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