[BACK]Return to ssh.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/ssh.1, Revision 1.189

1.1       deraadt     1: .\"  -*- nroff -*-
                      2: .\"
                      3: .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
                      4: .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
                      5: .\"                    All rights reserved
                      6: .\"
1.59      deraadt     7: .\" As far as I am concerned, the code I have written for this software
                      8: .\" can be used freely for any purpose.  Any derived versions of this
                      9: .\" software must be clearly marked as such, and if the derived work is
                     10: .\" incompatible with the protocol description in the RFC file, it must be
                     11: .\" called by a name other than "ssh" or "Secure Shell".
                     12: .\"
1.93      deraadt    13: .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
                     14: .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
                     15: .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
1.59      deraadt    16: .\"
                     17: .\" Redistribution and use in source and binary forms, with or without
                     18: .\" modification, are permitted provided that the following conditions
                     19: .\" are met:
                     20: .\" 1. Redistributions of source code must retain the above copyright
                     21: .\"    notice, this list of conditions and the following disclaimer.
                     22: .\" 2. Redistributions in binary form must reproduce the above copyright
                     23: .\"    notice, this list of conditions and the following disclaimer in the
                     24: .\"    documentation and/or other materials provided with the distribution.
1.1       deraadt    25: .\"
1.59      deraadt    26: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
                     27: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
                     28: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
                     29: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
                     30: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
                     31: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
                     32: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
                     33: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
                     34: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
                     35: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.1       deraadt    36: .\"
1.189   ! dtucker    37: .\" $OpenBSD: ssh.1,v 1.188 2004/05/22 16:01:05 jmc Exp $
1.2       deraadt    38: .Dd September 25, 1999
                     39: .Dt SSH 1
                     40: .Os
                     41: .Sh NAME
                     42: .Nm ssh
1.96      deraadt    43: .Nd OpenSSH SSH client (remote login program)
1.2       deraadt    44: .Sh SYNOPSIS
                     45: .Nm ssh
1.178     markus     46: .Op Fl 1246AaCfgkNnqsTtVvXxY
1.108     markus     47: .Op Fl b Ar bind_address
1.51      markus     48: .Op Fl c Ar cipher_spec
1.176     jmc        49: .Op Fl D Ar port
1.2       deraadt    50: .Op Fl e Ar escape_char
1.176     jmc        51: .Op Fl F Ar configfile
1.2       deraadt    52: .Op Fl i Ar identity_file
1.176     jmc        53: .Bk -words
1.12      aaron      54: .Oo Fl L Xo
                     55: .Sm off
1.33      markus     56: .Ar port :
1.12      aaron      57: .Ar host :
                     58: .Ar hostport
                     59: .Sm on
                     60: .Xc
                     61: .Oc
1.168     jmc        62: .Ek
1.176     jmc        63: .Op Fl l Ar login_name
                     64: .Op Fl m Ar mac_spec
                     65: .Op Fl o Ar option
1.168     jmc        66: .Bk -words
1.176     jmc        67: .Op Fl p Ar port
                     68: .Ek
1.12      aaron      69: .Oo Fl R Xo
                     70: .Sm off
1.33      markus     71: .Ar port :
1.12      aaron      72: .Ar host :
                     73: .Ar hostport
                     74: .Sm on
                     75: .Xc
                     76: .Oc
1.176     jmc        77: .Oo Ar user Ns @ Oc Ns Ar hostname
1.2       deraadt    78: .Op Ar command
1.44      aaron      79: .Sh DESCRIPTION
1.2       deraadt    80: .Nm
1.96      deraadt    81: (SSH client) is a program for logging into a remote machine and for
1.40      aaron      82: executing commands on a remote machine.
1.176     jmc        83: It is intended to replace rlogin and rsh,
                     84: and provide secure encrypted communications between
1.40      aaron      85: two untrusted hosts over an insecure network.
1.176     jmc        86: X11 connections and arbitrary TCP/IP ports
                     87: can also be forwarded over the secure channel.
1.2       deraadt    88: .Pp
                     89: .Nm
1.44      aaron      90: connects and logs into the specified
1.176     jmc        91: .Ar hostname
                     92: (with optional
                     93: .Ar user
                     94: name).
1.1       deraadt    95: The user must prove
1.49      markus     96: his/her identity to the remote machine using one of several methods
1.176     jmc        97: depending on the protocol version used.
1.49      markus     98: .Pp
1.176     jmc        99: If
                    100: .Ar command
                    101: is specified,
                    102: .Ar command
                    103: is executed on the remote host instead of a login shell.
1.49      markus    104: .Ss SSH protocol version 1
1.1       deraadt   105: First, if the machine the user logs in from is listed in
1.2       deraadt   106: .Pa /etc/hosts.equiv
1.1       deraadt   107: or
1.2       deraadt   108: .Pa /etc/shosts.equiv
1.1       deraadt   109: on the remote machine, and the user names are
                    110: the same on both sides, the user is immediately permitted to log in.
1.44      aaron     111: Second, if
1.176     jmc       112: .Pa .rhosts
1.1       deraadt   113: or
1.176     jmc       114: .Pa .shosts
1.1       deraadt   115: exists in the user's home directory on the
                    116: remote machine and contains a line containing the name of the client
                    117: machine and the name of the user on that machine, the user is
1.40      aaron     118: permitted to log in.
                    119: This form of authentication alone is normally not
1.1       deraadt   120: allowed by the server because it is not secure.
1.2       deraadt   121: .Pp
1.107     markus    122: The second authentication method is the
1.176     jmc       123: .Em rhosts
1.1       deraadt   124: or
1.176     jmc       125: .Em hosts.equiv
1.40      aaron     126: method combined with RSA-based host authentication.
                    127: It means that if the login would be permitted by
1.49      markus    128: .Pa $HOME/.rhosts ,
                    129: .Pa $HOME/.shosts ,
1.2       deraadt   130: .Pa /etc/hosts.equiv ,
1.1       deraadt   131: or
1.2       deraadt   132: .Pa /etc/shosts.equiv ,
1.11      deraadt   133: and if additionally the server can verify the client's
1.44      aaron     134: host key (see
1.147     deraadt   135: .Pa /etc/ssh/ssh_known_hosts
1.23      markus    136: and
                    137: .Pa $HOME/.ssh/known_hosts
1.1       deraadt   138: in the
1.2       deraadt   139: .Sx FILES
1.176     jmc       140: section), only then is login permitted.
1.40      aaron     141: This authentication method closes security holes due to IP
                    142: spoofing, DNS spoofing and routing spoofing.
                    143: [Note to the administrator:
1.2       deraadt   144: .Pa /etc/hosts.equiv ,
1.49      markus    145: .Pa $HOME/.rhosts ,
1.1       deraadt   146: and the rlogin/rsh protocol in general, are inherently insecure and should be
                    147: disabled if security is desired.]
