sftp.1

   1 .\" $OpenBSD: sftp.1,v 1.119 2018/07/23 19:53:55 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: July 23 2018 $
  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 .Op Fl 46aCfpqrv
  34 .Op Fl B Ar buffer_size
  35 .Op Fl b Ar batchfile
  36 .Op Fl c Ar cipher
  37 .Op Fl D Ar sftp_server_path
  38 .Op Fl F Ar ssh_config
  39 .Op Fl i Ar identity_file
  40 .Op Fl l Ar limit
  41 .Op Fl o Ar ssh_option
  42 .Op Fl P Ar port
  43 .Op Fl R Ar num_requests
  44 .Op Fl S Ar program
  45 .Op Fl s Ar subsystem | sftp_server
  46 .Ar destination
  47 .Sh DESCRIPTION
  48 .Nm
  49 is a file transfer program, similar to
  50 .Xr ftp 1 ,
  51 which performs all operations over an encrypted
  52 .Xr ssh 1
  53 transport.
  54 It may also use many features of ssh, such as public key authentication and
  55 compression.
  56 .Pp
  57 The
  58 .Ar destination
  59 may be specified either as
  60 .Sm off
  61 .Oo user @ Oc host Op : path
  62 .Sm on
  63 or as a URI in the form
  64 .Sm off
  65 .No sftp:// Oo user @ Oc host Oo : port Oc Op / path .
  66 .Sm on
  67 .Pp
  68 If the
  69 .Ar destination
  70 includes a
  71 .Ar path
  72 and it is not a directory,
  73 .Nm
  74 will retrieve files automatically if a non-interactive
  75 authentication method is used; otherwise it will do so after
  76 successful interactive authentication.
  77 .Pp
  78 If no
  79 .Ar path
  80 is specified, or if the
  81 .Ar path
  82 is a directory,
  83 .Nm
  84 will log in to the specified
  85 .Ar host
  86 and enter interactive command mode, changing to the remote directory
  87 if one was specified.
  88 An optional trailing slash can be used to force the
  89 .Ar path
  90 to be interpreted as a directory.
  91 .Pp
  92 Since the destination formats use colon characters to delimit host
  93 names from path names or port numbers, IPv6 addresses must be
  94 enclosed in square brackets to avoid ambiguity.
  95 .Pp
  96 The options are as follows:
  97 .Bl -tag -width Ds
  98 .It Fl 4
  99 Forces
 100 .Nm
 101 to use IPv4 addresses only.
 102 .It Fl 6
 103 Forces
 104 .Nm
 105 to use IPv6 addresses only.
 106 .It Fl a
 107 Attempt to continue interrupted transfers rather than overwriting
 108 existing partial or complete copies of files.
 109 If the partial contents differ from those being transferred,
 110 then the resultant file is likely to be corrupt.
 111 .It Fl B Ar buffer_size
 112 Specify the size of the buffer that
 113 .Nm
 114 uses when transferring files.
 115 Larger buffers require fewer round trips at the cost of higher
 116 memory consumption.
 117 The default is 32768 bytes.
 118 .It Fl b Ar batchfile
 119 Batch mode reads a series of commands from an input
 120 .Ar batchfile
 121 instead of
 122 .Em stdin .
 123 Since it lacks user interaction it should be used in conjunction with
 124 non-interactive authentication to obviate the need to enter a password
 125 at connection time (see
 126 .Xr sshd 8
 127 and
 128 .Xr ssh-keygen 1
 129 for details).
 130 A
 131 .Ar batchfile
 132 of
 133 .Sq \-
 134 may be used to indicate standard input.
 135 .Nm
 136 will abort if any of the following
 137 commands fail:
 138 .Ic get , put , reget , reput, rename , ln ,
 139 .Ic rm , mkdir , chdir , ls ,
 140 .Ic lchdir , chmod , chown ,
 141 .Ic chgrp , lpwd , df , symlink ,
 142 and
 143 .Ic lmkdir .
 144 Termination on error can be suppressed on a command by command basis by
 145 prefixing the command with a
 146 .Sq \-
 147 character (for example,
 148 .Ic -rm /tmp/blah* ) .
 149 .It Fl C
 150 Enables compression (via ssh's
 151 .Fl C
 152 flag).
 153 .It Fl c Ar cipher
 154 Selects the cipher to use for encrypting the data transfers.
 155 This option is directly passed to
 156 .Xr ssh 1 .
 157 .It Fl D Ar sftp_server_path
 158 Connect directly to a local sftp server
 159 (rather than via
 160 .Xr ssh 1 ) .
 161 This option may be useful in debugging the client and server.
 162 .It Fl F Ar ssh_config
 163 Specifies an alternative
 164 per-user configuration file for
 165 .Xr ssh 1 .
 166 This option is directly passed to
 167 .Xr ssh 1 .
 168 .It Fl f
 169 Requests that files be flushed to disk immediately after transfer.
 170 When uploading files, this feature is only enabled if the server
 171 implements the "fsync@openssh.com" extension.
 172 .It Fl i Ar identity_file
 173 Selects the file from which the identity (private key) for public key
 174 authentication is read.
 175 This option is directly passed to
 176 .Xr ssh 1 .
 177 .It Fl l Ar limit
 178 Limits the used bandwidth, specified in Kbit/s.
 179 .It Fl o Ar ssh_option
 180 Can be used to pass options to
 181 .Nm ssh
 182 in the format used in
 183 .Xr ssh_config 5 .
 184 This is useful for specifying options
 185 for which there is no separate
 186 .Nm sftp
 187 command-line flag.
 188 For example, to specify an alternate port use:
 189 .Ic sftp -oPort=24 .
 190 For full details of the options listed below, and their possible values, see
 191 .Xr ssh_config 5 .
 192 .Pp
 193 .Bl -tag -width Ds -offset indent -compact
 194 .It AddressFamily
 195 .It BatchMode
 196 .It BindAddress
 197 .It BindInterface
 198 .It CanonicalDomains
 199 .It CanonicalizeFallbackLocal
 200 .It CanonicalizeHostname
 201 .It CanonicalizeMaxDots
 202 .It CanonicalizePermittedCNAMEs
 203 .It CertificateFile
 204 .It ChallengeResponseAuthentication
 205 .It CheckHostIP
 206 .It Ciphers
 207 .It Compression
 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 IdentitiesOnly
 224 .It IdentityAgent
 225 .It IdentityFile
 226 .It IPQoS
 227 .It KbdInteractiveAuthentication
 228 .It KbdInteractiveDevices
 229 .It KexAlgorithms
 230 .It LogLevel
 231 .It MACs
 232 .It NoHostAuthenticationForLocalhost
 233 .It NumberOfPasswordPrompts
 234 .It PasswordAuthentication
 235 .It PKCS11Provider
 236 .It Port
 237 .It PreferredAuthentications
 238 .It ProxyCommand
 239 .It ProxyJump
 240 .It PubkeyAcceptedKeyTypes
 241 .It PubkeyAuthentication
 242 .It RekeyLimit
 243 .It SendEnv
 244 .It ServerAliveInterval
 245 .It ServerAliveCountMax
 246 .It SetEnv
 247 .It StrictHostKeyChecking
 248 .It TCPKeepAlive
 249 .It UpdateHostKeys
 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 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 Op Ar path
 306 Change remote directory to
 307 .Ar path .
 308 If
 309 .Ar path
 310 is not specified, then change directory to the one the session started in.
 311 .It Ic chgrp Ar grp Ar path
 312 Change group of file
 313 .Ar path
 314 to
 315 .Ar grp .
 316 .Ar path
 317 may contain
 318 .Xr glob 7
 319 characters and may match multiple files.
 320 .Ar grp
 321 must be a numeric GID.
 322 .It Ic chmod Ar mode Ar path
 323 Change permissions of file
 324 .Ar path
 325 to
 326 .Ar mode .
 327 .Ar path
 328 may contain
 329 .Xr glob 7
 330 characters and may match multiple files.
 331 .It Ic chown Ar own Ar path
 332 Change owner of file
 333 .Ar path
 334 to
 335 .Ar own .
 336 .Ar path
 337 may contain
 338 .Xr glob 7
 339 characters and may match multiple files.
 340 .Ar own
 341 must be a numeric UID.
 342 .It Xo Ic df
 343 .Op Fl hi
 344 .Op Ar path
 345 .Xc
 346 Display usage information for the filesystem holding the current directory
 347 (or
 348 .Ar path
 349 if specified).
 350 If the
 351 .Fl h
 352 flag is specified, the capacity information will be displayed using
 353 "human-readable" suffixes.
 354 The
 355 .Fl i
 356 flag requests display of inode information in addition to capacity information.
 357 This command is only supported on servers that implement the
 358 .Dq statvfs@openssh.com
 359 extension.
 360 .It Ic exit
 361 Quit
 362 .Nm sftp .
 363 .It Xo Ic get
 364 .Op Fl afPpr
 365 .Ar remote-path
 366 .Op Ar local-path
 367 .Xc
 368 Retrieve the
 369 .Ar remote-path
 370 and store it on the local machine.
 371 If the local
 372 path name is not specified, it is given the same name it has on the
 373 remote machine.
 374 .Ar remote-path
 375 may contain
 376 .Xr glob 7
 377 characters and may match multiple files.
 378 If it does and
 379 .Ar local-path
 380 is specified, then
 381 .Ar local-path
 382 must specify a directory.
 383 .Pp
 384 If the
 385 .Fl a
 386 flag is specified, then attempt to resume partial transfers of existing files.
 387 Note that resumption assumes that any partial copy of the local file matches
 388 the remote copy.
 389 If the remote file contents differ from the partial local copy then the
 390 resultant file is likely to be corrupt.
 391 .Pp
 392 If the
 393 .Fl f
 394 flag is specified, then
 395 .Xr fsync 2
 396 will be called after the file transfer has completed to flush the file
 397 to disk.
 398 .Pp
 399 If either the
 400 .Fl P
 401 or
 402 .Fl p
 403 flag is specified, then full file permissions and access times are
 404 copied too.
 405 .Pp
 406 If the
 407 .Fl r
 408 flag is specified then directories will be copied recursively.
 409 Note that
 410 .Nm
 411 does not follow symbolic links when performing recursive transfers.
 412 .It Ic help
 413 Display help text.
 414 .It Ic lcd Op Ar path
 415 Change local directory to
 416 .Ar path .
 417 If
 418 .Ar path
 419 is not specified, then change directory to the local user's home directory.
 420 .It Ic lls Op Ar ls-options Op Ar path
 421 Display local directory listing of either
 422 .Ar path
 423 or current directory if
 424 .Ar path
 425 is not specified.
 426 .Ar ls-options
 427 may contain any flags supported by the local system's
 428 .Xr ls 1
 429 command.
 430 .Ar path
 431 may contain
 432 .Xr glob 7
 433 characters and may match multiple files.
 434 .It Ic lmkdir Ar path
 435 Create local directory specified by
 436 .Ar path .
 437 .It Xo Ic ln
 438 .Op Fl s
 439 .Ar oldpath
 440 .Ar newpath
 441 .Xc
 442 Create a link from
 443 .Ar oldpath
 444 to
 445 .Ar newpath .
 446 If the
 447 .Fl s
 448 flag is specified the created link is a symbolic link, otherwise it is
 449 a hard link.
 450 .It Ic lpwd
 451 Print local working directory.
 452 .It Xo Ic ls
 453 .Op Fl 1afhlnrSt
 454 .Op Ar path
 455 .Xc
 456 Display a remote directory listing of either
 457 .Ar path
 458 or the current directory if
 459 .Ar path
 460 is not specified.
 461 .Ar path
 462 may contain
 463 .Xr glob 7
 464 characters and may match multiple files.
 465 .Pp
 466 The following flags are recognized and alter the behaviour of
 467 .Ic ls
 468 accordingly:
 469 .Bl -tag -width Ds
 470 .It Fl 1
 471 Produce single columnar output.
 472 .It Fl a
 473 List files beginning with a dot
 474 .Pq Sq \&. .
 475 .It Fl f
 476 Do not sort the listing.
 477 The default sort order is lexicographical.
 478 .It Fl h
 479 When used with a long format option, use unit suffixes: Byte, Kilobyte,
 480 Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
 481 the number of digits to four or fewer using powers of 2 for sizes (K=1024,
 482 M=1048576, etc.).
 483 .It Fl l
 484 Display additional details including permissions
 485 and ownership information.
 486 .It Fl n
 487 Produce a long listing with user and group information presented
 488 numerically.
 489 .It Fl r
 490 Reverse the sort order of the listing.
 491 .It Fl S
 492 Sort the listing by file size.
 493 .It Fl t
 494 Sort the listing by last modification time.
 495 .El
 496 .It Ic lumask Ar umask
 497 Set local umask to
 498 .Ar umask .
 499 .It Ic mkdir Ar path
 500 Create remote directory specified by
 501 .Ar path .
 502 .It Ic progress
 503 Toggle display of progress meter.
 504 .It Xo Ic put
 505 .Op Fl afPpr
 506 .Ar local-path
 507 .Op Ar remote-path
 508 .Xc
 509 Upload
 510 .Ar local-path
 511 and store it on the remote machine.
 512 If the remote path name is not specified, it is given the same name it has
 513 on the local machine.
 514 .Ar local-path
 515 may contain
 516 .Xr glob 7
 517 characters and may match multiple files.
 518 If it does and
 519 .Ar remote-path
 520 is specified, then
 521 .Ar remote-path
 522 must specify a directory.
 523 .Pp
 524 If the
 525 .Fl a
 526 flag is specified, then attempt to resume partial
 527 transfers of existing files.
 528 Note that resumption assumes that any partial copy of the remote file
 529 matches the local copy.
 530 If the local file contents differ from the remote local copy then
 531 the resultant file is likely to be corrupt.
 532 .Pp
 533 If the
 534 .Fl f
 535 flag is specified, then a request will be sent to the server to call
 536 .Xr fsync 2
 537 after the file has been transferred.
 538 Note that this is only supported by servers that implement
 539 the "fsync@openssh.com" extension.
 540 .Pp
 541 If either the
 542 .Fl P
 543 or
 544 .Fl p
 545 flag is specified, then full file permissions and access times are
 546 copied too.
 547 .Pp
 548 If the
 549 .Fl r
 550 flag is specified then directories will be copied recursively.
 551 Note that
 552 .Nm
 553 does not follow symbolic links when performing recursive transfers.
 554 .It Ic pwd
 555 Display remote working directory.
 556 .It Ic quit
 557 Quit
 558 .Nm sftp .
 559 .It Xo Ic reget
 560 .Op Fl Ppr
 561 .Ar remote-path
 562 .Op Ar local-path
 563 .Xc
 564 Resume download of
 565 .Ar remote-path .
 566 Equivalent to
 567 .Ic get
 568 with the
 569 .Fl a
 570 flag set.
 571 .It Xo Ic reput
 572 .Op Fl Ppr
 573 .Op Ar local-path
 574 .Ar remote-path
 575 .Xc
 576 Resume upload of
 577 .Op Ar local-path .
 578 Equivalent to
 579 .Ic put
 580 with the
 581 .Fl a
 582 flag set.
 583 .It Ic rename Ar oldpath Ar newpath
 584 Rename remote file from
 585 .Ar oldpath
 586 to
 587 .Ar newpath .
 588 .It Ic rm Ar path
 589 Delete remote file specified by
 590 .Ar path .
 591 .It Ic rmdir Ar path
 592 Remove remote directory specified by
 593 .Ar path .
 594 .It Ic symlink Ar oldpath Ar newpath
 595 Create a symbolic link from
 596 .Ar oldpath
 597 to
 598 .Ar newpath .
 599 .It Ic version
 600 Display the
 601 .Nm
 602 protocol version.
 603 .It Ic \&! Ns Ar command
 604 Execute
 605 .Ar command
 606 in local shell.
 607 .It Ic \&!
 608 Escape to local shell.
 609 .It Ic \&?
 610 Synonym for help.
 611 .El
 612 .Sh SEE ALSO
 613 .Xr ftp 1 ,
 614 .Xr ls 1 ,
 615 .Xr scp 1 ,
 616 .Xr ssh 1 ,
 617 .Xr ssh-add 1 ,
 618 .Xr ssh-keygen 1 ,
 619 .Xr ssh_config 5 ,
 620 .Xr glob 7 ,
 621 .Xr sftp-server 8 ,
 622 .Xr sshd 8
 623 .Rs
 624 .%A T. Ylonen
 625 .%A S. Lehtinen
 626 .%T "SSH File Transfer Protocol"
 627 .%N draft-ietf-secsh-filexfer-00.txt
 628 .%D January 2001
 629 .%O work in progress material
 630 .Re