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

Annotation of src/usr.bin/ssh/sshd.8, Revision 1.92

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.64      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: .\"
                     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.
                     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.64      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.92    ! deraadt    37: .\" $OpenBSD: sshd.8,v 1.91 2001/02/08 19:22:38 itojun Exp $
1.2       deraadt    38: .Dd September 25, 1999
                     39: .Dt SSHD 8
                     40: .Os
                     41: .Sh NAME
                     42: .Nm sshd
                     43: .Nd secure shell daemon
                     44: .Sh SYNOPSIS
                     45: .Nm sshd
1.85      markus     46: .Op Fl diqD46
1.2       deraadt    47: .Op Fl b Ar bits
                     48: .Op Fl f Ar config_file
                     49: .Op Fl g Ar login_grace_time
                     50: .Op Fl h Ar host_key_file
                     51: .Op Fl k Ar key_gen_time
                     52: .Op Fl p Ar port
1.61      markus     53: .Op Fl u Ar len
1.26      markus     54: .Op Fl V Ar client_protocol_id
1.40      aaron      55: .Sh DESCRIPTION
1.2       deraadt    56: .Nm
1.40      aaron      57: (Secure Shell Daemon) is the daemon program for
1.2       deraadt    58: .Xr ssh 1 .
1.42      hugh       59: Together these programs replace rlogin and rsh, and
1.1       deraadt    60: provide secure encrypted communications between two untrusted hosts
1.36      aaron      61: over an insecure network.
                     62: The programs are intended to be as easy to
1.1       deraadt    63: install and use as possible.
1.2       deraadt    64: .Pp
                     65: .Nm
1.36      aaron      66: is the daemon that listens for connections from clients.
1.40      aaron      67: It is normally started at boot from
1.2       deraadt    68: .Pa /etc/rc .
                     69: It forks a new
1.36      aaron      70: daemon for each incoming connection.
                     71: The forked daemons handle
1.1       deraadt    72: key exchange, encryption, authentication, command execution,
                     73: and data exchange.
1.49      markus     74: This implementation of
                     75: .Nm
                     76: supports both SSH protocol version 1 and 2 simultaneously.
1.2       deraadt    77: .Nm
1.36      aaron      78: works as follows.
1.49      markus     79: .Pp
                     80: .Ss SSH protocol version 1
                     81: .Pp
1.36      aaron      82: Each host has a host-specific RSA key
                     83: (normally 1024 bits) used to identify the host.
                     84: Additionally, when
1.1       deraadt    85: the daemon starts, it generates a server RSA key (normally 768 bits).
                     86: This key is normally regenerated every hour if it has been used, and
                     87: is never stored on disk.
1.2       deraadt    88: .Pp
1.42      hugh       89: Whenever a client connects the daemon responds with its public
                     90: host and server keys.
1.36      aaron      91: The client compares the
1.49      markus     92: RSA host key against its own database to verify that it has not changed.
1.36      aaron      93: The client then generates a 256 bit random number.
                     94: It encrypts this
1.1       deraadt    95: random number using both the host key and the server key, and sends
1.36      aaron      96: the encrypted number to the server.
1.42      hugh       97: Both sides then use this
1.1       deraadt    98: random number as a session key which is used to encrypt all further
1.36      aaron      99: communications in the session.
                    100: The rest of the session is encrypted
1.42      hugh      101: using a conventional cipher, currently Blowfish or 3DES, with 3DES
1.39      deraadt   102: being used by default.
1.36      aaron     103: The client selects the encryption algorithm
1.5       deraadt   104: to use from those offered by the server.
1.2       deraadt   105: .Pp
1.36      aaron     106: Next, the server and the client enter an authentication dialog.
                    107: The client tries to authenticate itself using
1.2       deraadt   108: .Pa .rhosts
                    109: authentication,
                    110: .Pa .rhosts
                    111: authentication combined with RSA host
1.1       deraadt   112: authentication, RSA challenge-response authentication, or password
                    113: based authentication.
1.2       deraadt   114: .Pp
1.1       deraadt   115: Rhosts authentication is normally disabled
                    116: because it is fundamentally insecure, but can be enabled in the server
1.36      aaron     117: configuration file if desired.
                    118: System security is not improved unless
1.2       deraadt   119: .Xr rshd 8 ,
                    120: .Xr rlogind 8 ,
                    121: .Xr rexecd 8 ,
                    122: and
                    123: .Xr rexd 8
1.1       deraadt   124: are disabled (thus completely disabling
1.2       deraadt   125: .Xr rlogin 1
1.1       deraadt   126: and
1.2       deraadt   127: .Xr rsh 1
1.42      hugh      128: into the machine).
1.2       deraadt   129: .Pp
1.49      markus    130: .Ss SSH protocol version 2
                    131: .Pp
1.58      deraadt   132: Version 2 works similarly:
1.49      markus    133: Each host has a host-specific DSA key used to identify the host.
                    134: However, when the daemon starts, it does not generate a server key.
                    135: Forward security is provided through a Diffie-Hellman key agreement.
                    136: This key agreement results in a shared session key.
                    137: The rest of the session is encrypted
                    138: using a symmetric cipher, currently
                    139: Blowfish, 3DES or CAST128 in CBC mode or Arcfour.
                    140: The client selects the encryption algorithm
                    141: to use from those offered by the server.
                    142: Additionally, session integrity is provided
1.51      hugh      143: through a cryptographic message authentication code
1.49      markus    144: (hmac-sha1 or hmac-md5).
                    145: .Pp
                    146: Protocol version 2 provides a public key based
1.72      markus    147: user authentication method (PubkeyAuthentication)
1.49      markus    148: and conventional password authentication.
                    149: .Pp
                    150: .Ss Command execution and data forwarding
                    151: .Pp
1.1       deraadt   152: If the client successfully authenticates itself, a dialog for
1.36      aaron     153: preparing the session is entered.
                    154: At this time the client may request
1.1       deraadt   155: things like allocating a pseudo-tty, forwarding X11 connections,
                    156: forwarding TCP/IP connections, or forwarding the authentication agent
                    157: connection over the secure channel.
1.2       deraadt   158: .Pp
1.1       deraadt   159: Finally, the client either requests a shell or execution of a command.
1.36      aaron     160: The sides then enter session mode.
                    161: In this mode, either side may send
1.1       deraadt   162: data at any time, and such data is forwarded to/from the shell or
                    163: command on the server side, and the user terminal in the client side.