1.2       deraadt   148: .Pp
1.44      aaron     149: As a third authentication method,
1.2       deraadt   150: .Nm
1.1       deraadt   151: supports RSA based authentication.
                    152: The scheme is based on public-key cryptography: there are cryptosystems
                    153: where encryption and decryption are done using separate keys, and it
                    154: is not possible to derive the decryption key from the encryption key.
1.40      aaron     155: RSA is one such system.
1.44      aaron     156: The idea is that each user creates a public/private
1.40      aaron     157: key pair for authentication purposes.
                    158: The server knows the public key, and only the user knows the private key.
1.176     jmc       159: .Pp
1.44      aaron     160: The file
1.2       deraadt   161: .Pa $HOME/.ssh/authorized_keys
1.176     jmc       162: lists the public keys that are permitted for logging in.
1.40      aaron     163: When the user logs in, the
1.2       deraadt   164: .Nm
1.1       deraadt   165: program tells the server which key pair it would like to use for
1.40      aaron     166: authentication.
1.176     jmc       167: The server checks if this key is permitted, and if so,
                    168: sends the user (actually the
1.2       deraadt   169: .Nm
1.1       deraadt   170: program running on behalf of the user) a challenge, a random number,
1.40      aaron     171: encrypted by the user's public key.
1.176     jmc       172: The challenge can only be decrypted using the proper private key.
                    173: The user's client then decrypts the challenge using the private key,
                    174: proving that he/she knows the private key
                    175: but without disclosing it to the server.
1.2       deraadt   176: .Pp
                    177: .Nm
1.40      aaron     178: implements the RSA authentication protocol automatically.
                    179: The user creates his/her RSA key pair by running
1.2       deraadt   180: .Xr ssh-keygen 1 .
1.44      aaron     181: This stores the private key in
1.49      markus    182: .Pa $HOME/.ssh/identity
1.176     jmc       183: and stores the public key in
1.49      markus    184: .Pa $HOME/.ssh/identity.pub
1.40      aaron     185: in the user's home directory.
                    186: The user should then copy the
1.2       deraadt   187: .Pa identity.pub
1.44      aaron     188: to
1.49      markus    189: .Pa $HOME/.ssh/authorized_keys
1.44      aaron     190: in his/her home directory on the remote machine (the
1.2       deraadt   191: .Pa authorized_keys
1.44      aaron     192: file corresponds to the conventional
1.49      markus    193: .Pa $HOME/.rhosts
1.1       deraadt   194: file, and has one key
1.40      aaron     195: per line, though the lines can be very long).
                    196: After this, the user can log in without giving the password.
1.176     jmc       197: RSA authentication is much more secure than
                    198: .Em rhosts
                    199: authentication.
1.2       deraadt   200: .Pp
1.1       deraadt   201: The most convenient way to use RSA authentication may be with an
1.40      aaron     202: authentication agent.
                    203: See
1.2       deraadt   204: .Xr ssh-agent 1
1.1       deraadt   205: for more information.
1.2       deraadt   206: .Pp
1.44      aaron     207: If other authentication methods fail,
1.2       deraadt   208: .Nm
1.40      aaron     209: prompts the user for a password.
                    210: The password is sent to the remote
1.1       deraadt   211: host for checking; however, since all communications are encrypted,
                    212: the password cannot be seen by someone listening on the network.
1.49      markus    213: .Ss SSH protocol version 2
1.176     jmc       214: When a user connects using protocol version 2,
1.145     markus    215: similar authentication methods are available.
1.107     markus    216: Using the default values for
                    217: .Cm PreferredAuthentications ,
1.123     markus    218: the client will try to authenticate first using the hostbased method;
1.176     jmc       219: if this method fails, public key authentication is attempted,
                    220: and finally if this method fails, keyboard-interactive and
1.123     markus    221: password authentication are tried.
1.49      markus    222: .Pp
                    223: The public key method is similar to RSA authentication described
1.107     markus    224: in the previous section and allows the RSA or DSA algorithm to be used:
1.102     itojun    225: The client uses his private key,
1.49      markus    226: .Pa $HOME/.ssh/id_dsa
1.102     itojun    227: or
                    228: .Pa $HOME/.ssh/id_rsa ,
1.49      markus    229: to sign the session identifier and sends the result to the server.
                    230: The server checks whether the matching public key is listed in
1.115     markus    231: .Pa $HOME/.ssh/authorized_keys
1.49      markus    232: and grants access if both the key is found and the signature is correct.
                    233: The session identifier is derived from a shared Diffie-Hellman value
                    234: and is only known to the client and the server.
                    235: .Pp
1.176     jmc       236: If public key authentication fails or is not available, a password
                    237: can be sent encrypted to the remote host to prove the user's identity.
1.107     markus    238: .Pp
                    239: Additionally,
                    240: .Nm
                    241: supports hostbased or challenge response authentication.
1.49      markus    242: .Pp
                    243: Protocol 2 provides additional mechanisms for confidentiality
1.189   ! dtucker   244: (the traffic is encrypted using AES, 3DES, Blowfish, CAST128 or Arcfour)
        !           245: and integrity (hmac-md5, hmac-sha1, hmac-ripemd160).
1.49      markus    246: Note that protocol 1 lacks a strong mechanism for ensuring the
                    247: integrity of the connection.
                    248: .Ss Login session and remote execution
1.1       deraadt   249: When the user's identity has been accepted by the server, the server
                    250: either executes the given command, or logs into the machine and gives
1.40      aaron     251: the user a normal shell on the remote machine.
                    252: All communication with
1.1       deraadt   253: the remote command or shell will be automatically encrypted.
1.2       deraadt   254: .Pp
1.1       deraadt   255: If a pseudo-terminal has been allocated (normal login session), the
1.104     djm       256: user may use the escape characters noted below.
1.2       deraadt   257: .Pp
1.176     jmc       258: If no pseudo-tty has been allocated,
                    259: the session is transparent and can be used to reliably transfer binary data.
1.40      aaron     260: On most systems, setting the escape character to
1.2       deraadt   261: .Dq none
                    262: will also make the session transparent even if a tty is used.
                    263: .Pp
