crypto/openssh/ssh.1

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