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