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