1.2       deraadt   164: .Pp
1.1       deraadt   165: When the user program terminates and all forwarded X11 and other
                    166: connections have been closed, the server sends command exit status to
                    167: the client, and both sides exit.
1.2       deraadt   168: .Pp
                    169: .Nm
1.1       deraadt   170: can be configured using command-line options or a configuration
1.36      aaron     171: file.
                    172: Command-line options override values specified in the
1.1       deraadt   173: configuration file.
1.25      markus    174: .Pp
                    175: .Nm
                    176: rereads its configuration file when it receives a hangup signal,
                    177: .Dv SIGHUP .
1.18      aaron     178: .Pp
                    179: The options are as follows:
1.2       deraadt   180: .Bl -tag -width Ds
                    181: .It Fl b Ar bits
1.1       deraadt   182: Specifies the number of bits in the server key (default 768).
1.2       deraadt   183: .Pp
                    184: .It Fl d
1.36      aaron     185: Debug mode.
                    186: The server sends verbose debug output to the system
                    187: log, and does not put itself in the background.
                    188: The server also will not fork and will only process one connection.
                    189: This option is only intended for debugging for the server.
1.67      aaron     190: Multiple -d options increases the debugging level.
                    191: Maximum is 3.
1.2       deraadt   192: .It Fl f Ar configuration_file
1.36      aaron     193: Specifies the name of the configuration file.
                    194: The default is
1.2       deraadt   195: .Pa /etc/sshd_config .
1.16      markus    196: .Nm
                    197: refuses to start if there is no configuration file.
1.2       deraadt   198: .It Fl g Ar login_grace_time
1.1       deraadt   199: Gives the grace time for clients to authenticate themselves (default
1.77      markus    200: 600 seconds).
1.36      aaron     201: If the client fails to authenticate the user within
                    202: this many seconds, the server disconnects and exits.
                    203: A value of zero indicates no limit.
1.2       deraadt   204: .It Fl h Ar host_key_file
1.75      markus    205: Specifies the file from which the host key is read (default
1.2       deraadt   206: .Pa /etc/ssh_host_key ) .
1.7       markus    207: This option must be given if
                    208: .Nm
                    209: is not run as root (as the normal
1.1       deraadt   210: host file is normally not readable by anyone but root).
1.75      markus    211: It is possible to have multiple host key files for
                    212: the different protocol versions.
1.2       deraadt   213: .It Fl i
1.7       markus    214: Specifies that
                    215: .Nm
1.40      aaron     216: is being run from inetd.
1.7       markus    217: .Nm
                    218: is normally not run
1.1       deraadt   219: from inetd because it needs to generate the server key before it can
1.36      aaron     220: respond to the client, and this may take tens of seconds.
                    221: Clients would have to wait too long if the key was regenerated every time.
1.35      aaron     222: However, with small key sizes (e.g., 512) using
1.7       markus    223: .Nm
                    224: from inetd may
1.1       deraadt   225: be feasible.
1.2       deraadt   226: .It Fl k Ar key_gen_time
1.1       deraadt   227: Specifies how often the server key is regenerated (default 3600
1.36      aaron     228: seconds, or one hour).
                    229: The motivation for regenerating the key fairly
1.1       deraadt   230: often is that the key is not stored anywhere, and after about an hour,
                    231: it becomes impossible to recover the key for decrypting intercepted
                    232: communications even if the machine is cracked into or physically
1.36      aaron     233: seized.
                    234: A value of zero indicates that the key will never be regenerated.
1.2       deraadt   235: .It Fl p Ar port
1.1       deraadt   236: Specifies the port on which the server listens for connections
                    237: (default 22).
1.2       deraadt   238: .It Fl q
1.36      aaron     239: Quiet mode.
                    240: Nothing is sent to the system log.
                    241: Normally the beginning,
1.1       deraadt   242: authentication, and termination of each connection is logged.
1.61      markus    243: .It Fl u Ar len
                    244: This option is used to specify the size of the field
                    245: in the
                    246: .Li utmp
                    247: structure that holds the remote host name.
                    248: If the resolved host name is longer than
                    249: .Ar len ,
                    250: the dotted decimal value will be used instead.
                    251: This allows hosts with very long host names that
                    252: overflow this field to still be uniquely identified.
                    253: Specifying
                    254: .Fl u0
                    255: indicates that only dotted decimal addresses
                    256: should be put into the
                    257: .Pa utmp
                    258: file.
1.74      markus    259: .It Fl D
                    260: When this option is specified
                    261: .Nm
                    262: will not detach and does not become a daemon.
                    263: This allows easy monitoring of
1.76      markus    264: .Nm sshd .
1.26      markus    265: .It Fl V Ar client_protocol_id
1.68      markus    266: SSH-2 compatibility mode.
1.42      hugh      267: When this option is specified
1.26      markus    268: .Nm
1.42      hugh      269: assumes the client has sent the supplied version string
1.26      markus    270: and skips the
                    271: Protocol Version Identification Exchange.
1.68      markus    272: This option is not intended to be called directly.
1.29      markus    273: .It Fl 4
                    274: Forces
                    275: .Nm
                    276: to use IPv4 addresses only.
                    277: .It Fl 6
                    278: Forces
                    279: .Nm
                    280: to use IPv6 addresses only.
1.2       deraadt   281: .El
                    282: .Sh CONFIGURATION FILE
                    283: .Nm
1.40      aaron     284: reads configuration data from
1.2       deraadt   285: .Pa /etc/sshd_config
                    286: (or the file specified with
                    287: .Fl f
1.36      aaron     288: on the command line).
                    289: The file contains keyword-value pairs, one per line.
                    290: Lines starting with
1.2       deraadt   291: .Ql #
1.1       deraadt   292: and empty lines are interpreted as comments.
1.2       deraadt   293: .Pp
1.1       deraadt   294: The following keywords are possible.
1.2       deraadt   295: .Bl -tag -width Ds
                    296: .It Cm AFSTokenPassing
1.36      aaron     297: Specifies whether an AFS token may be forwarded to the server.
                    298: Default is
1.2       deraadt   299: .Dq yes .
1.11      markus    300: .It Cm AllowGroups
1.92    ! deraadt   301: This keyword can be followed by a list of group names, separated
1.36      aaron     302: by spaces.
                    303: If specified, login is allowed only for users whose primary
