Annotation of src/usr.bin/ssh/sshd.8, Revision 1.306
1.1 deraadt 1: .\"
2: .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
3: .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4: .\" All rights reserved
5: .\"
1.64 deraadt 6: .\" As far as I am concerned, the code I have written for this software
7: .\" can be used freely for any purpose. Any derived versions of this
8: .\" software must be clearly marked as such, and if the derived work is
9: .\" incompatible with the protocol description in the RFC file, it must be
10: .\" called by a name other than "ssh" or "Secure Shell".
11: .\"
1.99 deraadt 12: .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
13: .\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
14: .\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
1.64 deraadt 15: .\"
16: .\" Redistribution and use in source and binary forms, with or without
17: .\" modification, are permitted provided that the following conditions
18: .\" are met:
19: .\" 1. Redistributions of source code must retain the above copyright
20: .\" notice, this list of conditions and the following disclaimer.
21: .\" 2. Redistributions in binary form must reproduce the above copyright
22: .\" notice, this list of conditions and the following disclaimer in the
23: .\" documentation and/or other materials provided with the distribution.
1.1 deraadt 24: .\"
1.64 deraadt 25: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.1 deraadt 35: .\"
1.306 ! djm 36: .\" $OpenBSD: sshd.8,v 1.305 2019/11/07 08:38:38 naddy Exp $
! 37: .Dd $Mdocdate: November 7 2019 $
1.2 deraadt 38: .Dt SSHD 8
39: .Os
40: .Sh NAME
41: .Nm sshd
1.120 markus 42: .Nd OpenSSH SSH daemon
1.2 deraadt 43: .Sh SYNOPSIS
44: .Nm sshd
1.194 jmc 45: .Bk -words
1.243 jmc 46: .Op Fl 46DdeiqTt
1.242 dtucker 47: .Op Fl C Ar connection_spec
1.251 djm 48: .Op Fl c Ar host_certificate_file
1.268 dtucker 49: .Op Fl E Ar log_file
1.2 deraadt 50: .Op Fl f Ar config_file
51: .Op Fl g Ar login_grace_time
52: .Op Fl h Ar host_key_file
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.275 tedu 61: Together these programs replace rlogin and rsh,
1.235 jmc 62: and 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.230 jmc 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.243 jmc 97: .It Fl C Ar connection_spec
98: Specify the connection parameters to use for the
99: .Fl T
100: extended test mode.
101: If provided, any
102: .Cm Match
1.293 dtucker 103: directives in the configuration file that would apply are applied before the
104: configuration is written to standard output.
105: The connection parameters are supplied as keyword=value pairs and may be
106: supplied in any order, either with multiple
107: .Fl C
108: options or as a comma-separated list.
1.243 jmc 109: The keywords are
1.293 dtucker 110: .Dq addr,
1.243 jmc 111: .Dq user ,
112: .Dq host ,
1.265 dtucker 113: .Dq laddr ,
114: .Dq lport ,
1.293 dtucker 115: and
1.292 djm 116: .Dq rdomain
1.293 dtucker 117: and correspond to source address, user, resolved source host name,
118: local address, local port number and routing domain respectively.
1.252 jmc 119: .It Fl c Ar host_certificate_file
120: Specifies a path to a certificate file to identify
121: .Nm
122: during key exchange.
123: The certificate file must match a host key file specified using the
124: .Fl h
125: option or the
126: .Cm HostKey
127: configuration directive.
1.200 jmc 128: .It Fl D
129: When this option is specified,
130: .Nm
131: will not detach and does not become a daemon.
132: This allows easy monitoring of
133: .Nm sshd .
1.2 deraadt 134: .It Fl d
1.36 aaron 135: Debug mode.
1.250 djm 136: The server sends verbose debug output to standard error,
137: and does not put itself in the background.
1.36 aaron 138: The server also will not fork and will only process one connection.
139: This option is only intended for debugging for the server.
1.194 jmc 140: Multiple
141: .Fl d
142: options increase the debugging level.
1.67 aaron 143: Maximum is 3.
1.268 dtucker 144: .It Fl E Ar log_file
145: Append debug logs to
146: .Ar log_file
147: instead of the system log.
1.120 markus 148: .It Fl e
1.269 dtucker 149: Write debug logs to standard error instead of the system log.
1.235 jmc 150: .It Fl f Ar config_file
1.36 aaron 151: Specifies the name of the configuration file.
152: The default is
1.167 deraadt 153: .Pa /etc/ssh/sshd_config .
1.16 markus 154: .Nm
155: refuses to start if there is no configuration file.
1.2 deraadt 156: .It Fl g Ar login_grace_time
1.1 deraadt 157: Gives the grace time for clients to authenticate themselves (default
1.191 stevesk 158: 120 seconds).
1.36 aaron 159: If the client fails to authenticate the user within
160: this many seconds, the server disconnects and exits.
161: A value of zero indicates no limit.
1.2 deraadt 162: .It Fl h Ar host_key_file
1.160 stevesk 163: Specifies a file from which a host key is read.
1.7 markus 164: This option must be given if
165: .Nm
166: is not run as root (as the normal
1.160 stevesk 167: host key files are normally not readable by anyone but root).
168: The default is
1.285 naddy 169: .Pa /etc/ssh/ssh_host_ecdsa_key ,
1.273 naddy 170: .Pa /etc/ssh/ssh_host_ed25519_key
1.259 djm 171: and
1.285 naddy 172: .Pa /etc/ssh/ssh_host_rsa_key .
1.75 markus 173: It is possible to have multiple host key files for
1.285 naddy 174: the different host key algorithms.
1.2 deraadt 175: .It Fl i
1.7 markus 176: Specifies that
177: .Nm
1.194 jmc 178: is being run from
179: .Xr inetd 8 .
1.156 markus 180: .It Fl o Ar option
181: Can be used to give options in the format used in the configuration file.
182: This is useful for specifying options for which there is no separate
183: command-line flag.
1.200 jmc 184: For full details of the options, and their values, see
185: .Xr sshd_config 5 .
1.2 deraadt 186: .It Fl p Ar port
1.1 deraadt 187: Specifies the port on which the server listens for connections
188: (default 22).
1.158 stevesk 189: Multiple port options are permitted.
1.210 stevesk 190: Ports specified in the configuration file with the
191: .Cm Port
192: option are ignored when a command-line port is specified.
193: Ports specified using the
194: .Cm ListenAddress
195: option override command-line ports.
1.2 deraadt 196: .It Fl q
1.36 aaron 197: Quiet mode.
198: Nothing is sent to the system log.
199: Normally the beginning,
1.1 deraadt 200: authentication, and termination of each connection is logged.
1.242 dtucker 201: .It Fl T
202: Extended test mode.
203: Check the validity of the configuration file, output the effective configuration
204: to stdout and then exit.
205: Optionally,
206: .Cm Match
207: rules may be applied by specifying the connection parameters using one or more
208: .Fl C
209: options.
1.243 jmc 210: .It Fl t
211: Test mode.
212: Only check the validity of the configuration file and sanity of the keys.
213: This is useful for updating
214: .Nm
215: reliably as configuration options may change.
1.61 markus 216: .It Fl u Ar len
217: This option is used to specify the size of the field
218: in the
219: .Li utmp
220: structure that holds the remote host name.
221: If the resolved host name is longer than
222: .Ar len ,
223: the dotted decimal value will be used instead.
224: This allows hosts with very long host names that
225: overflow this field to still be uniquely identified.
226: Specifying
227: .Fl u0
228: indicates that only dotted decimal addresses
229: should be put into the
230: .Pa utmp
231: file.
1.144 stevesk 232: .Fl u0
1.194 jmc 233: may also be used to prevent
1.144 stevesk 234: .Nm
235: from making DNS requests unless the authentication
236: mechanism or configuration requires it.
237: Authentication mechanisms that may require DNS include
1.285 naddy 238: .Cm HostbasedAuthentication
1.144 stevesk 239: and using a
240: .Cm from="pattern-list"
241: option in a key file.
1.170 stevesk 242: Configuration options that require DNS include using a
243: USER@HOST pattern in
244: .Cm AllowUsers
245: or
246: .Cm DenyUsers .
1.2 deraadt 247: .El
1.214 jmc 248: .Sh AUTHENTICATION
1.285 naddy 249: The OpenSSH SSH daemon supports SSH protocol 2 only.
1.284 jmc 250: Each host has a host-specific key,
1.214 jmc 251: used to identify the host.
1.212 jmc 252: Whenever a client connects, the daemon responds with its public
1.285 naddy 253: host key.
1.212 jmc 254: The client compares the
1.285 naddy 255: host key against its own database to verify that it has not changed.
256: Forward security is provided through a Diffie-Hellman key agreement.
1.214 jmc 257: This key agreement results in a shared session key.
258: The rest of the session is encrypted using a symmetric cipher, currently
259: 128-bit AES, Blowfish, 3DES, CAST128, Arcfour, 192-bit AES, or 256-bit AES.
260: The client selects the encryption algorithm
261: to use from those offered by the server.
262: Additionally, session integrity is provided
263: through a cryptographic message authentication code
1.289 djm 264: (hmac-md5, hmac-sha1, umac-64, umac-128,
1.263 djm 265: hmac-sha2-256 or hmac-sha2-512).
1.214 jmc 266: .Pp
267: Finally, the server and the client enter an authentication dialog.
1.212 jmc 268: The client tries to authenticate itself using
1.214 jmc 269: host-based authentication,
270: public key authentication,
271: challenge-response authentication,
272: or password authentication.
1.212 jmc 273: .Pp
274: If the client successfully authenticates itself, a dialog for
275: preparing the session is entered.
276: At this time the client may request
277: things like allocating a pseudo-tty, forwarding X11 connections,
278: forwarding TCP connections, or forwarding the authentication agent
279: connection over the secure channel.
280: .Pp
1.216 jmc 281: After this, the client either requests a shell or execution of a command.
1.212 jmc 282: The sides then enter session mode.
283: In this mode, either side may send
284: data at any time, and such data is forwarded to/from the shell or
285: command on the server side, and the user terminal in the client side.
286: .Pp
287: When the user program terminates and all forwarded X11 and other
288: connections have been closed, the server sends command exit status to
289: the client, and both sides exit.
1.2 deraadt 290: .Sh LOGIN PROCESS
1.1 deraadt 291: When a user successfully logs in,
1.2 deraadt 292: .Nm
1.1 deraadt 293: does the following:
1.2 deraadt 294: .Bl -enum -offset indent
295: .It
1.1 deraadt 296: If the login is on a tty, and no command has been specified,
1.40 aaron 297: prints last login time and
1.2 deraadt 298: .Pa /etc/motd
1.1 deraadt 299: (unless prevented in the configuration file or by
1.207 djm 300: .Pa ~/.hushlogin ;
1.2 deraadt 301: see the
1.40 aaron 302: .Sx FILES
1.2 deraadt 303: section).
304: .It
1.1 deraadt 305: If the login is on a tty, records login time.
1.2 deraadt 306: .It
307: Checks
308: .Pa /etc/nologin ;
309: if it exists, prints contents and quits
1.1 deraadt 310: (unless root).
1.2 deraadt 311: .It
1.1 deraadt 312: Changes to run with normal user privileges.
1.2 deraadt 313: .It
1.1 deraadt 314: Sets up basic environment.
1.2 deraadt 315: .It
1.200 jmc 316: Reads the file
1.207 djm 317: .Pa ~/.ssh/environment ,
1.200 jmc 318: if it exists, and users are allowed to change their environment.
1.188 stevesk 319: See the
1.187 marc 320: .Cm PermitUserEnvironment
1.188 stevesk 321: option in
1.187 marc 322: .Xr sshd_config 5 .
1.2 deraadt 323: .It
1.1 deraadt 324: Changes to user's home directory.
1.2 deraadt 325: .It
326: If
1.207 djm 327: .Pa ~/.ssh/rc
1.276 djm 328: exists and the
329: .Xr sshd_config 5
330: .Cm PermitUserRC
331: option is set, runs it; else if
1.168 deraadt 332: .Pa /etc/ssh/sshrc
1.2 deraadt 333: exists, runs
1.36 aaron 334: it; otherwise runs xauth.
335: The
1.2 deraadt 336: .Dq rc
337: files are given the X11
1.1 deraadt 338: authentication protocol and cookie in standard input.
1.226 jmc 339: See
340: .Sx SSHRC ,
341: below.
1.2 deraadt 342: .It
1.1 deraadt 343: Runs user's shell or command.
1.279 djm 344: All commands are run under the user's login shell as specified in the
345: system password database.
1.2 deraadt 346: .El
1.226 jmc 347: .Sh SSHRC
348: If the file
349: .Pa ~/.ssh/rc
350: exists,
351: .Xr sh 1
352: runs it after reading the
353: environment files but before starting the user's shell or command.
354: It must not produce any output on stdout; stderr must be used
355: instead.
356: If X11 forwarding is in use, it will receive the "proto cookie" pair in
357: its standard input (and
358: .Ev DISPLAY
359: in its environment).
360: The script must call
361: .Xr xauth 1
362: because
363: .Nm
364: will not run xauth automatically to add X11 cookies.
365: .Pp
366: The primary purpose of this file is to run any initialization routines
367: which may be needed before the user's home directory becomes
368: accessible; AFS is a particular example of such an environment.
369: .Pp
370: This file will probably contain some initialization code followed by
371: something similar to:
372: .Bd -literal -offset 3n
373: if read proto cookie && [ -n "$DISPLAY" ]; then
374: if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
375: # X11UseLocalhost=yes
376: echo add unix:`echo $DISPLAY |
377: cut -c11-` $proto $cookie
378: else
379: # X11UseLocalhost=no
380: echo add $DISPLAY $proto $cookie
381: fi | xauth -q -
382: fi
383: .Ed
384: .Pp
385: If this file does not exist,
386: .Pa /etc/ssh/sshrc
387: is run, and if that
388: does not exist either, xauth is used to add the cookie.
1.2 deraadt 389: .Sh AUTHORIZED_KEYS FILE FORMAT
1.125 markus 390: .Cm AuthorizedKeysFile
1.262 jmc 391: specifies the files containing public keys for
1.217 jmc 392: public key authentication;
1.281 djm 393: if this option is not specified, the default is
1.261 djm 394: .Pa ~/.ssh/authorized_keys
395: and
396: .Pa ~/.ssh/authorized_keys2 .
1.36 aaron 397: Each line of the file contains one
1.2 deraadt 398: key (empty lines and lines starting with a
399: .Ql #
400: are ignored as
1.36 aaron 401: comments).
1.285 naddy 402: Public keys consist of the following space-separated fields:
1.217 jmc 403: options, keytype, base64-encoded key, comment.
1.285 naddy 404: The options field is optional.
1.305 naddy 405: The supported key types are:
406: .Pp
407: .Bl -item -compact -offset indent
408: .It
409: sk-ecdsa-sha2-nistp256@openssh.com
410: .It
411: ecdsa-sha2-nistp256
412: .It
413: ecdsa-sha2-nistp384
414: .It
415: ecdsa-sha2-nistp521
416: .It
1.306 ! djm 417: sk-ssh-ed25519@openssh.com
! 418: .It
1.305 naddy 419: ssh-ed25519
420: .It
421: ssh-dss
422: .It
423: ssh-rsa
424: .El
425: .Pp
426: The comment field is not used for anything (but may be convenient for the
1.285 naddy 427: user to identify the key).
1.2 deraadt 428: .Pp
1.285 naddy 429: Note that lines in this file can be several hundred bytes long
1.203 dtucker 430: (because of the size of the public key encoding) up to a limit of
1.305 naddy 431: 8 kilobytes, which permits RSA keys up to 16 kilobits.
1.36 aaron 432: You don't want to type them in; instead, copy the
1.217 jmc 433: .Pa id_dsa.pub ,
1.259 djm 434: .Pa id_ecdsa.pub ,
1.305 naddy 435: .Pa id_ecdsa_sk.pub ,
1.273 naddy 436: .Pa id_ed25519.pub ,
1.306 ! djm 437: .Pa id_ed25519_sk.pub ,
1.75 markus 438: or the
1.113 itojun 439: .Pa id_rsa.pub
1.1 deraadt 440: file and edit it.
1.175 stevesk 441: .Pp
442: .Nm
1.296 dtucker 443: enforces a minimum RSA key modulus size of 1024 bits.
1.2 deraadt 444: .Pp
1.58 deraadt 445: The options (if present) consist of comma-separated option
1.36 aaron 446: specifications.
447: No spaces are permitted, except within double quotes.
1.141 stevesk 448: The following option specifications are supported (note
449: that option keywords are case-insensitive):
1.2 deraadt 450: .Bl -tag -width Ds
1.282 djm 451: .It Cm agent-forwarding
452: Enable authentication agent forwarding previously disabled by the
453: .Cm restrict
454: option.
1.253 djm 455: .It Cm cert-authority
1.251 djm 456: Specifies that the listed key is a certification authority (CA) that is
457: trusted to validate signed certificates for user authentication.
458: .Pp
459: Certificates may encode access restrictions similar to these key options.
460: If both certificate restrictions and key options are present, the most
461: restrictive union of the two is applied.
1.2 deraadt 462: .It Cm command="command"
1.1 deraadt 463: Specifies that the command is executed whenever this key is used for
1.36 aaron 464: authentication.
465: The command supplied by the user (if any) is ignored.
1.148 markus 466: The command is run on a pty if the client requests a pty;
1.36 aaron 467: otherwise it is run without a tty.
1.194 jmc 468: If an 8-bit clean channel is required,
1.147 deraadt 469: one must not request a pty or should specify
1.89 markus 470: .Cm no-pty .
1.36 aaron 471: A quote may be included in the command by quoting it with a backslash.
1.287 djm 472: .Pp
1.36 aaron 473: This option might be useful
1.189 espie 474: to restrict certain public keys to perform just a specific operation.
1.36 aaron 475: An example might be a key that permits remote backups but nothing else.
1.211 jmc 476: Note that the client may specify TCP and/or X11
1.287 djm 477: forwarding unless they are explicitly prohibited, e.g. using the
478: .Cm restrict
479: key option.
480: .Pp
1.233 dtucker 481: The command originally supplied by the client is available in the
482: .Ev SSH_ORIGINAL_COMMAND
483: environment variable.
1.149 markus 484: Note that this option applies to shell, command or subsystem execution.
1.287 djm 485: Also note that this command may be superseded by a
1.251 djm 486: .Xr sshd_config 5
487: .Cm ForceCommand
1.287 djm 488: directive.
489: .Pp
490: If a command is specified and a forced-command is embedded in a certificate
491: used for authentication, then the certificate will be accepted only if the
492: two commands are identical.
1.2 deraadt 493: .It Cm environment="NAME=value"
1.1 deraadt 494: Specifies that the string is to be added to the environment when
1.36 aaron 495: logging in using this key.
496: Environment variables set this way
497: override other default environment values.
498: Multiple options of this type are permitted.
1.188 stevesk 499: Environment processing is disabled by default and is
500: controlled via the
501: .Cm PermitUserEnvironment
502: option.
1.299 jmc 503: .It Cm expiry-time="timespec"
504: Specifies a time after which the key will not be accepted.
505: The time may be specified as a YYYYMMDD date or a YYYYMMDDHHMM[SS] time
506: in the system time-zone.
1.218 jmc 507: .It Cm from="pattern-list"
1.244 djm 508: Specifies that in addition to public key authentication, either the canonical
1.245 jmc 509: name of the remote host or its IP address must be present in the
1.244 djm 510: comma-separated list of patterns.
1.270 jmc 511: See PATTERNS in
1.229 jmc 512: .Xr ssh_config 5
513: for more information on patterns.
1.244 djm 514: .Pp
515: In addition to the wildcard matching that may be applied to hostnames or
516: addresses, a
517: .Cm from
1.248 sobrado 518: stanza may match IP addresses using CIDR address/masklen notation.
1.244 djm 519: .Pp
520: The purpose of this option is to optionally increase security: public key
521: authentication by itself does not trust the network or name servers or
522: anything (but the key); however, if somebody somehow steals the key, the key
523: permits an intruder to log in from anywhere in the world.
524: This additional option makes using a stolen key more difficult (name
525: servers and/or routers would have to be compromised in addition to
526: just the key).
1.218 jmc 527: .It Cm no-agent-forwarding
528: Forbids authentication agent forwarding when this key is used for
529: authentication.
1.2 deraadt 530: .It Cm no-port-forwarding
1.211 jmc 531: Forbids TCP forwarding when this key is used for authentication.
1.36 aaron 532: Any port forward requests by the client will return an error.
1.230 jmc 533: This might be used, e.g. in connection with the
1.2 deraadt 534: .Cm command
1.1 deraadt 535: option.
1.218 jmc 536: .It Cm no-pty
537: Prevents tty allocation (a request to allocate a pty will fail).
1.240 djm 538: .It Cm no-user-rc
1.241 jmc 539: Disables execution of
1.240 djm 540: .Pa ~/.ssh/rc .
1.2 deraadt 541: .It Cm no-X11-forwarding
1.1 deraadt 542: Forbids X11 forwarding when this key is used for authentication.
543: Any X11 forward requests by the client will return an error.
1.302 djm 544: .It Cm permitlisten="[host:]port"
1.301 jmc 545: Limit remote port forwarding with the
1.300 djm 546: .Xr ssh 1
547: .Fl R
1.302 djm 548: option such that it may only listen on the specified host (optional) and port.
1.300 djm 549: IPv6 addresses can be specified by enclosing the address in square brackets.
550: Multiple
551: .Cm permitlisten
552: options may be applied separated by commas.
553: Hostnames may include wildcards as described in the PATTERNS section in
554: .Xr ssh_config 5 .
555: A port specification of
556: .Cm *
557: matches any port.
558: Note that the setting of
559: .Cm GatewayPorts
560: may further restrict listen addresses.
1.302 djm 561: Note that
562: .Xr ssh 1
563: will send a hostname of
564: .Dq localhost
565: if a listen host was not specified when the forwarding was requested, and
1.303 jmc 566: that this name is treated differently to the explicit localhost addresses
1.302 djm 567: .Dq 127.0.0.1
568: and
569: .Dq ::1 .
1.107 djm 570: .It Cm permitopen="host:port"
1.301 jmc 571: Limit local port forwarding with the
1.278 bentley 572: .Xr ssh 1
573: .Fl L
1.300 djm 574: option such that it may only connect to the specified host and port.
1.257 djm 575: IPv6 addresses can be specified by enclosing the address in square brackets.
1.146 stevesk 576: Multiple
1.107 djm 577: .Cm permitopen
1.197 jmc 578: options may be applied separated by commas.
579: No pattern matching is performed on the specified hostnames,
580: they must be literal domains or addresses.
1.264 dtucker 581: A port specification of
582: .Cm *
583: matches any port.
1.282 djm 584: .It Cm port-forwarding
585: Enable port forwarding previously disabled by the
586: .Cm restrict
1.294 djm 587: option.
1.256 djm 588: .It Cm principals="principals"
589: On a
590: .Cm cert-authority
591: line, specifies allowed principals for certificate authentication as a
592: comma-separated list.
593: At least one name from the list must appear in the certificate's
594: list of principals for the certificate to be accepted.
595: This option is ignored for keys that are not marked as trusted certificate
596: signers using the
597: .Cm cert-authority
598: option.
1.282 djm 599: .It Cm pty
600: Permits tty allocation previously disabled by the
601: .Cm restrict
602: option.
603: .It Cm restrict
604: Enable all restrictions, i.e. disable port, agent and X11 forwarding,
605: as well as disabling PTY allocation
606: and execution of
607: .Pa ~/.ssh/rc .
608: If any future restriction capabilities are added to authorized_keys files
609: they will be included in this set.
1.209 reyk 610: .It Cm tunnel="n"
611: Force a
612: .Xr tun 4
613: device on the server.
614: Without this option, the next available device will be used if
615: the client requests a tunnel.
1.282 djm 616: .It Cm user-rc
617: Enables execution of
618: .Pa ~/.ssh/rc
619: previously disabled by the
620: .Cm restrict
621: option.
622: .It Cm X11-forwarding
623: Permits X11 forwarding previously disabled by the
624: .Cm restrict
625: option.
1.2 deraadt 626: .El
627: .Pp
1.219 jmc 628: An example authorized_keys file:
1.222 jmc 629: .Bd -literal -offset 3n
1.219 jmc 630: # Comments allowed at start of line
631: ssh-rsa AAAAB3Nza...LiPk== user@example.net
1.222 jmc 632: from="*.sales.example.net,!pc.sales.example.net" ssh-rsa
633: AAAAB2...19Q== john@example.net
1.304 dtucker 634: command="dump /home",no-pty,no-port-forwarding ssh-rsa
1.222 jmc 635: AAAAC3...51R== example.net
1.304 dtucker 636: permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-rsa
1.302 djm 637: AAAAB5...21S==
1.304 dtucker 638: permitlisten="localhost:8080",permitopen="localhost:22000" ssh-rsa
1.222 jmc 639: AAAAB5...21S==
640: tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...==
641: jane@example.net
1.282 djm 642: restrict,command="uptime" ssh-rsa AAAA1C8...32Tv==
643: user@example.net
644: restrict,pty,command="nethack" ssh-rsa AAAA1f8...IrrC5==
645: user@example.net
1.219 jmc 646: .Ed
1.2 deraadt 647: .Sh SSH_KNOWN_HOSTS FILE FORMAT
1.40 aaron 648: The
1.194 jmc 649: .Pa /etc/ssh/ssh_known_hosts
1.40 aaron 650: and
1.207 djm 651: .Pa ~/.ssh/known_hosts
1.36 aaron 652: files contain host public keys for all known hosts.
653: The global file should
1.37 brad 654: be prepared by the administrator (optional), and the per-user file is
1.288 dtucker 655: maintained automatically: whenever the user connects to an unknown host,
1.36 aaron 656: its key is added to the per-user file.
1.2 deraadt 657: .Pp
1.254 djm 658: Each line in these files contains the following fields: markers (optional),
1.285 naddy 659: hostnames, keytype, base64-encoded key, comment.
1.36 aaron 660: The fields are separated by spaces.
1.2 deraadt 661: .Pp
1.254 djm 662: The marker is optional, but if it is present then it must be one of
663: .Dq @cert-authority ,
664: to indicate that the line contains a certification authority (CA) key,
665: or
666: .Dq @revoked ,
667: to indicate that the key contained on the line is revoked and must not ever
668: be accepted.
669: Only one marker should be used on a key line.
670: .Pp
1.196 david 671: Hostnames is a comma-separated list of patterns
1.220 jmc 672: .Pf ( Ql *
1.197 jmc 673: and
674: .Ql \&?
1.195 mouring 675: act as
1.290 djm 676: wildcards); each pattern in turn is matched against the host name.
677: When
678: .Nm sshd
679: is authenticating a client, such as when using
680: .Cm HostbasedAuthentication ,
681: this will be the canonical client host name.
682: When
683: .Xr ssh 1
1.291 jmc 684: is authenticating a server, this will be the host name
1.290 djm 685: given by the user, the value of the
686: .Xr ssh 1
687: .Cm HostkeyAlias
688: if it was specified, or the canonical server hostname if the
689: .Xr ssh 1
690: .Cm CanonicalizeHostname
691: option was used.
692: .Pp
1.36 aaron 693: A pattern may also be preceded by
1.195 mouring 694: .Ql \&!
1.2 deraadt 695: to indicate negation: if the host name matches a negated
1.1 deraadt 696: pattern, it is not accepted (by that line) even if it matched another
697: pattern on the line.
1.231 dtucker 698: A hostname or address may optionally be enclosed within
699: .Ql \&[
700: and
701: .Ql \&]
702: brackets then followed by
703: .Ql \&:
1.232 jmc 704: and a non-standard port number.
1.2 deraadt 705: .Pp
1.205 djm 706: Alternately, hostnames may be stored in a hashed form which hides host names
1.206 jmc 707: and addresses should the file's contents be disclosed.
708: Hashed hostnames start with a
709: .Ql |
1.205 djm 710: character.
711: Only one hashed hostname may appear on a single line and none of the above
712: negation or wildcard operators may be applied.
713: .Pp
1.285 naddy 714: The keytype and base64-encoded key are taken directly from the host key; they
1.220 jmc 715: can be obtained, for example, from
1.285 naddy 716: .Pa /etc/ssh/ssh_host_rsa_key.pub .
1.1 deraadt 717: The optional comment field continues to the end of the line, and is not used.
1.2 deraadt 718: .Pp
719: Lines starting with
720: .Ql #
721: and empty lines are ignored as comments.
722: .Pp
1.1 deraadt 723: When performing host authentication, authentication is accepted if any
1.254 djm 724: matching line has the proper key; either one that matches exactly or,
725: if the server has presented a certificate for authentication, the key
726: of the certification authority that signed the certificate.
727: For a key to be trusted as a certification authority, it must use the
728: .Dq @cert-authority
729: marker described above.
730: .Pp
731: The known hosts file also provides a facility to mark keys as revoked,
732: for example when it is known that the associated private key has been
733: stolen.
734: Revoked keys are specified by including the
735: .Dq @revoked
736: marker at the beginning of the key line, and are never accepted for
737: authentication or as certification authorities, but instead will
738: produce a warning from
739: .Xr ssh 1
740: when they are encountered.
741: .Pp
742: It is permissible (but not
1.1 deraadt 743: recommended) to have several lines or different host keys for the same
1.36 aaron 744: names.
745: This will inevitably happen when short forms of host names
746: from different domains are put in the file.
747: It is possible
1.1 deraadt 748: that the files contain conflicting information; authentication is
749: accepted if valid information can be found from either file.
1.2 deraadt 750: .Pp
1.1 deraadt 751: Note that the lines in these files are typically hundreds of characters
752: long, and you definitely don't want to type in the host keys by hand.
1.254 djm 753: Rather, generate them by a script,
754: .Xr ssh-keyscan 1
1.285 naddy 755: or by taking, for example,
756: .Pa /etc/ssh/ssh_host_rsa_key.pub
1.1 deraadt 757: and adding the host names at the front.
1.254 djm 758: .Xr ssh-keygen 1
1.255 jmc 759: also offers some basic automated editing for
1.254 djm 760: .Pa ~/.ssh/known_hosts
761: including removing hosts matching a host name and converting all host
762: names to their hashed representations.
1.221 jmc 763: .Pp
764: An example ssh_known_hosts file:
765: .Bd -literal -offset 3n
766: # Comments allowed at start of line
767: closenet,...,192.0.2.53 1024 37 159...93 closenet.example.net
768: cvs.example.net,192.0.2.10 ssh-rsa AAAA1234.....=
1.205 djm 769: # A hashed hostname
770: |1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
771: AAAA1234.....=
1.254 djm 772: # A revoked key
773: @revoked * ssh-rsa AAAAB5W...
774: # A CA key, accepted for any host in *.mydomain.com or *.mydomain.org
775: @cert-authority *.mydomain.org,*.mydomain.com ssh-rsa AAAAB5W...
1.120 markus 776: .Ed
1.2 deraadt 777: .Sh FILES
1.223 jmc 778: .Bl -tag -width Ds -compact
1.258 jmc 779: .It Pa ~/.hushlogin
1.204 jmc 780: This file is used to suppress printing the last login time and
781: .Pa /etc/motd ,
782: if
783: .Cm PrintLastLog
784: and
785: .Cm PrintMotd ,
786: respectively,
787: are enabled.
788: It does not suppress printing of the banner specified by
789: .Cm Banner .
1.223 jmc 790: .Pp
1.258 jmc 791: .It Pa ~/.rhosts
1.225 jmc 792: This file is used for host-based authentication (see
793: .Xr ssh 1
794: for more information).
795: On some machines this file may need to be
796: world-readable if the user's home directory is on an NFS partition,
797: because
798: .Nm
799: reads it as root.
800: Additionally, this file must be owned by the user,
801: and must not have write permissions for anyone else.
802: The recommended
803: permission for most machines is read/write for the user, and not
1.1 deraadt 804: accessible by others.
1.2 deraadt 805: .Pp
1.258 jmc 806: .It Pa ~/.shosts
1.225 jmc 807: This file is used in exactly the same way as
808: .Pa .rhosts ,
809: but allows host-based authentication without permitting login with
810: rlogin/rsh.
1.238 mcbride 811: .Pp
1.258 jmc 812: .It Pa ~/.ssh/
1.238 mcbride 813: This directory is the default location for all user-specific configuration
814: and authentication information.
815: There is no general requirement to keep the entire contents of this directory
816: secret, but the recommended permissions are read/write/execute for the user,
817: and not accessible by others.
1.2 deraadt 818: .Pp
1.258 jmc 819: .It Pa ~/.ssh/authorized_keys
1.277 sobrado 820: Lists the public keys (DSA, ECDSA, Ed25519, RSA)
1.273 naddy 821: that can be used for logging in as this user.
1.223 jmc 822: The format of this file is described above.
1.234 dtucker 823: The content of the file is not highly sensitive, but the recommended
1.225 jmc 824: permissions are read/write for the user, and not accessible by others.
1.234 dtucker 825: .Pp
826: If this file, the
827: .Pa ~/.ssh
828: directory, or the user's home directory are writable
829: by other users, then the file could be modified or replaced by unauthorized
830: users.
831: In this case,
832: .Nm
833: will not allow it to be used unless the
834: .Cm StrictModes
835: option has been set to
836: .Dq no .
1.2 deraadt 837: .Pp
1.258 jmc 838: .It Pa ~/.ssh/environment
1.36 aaron 839: This file is read into the environment at login (if it exists).
840: It can only contain empty lines, comment lines (that start with
1.2 deraadt 841: .Ql # ) ,
1.36 aaron 842: and assignment lines of the form name=value.
843: The file should be writable
1.6 aaron 844: only by the user; it need not be readable by anyone else.
1.188 stevesk 845: Environment processing is disabled by default and is
846: controlled via the
847: .Cm PermitUserEnvironment
848: option.
1.223 jmc 849: .Pp
1.258 jmc 850: .It Pa ~/.ssh/known_hosts
1.225 jmc 851: Contains a list of host keys for all hosts the user has logged into
852: that are not already in the systemwide list of known host keys.
853: The format of this file is described above.
854: This file should be writable only by root/the owner and
1.223 jmc 855: can, but need not be, world-readable.
856: .Pp
1.258 jmc 857: .It Pa ~/.ssh/rc
1.226 jmc 858: Contains initialization routines to be run before
859: the user's home directory becomes accessible.
1.1 deraadt 860: This file should be writable only by the user, and need not be
861: readable by anyone else.
1.223 jmc 862: .Pp
1.258 jmc 863: .It Pa /etc/hosts.equiv
1.227 jmc 864: This file is for host-based authentication (see
865: .Xr ssh 1 ) .
866: It should only be writable by root.
1.223 jmc 867: .Pp
1.258 jmc 868: .It Pa /etc/moduli
1.283 djm 869: Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange"
870: key exchange method.
1.223 jmc 871: The file format is described in
872: .Xr moduli 5 .
1.283 djm 873: If no usable groups are found in this file then fixed internal groups will
874: be used.
1.223 jmc 875: .Pp
1.258 jmc 876: .It Pa /etc/motd
1.223 jmc 877: See
878: .Xr motd 5 .
879: .Pp
1.258 jmc 880: .It Pa /etc/nologin
1.223 jmc 881: If this file exists,
882: .Nm
883: refuses to let anyone except root log in.
884: The contents of the file
885: are displayed to anyone trying to log in, and non-root connections are
886: refused.
887: The file should be world-readable.
888: .Pp
1.258 jmc 889: .It Pa /etc/shosts.equiv
1.227 jmc 890: This file is used in exactly the same way as
891: .Pa hosts.equiv ,
892: but allows host-based authentication without permitting login with
893: rlogin/rsh.
1.225 jmc 894: .Pp
1.259 djm 895: .It Pa /etc/ssh/ssh_host_ecdsa_key
1.273 naddy 896: .It Pa /etc/ssh/ssh_host_ed25519_key
1.258 jmc 897: .It Pa /etc/ssh/ssh_host_rsa_key
1.266 dtucker 898: These files contain the private parts of the host keys.
1.223 jmc 899: These files should only be owned by root, readable only by root, and not
900: accessible to others.
901: Note that
902: .Nm
1.228 jmc 903: does not start if these files are group/world-accessible.
1.223 jmc 904: .Pp
1.259 djm 905: .It Pa /etc/ssh/ssh_host_ecdsa_key.pub
1.273 naddy 906: .It Pa /etc/ssh/ssh_host_ed25519_key.pub
1.258 jmc 907: .It Pa /etc/ssh/ssh_host_rsa_key.pub
1.266 dtucker 908: These files contain the public parts of the host keys.
1.223 jmc 909: These files should be world-readable but writable only by
910: root.
911: Their contents should match the respective private parts.
912: These files are not
913: really used for anything; they are provided for the convenience of
914: the user so their contents can be copied to known hosts files.
915: These files are created using
916: .Xr ssh-keygen 1 .
917: .Pp
1.258 jmc 918: .It Pa /etc/ssh/ssh_known_hosts
1.235 jmc 919: Systemwide list of known host keys.
920: This file should be prepared by the
921: system administrator to contain the public host keys of all machines in the
922: organization.
923: The format of this file is described above.
924: This file should be writable only by root/the owner and
925: should be world-readable.
926: .Pp
1.258 jmc 927: .It Pa /etc/ssh/sshd_config
1.223 jmc 928: Contains configuration data for
929: .Nm sshd .
930: The file format and configuration options are described in
931: .Xr sshd_config 5 .
932: .Pp
1.258 jmc 933: .It Pa /etc/ssh/sshrc
1.226 jmc 934: Similar to
935: .Pa ~/.ssh/rc ,
936: it can be used to specify
1.36 aaron 937: machine-specific login-time initializations globally.
938: This file should be writable only by root, and should be world-readable.
1.223 jmc 939: .Pp
1.258 jmc 940: .It Pa /var/empty
1.223 jmc 941: .Xr chroot 2
942: directory used by
943: .Nm
944: during privilege separation in the pre-authentication phase.
945: The directory should not contain any files and must be owned by root
946: and not group or world-writable.
947: .Pp
1.258 jmc 948: .It Pa /var/run/sshd.pid
1.223 jmc 949: Contains the process ID of the
950: .Nm
951: listening for connections (if there are several daemons running
952: concurrently for different ports, this contains the process ID of the one
953: started last).
954: The content of this file is not sensitive; it can be world-readable.
1.56 aaron 955: .El
1.2 deraadt 956: .Sh SEE ALSO
957: .Xr scp 1 ,
1.90 djm 958: .Xr sftp 1 ,
1.2 deraadt 959: .Xr ssh 1 ,
1.5 deraadt 960: .Xr ssh-add 1 ,
1.2 deraadt 961: .Xr ssh-agent 1 ,
1.5 deraadt 962: .Xr ssh-keygen 1 ,
1.235 jmc 963: .Xr ssh-keyscan 1 ,
1.200 jmc 964: .Xr chroot 2 ,
1.136 markus 965: .Xr login.conf 5 ,
966: .Xr moduli 5 ,
1.184 stevesk 967: .Xr sshd_config 5 ,
1.200 jmc 968: .Xr inetd 8 ,
1.128 mpech 969: .Xr sftp-server 8
1.198 jmc 970: .Sh AUTHORS
971: OpenSSH is a derivative of the original and free
972: ssh 1.2.12 release by Tatu Ylonen.
973: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
974: Theo de Raadt and Dug Song
975: removed many bugs, re-added newer features and
976: created OpenSSH.
977: Markus Friedl contributed the support for SSH
978: protocol versions 1.5 and 2.0.
979: Niels Provos and Markus Friedl contributed support
980: for privilege separation.
![[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