crypto/openssh/sftp.1

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