1.81      markus    304: group or supplementary group list matches one of the patterns.
1.11      markus    305: .Ql \&*
                    306: and
                    307: .Ql ?
                    308: can be used as
1.36      aaron     309: wildcards in the patterns.
1.58      deraadt   310: Only group names are valid; a numerical group ID isn't recognized.
1.81      markus    311: By default login is allowed regardless of the group list.
1.3       dugsong   312: .Pp
1.69      markus    313: .It Cm AllowTcpForwarding
                    314: Specifies whether TCP forwarding is permitted.
                    315: The default is
                    316: .Dq yes .
                    317: Note that disabling TCP forwarding does not improve security unless
                    318: users are also denied shell access, as they can always install their
                    319: own forwarders.
                    320: .Pp
1.11      markus    321: .It Cm AllowUsers
1.92    ! deraadt   322: This keyword can be followed by a list of user names, separated
1.36      aaron     323: by spaces.
                    324: If specified, login is allowed only for users names that
1.11      markus    325: match one of the patterns.
                    326: .Ql \&*
                    327: and
                    328: .Ql ?
                    329: can be used as
1.36      aaron     330: wildcards in the patterns.
1.58      deraadt   331: Only user names are valid; a numerical user ID isn't recognized.
1.36      aaron     332: By default login is allowed regardless of the user name.
1.80      markus    333: .Pp
                    334: .It Cm Banner
                    335: In some jurisdictions, sending a warning message before authentication
                    336: may be relevant for getting legal protection.
                    337: The contents of the specified file are sent to the remote user before
                    338: authentication is allowed.
                    339: This option is only available for protocol version 2.
1.11      markus    340: .Pp
1.41      markus    341: .It Cm Ciphers
                    342: Specifies the ciphers allowed for protocol version 2.
                    343: Multiple ciphers must be comma-separated.
                    344: The default is
1.78      djm       345: .Dq 3des-cbc,blowfish-cbc,cast128-cbc,arcfour,aes128-cbc .
1.8       markus    346: .It Cm CheckMail
                    347: Specifies whether
                    348: .Nm
                    349: should check for new mail for interactive logins.
                    350: The default is
                    351: .Dq no .
1.11      markus    352: .It Cm DenyGroups
                    353: This keyword can be followed by a number of group names, separated
1.36      aaron     354: by spaces.
1.81      markus    355: Users whose primary group or supplementary group list matches
                    356: one of the patterns aren't allowed to log in.
1.11      markus    357: .Ql \&*
                    358: and
                    359: .Ql ?
                    360: can be used as
1.36      aaron     361: wildcards in the patterns.
1.58      deraadt   362: Only group names are valid; a numerical group ID isn't recognized.
1.81      markus    363: By default login is allowed regardless of the group list.
1.11      markus    364: .Pp
                    365: .It Cm DenyUsers
                    366: This keyword can be followed by a number of user names, separated
1.36      aaron     367: by spaces.
                    368: Login is disallowed for user names that match one of the patterns.
1.11      markus    369: .Ql \&*
                    370: and
                    371: .Ql ?
1.36      aaron     372: can be used as wildcards in the patterns.
1.58      deraadt   373: Only user names are valid; a numerical user ID isn't recognized.
1.36      aaron     374: By default login is allowed regardless of the user name.
1.72      markus    375: .It Cm PubkeyAuthentication
                    376: Specifies whether public key authentication is allowed.
1.49      markus    377: The default is
                    378: .Dq yes .
                    379: Note that this option applies to protocol version 2 only.
1.47      markus    380: .It Cm GatewayPorts
                    381: Specifies whether remote hosts are allowed to connect to ports
                    382: forwarded for the client.
                    383: The argument must be
                    384: .Dq yes
                    385: or
                    386: .Dq no .
                    387: The default is
                    388: .Dq no .
1.2       deraadt   389: .It Cm HostKey
1.72      markus    390: Specifies the file containing the private host keys (default
1.46      markus    391: .Pa /etc/ssh_host_key )
1.72      markus    392: used by SSH protocol versions 1 and 2.
1.9       markus    393: Note that
                    394: .Nm
1.83      markus    395: will refuse to use a file if it is group/world-accessible.
1.72      markus    396: It is possible to have multiple host key files.
                    397: .Dq rsa1
                    398: keys are used for version 1 and
                    399: .Dq dsa
                    400: or
                    401: .Dq rsa
                    402: are used for version 2 of the SSH protocol.
1.2       deraadt   403: .It Cm IgnoreRhosts
1.34      markus    404: Specifies that
                    405: .Pa .rhosts
1.40      aaron     406: and
1.34      markus    407: .Pa .shosts
                    408: files will not be used in authentication.
1.2       deraadt   409: .Pa /etc/hosts.equiv
1.1       deraadt   410: and
1.40      aaron     411: .Pa /etc/shosts.equiv
1.36      aaron     412: are still used.
1.40      aaron     413: The default is
1.34      markus    414: .Dq yes .
1.24      markus    415: .It Cm IgnoreUserKnownHosts
                    416: Specifies whether
                    417: .Nm
                    418: should ignore the user's
                    419: .Pa $HOME/.ssh/known_hosts
1.45      markus    420: during
1.24      markus    421: .Cm RhostsRSAAuthentication .
                    422: The default is
1.2       deraadt   423: .Dq no .
                    424: .It Cm KeepAlive
1.1       deraadt   425: Specifies whether the system should send keepalive messages to the
1.36      aaron     426: other side.
                    427: If they are sent, death of the connection or crash of one
                    428: of the machines will be properly noticed.
                    429: However, this means that
1.1       deraadt   430: connections will die if the route is down temporarily, and some people
1.36      aaron     431: find it annoying.
1.51      hugh      432: On the other hand, if keepalives are not sent,
1.2       deraadt   433: sessions may hang indefinitely on the server, leaving
                    434: .Dq ghost
                    435: users and consuming server resources.
                    436: .Pp
                    437: The default is
                    438: .Dq yes
                    439: (to send keepalives), and the server will notice
1.36      aaron     440: if the network goes down or the client host reboots.
                    441: This avoids infinitely hanging sessions.
1.2       deraadt   442: .Pp
                    443: To disable keepalives, the value should be set to
                    444: .Dq no
                    445: in both the server and the client configuration files.
                    446: .It Cm KerberosAuthentication
1.36      aaron     447: Specifies whether Kerberos authentication is allowed.
                    448: This can be in the form of a Kerberos ticket, or if