1.71      djm       264: The session terminates when the command or shell on the remote
1.92      markus    265: machine exits and all X11 and TCP/IP connections have been closed.
1.176     jmc       266: The exit status of the remote program is returned as the exit status of
1.2       deraadt   267: .Nm ssh .
1.104     djm       268: .Ss Escape Characters
1.176     jmc       269: When a pseudo-terminal has been requested,
                    270: .Nm
                    271: supports a number of functions through the use of an escape character.
1.104     djm       272: .Pp
                    273: A single tilde character can be sent as
                    274: .Ic ~~
1.119     stevesk   275: or by following the tilde by a character other than those described below.
1.104     djm       276: The escape character must always follow a newline to be interpreted as
                    277: special.
                    278: The escape character can be changed in configuration files using the
                    279: .Cm EscapeChar
1.117     itojun    280: configuration directive or on the command line by the
1.104     djm       281: .Fl e
                    282: option.
                    283: .Pp
                    284: The supported escapes (assuming the default
                    285: .Ql ~ )
                    286: are:
                    287: .Bl -tag -width Ds
                    288: .It Cm ~.
1.176     jmc       289: Disconnect.
1.104     djm       290: .It Cm ~^Z
1.176     jmc       291: Background
                    292: .Nm ssh .
1.104     djm       293: .It Cm ~#
1.176     jmc       294: List forwarded connections.
1.104     djm       295: .It Cm ~&
1.176     jmc       296: Background
                    297: .Nm
                    298: at logout when waiting for forwarded connection / X11 sessions to terminate.
1.104     djm       299: .It Cm ~?
1.176     jmc       300: Display a list of escape characters.
1.170     markus    301: .It Cm ~B
1.176     jmc       302: Send a BREAK to the remote system
                    303: (only useful for SSH protocol version 2 and if the peer supports it).
1.149     jakob     304: .It Cm ~C
1.186     djm       305: Open command line.
                    306: Currently this allows the addition of port forwardings using the
1.149     jakob     307: .Fl L
                    308: and
                    309: .Fl R
1.186     djm       310: options (see below).
1.188     jmc       311: It also allows the cancellation of existing remote port-forwardings
1.186     djm       312: using
                    313: .Fl KR Ar hostport .
1.187     djm       314: Basic help is available, using the
                    315: .Fl h
1.186     djm       316: option.
1.104     djm       317: .It Cm ~R
1.176     jmc       318: Request rekeying of the connection
                    319: (only useful for SSH protocol version 2 and if the peer supports it).
1.104     djm       320: .El
1.49      markus    321: .Ss X11 and TCP forwarding
1.110     deraadt   322: If the
                    323: .Cm ForwardX11
                    324: variable is set to
                    325: .Dq yes
1.176     jmc       326: (or see the description of the
1.110     deraadt   327: .Fl X
                    328: and
                    329: .Fl x
                    330: options described later)
                    331: and the user is using X11 (the
1.2       deraadt   332: .Ev DISPLAY
1.1       deraadt   333: environment variable is set), the connection to the X11 display is
                    334: automatically forwarded to the remote side in such a way that any X11
                    335: programs started from the shell (or command) will go through the
                    336: encrypted channel, and the connection to the real X server will be made
1.40      aaron     337: from the local machine.
                    338: The user should not manually set
1.2       deraadt   339: .Ev DISPLAY .
1.1       deraadt   340: Forwarding of X11 connections can be
                    341: configured on the command line or in configuration files.
1.2       deraadt   342: .Pp
                    343: The
1.44      aaron     344: .Ev DISPLAY
1.2       deraadt   345: value set by
                    346: .Nm
1.176     jmc       347: will point to the server machine, but with a display number greater than zero.
1.40      aaron     348: This is normal, and happens because
1.2       deraadt   349: .Nm
                    350: creates a
                    351: .Dq proxy
                    352: X server on the server machine for forwarding the
1.1       deraadt   353: connections over the encrypted channel.
1.2       deraadt   354: .Pp
                    355: .Nm
1.1       deraadt   356: will also automatically set up Xauthority data on the server machine.
                    357: For this purpose, it will generate a random authorization cookie,
                    358: store it in Xauthority on the server, and verify that any forwarded
                    359: connections carry this cookie and replace it by the real cookie when
1.40      aaron     360: the connection is opened.
                    361: The real authentication cookie is never
1.1       deraadt   362: sent to the server machine (and no cookies are sent in the plain).
1.2       deraadt   363: .Pp
1.163     stevesk   364: If the
                    365: .Cm ForwardAgent
                    366: variable is set to
                    367: .Dq yes
1.176     jmc       368: (or see the description of the
1.163     stevesk   369: .Fl A
                    370: and
                    371: .Fl a
1.168     jmc       372: options described later) and
1.163     stevesk   373: the user is using an authentication agent, the connection to the agent
                    374: is automatically forwarded to the remote side.
1.2       deraadt   375: .Pp
1.1       deraadt   376: Forwarding of arbitrary TCP/IP connections over the secure channel can
1.120     stevesk   377: be specified either on the command line or in a configuration file.
1.40      aaron     378: One possible application of TCP/IP forwarding is a secure connection to an
1.92      markus    379: electronic purse; another is going through firewalls.
1.49      markus    380: .Ss Server authentication
1.2       deraadt   381: .Nm
1.49      markus    382: automatically maintains and checks a database containing
1.40      aaron     383: identifications for all hosts it has ever been used with.
1.116     markus    384: Host keys are stored in
1.49      markus    385: .Pa $HOME/.ssh/known_hosts
1.40      aaron     386: in the user's home directory.
1.116     markus    387: Additionally, the file
1.147     deraadt   388: .Pa /etc/ssh/ssh_known_hosts
1.116     markus    389: is automatically checked for known hosts.
1.40      aaron     390: Any new hosts are automatically added to the user's file.
1.176     jmc       391: If a host's identification ever changes,
1.2       deraadt   392: .Nm
1.1       deraadt   393: warns about this and disables password authentication to prevent a
1.40      aaron     394: trojan horse from getting the user's password.
1.176     jmc       395: Another purpose of this mechanism is to prevent man-in-the-middle attacks
                    396: which could otherwise be used to circumvent the encryption.
1.40      aaron     397: The
1.2       deraadt   398: .Cm StrictHostKeyChecking
1.158     stevesk   399: option can be used to prevent logins to machines whose
1.1       deraadt   400: host key is not known or has changed.
1.65      aaron     401: .Pp
                    402: The options are as follows:
1.2       deraadt   403: .Bl -tag -width Ds
1.176     jmc       404: .It Fl 1
                    405: Forces
                    406: .Nm
                    407: to try protocol version 1 only.
                    408: .It Fl 2
                    409: Forces
                    410: .Nm
                    411: to try protocol version 2 only.
                    412: .It Fl 4
                    413: Forces
                    414: .Nm
                    415: to use IPv4 addresses only.
                    416: .It Fl 6
                    417: Forces
                    418: .Nm
                    419: to use IPv6 addresses only.
1.54      markus    420: .It Fl A
                    421: Enables forwarding of the authentication agent connection.
                    422: This can also be specified on a per-host basis in a configuration file.
1.165     stevesk   423: .Pp
1.168     jmc       424: Agent forwarding should be enabled with caution.
                    425: Users with the ability to bypass file permissions on the remote host
                    426: (for the agent's Unix-domain socket)
                    427: can access the local agent through the forwarded connection.
                    428: An attacker cannot obtain key material from the agent,
1.165     stevesk   429: however they can perform operations on the keys that enable them to
                    430: authenticate using the identities loaded into the agent.
1.176     jmc       431: .It Fl a
                    432: Disables forwarding of the authentication agent connection.
1.108     markus    433: .It Fl b Ar bind_address
                    434: Specify the interface to transmit from on machines with multiple
                    435: interfaces or aliased addresses.
1.176     jmc       436: .It Fl C
                    437: Requests compression of all data (including stdin, stdout, stderr, and
                    438: data for forwarded X11 and TCP/IP connections).
                    439: The compression algorithm is the same used by
                    440: .Xr gzip 1 ,
                    441: and the
                    442: .Dq level
                    443: can be controlled by the
                    444: .Cm CompressionLevel
                    445: option for protocol version 1.
                    446: Compression is desirable on modem lines and other
                    447: slow connections, but will only slow down things on fast networks.
                    448: The default value can be set on a host-by-host basis in the
                    449: configuration files; see the
                    450: .Cm Compression
                    451: option.
1.189   ! dtucker   452: .It Fl c Ar cipher_spec
        !           453: Selects the cipher specification for encrypting the session.
        !           454: .Pp
        !           455: Protocol version 1 allows specification of a single cipher.
        !           456: The suported values are
        !           457: .Dq 3des ,
        !           458: .Dq blowfish
        !           459: and
        !           460: .Dq des .
1.2       deraadt   461: .Ar 3des
1.189   ! dtucker   462: (triple-des) is an encrypt-decrypt-encrypt triple with three different keys.
1.44      aaron     463: It is believed to be secure.
1.5       deraadt   464: .Ar blowfish
1.176     jmc       465: is a fast block cipher; it appears very secure and is much faster than
1.40      aaron     466: .Ar 3des .
1.131     stevesk   467: .Ar des
                    468: is only supported in the
                    469: .Nm
                    470: client for interoperability with legacy protocol 1 implementations
                    471: that do not support the
                    472: .Ar 3des
1.168     jmc       473: cipher.
                    474: Its use is strongly discouraged due to cryptographic weaknesses.
1.189   ! dtucker   475: The default is
        !           476: .Dq 3des .
        !           477: .Pp
        !           478: For protocol version 2
        !           479: .Ar cipher_spec
        !           480: is a comma-separated list of ciphers
        !           481: listed in order of preference.
        !           482: The supported ciphers are
        !           483: .Dq 3des-cbc ,
        !           484: .Dq aes128-cbc ,
        !           485: .Dq aes192-cbc ,
        !           486: .Dq aes256-cbc ,
        !           487: .Dq aes128-ctr ,
        !           488: .Dq aes192-ctr ,
        !           489: .Dq aes256-ctr ,
        !           490: .Dq arcfour ,
        !           491: .Dq blowfish-cbc ,
        !           492: and
        !           493: .Dq cast128-cbc .
        !           494: The default is
        !           495: .Bd -literal
        !           496:   ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
        !           497:     aes192-cbc,aes256-cbc''
        !           498: .Ed
1.176     jmc       499: .It Fl D Ar port
                    500: Specifies a local
                    501: .Dq dynamic
                    502: application-level port forwarding.
                    503: This works by allocating a socket to listen to
                    504: .Ar port
                    505: on the local side, and whenever a connection is made to this port, the
                    506: connection is forwarded over the secure channel, and the application
                    507: protocol is then used to determine where to connect to from the
                    508: remote machine.
                    509: Currently the SOCKS4 and SOCKS5 protocols are supported, and
                    510: .Nm
                    511: will act as a SOCKS server.
                    512: Only root can forward privileged ports.
                    513: Dynamic port forwardings can also be specified in the configuration file.
                    514: .It Fl e Ar ch | ^ch | none
1.2       deraadt   515: Sets the escape character for sessions with a pty (default:
                    516: .Ql ~ ) .
1.40      aaron     517: The escape character is only recognized at the beginning of a line.
                    518: The escape character followed by a dot
1.2       deraadt   519: .Pq Ql \&.
1.176     jmc       520: closes the connection;
                    521: followed by control-Z suspends the connection;
                    522: and followed by itself sends the escape character once.
1.40      aaron     523: Setting the character to
1.2       deraadt   524: .Dq none
                    525: disables any escapes and makes the session fully transparent.
1.176     jmc       526: .It Fl F Ar configfile
                    527: Specifies an alternative per-user configuration file.
                    528: If a configuration file is given on the command line,
                    529: the system-wide configuration file
                    530: .Pq Pa /etc/ssh/ssh_config
                    531: will be ignored.
                    532: The default for the per-user configuration file is
                    533: .Pa $HOME/.ssh/config .
1.2       deraadt   534: .It Fl f
                    535: Requests
                    536: .Nm
1.40      aaron     537: to go to background just before command execution.
                    538: This is useful if
1.2       deraadt   539: .Nm
                    540: is going to ask for passwords or passphrases, but the user
1.40      aaron     541: wants it in the background.
1.44      aaron     542: This implies
1.2       deraadt   543: .Fl n .
1.1       deraadt   544: The recommended way to start X11 programs at a remote site is with
1.2       deraadt   545: something like
                    546: .Ic ssh -f host xterm .
1.34      markus    547: .It Fl g
                    548: Allows remote hosts to connect to local forwarded ports.
1.176     jmc       549: .It Fl I Ar smartcard_device
                    550: Specifies which smartcard device to use.
                    551: The argument is the device
                    552: .Nm
                    553: should use to communicate with a smartcard used for storing the user's
                    554: private RSA key.
1.2       deraadt   555: .It Fl i Ar identity_file
1.144     stevesk   556: Selects a file from which the identity (private key) for
1.68      markus    557: RSA or DSA authentication is read.
1.144     stevesk   558: The default is
1.49      markus    559: .Pa $HOME/.ssh/identity
1.144     stevesk   560: for protocol version 1, and
                    561: .Pa $HOME/.ssh/id_rsa
                    562: and
                    563: .Pa $HOME/.ssh/id_dsa
                    564: for protocol version 2.
1.40      aaron     565: Identity files may also be specified on
                    566: a per-host basis in the configuration file.
                    567: It is possible to have multiple
1.2       deraadt   568: .Fl i
                    569: options (and multiple identities specified in
1.1       deraadt   570: configuration files).
1.2       deraadt   571: .It Fl k
1.179     dtucker   572: Disables forwarding (delegation) of GSSAPI credentials to the server.
1.176     jmc       573: .It Fl L Xo
                    574: .Sm off
                    575: .Ar port : host : hostport
                    576: .Sm on
                    577: .Xc
                    578: Specifies that the given port on the local (client) host is to be
                    579: forwarded to the given host and port on the remote side.
                    580: This works by allocating a socket to listen to
                    581: .Ar port
                    582: on the local side, and whenever a connection is made to this port, the
                    583: connection is forwarded over the secure channel, and a connection is
                    584: made to
                    585: .Ar host
                    586: port
                    587: .Ar hostport
                    588: from the remote machine.
                    589: Port forwardings can also be specified in the configuration file.
                    590: Only root can forward privileged ports.
                    591: IPv6 addresses can be specified with an alternative syntax:
                    592: .Sm off
                    593: .Xo
                    594: .Ar port No / Ar host No /
                    595: .Ar hostport .
                    596: .Xc
                    597: .Sm on
1.2       deraadt   598: .It Fl l Ar login_name
1.40      aaron     599: Specifies the user to log in as on the remote machine.
                    600: This also may be specified on a per-host basis in the configuration file.
1.91      markus    601: .It Fl m Ar mac_spec
                    602: Additionally, for protocol version 2 a comma-separated list of MAC
                    603: (message authentication code) algorithms can
                    604: be specified in order of preference.
                    605: See the
                    606: .Cm MACs
                    607: keyword for more information.
1.176     jmc       608: .It Fl N
                    609: Do not execute a remote command.
                    610: This is useful for just forwarding ports
                    611: (protocol version 2 only).
1.2       deraadt   612: .It Fl n
                    613: Redirects stdin from
                    614: .Pa /dev/null
                    615: (actually, prevents reading from stdin).
1.1       deraadt   616: This must be used when
1.2       deraadt   617: .Nm
1.40      aaron     618: is run in the background.
                    619: A common trick is to use this to run X11 programs on a remote machine.
                    620: For example,
1.2       deraadt   621: .Ic ssh -n shadows.cs.hut.fi emacs &
                    622: will start an emacs on shadows.cs.hut.fi, and the X11
1.1       deraadt   623: connection will be automatically forwarded over an encrypted channel.
                    624: The
1.2       deraadt   625: .Nm
1.1       deraadt   626: program will be put in the background.
                    627: (This does not work if
1.2       deraadt   628: .Nm
                    629: needs to ask for a password or passphrase; see also the
                    630: .Fl f
                    631: option.)
                    632: .It Fl o Ar option
1.127     stevesk   633: Can be used to give options in the format used in the configuration file.
1.1       deraadt   634: This is useful for specifying options for which there is no separate
1.40      aaron     635: command-line flag.
1.176     jmc       636: For full details of the options listed below, and their possible values, see
                    637: .Xr ssh_config 5 .
                    638: .Pp
                    639: .Bl -tag -width Ds -offset indent -compact
                    640: .It AddressFamily
                    641: .It BatchMode
                    642: .It BindAddress
                    643: .It ChallengeResponseAuthentication
                    644: .It CheckHostIP
                    645: .It Cipher
                    646: .It Ciphers
                    647: .It ClearAllForwardings
                    648: .It Compression
                    649: .It CompressionLevel
                    650: .It ConnectionAttempts
1.185     dtucker   651: .It ConnectTimeout
1.176     jmc       652: .It DynamicForward
                    653: .It EscapeChar
                    654: .It ForwardAgent
                    655: .It ForwardX11
1.178     markus    656: .It ForwardX11Trusted
1.176     jmc       657: .It GatewayPorts
                    658: .It GlobalKnownHostsFile
                    659: .It GSSAPIAuthentication
                    660: .It GSSAPIDelegateCredentials
                    661: .It Host
                    662: .It HostbasedAuthentication
                    663: .It HostKeyAlgorithms
                    664: .It HostKeyAlias
                    665: .It HostName
                    666: .It IdentityFile
1.182     markus    667: .It IdentitiesOnly
1.176     jmc       668: .It LocalForward
                    669: .It LogLevel
                    670: .It MACs
                    671: .It NoHostAuthenticationForLocalhost
                    672: .It NumberOfPasswordPrompts
                    673: .It PasswordAuthentication
                    674: .It Port
                    675: .It PreferredAuthentications
                    676: .It Protocol
                    677: .It ProxyCommand
                    678: .It PubkeyAuthentication
                    679: .It RemoteForward
                    680: .It RhostsRSAAuthentication
                    681: .It RSAAuthentication
1.184     jmc       682: .It SendEnv
1.181     markus    683: .It ServerAliveInterval
                    684: .It ServerAliveCountMax
1.176     jmc       685: .It SmartcardDevice
                    686: .It StrictHostKeyChecking
1.180     markus    687: .It TCPKeepAlive
1.176     jmc       688: .It UsePrivilegedPort
                    689: .It User
                    690: .It UserKnownHostsFile
                    691: .It VerifyHostKeyDNS
                    692: .It XAuthLocation
                    693: .El
1.2       deraadt   694: .It Fl p Ar port
1.40      aaron     695: Port to connect to on the remote host.
                    696: This can be specified on a
1.1       deraadt   697: per-host basis in the configuration file.
1.2       deraadt   698: .It Fl q
1.40      aaron     699: Quiet mode.
                    700: Causes all warning and diagnostic messages to be suppressed.
1.176     jmc       701: .It Fl R Xo
                    702: .Sm off
                    703: .Ar port : host : hostport
                    704: .Sm on
                    705: .Xc
                    706: Specifies that the given port on the remote (server) host is to be
                    707: forwarded to the given host and port on the local side.
                    708: This works by allocating a socket to listen to
                    709: .Ar port
                    710: on the remote side, and whenever a connection is made to this port, the
                    711: connection is forwarded over the secure channel, and a connection is
                    712: made to
                    713: .Ar host
                    714: port
                    715: .Ar hostport
                    716: from the local machine.
                    717: Port forwardings can also be specified in the configuration file.
                    718: Privileged ports can be forwarded only when
                    719: logging in as root on the remote machine.
                    720: IPv6 addresses can be specified with an alternative syntax:
                    721: .Sm off
                    722: .Xo
                    723: .Ar port No / Ar host No /
                    724: .Ar hostport .
                    725: .Xc
                    726: .Sm on
1.80      djm       727: .It Fl s
1.172     jmc       728: May be used to request invocation of a subsystem on the remote system.
                    729: Subsystems are a feature of the SSH2 protocol which facilitate the use
1.176     jmc       730: of SSH as a secure transport for other applications (eg.\&
                    731: .Xr sftp 1 ) .
1.172     jmc       732: The subsystem is specified as the remote command.
1.176     jmc       733: .It Fl T
                    734: Disable pseudo-tty allocation.
1.2       deraadt   735: .It Fl t
1.40      aaron     736: Force pseudo-tty allocation.
1.43      brad      737: This can be used to execute arbitrary
1.40      aaron     738: screen-based programs on a remote machine, which can be very useful,
                    739: e.g., when implementing menu services.
1.73      markus    740: Multiple
                    741: .Fl t
                    742: options force tty allocation, even if
                    743: .Nm
                    744: has no local tty.
1.176     jmc       745: .It Fl V
                    746: Display the version number and exit.
1.2       deraadt   747: .It Fl v
1.40      aaron     748: Verbose mode.
                    749: Causes
1.2       deraadt   750: .Nm
1.40      aaron     751: to print debugging messages about its progress.
                    752: This is helpful in
1.1       deraadt   753: debugging connection, authentication, and configuration problems.
1.73      markus    754: Multiple
                    755: .Fl v
1.169     naddy     756: options increase the verbosity.
                    757: The maximum is 3.
1.2       deraadt   758: .It Fl X
1.1       deraadt   759: Enables X11 forwarding.
1.54      markus    760: This can also be specified on a per-host basis in a configuration file.
1.165     stevesk   761: .Pp
1.168     jmc       762: X11 forwarding should be enabled with caution.
                    763: Users with the ability to bypass file permissions on the remote host
                    764: (for the user's X authorization database)
                    765: can access the local X11 display through the forwarded connection.
                    766: An attacker may then be able to perform activities such as keystroke monitoring.
1.176     jmc       767: .It Fl x
                    768: Disables X11 forwarding.
1.178     markus    769: .It Fl Y
                    770: Enables trusted X11 forwarding.
1.2       deraadt   771: .El
                    772: .Sh CONFIGURATION FILES
                    773: .Nm
1.158     stevesk   774: may additionally obtain configuration data from
                    775: a per-user configuration file and a system-wide configuration file.
                    776: The file format and configuration options are described in
                    777: .Xr ssh_config 5 .
1.2       deraadt   778: .Sh ENVIRONMENT
                    779: .Nm
1.1       deraadt   780: will normally set the following environment variables:
1.176     jmc       781: .Bl -tag -width LOGNAME
1.2       deraadt   782: .It Ev DISPLAY
                    783: The
                    784: .Ev DISPLAY
1.40      aaron     785: variable indicates the location of the X11 server.
1.44      aaron     786: It is automatically set by
1.2       deraadt   787: .Nm
                    788: to point to a value of the form
                    789: .Dq hostname:n
                    790: where hostname indicates
1.176     jmc       791: the host where the shell runs, and n is an integer \*(Ge 1.
1.40      aaron     792: .Nm
                    793: uses this special value to forward X11 connections over the secure
                    794: channel.
1.107     markus    795: The user should normally not set
                    796: .Ev DISPLAY
                    797: explicitly, as that
1.1       deraadt   798: will render the X11 connection insecure (and will require the user to
                    799: manually copy any required authorization cookies).
1.2       deraadt   800: .It Ev HOME
1.1       deraadt   801: Set to the path of the user's home directory.
1.2       deraadt   802: .It Ev LOGNAME
                    803: Synonym for
1.12      aaron     804: .Ev USER ;
                    805: set for compatibility with systems that use this variable.
1.2       deraadt   806: .It Ev MAIL
1.129     stevesk   807: Set to the path of the user's mailbox.
1.40      aaron     808: .It Ev PATH
1.2       deraadt   809: Set to the default
                    810: .Ev PATH ,
                    811: as specified when compiling
1.12      aaron     812: .Nm ssh .
1.118     markus    813: .It Ev SSH_ASKPASS
                    814: If
                    815: .Nm
                    816: needs a passphrase, it will read the passphrase from the current
                    817: terminal if it was run from a terminal.
                    818: If
                    819: .Nm
                    820: does not have a terminal associated with it but
                    821: .Ev DISPLAY
                    822: and
                    823: .Ev SSH_ASKPASS
                    824: are set, it will execute the program specified by
                    825: .Ev SSH_ASKPASS
                    826: and open an X11 window to read the passphrase.
                    827: This is particularly useful when calling
                    828: .Nm
                    829: from a
                    830: .Pa .Xsession
                    831: or related script.
                    832: (Note that on some machines it
                    833: may be necessary to redirect the input from
                    834: .Pa /dev/null
                    835: to make this work.)
1.18      markus    836: .It Ev SSH_AUTH_SOCK
1.129     stevesk   837: Identifies the path of a unix-domain socket used to communicate with the
1.17      markus    838: agent.
1.166     stevesk   839: .It Ev SSH_CONNECTION
                    840: Identifies the client and server ends of the connection.
1.40      aaron     841: The variable contains
1.166     stevesk   842: four space-separated values: client ip-address, client port number,
                    843: server ip-address and server port number.
1.73      markus    844: .It Ev SSH_ORIGINAL_COMMAND
                    845: The variable contains the original command line if a forced command
                    846: is executed.
                    847: It can be used to extract the original arguments.
1.2       deraadt   848: .It Ev SSH_TTY
1.1       deraadt   849: This is set to the name of the tty (path to the device) associated
1.40      aaron     850: with the current shell or command.
                    851: If the current session has no tty,
1.1       deraadt   852: this variable is not set.
1.2       deraadt   853: .It Ev TZ
1.1       deraadt   854: The timezone variable is set to indicate the present timezone if it
1.56      deraadt   855: was set when the daemon was started (i.e., the daemon passes the value
1.1       deraadt   856: on to new connections).
1.2       deraadt   857: .It Ev USER
1.1       deraadt   858: Set to the name of the user logging in.
1.2       deraadt   859: .El
                    860: .Pp
1.44      aaron     861: Additionally,
1.2       deraadt   862: .Nm
1.44      aaron     863: reads
                    864: .Pa $HOME/.ssh/environment ,
1.2       deraadt   865: and adds lines of the format
                    866: .Dq VARNAME=value
1.161     marc      867: to the environment if the file exists and if users are allowed to
                    868: change their environment.
1.176     jmc       869: For more information, see the
1.161     marc      870: .Cm PermitUserEnvironment
1.162     stevesk   871: option in
1.161     marc      872: .Xr sshd_config 5 .
1.2       deraadt   873: .Sh FILES
1.36      markus    874: .Bl -tag -width Ds
1.116     markus    875: .It Pa $HOME/.ssh/known_hosts
1.129     stevesk   876: Records host keys for all hosts the user has logged into that are not
1.2       deraadt   877: in
1.147     deraadt   878: .Pa /etc/ssh/ssh_known_hosts .
1.2       deraadt   879: See
                    880: .Xr sshd 8 .
1.102     itojun    881: .It Pa $HOME/.ssh/identity, $HOME/.ssh/id_dsa, $HOME/.ssh/id_rsa
                    882: Contains the authentication identity of the user.
                    883: They are for protocol 1 RSA, protocol 2 DSA, and protocol 2 RSA, respectively.
1.48      markus    884: These files
                    885: contain sensitive data and should be readable by the user but not
1.15      markus    886: accessible by others (read/write/execute).
                    887: Note that
                    888: .Nm
1.48      markus    889: ignores a private key file if it is accessible by others.
1.15      markus    890: It is possible to specify a passphrase when
1.1       deraadt   891: generating the key; the passphrase will be used to encrypt the
1.8       deraadt   892: sensitive part of this file using 3DES.
1.102     itojun    893: .It Pa $HOME/.ssh/identity.pub, $HOME/.ssh/id_dsa.pub, $HOME/.ssh/id_rsa.pub
1.1       deraadt   894: Contains the public key for authentication (public part of the
1.40      aaron     895: identity file in human-readable form).
1.48      markus    896: The contents of the
                    897: .Pa $HOME/.ssh/identity.pub
1.176     jmc       898: file should be added to the file
1.2       deraadt   899: .Pa $HOME/.ssh/authorized_keys
                    900: on all machines
1.137     deraadt   901: where the user wishes to log in using protocol version 1 RSA authentication.
1.48      markus    902: The contents of the
                    903: .Pa $HOME/.ssh/id_dsa.pub
1.102     itojun    904: and
                    905: .Pa $HOME/.ssh/id_rsa.pub
1.48      markus    906: file should be added to
1.115     markus    907: .Pa $HOME/.ssh/authorized_keys
1.48      markus    908: on all machines
1.137     deraadt   909: where the user wishes to log in using protocol version 2 DSA/RSA authentication.
1.48      markus    910: These files are not
1.40      aaron     911: sensitive and can (but need not) be readable by anyone.
1.48      markus    912: These files are
1.84      markus    913: never used automatically and are not necessary; they are only provided for
1.1       deraadt   914: the convenience of the user.
1.2       deraadt   915: .It Pa $HOME/.ssh/config
1.40      aaron     916: This is the per-user configuration file.
1.158     stevesk   917: The file format and configuration options are described in
                    918: .Xr ssh_config 5 .
1.183     djm       919: Because of the potential for abuse, this file must have strict permissions:
                    920: read/write for the user, and not accessible by others.
1.2       deraadt   921: .It Pa $HOME/.ssh/authorized_keys
1.115     markus    922: Lists the public keys (RSA/DSA) that can be used for logging in as this user.
1.40      aaron     923: The format of this file is described in the
1.2       deraadt   924: .Xr sshd 8
1.40      aaron     925: manual page.
1.176     jmc       926: In the simplest form the format is the same as the
                    927: .Pa .pub
1.116     markus    928: identity files.
1.48      markus    929: This file is not highly sensitive, but the recommended
                    930: permissions are read/write for the user, and not accessible by others.
1.147     deraadt   931: .It Pa /etc/ssh/ssh_known_hosts
1.40      aaron     932: Systemwide list of known host keys.
1.116     markus    933: This file should be prepared by the
1.1       deraadt   934: system administrator to contain the public host keys of all machines in the
1.40      aaron     935: organization.
                    936: This file should be world-readable.
                    937: This file contains
1.1       deraadt   938: public keys, one per line, in the following format (fields separated
1.116     markus    939: by spaces): system name, public key and optional comment field.
1.40      aaron     940: When different names are used
1.1       deraadt   941: for the same machine, all such names should be listed, separated by
1.40      aaron     942: commas.
1.176     jmc       943: The format is described in the
1.2       deraadt   944: .Xr sshd 8
1.1       deraadt   945: manual page.
1.2       deraadt   946: .Pp
1.1       deraadt   947: The canonical system name (as returned by name servers) is used by
1.2       deraadt   948: .Xr sshd 8
1.1       deraadt   949: to verify the client host when logging in; other names are needed because
1.2       deraadt   950: .Nm
1.1       deraadt   951: does not convert the user-supplied name to a canonical name before
                    952: checking the key, because someone with access to the name servers
                    953: would then be able to fool host authentication.
1.147     deraadt   954: .It Pa /etc/ssh/ssh_config
1.40      aaron     955: Systemwide configuration file.
1.158     stevesk   956: The file format and configuration options are described in
                    957: .Xr ssh_config 5 .
1.147     deraadt   958: .It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key
1.141     markus    959: These three files contain the private parts of the host keys
                    960: and are used for
                    961: .Cm RhostsRSAAuthentication
                    962: and
                    963: .Cm HostbasedAuthentication .
1.155     stevesk   964: If the protocol version 1
                    965: .Cm RhostsRSAAuthentication
1.157     deraadt   966: method is used,
1.155     stevesk   967: .Nm
                    968: must be setuid root, since the host key is readable only by root.
                    969: For protocol version 2,
                    970: .Nm
                    971: uses
                    972: .Xr ssh-keysign 8
                    973: to access the host keys for
                    974: .Cm HostbasedAuthentication .
                    975: This eliminates the requirement that
                    976: .Nm
                    977: be setuid root when that authentication method is used.
                    978: By default
1.141     markus    979: .Nm
1.155     stevesk   980: is not setuid root.
1.2       deraadt   981: .It Pa $HOME/.rhosts
                    982: This file is used in
1.176     jmc       983: .Em rhosts
1.2       deraadt   984: authentication to list the
1.40      aaron     985: host/user pairs that are permitted to log in.
                    986: (Note that this file is
1.1       deraadt   987: also used by rlogin and rsh, which makes using this file insecure.)
                    988: Each line of the file contains a host name (in the canonical form
                    989: returned by name servers), and then a user name on that host,
1.40      aaron     990: separated by a space.
1.92      markus    991: On some machines this file may need to be
1.1       deraadt   992: world-readable if the user's home directory is on a NFS partition,
                    993: because
1.2       deraadt   994: .Xr sshd 8
1.40      aaron     995: reads it as root.
                    996: Additionally, this file must be owned by the user,
                    997: and must not have write permissions for anyone else.
                    998: The recommended
1.1       deraadt   999: permission for most machines is read/write for the user, and not
                   1000: accessible by others.
1.2       deraadt  1001: .Pp
1.1       deraadt  1002: Note that by default
1.2       deraadt  1003: .Xr sshd 8
1.1       deraadt  1004: will be installed so that it requires successful RSA host
1.176     jmc      1005: authentication before permitting
                   1006: .Em rhosts
                   1007: authentication.
1.137     deraadt  1008: If the server machine does not have the client's host key in
1.147     deraadt  1009: .Pa /etc/ssh/ssh_known_hosts ,
1.137     deraadt  1010: it can be stored in
1.2       deraadt  1011: .Pa $HOME/.ssh/known_hosts .
                   1012: The easiest way to do this is to
1.1       deraadt  1013: connect back to the client from the server machine using ssh; this
1.48      markus   1014: will automatically add the host key to
1.2       deraadt  1015: .Pa $HOME/.ssh/known_hosts .
                   1016: .It Pa $HOME/.shosts
                   1017: This file is used exactly the same way as
1.176     jmc      1018: .Pa .rhosts .
1.2       deraadt  1019: The purpose for
1.1       deraadt  1020: having this file is to be able to use rhosts authentication with
1.2       deraadt  1021: .Nm
                   1022: without permitting login with
1.176     jmc      1023: .Xr rlogin
1.2       deraadt  1024: or
                   1025: .Xr rsh 1 .
                   1026: .It Pa /etc/hosts.equiv
                   1027: This file is used during
1.176     jmc      1028: .Em rhosts
1.173     jmc      1029: authentication.
1.40      aaron    1030: It contains
1.176     jmc      1031: canonical hosts names, one per line (the full format is described in the
1.2       deraadt  1032: .Xr sshd 8
1.40      aaron    1033: manual page).
                   1034: If the client host is found in this file, login is
1.1       deraadt  1035: automatically permitted provided client and server user names are the
1.40      aaron    1036: same.
                   1037: Additionally, successful RSA host authentication is normally
                   1038: required.
                   1039: This file should only be writable by root.
1.2       deraadt  1040: .It Pa /etc/shosts.equiv
1.44      aaron    1041: This file is processed exactly as
1.2       deraadt  1042: .Pa /etc/hosts.equiv .
1.1       deraadt  1043: This file may be useful to permit logins using
1.2       deraadt  1044: .Nm
1.1       deraadt  1045: but not using rsh/rlogin.
1.147     deraadt  1046: .It Pa /etc/ssh/sshrc
1.1       deraadt  1047: Commands in this file are executed by
1.2       deraadt  1048: .Nm
1.1       deraadt  1049: when the user logs in just before the user's shell (or command) is started.
                   1050: See the
1.2       deraadt  1051: .Xr sshd 8
1.1       deraadt  1052: manual page for more information.
1.2       deraadt  1053: .It Pa $HOME/.ssh/rc
1.1       deraadt  1054: Commands in this file are executed by
1.2       deraadt  1055: .Nm
1.1       deraadt  1056: when the user logs in just before the user's shell (or command) is
                   1057: started.
1.44      aaron    1058: See the
1.2       deraadt  1059: .Xr sshd 8
1.1       deraadt  1060: manual page for more information.
1.31      markus   1061: .It Pa $HOME/.ssh/environment
                   1062: Contains additional definitions for environment variables, see section
                   1063: .Sx ENVIRONMENT
                   1064: above.
1.58      itojun   1065: .El
1.145     markus   1066: .Sh DIAGNOSTICS
                   1067: .Nm
                   1068: exits with the exit status of the remote command or with 255
                   1069: if an error occurred.
1.2       deraadt  1070: .Sh SEE ALSO
1.176     jmc      1071: .Xr gzip 1 ,
1.2       deraadt  1072: .Xr rsh 1 ,
                   1073: .Xr scp 1 ,
1.83      djm      1074: .Xr sftp 1 ,
1.2       deraadt  1075: .Xr ssh-add 1 ,
                   1076: .Xr ssh-agent 1 ,
                   1077: .Xr ssh-keygen 1 ,
                   1078: .Xr telnet 1 ,
1.176     jmc      1079: .Xr hosts.equiv 5 ,
1.159     stevesk  1080: .Xr ssh_config 5 ,
1.160     naddy    1081: .Xr ssh-keysign 8 ,
1.87      itojun   1082: .Xr sshd 8
1.106     markus   1083: .Rs
                   1084: .%A T. Ylonen
                   1085: .%A T. Kivinen
                   1086: .%A M. Saarinen
                   1087: .%A T. Rinne
                   1088: .%A S. Lehtinen
                   1089: .%T "SSH Protocol Architecture"
1.150     markus   1090: .%N draft-ietf-secsh-architecture-12.txt
                   1091: .%D January 2002
1.106     markus   1092: .%O work in progress material
                   1093: .Re
1.173     jmc      1094: .Sh AUTHORS
                   1095: OpenSSH is a derivative of the original and free
                   1096: ssh 1.2.12 release by Tatu Ylonen.
                   1097: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
                   1098: Theo de Raadt and Dug Song
                   1099: removed many bugs, re-added newer features and
                   1100: created OpenSSH.
                   1101: Markus Friedl contributed the support for SSH
                   1102: protocol versions 1.5 and 2.0.