]> andersk Git - openssh.git/blame - sshd.8
- stevesk@cvs.openbsd.org 2002/06/22 16:32:54
[openssh.git] / sshd.8
CommitLineData
bf740959 1.\" -*- nroff -*-
2.\"
bf740959 3.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
bf740959 4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5.\" All rights reserved
6.\"
bcbf86ec 7.\" As far as I am concerned, the code I have written for this software
8.\" can be used freely for any purpose. Any derived versions of this
9.\" software must be clearly marked as such, and if the derived work is
10.\" incompatible with the protocol description in the RFC file, it must be
11.\" called by a name other than "ssh" or "Secure Shell".
12.\"
f3c7c613 13.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
14.\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
15.\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
bcbf86ec 16.\"
17.\" Redistribution and use in source and binary forms, with or without
18.\" modification, are permitted provided that the following conditions
19.\" are met:
20.\" 1. Redistributions of source code must retain the above copyright
21.\" notice, this list of conditions and the following disclaimer.
22.\" 2. Redistributions in binary form must reproduce the above copyright
23.\" notice, this list of conditions and the following disclaimer in the
24.\" documentation and/or other materials provided with the distribution.
bf740959 25.\"
bcbf86ec 26.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bf740959 36.\"
75653d3e 37.\" $OpenBSD: sshd.8,v 1.185 2002/06/22 16:32:54 stevesk Exp $
bf740959 38.Dd September 25, 1999
39.Dt SSHD 8
40.Os
41.Sh NAME
42.Nm sshd
da89cf4d 43.Nd OpenSSH SSH daemon
bf740959 44.Sh SYNOPSIS
45.Nm sshd
2043936f 46.Op Fl deiqtD46
bf740959 47.Op Fl b Ar bits
48.Op Fl f Ar config_file
49.Op Fl g Ar login_grace_time
50.Op Fl h Ar host_key_file
51.Op Fl k Ar key_gen_time
2717fa0f 52.Op Fl o Ar option
bf740959 53.Op Fl p Ar port
c345cf9d 54.Op Fl u Ar len
f54651ce 55.Sh DESCRIPTION
bf740959 56.Nm
2c86906e 57(SSH Daemon) is the daemon program for
bf740959 58.Xr ssh 1 .
3189621b 59Together these programs replace rlogin and rsh, and
bf740959 60provide secure encrypted communications between two untrusted hosts
4fe2af09 61over an insecure network.
62The programs are intended to be as easy to
bf740959 63install and use as possible.
64.Pp
65.Nm
4fe2af09 66is the daemon that listens for connections from clients.
f54651ce 67It is normally started at boot from
bf740959 68.Pa /etc/rc .
69It forks a new
4fe2af09 70daemon for each incoming connection.
71The forked daemons handle
bf740959 72key exchange, encryption, authentication, command execution,
73and data exchange.
1d1ffb87 74This implementation of
75.Nm
76supports both SSH protocol version 1 and 2 simultaneously.
bf740959 77.Nm
4fe2af09 78works as follows.
1d1ffb87 79.Pp
80.Ss SSH protocol version 1
81.Pp
4fe2af09 82Each host has a host-specific RSA key
83(normally 1024 bits) used to identify the host.
84Additionally, when
bf740959 85the daemon starts, it generates a server RSA key (normally 768 bits).
86This key is normally regenerated every hour if it has been used, and
87is never stored on disk.
88.Pp
3189621b 89Whenever a client connects the daemon responds with its public
90host and server keys.
4fe2af09 91The client compares the
1d1ffb87 92RSA host key against its own database to verify that it has not changed.
4fe2af09 93The client then generates a 256 bit random number.
94It encrypts this
bf740959 95random number using both the host key and the server key, and sends
4fe2af09 96the encrypted number to the server.
3189621b 97Both sides then use this
bf740959 98random number as a session key which is used to encrypt all further
4fe2af09 99communications in the session.
100The rest of the session is encrypted
3189621b 101using a conventional cipher, currently Blowfish or 3DES, with 3DES
7368a6c8 102being used by default.
4fe2af09 103The client selects the encryption algorithm
bf740959 104to use from those offered by the server.
105.Pp
4fe2af09 106Next, the server and the client enter an authentication dialog.
107The client tries to authenticate itself using
bf740959 108.Pa .rhosts
109authentication,
110.Pa .rhosts
111authentication combined with RSA host
112authentication, RSA challenge-response authentication, or password
113based authentication.
114.Pp
115Rhosts authentication is normally disabled
116because it is fundamentally insecure, but can be enabled in the server
4fe2af09 117configuration file if desired.
118System security is not improved unless
7e276482 119.Nm rshd ,
120.Nm rlogind ,
bf740959 121and
7e276482 122.Xr rexecd
bf740959 123are disabled (thus completely disabling
7e276482 124.Xr rlogin
bf740959 125and
7e276482 126.Xr rsh
3189621b 127into the machine).
bf740959 128.Pp
1d1ffb87 129.Ss SSH protocol version 2
130.Pp
c345cf9d 131Version 2 works similarly:
7f19f8bb 132Each host has a host-specific key (RSA or DSA) used to identify the host.
1d1ffb87 133However, when the daemon starts, it does not generate a server key.
134Forward security is provided through a Diffie-Hellman key agreement.
135This key agreement results in a shared session key.
da89cf4d 136.Pp
51c251f0 137The rest of the session is encrypted using a symmetric cipher, currently
da89cf4d 138128 bit AES, Blowfish, 3DES, CAST128, Arcfour, 192 bit AES, or 256 bit AES.
1d1ffb87 139The client selects the encryption algorithm
140to use from those offered by the server.
141Additionally, session integrity is provided
d0c832f3 142through a cryptographic message authentication code
1d1ffb87 143(hmac-sha1 or hmac-md5).
144.Pp
145Protocol version 2 provides a public key based
da89cf4d 146user (PubkeyAuthentication) or
147client host (HostbasedAuthentication) authentication method,
148conventional password authentication and challenge response based methods.
1d1ffb87 149.Pp
150.Ss Command execution and data forwarding
151.Pp
bf740959 152If the client successfully authenticates itself, a dialog for
4fe2af09 153preparing the session is entered.
154At this time the client may request
bf740959 155things like allocating a pseudo-tty, forwarding X11 connections,
156forwarding TCP/IP connections, or forwarding the authentication agent
157connection over the secure channel.
158.Pp
159Finally, the client either requests a shell or execution of a command.
4fe2af09 160The sides then enter session mode.
161In this mode, either side may send
bf740959 162data at any time, and such data is forwarded to/from the shell or
163command on the server side, and the user terminal in the client side.
164.Pp
165When the user program terminates and all forwarded X11 and other
166connections have been closed, the server sends command exit status to
167the client, and both sides exit.
168.Pp
169.Nm
170can be configured using command-line options or a configuration
4fe2af09 171file.
172Command-line options override values specified in the
bf740959 173configuration file.
174.Pp
9d6b7add 175.Nm
176rereads its configuration file when it receives a hangup signal,
409edaba 177.Dv SIGHUP ,
a5a2da3b 178by executing itself with the name it was started as, i.e.,
409edaba 179.Pa /usr/sbin/sshd .
9d6b7add 180.Pp
bf740959 181The options are as follows:
182.Bl -tag -width Ds
183.It Fl b Ar bits
da89cf4d 184Specifies the number of bits in the ephemeral protocol version 1
185server key (default 768).
bf740959 186.It Fl d
4fe2af09 187Debug mode.
188The server sends verbose debug output to the system
189log, and does not put itself in the background.
190The server also will not fork and will only process one connection.
191This option is only intended for debugging for the server.
da89cf4d 192Multiple -d options increase the debugging level.
94ec8c6b 193Maximum is 3.
da89cf4d 194.It Fl e
195When this option is specified,
196.Nm
197will send the output to the standard error instead of the system log.
bf740959 198.It Fl f Ar configuration_file
4fe2af09 199Specifies the name of the configuration file.
200The default is
2a8a6488 201.Pa /etc/ssh/sshd_config .
bf740959 202.Nm
203refuses to start if there is no configuration file.
204.It Fl g Ar login_grace_time
205Gives the grace time for clients to authenticate themselves (default
ee5e6612 206600 seconds).
4fe2af09 207If the client fails to authenticate the user within
208this many seconds, the server disconnects and exits.
209A value of zero indicates no limit.
bf740959 210.It Fl h Ar host_key_file
0f84fe37 211Specifies a file from which a host key is read.
bf740959 212This option must be given if
213.Nm
214is not run as root (as the normal
0f84fe37 215host key files are normally not readable by anyone but root).
216The default is
2a8a6488 217.Pa /etc/ssh/ssh_host_key
0f84fe37 218for protocol version 1, and
2a8a6488 219.Pa /etc/ssh/ssh_host_rsa_key
0f84fe37 220and
2a8a6488 221.Pa /etc/ssh/ssh_host_dsa_key
0f84fe37 222for protocol version 2.
8abcdba4 223It is possible to have multiple host key files for
da89cf4d 224the different protocol versions and host key algorithms.
bf740959 225.It Fl i
226Specifies that
227.Nm
f54651ce 228is being run from inetd.
bf740959 229.Nm
230is normally not run
231from inetd because it needs to generate the server key before it can
4fe2af09 232respond to the client, and this may take tens of seconds.
233Clients would have to wait too long if the key was regenerated every time.
610cd5c6 234However, with small key sizes (e.g., 512) using
bf740959 235.Nm
236from inetd may
237be feasible.
238.It Fl k Ar key_gen_time
da89cf4d 239Specifies how often the ephemeral protocol version 1 server key is
240regenerated (default 3600 seconds, or one hour).
4fe2af09 241The motivation for regenerating the key fairly
bf740959 242often is that the key is not stored anywhere, and after about an hour,
243it becomes impossible to recover the key for decrypting intercepted
244communications even if the machine is cracked into or physically
4fe2af09 245seized.
246A value of zero indicates that the key will never be regenerated.
2717fa0f 247.It Fl o Ar option
248Can be used to give options in the format used in the configuration file.
249This is useful for specifying options for which there is no separate
250command-line flag.
bf740959 251.It Fl p Ar port
252Specifies the port on which the server listens for connections
253(default 22).
135113a3 254Multiple port options are permitted.
255Ports specified in the configuration file are ignored when a
256command-line port is specified.
bf740959 257.It Fl q
4fe2af09 258Quiet mode.
259Nothing is sent to the system log.
260Normally the beginning,
bf740959 261authentication, and termination of each connection is logged.
f87f09aa 262.It Fl t
263Test mode.
264Only check the validity of the configuration file and sanity of the keys.
184eed6a 265This is useful for updating
f87f09aa 266.Nm
267reliably as configuration options may change.
c345cf9d 268.It Fl u Ar len
269This option is used to specify the size of the field
270in the
271.Li utmp
272structure that holds the remote host name.
273If the resolved host name is longer than
274.Ar len ,
275the dotted decimal value will be used instead.
276This allows hosts with very long host names that
277overflow this field to still be uniquely identified.
278Specifying
279.Fl u0
280indicates that only dotted decimal addresses
281should be put into the
282.Pa utmp
283file.
e675b851 284.Fl u0
285is also be used to prevent
286.Nm
287from making DNS requests unless the authentication
288mechanism or configuration requires it.
289Authentication mechanisms that may require DNS include
290.Cm RhostsAuthentication ,
291.Cm RhostsRSAAuthentication ,
292.Cm HostbasedAuthentication
293and using a
294.Cm from="pattern-list"
295option in a key file.
f464aad8 296Configuration options that require DNS include using a
297USER@HOST pattern in
298.Cm AllowUsers
299or
300.Cm DenyUsers .
8abcdba4 301.It Fl D
302When this option is specified
303.Nm
304will not detach and does not become a daemon.
305This allows easy monitoring of
306.Nm sshd .
48e671d5 307.It Fl 4
308Forces
309.Nm
310to use IPv4 addresses only.
311.It Fl 6
312Forces
313.Nm
314to use IPv6 addresses only.
bf740959 315.El
316.Sh CONFIGURATION FILE
317.Nm
f54651ce 318reads configuration data from
2a8a6488 319.Pa /etc/ssh/sshd_config
bf740959 320(or the file specified with
321.Fl f
4fe2af09 322on the command line).
588df31a 323The file format and configuration options are described in
324.Xr sshd_config 5 .
bf740959 325.Sh LOGIN PROCESS
326When a user successfully logs in,
327.Nm
328does the following:
329.Bl -enum -offset indent
330.It
331If the login is on a tty, and no command has been specified,
f54651ce 332prints last login time and
bf740959 333.Pa /etc/motd
334(unless prevented in the configuration file or by
335.Pa $HOME/.hushlogin ;
336see the
f54651ce 337.Sx FILES
bf740959 338section).
339.It
340If the login is on a tty, records login time.
341.It
342Checks
343.Pa /etc/nologin ;
344if it exists, prints contents and quits
345(unless root).
346.It
347Changes to run with normal user privileges.
348.It
349Sets up basic environment.
350.It
351Reads
352.Pa $HOME/.ssh/environment
353if it exists.
354.It
355Changes to user's home directory.
356.It
357If
358.Pa $HOME/.ssh/rc
359exists, runs it; else if
af98ced9 360.Pa /etc/ssh/sshrc
bf740959 361exists, runs
4fe2af09 362it; otherwise runs xauth.
363The
bf740959 364.Dq rc
365files are given the X11
366authentication protocol and cookie in standard input.
367.It
368Runs user's shell or command.
369.El
370.Sh AUTHORIZED_KEYS FILE FORMAT
bf740959 371.Pa $HOME/.ssh/authorized_keys
96a7b0cc 372is the default file that lists the public keys that are
373permitted for RSA authentication in protocol version 1
374and for public key authentication (PubkeyAuthentication)
da89cf4d 375in protocol version 2.
96a7b0cc 376.Cm AuthorizedKeysFile
c8445989 377may be used to specify an alternative file.
8abcdba4 378.Pp
4fe2af09 379Each line of the file contains one
bf740959 380key (empty lines and lines starting with a
381.Ql #
382are ignored as
4fe2af09 383comments).
8abcdba4 384Each RSA public key consists of the following fields, separated by
4fe2af09 385spaces: options, bits, exponent, modulus, comment.
8abcdba4 386Each protocol version 2 public key consists of:
387options, keytype, base64 encoded key, comment.
388The options fields
389are optional; its presence is determined by whether the line starts
bf740959 390with a number or not (the option field never starts with a number).
8abcdba4 391The bits, exponent, modulus and comment fields give the RSA key for
392protocol version 1; the
bf740959 393comment field is not used for anything (but may be convenient for the
394user to identify the key).
8abcdba4 395For protocol version 2 the keytype is
396.Dq ssh-dss
397or
398.Dq ssh-rsa .
bf740959 399.Pp
400Note that lines in this file are usually several hundred bytes long
4fe2af09 401(because of the size of the RSA key modulus).
402You don't want to type them in; instead, copy the
c0ecc314 403.Pa identity.pub ,
8abcdba4 404.Pa id_dsa.pub
c0ecc314 405or the
406.Pa id_rsa.pub
bf740959 407file and edit it.
408.Pp
3bc822df 409.Nm
410enforces a minimum RSA key modulus size for protocol 1
411and protocol 2 keys of 768 bits.
412.Pp
c345cf9d 413The options (if present) consist of comma-separated option
4fe2af09 414specifications.
415No spaces are permitted, except within double quotes.
54bf768d 416The following option specifications are supported (note
417that option keywords are case-insensitive):
bf740959 418.Bl -tag -width Ds
419.It Cm from="pattern-list"
420Specifies that in addition to RSA authentication, the canonical name
421of the remote host must be present in the comma-separated list of
4fe2af09 422patterns
423.Pf ( Ql *
424and
425.Ql ?
426serve as wildcards).
427The list may also contain
428patterns negated by prefixing them with
429.Ql ! ;
430if the canonical host name matches a negated pattern, the key is not accepted.
431The purpose
bf740959 432of this option is to optionally increase security: RSA authentication
433by itself does not trust the network or name servers or anything (but
434the key); however, if somebody somehow steals the key, the key
4fe2af09 435permits an intruder to log in from anywhere in the world.
436This additional option makes using a stolen key more difficult (name
bf740959 437servers and/or routers would have to be compromised in addition to
438just the key).
439.It Cm command="command"
440Specifies that the command is executed whenever this key is used for
4fe2af09 441authentication.
442The command supplied by the user (if any) is ignored.
9658ecbc 443The command is run on a pty if the client requests a pty;
4fe2af09 444otherwise it is run without a tty.
91789042 445If a 8-bit clean channel is required,
446one must not request a pty or should specify
61e96248 447.Cm no-pty .
4fe2af09 448A quote may be included in the command by quoting it with a backslash.
449This option might be useful
450to restrict certain RSA keys to perform just a specific operation.
451An example might be a key that permits remote backups but nothing else.
d0c832f3 452Note that the client may specify TCP/IP and/or X11
453forwarding unless they are explicitly prohibited.
4cdbc654 454Note that this option applies to shell, command or subsystem execution.
bf740959 455.It Cm environment="NAME=value"
456Specifies that the string is to be added to the environment when
4fe2af09 457logging in using this key.
458Environment variables set this way
459override other default environment values.
460Multiple options of this type are permitted.
2548961d 461This option is automatically disabled if
462.Cm UseLogin
463is enabled.
bf740959 464.It Cm no-port-forwarding
465Forbids TCP/IP forwarding when this key is used for authentication.
4fe2af09 466Any port forward requests by the client will return an error.
467This might be used, e.g., in connection with the
bf740959 468.Cm command
469option.
470.It Cm no-X11-forwarding
471Forbids X11 forwarding when this key is used for authentication.
472Any X11 forward requests by the client will return an error.
473.It Cm no-agent-forwarding
474Forbids authentication agent forwarding when this key is used for
475authentication.
476.It Cm no-pty
477Prevents tty allocation (a request to allocate a pty will fail).
dc504afd 478.It Cm permitopen="host:port"
3730bb22 479Limit local
dc504afd 480.Li ``ssh -L''
b2ae83b8 481port forwarding such that it may only connect to the specified host and
ed787d14 482port.
483IPv6 addresses can be specified with an alternative syntax:
484.Ar host/port .
485Multiple
dc504afd 486.Cm permitopen
3730bb22 487options may be applied separated by commas. No pattern matching is
488performed on the specified hostnames, they must be literal domains or
dc504afd 489addresses.
bf740959 490.El
491.Ss Examples
4921024 33 12121.\|.\|.\|312314325 ylo@foo.bar
493.Pp
494from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23.\|.\|.\|2334 ylo@niksula
495.Pp
496command="dump /home",no-pty,no-port-forwarding 1024 33 23.\|.\|.\|2323 backup.hut.fi
dc504afd 497.Pp
498permitopen="10.2.1.55:80",permitopen="10.2.1.56:25" 1024 33 23.\|.\|.\|2323
bf740959 499.Sh SSH_KNOWN_HOSTS FILE FORMAT
f54651ce 500The
2a8a6488 501.Pa /etc/ssh/ssh_known_hosts ,
f54651ce 502and
f49bc4f7 503.Pa $HOME/.ssh/known_hosts
4fe2af09 504files contain host public keys for all known hosts.
505The global file should
506be prepared by the administrator (optional), and the per-user file is
c345cf9d 507maintained automatically: whenever the user connects from an unknown host
4fe2af09 508its key is added to the per-user file.
bf740959 509.Pp
510Each line in these files contains the following fields: hostnames,
4fe2af09 511bits, exponent, modulus, comment.
512The fields are separated by spaces.
bf740959 513.Pp
514Hostnames is a comma-separated list of patterns ('*' and '?' act as
515wildcards); each pattern in turn is matched against the canonical host
516name (when authenticating a client) or against the user-supplied
4fe2af09 517name (when authenticating a server).
518A pattern may also be preceded by
bf740959 519.Ql !
520to indicate negation: if the host name matches a negated
521pattern, it is not accepted (by that line) even if it matched another
522pattern on the line.
523.Pp
1d1ffb87 524Bits, exponent, and modulus are taken directly from the RSA host key; they
bf740959 525can be obtained, e.g., from
2a8a6488 526.Pa /etc/ssh/ssh_host_key.pub .
bf740959 527The optional comment field continues to the end of the line, and is not used.
528.Pp
529Lines starting with
530.Ql #
531and empty lines are ignored as comments.
532.Pp
533When performing host authentication, authentication is accepted if any
4fe2af09 534matching line has the proper key.
535It is thus permissible (but not
bf740959 536recommended) to have several lines or different host keys for the same
4fe2af09 537names.
538This will inevitably happen when short forms of host names
539from different domains are put in the file.
540It is possible
bf740959 541that the files contain conflicting information; authentication is
542accepted if valid information can be found from either file.
543.Pp
544Note that the lines in these files are typically hundreds of characters
545long, and you definitely don't want to type in the host keys by hand.
546Rather, generate them by a script
f54651ce 547or by taking
2a8a6488 548.Pa /etc/ssh/ssh_host_key.pub
bf740959 549and adding the host names at the front.
550.Ss Examples
da89cf4d 551.Bd -literal
552closenet,.\|.\|.\|,130.233.208.41 1024 37 159.\|.\|.93 closenet.hut.fi
553cvs.openbsd.org,199.185.137.3 ssh-rsa AAAA1234.....=
554.Ed
bf740959 555.Sh FILES
556.Bl -tag -width Ds
2a8a6488 557.It Pa /etc/ssh/sshd_config
bf740959 558Contains configuration data for
559.Nm sshd .
588df31a 560The file format and configuration options are described in
561.Xr sshd_config 5 .
2a8a6488 562.It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key
da89cf4d 563These three files contain the private parts of the host keys.
b8dc87d3 564These files should only be owned by root, readable only by root, and not
bf740959 565accessible to others.
566Note that
567.Nm
568does not start if this file is group/world-accessible.
2a8a6488 569.It Pa /etc/ssh/ssh_host_key.pub, /etc/ssh/ssh_host_dsa_key.pub, /etc/ssh/ssh_host_rsa_key.pub
da89cf4d 570These three files contain the public parts of the host keys.
b8dc87d3 571These files should be world-readable but writable only by
4fe2af09 572root.
b8dc87d3 573Their contents should match the respective private parts.
574These files are not
575really used for anything; they are provided for the convenience of
576the user so their contents can be copied to known hosts files.
577These files are created using
bf740959 578.Xr ssh-keygen 1 .
e2432638 579.It Pa /etc/moduli
c523303b 580Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
75653d3e 581.It Pa /var/empty
582.Xr chroot 2
583directory used by
584.Nm
585during privilege separation in the pre-authentication phase.
586The directory should not contain any files and must be owned by root
587and not group or world-writable.
5f4fdfae 588.It Pa /var/run/sshd.pid
bf740959 589Contains the process ID of the
590.Nm
591listening for connections (if there are several daemons running
592concurrently for different ports, this contains the pid of the one
4fe2af09 593started last).
c345cf9d 594The content of this file is not sensitive; it can be world-readable.
bf740959 595.It Pa $HOME/.ssh/authorized_keys
da89cf4d 596Lists the public keys (RSA or DSA) that can be used to log into the user's account.
1d1ffb87 597This file must be readable by root (which may on some machines imply
598it being world-readable if the user's home directory resides on an NFS
599volume).
600It is recommended that it not be accessible by others.
601The format of this file is described above.
602Users will place the contents of their
96a7b0cc 603.Pa identity.pub ,
1d1ffb87 604.Pa id_dsa.pub
c0ecc314 605and/or
606.Pa id_rsa.pub
1d1ffb87 607files into this file, as described in
608.Xr ssh-keygen 1 .
2a8a6488 609.It Pa "/etc/ssh/ssh_known_hosts" and "$HOME/.ssh/known_hosts"
6a17f9c2 610These files are consulted when using rhosts with RSA host
f49bc4f7 611authentication or protocol version 2 hostbased authentication
612to check the public key of the host.
4fe2af09 613The key must be listed in one of these files to be accepted.
5bbb5681 614The client uses the same files
e91c60f2 615to verify that it is connecting to the correct remote host.
4fe2af09 616These files should be writable only by root/the owner.
2a8a6488 617.Pa /etc/ssh/ssh_known_hosts
bf740959 618should be world-readable, and
619.Pa $HOME/.ssh/known_hosts
620can but need not be world-readable.
621.It Pa /etc/nologin
f54651ce 622If this file exists,
bf740959 623.Nm
4fe2af09 624refuses to let anyone except root log in.
625The contents of the file
bf740959 626are displayed to anyone trying to log in, and non-root connections are
4fe2af09 627refused.
628The file should be world-readable.
bf740959 629.It Pa /etc/hosts.allow, /etc/hosts.deny
5b263aae 630Access controls that should be enforced by tcp-wrappers are defined here.
631Further details are described in
bf740959 632.Xr hosts_access 5 .
633.It Pa $HOME/.rhosts
634This file contains host-username pairs, separated by a space, one per
4fe2af09 635line.
636The given user on the corresponding host is permitted to log in
637without password.
638The same file is used by rlogind and rshd.
bf740959 639The file must
640be writable only by the user; it is recommended that it not be
641accessible by others.
642.Pp
4fe2af09 643If is also possible to use netgroups in the file.
644Either host or user
bf740959 645name may be of the form +@groupname to specify all hosts or all users
646in the group.
647.It Pa $HOME/.shosts
648For ssh,
649this file is exactly the same as for
650.Pa .rhosts .
651However, this file is
652not used by rlogin and rshd, so using this permits access using SSH only.
c345cf9d 653.It Pa /etc/hosts.equiv
bf740959 654This file is used during
655.Pa .rhosts
4fe2af09 656authentication.
657In the simplest form, this file contains host names, one per line.
658Users on
bf740959 659those hosts are permitted to log in without a password, provided they
4fe2af09 660have the same user name on both machines.
661The host name may also be
bf740959 662followed by a user name; such users are permitted to log in as
663.Em any
4fe2af09 664user on this machine (except root).
665Additionally, the syntax
bf740959 666.Dq +@group
4fe2af09 667can be used to specify netgroups.
668Negated entries start with
bf740959 669.Ql \&- .
670.Pp
671If the client host/user is successfully matched in this file, login is
672automatically permitted provided the client and server user names are the
4fe2af09 673same.
674Additionally, successful RSA host authentication is normally required.
675This file must be writable only by root; it is recommended
bf740959 676that it be world-readable.
677.Pp
678.Sy "Warning: It is almost never a good idea to use user names in"
679.Pa hosts.equiv .
680Beware that it really means that the named user(s) can log in as
681.Em anybody ,
682which includes bin, daemon, adm, and other accounts that own critical
4fe2af09 683binaries and directories.
684Using a user name practically grants the user root access.
685The only valid use for user names that I can think
bf740959 686of is in negative entries.
687.Pp
688Note that this warning also applies to rsh/rlogin.
5f4fdfae 689.It Pa /etc/shosts.equiv
bf740959 690This is processed exactly as
691.Pa /etc/hosts.equiv .
692However, this file may be useful in environments that want to run both
693rsh/rlogin and ssh.
694.It Pa $HOME/.ssh/environment
4fe2af09 695This file is read into the environment at login (if it exists).
696It can only contain empty lines, comment lines (that start with
bf740959 697.Ql # ) ,
4fe2af09 698and assignment lines of the form name=value.
699The file should be writable
bf740959 700only by the user; it need not be readable by anyone else.
701.It Pa $HOME/.ssh/rc
702If this file exists, it is run with /bin/sh after reading the
4fe2af09 703environment files but before starting the user's shell or command.
d4c6ddff 704It must not produce any output on stdout; stderr must be used
705instead.
706If X11 forwarding is in use, it will receive the "proto cookie" pair in
707its standard input (and
bf740959 708.Ev DISPLAY
d4c6ddff 709in its environment).
710The script must call
bf740959 711.Xr xauth 1
d4c6ddff 712because
713.Nm
714will not run xauth automatically to add X11 cookies.
bf740959 715.Pp
716The primary purpose of this file is to run any initialization routines
717which may be needed before the user's home directory becomes
718accessible; AFS is a particular example of such an environment.
719.Pp
720This file will probably contain some initialization code followed by
da89cf4d 721something similar to:
722.Bd -literal
d4c6ddff 723if read proto cookie && [ -n "$DISPLAY" ]; then
724 if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
725 # X11UseLocalhost=yes
726 xauth add unix:`echo $DISPLAY |
727 cut -c11-` $proto $cookie
728 else
729 # X11UseLocalhost=no
730 xauth add $DISPLAY $proto $cookie
da89cf4d 731 fi
d4c6ddff 732fi
da89cf4d 733.Ed
bf740959 734.Pp
735If this file does not exist,
2a8a6488 736.Pa /etc/ssh/sshrc
bf740959 737is run, and if that
d4c6ddff 738does not exist either, xauth is used to add the cookie.
bf740959 739.Pp
740This file should be writable only by the user, and need not be
741readable by anyone else.
2a8a6488 742.It Pa /etc/ssh/sshrc
bf740959 743Like
744.Pa $HOME/.ssh/rc .
745This can be used to specify
4fe2af09 746machine-specific login-time initializations globally.
747This file should be writable only by root, and should be world-readable.
089fbbd2 748.El
fa08c86b 749.Sh AUTHORS
7f5c4295 750OpenSSH is a derivative of the original and free
751ssh 1.2.12 release by Tatu Ylonen.
752Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
753Theo de Raadt and Dug Song
754removed many bugs, re-added newer features and
755created OpenSSH.
756Markus Friedl contributed the support for SSH
757protocol versions 1.5 and 2.0.
ce19ff48 758Niels Provos and Markus Friedl contributed support
759for privilege separation.
bf740959 760.Sh SEE ALSO
bf740959 761.Xr scp 1 ,
61e96248 762.Xr sftp 1 ,
bf740959 763.Xr ssh 1 ,
764.Xr ssh-add 1 ,
765.Xr ssh-agent 1 ,
766.Xr ssh-keygen 1 ,
248bad82 767.Xr login.conf 5 ,
768.Xr moduli 5 ,
588df31a 769.Xr sshd_config 5 ,
a5a2da3b 770.Xr sftp-server 8
2cad6cef 771.Rs
772.%A T. Ylonen
773.%A T. Kivinen
774.%A M. Saarinen
775.%A T. Rinne
776.%A S. Lehtinen
777.%T "SSH Protocol Architecture"
17f5e68a 778.%N draft-ietf-secsh-architecture-12.txt
779.%D January 2002
2cad6cef 780.%O work in progress material
781.Re
da89cf4d 782.Rs
783.%A M. Friedl
784.%A N. Provos
785.%A W. A. Simpson
786.%T "Diffie-Hellman Group Exchange for the SSH Transport Layer Protocol"
17f5e68a 787.%N draft-ietf-secsh-dh-group-exchange-02.txt
788.%D January 2002
da89cf4d 789.%O work in progress material
790.Re
This page took 0.318518 seconds and 5 git commands to generate.