1.7       markus    449: .Cm PasswordAuthentication
1.1       deraadt   450: is yes, the password provided by the user will be validated through
1.67      aaron     451: the Kerberos KDC.
                    452: To use this option, the server needs a
1.59      provos    453: Kerberos servtab which allows the verification of the KDC's identity.
1.36      aaron     454: Default is
1.60      provos    455: .Dq yes .
1.2       deraadt   456: .It Cm KerberosOrLocalPasswd
1.1       deraadt   457: If set then if password authentication through Kerberos fails then
                    458: the password will be validated via any additional local mechanism
1.2       deraadt   459: such as
1.66      markus    460: .Pa /etc/passwd .
1.36      aaron     461: Default is
1.20      dugsong   462: .Dq yes .
1.2       deraadt   463: .It Cm KerberosTgtPassing
1.1       deraadt   464: Specifies whether a Kerberos TGT may be forwarded to the server.
1.40      aaron     465: Default is
1.3       dugsong   466: .Dq no ,
                    467: as this only works when the Kerberos KDC is actually an AFS kaserver.
1.2       deraadt   468: .It Cm KerberosTicketCleanup
1.7       markus    469: Specifies whether to automatically destroy the user's ticket cache
1.36      aaron     470: file on logout.
                    471: Default is
1.3       dugsong   472: .Dq yes .
1.2       deraadt   473: .It Cm KeyRegenerationInterval
1.1       deraadt   474: The server key is automatically regenerated after this many seconds
1.36      aaron     475: (if it has been used).
                    476: The purpose of regeneration is to prevent
1.1       deraadt   477: decrypting captured sessions by later breaking into the machine and
1.36      aaron     478: stealing the keys.
                    479: The key is never stored anywhere.
                    480: If the value is 0, the key is never regenerated.
                    481: The default is 3600 (seconds).
1.7       markus    482: .It Cm ListenAddress
                    483: Specifies what local address
                    484: .Nm
                    485: should listen on.
                    486: The default is to listen to all local addresses.
1.28      markus    487: Multiple options of this type are permitted.
                    488: Additionally, the
                    489: .Cm Ports
                    490: options must precede this option.
1.2       deraadt   491: .It Cm LoginGraceTime
1.1       deraadt   492: The server disconnects after this time if the user has not
1.36      aaron     493: successfully logged in.
                    494: If the value is 0, there is no time limit.
1.1       deraadt   495: The default is 600 (seconds).
1.23      markus    496: .It Cm LogLevel
                    497: Gives the verbosity level that is used when logging messages from
                    498: .Nm sshd .
                    499: The possible values are:
1.82      markus    500: QUIET, FATAL, ERROR, INFO, VERBOSE and DEBUG.
                    501: The default is INFO.
1.23      markus    502: Logging with level DEBUG violates the privacy of users
                    503: and is not recommended.
1.55      markus    504: .It Cm MaxStartups
                    505: Specifies the maximum number of concurrent unauthenticated connections to the
                    506: .Nm
                    507: daemon.
                    508: Additional connections will be dropped until authentication succeeds or the
                    509: .Cm LoginGraceTime
                    510: expires for a connection.
                    511: The default is 10.
1.57      markus    512: .Pp
                    513: Alternatively, random early drop can be enabled by specifying
                    514: the three colon separated values
                    515: .Dq start:rate:full
1.67      aaron     516: (e.g., "10:30:60").
1.57      markus    517: .Nm
1.86      stevesk   518: will refuse connection attempts with a probability of
1.57      markus    519: .Dq rate/100
                    520: (30%)
                    521: if there are currently
                    522: .Dq start
                    523: (10)
                    524: unauthenticated connections.
1.86      stevesk   525: The probability increases linearly and all connection attempts
1.57      markus    526: are refused if the number of unauthenticated connections reaches
                    527: .Dq full
                    528: (60).
1.2       deraadt   529: .It Cm PasswordAuthentication
1.1       deraadt   530: Specifies whether password authentication is allowed.
1.2       deraadt   531: The default is
                    532: .Dq yes .
1.58      deraadt   533: Note that this option applies to both protocol versions 1 and 2.
1.2       deraadt   534: .It Cm PermitEmptyPasswords
1.1       deraadt   535: When password authentication is allowed, it specifies whether the
1.36      aaron     536: server allows login to accounts with empty password strings.
                    537: The default is
1.34      markus    538: .Dq no .
1.2       deraadt   539: .It Cm PermitRootLogin
1.1       deraadt   540: Specifies whether the root can log in using
1.2       deraadt   541: .Xr ssh 1 .
1.15      markus    542: The argument must be
                    543: .Dq yes ,
                    544: .Dq without-password
                    545: or
                    546: .Dq no .
1.2       deraadt   547: The default is
                    548: .Dq yes .
1.15      markus    549: If this options is set to
                    550: .Dq without-password
                    551: only password authentication is disabled for root.
1.2       deraadt   552: .Pp
                    553: Root login with RSA authentication when the
                    554: .Ar command
                    555: option has been
1.1       deraadt   556: specified will be allowed regardless of the value of this setting
                    557: (which may be useful for taking remote backups even if root login is
                    558: normally not allowed).
1.43      markus    559: .It Cm PidFile
                    560: Specifies the file that contains the process identifier of the
                    561: .Nm
                    562: daemon.
                    563: The default is
                    564: .Pa /var/run/sshd.pid .
1.2       deraadt   565: .It Cm Port
1.1       deraadt   566: Specifies the port number that
1.2       deraadt   567: .Nm
1.36      aaron     568: listens on.
                    569: The default is 22.
1.28      markus    570: Multiple options of this type are permitted.
1.2       deraadt   571: .It Cm PrintMotd
1.1       deraadt   572: Specifies whether
1.2       deraadt   573: .Nm
1.40      aaron     574: should print
1.2       deraadt   575: .Pa /etc/motd
1.36      aaron     576: when a user logs in interactively.
                    577: (On some systems it is also printed by the shell,
1.2       deraadt   578: .Pa /etc/profile ,
1.36      aaron     579: or equivalent.)
                    580: The default is
1.2       deraadt   581: .Dq yes .
1.41      markus    582: .It Cm Protocol
                    583: Specifies the protocol versions
                    584: .Nm
                    585: should support.
                    586: The possible values are
                    587: .Dq 1
                    588: and
                    589: .Dq 2 .
                    590: Multiple versions must be comma-separated.
                    591: The default is
                    592: .Dq 1 .
