Annotation of src/usr.bin/ssh/sshd.8, Revision 1.220
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: .\"
1.99 deraadt 13: .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
14: .\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
15: .\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
1.64 deraadt 16: .\"
17: .\" Redistribution and use in source and binary forms, with or without
18: .\" modification, are permitted provided that the following conditions
19: .\" are met:
20: .\" 1. Redistributions of source code must retain the above copyright
21: .\" notice, this list of conditions and the following disclaimer.
22: .\" 2. Redistributions in binary form must reproduce the above copyright
23: .\" notice, this list of conditions and the following disclaimer in the
24: .\" documentation and/or other materials provided with the distribution.
1.1 deraadt 25: .\"
1.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.220 ! jmc 37: .\" $OpenBSD: sshd.8,v 1.219 2006/02/13 10:16:39 jmc Exp $
1.2 deraadt 38: .Dd September 25, 1999
39: .Dt SSHD 8
40: .Os
41: .Sh NAME
42: .Nm sshd
1.120 markus 43: .Nd OpenSSH SSH daemon
1.2 deraadt 44: .Sh SYNOPSIS
45: .Nm sshd
1.194 jmc 46: .Bk -words
1.200 jmc 47: .Op Fl 46Ddeiqt
1.2 deraadt 48: .Op Fl b Ar bits
49: .Op Fl f Ar config_file
50: .Op Fl g Ar login_grace_time
51: .Op Fl h Ar host_key_file
52: .Op Fl k Ar key_gen_time
1.156 markus 53: .Op Fl o Ar option
1.2 deraadt 54: .Op Fl p Ar port
1.61 markus 55: .Op Fl u Ar len
1.194 jmc 56: .Ek
1.40 aaron 57: .Sh DESCRIPTION
1.2 deraadt 58: .Nm
1.212 jmc 59: (OpenSSH Daemon) is the daemon program for
1.2 deraadt 60: .Xr ssh 1 .
1.42 hugh 61: Together these programs replace rlogin and rsh, and
1.1 deraadt 62: provide secure encrypted communications between two untrusted hosts
1.36 aaron 63: over an insecure network.
1.2 deraadt 64: .Pp
65: .Nm
1.212 jmc 66: 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.2 deraadt 74: .Pp
75: .Nm
1.200 jmc 76: can be configured using command-line options or a configuration file
77: (by default
1.212 jmc 78: .Xr sshd_config 5 ) ;
79: command-line options override values specified in the
1.1 deraadt 80: configuration file.
1.25 markus 81: .Nm
82: rereads its configuration file when it receives a hangup signal,
1.97 deraadt 83: .Dv SIGHUP ,
1.201 dtucker 84: by executing itself with the name and options it was started with, e.g.,
1.97 deraadt 85: .Pa /usr/sbin/sshd .
1.18 aaron 86: .Pp
87: The options are as follows:
1.2 deraadt 88: .Bl -tag -width Ds
1.200 jmc 89: .It Fl 4
90: Forces
91: .Nm
92: to use IPv4 addresses only.
93: .It Fl 6
94: Forces
95: .Nm
96: to use IPv6 addresses only.
1.2 deraadt 97: .It Fl b Ar bits
1.120 markus 98: Specifies the number of bits in the ephemeral protocol version 1
99: server key (default 768).
1.200 jmc 100: .It Fl D
101: When this option is specified,
102: .Nm
103: will not detach and does not become a daemon.
104: This allows easy monitoring of
105: .Nm sshd .
1.2 deraadt 106: .It Fl d
1.36 aaron 107: Debug mode.
108: The server sends verbose debug output to the system
109: log, and does not put itself in the background.
110: The server also will not fork and will only process one connection.
111: This option is only intended for debugging for the server.
1.194 jmc 112: Multiple
113: .Fl d
114: options increase the debugging level.
1.67 aaron 115: Maximum is 3.
1.120 markus 116: .It Fl e
117: When this option is specified,
118: .Nm
119: will send the output to the standard error instead of the system log.
1.2 deraadt 120: .It Fl f Ar configuration_file
1.36 aaron 121: Specifies the name of the configuration file.
122: The default is
1.167 deraadt 123: .Pa /etc/ssh/sshd_config .
1.16 markus 124: .Nm
125: refuses to start if there is no configuration file.
1.2 deraadt 126: .It Fl g Ar login_grace_time
1.1 deraadt 127: Gives the grace time for clients to authenticate themselves (default
1.191 stevesk 128: 120 seconds).
1.36 aaron 129: If the client fails to authenticate the user within
130: this many seconds, the server disconnects and exits.
131: A value of zero indicates no limit.
1.2 deraadt 132: .It Fl h Ar host_key_file
1.160 stevesk 133: Specifies a file from which a host key is read.
1.7 markus 134: This option must be given if
135: .Nm
136: is not run as root (as the normal
1.160 stevesk 137: host key files are normally not readable by anyone but root).
138: The default is
1.167 deraadt 139: .Pa /etc/ssh/ssh_host_key
1.160 stevesk 140: for protocol version 1, and
1.167 deraadt 141: .Pa /etc/ssh/ssh_host_rsa_key
1.160 stevesk 142: and
1.167 deraadt 143: .Pa /etc/ssh/ssh_host_dsa_key
1.160 stevesk 144: for protocol version 2.
1.75 markus 145: It is possible to have multiple host key files for
1.120 markus 146: the different protocol versions and host key algorithms.
1.2 deraadt 147: .It Fl i
1.7 markus 148: Specifies that
149: .Nm
1.194 jmc 150: is being run from
151: .Xr inetd 8 .
1.7 markus 152: .Nm
153: is normally not run
1.1 deraadt 154: from inetd because it needs to generate the server key before it can
1.36 aaron 155: respond to the client, and this may take tens of seconds.
156: Clients would have to wait too long if the key was regenerated every time.
1.35 aaron 157: However, with small key sizes (e.g., 512) using
1.7 markus 158: .Nm
159: from inetd may
1.1 deraadt 160: be feasible.
1.2 deraadt 161: .It Fl k Ar key_gen_time
1.120 markus 162: Specifies how often the ephemeral protocol version 1 server key is
163: regenerated (default 3600 seconds, or one hour).
1.36 aaron 164: The motivation for regenerating the key fairly
1.200 jmc 165: often is that the key is not stored anywhere, and after about an hour
1.1 deraadt 166: it becomes impossible to recover the key for decrypting intercepted
167: communications even if the machine is cracked into or physically
1.36 aaron 168: seized.
169: A value of zero indicates that the key will never be regenerated.
1.156 markus 170: .It Fl o Ar option
171: Can be used to give options in the format used in the configuration file.
172: This is useful for specifying options for which there is no separate
173: command-line flag.
1.200 jmc 174: For full details of the options, and their values, see
175: .Xr sshd_config 5 .
1.2 deraadt 176: .It Fl p Ar port
1.1 deraadt 177: Specifies the port on which the server listens for connections
178: (default 22).
1.158 stevesk 179: Multiple port options are permitted.
1.210 stevesk 180: Ports specified in the configuration file with the
181: .Cm Port
182: option are ignored when a command-line port is specified.
183: Ports specified using the
184: .Cm ListenAddress
185: option override command-line ports.
1.2 deraadt 186: .It Fl q
1.36 aaron 187: Quiet mode.
188: Nothing is sent to the system log.
189: Normally the beginning,
1.1 deraadt 190: authentication, and termination of each connection is logged.
1.137 stevesk 191: .It Fl t
192: Test mode.
193: Only check the validity of the configuration file and sanity of the keys.
1.157 deraadt 194: This is useful for updating
1.137 stevesk 195: .Nm
196: reliably as configuration options may change.
1.61 markus 197: .It Fl u Ar len
198: This option is used to specify the size of the field
199: in the
200: .Li utmp
201: structure that holds the remote host name.
202: If the resolved host name is longer than
203: .Ar len ,
204: the dotted decimal value will be used instead.
205: This allows hosts with very long host names that
206: overflow this field to still be uniquely identified.
207: Specifying
208: .Fl u0
209: indicates that only dotted decimal addresses
210: should be put into the
211: .Pa utmp
212: file.
1.144 stevesk 213: .Fl u0
1.194 jmc 214: may also be used to prevent
1.144 stevesk 215: .Nm
216: from making DNS requests unless the authentication
217: mechanism or configuration requires it.
218: Authentication mechanisms that may require DNS include
219: .Cm RhostsRSAAuthentication ,
1.215 jmc 220: .Cm HostbasedAuthentication ,
1.144 stevesk 221: and using a
222: .Cm from="pattern-list"
223: option in a key file.
1.170 stevesk 224: Configuration options that require DNS include using a
225: USER@HOST pattern in
226: .Cm AllowUsers
227: or
228: .Cm DenyUsers .
1.2 deraadt 229: .El
1.214 jmc 230: .Sh AUTHENTICATION
231: The OpenSSH SSH daemon supports SSH protocols 1 and 2.
232: Both protocols are supported by default,
233: though this can be changed via the
234: .Cm Protocol
235: option in
236: .Xr sshd_config 5 .
237: Protocol 2 supports both RSA and DSA keys;
238: protocol 1 only supports RSA keys.
239: For both protocols,
240: each host has a host-specific key,
241: normally 2048 bits,
242: used to identify the host.
243: .Pp
244: Forward security for protocol 1 is provided through
245: an additional server key,
246: normally 768 bits,
247: generated when the server starts.
1.212 jmc 248: This key is normally regenerated every hour if it has been used, and
249: is never stored on disk.
250: Whenever a client connects, the daemon responds with its public
251: host and server keys.
252: The client compares the
253: RSA host key against its own database to verify that it has not changed.
254: The client then generates a 256-bit random number.
255: It encrypts this
256: random number using both the host key and the server key, and sends
257: the encrypted number to the server.
258: Both sides then use this
259: random number as a session key which is used to encrypt all further
260: communications in the session.
261: The rest of the session is encrypted
262: using a conventional cipher, currently Blowfish or 3DES, with 3DES
263: being used by default.
264: The client selects the encryption algorithm
265: to use from those offered by the server.
266: .Pp
1.214 jmc 267: For protocol 2,
268: forward security is provided through a Diffie-Hellman key agreement.
269: This key agreement results in a shared session key.
270: The rest of the session is encrypted using a symmetric cipher, currently
271: 128-bit AES, Blowfish, 3DES, CAST128, Arcfour, 192-bit AES, or 256-bit AES.
272: The client selects the encryption algorithm
273: to use from those offered by the server.
274: Additionally, session integrity is provided
275: through a cryptographic message authentication code
276: (hmac-sha1 or hmac-md5).
277: .Pp
278: Finally, the server and the client enter an authentication dialog.
1.212 jmc 279: The client tries to authenticate itself using
1.214 jmc 280: host-based authentication,
281: public key authentication,
282: challenge-response authentication,
283: or password authentication.
1.212 jmc 284: .Pp
285: If the client successfully authenticates itself, a dialog for
286: preparing the session is entered.
287: At this time the client may request
288: things like allocating a pseudo-tty, forwarding X11 connections,
289: forwarding TCP connections, or forwarding the authentication agent
290: connection over the secure channel.
291: .Pp
1.216 jmc 292: After this, the client either requests a shell or execution of a command.
1.212 jmc 293: The sides then enter session mode.
294: In this mode, either side may send
295: data at any time, and such data is forwarded to/from the shell or
296: command on the server side, and the user terminal in the client side.
297: .Pp
298: When the user program terminates and all forwarded X11 and other
299: connections have been closed, the server sends command exit status to
300: the client, and both sides exit.
1.2 deraadt 301: .Sh LOGIN PROCESS
1.1 deraadt 302: When a user successfully logs in,
1.2 deraadt 303: .Nm
1.1 deraadt 304: does the following:
1.2 deraadt 305: .Bl -enum -offset indent
306: .It
1.1 deraadt 307: If the login is on a tty, and no command has been specified,
1.40 aaron 308: prints last login time and
1.2 deraadt 309: .Pa /etc/motd
1.1 deraadt 310: (unless prevented in the configuration file or by
1.207 djm 311: .Pa ~/.hushlogin ;
1.2 deraadt 312: see the
1.40 aaron 313: .Sx FILES
1.2 deraadt 314: section).
315: .It
1.1 deraadt 316: If the login is on a tty, records login time.
1.2 deraadt 317: .It
318: Checks
319: .Pa /etc/nologin ;
320: if it exists, prints contents and quits
1.1 deraadt 321: (unless root).
1.2 deraadt 322: .It
1.1 deraadt 323: Changes to run with normal user privileges.
1.2 deraadt 324: .It
1.1 deraadt 325: Sets up basic environment.
1.2 deraadt 326: .It
1.200 jmc 327: Reads the file
1.207 djm 328: .Pa ~/.ssh/environment ,
1.200 jmc 329: if it exists, and users are allowed to change their environment.
1.188 stevesk 330: See the
1.187 marc 331: .Cm PermitUserEnvironment
1.188 stevesk 332: option in
1.187 marc 333: .Xr sshd_config 5 .
1.2 deraadt 334: .It
1.1 deraadt 335: Changes to user's home directory.
1.2 deraadt 336: .It
337: If
1.207 djm 338: .Pa ~/.ssh/rc
1.2 deraadt 339: exists, runs it; else if
1.168 deraadt 340: .Pa /etc/ssh/sshrc
1.2 deraadt 341: exists, runs
1.36 aaron 342: it; otherwise runs xauth.
343: The
1.2 deraadt 344: .Dq rc
345: files are given the X11
1.1 deraadt 346: authentication protocol and cookie in standard input.
1.2 deraadt 347: .It
1.1 deraadt 348: Runs user's shell or command.
1.2 deraadt 349: .El
350: .Sh AUTHORIZED_KEYS FILE FORMAT
1.125 markus 351: .Cm AuthorizedKeysFile
1.217 jmc 352: specifies the file containing public keys for
353: public key authentication;
354: if none is specified, the default is
355: .Pa ~/.ssh/authorized_keys .
1.36 aaron 356: Each line of the file contains one
1.2 deraadt 357: key (empty lines and lines starting with a
358: .Ql #
359: are ignored as
1.36 aaron 360: comments).
1.217 jmc 361: Protocol 1 public keys consist of the following space-separated fields:
362: options, bits, exponent, modulus, comment.
363: Protocol 2 public key consist of:
364: options, keytype, base64-encoded key, comment.
365: The options field is optional;
366: its presence is determined by whether the line starts
1.189 espie 367: with a number or not (the options field never starts with a number).
1.217 jmc 368: The bits, exponent, modulus, and comment fields give the RSA key for
1.75 markus 369: protocol version 1; the
1.1 deraadt 370: comment field is not used for anything (but may be convenient for the
371: user to identify the key).
1.75 markus 372: For protocol version 2 the keytype is
373: .Dq ssh-dss
374: or
375: .Dq ssh-rsa .
1.2 deraadt 376: .Pp
1.1 deraadt 377: Note that lines in this file are usually several hundred bytes long
1.203 dtucker 378: (because of the size of the public key encoding) up to a limit of
379: 8 kilobytes, which permits DSA keys up to 8 kilobits and RSA
380: keys up to 16 kilobits.
1.36 aaron 381: You don't want to type them in; instead, copy the
1.113 itojun 382: .Pa identity.pub ,
1.217 jmc 383: .Pa id_dsa.pub ,
1.75 markus 384: or the
1.113 itojun 385: .Pa id_rsa.pub
1.1 deraadt 386: file and edit it.
1.175 stevesk 387: .Pp
388: .Nm
389: enforces a minimum RSA key modulus size for protocol 1
390: and protocol 2 keys of 768 bits.
1.2 deraadt 391: .Pp
1.58 deraadt 392: The options (if present) consist of comma-separated option
1.36 aaron 393: specifications.
394: No spaces are permitted, except within double quotes.
1.141 stevesk 395: The following option specifications are supported (note
396: that option keywords are case-insensitive):
1.2 deraadt 397: .Bl -tag -width Ds
398: .It Cm command="command"
1.1 deraadt 399: Specifies that the command is executed whenever this key is used for
1.36 aaron 400: authentication.
401: The command supplied by the user (if any) is ignored.
1.148 markus 402: The command is run on a pty if the client requests a pty;
1.36 aaron 403: otherwise it is run without a tty.
1.194 jmc 404: If an 8-bit clean channel is required,
1.147 deraadt 405: one must not request a pty or should specify
1.89 markus 406: .Cm no-pty .
1.36 aaron 407: A quote may be included in the command by quoting it with a backslash.
408: This option might be useful
1.189 espie 409: to restrict certain public keys to perform just a specific operation.
1.36 aaron 410: An example might be a key that permits remote backups but nothing else.
1.211 jmc 411: Note that the client may specify TCP and/or X11
1.51 hugh 412: forwarding unless they are explicitly prohibited.
1.149 markus 413: Note that this option applies to shell, command or subsystem execution.
1.2 deraadt 414: .It Cm environment="NAME=value"
1.1 deraadt 415: Specifies that the string is to be added to the environment when
1.36 aaron 416: logging in using this key.
417: Environment variables set this way
418: override other default environment values.
419: Multiple options of this type are permitted.
1.188 stevesk 420: Environment processing is disabled by default and is
421: controlled via the
422: .Cm PermitUserEnvironment
423: option.
1.155 markus 424: This option is automatically disabled if
425: .Cm UseLogin
426: is enabled.
1.218 jmc 427: .It Cm from="pattern-list"
428: Specifies that in addition to public key authentication, the canonical name
429: of the remote host must be present in the comma-separated list of
430: patterns
431: .Pf ( Ql \&*
432: and
433: .Ql \&?
434: serve as wildcards).
435: The list may also contain
436: patterns negated by prefixing them with
437: .Ql \&! ;
438: if the canonical host name matches a negated pattern, the key is not accepted.
439: The purpose
440: of this option is to optionally increase security: public key authentication
441: by itself does not trust the network or name servers or anything (but
442: the key); however, if somebody somehow steals the key, the key
443: permits an intruder to log in from anywhere in the world.
444: This additional option makes using a stolen key more difficult (name
445: servers and/or routers would have to be compromised in addition to
446: just the key).
447: .It Cm no-agent-forwarding
448: Forbids authentication agent forwarding when this key is used for
449: authentication.
1.2 deraadt 450: .It Cm no-port-forwarding
1.211 jmc 451: Forbids TCP forwarding when this key is used for authentication.
1.36 aaron 452: Any port forward requests by the client will return an error.
453: This might be used, e.g., in connection with the
1.2 deraadt 454: .Cm command
1.1 deraadt 455: option.
1.218 jmc 456: .It Cm no-pty
457: Prevents tty allocation (a request to allocate a pty will fail).
1.2 deraadt 458: .It Cm no-X11-forwarding
1.1 deraadt 459: Forbids X11 forwarding when this key is used for authentication.
460: Any X11 forward requests by the client will return an error.
1.107 djm 461: .It Cm permitopen="host:port"
1.133 itojun 462: Limit local
1.107 djm 463: .Li ``ssh -L''
1.111 stevesk 464: port forwarding such that it may only connect to the specified host and
1.146 stevesk 465: port.
466: IPv6 addresses can be specified with an alternative syntax:
1.200 jmc 467: .Ar host Ns / Ns Ar port .
1.146 stevesk 468: Multiple
1.107 djm 469: .Cm permitopen
1.197 jmc 470: options may be applied separated by commas.
471: No pattern matching is performed on the specified hostnames,
472: they must be literal domains or addresses.
1.209 reyk 473: .It Cm tunnel="n"
474: Force a
475: .Xr tun 4
476: device on the server.
477: Without this option, the next available device will be used if
478: the client requests a tunnel.
1.2 deraadt 479: .El
480: .Pp
1.219 jmc 481: An example authorized_keys file:
482: .Bd -literal
483: # Comments allowed at start of line
484: ssh-rsa AAAAB3Nza...LiPk== user@example.net
485: from="*.sales.example.net,!pc.sales.example.net" ssh-rsa AAAAB2...19Q== john@example.net
486: command="dump /home",no-pty,no-port-forwarding ssh-dss AAAAC3...51R== example.net
487: permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss AAAAB5...21S==
488: tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...== jane@example.net
489: .Ed
1.2 deraadt 490: .Sh SSH_KNOWN_HOSTS FILE FORMAT
1.40 aaron 491: The
1.194 jmc 492: .Pa /etc/ssh/ssh_known_hosts
1.40 aaron 493: and
1.207 djm 494: .Pa ~/.ssh/known_hosts
1.36 aaron 495: files contain host public keys for all known hosts.
496: The global file should
1.37 brad 497: be prepared by the administrator (optional), and the per-user file is
1.220 ! jmc 498: maintained automatically: whenever the user connects from an unknown host,
1.36 aaron 499: its key is added to the per-user file.
1.2 deraadt 500: .Pp
1.1 deraadt 501: Each line in these files contains the following fields: hostnames,
1.36 aaron 502: bits, exponent, modulus, comment.
503: The fields are separated by spaces.
1.2 deraadt 504: .Pp
1.196 david 505: Hostnames is a comma-separated list of patterns
1.220 ! jmc 506: .Pf ( Ql *
1.197 jmc 507: and
508: .Ql \&?
1.195 mouring 509: act as
1.1 deraadt 510: wildcards); each pattern in turn is matched against the canonical host
511: name (when authenticating a client) or against the user-supplied
1.36 aaron 512: name (when authenticating a server).
513: A pattern may also be preceded by
1.195 mouring 514: .Ql \&!
1.2 deraadt 515: to indicate negation: if the host name matches a negated
1.1 deraadt 516: pattern, it is not accepted (by that line) even if it matched another
517: pattern on the line.
1.2 deraadt 518: .Pp
1.205 djm 519: Alternately, hostnames may be stored in a hashed form which hides host names
1.206 jmc 520: and addresses should the file's contents be disclosed.
521: Hashed hostnames start with a
522: .Ql |
1.205 djm 523: character.
524: Only one hashed hostname may appear on a single line and none of the above
525: negation or wildcard operators may be applied.
526: .Pp
1.49 markus 527: Bits, exponent, and modulus are taken directly from the RSA host key; they
1.220 ! jmc 528: can be obtained, for example, from
1.167 deraadt 529: .Pa /etc/ssh/ssh_host_key.pub .
1.1 deraadt 530: The optional comment field continues to the end of the line, and is not used.
1.2 deraadt 531: .Pp
532: Lines starting with
533: .Ql #
534: and empty lines are ignored as comments.
535: .Pp
1.1 deraadt 536: When performing host authentication, authentication is accepted if any
1.36 aaron 537: matching line has the proper key.
538: It is thus permissible (but not
1.1 deraadt 539: recommended) to have several lines or different host keys for the same
1.36 aaron 540: names.
541: This will inevitably happen when short forms of host names
542: from different domains are put in the file.
543: It is possible
1.1 deraadt 544: that the files contain conflicting information; authentication is
545: accepted if valid information can be found from either file.
1.2 deraadt 546: .Pp
1.1 deraadt 547: Note that the lines in these files are typically hundreds of characters
548: long, and you definitely don't want to type in the host keys by hand.
1.6 aaron 549: Rather, generate them by a script
1.40 aaron 550: or by taking
1.167 deraadt 551: .Pa /etc/ssh/ssh_host_key.pub
1.1 deraadt 552: and adding the host names at the front.
1.2 deraadt 553: .Ss Examples
1.120 markus 554: .Bd -literal
1.200 jmc 555: closenet,...,130.233.208.41 1024 37 159...93 closenet.hut.fi
1.120 markus 556: cvs.openbsd.org,199.185.137.3 ssh-rsa AAAA1234.....=
1.205 djm 557: .Ed
558: .Bd -literal
559: # A hashed hostname
560: |1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
561: AAAA1234.....=
1.120 markus 562: .Ed
1.2 deraadt 563: .Sh FILES
564: .Bl -tag -width Ds
1.167 deraadt 565: .It Pa /etc/ssh/sshd_config
1.1 deraadt 566: Contains configuration data for
1.2 deraadt 567: .Nm sshd .
1.184 stevesk 568: The file format and configuration options are described in
569: .Xr sshd_config 5 .
1.167 deraadt 570: .It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key
1.120 markus 571: These three files contain the private parts of the host keys.
1.98 deraadt 572: These files should only be owned by root, readable only by root, and not
1.1 deraadt 573: accessible to others.
1.14 markus 574: Note that
575: .Nm
576: does not start if this file is group/world-accessible.
1.167 deraadt 577: .It Pa /etc/ssh/ssh_host_key.pub, /etc/ssh/ssh_host_dsa_key.pub, /etc/ssh/ssh_host_rsa_key.pub
1.120 markus 578: These three files contain the public parts of the host keys.
1.98 deraadt 579: These files should be world-readable but writable only by
1.36 aaron 580: root.
1.98 deraadt 581: Their contents should match the respective private parts.
582: These files are not
583: really used for anything; they are provided for the convenience of
584: the user so their contents can be copied to known hosts files.
585: These files are created using
1.7 markus 586: .Xr ssh-keygen 1 .
1.129 provos 587: .It Pa /etc/moduli
1.73 provos 588: Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
1.192 stevesk 589: The file format is described in
590: .Xr moduli 5 .
1.185 stevesk 591: .It Pa /var/empty
592: .Xr chroot 2
593: directory used by
594: .Nm
595: during privilege separation in the pre-authentication phase.
596: The directory should not contain any files and must be owned by root
597: and not group or world-writable.
1.2 deraadt 598: .It Pa /var/run/sshd.pid
599: Contains the process ID of the
600: .Nm
1.1 deraadt 601: listening for connections (if there are several daemons running
1.186 stevesk 602: concurrently for different ports, this contains the process ID of the one
1.36 aaron 603: started last).
1.58 deraadt 604: The content of this file is not sensitive; it can be world-readable.
1.207 djm 605: .It Pa ~/.ssh/authorized_keys
1.120 markus 606: Lists the public keys (RSA or DSA) that can be used to log into the user's account.
1.44 deraadt 607: This file must be readable by root (which may on some machines imply
608: it being world-readable if the user's home directory resides on an NFS
609: volume).
610: It is recommended that it not be accessible by others.
611: The format of this file is described above.
612: Users will place the contents of their
1.130 markus 613: .Pa identity.pub ,
1.44 deraadt 614: .Pa id_dsa.pub
1.113 itojun 615: and/or
616: .Pa id_rsa.pub
1.44 deraadt 617: files into this file, as described in
618: .Xr ssh-keygen 1 .
1.207 djm 619: .It Pa "/etc/ssh/ssh_known_hosts", "~/.ssh/known_hosts"
1.22 markus 620: These files are consulted when using rhosts with RSA host
1.131 markus 621: authentication or protocol version 2 hostbased authentication
622: to check the public key of the host.
1.36 aaron 623: The key must be listed in one of these files to be accepted.
1.22 markus 624: The client uses the same files
1.96 markus 625: to verify that it is connecting to the correct remote host.
1.36 aaron 626: These files should be writable only by root/the owner.
1.167 deraadt 627: .Pa /etc/ssh/ssh_known_hosts
1.2 deraadt 628: should be world-readable, and
1.207 djm 629: .Pa ~/.ssh/known_hosts
1.194 jmc 630: can, but need not be, world-readable.
1.204 jmc 631: .It Pa /etc/motd
632: See
633: .Xr motd 5 .
1.207 djm 634: .It Pa ~/.hushlogin
1.204 jmc 635: This file is used to suppress printing the last login time and
636: .Pa /etc/motd ,
637: if
638: .Cm PrintLastLog
639: and
640: .Cm PrintMotd ,
641: respectively,
642: are enabled.
643: It does not suppress printing of the banner specified by
644: .Cm Banner .
1.6 aaron 645: .It Pa /etc/nologin
1.40 aaron 646: If this file exists,
1.2 deraadt 647: .Nm
1.36 aaron 648: refuses to let anyone except root log in.
649: The contents of the file
1.1 deraadt 650: are displayed to anyone trying to log in, and non-root connections are
1.36 aaron 651: refused.
652: The file should be world-readable.
1.19 dugsong 653: .It Pa /etc/hosts.allow, /etc/hosts.deny
1.153 camield 654: Access controls that should be enforced by tcp-wrappers are defined here.
655: Further details are described in
1.19 dugsong 656: .Xr hosts_access 5 .
1.207 djm 657: .It Pa ~/.rhosts
1.202 markus 658: This file is used during
659: .Cm RhostsRSAAuthentication
660: and
661: .Cm HostbasedAuthentication
662: and contains host-username pairs, separated by a space, one per
1.36 aaron 663: line.
664: The given user on the corresponding host is permitted to log in
1.194 jmc 665: without a password.
1.36 aaron 666: The same file is used by rlogind and rshd.
1.6 aaron 667: The file must
1.1 deraadt 668: be writable only by the user; it is recommended that it not be
669: accessible by others.
1.2 deraadt 670: .Pp
1.200 jmc 671: It is also possible to use netgroups in the file.
1.36 aaron 672: Either host or user
1.1 deraadt 673: name may be of the form +@groupname to specify all hosts or all users
674: in the group.
1.207 djm 675: .It Pa ~/.shosts
1.2 deraadt 676: For ssh,
677: this file is exactly the same as for
678: .Pa .rhosts .
679: However, this file is
680: not used by rlogin and rshd, so using this permits access using SSH only.
1.58 deraadt 681: .It Pa /etc/hosts.equiv
1.2 deraadt 682: This file is used during
1.202 markus 683: .Cm RhostsRSAAuthentication
684: and
685: .Cm HostbasedAuthentication
1.36 aaron 686: authentication.
687: In the simplest form, this file contains host names, one per line.
688: Users on
1.1 deraadt 689: those hosts are permitted to log in without a password, provided they
1.36 aaron 690: have the same user name on both machines.
691: The host name may also be
1.1 deraadt 692: followed by a user name; such users are permitted to log in as
1.2 deraadt 693: .Em any
1.36 aaron 694: user on this machine (except root).
695: Additionally, the syntax
1.2 deraadt 696: .Dq +@group
1.36 aaron 697: can be used to specify netgroups.
698: Negated entries start with
1.2 deraadt 699: .Ql \&- .
700: .Pp
1.1 deraadt 701: If the client host/user is successfully matched in this file, login is
702: automatically permitted provided the client and server user names are the
1.36 aaron 703: same.
1.202 markus 704: Additionally, successful client host key authentication is required.
1.36 aaron 705: This file must be writable only by root; it is recommended
1.1 deraadt 706: that it be world-readable.
1.2 deraadt 707: .Pp
1.6 aaron 708: .Sy "Warning: It is almost never a good idea to use user names in"
1.2 deraadt 709: .Pa hosts.equiv .
1.1 deraadt 710: Beware that it really means that the named user(s) can log in as
1.2 deraadt 711: .Em anybody ,
1.1 deraadt 712: which includes bin, daemon, adm, and other accounts that own critical
1.36 aaron 713: binaries and directories.
714: Using a user name practically grants the user root access.
715: The only valid use for user names that I can think
1.1 deraadt 716: of is in negative entries.
1.2 deraadt 717: .Pp
718: Note that this warning also applies to rsh/rlogin.
719: .It Pa /etc/shosts.equiv
1.1 deraadt 720: This is processed exactly as
1.2 deraadt 721: .Pa /etc/hosts.equiv .
1.1 deraadt 722: However, this file may be useful in environments that want to run both
1.2 deraadt 723: rsh/rlogin and ssh.
1.207 djm 724: .It Pa ~/.ssh/environment
1.36 aaron 725: This file is read into the environment at login (if it exists).
726: It can only contain empty lines, comment lines (that start with
1.2 deraadt 727: .Ql # ) ,
1.36 aaron 728: and assignment lines of the form name=value.
729: The file should be writable
1.6 aaron 730: only by the user; it need not be readable by anyone else.
1.188 stevesk 731: Environment processing is disabled by default and is
732: controlled via the
733: .Cm PermitUserEnvironment
734: option.
1.207 djm 735: .It Pa ~/.ssh/rc
1.194 jmc 736: If this file exists, it is run with
737: .Pa /bin/sh
738: after reading the
1.36 aaron 739: environment files but before starting the user's shell or command.
1.176 stevesk 740: It must not produce any output on stdout; stderr must be used
741: instead.
742: If X11 forwarding is in use, it will receive the "proto cookie" pair in
743: its standard input (and
1.2 deraadt 744: .Ev DISPLAY
1.176 stevesk 745: in its environment).
746: The script must call
1.2 deraadt 747: .Xr xauth 1
1.176 stevesk 748: because
749: .Nm
750: will not run xauth automatically to add X11 cookies.
1.2 deraadt 751: .Pp
1.1 deraadt 752: The primary purpose of this file is to run any initialization routines
753: which may be needed before the user's home directory becomes
754: accessible; AFS is a particular example of such an environment.
1.2 deraadt 755: .Pp
1.1 deraadt 756: This file will probably contain some initialization code followed by
1.120 markus 757: something similar to:
758: .Bd -literal
1.176 stevesk 759: if read proto cookie && [ -n "$DISPLAY" ]; then
760: if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
761: # X11UseLocalhost=yes
1.193 todd 762: echo add unix:`echo $DISPLAY |
1.176 stevesk 763: cut -c11-` $proto $cookie
764: else
765: # X11UseLocalhost=no
1.193 todd 766: echo add $DISPLAY $proto $cookie
767: fi | xauth -q -
1.176 stevesk 768: fi
1.120 markus 769: .Ed
1.2 deraadt 770: .Pp
771: If this file does not exist,
1.167 deraadt 772: .Pa /etc/ssh/sshrc
1.2 deraadt 773: is run, and if that
1.176 stevesk 774: does not exist either, xauth is used to add the cookie.
1.2 deraadt 775: .Pp
1.1 deraadt 776: This file should be writable only by the user, and need not be
777: readable by anyone else.
1.167 deraadt 778: .It Pa /etc/ssh/sshrc
1.2 deraadt 779: Like
1.207 djm 780: .Pa ~/.ssh/rc .
1.2 deraadt 781: This can be used to specify
1.36 aaron 782: machine-specific login-time initializations globally.
783: This file should be writable only by root, and should be world-readable.
1.56 aaron 784: .El
1.2 deraadt 785: .Sh SEE ALSO
786: .Xr scp 1 ,
1.90 djm 787: .Xr sftp 1 ,
1.2 deraadt 788: .Xr ssh 1 ,
1.5 deraadt 789: .Xr ssh-add 1 ,
1.2 deraadt 790: .Xr ssh-agent 1 ,
1.5 deraadt 791: .Xr ssh-keygen 1 ,
1.200 jmc 792: .Xr chroot 2 ,
793: .Xr hosts_access 5 ,
1.136 markus 794: .Xr login.conf 5 ,
795: .Xr moduli 5 ,
1.184 stevesk 796: .Xr sshd_config 5 ,
1.200 jmc 797: .Xr inetd 8 ,
1.128 mpech 798: .Xr sftp-server 8
1.119 markus 799: .Rs
800: .%A T. Ylonen
801: .%A T. Kivinen
802: .%A M. Saarinen
803: .%A T. Rinne
804: .%A S. Lehtinen
805: .%T "SSH Protocol Architecture"
1.174 markus 806: .%N draft-ietf-secsh-architecture-12.txt
807: .%D January 2002
1.120 markus 808: .%O work in progress material
809: .Re
810: .Rs
811: .%A M. Friedl
812: .%A N. Provos
813: .%A W. A. Simpson
814: .%T "Diffie-Hellman Group Exchange for the SSH Transport Layer Protocol"
1.174 markus 815: .%N draft-ietf-secsh-dh-group-exchange-02.txt
816: .%D January 2002
1.119 markus 817: .%O work in progress material
818: .Re
1.198 jmc 819: .Sh AUTHORS
820: OpenSSH is a derivative of the original and free
821: ssh 1.2.12 release by Tatu Ylonen.
822: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
823: Theo de Raadt and Dug Song
824: removed many bugs, re-added newer features and
825: created OpenSSH.
826: Markus Friedl contributed the support for SSH
827: protocol versions 1.5 and 2.0.
828: Niels Provos and Markus Friedl contributed support
829: for privilege separation.
1.216 jmc 830: .Sh CAVEATS
831: System security is not improved unless
832: .Nm rshd ,
833: .Nm rlogind ,
834: and
835: .Nm rexecd
836: are disabled (thus completely disabling
837: .Xr rlogin
838: and
839: .Xr rsh
840: into the machine).
![[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