Annotation of src/usr.bin/ssh/sshd.8, Revision 1.153.2.8
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.153.2.8! miod 37: .\" $OpenBSD: sshd.8,v 1.193 2002/09/24 20:59:44 todd 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.150 stevesk 46: .Op Fl deiqtD46
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
1.153.2.3 jason 52: .Op Fl o Ar option
1.2 deraadt 53: .Op Fl p Ar port
1.61 markus 54: .Op Fl u Ar len
1.40 aaron 55: .Sh DESCRIPTION
1.2 deraadt 56: .Nm
1.106 deraadt 57: (SSH 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.153.2.5 miod 119: .Nm rshd ,
120: .Nm rlogind ,
1.2 deraadt 121: and
1.153.2.5 miod 122: .Xr rexecd
1.1 deraadt 123: are disabled (thus completely disabling
1.153.2.5 miod 124: .Xr rlogin
1.1 deraadt 125: and
1.153.2.5 miod 126: .Xr rsh
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.138 markus 132: Each host has a host-specific key (RSA or DSA) used to identify the host.
1.49 markus 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.
1.120 markus 136: .Pp
1.103 deraadt 137: The rest of the session is encrypted using a symmetric cipher, currently
1.120 markus 138: 128 bit AES, Blowfish, 3DES, CAST128, Arcfour, 192 bit AES, or 256 bit AES.
1.49 markus 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
1.120 markus 146: user (PubkeyAuthentication) or
147: client host (HostbasedAuthentication) authentication method,
148: conventional password authentication and challenge response based methods.
1.49 markus 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,
1.97 deraadt 177: .Dv SIGHUP ,
1.128 mpech 178: by executing itself with the name it was started as, i.e.,
1.97 deraadt 179: .Pa /usr/sbin/sshd .
1.18 aaron 180: .Pp
181: The options are as follows:
1.2 deraadt 182: .Bl -tag -width Ds
183: .It Fl b Ar bits
1.120 markus 184: Specifies the number of bits in the ephemeral protocol version 1
185: server key (default 768).
1.2 deraadt 186: .It Fl d
1.36 aaron 187: Debug mode.
188: The server sends verbose debug output to the system
189: log, and does not put itself in the background.
190: The server also will not fork and will only process one connection.
191: This option is only intended for debugging for the server.
1.120 markus 192: Multiple -d options increase the debugging level.
1.67 aaron 193: Maximum is 3.
1.120 markus 194: .It Fl e
195: When this option is specified,
196: .Nm
197: will send the output to the standard error instead of the system log.
1.2 deraadt 198: .It Fl f Ar configuration_file
1.36 aaron 199: Specifies the name of the configuration file.
200: The default is
1.153.2.4 brad 201: .Pa /etc/sshd_config .
1.16 markus 202: .Nm
203: refuses to start if there is no configuration file.
1.2 deraadt 204: .It Fl g Ar login_grace_time
1.1 deraadt 205: Gives the grace time for clients to authenticate themselves (default
1.153.2.8! miod 206: 120 seconds).
1.36 aaron 207: If the client fails to authenticate the user within
208: this many seconds, the server disconnects and exits.
209: A value of zero indicates no limit.
1.2 deraadt 210: .It Fl h Ar host_key_file
1.153.2.3 jason 211: Specifies a file from which a host key is read.
1.7 markus 212: This option must be given if
213: .Nm
214: is not run as root (as the normal
1.153.2.3 jason 215: host key files are normally not readable by anyone but root).
216: The default is
1.153.2.4 brad 217: .Pa /etc/ssh_host_key
1.153.2.3 jason 218: for protocol version 1, and
1.153.2.4 brad 219: .Pa /etc/ssh_host_rsa_key
1.153.2.3 jason 220: and
1.153.2.4 brad 221: .Pa /etc/ssh_host_dsa_key
1.153.2.3 jason 222: for protocol version 2.
1.75 markus 223: It is possible to have multiple host key files for
1.120 markus 224: the different protocol versions and host key algorithms.
1.2 deraadt 225: .It Fl i
1.7 markus 226: Specifies that
227: .Nm
1.40 aaron 228: is being run from inetd.
1.7 markus 229: .Nm
230: is normally not run
1.1 deraadt 231: from inetd because it needs to generate the server key before it can
1.36 aaron 232: respond to the client, and this may take tens of seconds.
233: Clients would have to wait too long if the key was regenerated every time.
1.35 aaron 234: However, with small key sizes (e.g., 512) using
1.7 markus 235: .Nm
236: from inetd may
1.1 deraadt 237: be feasible.
1.2 deraadt 238: .It Fl k Ar key_gen_time
1.120 markus 239: Specifies how often the ephemeral protocol version 1 server key is
240: regenerated (default 3600 seconds, or one hour).
1.36 aaron 241: The motivation for regenerating the key fairly
1.1 deraadt 242: often is that the key is not stored anywhere, and after about an hour,
243: it becomes impossible to recover the key for decrypting intercepted
244: communications even if the machine is cracked into or physically
1.36 aaron 245: seized.
246: A value of zero indicates that the key will never be regenerated.
1.153.2.3 jason 247: .It Fl o Ar option
248: Can be used to give options in the format used in the configuration file.
249: This is useful for specifying options for which there is no separate
250: command-line flag.
1.2 deraadt 251: .It Fl p Ar port
1.1 deraadt 252: Specifies the port on which the server listens for connections
253: (default 22).
1.153.2.3 jason 254: Multiple port options are permitted.
255: Ports specified in the configuration file are ignored when a
256: command-line port is specified.
1.2 deraadt 257: .It Fl q
1.36 aaron 258: Quiet mode.
259: Nothing is sent to the system log.
260: Normally the beginning,
1.1 deraadt 261: authentication, and termination of each connection is logged.
1.137 stevesk 262: .It Fl t
263: Test mode.
264: Only check the validity of the configuration file and sanity of the keys.
1.153.2.3 jason 265: This is useful for updating
1.137 stevesk 266: .Nm
267: reliably as configuration options may change.
1.61 markus 268: .It Fl u Ar len
269: This option is used to specify the size of the field
270: in the
271: .Li utmp
272: structure that holds the remote host name.
273: If the resolved host name is longer than
274: .Ar len ,
275: the dotted decimal value will be used instead.
276: This allows hosts with very long host names that
277: overflow this field to still be uniquely identified.
278: Specifying
279: .Fl u0
280: indicates that only dotted decimal addresses
281: should be put into the
282: .Pa utmp
283: file.
1.144 stevesk 284: .Fl u0
285: is also be used to prevent
286: .Nm
287: from making DNS requests unless the authentication
288: mechanism or configuration requires it.
289: Authentication mechanisms that may require DNS include
290: .Cm RhostsAuthentication ,
291: .Cm RhostsRSAAuthentication ,
292: .Cm HostbasedAuthentication
293: and using a
294: .Cm from="pattern-list"
295: option in a key file.
1.153.2.3 jason 296: Configuration options that require DNS include using a
297: USER@HOST pattern in
298: .Cm AllowUsers
299: or
300: .Cm DenyUsers .
1.74 markus 301: .It Fl D
302: When this option is specified
303: .Nm
304: will not detach and does not become a daemon.
305: This allows easy monitoring of
1.76 markus 306: .Nm sshd .
1.29 markus 307: .It Fl 4
308: Forces
309: .Nm
310: to use IPv4 addresses only.
311: .It Fl 6
312: Forces
313: .Nm
314: to use IPv6 addresses only.
1.2 deraadt 315: .El
316: .Sh CONFIGURATION FILE
317: .Nm
1.40 aaron 318: reads configuration data from
1.153.2.4 brad 319: .Pa /etc/sshd_config
1.2 deraadt 320: (or the file specified with
321: .Fl f
1.36 aaron 322: on the command line).
1.153.2.6 miod 323: The file format and configuration options are described in
324: .Xr sshd_config 5 .
1.2 deraadt 325: .Sh LOGIN PROCESS
1.1 deraadt 326: When a user successfully logs in,
1.2 deraadt 327: .Nm
1.1 deraadt 328: does the following:
1.2 deraadt 329: .Bl -enum -offset indent
330: .It
1.1 deraadt 331: If the login is on a tty, and no command has been specified,
1.40 aaron 332: prints last login time and
1.2 deraadt 333: .Pa /etc/motd
1.1 deraadt 334: (unless prevented in the configuration file or by
1.2 deraadt 335: .Pa $HOME/.hushlogin ;
336: see the
1.40 aaron 337: .Sx FILES
1.2 deraadt 338: section).
339: .It
1.1 deraadt 340: If the login is on a tty, records login time.
1.2 deraadt 341: .It
342: Checks
343: .Pa /etc/nologin ;
344: if it exists, prints contents and quits
1.1 deraadt 345: (unless root).
1.2 deraadt 346: .It
1.1 deraadt 347: Changes to run with normal user privileges.
1.2 deraadt 348: .It
1.1 deraadt 349: Sets up basic environment.
1.2 deraadt 350: .It
351: Reads
352: .Pa $HOME/.ssh/environment
1.153.2.8! miod 353: if it exists and users are allowed to change their environment.
! 354: See the
! 355: .Cm PermitUserEnvironment
! 356: option in
! 357: .Xr sshd_config 5 .
1.2 deraadt 358: .It
1.1 deraadt 359: Changes to user's home directory.
1.2 deraadt 360: .It
361: If
362: .Pa $HOME/.ssh/rc
363: exists, runs it; else if
1.153.2.4 brad 364: .Pa /etc/sshrc
1.2 deraadt 365: exists, runs
1.36 aaron 366: it; otherwise runs xauth.
367: The
1.2 deraadt 368: .Dq rc
369: files are given the X11
1.1 deraadt 370: authentication protocol and cookie in standard input.
1.2 deraadt 371: .It
1.1 deraadt 372: Runs user's shell or command.
1.2 deraadt 373: .El
374: .Sh AUTHORIZED_KEYS FILE FORMAT
375: .Pa $HOME/.ssh/authorized_keys
1.130 markus 376: is the default file that lists the public keys that are
377: permitted for RSA authentication in protocol version 1
378: and for public key authentication (PubkeyAuthentication)
379: in protocol version 2.
1.125 markus 380: .Cm AuthorizedKeysFile
381: may be used to specify an alternative file.
1.75 markus 382: .Pp
1.36 aaron 383: Each line of the file contains one
1.2 deraadt 384: key (empty lines and lines starting with a
385: .Ql #
386: are ignored as
1.36 aaron 387: comments).
1.75 markus 388: Each RSA public key consists of the following fields, separated by
1.36 aaron 389: spaces: options, bits, exponent, modulus, comment.
1.75 markus 390: Each protocol version 2 public key consists of:
391: options, keytype, base64 encoded key, comment.
1.153.2.8! miod 392: The options field
! 393: is optional; its presence is determined by whether the line starts
! 394: with a number or not (the options field never starts with a number).
1.75 markus 395: The bits, exponent, modulus and comment fields give the RSA key for
396: protocol version 1; the
1.1 deraadt 397: comment field is not used for anything (but may be convenient for the
398: user to identify the key).
1.75 markus 399: For protocol version 2 the keytype is
400: .Dq ssh-dss
401: or
402: .Dq ssh-rsa .
1.2 deraadt 403: .Pp
1.1 deraadt 404: Note that lines in this file are usually several hundred bytes long
1.153.2.8! miod 405: (because of the size of the public key encoding).
1.36 aaron 406: You don't want to type them in; instead, copy the
1.113 itojun 407: .Pa identity.pub ,
408: .Pa id_dsa.pub
1.75 markus 409: or the
1.113 itojun 410: .Pa id_rsa.pub
1.1 deraadt 411: file and edit it.
1.2 deraadt 412: .Pp
1.153.2.5 miod 413: .Nm
414: enforces a minimum RSA key modulus size for protocol 1
415: and protocol 2 keys of 768 bits.
416: .Pp
1.58 deraadt 417: The options (if present) consist of comma-separated option
1.36 aaron 418: specifications.
419: No spaces are permitted, except within double quotes.
1.141 stevesk 420: The following option specifications are supported (note
421: that option keywords are case-insensitive):
1.2 deraadt 422: .Bl -tag -width Ds
423: .It Cm from="pattern-list"
1.153.2.8! miod 424: Specifies that in addition to public key authentication, the canonical name
1.1 deraadt 425: of the remote host must be present in the comma-separated list of
1.36 aaron 426: patterns
427: .Pf ( Ql *
428: and
429: .Ql ?
430: serve as wildcards).
431: The list may also contain
432: patterns negated by prefixing them with
433: .Ql ! ;
434: if the canonical host name matches a negated pattern, the key is not accepted.
435: The purpose
1.153.2.8! miod 436: of this option is to optionally increase security: public key authentication
1.1 deraadt 437: by itself does not trust the network or name servers or anything (but
438: the key); however, if somebody somehow steals the key, the key
1.36 aaron 439: permits an intruder to log in from anywhere in the world.
440: This additional option makes using a stolen key more difficult (name
1.1 deraadt 441: servers and/or routers would have to be compromised in addition to
442: just the key).
1.2 deraadt 443: .It Cm command="command"
1.1 deraadt 444: Specifies that the command is executed whenever this key is used for
1.36 aaron 445: authentication.
446: The command supplied by the user (if any) is ignored.
1.148 markus 447: The command is run on a pty if the client requests a pty;
1.36 aaron 448: otherwise it is run without a tty.
1.147 deraadt 449: If a 8-bit clean channel is required,
450: one must not request a pty or should specify
1.89 markus 451: .Cm no-pty .
1.36 aaron 452: A quote may be included in the command by quoting it with a backslash.
453: This option might be useful
1.153.2.8! miod 454: to restrict certain public keys to perform just a specific operation.
1.36 aaron 455: An example might be a key that permits remote backups but nothing else.
1.51 hugh 456: Note that the client may specify TCP/IP and/or X11
457: forwarding unless they are explicitly prohibited.
1.149 markus 458: Note that this option applies to shell, command or subsystem execution.
1.2 deraadt 459: .It Cm environment="NAME=value"
1.1 deraadt 460: Specifies that the string is to be added to the environment when
1.36 aaron 461: logging in using this key.
462: Environment variables set this way
463: override other default environment values.
464: Multiple options of this type are permitted.
1.153.2.8! miod 465: Environment processing is disabled by default and is
! 466: controlled via the
! 467: .Cm PermitUserEnvironment
! 468: option.
1.153.2.2 jason 469: This option is automatically disabled if
470: .Cm UseLogin
471: is enabled.
1.2 deraadt 472: .It Cm no-port-forwarding
1.1 deraadt 473: Forbids TCP/IP forwarding when this key is used for authentication.
1.36 aaron 474: Any port forward requests by the client will return an error.
475: This might be used, e.g., in connection with the
1.2 deraadt 476: .Cm command
1.1 deraadt 477: option.
1.2 deraadt 478: .It Cm no-X11-forwarding
1.1 deraadt 479: Forbids X11 forwarding when this key is used for authentication.
480: Any X11 forward requests by the client will return an error.
1.2 deraadt 481: .It Cm no-agent-forwarding
1.1 deraadt 482: Forbids authentication agent forwarding when this key is used for
483: authentication.
1.2 deraadt 484: .It Cm no-pty
1.1 deraadt 485: Prevents tty allocation (a request to allocate a pty will fail).
1.107 djm 486: .It Cm permitopen="host:port"
1.133 itojun 487: Limit local
1.107 djm 488: .Li ``ssh -L''
1.111 stevesk 489: port forwarding such that it may only connect to the specified host and
1.146 stevesk 490: port.
491: IPv6 addresses can be specified with an alternative syntax:
492: .Ar host/port .
493: Multiple
1.107 djm 494: .Cm permitopen
1.133 itojun 495: options may be applied separated by commas. No pattern matching is
496: performed on the specified hostnames, they must be literal domains or
1.107 djm 497: addresses.
1.2 deraadt 498: .El
499: .Ss Examples
1.1 deraadt 500: 1024 33 12121.\|.\|.\|312314325 ylo@foo.bar
1.2 deraadt 501: .Pp
1.1 deraadt 502: from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23.\|.\|.\|2334 ylo@niksula
1.2 deraadt 503: .Pp
1.1 deraadt 504: command="dump /home",no-pty,no-port-forwarding 1024 33 23.\|.\|.\|2323 backup.hut.fi
1.107 djm 505: .Pp
506: permitopen="10.2.1.55:80",permitopen="10.2.1.56:25" 1024 33 23.\|.\|.\|2323
1.2 deraadt 507: .Sh SSH_KNOWN_HOSTS FILE FORMAT
1.40 aaron 508: The
1.153.2.4 brad 509: .Pa /etc/ssh_known_hosts ,
1.40 aaron 510: and
1.131 markus 511: .Pa $HOME/.ssh/known_hosts
1.36 aaron 512: files contain host public keys for all known hosts.
513: The global file should
1.37 brad 514: be prepared by the administrator (optional), and the per-user file is
1.58 deraadt 515: maintained automatically: whenever the user connects from an unknown host
1.36 aaron 516: its key is added to the per-user file.
1.2 deraadt 517: .Pp
1.1 deraadt 518: Each line in these files contains the following fields: hostnames,
1.36 aaron 519: bits, exponent, modulus, comment.
520: The fields are separated by spaces.
1.2 deraadt 521: .Pp
1.1 deraadt 522: Hostnames is a comma-separated list of patterns ('*' and '?' act as
523: wildcards); each pattern in turn is matched against the canonical host
524: name (when authenticating a client) or against the user-supplied
1.36 aaron 525: name (when authenticating a server).
526: A pattern may also be preceded by
1.2 deraadt 527: .Ql !
528: to indicate negation: if the host name matches a negated
1.1 deraadt 529: pattern, it is not accepted (by that line) even if it matched another
530: pattern on the line.
1.2 deraadt 531: .Pp
1.49 markus 532: Bits, exponent, and modulus are taken directly from the RSA host key; they
1.2 deraadt 533: can be obtained, e.g., from
1.153.2.4 brad 534: .Pa /etc/ssh_host_key.pub .
1.1 deraadt 535: The optional comment field continues to the end of the line, and is not used.
1.2 deraadt 536: .Pp
537: Lines starting with
538: .Ql #
539: and empty lines are ignored as comments.
540: .Pp
1.1 deraadt 541: When performing host authentication, authentication is accepted if any
1.36 aaron 542: matching line has the proper key.
543: It is thus permissible (but not
1.1 deraadt 544: recommended) to have several lines or different host keys for the same
1.36 aaron 545: names.
546: This will inevitably happen when short forms of host names
547: from different domains are put in the file.
548: It is possible
1.1 deraadt 549: that the files contain conflicting information; authentication is
550: accepted if valid information can be found from either file.
1.2 deraadt 551: .Pp
1.1 deraadt 552: Note that the lines in these files are typically hundreds of characters
553: long, and you definitely don't want to type in the host keys by hand.
1.6 aaron 554: Rather, generate them by a script
1.40 aaron 555: or by taking
1.153.2.4 brad 556: .Pa /etc/ssh_host_key.pub
1.1 deraadt 557: and adding the host names at the front.
1.2 deraadt 558: .Ss Examples
1.120 markus 559: .Bd -literal
560: closenet,.\|.\|.\|,130.233.208.41 1024 37 159.\|.\|.93 closenet.hut.fi
561: cvs.openbsd.org,199.185.137.3 ssh-rsa AAAA1234.....=
562: .Ed
1.2 deraadt 563: .Sh FILES
564: .Bl -tag -width Ds
1.153.2.4 brad 565: .It Pa /etc/sshd_config
1.1 deraadt 566: Contains configuration data for
1.2 deraadt 567: .Nm sshd .
1.153.2.6 miod 568: The file format and configuration options are described in
569: .Xr sshd_config 5 .
1.153.2.4 brad 570: .It Pa /etc/ssh_host_key, /etc/ssh_host_dsa_key, /etc/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.153.2.4 brad 577: .It Pa /etc/ssh_host_key.pub, /etc/ssh_host_dsa_key.pub, /etc/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.153.2.8! miod 589: The file format is described in
! 590: .Xr moduli 5 .
1.153.2.7 miod 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.153.2.7 miod 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.2 deraadt 605: .It Pa $HOME/.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.153.2.4 brad 619: .It Pa "/etc/ssh_known_hosts" and "$HOME/.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.153.2.4 brad 627: .Pa /etc/ssh_known_hosts
1.2 deraadt 628: should be world-readable, and
629: .Pa $HOME/.ssh/known_hosts
1.120 markus 630: can but need not be world-readable.
1.6 aaron 631: .It Pa /etc/nologin
1.40 aaron 632: If this file exists,
1.2 deraadt 633: .Nm
1.36 aaron 634: refuses to let anyone except root log in.
635: The contents of the file
1.1 deraadt 636: are displayed to anyone trying to log in, and non-root connections are
1.36 aaron 637: refused.
638: The file should be world-readable.
1.19 dugsong 639: .It Pa /etc/hosts.allow, /etc/hosts.deny
1.153 camield 640: Access controls that should be enforced by tcp-wrappers are defined here.
641: Further details are described in
1.19 dugsong 642: .Xr hosts_access 5 .
1.6 aaron 643: .It Pa $HOME/.rhosts
1.1 deraadt 644: This file contains host-username pairs, separated by a space, one per
1.36 aaron 645: line.
646: The given user on the corresponding host is permitted to log in
647: without password.
648: The same file is used by rlogind and rshd.
1.6 aaron 649: The file must
1.1 deraadt 650: be writable only by the user; it is recommended that it not be
651: accessible by others.
1.2 deraadt 652: .Pp
1.36 aaron 653: If is also possible to use netgroups in the file.
654: Either host or user
1.1 deraadt 655: name may be of the form +@groupname to specify all hosts or all users
656: in the group.
1.2 deraadt 657: .It Pa $HOME/.shosts
658: For ssh,
659: this file is exactly the same as for
660: .Pa .rhosts .
661: However, this file is
662: not used by rlogin and rshd, so using this permits access using SSH only.
1.58 deraadt 663: .It Pa /etc/hosts.equiv
1.2 deraadt 664: This file is used during
665: .Pa .rhosts
1.36 aaron 666: authentication.
667: In the simplest form, this file contains host names, one per line.
668: Users on
1.1 deraadt 669: those hosts are permitted to log in without a password, provided they
1.36 aaron 670: have the same user name on both machines.
671: The host name may also be
1.1 deraadt 672: followed by a user name; such users are permitted to log in as
1.2 deraadt 673: .Em any
1.36 aaron 674: user on this machine (except root).
675: Additionally, the syntax
1.2 deraadt 676: .Dq +@group
1.36 aaron 677: can be used to specify netgroups.
678: Negated entries start with
1.2 deraadt 679: .Ql \&- .
680: .Pp
1.1 deraadt 681: If the client host/user is successfully matched in this file, login is
682: automatically permitted provided the client and server user names are the
1.36 aaron 683: same.
684: Additionally, successful RSA host authentication is normally required.
685: This file must be writable only by root; it is recommended
1.1 deraadt 686: that it be world-readable.
1.2 deraadt 687: .Pp
1.6 aaron 688: .Sy "Warning: It is almost never a good idea to use user names in"
1.2 deraadt 689: .Pa hosts.equiv .
1.1 deraadt 690: Beware that it really means that the named user(s) can log in as
1.2 deraadt 691: .Em anybody ,
1.1 deraadt 692: which includes bin, daemon, adm, and other accounts that own critical
1.36 aaron 693: binaries and directories.
694: Using a user name practically grants the user root access.
695: The only valid use for user names that I can think
1.1 deraadt 696: of is in negative entries.
1.2 deraadt 697: .Pp
698: Note that this warning also applies to rsh/rlogin.
699: .It Pa /etc/shosts.equiv
1.1 deraadt 700: This is processed exactly as
1.2 deraadt 701: .Pa /etc/hosts.equiv .
1.1 deraadt 702: However, this file may be useful in environments that want to run both
1.2 deraadt 703: rsh/rlogin and ssh.
1.6 aaron 704: .It Pa $HOME/.ssh/environment
1.36 aaron 705: This file is read into the environment at login (if it exists).
706: It can only contain empty lines, comment lines (that start with
1.2 deraadt 707: .Ql # ) ,
1.36 aaron 708: and assignment lines of the form name=value.
709: The file should be writable
1.6 aaron 710: only by the user; it need not be readable by anyone else.
1.153.2.8! miod 711: Environment processing is disabled by default and is
! 712: controlled via the
! 713: .Cm PermitUserEnvironment
! 714: option.
1.2 deraadt 715: .It Pa $HOME/.ssh/rc
1.1 deraadt 716: If this file exists, it is run with /bin/sh after reading the
1.36 aaron 717: environment files but before starting the user's shell or command.
1.153.2.5 miod 718: It must not produce any output on stdout; stderr must be used
719: instead.
720: If X11 forwarding is in use, it will receive the "proto cookie" pair in
721: its standard input (and
1.2 deraadt 722: .Ev DISPLAY
1.153.2.5 miod 723: in its environment).
724: The script must call
1.2 deraadt 725: .Xr xauth 1
1.153.2.5 miod 726: because
727: .Nm
728: will not run xauth automatically to add X11 cookies.
1.2 deraadt 729: .Pp
1.1 deraadt 730: The primary purpose of this file is to run any initialization routines
731: which may be needed before the user's home directory becomes
732: accessible; AFS is a particular example of such an environment.
1.2 deraadt 733: .Pp
1.1 deraadt 734: This file will probably contain some initialization code followed by
1.120 markus 735: something similar to:
736: .Bd -literal
1.153.2.5 miod 737: if read proto cookie && [ -n "$DISPLAY" ]; then
738: if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
739: # X11UseLocalhost=yes
1.153.2.8! miod 740: echo add unix:`echo $DISPLAY |
1.153.2.5 miod 741: cut -c11-` $proto $cookie
742: else
743: # X11UseLocalhost=no
1.153.2.8! miod 744: echo add $DISPLAY $proto $cookie
! 745: fi | xauth -q -
1.153.2.5 miod 746: fi
1.120 markus 747: .Ed
1.2 deraadt 748: .Pp
749: If this file does not exist,
1.153.2.4 brad 750: .Pa /etc/sshrc
1.2 deraadt 751: is run, and if that
1.153.2.5 miod 752: does not exist either, xauth is used to add the cookie.
1.2 deraadt 753: .Pp
1.1 deraadt 754: This file should be writable only by the user, and need not be
755: readable by anyone else.
1.153.2.4 brad 756: .It Pa /etc/sshrc
1.2 deraadt 757: Like
758: .Pa $HOME/.ssh/rc .
759: This can be used to specify
1.36 aaron 760: machine-specific login-time initializations globally.
761: This file should be writable only by root, and should be world-readable.
1.56 aaron 762: .El
1.71 aaron 763: .Sh AUTHORS
1.84 markus 764: OpenSSH is a derivative of the original and free
765: ssh 1.2.12 release by Tatu Ylonen.
766: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
767: Theo de Raadt and Dug Song
768: removed many bugs, re-added newer features and
769: created OpenSSH.
770: Markus Friedl contributed the support for SSH
771: protocol versions 1.5 and 2.0.
1.153.2.5 miod 772: Niels Provos and Markus Friedl contributed support
773: for privilege separation.
1.2 deraadt 774: .Sh SEE ALSO
775: .Xr scp 1 ,
1.90 djm 776: .Xr sftp 1 ,
1.2 deraadt 777: .Xr ssh 1 ,
1.5 deraadt 778: .Xr ssh-add 1 ,
1.2 deraadt 779: .Xr ssh-agent 1 ,
1.5 deraadt 780: .Xr ssh-keygen 1 ,
1.136 markus 781: .Xr login.conf 5 ,
782: .Xr moduli 5 ,
1.153.2.6 miod 783: .Xr sshd_config 5 ,
1.128 mpech 784: .Xr sftp-server 8
1.119 markus 785: .Rs
786: .%A T. Ylonen
787: .%A T. Kivinen
788: .%A M. Saarinen
789: .%A T. Rinne
790: .%A S. Lehtinen
791: .%T "SSH Protocol Architecture"
1.153.2.5 miod 792: .%N draft-ietf-secsh-architecture-12.txt
793: .%D January 2002
1.120 markus 794: .%O work in progress material
795: .Re
796: .Rs
797: .%A M. Friedl
798: .%A N. Provos
799: .%A W. A. Simpson
800: .%T "Diffie-Hellman Group Exchange for the SSH Transport Layer Protocol"
1.153.2.5 miod 801: .%N draft-ietf-secsh-dh-group-exchange-02.txt
802: .%D January 2002
1.119 markus 803: .%O work in progress material
804: .Re
![[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