1.2       deraadt   593: .It Cm RandomSeed
1.36      aaron     594: Obsolete.
                    595: Random number generation uses other techniques.
1.87      markus    596: .It Cm ReverseMappingCheck
                    597: Specifies whether
                    598: .Nm
                    599: should try to verify the remote host name and check that
                    600: the resolved host name for the remote IP address maps back to the
                    601: very same IP address.
                    602: The default is
                    603: .Dq no .
1.2       deraadt   604: .It Cm RhostsAuthentication
1.1       deraadt   605: Specifies whether authentication using rhosts or /etc/hosts.equiv
1.36      aaron     606: files is sufficient.
                    607: Normally, this method should not be permitted because it is insecure.
1.7       markus    608: .Cm RhostsRSAAuthentication
                    609: should be used
1.1       deraadt   610: instead, because it performs RSA-based host authentication in addition
                    611: to normal rhosts or /etc/hosts.equiv authentication.
1.2       deraadt   612: The default is
                    613: .Dq no .
                    614: .It Cm RhostsRSAAuthentication
1.1       deraadt   615: Specifies whether rhosts or /etc/hosts.equiv authentication together
1.36      aaron     616: with successful RSA host authentication is allowed.
                    617: The default is
1.34      markus    618: .Dq no .
1.2       deraadt   619: .It Cm RSAAuthentication
1.36      aaron     620: Specifies whether pure RSA authentication is allowed.
                    621: The default is
1.2       deraadt   622: .Dq yes .
1.49      markus    623: Note that this option applies to protocol version 1 only.
1.2       deraadt   624: .It Cm ServerKeyBits
1.36      aaron     625: Defines the number of bits in the server key.
                    626: The minimum value is 512, and the default is 768.
1.88      markus    627: .It Cm ChallengeResponseAuthentication
1.7       markus    628: Specifies whether
1.88      markus    629: challenge reponse
                    630: authentication is allowed.
                    631: Currently there is only support for
1.40      aaron     632: .Xr skey 1
1.88      markus    633: authentication.
1.36      aaron     634: The default is
1.7       markus    635: .Dq yes .
1.2       deraadt   636: .It Cm StrictModes
1.12      markus    637: Specifies whether
                    638: .Nm
                    639: should check file modes and ownership of the
1.36      aaron     640: user's files and home directory before accepting login.
                    641: This is normally desirable because novices sometimes accidentally leave their
                    642: directory or files world-writable.
                    643: The default is
1.7       markus    644: .Dq yes .
1.54      jakob     645: .It Cm Subsystem
1.67      aaron     646: Configures an external subsystem (e.g., file transfer daemon).
                    647: Arguments should be a subsystem name and a command to execute upon subsystem
                    648: request.
1.63      markus    649: The command
                    650: .Xr sftp-server 8
                    651: implements the
                    652: .Dq sftp
                    653: file transfer subsystem.
1.54      jakob     654: By default no subsystems are defined.
                    655: Note that this option applies to protocol version 2 only.
1.2       deraadt   656: .It Cm SyslogFacility
1.1       deraadt   657: Gives the facility code that is used when logging messages from
1.2       deraadt   658: .Nm sshd .
1.1       deraadt   659: The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
1.36      aaron     660: LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
                    661: The default is AUTH.
1.10      markus    662: .It Cm UseLogin
                    663: Specifies whether
                    664: .Xr login 1
1.53      markus    665: is used for interactive login sessions.
                    666: Note that
                    667: .Xr login 1
1.58      deraadt   668: is never used for remote command execution.
1.36      aaron     669: The default is
1.10      markus    670: .Dq no .
1.6       aaron     671: .It Cm X11DisplayOffset
                    672: Specifies the first display number available for
                    673: .Nm sshd Ns 's
1.36      aaron     674: X11 forwarding.
                    675: This prevents
1.6       aaron     676: .Nm
                    677: from interfering with real X11 servers.
1.34      markus    678: The default is 10.
1.30      markus    679: .It Cm X11Forwarding
1.36      aaron     680: Specifies whether X11 forwarding is permitted.
                    681: The default is
1.34      markus    682: .Dq no .
1.30      markus    683: Note that disabling X11 forwarding does not improve security in any
                    684: way, as users can always install their own forwarders.
1.52      markus    685: .It Cm XAuthLocation
                    686: Specifies the location of the
                    687: .Xr xauth 1
                    688: program.
                    689: The default is
                    690: .Pa /usr/X11R6/bin/xauth .
1.2       deraadt   691: .El
                    692: .Sh LOGIN PROCESS
1.1       deraadt   693: When a user successfully logs in,
1.2       deraadt   694: .Nm
1.1       deraadt   695: does the following:
1.2       deraadt   696: .Bl -enum -offset indent
                    697: .It
1.1       deraadt   698: If the login is on a tty, and no command has been specified,
1.40      aaron     699: prints last login time and
1.2       deraadt   700: .Pa /etc/motd
1.1       deraadt   701: (unless prevented in the configuration file or by
1.2       deraadt   702: .Pa $HOME/.hushlogin ;
                    703: see the
1.40      aaron     704: .Sx FILES
1.2       deraadt   705: section).
                    706: .It
1.1       deraadt   707: If the login is on a tty, records login time.
1.2       deraadt   708: .It
                    709: Checks
                    710: .Pa /etc/nologin ;
                    711: if it exists, prints contents and quits
1.1       deraadt   712: (unless root).
1.2       deraadt   713: .It
1.1       deraadt   714: Changes to run with normal user privileges.
1.2       deraadt   715: .It
1.1       deraadt   716: Sets up basic environment.
1.2       deraadt   717: .It
                    718: Reads
                    719: .Pa $HOME/.ssh/environment
                    720: if it exists.
                    721: .It
1.1       deraadt   722: Changes to user's home directory.
1.2       deraadt   723: .It
                    724: If
                    725: .Pa $HOME/.ssh/rc
                    726: exists, runs it; else if
                    727: .Pa /etc/sshrc
                    728: exists, runs
1.36      aaron     729: it; otherwise runs xauth.
                    730: The
1.2       deraadt   731: .Dq rc
                    732: files are given the X11
1.1       deraadt   733: authentication protocol and cookie in standard input.
1.2       deraadt   734: .It
1.1       deraadt   735: Runs user's shell or command.
1.2       deraadt   736: .El
                    737: .Sh AUTHORIZED_KEYS FILE FORMAT
