crypto/openssh/sftp.1

   1 .\" $OpenBSD: sftp.1,v 1.99 2014/04/22 14:16:30 jmc 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: April 22 2014 $
  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 transfers rather than overwriting
 112 existing partial or complete copies of files.
 113 If the partial contents differ from those being transferred,
 114 then the 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 , reput, 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 256 outstanding requests providing for 8MB
 265 of outstanding data with a 32KB buffer.
 266 .It Fl r
 267 Recursively copy entire directories when uploading and downloading.
 268 Note that
 269 .Nm
 270 does not follow symbolic links encountered in the tree traversal.
 271 .It Fl S Ar program
 272 Name of the
 273 .Ar program
 274 to use for the encrypted connection.
 275 The program must understand
 276 .Xr ssh 1
 277 options.
 278 .It Fl s Ar subsystem | sftp_server
 279 Specifies the SSH2 subsystem or the path for an sftp server
 280 on the remote host.
 281 A path is useful for using
 282 .Nm
 283 over protocol version 1, or when the remote
 284 .Xr sshd 8
 285 does not have an sftp subsystem configured.
 286 .It Fl v
 287 Raise logging level.
 288 This option is also passed to ssh.
 289 .El
 290 .Sh INTERACTIVE COMMANDS
 291 Once in interactive mode,
 292 .Nm
 293 understands a set of commands similar to those of
 294 .Xr ftp 1 .
 295 Commands are case insensitive.
 296 Pathnames that contain spaces must be enclosed in quotes.
 297 Any special characters contained within pathnames that are recognized by
 298 .Xr glob 3
 299 must be escaped with backslashes
 300 .Pq Sq \e .
 301 .Bl -tag -width Ds
 302 .It Ic bye
 303 Quit
 304 .Nm sftp .
 305 .It Ic cd Ar path
 306 Change remote directory to
 307 .Ar path .
 308 .It Ic chgrp Ar grp Ar path
 309 Change group of file
 310 .Ar path
 311 to
 312 .Ar grp .
 313 .Ar path
 314 may contain
 315 .Xr glob 3
 316 characters and may match multiple files.
 317 .Ar grp
 318 must be a numeric GID.
 319 .It Ic chmod Ar mode Ar path
 320 Change permissions of file
 321 .Ar path
 322 to
 323 .Ar mode .
 324 .Ar path
 325 may contain
 326 .Xr glob 3
 327 characters and may match multiple files.
 328 .It Ic chown Ar own Ar path
 329 Change owner of file
 330 .Ar path
 331 to
 332 .Ar own .
 333 .Ar path
 334 may contain
 335 .Xr glob 3
 336 characters and may match multiple files.
 337 .Ar own
 338 must be a numeric UID.
 339 .It Xo Ic df
 340 .Op Fl hi
 341 .Op Ar path
 342 .Xc
 343 Display usage information for the filesystem holding the current directory
 344 (or
 345 .Ar path
 346 if specified).
 347 If the
 348 .Fl h
 349 flag is specified, the capacity information will be displayed using
 350 "human-readable" suffixes.
 351 The
 352 .Fl i
 353 flag requests display of inode information in addition to capacity information.
 354 This command is only supported on servers that implement the
 355 .Dq statvfs@openssh.com
 356 extension.
 357 .It Ic exit
 358 Quit
 359 .Nm sftp .
 360 .It Xo Ic get
 361 .Op Fl afPpr
 362 .Ar remote-path
 363 .Op Ar local-path
 364 .Xc
 365 Retrieve the
 366 .Ar remote-path
 367 and store it on the local machine.
 368 If the local
 369 path name is not specified, it is given the same name it has on the
 370 remote machine.
 371 .Ar remote-path
 372 may contain
 373 .Xr glob 3
 374 characters and may match multiple files.
 375 If it does and
 376 .Ar local-path
 377 is specified, then
 378 .Ar local-path
 379 must specify a directory.
 380 .Pp
 381 If the
 382 .Fl a
 383 flag is specified, then attempt to resume partial transfers of existing files.
 384 Note that resumption assumes that any partial copy of the local file matches
 385 the remote copy.
 386 If the remote file contents differ from the partial local copy then the
 387 resultant file is likely to be corrupt.
 388 .Pp
 389 If the
 390 .Fl f
 391 flag is specified, then
 392 .Xr fsync 2
 393 will be called after the file transfer has completed to flush the file
 394 to disk.
 395 .Pp
 396 If either the
 397 .Fl P
 398 or
 399 .Fl p
 400 flag is specified, then full file permissions and access times are
 401 copied too.
 402 .Pp
 403 If the
 404 .Fl r
 405 flag is specified then directories will be copied recursively.
 406 Note that
 407 .Nm
 408 does not follow symbolic links when performing recursive transfers.
 409 .It Ic help
 410 Display help text.
 411 .It Ic lcd Ar path
 412 Change local directory to
 413 .Ar path .
 414 .It Ic lls Op Ar ls-options Op Ar path
 415 Display local directory listing of either
 416 .Ar path
 417 or current directory if
 418 .Ar path
 419 is not specified.
 420 .Ar ls-options
 421 may contain any flags supported by the local system's
 422 .Xr ls 1
 423 command.
 424 .Ar path
 425 may contain
 426 .Xr glob 3
 427 characters and may match multiple files.
 428 .It Ic lmkdir Ar path
 429 Create local directory specified by
 430 .Ar path .
 431 .It Xo Ic ln
 432 .Op Fl s
 433 .Ar oldpath
 434 .Ar newpath
 435 .Xc
 436 Create a link from
 437 .Ar oldpath
 438 to
 439 .Ar newpath .
 440 If the
 441 .Fl s
 442 flag is specified the created link is a symbolic link, otherwise it is
 443 a hard link.
 444 .It Ic lpwd
 445 Print local working directory.
 446 .It Xo Ic ls
 447 .Op Fl 1afhlnrSt
 448 .Op Ar path
 449 .Xc
 450 Display a remote directory listing of either
 451 .Ar path
 452 or the current directory if
 453 .Ar path
 454 is not specified.
 455 .Ar path
 456 may contain
 457 .Xr glob 3
 458 characters and may match multiple files.
 459 .Pp
 460 The following flags are recognized and alter the behaviour of
 461 .Ic ls
 462 accordingly:
 463 .Bl -tag -width Ds
 464 .It Fl 1
 465 Produce single columnar output.
 466 .It Fl a
 467 List files beginning with a dot
 468 .Pq Sq \&. .
 469 .It Fl f
 470 Do not sort the listing.
 471 The default sort order is lexicographical.
 472 .It Fl h
 473 When used with a long format option, use unit suffixes: Byte, Kilobyte,
 474 Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
 475 the number of digits to four or fewer using powers of 2 for sizes (K=1024,
 476 M=1048576, etc.).
 477 .It Fl l
 478 Display additional details including permissions
 479 and ownership information.
 480 .It Fl n
 481 Produce a long listing with user and group information presented
 482 numerically.
 483 .It Fl r
 484 Reverse the sort order of the listing.
 485 .It Fl S
 486 Sort the listing by file size.
 487 .It Fl t
 488 Sort the listing by last modification time.
 489 .El
 490 .It Ic lumask Ar umask
 491 Set local umask to
 492 .Ar umask .
 493 .It Ic mkdir Ar path
 494 Create remote directory specified by
 495 .Ar path .
 496 .It Ic progress
 497 Toggle display of progress meter.
 498 .It Xo Ic put
 499 .Op Fl afPpr
 500 .Ar local-path
 501 .Op Ar remote-path
 502 .Xc
 503 Upload
 504 .Ar local-path
 505 and store it on the remote machine.
 506 If the remote path name is not specified, it is given the same name it has
 507 on the local machine.
 508 .Ar local-path
 509 may contain
 510 .Xr glob 3
 511 characters and may match multiple files.
 512 If it does and
 513 .Ar remote-path
 514 is specified, then
 515 .Ar remote-path
 516 must specify a directory.
 517 .Pp
 518 If the
 519 .Fl a
 520 flag is specified, then attempt to resume partial
 521 transfers of existing files.
 522 Note that resumption assumes that any partial copy of the remote file
 523 matches the local copy.
 524 If the local file contents differ from the remote local copy then
 525 the resultant file is likely to be corrupt.
 526 .Pp
 527 If the
 528 .Fl f
 529 flag is specified, then a request will be sent to the server to call
 530 .Xr fsync 2
 531 after the file has been transferred.
 532 Note that this is only supported by servers that implement
 533 the "fsync@openssh.com" extension.
 534 .Pp
 535 If either the
 536 .Fl P
 537 or
 538 .Fl p
 539 flag is specified, then full file permissions and access times are
 540 copied too.
 541 .Pp
 542 If the
 543 .Fl r
 544 flag is specified then directories will be copied recursively.
 545 Note that
 546 .Nm
 547 does not follow symbolic links when performing recursive transfers.
 548 .It Ic pwd
 549 Display remote working directory.
 550 .It Ic quit
 551 Quit
 552 .Nm sftp .
 553 .It Xo Ic reget
 554 .Op Fl Ppr
 555 .Ar remote-path
 556 .Op Ar local-path
 557 .Xc
 558 Resume download of
 559 .Ar remote-path .
 560 Equivalent to
 561 .Ic get
 562 with the
 563 .Fl a
 564 flag set.
 565 .It Xo Ic reput
 566 .Op Fl Ppr
 567 .Op Ar local-path
 568 .Ar remote-path
 569 .Xc
 570 Resume upload of
 571 .Op Ar local-path .
 572 Equivalent to
 573 .Ic put
 574 with the
 575 .Fl a
 576 flag set.
 577 .It Ic rename Ar oldpath Ar newpath
 578 Rename remote file from
 579 .Ar oldpath
 580 to
 581 .Ar newpath .
 582 .It Ic rm Ar path
 583 Delete remote file specified by
 584 .Ar path .
 585 .It Ic rmdir Ar path
 586 Remove remote directory specified by
 587 .Ar path .
 588 .It Ic symlink Ar oldpath Ar newpath
 589 Create a symbolic link from
 590 .Ar oldpath
 591 to
 592 .Ar newpath .
 593 .It Ic version
 594 Display the
 595 .Nm
 596 protocol version.
 597 .It Ic \&! Ns Ar command
 598 Execute
 599 .Ar command
 600 in local shell.
 601 .It Ic \&!
 602 Escape to local shell.
 603 .It Ic \&?
 604 Synonym for help.
 605 .El
 606 .Sh SEE ALSO
 607 .Xr ftp 1 ,
 608 .Xr ls 1 ,
 609 .Xr scp 1 ,
 610 .Xr ssh 1 ,
 611 .Xr ssh-add 1 ,
 612 .Xr ssh-keygen 1 ,
 613 .Xr glob 3 ,
 614 .Xr ssh_config 5 ,
 615 .Xr sftp-server 8 ,
 616 .Xr sshd 8
 617 .Rs
 618 .%A T. Ylonen
 619 .%A S. Lehtinen
 620 .%T "SSH File Transfer Protocol"
 621 .%N draft-ietf-secsh-filexfer-00.txt
 622 .%D January 2001
 623 .%O work in progress material
 624 .Re