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