1.40      aaron     738: The
1.2       deraadt   739: .Pa $HOME/.ssh/authorized_keys
1.1       deraadt   740: file lists the RSA keys that are
1.44      deraadt   741: permitted for RSA authentication in SSH protocols 1.3 and 1.5
1.51      hugh      742: Similarly, the
1.44      deraadt   743: .Pa $HOME/.ssh/authorized_keys2
1.75      markus    744: file lists the DSA and RSA keys that are
                    745: permitted for public key authentication (PubkeyAuthentication)
                    746: in SSH protocol 2.0.
                    747: .Pp
1.36      aaron     748: Each line of the file contains one
1.2       deraadt   749: key (empty lines and lines starting with a
                    750: .Ql #
                    751: are ignored as
1.36      aaron     752: comments).
1.75      markus    753: Each RSA public key consists of the following fields, separated by
1.36      aaron     754: spaces: options, bits, exponent, modulus, comment.
1.75      markus    755: Each protocol version 2 public key consists of:
                    756: options, keytype, base64 encoded key, comment.
                    757: The options fields
                    758: are optional; its presence is determined by whether the line starts
1.1       deraadt   759: with a number or not (the option field never starts with a number).
1.75      markus    760: The bits, exponent, modulus and comment fields give the RSA key for
                    761: protocol version 1; the
1.1       deraadt   762: comment field is not used for anything (but may be convenient for the
                    763: user to identify the key).
1.75      markus    764: For protocol version 2 the keytype is
                    765: .Dq ssh-dss
                    766: or
                    767: .Dq ssh-rsa .
1.2       deraadt   768: .Pp
1.1       deraadt   769: Note that lines in this file are usually several hundred bytes long
1.36      aaron     770: (because of the size of the RSA key modulus).
                    771: You don't want to type them in; instead, copy the
1.2       deraadt   772: .Pa identity.pub
1.75      markus    773: or the
                    774: .Pa id_dsa.pub
1.1       deraadt   775: file and edit it.
1.2       deraadt   776: .Pp
1.58      deraadt   777: The options (if present) consist of comma-separated option
1.36      aaron     778: specifications.
                    779: No spaces are permitted, except within double quotes.
1.1       deraadt   780: The following option specifications are supported:
1.2       deraadt   781: .Bl -tag -width Ds
                    782: .It Cm from="pattern-list"
1.1       deraadt   783: Specifies that in addition to RSA authentication, the canonical name
                    784: of the remote host must be present in the comma-separated list of
1.36      aaron     785: patterns
                    786: .Pf ( Ql *
                    787: and
                    788: .Ql ?
                    789: serve as wildcards).
                    790: The list may also contain
                    791: patterns negated by prefixing them with
                    792: .Ql ! ;
                    793: if the canonical host name matches a negated pattern, the key is not accepted.
                    794: The purpose
1.1       deraadt   795: of this option is to optionally increase security: RSA authentication
                    796: by itself does not trust the network or name servers or anything (but
                    797: the key); however, if somebody somehow steals the key, the key
1.36      aaron     798: permits an intruder to log in from anywhere in the world.
                    799: This additional option makes using a stolen key more difficult (name
1.1       deraadt   800: servers and/or routers would have to be compromised in addition to
                    801: just the key).
1.2       deraadt   802: .It Cm command="command"
1.1       deraadt   803: Specifies that the command is executed whenever this key is used for
1.36      aaron     804: authentication.
                    805: The command supplied by the user (if any) is ignored.
1.1       deraadt   806: The command is run on a pty if the connection requests a pty;
1.36      aaron     807: otherwise it is run without a tty.
1.89      markus    808: Note that if you want a 8-bit clean channel,
                    809: you must not request a pty or should specify
                    810: .Cm no-pty .
1.36      aaron     811: A quote may be included in the command by quoting it with a backslash.
                    812: This option might be useful
                    813: to restrict certain RSA keys to perform just a specific operation.
                    814: An example might be a key that permits remote backups but nothing else.
1.51      hugh      815: Note that the client may specify TCP/IP and/or X11
                    816: forwarding unless they are explicitly prohibited.
1.2       deraadt   817: .It Cm environment="NAME=value"
1.1       deraadt   818: Specifies that the string is to be added to the environment when
1.36      aaron     819: logging in using this key.
                    820: Environment variables set this way
                    821: override other default environment values.
                    822: Multiple options of this type are permitted.
1.2       deraadt   823: .It Cm no-port-forwarding
1.1       deraadt   824: Forbids TCP/IP forwarding when this key is used for authentication.
1.36      aaron     825: Any port forward requests by the client will return an error.
                    826: This might be used, e.g., in connection with the
1.2       deraadt   827: .Cm command
1.1       deraadt   828: option.
1.2       deraadt   829: .It Cm no-X11-forwarding
1.1       deraadt   830: Forbids X11 forwarding when this key is used for authentication.
                    831: Any X11 forward requests by the client will return an error.
1.2       deraadt   832: .It Cm no-agent-forwarding
1.1       deraadt   833: Forbids authentication agent forwarding when this key is used for
                    834: authentication.
1.2       deraadt   835: .It Cm no-pty
1.1       deraadt   836: Prevents tty allocation (a request to allocate a pty will fail).
1.2       deraadt   837: .El
                    838: .Ss Examples
1.1       deraadt   839: 1024 33 12121.\|.\|.\|312314325 ylo@foo.bar
1.2       deraadt   840: .Pp
1.1       deraadt   841: from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23.\|.\|.\|2334 ylo@niksula
1.2       deraadt   842: .Pp
1.1       deraadt   843: command="dump /home",no-pty,no-port-forwarding 1024 33 23.\|.\|.\|2323 backup.hut.fi
1.2       deraadt   844: .Sh SSH_KNOWN_HOSTS FILE FORMAT
1.40      aaron     845: The
1.44      deraadt   846: .Pa /etc/ssh_known_hosts ,
                    847: .Pa /etc/ssh_known_hosts2 ,
                    848: .Pa $HOME/.ssh/known_hosts ,
1.40      aaron     849: and
1.44      deraadt   850: .Pa $HOME/.ssh/known_hosts2
1.36      aaron     851: files contain host public keys for all known hosts.
                    852: The global file should
