crypto/openssh/sftp.1

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