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