1.37      brad      853: be prepared by the administrator (optional), and the per-user file is
1.58      deraadt   854: maintained automatically: whenever the user connects from an unknown host
1.36      aaron     855: its key is added to the per-user file.
1.2       deraadt   856: .Pp
1.1       deraadt   857: Each line in these files contains the following fields: hostnames,
1.36      aaron     858: bits, exponent, modulus, comment.
                    859: The fields are separated by spaces.
1.2       deraadt   860: .Pp
1.1       deraadt   861: Hostnames is a comma-separated list of patterns ('*' and '?' act as
                    862: wildcards); each pattern in turn is matched against the canonical host
                    863: name (when authenticating a client) or against the user-supplied
1.36      aaron     864: name (when authenticating a server).
                    865: A pattern may also be preceded by
1.2       deraadt   866: .Ql !
                    867: to indicate negation: if the host name matches a negated
1.1       deraadt   868: pattern, it is not accepted (by that line) even if it matched another
                    869: pattern on the line.
1.2       deraadt   870: .Pp
1.49      markus    871: Bits, exponent, and modulus are taken directly from the RSA host key; they
1.2       deraadt   872: can be obtained, e.g., from
                    873: .Pa /etc/ssh_host_key.pub .
1.1       deraadt   874: The optional comment field continues to the end of the line, and is not used.
1.2       deraadt   875: .Pp
                    876: Lines starting with
                    877: .Ql #
                    878: and empty lines are ignored as comments.
                    879: .Pp
1.1       deraadt   880: When performing host authentication, authentication is accepted if any
1.36      aaron     881: matching line has the proper key.
                    882: It is thus permissible (but not
1.1       deraadt   883: recommended) to have several lines or different host keys for the same
1.36      aaron     884: names.
                    885: This will inevitably happen when short forms of host names
                    886: from different domains are put in the file.
                    887: It is possible
1.1       deraadt   888: that the files contain conflicting information; authentication is
                    889: accepted if valid information can be found from either file.
1.2       deraadt   890: .Pp
1.1       deraadt   891: Note that the lines in these files are typically hundreds of characters
                    892: long, and you definitely don't want to type in the host keys by hand.
1.6       aaron     893: Rather, generate them by a script
1.40      aaron     894: or by taking
1.2       deraadt   895: .Pa /etc/ssh_host_key.pub
1.1       deraadt   896: and adding the host names at the front.
1.2       deraadt   897: .Ss Examples
1.1       deraadt   898: closenet,closenet.hut.fi,.\|.\|.\|,130.233.208.41 1024 37 159.\|.\|.93 closenet.hut.fi
1.2       deraadt   899: .Sh FILES
                    900: .Bl -tag -width Ds
                    901: .It Pa /etc/sshd_config
1.1       deraadt   902: Contains configuration data for
1.2       deraadt   903: .Nm sshd .
1.1       deraadt   904: This file should be writable by root only, but it is recommended
                    905: (though not necessary) that it be world-readable.
1.2       deraadt   906: .It Pa /etc/ssh_host_key
1.7       markus    907: Contains the private part of the host key.
1.1       deraadt   908: This file should only be owned by root, readable only by root, and not
                    909: accessible to others.
1.14      markus    910: Note that
                    911: .Nm
                    912: does not start if this file is group/world-accessible.
1.2       deraadt   913: .It Pa /etc/ssh_host_key.pub
1.7       markus    914: Contains the public part of the host key.
                    915: This file should be world-readable but writable only by
1.36      aaron     916: root.
                    917: Its contents should match the private part.
                    918: This file is not
1.1       deraadt   919: really used for anything; it is only provided for the convenience of
                    920: the user so its contents can be copied to known hosts files.
1.7       markus    921: These two files are created using
                    922: .Xr ssh-keygen 1 .
1.73      provos    923: .It Pa /etc/primes
                    924: Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
1.2       deraadt   925: .It Pa /var/run/sshd.pid
                    926: Contains the process ID of the
                    927: .Nm
1.1       deraadt   928: listening for connections (if there are several daemons running
                    929: concurrently for different ports, this contains the pid of the one
1.36      aaron     930: started last).
1.58      deraadt   931: The content of this file is not sensitive; it can be world-readable.
1.2       deraadt   932: .It Pa $HOME/.ssh/authorized_keys
1.1       deraadt   933: Lists the RSA keys that can be used to log into the user's account.
                    934: This file must be readable by root (which may on some machines imply
                    935: it being world-readable if the user's home directory resides on an NFS
1.36      aaron     936: volume).
                    937: It is recommended that it not be accessible by others.
                    938: The format of this file is described above.
1.44      deraadt   939: Users will place the contents of their
                    940: .Pa identity.pub
                    941: files into this file, as described in
                    942: .Xr ssh-keygen 1 .
                    943: .It Pa $HOME/.ssh/authorized_keys2
                    944: Lists the DSA keys that can be used to log into the user's account.
                    945: This file must be readable by root (which may on some machines imply
                    946: it being world-readable if the user's home directory resides on an NFS
                    947: volume).
                    948: It is recommended that it not be accessible by others.
                    949: The format of this file is described above.
                    950: Users will place the contents of their
                    951: .Pa id_dsa.pub
                    952: files into this file, as described in
                    953: .Xr ssh-keygen 1 .
1.22      markus    954: .It Pa "/etc/ssh_known_hosts" and "$HOME/.ssh/known_hosts"
                    955: These files are consulted when using rhosts with RSA host
1.36      aaron     956: authentication to check the public key of the host.
                    957: The key must be listed in one of these files to be accepted.
1.22      markus    958: The client uses the same files
1.58      deraadt   959: to verify that the remote host is the one it intended to connect.
1.36      aaron     960: These files should be writable only by root/the owner.
1.2       deraadt   961: .Pa /etc/ssh_known_hosts
                    962: should be world-readable, and
                    963: .Pa $HOME/.ssh/known_hosts
                    964: can but need not be world-readable.
1.6       aaron     965: .It Pa /etc/nologin
1.40      aaron     966: If this file exists,
1.2       deraadt   967: .Nm
1.36      aaron     968: refuses to let anyone except root log in.
                    969: The contents of the file
1.1       deraadt   970: are displayed to anyone trying to log in, and non-root connections are
1.36      aaron     971: refused.
                    972: The file should be world-readable.
1.19      dugsong   973: .It Pa /etc/hosts.allow, /etc/hosts.deny
                    974: If compiled with
                    975: .Sy LIBWRAP
                    976: support, tcp-wrappers access controls may be defined here as described in
                    977: .Xr hosts_access 5 .
