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