sftp.1

   1 .\" $OpenBSD: sftp.1,v 1.97 2013/10/20 09:51:26 djm Exp $
   2 .\"
   3 .\" Copyright (c) 2001 Damien Miller.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .Dd $Mdocdate: October 20 2013 $
  26 .Dt SFTP 1
  27 .Os
  28 .Sh NAME
  29 .Nm sftp
  30 .Nd secure file transfer program
  31 .Sh SYNOPSIS
  32 .Nm sftp
  33 .Bk -words
  34 .Op Fl 1246aCfpqrv
  35 .Op Fl B Ar buffer_size
  36 .Op Fl b Ar batchfile
  37 .Op Fl c Ar cipher
  38 .Op Fl D Ar sftp_server_path
  39 .Op Fl F Ar ssh_config
  40 .Op Fl i Ar identity_file
  41 .Op Fl l Ar limit
  42 .Op Fl o Ar ssh_option
  43 .Op Fl P Ar port
  44 .Op Fl R Ar num_requests
  45 .Op Fl S Ar program
  46 .Op Fl s Ar subsystem | sftp_server
  47 .Ar host
  48 .Ek
  49 .Nm sftp
  50 .Oo Ar user Ns @ Oc Ns
  51 .Ar host Ns Op : Ns Ar
  52 .Nm sftp
  53 .Oo
  54 .Ar user Ns @ Oc Ns
  55 .Ar host Ns Oo : Ns Ar dir Ns
  56 .Op Ar /
  57 .Oc
  58 .Nm sftp
  59 .Fl b Ar batchfile
  60 .Oo Ar user Ns @ Oc Ns Ar host
  61 .Sh DESCRIPTION
  62 .Nm
  63 is an interactive file transfer program, similar to
  64 .Xr ftp 1 ,
  65 which performs all operations over an encrypted
  66 .Xr ssh 1
  67 transport.
  68 It may also use many features of ssh, such as public key authentication and
  69 compression.
  70 .Nm
  71 connects and logs into the specified
  72 .Ar host ,
  73 then enters an interactive command mode.
  74 .Pp
  75 The second usage format will retrieve files automatically if a non-interactive
  76 authentication method is used; otherwise it will do so after
  77 successful interactive authentication.
  78 .Pp
  79 The third usage format allows
  80 .Nm
  81 to start in a remote directory.
  82 .Pp
  83 The final usage format allows for automated sessions using the
  84 .Fl b
  85 option.
  86 In such cases, it is necessary to configure non-interactive authentication
  87 to obviate the need to enter a password at connection time (see
  88 .Xr sshd 8
  89 and
  90 .Xr ssh-keygen 1
  91 for details).
  92 .Pp
  93 Since some usage formats use colon characters to delimit host names from path
  94 names, IPv6 addresses must be enclosed in square brackets to avoid ambiguity.
  95 .Pp
  96 The options are as follows:
  97 .Bl -tag -width Ds
  98 .It Fl 1
  99 Specify the use of protocol version 1.
 100 .It Fl 2
 101 Specify the use of protocol version 2.
 102 .It Fl 4
 103 Forces
 104 .Nm
 105 to use IPv4 addresses only.
 106 .It Fl 6
 107 Forces
 108 .Nm
 109 to use IPv6 addresses only.
 110 .It Fl a
 111 Attempt to continue interrupted downloads rather than overwriting existing
 112 partial or complete copies of files.
 113 If the remote file contents differ from the partial local copy then the
 114 resultant file is likely to be corrupt.
 115 .It Fl B Ar buffer_size
 116 Specify the size of the buffer that
 117 .Nm
 118 uses when transferring files.
 119 Larger buffers require fewer round trips at the cost of higher
 120 memory consumption.
 121 The default is 32768 bytes.
 122 .It Fl b Ar batchfile
 123 Batch mode reads a series of commands from an input
 124 .Ar batchfile
 125 instead of
 126 .Em stdin .
 127 Since it lacks user interaction it should be used in conjunction with
 128 non-interactive authentication.
 129 A
 130 .Ar batchfile
 131 of
 132 .Sq \-
 133 may be used to indicate standard input.
 134 .Nm
 135 will abort if any of the following
 136 commands fail:
 137 .Ic get , put , reget , rename , ln ,
 138 .Ic rm , mkdir , chdir , ls ,
 139 .Ic lchdir , chmod , chown ,
 140 .Ic chgrp , lpwd , df , symlink ,
 141 and
 142 .Ic lmkdir .
 143 Termination on error can be suppressed on a command by command basis by
 144 prefixing the command with a
 145 .Sq \-
 146 character (for example,
 147 .Ic -rm /tmp/blah* ) .
 148 .It Fl C
 149 Enables compression (via ssh's
 150 .Fl C
 151 flag).
 152 .It Fl c Ar cipher
 153 Selects the cipher to use for encrypting the data transfers.
 154 This option is directly passed to
 155 .Xr ssh 1 .
 156 .It Fl D Ar sftp_server_path
 157 Connect directly to a local sftp server
 158 (rather than via
 159 .Xr ssh 1 ) .
 160 This option may be useful in debugging the client and server.
 161 .It Fl F Ar ssh_config
 162 Specifies an alternative
 163 per-user configuration file for
 164 .Xr ssh 1 .
 165 This option is directly passed to
 166 .Xr ssh 1 .
 167 .It Fl f
 168 Requests that files be flushed to disk immediately after transfer.
 169 When uploading files, this feature is only enabled if the server
 170 implements the "fsync@openssh.com" extension.
 171 .It Fl i Ar identity_file
 172 Selects the file from which the identity (private key) for public key
 173 authentication is read.
 174 This option is directly passed to
 175 .Xr ssh 1 .
 176 .It Fl l Ar limit
 177 Limits the used bandwidth, specified in Kbit/s.
 178 .It Fl o Ar ssh_option
 179 Can be used to pass options to
 180 .Nm ssh
 181 in the format used in
 182 .Xr ssh_config 5 .
 183 This is useful for specifying options
 184 for which there is no separate
 185 .Nm sftp
 186 command-line flag.
 187 For example, to specify an alternate port use:
 188 .Ic sftp -oPort=24 .
 189 For full details of the options listed below, and their possible values, see
 190 .Xr ssh_config 5 .
 191 .Pp
 192 .Bl -tag -width Ds -offset indent -compact
 193 .It AddressFamily
 194 .It BatchMode
 195 .It BindAddress
 196 .It CanonicalDomains
 197 .It CanonicalizeFallbackLocal
 198 .It CanonicalizeHostname
 199 .It CanonicalizeMaxDots
 200 .It CanonicalizePermittedCNAMEs
 201 .It ChallengeResponseAuthentication
 202 .It CheckHostIP
 203 .It Cipher
 204 .It Ciphers
 205 .It Compression
 206 .It CompressionLevel
 207 .It ConnectionAttempts
 208 .It ConnectTimeout
 209 .It ControlMaster
 210 .It ControlPath
 211 .It ControlPersist
 212 .It GlobalKnownHostsFile
 213 .It GSSAPIAuthentication
 214 .It GSSAPIDelegateCredentials
 215 .It HashKnownHosts
 216 .It Host
 217 .It HostbasedAuthentication
 218 .It HostKeyAlgorithms
 219 .It HostKeyAlias
 220 .It HostName
 221 .It IdentityFile
 222 .It IdentitiesOnly
 223 .It IPQoS
 224 .It KbdInteractiveAuthentication
 225 .It KbdInteractiveDevices
 226 .It KexAlgorithms
 227 .It LogLevel
 228 .It MACs
 229 .It NoHostAuthenticationForLocalhost
 230 .It NumberOfPasswordPrompts
 231 .It PasswordAuthentication
 232 .It PKCS11Provider
 233 .It Port
 234 .It PreferredAuthentications
 235 .It Protocol
 236 .It ProxyCommand
 237 .It PubkeyAuthentication
 238 .It RekeyLimit
 239 .It RhostsRSAAuthentication
 240 .It RSAAuthentication
 241 .It SendEnv
 242 .It ServerAliveInterval
 243 .It ServerAliveCountMax
 244 .It StrictHostKeyChecking
 245 .It TCPKeepAlive
 246 .It UsePrivilegedPort
 247 .It User
 248 .It UserKnownHostsFile
 249 .It VerifyHostKeyDNS
 250 .El
 251 .It Fl P Ar port
 252 Specifies the port to connect to on the remote host.
 253 .It Fl p
 254 Preserves modification times, access times, and modes from the
 255 original files transferred.
 256 .It Fl q
 257 Quiet mode: disables the progress meter as well as warning and
 258 diagnostic messages from
 259 .Xr ssh 1 .
 260 .It Fl R Ar num_requests
 261 Specify how many requests may be outstanding at any one time.
 262 Increasing this may slightly improve file transfer speed
 263 but will increase memory usage.
 264 The default is 64 outstanding requests.
 265 .It Fl r
 266 Recursively copy entire directories when uploading and downloading.
 267 Note that
 268 .Nm
 269 does not follow symbolic links encountered in the tree traversal.
 270 .It Fl S Ar program
 271 Name of the
 272 .Ar program
 273 to use for the encrypted connection.
 274 The program must understand
 275 .Xr ssh 1
 276 options.
 277 .It Fl s Ar subsystem | sftp_server
 278 Specifies the SSH2 subsystem or the path for an sftp server
 279 on the remote host.
 280 A path is useful for using
 281 .Nm
 282 over protocol version 1, or when the remote
 283 .Xr sshd 8
 284 does not have an sftp subsystem configured.
 285 .It Fl v
 286 Raise logging level.
 287 This option is also passed to ssh.
 288 .El
 289 .Sh INTERACTIVE COMMANDS
 290 Once in interactive mode,
 291 .Nm
 292 understands a set of commands similar to those of
 293 .Xr ftp 1 .
 294 Commands are case insensitive.
 295 Pathnames that contain spaces must be enclosed in quotes.
 296 Any special characters contained within pathnames that are recognized by
 297 .Xr glob 3
 298 must be escaped with backslashes
 299 .Pq Sq \e .
 300 .Bl -tag -width Ds
 301 .It Ic bye
 302 Quit
 303 .Nm sftp .
 304 .It Ic cd Ar path
 305 Change remote directory to
 306 .Ar path .
 307 .It Ic chgrp Ar grp Ar path
 308 Change group of file
 309 .Ar path
 310 to
 311 .Ar grp .
 312 .Ar path
 313 may contain
 314 .Xr glob 3
 315 characters and may match multiple files.
 316 .Ar grp
 317 must be a numeric GID.
 318 .It Ic chmod Ar mode Ar path
 319 Change permissions of file
 320 .Ar path
 321 to
 322 .Ar mode .
 323 .Ar path
 324 may contain
 325 .Xr glob 3
 326 characters and may match multiple files.
 327 .It Ic chown Ar own Ar path
 328 Change owner of file
 329 .Ar path
 330 to
 331 .Ar own .
 332 .Ar path
 333 may contain
 334 .Xr glob 3
 335 characters and may match multiple files.
 336 .Ar own
 337 must be a numeric UID.
 338 .It Xo Ic df
 339 .Op Fl hi
 340 .Op Ar path
 341 .Xc
 342 Display usage information for the filesystem holding the current directory
 343 (or
 344 .Ar path
 345 if specified).
 346 If the
 347 .Fl h
 348 flag is specified, the capacity information will be displayed using
 349 "human-readable" suffixes.
 350 The
 351 .Fl i
 352 flag requests display of inode information in addition to capacity information.
 353 This command is only supported on servers that implement the
 354 .Dq statvfs@openssh.com
 355 extension.
 356 .It Ic exit
 357 Quit
 358 .Nm sftp .
 359 .It Xo Ic get
 360 .Op Fl afPpr
 361 .Ar remote-path
 362 .Op Ar local-path
 363 .Xc
 364 Retrieve the
 365 .Ar remote-path
 366 and store it on the local machine.
 367 If the local
 368 path name is not specified, it is given the same name it has on the
 369 remote machine.
 370 .Ar remote-path
 371 may contain
 372 .Xr glob 3
 373 characters and may match multiple files.
 374 If it does and
 375 .Ar local-path
 376 is specified, then
 377 .Ar local-path
 378 must specify a directory.
 379 .Pp
 380 If the
 381 .Fl a
 382 flag is specified, then attempt to resume partial transfers of existing files.
 383 Note that resumption assumes that any partial copy of the local file matches
 384 the remote copy.
 385 If the remote file contents differ from the partial local copy then the
 386 resultant file is likely to be corrupt.
 387 .Pp
 388 If the
 389 .Fl f
 390 flag is specified, then
 391 .Xr fsync 2
 392 will be called after the file transfer has completed to flush the file
 393 to disk.
 394 .Pp
 395 If either the
 396 .Fl P
 397 or
 398 .Fl p
 399 flag is specified, then full file permissions and access times are
 400 copied too.
 401 .Pp
 402 If the
 403 .Fl r
 404 flag is specified then directories will be copied recursively.
 405 Note that
 406 .Nm
 407 does not follow symbolic links when performing recursive transfers.
 408 .It Ic help
 409 Display help text.
 410 .It Ic lcd Ar path
 411 Change local directory to
 412 .Ar path .
 413 .It Ic lls Op Ar ls-options Op Ar path
 414 Display local directory listing of either
 415 .Ar path
 416 or current directory if
 417 .Ar path
 418 is not specified.
 419 .Ar ls-options
 420 may contain any flags supported by the local system's
 421 .Xr ls 1
 422 command.
 423 .Ar path
 424 may contain
 425 .Xr glob 3
 426 characters and may match multiple files.
 427 .It Ic lmkdir Ar path
 428 Create local directory specified by
 429 .Ar path .
 430 .It Xo Ic ln
 431 .Op Fl s
 432 .Ar oldpath
 433 .Ar newpath
 434 .Xc
 435 Create a link from
 436 .Ar oldpath
 437 to
 438 .Ar newpath .
 439 If the
 440 .Fl s
 441 flag is specified the created link is a symbolic link, otherwise it is
 442 a hard link.
 443 .It Ic lpwd
 444 Print local working directory.
 445 .It Xo Ic ls
 446 .Op Fl 1afhlnrSt
 447 .Op Ar path
 448 .Xc
 449 Display a remote directory listing of either
 450 .Ar path
 451 or the current directory if
 452 .Ar path
 453 is not specified.
 454 .Ar path
 455 may contain
 456 .Xr glob 3
 457 characters and may match multiple files.
 458 .Pp
 459 The following flags are recognized and alter the behaviour of
 460 .Ic ls
 461 accordingly:
 462 .Bl -tag -width Ds
 463 .It Fl 1
 464 Produce single columnar output.
 465 .It Fl a
 466 List files beginning with a dot
 467 .Pq Sq \&. .
 468 .It Fl f
 469 Do not sort the listing.
 470 The default sort order is lexicographical.
 471 .It Fl h
 472 When used with a long format option, use unit suffixes: Byte, Kilobyte,
 473 Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
 474 the number of digits to four or fewer using powers of 2 for sizes (K=1024,
 475 M=1048576, etc.).
 476 .It Fl l
 477 Display additional details including permissions
 478 and ownership information.
 479 .It Fl n
 480 Produce a long listing with user and group information presented
 481 numerically.
 482 .It Fl r
 483 Reverse the sort order of the listing.
 484 .It Fl S
 485 Sort the listing by file size.
 486 .It Fl t
 487 Sort the listing by last modification time.
 488 .El
 489 .It Ic lumask Ar umask
 490 Set local umask to
 491 .Ar umask .
 492 .It Ic mkdir Ar path
 493 Create remote directory specified by
 494 .Ar path .
 495 .It Ic progress
 496 Toggle display of progress meter.
 497 .It Xo Ic put
 498 .Op Fl fPpr
 499 .Ar local-path
 500 .Op Ar remote-path
 501 .Xc
 502 Upload
 503 .Ar local-path
 504 and store it on the remote machine.
 505 If the remote path name is not specified, it is given the same name it has
 506 on the local machine.
 507 .Ar local-path
 508 may contain
 509 .Xr glob 3
 510 characters and may match multiple files.
 511 If it does and
 512 .Ar remote-path
 513 is specified, then
 514 .Ar remote-path
 515 must specify a directory.
 516 .Pp
 517 If the
 518 .Fl f
 519 flag is specified, then a request will be sent to the server to call
 520 .Xr fsync 2
 521 after the file has been transferred.
 522 Note that this is only supported by servers that implement
 523 the "fsync@openssh.com" extension.
 524 .Pp
 525 If either the
 526 .Fl P
 527 or
 528 .Fl p
 529 flag is specified, then full file permissions and access times are
 530 copied too.
 531 .Pp
 532 If the
 533 .Fl r
 534 flag is specified then directories will be copied recursively.
 535 Note that
 536 .Nm
 537 does not follow symbolic links when performing recursive transfers.
 538 .It Ic pwd
 539 Display remote working directory.
 540 .It Ic quit
 541 Quit
 542 .Nm sftp .
 543 .It Xo Ic reget
 544 .Op Fl Ppr
 545 .Ar remote-path
 546 .Op Ar local-path
 547 .Xc
 548 Resume download of
 549 .Ar remote-path .
 550 Equivalent to
 551 .Ic get
 552 with the
 553 .Fl a
 554 flag set.
 555 .It Ic rename Ar oldpath Ar newpath
 556 Rename remote file from
 557 .Ar oldpath
 558 to
 559 .Ar newpath .
 560 .It Ic rm Ar path
 561 Delete remote file specified by
 562 .Ar path .
 563 .It Ic rmdir Ar path
 564 Remove remote directory specified by
 565 .Ar path .
 566 .It Ic symlink Ar oldpath Ar newpath
 567 Create a symbolic link from
 568 .Ar oldpath
 569 to
 570 .Ar newpath .
 571 .It Ic version
 572 Display the
 573 .Nm
 574 protocol version.
 575 .It Ic \&! Ns Ar command
 576 Execute
 577 .Ar command
 578 in local shell.
 579 .It Ic \&!
 580 Escape to local shell.
 581 .It Ic \&?
 582 Synonym for help.
 583 .El
 584 .Sh SEE ALSO
 585 .Xr ftp 1 ,
 586 .Xr ls 1 ,
 587 .Xr scp 1 ,
 588 .Xr ssh 1 ,
 589 .Xr ssh-add 1 ,
 590 .Xr ssh-keygen 1 ,
 591 .Xr glob 3 ,
 592 .Xr ssh_config 5 ,
 593 .Xr sftp-server 8 ,
 594 .Xr sshd 8
 595 .Rs
 596 .%A T. Ylonen
 597 .%A S. Lehtinen
 598 .%T "SSH File Transfer Protocol"
 599 .%N draft-ietf-secsh-filexfer-00.txt
 600 .%D January 2001
 601 .%O work in progress material
 602 .Re