1.6       aaron     978: .It Pa $HOME/.rhosts
1.1       deraadt   979: This file contains host-username pairs, separated by a space, one per
1.36      aaron     980: line.
                    981: The given user on the corresponding host is permitted to log in
                    982: without password.
                    983: The same file is used by rlogind and rshd.
1.6       aaron     984: The file must
1.1       deraadt   985: be writable only by the user; it is recommended that it not be
                    986: accessible by others.
1.2       deraadt   987: .Pp
1.36      aaron     988: If is also possible to use netgroups in the file.
                    989: Either host or user
1.1       deraadt   990: name may be of the form +@groupname to specify all hosts or all users
                    991: in the group.
1.2       deraadt   992: .It Pa $HOME/.shosts
                    993: For ssh,
                    994: this file is exactly the same as for
                    995: .Pa .rhosts .
                    996: However, this file is
                    997: not used by rlogin and rshd, so using this permits access using SSH only.
1.58      deraadt   998: .It Pa /etc/hosts.equiv
1.2       deraadt   999: This file is used during
                   1000: .Pa .rhosts
1.36      aaron    1001: authentication.
                   1002: In the simplest form, this file contains host names, one per line.
                   1003: Users on
1.1       deraadt  1004: those hosts are permitted to log in without a password, provided they
1.36      aaron    1005: have the same user name on both machines.
                   1006: The host name may also be
1.1       deraadt  1007: followed by a user name; such users are permitted to log in as
1.2       deraadt  1008: .Em any
1.36      aaron    1009: user on this machine (except root).
                   1010: Additionally, the syntax
1.2       deraadt  1011: .Dq +@group
1.36      aaron    1012: can be used to specify netgroups.
                   1013: Negated entries start with
1.2       deraadt  1014: .Ql \&- .
                   1015: .Pp
1.1       deraadt  1016: If the client host/user is successfully matched in this file, login is
                   1017: automatically permitted provided the client and server user names are the
1.36      aaron    1018: same.
                   1019: Additionally, successful RSA host authentication is normally required.
                   1020: This file must be writable only by root; it is recommended
1.1       deraadt  1021: that it be world-readable.
1.2       deraadt  1022: .Pp
1.6       aaron    1023: .Sy "Warning: It is almost never a good idea to use user names in"
1.2       deraadt  1024: .Pa hosts.equiv .
1.1       deraadt  1025: Beware that it really means that the named user(s) can log in as
1.2       deraadt  1026: .Em anybody ,
1.1       deraadt  1027: which includes bin, daemon, adm, and other accounts that own critical
1.36      aaron    1028: binaries and directories.
                   1029: Using a user name practically grants the user root access.
                   1030: The only valid use for user names that I can think
1.1       deraadt  1031: of is in negative entries.
1.2       deraadt  1032: .Pp
                   1033: Note that this warning also applies to rsh/rlogin.
                   1034: .It Pa /etc/shosts.equiv
1.1       deraadt  1035: This is processed exactly as
1.2       deraadt  1036: .Pa /etc/hosts.equiv .
1.1       deraadt  1037: However, this file may be useful in environments that want to run both
1.2       deraadt  1038: rsh/rlogin and ssh.
1.6       aaron    1039: .It Pa $HOME/.ssh/environment
1.36      aaron    1040: This file is read into the environment at login (if it exists).
                   1041: It can only contain empty lines, comment lines (that start with
1.2       deraadt  1042: .Ql # ) ,
1.36      aaron    1043: and assignment lines of the form name=value.
                   1044: The file should be writable
1.6       aaron    1045: only by the user; it need not be readable by anyone else.
1.2       deraadt  1046: .It Pa $HOME/.ssh/rc
1.1       deraadt  1047: If this file exists, it is run with /bin/sh after reading the
1.36      aaron    1048: environment files but before starting the user's shell or command.
                   1049: If X11 spoofing is in use, this will receive the "proto cookie" pair in
1.2       deraadt  1050: standard input (and
                   1051: .Ev DISPLAY
1.36      aaron    1052: in environment).
                   1053: This must call
1.2       deraadt  1054: .Xr xauth 1
                   1055: in that case.
                   1056: .Pp
1.1       deraadt  1057: The primary purpose of this file is to run any initialization routines
                   1058: which may be needed before the user's home directory becomes
                   1059: accessible; AFS is a particular example of such an environment.
1.2       deraadt  1060: .Pp
1.1       deraadt  1061: This file will probably contain some initialization code followed by
                   1062: something similar to: "if read proto cookie; then echo add $DISPLAY
                   1063: $proto $cookie | xauth -q -; fi".
1.2       deraadt  1064: .Pp
                   1065: If this file does not exist,
                   1066: .Pa /etc/sshrc
                   1067: is run, and if that
1.1       deraadt  1068: does not exist either, xauth is used to store the cookie.
1.2       deraadt  1069: .Pp
1.1       deraadt  1070: This file should be writable only by the user, and need not be
                   1071: readable by anyone else.
1.2       deraadt  1072: .It Pa /etc/sshrc
                   1073: Like
                   1074: .Pa $HOME/.ssh/rc .
                   1075: This can be used to specify
1.36      aaron    1076: machine-specific login-time initializations globally.
                   1077: This file should be writable only by root, and should be world-readable.
1.56      aaron    1078: .El
1.71      aaron    1079: .Sh AUTHORS
1.84      markus   1080: OpenSSH is a derivative of the original and free
                   1081: ssh 1.2.12 release by Tatu Ylonen.
                   1082: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
                   1083: Theo de Raadt and Dug Song
                   1084: removed many bugs, re-added newer features and
                   1085: created OpenSSH.
                   1086: Markus Friedl contributed the support for SSH
                   1087: protocol versions 1.5 and 2.0.
1.2       deraadt  1088: .Sh SEE ALSO
                   1089: .Xr scp 1 ,
1.90      djm      1090: .Xr sftp 1 ,
1.63      markus   1091: .Xr sftp-server 8 ,
1.2       deraadt  1092: .Xr ssh 1 ,
1.5       deraadt  1093: .Xr ssh-add 1 ,
1.2       deraadt  1094: .Xr ssh-agent 1 ,
1.5       deraadt  1095: .Xr ssh-keygen 1 ,
1.38      deraadt  1096: .Xr rlogin 1 ,
                   1097: .Xr rsh 1