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.316 2010/11/18 15:01:00 jmc Exp $
  37 .Dd $Mdocdate: November 18 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 IPQoS
 439 .It KbdInteractiveDevices
 440 .It KexAlgorithms
 441 .It LocalCommand
 442 .It LocalForward
 443 .It LogLevel
 444 .It MACs
 445 .It NoHostAuthenticationForLocalhost
 446 .It NumberOfPasswordPrompts
 447 .It PasswordAuthentication
 448 .It PermitLocalCommand
 449 .It PKCS11Provider
 450 .It Port
 451 .It PreferredAuthentications
 452 .It Protocol
 453 .It ProxyCommand
 454 .It PubkeyAuthentication
 455 .It RekeyLimit
 456 .It RemoteForward
 457 .It RhostsRSAAuthentication
 458 .It RSAAuthentication
 459 .It SendEnv
 460 .It ServerAliveInterval
 461 .It ServerAliveCountMax
 462 .It StrictHostKeyChecking
 463 .It TCPKeepAlive
 464 .It Tunnel
 465 .It TunnelDevice
 466 .It UsePrivilegedPort
 467 .It User
 468 .It UserKnownHostsFile
 469 .It VerifyHostKeyDNS
 470 .It VisualHostKey
 471 .It XAuthLocation
 472 .El
 473 .It Fl p Ar port
 474 Port to connect to on the remote host.
 475 This can be specified on a
 476 per-host basis in the configuration file.
 477 .It Fl q
 478 Quiet mode.
 479 Causes most warning and diagnostic messages to be suppressed.
 480 .It Fl R Xo
 481 .Sm off
 482 .Oo Ar bind_address : Oc
 483 .Ar port : host : hostport
 484 .Sm on
 485 .Xc
 486 Specifies that the given port on the remote (server) host is to be
 487 forwarded to the given host and port on the local side.
 488 This works by allocating a socket to listen to
 489 .Ar port
 490 on the remote side, and whenever a connection is made to this port, the
 491 connection is forwarded over the secure channel, and a connection is
 492 made to
 493 .Ar host
 494 port
 495 .Ar hostport
 496 from the local machine.
 497 .Pp
 498 Port forwardings can also be specified in the configuration file.
 499 Privileged ports can be forwarded only when
 500 logging in as root on the remote machine.
 501 IPv6 addresses can be specified by enclosing the address in square braces.
 502 .Pp
 503 By default, the listening socket on the server will be bound to the loopback
 504 interface only.
 505 This may be overridden by specifying a
 506 .Ar bind_address .
 507 An empty
 508 .Ar bind_address ,
 509 or the address
 510 .Ql * ,
 511 indicates that the remote socket should listen on all interfaces.
 512 Specifying a remote
 513 .Ar bind_address
 514 will only succeed if the server's
 515 .Cm GatewayPorts
 516 option is enabled (see
 517 .Xr sshd_config 5 ) .
 518 .Pp
 519 If the
 520 .Ar port
 521 argument is
 522 .Ql 0 ,
 523 the listen port will be dynamically allocated on the server and reported
 524 to the client at run time.
 525 When used together with
 526 .Ic -O forward
 527 the allocated port will be printed to the standard output.
 528 .It Fl S Ar ctl_path
 529 Specifies the location of a control socket for connection sharing,
 530 or the string
 531 .Dq none
 532 to disable connection sharing.
 533 Refer to the description of
 534 .Cm ControlPath
 535 and
 536 .Cm ControlMaster
 537 in
 538 .Xr ssh_config 5
 539 for details.
 540 .It Fl s
 541 May be used to request invocation of a subsystem on the remote system.
 542 Subsystems are a feature of the SSH2 protocol which facilitate the use
 543 of SSH as a secure transport for other applications (eg.\&
 544 .Xr sftp 1 ) .
 545 The subsystem is specified as the remote command.
 546 .It Fl T
 547 Disable pseudo-tty allocation.
 548 .It Fl t
 549 Force pseudo-tty allocation.
 550 This can be used to execute arbitrary
 551 screen-based programs on a remote machine, which can be very useful,
 552 e.g. when implementing menu services.
 553 Multiple
 554 .Fl t
 555 options force tty allocation, even if
 556 .Nm
 557 has no local tty.
 558 .It Fl V
 559 Display the version number and exit.
 560 .It Fl v
 561 Verbose mode.
 562 Causes
 563 .Nm
 564 to print debugging messages about its progress.
 565 This is helpful in
 566 debugging connection, authentication, and configuration problems.
 567 Multiple
 568 .Fl v
 569 options increase the verbosity.
 570 The maximum is 3.
 571 .It Fl W Ar host : Ns Ar port
 572 Requests that standard input and output on the client be forwarded to
 573 .Ar host
 574 on
 575 .Ar port
 576 over the secure channel.
 577 Implies
 578 .Fl N ,
 579 .Fl T ,
 580 .Cm ExitOnForwardFailure
 581 and
 582 .Cm ClearAllForwardings
 583 and works with Protocol version 2 only.
 584 .It Fl w Xo
 585 .Ar local_tun Ns Op : Ns Ar remote_tun
 586 .Xc
 587 Requests
 588 tunnel
 589 device forwarding with the specified
 590 .Xr tun 4
 591 devices between the client
 592 .Pq Ar local_tun
 593 and the server
 594 .Pq Ar remote_tun .
 595 .Pp
 596 The devices may be specified by numerical ID or the keyword
 597 .Dq any ,
 598 which uses the next available tunnel device.
 599 If
 600 .Ar remote_tun
 601 is not specified, it defaults to
 602 .Dq any .
 603 See also the
 604 .Cm Tunnel
 605 and
 606 .Cm TunnelDevice
 607 directives in
 608 .Xr ssh_config 5 .
 609 If the
 610 .Cm Tunnel
 611 directive is unset, it is set to the default tunnel mode, which is
 612 .Dq point-to-point .
 613 .It Fl X
 614 Enables X11 forwarding.
 615 This can also be specified on a per-host basis in a configuration file.
 616 .Pp
 617 X11 forwarding should be enabled with caution.
 618 Users with the ability to bypass file permissions on the remote host
 619 (for the user's X authorization database)
 620 can access the local X11 display through the forwarded connection.
 621 An attacker may then be able to perform activities such as keystroke monitoring.
 622 .Pp
 623 For this reason, X11 forwarding is subjected to X11 SECURITY extension
 624 restrictions by default.
 625 Please refer to the
 626 .Nm
 627 .Fl Y
 628 option and the
 629 .Cm ForwardX11Trusted
 630 directive in
 631 .Xr ssh_config 5
 632 for more information.
 633 .It Fl x
 634 Disables X11 forwarding.
 635 .It Fl Y
 636 Enables trusted X11 forwarding.
 637 Trusted X11 forwardings are not subjected to the X11 SECURITY extension
 638 controls.
 639 .It Fl y
 640 Send log information using the
 641 .Xr syslog 3
 642 system module.
 643 By default this information is sent to stderr.
 644 .El
 645 .Pp
 646 .Nm
 647 may additionally obtain configuration data from
 648 a per-user configuration file and a system-wide configuration file.
 649 The file format and configuration options are described in
 650 .Xr ssh_config 5 .
 651 .Sh AUTHENTICATION
 652 The OpenSSH SSH client supports SSH protocols 1 and 2.
 653 The default is to use protocol 2 only,
 654 though this can be changed via the
 655 .Cm Protocol
 656 option in
 657 .Xr ssh_config 5
 658 or the
 659 .Fl 1
 660 and
 661 .Fl 2
 662 options (see above).
 663 Both protocols support similar authentication methods,
 664 but protocol 2 is the default since
 665 it provides additional mechanisms for confidentiality
 666 (the traffic is encrypted using AES, 3DES, Blowfish, CAST128, or Arcfour)
 667 and integrity (hmac-md5, hmac-sha1, umac-64, hmac-ripemd160).
 668 Protocol 1 lacks a strong mechanism for ensuring the
 669 integrity of the connection.
 670 .Pp
 671 The methods available for authentication are:
 672 GSSAPI-based authentication,
 673 host-based authentication,
 674 public key authentication,
 675 challenge-response authentication,
 676 and password authentication.
 677 Authentication methods are tried in the order specified above,
 678 though protocol 2 has a configuration option to change the default order:
 679 .Cm PreferredAuthentications .
 680 .Pp
 681 Host-based authentication works as follows:
 682 If the machine the user logs in from is listed in
 683 .Pa /etc/hosts.equiv
 684 or
 685 .Pa /etc/shosts.equiv
 686 on the remote machine, and the user names are
 687 the same on both sides, or if the files
 688 .Pa ~/.rhosts
 689 or
 690 .Pa ~/.shosts
 691 exist in the user's home directory on the
 692 remote machine and contain a line containing the name of the client
 693 machine and the name of the user on that machine, the user is
 694 considered for login.
 695 Additionally, the server
 696 .Em must
 697 be able to verify the client's
 698 host key (see the description of
 699 .Pa /etc/ssh/ssh_known_hosts
 700 and
 701 .Pa ~/.ssh/known_hosts ,
 702 below)
 703 for login to be permitted.
 704 This authentication method closes security holes due to IP
 705 spoofing, DNS spoofing, and routing spoofing.
 706 [Note to the administrator:
 707 .Pa /etc/hosts.equiv ,
 708 .Pa ~/.rhosts ,
 709 and the rlogin/rsh protocol in general, are inherently insecure and should be
 710 disabled if security is desired.]
 711 .Pp
 712 Public key authentication works as follows:
 713 The scheme is based on public-key cryptography,
 714 using cryptosystems
 715 where encryption and decryption are done using separate keys,
 716 and it is unfeasible to derive the decryption key from the encryption key.
 717 The idea is that each user creates a public/private
 718 key pair for authentication purposes.
 719 The server knows the public key, and only the user knows the private key.
 720 .Nm
 721 implements public key authentication protocol automatically,
 722 using one of the DSA, ECDSA or RSA algorithms.
 723 Protocol 1 is restricted to using only RSA keys,
 724 but protocol 2 may use any.
 725 The
 726 .Sx HISTORY
 727 section of
 728 .Xr ssl 8
 729 (on non-OpenBSD systems, see
 730 .nh
 731 http://www.openbsd.org/cgi\-bin/man.cgi?query=ssl&sektion=8#HISTORY)
 732 .hy
 733 contains a brief discussion of the DSA and RSA algorithms.
 734 .Pp
 735 The file
 736 .Pa ~/.ssh/authorized_keys
 737 lists the public keys that are permitted for logging in.
 738 When the user logs in, the
 739 .Nm
 740 program tells the server which key pair it would like to use for
 741 authentication.
 742 The client proves that it has access to the private key
 743 and the server checks that the corresponding public key
 744 is authorized to accept the account.
 745 .Pp
 746 The user creates his/her key pair by running
 747 .Xr ssh-keygen 1 .
 748 This stores the private key in
 749 .Pa ~/.ssh/identity
 750 (protocol 1),
 751 .Pa ~/.ssh/id_dsa
 752 (protocol 2 DSA),
 753 .Pa ~/.ssh/id_ecdsa
 754 (protocol 2 ECDSA),
 755 or
 756 .Pa ~/.ssh/id_rsa
 757 (protocol 2 RSA)
 758 and stores the public key in
 759 .Pa ~/.ssh/identity.pub
 760 (protocol 1),
 761 .Pa ~/.ssh/id_dsa.pub
 762 (protocol 2 DSA),
 763 .Pa ~/.ssh/id_ecdsa.pub
 764 (protocol 2 ECDSA),
 765 or
 766 .Pa ~/.ssh/id_rsa.pub
 767 (protocol 2 RSA)
 768 in the user's home directory.
 769 The user should then copy the public key
 770 to
 771 .Pa ~/.ssh/authorized_keys
 772 in his/her home directory on the remote machine.
 773 The
 774 .Pa authorized_keys
 775 file corresponds to the conventional
 776 .Pa ~/.rhosts
 777 file, and has one key
 778 per line, though the lines can be very long.
 779 After this, the user can log in without giving the password.
 780 .Pp
 781 A variation on public key authentication
 782 is available in the form of certificate authentication:
 783 instead of a set of public/private keys,
 784 signed certificates are used.
 785 This has the advantage that a single trusted certification authority
 786 can be used in place of many public/private keys.
 787 See the
 788 .Sx CERTIFICATES
 789 section of
 790 .Xr ssh-keygen 1
 791 for more information.
 792 .Pp
 793 The most convenient way to use public key or certificate authentication
 794 may be with an authentication agent.
 795 See
 796 .Xr ssh-agent 1
 797 for more information.
 798 .Pp
 799 Challenge-response authentication works as follows:
 800 The server sends an arbitrary
 801 .Qq challenge
 802 text, and prompts for a response.
 803 Protocol 2 allows multiple challenges and responses;
 804 protocol 1 is restricted to just one challenge/response.
 805 Examples of challenge-response authentication include
 806 BSD Authentication (see
 807 .Xr login.conf 5 )
 808 and PAM (some non-OpenBSD systems).
 809 .Pp
 810 Finally, if other authentication methods fail,
 811 .Nm
 812 prompts the user for a password.
 813 The password is sent to the remote
 814 host for checking; however, since all communications are encrypted,
 815 the password cannot be seen by someone listening on the network.
 816 .Pp
 817 .Nm
 818 automatically maintains and checks a database containing
 819 identification for all hosts it has ever been used with.
 820 Host keys are stored in
 821 .Pa ~/.ssh/known_hosts
 822 in the user's home directory.
 823 Additionally, the file
 824 .Pa /etc/ssh/ssh_known_hosts
 825 is automatically checked for known hosts.
 826 Any new hosts are automatically added to the user's file.
 827 If a host's identification ever changes,
 828 .Nm
 829 warns about this and disables password authentication to prevent
 830 server spoofing or man-in-the-middle attacks,
 831 which could otherwise be used to circumvent the encryption.
 832 The
 833 .Cm StrictHostKeyChecking
 834 option can be used to control logins to machines whose
 835 host key is not known or has changed.
 836 .Pp
 837 When the user's identity has been accepted by the server, the server
 838 either executes the given command, or logs into the machine and gives
 839 the user a normal shell on the remote machine.
 840 All communication with
 841 the remote command or shell will be automatically encrypted.
 842 .Pp
 843 If a pseudo-terminal has been allocated (normal login session), the
 844 user may use the escape characters noted below.
 845 .Pp
 846 If no pseudo-tty has been allocated,
 847 the session is transparent and can be used to reliably transfer binary data.
 848 On most systems, setting the escape character to
 849 .Dq none
 850 will also make the session transparent even if a tty is used.
 851 .Pp
 852 The session terminates when the command or shell on the remote
 853 machine exits and all X11 and TCP connections have been closed.
 854 .Sh ESCAPE CHARACTERS
 855 When a pseudo-terminal has been requested,
 856 .Nm
 857 supports a number of functions through the use of an escape character.
 858 .Pp
 859 A single tilde character can be sent as
 860 .Ic ~~
 861 or by following the tilde by a character other than those described below.
 862 The escape character must always follow a newline to be interpreted as
 863 special.
 864 The escape character can be changed in configuration files using the
 865 .Cm EscapeChar
 866 configuration directive or on the command line by the
 867 .Fl e
 868 option.
 869 .Pp
 870 The supported escapes (assuming the default
 871 .Ql ~ )
 872 are:
 873 .Bl -tag -width Ds
 874 .It Cm ~.
 875 Disconnect.
 876 .It Cm ~^Z
 877 Background
 878 .Nm .
 879 .It Cm ~#
 880 List forwarded connections.
 881 .It Cm ~&
 882 Background
 883 .Nm
 884 at logout when waiting for forwarded connection / X11 sessions to terminate.
 885 .It Cm ~?
 886 Display a list of escape characters.
 887 .It Cm ~B
 888 Send a BREAK to the remote system
 889 (only useful for SSH protocol version 2 and if the peer supports it).
 890 .It Cm ~C
 891 Open command line.
 892 Currently this allows the addition of port forwardings using the
 893 .Fl L ,
 894 .Fl R
 895 and
 896 .Fl D
 897 options (see above).
 898 It also allows the cancellation of existing remote port-forwardings
 899 using
 900 .Sm off
 901 .Fl KR Oo Ar bind_address : Oc Ar port .
 902 .Sm on
 903 .Ic !\& Ns Ar command
 904 allows the user to execute a local command if the
 905 .Ic PermitLocalCommand
 906 option is enabled in
 907 .Xr ssh_config 5 .
 908 Basic help is available, using the
 909 .Fl h
 910 option.
 911 .It Cm ~R
 912 Request rekeying of the connection
 913 (only useful for SSH protocol version 2 and if the peer supports it).
 914 .El
 915 .Sh TCP FORWARDING
 916 Forwarding of arbitrary TCP connections over the secure channel can
 917 be specified either on the command line or in a configuration file.
 918 One possible application of TCP forwarding is a secure connection to a
 919 mail server; another is going through firewalls.
 920 .Pp
 921 In the example below, we look at encrypting communication between
 922 an IRC client and server, even though the IRC server does not directly
 923 support encrypted communications.
 924 This works as follows:
 925 the user connects to the remote host using
 926 .Nm ,
 927 specifying a port to be used to forward connections
 928 to the remote server.
 929 After that it is possible to start the service which is to be encrypted
 930 on the client machine,
 931 connecting to the same local port,
 932 and
 933 .Nm
 934 will encrypt and forward the connection.
 935 .Pp
 936 The following example tunnels an IRC session from client machine
 937 .Dq 127.0.0.1
 938 (localhost)
 939 to remote server
 940 .Dq server.example.com :
 941 .Bd -literal -offset 4n
 942 $ ssh -f -L 1234:localhost:6667 server.example.com sleep 10
 943 $ irc -c '#users' -p 1234 pinky 127.0.0.1
 944 .Ed
 945 .Pp
 946 This tunnels a connection to IRC server
 947 .Dq server.example.com ,
 948 joining channel
 949 .Dq #users ,
 950 nickname
 951 .Dq pinky ,
 952 using port 1234.
 953 It doesn't matter which port is used,
 954 as long as it's greater than 1023
 955 (remember, only root can open sockets on privileged ports)
 956 and doesn't conflict with any ports already in use.
 957 The connection is forwarded to port 6667 on the remote server,
 958 since that's the standard port for IRC services.
 959 .Pp
 960 The
 961 .Fl f
 962 option backgrounds
 963 .Nm
 964 and the remote command
 965 .Dq sleep 10
 966 is specified to allow an amount of time
 967 (10 seconds, in the example)
 968 to start the service which is to be tunnelled.
 969 If no connections are made within the time specified,
 970 .Nm
 971 will exit.
 972 .Sh X11 FORWARDING
 973 If the
 974 .Cm ForwardX11
 975 variable is set to
 976 .Dq yes
 977 (or see the description of the
 978 .Fl X ,
 979 .Fl x ,
 980 and
 981 .Fl Y
 982 options above)
 983 and the user is using X11 (the
 984 .Ev DISPLAY
 985 environment variable is set), the connection to the X11 display is
 986 automatically forwarded to the remote side in such a way that any X11
 987 programs started from the shell (or command) will go through the
 988 encrypted channel, and the connection to the real X server will be made
 989 from the local machine.
 990 The user should not manually set
 991 .Ev DISPLAY .
 992 Forwarding of X11 connections can be
 993 configured on the command line or in configuration files.
 994 .Pp
 995 The
 996 .Ev DISPLAY
 997 value set by
 998 .Nm
 999 will point to the server machine, but with a display number greater than zero.
1000 This is normal, and happens because
1001 .Nm
1002 creates a
1003 .Dq proxy
1004 X server on the server machine for forwarding the
1005 connections over the encrypted channel.
1006 .Pp
1007 .Nm
1008 will also automatically set up Xauthority data on the server machine.
1009 For this purpose, it will generate a random authorization cookie,
1010 store it in Xauthority on the server, and verify that any forwarded
1011 connections carry this cookie and replace it by the real cookie when
1012 the connection is opened.
1013 The real authentication cookie is never
1014 sent to the server machine (and no cookies are sent in the plain).
1015 .Pp
1016 If the
1017 .Cm ForwardAgent
1018 variable is set to
1019 .Dq yes
1020 (or see the description of the
1021 .Fl A
1022 and
1023 .Fl a
1024 options above) and
1025 the user is using an authentication agent, the connection to the agent
1026 is automatically forwarded to the remote side.
1027 .Sh VERIFYING HOST KEYS
1028 When connecting to a server for the first time,
1029 a fingerprint of the server's public key is presented to the user
1030 (unless the option
1031 .Cm StrictHostKeyChecking
1032 has been disabled).
1033 Fingerprints can be determined using
1034 .Xr ssh-keygen 1 :
1035 .Pp
1036 .Dl $ ssh-keygen -l -f /etc/ssh/ssh_host_rsa_key
1037 .Pp
1038 If the fingerprint is already known, it can be matched
1039 and the key can be accepted or rejected.
1040 Because of the difficulty of comparing host keys
1041 just by looking at hex strings,
1042 there is also support to compare host keys visually,
1043 using
1044 .Em random art .
1045 By setting the
1046 .Cm VisualHostKey
1047 option to
1048 .Dq yes ,
1049 a small ASCII graphic gets displayed on every login to a server, no matter
1050 if the session itself is interactive or not.
1051 By learning the pattern a known server produces, a user can easily
1052 find out that the host key has changed when a completely different pattern
1053 is displayed.
1054 Because these patterns are not unambiguous however, a pattern that looks
1055 similar to the pattern remembered only gives a good probability that the
1056 host key is the same, not guaranteed proof.
1057 .Pp
1058 To get a listing of the fingerprints along with their random art for
1059 all known hosts, the following command line can be used:
1060 .Pp
1061 .Dl $ ssh-keygen -lv -f ~/.ssh/known_hosts
1062 .Pp
1063 If the fingerprint is unknown,
1064 an alternative method of verification is available:
1065 SSH fingerprints verified by DNS.
1066 An additional resource record (RR),
1067 SSHFP,
1068 is added to a zonefile
1069 and the connecting client is able to match the fingerprint
1070 with that of the key presented.
1071 .Pp
1072 In this example, we are connecting a client to a server,
1073 .Dq host.example.com .
1074 The SSHFP resource records should first be added to the zonefile for
1075 host.example.com:
1076 .Bd -literal -offset indent
1077 $ ssh-keygen -r host.example.com.
1078 .Ed
1079 .Pp
1080 The output lines will have to be added to the zonefile.
1081 To check that the zone is answering fingerprint queries:
1082 .Pp
1083 .Dl $ dig -t SSHFP host.example.com
1084 .Pp
1085 Finally the client connects:
1086 .Bd -literal -offset indent
1087 $ ssh -o "VerifyHostKeyDNS ask" host.example.com
1088 [...]
1089 Matching host key fingerprint found in DNS.
1090 Are you sure you want to continue connecting (yes/no)?
1091 .Ed
1092 .Pp
1093 See the
1094 .Cm VerifyHostKeyDNS
1095 option in
1096 .Xr ssh_config 5
1097 for more information.
1098 .Sh SSH-BASED VIRTUAL PRIVATE NETWORKS
1099 .Nm
1100 contains support for Virtual Private Network (VPN) tunnelling
1101 using the
1102 .Xr tun 4
1103 network pseudo-device,
1104 allowing two networks to be joined securely.
1105 The
1106 .Xr sshd_config 5
1107 configuration option
1108 .Cm PermitTunnel
1109 controls whether the server supports this,
1110 and at what level (layer 2 or 3 traffic).
1111 .Pp
1112 The following example would connect client network 10.0.50.0/24
1113 with remote network 10.0.99.0/24 using a point-to-point connection
1114 from 10.1.1.1 to 10.1.1.2,
1115 provided that the SSH server running on the gateway to the remote network,
1116 at 192.168.1.15, allows it.
1117 .Pp
1118 On the client:
1119 .Bd -literal -offset indent
1120 # ssh -f -w 0:1 192.168.1.15 true
1121 # ifconfig tun0 10.1.1.1 10.1.1.2 netmask 255.255.255.252
1122 # route add 10.0.99.0/24 10.1.1.2
1123 .Ed
1124 .Pp
1125 On the server:
1126 .Bd -literal -offset indent
1127 # ifconfig tun1 10.1.1.2 10.1.1.1 netmask 255.255.255.252
1128 # route add 10.0.50.0/24 10.1.1.1
1129 .Ed
1130 .Pp
1131 Client access may be more finely tuned via the
1132 .Pa /root/.ssh/authorized_keys
1133 file (see below) and the
1134 .Cm PermitRootLogin
1135 server option.
1136 The following entry would permit connections on
1137 .Xr tun 4
1138 device 1 from user
1139 .Dq jane
1140 and on tun device 2 from user
1141 .Dq john ,
1142 if
1143 .Cm PermitRootLogin
1144 is set to
1145 .Dq forced-commands-only :
1146 .Bd -literal -offset 2n
1147 tunnel="1",command="sh /etc/netstart tun1" ssh-rsa ... jane
1148 tunnel="2",command="sh /etc/netstart tun2" ssh-rsa ... john
1149 .Ed
1150 .Pp
1151 Since an SSH-based setup entails a fair amount of overhead,
1152 it may be more suited to temporary setups,
1153 such as for wireless VPNs.
1154 More permanent VPNs are better provided by tools such as
1155 .Xr ipsecctl 8
1156 and
1157 .Xr isakmpd 8 .
1158 .Sh ENVIRONMENT
1159 .Nm
1160 will normally set the following environment variables:
1161 .Bl -tag -width "SSH_ORIGINAL_COMMAND"
1162 .It Ev DISPLAY
1163 The
1164 .Ev DISPLAY
1165 variable indicates the location of the X11 server.
1166 It is automatically set by
1167 .Nm
1168 to point to a value of the form
1169 .Dq hostname:n ,
1170 where
1171 .Dq hostname
1172 indicates the host where the shell runs, and
1173 .Sq n
1174 is an integer \*(Ge 1.
1175 .Nm
1176 uses this special value to forward X11 connections over the secure
1177 channel.
1178 The user should normally not set
1179 .Ev DISPLAY
1180 explicitly, as that
1181 will render the X11 connection insecure (and will require the user to
1182 manually copy any required authorization cookies).
1183 .It Ev HOME
1184 Set to the path of the user's home directory.
1185 .It Ev LOGNAME
1186 Synonym for
1187 .Ev USER ;
1188 set for compatibility with systems that use this variable.
1189 .It Ev MAIL
1190 Set to the path of the user's mailbox.
1191 .It Ev PATH
1192 Set to the default
1193 .Ev PATH ,
1194 as specified when compiling
1195 .Nm .
1196 .It Ev SSH_ASKPASS
1197 If
1198 .Nm
1199 needs a passphrase, it will read the passphrase from the current
1200 terminal if it was run from a terminal.
1201 If
1202 .Nm
1203 does not have a terminal associated with it but
1204 .Ev DISPLAY
1205 and
1206 .Ev SSH_ASKPASS
1207 are set, it will execute the program specified by
1208 .Ev SSH_ASKPASS
1209 and open an X11 window to read the passphrase.
1210 This is particularly useful when calling
1211 .Nm
1212 from a
1213 .Pa .xsession
1214 or related script.
1215 (Note that on some machines it
1216 may be necessary to redirect the input from
1217 .Pa /dev/null
1218 to make this work.)
1219 .It Ev SSH_AUTH_SOCK
1220 Identifies the path of a
1221 .Ux Ns -domain
1222 socket used to communicate with the agent.
1223 .It Ev SSH_CONNECTION
1224 Identifies the client and server ends of the connection.
1225 The variable contains
1226 four space-separated values: client IP address, client port number,
1227 server IP address, and server port number.
1228 .It Ev SSH_ORIGINAL_COMMAND
1229 This variable contains the original command line if a forced command
1230 is executed.
1231 It can be used to extract the original arguments.
1232 .It Ev SSH_TTY
1233 This is set to the name of the tty (path to the device) associated
1234 with the current shell or command.
1235 If the current session has no tty,
1236 this variable is not set.
1237 .It Ev TZ
1238 This variable is set to indicate the present time zone if it
1239 was set when the daemon was started (i.e. the daemon passes the value
1240 on to new connections).
1241 .It Ev USER
1242 Set to the name of the user logging in.
1243 .El
1244 .Pp
1245 Additionally,
1246 .Nm
1247 reads
1248 .Pa ~/.ssh/environment ,
1249 and adds lines of the format
1250 .Dq VARNAME=value
1251 to the environment if the file exists and users are allowed to
1252 change their environment.
1253 For more information, see the
1254 .Cm PermitUserEnvironment
1255 option in
1256 .Xr sshd_config 5 .
1257 .Sh FILES
1258 .Bl -tag -width Ds -compact
1259 .It Pa ~/.rhosts
1260 This file is used for host-based authentication (see above).
1261 On some machines this file may need to be
1262 world-readable if the user's home directory is on an NFS partition,
1263 because
1264 .Xr sshd 8
1265 reads it as root.
1266 Additionally, this file must be owned by the user,
1267 and must not have write permissions for anyone else.
1268 The recommended
1269 permission for most machines is read/write for the user, and not
1270 accessible by others.
1271 .Pp
1272 .It Pa ~/.shosts
1273 This file is used in exactly the same way as
1274 .Pa .rhosts ,
1275 but allows host-based authentication without permitting login with
1276 rlogin/rsh.
1277 .Pp
1278 .It Pa ~/.ssh/
1279 This directory is the default location for all user-specific configuration
1280 and authentication information.
1281 There is no general requirement to keep the entire contents of this directory
1282 secret, but the recommended permissions are read/write/execute for the user,
1283 and not accessible by others.
1284 .Pp
1285 .It Pa ~/.ssh/authorized_keys
1286 Lists the public keys (DSA/ECDSA/RSA) that can be used for logging in as
1287 this user.
1288 The format of this file is described in the
1289 .Xr sshd 8
1290 manual page.
1291 This file is not highly sensitive, but the recommended
1292 permissions are read/write for the user, and not accessible by others.
1293 .Pp
1294 .It Pa ~/.ssh/config
1295 This is the per-user configuration file.
1296 The file format and configuration options are described in
1297 .Xr ssh_config 5 .
1298 Because of the potential for abuse, this file must have strict permissions:
1299 read/write for the user, and not accessible by others.
1300 It may be group-writable provided that the group in question contains only
1301 the user.
1302 .Pp
1303 .It Pa ~/.ssh/environment
1304 Contains additional definitions for environment variables; see
1305 .Sx ENVIRONMENT ,
1306 above.
1307 .Pp
1308 .It Pa ~/.ssh/identity
1309 .It Pa ~/.ssh/id_dsa
1310 .It Pa ~/.ssh/id_ecdsa
1311 .It Pa ~/.ssh/id_rsa
1312 Contains the private key for authentication.
1313 These files
1314 contain sensitive data and should be readable by the user but not
1315 accessible by others (read/write/execute).
1316 .Nm
1317 will simply ignore a private key file if it is accessible by others.
1318 It is possible to specify a passphrase when
1319 generating the key which will be used to encrypt the
1320 sensitive part of this file using 3DES.
1321 .Pp
1322 .It Pa ~/.ssh/identity.pub
1323 .It Pa ~/.ssh/id_dsa.pub
1324 .It Pa ~/.ssh/id_ecdsa.pub
1325 .It Pa ~/.ssh/id_rsa.pub
1326 Contains the public key for authentication.
1327 These files are not
1328 sensitive and can (but need not) be readable by anyone.
1329 .Pp
1330 .It Pa ~/.ssh/known_hosts
1331 Contains a list of host keys for all hosts the user has logged into
1332 that are not already in the systemwide list of known host keys.
1333 See
1334 .Xr sshd 8
1335 for further details of the format of this file.
1336 .Pp
1337 .It Pa ~/.ssh/rc
1338 Commands in this file are executed by
1339 .Nm
1340 when the user logs in, just before the user's shell (or command) is
1341 started.
1342 See the
1343 .Xr sshd 8
1344 manual page for more information.
1345 .Pp
1346 .It Pa /etc/hosts.equiv
1347 This file is for host-based authentication (see above).
1348 It should only be writable by root.
1349 .Pp
1350 .It Pa /etc/shosts.equiv
1351 This file is used in exactly the same way as
1352 .Pa hosts.equiv ,
1353 but allows host-based authentication without permitting login with
1354 rlogin/rsh.
1355 .Pp
1356 .It Pa /etc/ssh/ssh_config
1357 Systemwide configuration file.
1358 The file format and configuration options are described in
1359 .Xr ssh_config 5 .
1360 .Pp
1361 .It Pa /etc/ssh/ssh_host_key
1362 .It Pa /etc/ssh/ssh_host_dsa_key
1363 .It Pa /etc/ssh/ssh_host_ecdsa_key
1364 .It Pa /etc/ssh/ssh_host_rsa_key
1365 These three files contain the private parts of the host keys
1366 and are used for host-based authentication.
1367 If protocol version 1 is used,
1368 .Nm
1369 must be setuid root, since the host key is readable only by root.
1370 For protocol version 2,
1371 .Nm
1372 uses
1373 .Xr ssh-keysign 8
1374 to access the host keys,
1375 eliminating the requirement that
1376 .Nm
1377 be setuid root when host-based authentication is used.
1378 By default
1379 .Nm
1380 is not setuid root.
1381 .Pp
1382 .It Pa /etc/ssh/ssh_known_hosts
1383 Systemwide list of known host keys.
1384 This file should be prepared by the
1385 system administrator to contain the public host keys of all machines in the
1386 organization.
1387 It should be world-readable.
1388 See
1389 .Xr sshd 8
1390 for further details of the format of this file.
1391 .Pp
1392 .It Pa /etc/ssh/sshrc
1393 Commands in this file are executed by
1394 .Nm
1395 when the user logs in, just before the user's shell (or command) is started.
1396 See the
1397 .Xr sshd 8
1398 manual page for more information.
1399 .El
1400 .Sh EXIT STATUS
1401 .Nm
1402 exits with the exit status of the remote command or with 255
1403 if an error occurred.
1404 .Sh SEE ALSO
1405 .Xr scp 1 ,
1406 .Xr sftp 1 ,
1407 .Xr ssh-add 1 ,
1408 .Xr ssh-agent 1 ,
1409 .Xr ssh-argv0 1 ,
1410 .Xr ssh-keygen 1 ,
1411 .Xr ssh-keyscan 1 ,
1412 .Xr ssh-vulnkey 1 ,
1413 .Xr tun 4 ,
1414 .Xr hosts.equiv 5 ,
1415 .Xr ssh_config 5 ,
1416 .Xr ssh-keysign 8 ,
1417 .Xr sshd 8
1418 .Rs
1419 .%R RFC 4250
1420 .%T "The Secure Shell (SSH) Protocol Assigned Numbers"
1421 .%D 2006
1422 .Re
1423 .Rs
1424 .%R RFC 4251
1425 .%T "The Secure Shell (SSH) Protocol Architecture"
1426 .%D 2006
1427 .Re
1428 .Rs
1429 .%R RFC 4252
1430 .%T "The Secure Shell (SSH) Authentication Protocol"
1431 .%D 2006
1432 .Re
1433 .Rs
1434 .%R RFC 4253
1435 .%T "The Secure Shell (SSH) Transport Layer Protocol"
1436 .%D 2006
1437 .Re
1438 .Rs
1439 .%R RFC 4254
1440 .%T "The Secure Shell (SSH) Connection Protocol"
1441 .%D 2006
1442 .Re
1443 .Rs
1444 .%R RFC 4255
1445 .%T "Using DNS to Securely Publish Secure Shell (SSH) Key Fingerprints"
1446 .%D 2006
1447 .Re
1448 .Rs
1449 .%R RFC 4256
1450 .%T "Generic Message Exchange Authentication for the Secure Shell Protocol (SSH)"
1451 .%D 2006
1452 .Re
1453 .Rs
1454 .%R RFC 4335
1455 .%T "The Secure Shell (SSH) Session Channel Break Extension"
1456 .%D 2006
1457 .Re
1458 .Rs
1459 .%R RFC 4344
1460 .%T "The Secure Shell (SSH) Transport Layer Encryption Modes"
1461 .%D 2006
1462 .Re
1463 .Rs
1464 .%R RFC 4345
1465 .%T "Improved Arcfour Modes for the Secure Shell (SSH) Transport Layer Protocol"
1466 .%D 2006
1467 .Re
1468 .Rs
1469 .%R RFC 4419
1470 .%T "Diffie-Hellman Group Exchange for the Secure Shell (SSH) Transport Layer Protocol"
1471 .%D 2006
1472 .Re
1473 .Rs
1474 .%R RFC 4716
1475 .%T "The Secure Shell (SSH) Public Key File Format"
1476 .%D 2006
1477 .Re
1478 .Rs
1479 .%R RFC 5656
1480 .%T "Elliptic Curve Algorithm Integration in the Secure Shell Transport Layer"
1481 .%D 2009
1482 .Re
1483 .Rs
1484 .%T "Hash Visualization: a New Technique to improve Real-World Security"
1485 .%A A. Perrig
1486 .%A D. Song
1487 .%D 1999
1488 .%O "International Workshop on Cryptographic Techniques and E-Commerce (CrypTEC '99)"
1489 .Re
1490 .Sh AUTHORS
1491 OpenSSH is a derivative of the original and free
1492 ssh 1.2.12 release by Tatu Ylonen.
1493 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1494 Theo de Raadt and Dug Song
1495 removed many bugs, re-added newer features and
1496 created OpenSSH.
1497 Markus Friedl contributed the support for SSH
1498 protocol versions 1.5 and 2.0.