crypto/openssh/ssh.1

   1 .\"
   2 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   3 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   4 .\"                    All rights reserved
   5 .\"
   6 .\" As far as I am concerned, the code I have written for this software
   7 .\" can be used freely for any purpose.  Any derived versions of this
   8 .\" software must be clearly marked as such, and if the derived work is
   9 .\" incompatible with the protocol description in the RFC file, it must be
  10 .\" called by a name other than "ssh" or "Secure Shell".
  11 .\"
  12 .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
  13 .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
  14 .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
  15 .\"
  16 .\" Redistribution and use in source and binary forms, with or without
  17 .\" modification, are permitted provided that the following conditions
  18 .\" are met:
  19 .\" 1. Redistributions of source code must retain the above copyright
  20 .\"    notice, this list of conditions and the following disclaimer.
  21 .\" 2. Redistributions in binary form must reproduce the above copyright
  22 .\"    notice, this list of conditions and the following disclaimer in the
  23 .\"    documentation and/or other materials provided with the distribution.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  26 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  27 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  28 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  29 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  34 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35 .\"
  36 .\" $OpenBSD: ssh.1,v 1.396 2018/07/19 10:28:47 dtucker Exp $
  37 .\" $FreeBSD$
  38 .Dd $Mdocdate: July 19 2018 $
  39 .Dt SSH 1
  40 .Os
  41 .Sh NAME
  42 .Nm ssh
  43 .Nd OpenSSH SSH client (remote login program)
  44 .Sh SYNOPSIS
  45 .Nm ssh
  46 .Op Fl 46AaCfGgKkMNnqsTtVvXxYy
  47 .Op Fl B Ar bind_interface
  48 .Op Fl b Ar bind_address
  49 .Op Fl c Ar cipher_spec
  50 .Op Fl D Oo Ar bind_address : Oc Ns Ar port
  51 .Op Fl E Ar log_file
  52 .Op Fl e Ar escape_char
  53 .Op Fl F Ar configfile
  54 .Op Fl I Ar pkcs11
  55 .Op Fl i Ar identity_file
  56 .Op Fl J Ar destination
  57 .Op Fl L Ar address
  58 .Op Fl l Ar login_name
  59 .Op Fl m Ar mac_spec
  60 .Op Fl O Ar ctl_cmd
  61 .Op Fl o Ar option
  62 .Op Fl p Ar port
  63 .Op Fl Q Ar query_option
  64 .Op Fl R Ar address
  65 .Op Fl S Ar ctl_path
  66 .Op Fl W Ar host : Ns Ar port
  67 .Op Fl w Ar local_tun Ns Op : Ns Ar remote_tun
  68 .Ar destination
  69 .Op Ar command
  70 .Sh DESCRIPTION
  71 .Nm
  72 (SSH client) is a program for logging into a remote machine and for
  73 executing commands on a remote machine.
  74 It is intended to provide secure encrypted communications between
  75 two untrusted hosts over an insecure network.
  76 X11 connections, arbitrary TCP ports and
  77 .Ux Ns -domain
  78 sockets can also be forwarded over the secure channel.
  79 .Pp
  80 .Nm
  81 connects and logs into the specified
  82 .Ar destination ,
  83 which may be specified as either
  84 .Sm off
  85 .Oo user @ Oc hostname
  86 .Sm on
  87 or a URI of the form
  88 .Sm off
  89 .No ssh:// Oo user @ Oc hostname Op : port .
  90 .Sm on
  91 The user must prove
  92 his/her identity to the remote machine using one of several methods
  93 (see below).
  94 .Pp
  95 If a
  96 .Ar command
  97 is specified,
  98 it is executed on the remote host instead of a login shell.
  99 .Pp
 100 The options are as follows:
 101 .Pp
 102 .Bl -tag -width Ds -compact
 103 .It Fl 4
 104 Forces
 105 .Nm
 106 to use IPv4 addresses only.
 107 .Pp
 108 .It Fl 6
 109 Forces
 110 .Nm
 111 to use IPv6 addresses only.
 112 .Pp
 113 .It Fl A
 114 Enables forwarding of the authentication agent connection.
 115 This can also be specified on a per-host basis in a configuration file.
 116 .Pp
 117 Agent forwarding should be enabled with caution.
 118 Users with the ability to bypass file permissions on the remote host
 119 (for the agent's
 120 .Ux Ns -domain
 121 socket) can access the local agent through the forwarded connection.
 122 An attacker cannot obtain key material from the agent,
 123 however they can perform operations on the keys that enable them to
 124 authenticate using the identities loaded into the agent.
 125 .Pp
 126 .It Fl a
 127 Disables forwarding of the authentication agent connection.
 128 .Pp
 129 .It Fl B Ar bind_interface
 130 Bind to the address of
 131 .Ar bind_interface
 132 before attempting to connect to the destination host.
 133 This is only useful on systems with more than one address.
 134 .Pp
 135 .It Fl b Ar bind_address
 136 Use
 137 .Ar bind_address
 138 on the local machine as the source address
 139 of the connection.
 140 Only useful on systems with more than one address.
 141 .Pp
 142 .It Fl C
 143 Requests compression of all data (including stdin, stdout, stderr, and
 144 data for forwarded X11, TCP and
 145 .Ux Ns -domain
 146 connections).
 147 The compression algorithm is the same used by
 148 .Xr gzip 1 .
 149 Compression is desirable on modem lines and other
 150 slow connections, but will only slow down things on fast networks.
 151 The default value can be set on a host-by-host basis in the
 152 configuration files; see the
 153 .Cm Compression
 154 option.
 155 .Pp
 156 .It Fl c Ar cipher_spec
 157 Selects the cipher specification for encrypting the session.
 158 .Ar cipher_spec
 159 is a comma-separated list of ciphers
 160 listed in order of preference.
 161 See the
 162 .Cm Ciphers
 163 keyword in
 164 .Xr ssh_config 5
 165 for more information.
 166 .Pp
 167 .It Fl D Xo
 168 .Sm off
 169 .Oo Ar bind_address : Oc
 170 .Ar port
 171 .Sm on
 172 .Xc
 173 Specifies a local
 174 .Dq dynamic
 175 application-level port forwarding.
 176 This works by allocating a socket to listen to
 177 .Ar port
 178 on the local side, optionally bound to the specified
 179 .Ar bind_address .
 180 Whenever a connection is made to this port, the
 181 connection is forwarded over the secure channel, and the application
 182 protocol is then used to determine where to connect to from the
 183 remote machine.
 184 Currently the SOCKS4 and SOCKS5 protocols are supported, and
 185 .Nm
 186 will act as a SOCKS server.
 187 Only root can forward privileged ports.
 188 Dynamic port forwardings can also be specified in the configuration file.
 189 .Pp
 190 IPv6 addresses can be specified by enclosing the address in square brackets.
 191 Only the superuser can forward privileged ports.
 192 By default, the local port is bound in accordance with the
 193 .Cm GatewayPorts
 194 setting.
 195 However, an explicit
 196 .Ar bind_address
 197 may be used to bind the connection to a specific address.
 198 The
 199 .Ar bind_address
 200 of
 201 .Dq localhost
 202 indicates that the listening port be bound for local use only, while an
 203 empty address or
 204 .Sq *
 205 indicates that the port should be available from all interfaces.
 206 .Pp
 207 .It Fl E Ar log_file
 208 Append debug logs to
 209 .Ar log_file
 210 instead of standard error.
 211 .Pp
 212 .It Fl e Ar escape_char
 213 Sets the escape character for sessions with a pty (default:
 214 .Ql ~ ) .
 215 The escape character is only recognized at the beginning of a line.
 216 The escape character followed by a dot
 217 .Pq Ql \&.
 218 closes the connection;
 219 followed by control-Z suspends the connection;
 220 and followed by itself sends the escape character once.
 221 Setting the character to
 222 .Dq none
 223 disables any escapes and makes the session fully transparent.
 224 .Pp
 225 .It Fl F Ar configfile
 226 Specifies an alternative per-user configuration file.
 227 If a configuration file is given on the command line,
 228 the system-wide configuration file
 229 .Pq Pa /etc/ssh/ssh_config
 230 will be ignored.
 231 The default for the per-user configuration file is
 232 .Pa ~/.ssh/config .
 233 .Pp
 234 .It Fl f
 235 Requests
 236 .Nm
 237 to go to background just before command execution.
 238 This is useful if
 239 .Nm
 240 is going to ask for passwords or passphrases, but the user
 241 wants it in the background.
 242 This implies
 243 .Fl n .
 244 The recommended way to start X11 programs at a remote site is with
 245 something like
 246 .Ic ssh -f host xterm .
 247 .Pp
 248 If the
 249 .Cm ExitOnForwardFailure
 250 configuration option is set to
 251 .Dq yes ,
 252 then a client started with
 253 .Fl f
 254 will wait for all remote port forwards to be successfully established
 255 before placing itself in the background.
 256 .Pp
 257 .It Fl G
 258 Causes
 259 .Nm
 260 to print its configuration after evaluating
 261 .Cm Host
 262 and
 263 .Cm Match
 264 blocks and exit.
 265 .Pp
 266 .It Fl g
 267 Allows remote hosts to connect to local forwarded ports.
 268 If used on a multiplexed connection, then this option must be specified
 269 on the master process.
 270 .Pp
 271 .It Fl I Ar pkcs11
 272 Specify the PKCS#11 shared library
 273 .Nm
 274 should use to communicate with a PKCS#11 token providing the user's
 275 private RSA key.
 276 .Pp
 277 .It Fl i Ar identity_file
 278 Selects a file from which the identity (private key) for
 279 public key authentication is read.
 280 The default is
 281 .Pa ~/.ssh/id_dsa ,
 282 .Pa ~/.ssh/id_ecdsa ,
 283 .Pa ~/.ssh/id_ed25519
 284 and
 285 .Pa ~/.ssh/id_rsa .
 286 Identity files may also be specified on
 287 a per-host basis in the configuration file.
 288 It is possible to have multiple
 289 .Fl i
 290 options (and multiple identities specified in
 291 configuration files).
 292 If no certificates have been explicitly specified by the
 293 .Cm CertificateFile
 294 directive,
 295 .Nm
 296 will also try to load certificate information from the filename obtained
 297 by appending
 298 .Pa -cert.pub
 299 to identity filenames.
 300 .Pp
 301 .It Fl J Ar destination
 302 Connect to the target host by first making a
 303 .Nm
 304 connection to the jump host described by
 305 .Ar destination
 306 and then establishing a TCP forwarding to the ultimate destination from
 307 there.
 308 Multiple jump hops may be specified separated by comma characters.
 309 This is a shortcut to specify a
 310 .Cm ProxyJump
 311 configuration directive.
 312 .Pp
 313 .It Fl K
 314 Enables GSSAPI-based authentication and forwarding (delegation) of GSSAPI
 315 credentials to the server.
 316 .Pp
 317 .It Fl k
 318 Disables forwarding (delegation) of GSSAPI credentials to the server.
 319 .Pp
 320 .It Fl L Xo
 321 .Sm off
 322 .Oo Ar bind_address : Oc
 323 .Ar port : host : hostport
 324 .Sm on
 325 .Xc
 326 .It Fl L Xo
 327 .Sm off
 328 .Oo Ar bind_address : Oc
 329 .Ar port : remote_socket
 330 .Sm on
 331 .Xc
 332 .It Fl L Xo
 333 .Sm off
 334 .Ar local_socket : host : hostport
 335 .Sm on
 336 .Xc
 337 .It Fl L Xo
 338 .Sm off
 339 .Ar local_socket : remote_socket
 340 .Sm on
 341 .Xc
 342 Specifies that connections to the given TCP port or Unix socket on the local
 343 (client) host are to be forwarded to the given host and port, or Unix socket,
 344 on the remote side.
 345 This works by allocating a socket to listen to either a TCP
 346 .Ar port
 347 on the local side, optionally bound to the specified
 348 .Ar bind_address ,
 349 or to a Unix socket.
 350 Whenever a connection is made to the local port or socket, the
 351 connection is forwarded over the secure channel, and a connection is
 352 made to either
 353 .Ar host
 354 port
 355 .Ar hostport ,
 356 or the Unix socket
 357 .Ar remote_socket ,
 358 from the remote machine.
 359 .Pp
 360 Port forwardings can also be specified in the configuration file.
 361 Only the superuser can forward privileged ports.
 362 IPv6 addresses can be specified by enclosing the address in square brackets.
 363 .Pp
 364 By default, the local port is bound in accordance with the
 365 .Cm GatewayPorts
 366 setting.
 367 However, an explicit
 368 .Ar bind_address
 369 may be used to bind the connection to a specific address.
 370 The
 371 .Ar bind_address
 372 of
 373 .Dq localhost
 374 indicates that the listening port be bound for local use only, while an
 375 empty address or
 376 .Sq *
 377 indicates that the port should be available from all interfaces.
 378 .Pp
 379 .It Fl l Ar login_name
 380 Specifies the user to log in as on the remote machine.
 381 This also may be specified on a per-host basis in the configuration file.
 382 .Pp
 383 .It Fl M
 384 Places the
 385 .Nm
 386 client into
 387 .Dq master
 388 mode for connection sharing.
 389 Multiple
 390 .Fl M
 391 options places
 392 .Nm
 393 into
 394 .Dq master
 395 mode with confirmation required before slave connections are accepted.
 396 Refer to the description of
 397 .Cm ControlMaster
 398 in
 399 .Xr ssh_config 5
 400 for details.
 401 .Pp
 402 .It Fl m Ar mac_spec
 403 A comma-separated list of MAC (message authentication code) algorithms,
 404 specified in order of preference.
 405 See the
 406 .Cm MACs
 407 keyword for more information.
 408 .Pp
 409 .It Fl N
 410 Do not execute a remote command.
 411 This is useful for just forwarding ports.
 412 .Pp
 413 .It Fl n
 414 Redirects stdin from
 415 .Pa /dev/null
 416 (actually, prevents reading from stdin).
 417 This must be used when
 418 .Nm
 419 is run in the background.
 420 A common trick is to use this to run X11 programs on a remote machine.
 421 For example,
 422 .Ic ssh -n shadows.cs.hut.fi emacs &
 423 will start an emacs on shadows.cs.hut.fi, and the X11
 424 connection will be automatically forwarded over an encrypted channel.
 425 The
 426 .Nm
 427 program will be put in the background.
 428 (This does not work if
 429 .Nm
 430 needs to ask for a password or passphrase; see also the
 431 .Fl f
 432 option.)
 433 .Pp
 434 .It Fl O Ar ctl_cmd
 435 Control an active connection multiplexing master process.
 436 When the
 437 .Fl O
 438 option is specified, the
 439 .Ar ctl_cmd
 440 argument is interpreted and passed to the master process.
 441 Valid commands are:
 442 .Dq check
 443 (check that the master process is running),
 444 .Dq forward
 445 (request forwardings without command execution),
 446 .Dq cancel
 447 (cancel forwardings),
 448 .Dq exit
 449 (request the master to exit), and
 450 .Dq stop
 451 (request the master to stop accepting further multiplexing requests).
 452 .Pp
 453 .It Fl o Ar option
 454 Can be used to give options in the format used in the configuration file.
 455 This is useful for specifying options for which there is no separate
 456 command-line flag.
 457 For full details of the options listed below, and their possible values, see
 458 .Xr ssh_config 5 .
 459 .Pp
 460 .Bl -tag -width Ds -offset indent -compact
 461 .It AddKeysToAgent
 462 .It AddressFamily
 463 .It BatchMode
 464 .It BindAddress
 465 .It CanonicalDomains
 466 .It CanonicalizeFallbackLocal
 467 .It CanonicalizeHostname
 468 .It CanonicalizeMaxDots
 469 .It CanonicalizePermittedCNAMEs
 470 .It CertificateFile
 471 .It ChallengeResponseAuthentication
 472 .It CheckHostIP
 473 .It Ciphers
 474 .It ClearAllForwardings
 475 .It Compression
 476 .It ConnectionAttempts
 477 .It ConnectTimeout
 478 .It ControlMaster
 479 .It ControlPath
 480 .It ControlPersist
 481 .It DynamicForward
 482 .It EscapeChar
 483 .It ExitOnForwardFailure
 484 .It FingerprintHash
 485 .It ForwardAgent
 486 .It ForwardX11
 487 .It ForwardX11Timeout
 488 .It ForwardX11Trusted
 489 .It GatewayPorts
 490 .It GlobalKnownHostsFile
 491 .It GSSAPIAuthentication
 492 .It GSSAPIDelegateCredentials
 493 .It HashKnownHosts
 494 .It Host
 495 .It HostbasedAuthentication
 496 .It HostbasedKeyTypes
 497 .It HostKeyAlgorithms
 498 .It HostKeyAlias
 499 .It HostName
 500 .It IdentitiesOnly
 501 .It IdentityAgent
 502 .It IdentityFile
 503 .It IPQoS
 504 .It KbdInteractiveAuthentication
 505 .It KbdInteractiveDevices
 506 .It KexAlgorithms
 507 .It LocalCommand
 508 .It LocalForward
 509 .It LogLevel
 510 .It MACs
 511 .It Match
 512 .It NoHostAuthenticationForLocalhost
 513 .It NumberOfPasswordPrompts
 514 .It PasswordAuthentication
 515 .It PermitLocalCommand
 516 .It PKCS11Provider
 517 .It Port
 518 .It PreferredAuthentications
 519 .It ProxyCommand
 520 .It ProxyJump
 521 .It ProxyUseFdpass
 522 .It PubkeyAcceptedKeyTypes
 523 .It PubkeyAuthentication
 524 .It RekeyLimit
 525 .It RemoteCommand
 526 .It RemoteForward
 527 .It RequestTTY
 528 .It SendEnv
 529 .It ServerAliveInterval
 530 .It ServerAliveCountMax
 531 .It SetEnv
 532 .It StreamLocalBindMask
 533 .It StreamLocalBindUnlink
 534 .It StrictHostKeyChecking
 535 .It TCPKeepAlive
 536 .It Tunnel
 537 .It TunnelDevice
 538 .It UpdateHostKeys
 539 .It User
 540 .It UserKnownHostsFile
 541 .It VerifyHostKeyDNS
 542 .It VersionAddendum
 543 .It VisualHostKey
 544 .It XAuthLocation
 545 .El
 546 .Pp
 547 .It Fl p Ar port
 548 Port to connect to on the remote host.
 549 This can be specified on a
 550 per-host basis in the configuration file.
 551 .Pp
 552 .It Fl Q Ar query_option
 553 Queries
 554 .Nm
 555 for the algorithms supported for the specified version 2.
 556 The available features are:
 557 .Ar cipher
 558 (supported symmetric ciphers),
 559 .Ar cipher-auth
 560 (supported symmetric ciphers that support authenticated encryption),
 561 .Ar mac
 562 (supported message integrity codes),
 563 .Ar kex
 564 (key exchange algorithms),
 565 .Ar key
 566 (key types),
 567 .Ar key-cert
 568 (certificate key types),
 569 .Ar key-plain
 570 (non-certificate key types), and
 571 .Ar protocol-version
 572 (supported SSH protocol versions).
 573 .Pp
 574 .It Fl q
 575 Quiet mode.
 576 Causes most warning and diagnostic messages to be suppressed.
 577 .Pp
 578 .It Fl R Xo
 579 .Sm off
 580 .Oo Ar bind_address : Oc
 581 .Ar port : host : hostport
 582 .Sm on
 583 .Xc
 584 .It Fl R Xo
 585 .Sm off
 586 .Oo Ar bind_address : Oc
 587 .Ar port : local_socket
 588 .Sm on
 589 .Xc
 590 .It Fl R Xo
 591 .Sm off
 592 .Ar remote_socket : host : hostport
 593 .Sm on
 594 .Xc
 595 .It Fl R Xo
 596 .Sm off
 597 .Ar remote_socket : local_socket
 598 .Sm on
 599 .Xc
 600 .It Fl R Xo
 601 .Sm off
 602 .Oo Ar bind_address : Oc
 603 .Ar port
 604 .Sm on
 605 .Xc
 606 Specifies that connections to the given TCP port or Unix socket on the remote
 607 (server) host are to be forwarded to the local side.
 608 .Pp
 609 This works by allocating a socket to listen to either a TCP
 610 .Ar port
 611 or to a Unix socket on the remote side.
 612 Whenever a connection is made to this port or Unix socket, the
 613 connection is forwarded over the secure channel, and a connection
 614 is made from the local machine to either an explicit destination specified by
 615 .Ar host
 616 port
 617 .Ar hostport ,
 618 or
 619 .Ar local_socket ,
 620 or, if no explicit destination was specified,
 621 .Nm
 622 will act as a SOCKS 4/5 proxy and forward connections to the destinations
 623 requested by the remote SOCKS client.
 624 .Pp
 625 Port forwardings can also be specified in the configuration file.
 626 Privileged ports can be forwarded only when
 627 logging in as root on the remote machine.
 628 IPv6 addresses can be specified by enclosing the address in square brackets.
 629 .Pp
 630 By default, TCP listening sockets on the server will be bound to the loopback
 631 interface only.
 632 This may be overridden by specifying a
 633 .Ar bind_address .
 634 An empty
 635 .Ar bind_address ,
 636 or the address
 637 .Ql * ,
 638 indicates that the remote socket should listen on all interfaces.
 639 Specifying a remote
 640 .Ar bind_address
 641 will only succeed if the server's
 642 .Cm GatewayPorts
 643 option is enabled (see
 644 .Xr sshd_config 5 ) .
 645 .Pp
 646 If the
 647 .Ar port
 648 argument is
 649 .Ql 0 ,
 650 the listen port will be dynamically allocated on the server and reported
 651 to the client at run time.
 652 When used together with
 653 .Ic -O forward
 654 the allocated port will be printed to the standard output.
 655 .Pp
 656 .It Fl S Ar ctl_path
 657 Specifies the location of a control socket for connection sharing,
 658 or the string
 659 .Dq none
 660 to disable connection sharing.
 661 Refer to the description of
 662 .Cm ControlPath
 663 and
 664 .Cm ControlMaster
 665 in
 666 .Xr ssh_config 5
 667 for details.
 668 .Pp
 669 .It Fl s
 670 May be used to request invocation of a subsystem on the remote system.
 671 Subsystems facilitate the use of SSH
 672 as a secure transport for other applications (e.g.\&
 673 .Xr sftp 1 ) .
 674 The subsystem is specified as the remote command.
 675 .Pp
 676 .It Fl T
 677 Disable pseudo-terminal allocation.
 678 .Pp
 679 .It Fl t
 680 Force pseudo-terminal allocation.
 681 This can be used to execute arbitrary
 682 screen-based programs on a remote machine, which can be very useful,
 683 e.g. when implementing menu services.
 684 Multiple
 685 .Fl t
 686 options force tty allocation, even if
 687 .Nm
 688 has no local tty.
 689 .Pp
 690 .It Fl V
 691 Display the version number and exit.
 692 .Pp
 693 .It Fl v
 694 Verbose mode.
 695 Causes
 696 .Nm
 697 to print debugging messages about its progress.
 698 This is helpful in
 699 debugging connection, authentication, and configuration problems.
 700 Multiple
 701 .Fl v
 702 options increase the verbosity.
 703 The maximum is 3.
 704 .Pp
 705 .It Fl W Ar host : Ns Ar port
 706 Requests that standard input and output on the client be forwarded to
 707 .Ar host
 708 on
 709 .Ar port
 710 over the secure channel.
 711 Implies
 712 .Fl N ,
 713 .Fl T ,
 714 .Cm ExitOnForwardFailure
 715 and
 716 .Cm ClearAllForwardings ,
 717 though these can be overridden in the configuration file or using
 718 .Fl o
 719 command line options.
 720 .Pp
 721 .It Fl w Xo
 722 .Ar local_tun Ns Op : Ns Ar remote_tun
 723 .Xc
 724 Requests
 725 tunnel
 726 device forwarding with the specified
 727 .Xr tun 4
 728 devices between the client
 729 .Pq Ar local_tun
 730 and the server
 731 .Pq Ar remote_tun .
 732 .Pp
 733 The devices may be specified by numerical ID or the keyword
 734 .Dq any ,
 735 which uses the next available tunnel device.
 736 If
 737 .Ar remote_tun
 738 is not specified, it defaults to
 739 .Dq any .
 740 See also the
 741 .Cm Tunnel
 742 and
 743 .Cm TunnelDevice
 744 directives in
 745 .Xr ssh_config 5 .
 746 .Pp
 747 If the
 748 .Cm Tunnel
 749 directive is unset, it will be set to the default tunnel mode, which is
 750 .Dq point-to-point .
 751 If a different
 752 .Cm Tunnel
 753 forwarding mode it desired, then it should be specified before
 754 .Fl w .
 755 .Pp
 756 .It Fl X
 757 Enables X11 forwarding.
 758 This can also be specified on a per-host basis in a configuration file.
 759 .Pp
 760 X11 forwarding should be enabled with caution.
 761 Users with the ability to bypass file permissions on the remote host
 762 (for the user's X authorization database)
 763 can access the local X11 display through the forwarded connection.
 764 An attacker may then be able to perform activities such as keystroke monitoring.
 765 .Pp
 766 For this reason, X11 forwarding is subjected to X11 SECURITY extension
 767 restrictions by default.
 768 Please refer to the
 769 .Nm
 770 .Fl Y
 771 option and the
 772 .Cm ForwardX11Trusted
 773 directive in
 774 .Xr ssh_config 5
 775 for more information.
 776 .Pp
 777 .It Fl x
 778 Disables X11 forwarding.
 779 .Pp
 780 .It Fl Y
 781 Enables trusted X11 forwarding.
 782 Trusted X11 forwardings are not subjected to the X11 SECURITY extension
 783 controls.
 784 .Pp
 785 .It Fl y
 786 Send log information using the
 787 .Xr syslog 3
 788 system module.
 789 By default this information is sent to stderr.
 790 .El
 791 .Pp
 792 .Nm
 793 may additionally obtain configuration data from
 794 a per-user configuration file and a system-wide configuration file.
 795 The file format and configuration options are described in
 796 .Xr ssh_config 5 .
 797 .Sh AUTHENTICATION
 798 The OpenSSH SSH client supports SSH protocol 2.
 799 .Pp
 800 The methods available for authentication are:
 801 GSSAPI-based authentication,
 802 host-based authentication,
 803 public key authentication,
 804 challenge-response authentication,
 805 and password authentication.
 806 Authentication methods are tried in the order specified above,
 807 though
 808 .Cm PreferredAuthentications
 809 can be used to change the default order.
 810 .Pp
 811 Host-based authentication works as follows:
 812 If the machine the user logs in from is listed in
 813 .Pa /etc/hosts.equiv
 814 or
 815 .Pa /etc/shosts.equiv
 816 on the remote machine, and the user names are
 817 the same on both sides, or if the files
 818 .Pa ~/.rhosts
 819 or
 820 .Pa ~/.shosts
 821 exist in the user's home directory on the
 822 remote machine and contain a line containing the name of the client
 823 machine and the name of the user on that machine, the user is
 824 considered for login.
 825 Additionally, the server
 826 .Em must
 827 be able to verify the client's
 828 host key (see the description of
 829 .Pa /etc/ssh/ssh_known_hosts
 830 and
 831 .Pa ~/.ssh/known_hosts ,
 832 below)
 833 for login to be permitted.
 834 This authentication method closes security holes due to IP
 835 spoofing, DNS spoofing, and routing spoofing.
 836 [Note to the administrator:
 837 .Pa /etc/hosts.equiv ,
 838 .Pa ~/.rhosts ,
 839 and the rlogin/rsh protocol in general, are inherently insecure and should be
 840 disabled if security is desired.]
 841 .Pp
 842 Public key authentication works as follows:
 843 The scheme is based on public-key cryptography,
 844 using cryptosystems
 845 where encryption and decryption are done using separate keys,
 846 and it is unfeasible to derive the decryption key from the encryption key.
 847 The idea is that each user creates a public/private
 848 key pair for authentication purposes.
 849 The server knows the public key, and only the user knows the private key.
 850 .Nm
 851 implements public key authentication protocol automatically,
 852 using one of the DSA, ECDSA, Ed25519 or RSA algorithms.
 853 The HISTORY section of
 854 .Xr ssl 8
 855 contains a brief discussion of the DSA and RSA algorithms.
 856 .Pp
 857 The file
 858 .Pa ~/.ssh/authorized_keys
 859 lists the public keys that are permitted for logging in.
 860 When the user logs in, the
 861 .Nm
 862 program tells the server which key pair it would like to use for
 863 authentication.
 864 The client proves that it has access to the private key
 865 and the server checks that the corresponding public key
 866 is authorized to accept the account.
 867 .Pp
 868 The server may inform the client of errors that prevented public key
 869 authentication from succeeding after authentication completes using a
 870 different method.
 871 These may be viewed by increasing the
 872 .Cm LogLevel
 873 to
 874 .Cm DEBUG
 875 or higher (e.g. by using the
 876 .Fl v
 877 flag).
 878 .Pp
 879 The user creates his/her key pair by running
 880 .Xr ssh-keygen 1 .
 881 This stores the private key in
 882 .Pa ~/.ssh/id_dsa
 883 (DSA),
 884 .Pa ~/.ssh/id_ecdsa
 885 (ECDSA),
 886 .Pa ~/.ssh/id_ed25519
 887 (Ed25519),
 888 or
 889 .Pa ~/.ssh/id_rsa
 890 (RSA)
 891 and stores the public key in
 892 .Pa ~/.ssh/id_dsa.pub
 893 (DSA),
 894 .Pa ~/.ssh/id_ecdsa.pub
 895 (ECDSA),
 896 .Pa ~/.ssh/id_ed25519.pub
 897 (Ed25519),
 898 or
 899 .Pa ~/.ssh/id_rsa.pub
 900 (RSA)
 901 in the user's home directory.
 902 The user should then copy the public key
 903 to
 904 .Pa ~/.ssh/authorized_keys
 905 in his/her home directory on the remote machine.
 906 The
 907 .Pa authorized_keys
 908 file corresponds to the conventional
 909 .Pa ~/.rhosts
 910 file, and has one key
 911 per line, though the lines can be very long.
 912 After this, the user can log in without giving the password.
 913 .Pp
 914 A variation on public key authentication
 915 is available in the form of certificate authentication:
 916 instead of a set of public/private keys,
 917 signed certificates are used.
 918 This has the advantage that a single trusted certification authority
 919 can be used in place of many public/private keys.
 920 See the CERTIFICATES section of
 921 .Xr ssh-keygen 1
 922 for more information.
 923 .Pp
 924 The most convenient way to use public key or certificate authentication
 925 may be with an authentication agent.
 926 See
 927 .Xr ssh-agent 1
 928 and (optionally) the
 929 .Cm AddKeysToAgent
 930 directive in
 931 .Xr ssh_config 5
 932 for more information.
 933 .Pp
 934 Challenge-response authentication works as follows:
 935 The server sends an arbitrary
 936 .Qq challenge
 937 text, and prompts for a response.
 938 Examples of challenge-response authentication include
 939 .Bx
 940 Authentication (see
 941 .Xr login.conf 5 )
 942 and PAM (some
 943 .Pf non- Ox
 944 systems).
 945 .Pp
 946 Finally, if other authentication methods fail,
 947 .Nm
 948 prompts the user for a password.
 949 The password is sent to the remote
 950 host for checking; however, since all communications are encrypted,
 951 the password cannot be seen by someone listening on the network.
 952 .Pp
 953 .Nm
 954 automatically maintains and checks a database containing
 955 identification for all hosts it has ever been used with.
 956 Host keys are stored in
 957 .Pa ~/.ssh/known_hosts
 958 in the user's home directory.
 959 Additionally, the file
 960 .Pa /etc/ssh/ssh_known_hosts
 961 is automatically checked for known hosts.
 962 Any new hosts are automatically added to the user's file.
 963 If a host's identification ever changes,
 964 .Nm
 965 warns about this and disables password authentication to prevent
 966 server spoofing or man-in-the-middle attacks,
 967 which could otherwise be used to circumvent the encryption.
 968 The
 969 .Cm StrictHostKeyChecking
 970 option can be used to control logins to machines whose
 971 host key is not known or has changed.
 972 .Pp
 973 When the user's identity has been accepted by the server, the server
 974 either executes the given command in a non-interactive session or,
 975 if no command has been specified, logs into the machine and gives
 976 the user a normal shell as an interactive session.
 977 All communication with
 978 the remote command or shell will be automatically encrypted.
 979 .Pp
 980 If an interactive session is requested
 981 .Nm
 982 by default will only request a pseudo-terminal (pty) for interactive
 983 sessions when the client has one.
 984 The flags
 985 .Fl T
 986 and
 987 .Fl t
 988 can be used to override this behaviour.
 989 .Pp
 990 If a pseudo-terminal has been allocated the
 991 user may use the escape characters noted below.
 992 .Pp
 993 If no pseudo-terminal has been allocated,
 994 the session is transparent and can be used to reliably transfer binary data.
 995 On most systems, setting the escape character to
 996 .Dq none
 997 will also make the session transparent even if a tty is used.
 998 .Pp
 999 The session terminates when the command or shell on the remote
1000 machine exits and all X11 and TCP connections have been closed.
1001 .Sh ESCAPE CHARACTERS
1002 When a pseudo-terminal has been requested,
1003 .Nm
1004 supports a number of functions through the use of an escape character.
1005 .Pp
1006 A single tilde character can be sent as
1007 .Ic ~~
1008 or by following the tilde by a character other than those described below.
1009 The escape character must always follow a newline to be interpreted as
1010 special.
1011 The escape character can be changed in configuration files using the
1012 .Cm EscapeChar
1013 configuration directive or on the command line by the
1014 .Fl e
1015 option.
1016 .Pp
1017 The supported escapes (assuming the default
1018 .Ql ~ )
1019 are:
1020 .Bl -tag -width Ds
1021 .It Cm ~.
1022 Disconnect.
1023 .It Cm ~^Z
1024 Background
1025 .Nm .
1026 .It Cm ~#
1027 List forwarded connections.
1028 .It Cm ~&
1029 Background
1030 .Nm
1031 at logout when waiting for forwarded connection / X11 sessions to terminate.
1032 .It Cm ~?
1033 Display a list of escape characters.
1034 .It Cm ~B
1035 Send a BREAK to the remote system
1036 (only useful if the peer supports it).
1037 .It Cm ~C
1038 Open command line.
1039 Currently this allows the addition of port forwardings using the
1040 .Fl L ,
1041 .Fl R
1042 and
1043 .Fl D
1044 options (see above).
1045 It also allows the cancellation of existing port-forwardings
1046 with
1047 .Sm off
1048 .Fl KL Oo Ar bind_address : Oc Ar port
1049 .Sm on
1050 for local,
1051 .Sm off
1052 .Fl KR Oo Ar bind_address : Oc Ar port
1053 .Sm on
1054 for remote and
1055 .Sm off
1056 .Fl KD Oo Ar bind_address : Oc Ar port
1057 .Sm on
1058 for dynamic port-forwardings.
1059 .Ic !\& Ns Ar command
1060 allows the user to execute a local command if the
1061 .Ic PermitLocalCommand
1062 option is enabled in
1063 .Xr ssh_config 5 .
1064 Basic help is available, using the
1065 .Fl h
1066 option.
1067 .It Cm ~R
1068 Request rekeying of the connection
1069 (only useful if the peer supports it).
1070 .It Cm ~V
1071 Decrease the verbosity
1072 .Pq Ic LogLevel
1073 when errors are being written to stderr.
1074 .It Cm ~v
1075 Increase the verbosity
1076 .Pq Ic LogLevel
1077 when errors are being written to stderr.
1078 .El
1079 .Sh TCP FORWARDING
1080 Forwarding of arbitrary TCP connections over the secure channel can
1081 be specified either on the command line or in a configuration file.
1082 One possible application of TCP forwarding is a secure connection to a
1083 mail server; another is going through firewalls.
1084 .Pp
1085 In the example below, we look at encrypting communication between
1086 an IRC client and server, even though the IRC server does not directly
1087 support encrypted communications.
1088 This works as follows:
1089 the user connects to the remote host using
1090 .Nm ,
1091 specifying a port to be used to forward connections
1092 to the remote server.
1093 After that it is possible to start the service which is to be encrypted
1094 on the client machine,
1095 connecting to the same local port,
1096 and
1097 .Nm
1098 will encrypt and forward the connection.
1099 .Pp
1100 The following example tunnels an IRC session from client machine
1101 .Dq 127.0.0.1
1102 (localhost)
1103 to remote server
1104 .Dq server.example.com :
1105 .Bd -literal -offset 4n
1106 $ ssh -f -L 1234:localhost:6667 server.example.com sleep 10
1107 $ irc -c '#users' -p 1234 pinky 127.0.0.1
1108 .Ed
1109 .Pp
1110 This tunnels a connection to IRC server
1111 .Dq server.example.com ,
1112 joining channel
1113 .Dq #users ,
1114 nickname
1115 .Dq pinky ,
1116 using port 1234.
1117 It doesn't matter which port is used,
1118 as long as it's greater than 1023
1119 (remember, only root can open sockets on privileged ports)
1120 and doesn't conflict with any ports already in use.
1121 The connection is forwarded to port 6667 on the remote server,
1122 since that's the standard port for IRC services.
1123 .Pp
1124 The
1125 .Fl f
1126 option backgrounds
1127 .Nm
1128 and the remote command
1129 .Dq sleep 10
1130 is specified to allow an amount of time
1131 (10 seconds, in the example)
1132 to start the service which is to be tunnelled.
1133 If no connections are made within the time specified,
1134 .Nm
1135 will exit.
1136 .Sh X11 FORWARDING
1137 If the
1138 .Cm ForwardX11
1139 variable is set to
1140 .Dq yes
1141 (or see the description of the
1142 .Fl X ,
1143 .Fl x ,
1144 and
1145 .Fl Y
1146 options above)
1147 and the user is using X11 (the
1148 .Ev DISPLAY
1149 environment variable is set), the connection to the X11 display is
1150 automatically forwarded to the remote side in such a way that any X11
1151 programs started from the shell (or command) will go through the
1152 encrypted channel, and the connection to the real X server will be made
1153 from the local machine.
1154 The user should not manually set
1155 .Ev DISPLAY .
1156 Forwarding of X11 connections can be
1157 configured on the command line or in configuration files.
1158 .Pp
1159 The
1160 .Ev DISPLAY
1161 value set by
1162 .Nm
1163 will point to the server machine, but with a display number greater than zero.
1164 This is normal, and happens because
1165 .Nm
1166 creates a
1167 .Dq proxy
1168 X server on the server machine for forwarding the
1169 connections over the encrypted channel.
1170 .Pp
1171 .Nm
1172 will also automatically set up Xauthority data on the server machine.
1173 For this purpose, it will generate a random authorization cookie,
1174 store it in Xauthority on the server, and verify that any forwarded
1175 connections carry this cookie and replace it by the real cookie when
1176 the connection is opened.
1177 The real authentication cookie is never
1178 sent to the server machine (and no cookies are sent in the plain).
1179 .Pp
1180 If the
1181 .Cm ForwardAgent
1182 variable is set to
1183 .Dq yes
1184 (or see the description of the
1185 .Fl A
1186 and
1187 .Fl a
1188 options above) and
1189 the user is using an authentication agent, the connection to the agent
1190 is automatically forwarded to the remote side.
1191 .Sh VERIFYING HOST KEYS
1192 When connecting to a server for the first time,
1193 a fingerprint of the server's public key is presented to the user
1194 (unless the option
1195 .Cm StrictHostKeyChecking
1196 has been disabled).
1197 Fingerprints can be determined using
1198 .Xr ssh-keygen 1 :
1199 .Pp
1200 .Dl $ ssh-keygen -l -f /etc/ssh/ssh_host_rsa_key
1201 .Pp
1202 If the fingerprint is already known, it can be matched
1203 and the key can be accepted or rejected.
1204 If only legacy (MD5) fingerprints for the server are available, the
1205 .Xr ssh-keygen 1
1206 .Fl E
1207 option may be used to downgrade the fingerprint algorithm to match.
1208 .Pp
1209 Because of the difficulty of comparing host keys
1210 just by looking at fingerprint strings,
1211 there is also support to compare host keys visually,
1212 using
1213 .Em random art .
1214 By setting the
1215 .Cm VisualHostKey
1216 option to
1217 .Dq yes ,
1218 a small ASCII graphic gets displayed on every login to a server, no matter
1219 if the session itself is interactive or not.
1220 By learning the pattern a known server produces, a user can easily
1221 find out that the host key has changed when a completely different pattern
1222 is displayed.
1223 Because these patterns are not unambiguous however, a pattern that looks
1224 similar to the pattern remembered only gives a good probability that the
1225 host key is the same, not guaranteed proof.
1226 .Pp
1227 To get a listing of the fingerprints along with their random art for
1228 all known hosts, the following command line can be used:
1229 .Pp
1230 .Dl $ ssh-keygen -lv -f ~/.ssh/known_hosts
1231 .Pp
1232 If the fingerprint is unknown,
1233 an alternative method of verification is available:
1234 SSH fingerprints verified by DNS.
1235 An additional resource record (RR),
1236 SSHFP,
1237 is added to a zonefile
1238 and the connecting client is able to match the fingerprint
1239 with that of the key presented.
1240 .Pp
1241 In this example, we are connecting a client to a server,
1242 .Dq host.example.com .
1243 The SSHFP resource records should first be added to the zonefile for
1244 host.example.com:
1245 .Bd -literal -offset indent
1246 $ ssh-keygen -r host.example.com.
1247 .Ed
1248 .Pp
1249 The output lines will have to be added to the zonefile.
1250 To check that the zone is answering fingerprint queries:
1251 .Pp
1252 .Dl $ dig -t SSHFP host.example.com
1253 .Pp
1254 Finally the client connects:
1255 .Bd -literal -offset indent
1256 $ ssh -o "VerifyHostKeyDNS ask" host.example.com
1257 [...]
1258 Matching host key fingerprint found in DNS.
1259 Are you sure you want to continue connecting (yes/no)?
1260 .Ed
1261 .Pp
1262 See the
1263 .Cm VerifyHostKeyDNS
1264 option in
1265 .Xr ssh_config 5
1266 for more information.
1267 .Sh SSH-BASED VIRTUAL PRIVATE NETWORKS
1268 .Nm
1269 contains support for Virtual Private Network (VPN) tunnelling
1270 using the
1271 .Xr tun 4
1272 network pseudo-device,
1273 allowing two networks to be joined securely.
1274 The
1275 .Xr sshd_config 5
1276 configuration option
1277 .Cm PermitTunnel
1278 controls whether the server supports this,
1279 and at what level (layer 2 or 3 traffic).
1280 .Pp
1281 The following example would connect client network 10.0.50.0/24
1282 with remote network 10.0.99.0/24 using a point-to-point connection
1283 from 10.1.1.1 to 10.1.1.2,
1284 provided that the SSH server running on the gateway to the remote network,
1285 at 192.168.1.15, allows it.
1286 .Pp
1287 On the client:
1288 .Bd -literal -offset indent
1289 # ssh -f -w 0:1 192.168.1.15 true
1290 # ifconfig tun0 10.1.1.1 10.1.1.2 netmask 255.255.255.252
1291 # route add 10.0.99.0/24 10.1.1.2
1292 .Ed
1293 .Pp
1294 On the server:
1295 .Bd -literal -offset indent
1296 # ifconfig tun1 10.1.1.2 10.1.1.1 netmask 255.255.255.252
1297 # route add 10.0.50.0/24 10.1.1.1
1298 .Ed
1299 .Pp
1300 Client access may be more finely tuned via the
1301 .Pa /root/.ssh/authorized_keys
1302 file (see below) and the
1303 .Cm PermitRootLogin
1304 server option.
1305 The following entry would permit connections on
1306 .Xr tun 4
1307 device 1 from user
1308 .Dq jane
1309 and on tun device 2 from user
1310 .Dq john ,
1311 if
1312 .Cm PermitRootLogin
1313 is set to
1314 .Dq forced-commands-only :
1315 .Bd -literal -offset 2n
1316 tunnel="1",command="sh /etc/netstart tun1" ssh-rsa ... jane
1317 tunnel="2",command="sh /etc/netstart tun2" ssh-rsa ... john
1318 .Ed
1319 .Pp
1320 Since an SSH-based setup entails a fair amount of overhead,
1321 it may be more suited to temporary setups,
1322 such as for wireless VPNs.
1323 More permanent VPNs are better provided by tools such as
1324 .Xr ipsecctl 8
1325 and
1326 .Xr isakmpd 8 .
1327 .Sh ENVIRONMENT
1328 .Nm
1329 will normally set the following environment variables:
1330 .Bl -tag -width "SSH_ORIGINAL_COMMAND"
1331 .It Ev DISPLAY
1332 The
1333 .Ev DISPLAY
1334 variable indicates the location of the X11 server.
1335 It is automatically set by
1336 .Nm
1337 to point to a value of the form
1338 .Dq hostname:n ,
1339 where
1340 .Dq hostname
1341 indicates the host where the shell runs, and
1342 .Sq n
1343 is an integer \*(Ge 1.
1344 .Nm
1345 uses this special value to forward X11 connections over the secure
1346 channel.
1347 The user should normally not set
1348 .Ev DISPLAY
1349 explicitly, as that
1350 will render the X11 connection insecure (and will require the user to
1351 manually copy any required authorization cookies).
1352 .It Ev HOME
1353 Set to the path of the user's home directory.
1354 .It Ev LOGNAME
1355 Synonym for
1356 .Ev USER ;
1357 set for compatibility with systems that use this variable.
1358 .It Ev MAIL
1359 Set to the path of the user's mailbox.
1360 .It Ev PATH
1361 Set to the default
1362 .Ev PATH ,
1363 as specified when compiling
1364 .Nm .
1365 .It Ev SSH_ASKPASS
1366 If
1367 .Nm
1368 needs a passphrase, it will read the passphrase from the current
1369 terminal if it was run from a terminal.
1370 If
1371 .Nm
1372 does not have a terminal associated with it but
1373 .Ev DISPLAY
1374 and
1375 .Ev SSH_ASKPASS
1376 are set, it will execute the program specified by
1377 .Ev SSH_ASKPASS
1378 and open an X11 window to read the passphrase.
1379 This is particularly useful when calling
1380 .Nm
1381 from a
1382 .Pa .xsession
1383 or related script.
1384 (Note that on some machines it
1385 may be necessary to redirect the input from
1386 .Pa /dev/null
1387 to make this work.)
1388 .It Ev SSH_AUTH_SOCK
1389 Identifies the path of a
1390 .Ux Ns -domain
1391 socket used to communicate with the agent.
1392 .It Ev SSH_CONNECTION
1393 Identifies the client and server ends of the connection.
1394 The variable contains
1395 four space-separated values: client IP address, client port number,
1396 server IP address, and server port number.
1397 .It Ev SSH_ORIGINAL_COMMAND
1398 This variable contains the original command line if a forced command
1399 is executed.
1400 It can be used to extract the original arguments.
1401 .It Ev SSH_TTY
1402 This is set to the name of the tty (path to the device) associated
1403 with the current shell or command.
1404 If the current session has no tty,
1405 this variable is not set.
1406 .It Ev SSH_TUNNEL
1407 Optionally set by
1408 .Xr sshd 8
1409 to contain the interface names assigned if tunnel forwarding was
1410 requested by the client.
1411 .It Ev SSH_USER_AUTH
1412 Optionally set by
1413 .Xr sshd 8 ,
1414 this variable may contain a pathname to a file that lists the authentication
1415 methods successfully used when the session was established, including any
1416 public keys that were used.
1417 .It Ev TZ
1418 This variable is set to indicate the present time zone if it
1419 was set when the daemon was started (i.e. the daemon passes the value
1420 on to new connections).
1421 .It Ev USER
1422 Set to the name of the user logging in.
1423 .El
1424 .Pp
1425 Additionally,
1426 .Nm
1427 reads
1428 .Pa ~/.ssh/environment ,
1429 and adds lines of the format
1430 .Dq VARNAME=value
1431 to the environment if the file exists and users are allowed to
1432 change their environment.
1433 For more information, see the
1434 .Cm PermitUserEnvironment
1435 option in
1436 .Xr sshd_config 5 .
1437 .Sh FILES
1438 .Bl -tag -width Ds -compact
1439 .It Pa ~/.rhosts
1440 This file is used for host-based authentication (see above).
1441 On some machines this file may need to be
1442 world-readable if the user's home directory is on an NFS partition,
1443 because
1444 .Xr sshd 8
1445 reads it as root.
1446 Additionally, this file must be owned by the user,
1447 and must not have write permissions for anyone else.
1448 The recommended
1449 permission for most machines is read/write for the user, and not
1450 accessible by others.
1451 .Pp
1452 .It Pa ~/.shosts
1453 This file is used in exactly the same way as
1454 .Pa .rhosts ,
1455 but allows host-based authentication without permitting login with
1456 rlogin/rsh.
1457 .Pp
1458 .It Pa ~/.ssh/
1459 This directory is the default location for all user-specific configuration
1460 and authentication information.
1461 There is no general requirement to keep the entire contents of this directory
1462 secret, but the recommended permissions are read/write/execute for the user,
1463 and not accessible by others.
1464 .Pp
1465 .It Pa ~/.ssh/authorized_keys
1466 Lists the public keys (DSA, ECDSA, Ed25519, RSA)
1467 that can be used for logging in as this user.
1468 The format of this file is described in the
1469 .Xr sshd 8
1470 manual page.
1471 This file is not highly sensitive, but the recommended
1472 permissions are read/write for the user, and not accessible by others.
1473 .Pp
1474 .It Pa ~/.ssh/config
1475 This is the per-user configuration file.
1476 The file format and configuration options are described in
1477 .Xr ssh_config 5 .
1478 Because of the potential for abuse, this file must have strict permissions:
1479 read/write for the user, and not writable by others.
1480 .Pp
1481 .It Pa ~/.ssh/environment
1482 Contains additional definitions for environment variables; see
1483 .Sx ENVIRONMENT ,
1484 above.
1485 .Pp
1486 .It Pa ~/.ssh/id_dsa
1487 .It Pa ~/.ssh/id_ecdsa
1488 .It Pa ~/.ssh/id_ed25519
1489 .It Pa ~/.ssh/id_rsa
1490 Contains the private key for authentication.
1491 These files
1492 contain sensitive data and should be readable by the user but not
1493 accessible by others (read/write/execute).
1494 .Nm
1495 will simply ignore a private key file if it is accessible by others.
1496 It is possible to specify a passphrase when
1497 generating the key which will be used to encrypt the
1498 sensitive part of this file using AES-128.
1499 .Pp
1500 .It Pa ~/.ssh/id_dsa.pub
1501 .It Pa ~/.ssh/id_ecdsa.pub
1502 .It Pa ~/.ssh/id_ed25519.pub
1503 .It Pa ~/.ssh/id_rsa.pub
1504 Contains the public key for authentication.
1505 These files are not
1506 sensitive and can (but need not) be readable by anyone.
1507 .Pp
1508 .It Pa ~/.ssh/known_hosts
1509 Contains a list of host keys for all hosts the user has logged into
1510 that are not already in the systemwide list of known host keys.
1511 See
1512 .Xr sshd 8
1513 for further details of the format of this file.
1514 .Pp
1515 .It Pa ~/.ssh/rc
1516 Commands in this file are executed by
1517 .Nm
1518 when the user logs in, just before the user's shell (or command) is
1519 started.
1520 See the
1521 .Xr sshd 8
1522 manual page for more information.
1523 .Pp
1524 .It Pa /etc/hosts.equiv
1525 This file is for host-based authentication (see above).
1526 It should only be writable by root.
1527 .Pp
1528 .It Pa /etc/shosts.equiv
1529 This file is used in exactly the same way as
1530 .Pa hosts.equiv ,
1531 but allows host-based authentication without permitting login with
1532 rlogin/rsh.
1533 .Pp
1534 .It Pa /etc/ssh/ssh_config
1535 Systemwide configuration file.
1536 The file format and configuration options are described in
1537 .Xr ssh_config 5 .
1538 .Pp
1539 .It Pa /etc/ssh/ssh_host_key
1540 .It Pa /etc/ssh/ssh_host_dsa_key
1541 .It Pa /etc/ssh/ssh_host_ecdsa_key
1542 .It Pa /etc/ssh/ssh_host_ed25519_key
1543 .It Pa /etc/ssh/ssh_host_rsa_key
1544 These files contain the private parts of the host keys
1545 and are used for host-based authentication.
1546 .Pp
1547 .It Pa /etc/ssh/ssh_known_hosts
1548 Systemwide list of known host keys.
1549 This file should be prepared by the
1550 system administrator to contain the public host keys of all machines in the
1551 organization.
1552 It should be world-readable.
1553 See
1554 .Xr sshd 8
1555 for further details of the format of this file.
1556 .Pp
1557 .It Pa /etc/ssh/sshrc
1558 Commands in this file are executed by
1559 .Nm
1560 when the user logs in, just before the user's shell (or command) is started.
1561 See the
1562 .Xr sshd 8
1563 manual page for more information.
1564 .El
1565 .Sh EXIT STATUS
1566 .Nm
1567 exits with the exit status of the remote command or with 255
1568 if an error occurred.
1569 .Sh SEE ALSO
1570 .Xr scp 1 ,
1571 .Xr sftp 1 ,
1572 .Xr ssh-add 1 ,
1573 .Xr ssh-agent 1 ,
1574 .Xr ssh-keygen 1 ,
1575 .Xr ssh-keyscan 1 ,
1576 .Xr tun 4 ,
1577 .Xr ssh_config 5 ,
1578 .Xr ssh-keysign 8 ,
1579 .Xr sshd 8
1580 .Sh STANDARDS
1581 .Rs
1582 .%A S. Lehtinen
1583 .%A C. Lonvick
1584 .%D January 2006
1585 .%R RFC 4250
1586 .%T The Secure Shell (SSH) Protocol Assigned Numbers
1587 .Re
1588 .Pp
1589 .Rs
1590 .%A T. Ylonen
1591 .%A C. Lonvick
1592 .%D January 2006
1593 .%R RFC 4251
1594 .%T The Secure Shell (SSH) Protocol Architecture
1595 .Re
1596 .Pp
1597 .Rs
1598 .%A T. Ylonen
1599 .%A C. Lonvick
1600 .%D January 2006
1601 .%R RFC 4252
1602 .%T The Secure Shell (SSH) Authentication Protocol
1603 .Re
1604 .Pp
1605 .Rs
1606 .%A T. Ylonen
1607 .%A C. Lonvick
1608 .%D January 2006
1609 .%R RFC 4253
1610 .%T The Secure Shell (SSH) Transport Layer Protocol
1611 .Re
1612 .Pp
1613 .Rs
1614 .%A T. Ylonen
1615 .%A C. Lonvick
1616 .%D January 2006
1617 .%R RFC 4254
1618 .%T The Secure Shell (SSH) Connection Protocol
1619 .Re
1620 .Pp
1621 .Rs
1622 .%A J. Schlyter
1623 .%A W. Griffin
1624 .%D January 2006
1625 .%R RFC 4255
1626 .%T Using DNS to Securely Publish Secure Shell (SSH) Key Fingerprints
1627 .Re
1628 .Pp
1629 .Rs
1630 .%A F. Cusack
1631 .%A M. Forssen
1632 .%D January 2006
1633 .%R RFC 4256
1634 .%T Generic Message Exchange Authentication for the Secure Shell Protocol (SSH)
1635 .Re
1636 .Pp
1637 .Rs
1638 .%A J. Galbraith
1639 .%A P. Remaker
1640 .%D January 2006
1641 .%R RFC 4335
1642 .%T The Secure Shell (SSH) Session Channel Break Extension
1643 .Re
1644 .Pp
1645 .Rs
1646 .%A M. Bellare
1647 .%A T. Kohno
1648 .%A C. Namprempre
1649 .%D January 2006
1650 .%R RFC 4344
1651 .%T The Secure Shell (SSH) Transport Layer Encryption Modes
1652 .Re
1653 .Pp
1654 .Rs
1655 .%A B. Harris
1656 .%D January 2006
1657 .%R RFC 4345
1658 .%T Improved Arcfour Modes for the Secure Shell (SSH) Transport Layer Protocol
1659 .Re
1660 .Pp
1661 .Rs
1662 .%A M. Friedl
1663 .%A N. Provos
1664 .%A W. Simpson
1665 .%D March 2006
1666 .%R RFC 4419
1667 .%T Diffie-Hellman Group Exchange for the Secure Shell (SSH) Transport Layer Protocol
1668 .Re
1669 .Pp
1670 .Rs
1671 .%A J. Galbraith
1672 .%A R. Thayer
1673 .%D November 2006
1674 .%R RFC 4716
1675 .%T The Secure Shell (SSH) Public Key File Format
1676 .Re
1677 .Pp
1678 .Rs
1679 .%A D. Stebila
1680 .%A J. Green
1681 .%D December 2009
1682 .%R RFC 5656
1683 .%T Elliptic Curve Algorithm Integration in the Secure Shell Transport Layer
1684 .Re
1685 .Pp
1686 .Rs
1687 .%A A. Perrig
1688 .%A D. Song
1689 .%D 1999
1690 .%O International Workshop on Cryptographic Techniques and E-Commerce (CrypTEC '99)
1691 .%T Hash Visualization: a New Technique to improve Real-World Security
1692 .Re
1693 .Sh AUTHORS
1694 OpenSSH is a derivative of the original and free
1695 ssh 1.2.12 release by Tatu Ylonen.
1696 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1697 Theo de Raadt and Dug Song
1698 removed many bugs, re-added newer features and
1699 created OpenSSH.
1700 Markus Friedl contributed the support for SSH
1701 protocol versions 1.5 and 2.0.