]> andersk Git - gssapi-openssh.git/blame - openssh/sshd.8
Import of OpenSSH 4.9p1
[gssapi-openssh.git] / openssh / sshd.8
CommitLineData
3c0ef626 1.\" -*- nroff -*-
2.\"
3.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5.\" All rights reserved
6.\"
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.\"
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.
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.
25.\"
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.
36.\"
47686178 37.\" $OpenBSD: sshd.8,v 1.240 2008/03/26 21:28:14 djm Exp $
38.Dd $Mdocdate: March 27 2008 $
3c0ef626 39.Dt SSHD 8
40.Os
41.Sh NAME
42.Nm sshd
43.Nd OpenSSH SSH daemon
44.Sh SYNOPSIS
45.Nm sshd
6a9b3198 46.Bk -words
cdd66111 47.Op Fl 46Ddeiqt
3c0ef626 48.Op Fl b Ar bits
49.Op Fl f Ar config_file
50.Op Fl g Ar login_grace_time
51.Op Fl h Ar host_key_file
52.Op Fl k Ar key_gen_time
e9a17296 53.Op Fl o Ar option
3c0ef626 54.Op Fl p Ar port
55.Op Fl u Ar len
6a9b3198 56.Ek
3c0ef626 57.Sh DESCRIPTION
58.Nm
2c06c99b 59(OpenSSH Daemon) is the daemon program for
3c0ef626 60.Xr ssh 1 .
d4487008 61Together these programs replace
62.Xr rlogin 1
63and
64.Xr rsh 1 ,
65and provide secure encrypted communications between two untrusted hosts
3c0ef626 66over an insecure network.
3c0ef626 67.Pp
68.Nm
2c06c99b 69listens for connections from clients.
3c0ef626 70It is normally started at boot from
71.Pa /etc/rc .
72It forks a new
73daemon for each incoming connection.
74The forked daemons handle
75key exchange, encryption, authentication, command execution,
76and data exchange.
3c0ef626 77.Pp
78.Nm
cdd66111 79can be configured using command-line options or a configuration file
80(by default
2c06c99b 81.Xr sshd_config 5 ) ;
82command-line options override values specified in the
3c0ef626 83configuration file.
3c0ef626 84.Nm
85rereads its configuration file when it receives a hangup signal,
86.Dv SIGHUP ,
9108f8d9 87by executing itself with the name and options it was started with, e.g.\&
3c0ef626 88.Pa /usr/sbin/sshd .
89.Pp
90The options are as follows:
91.Bl -tag -width Ds
cdd66111 92.It Fl 4
93Forces
94.Nm
95to use IPv4 addresses only.
96.It Fl 6
97Forces
98.Nm
99to use IPv6 addresses only.
3c0ef626 100.It Fl b Ar bits
101Specifies the number of bits in the ephemeral protocol version 1
102server key (default 768).
cdd66111 103.It Fl D
104When this option is specified,
105.Nm
106will not detach and does not become a daemon.
107This allows easy monitoring of
108.Nm sshd .
3c0ef626 109.It Fl d
110Debug mode.
111The server sends verbose debug output to the system
112log, and does not put itself in the background.
113The server also will not fork and will only process one connection.
114This option is only intended for debugging for the server.
6a9b3198 115Multiple
116.Fl d
117options increase the debugging level.
3c0ef626 118Maximum is 3.
119.It Fl e
120When this option is specified,
121.Nm
122will send the output to the standard error instead of the system log.
d4487008 123.It Fl f Ar config_file
3c0ef626 124Specifies the name of the configuration file.
125The default is
e9a17296 126.Pa /etc/ssh/sshd_config .
3c0ef626 127.Nm
128refuses to start if there is no configuration file.
129.It Fl g Ar login_grace_time
130Gives the grace time for clients to authenticate themselves (default
41b2f314 131120 seconds).
3c0ef626 132If the client fails to authenticate the user within
133this many seconds, the server disconnects and exits.
134A value of zero indicates no limit.
135.It Fl h Ar host_key_file
e9a17296 136Specifies a file from which a host key is read.
3c0ef626 137This option must be given if
138.Nm
139is not run as root (as the normal
e9a17296 140host key files are normally not readable by anyone but root).
141The default is
142.Pa /etc/ssh/ssh_host_key
143for protocol version 1, and
144.Pa /etc/ssh/ssh_host_rsa_key
145and
146.Pa /etc/ssh/ssh_host_dsa_key
147for protocol version 2.
3c0ef626 148It is possible to have multiple host key files for
149the different protocol versions and host key algorithms.
150.It Fl i
151Specifies that
152.Nm
6a9b3198 153is being run from
154.Xr inetd 8 .
3c0ef626 155.Nm
156is normally not run
157from inetd because it needs to generate the server key before it can
158respond to the client, and this may take tens of seconds.
159Clients would have to wait too long if the key was regenerated every time.
9108f8d9 160However, with small key sizes (e.g. 512) using
3c0ef626 161.Nm
162from inetd may
163be feasible.
164.It Fl k Ar key_gen_time
165Specifies how often the ephemeral protocol version 1 server key is
166regenerated (default 3600 seconds, or one hour).
167The motivation for regenerating the key fairly
cdd66111 168often is that the key is not stored anywhere, and after about an hour
3c0ef626 169it becomes impossible to recover the key for decrypting intercepted
170communications even if the machine is cracked into or physically
171seized.
172A value of zero indicates that the key will never be regenerated.
e9a17296 173.It Fl o Ar option
174Can be used to give options in the format used in the configuration file.
175This is useful for specifying options for which there is no separate
176command-line flag.
cdd66111 177For full details of the options, and their values, see
178.Xr sshd_config 5 .
3c0ef626 179.It Fl p Ar port
180Specifies the port on which the server listens for connections
181(default 22).
e9a17296 182Multiple port options are permitted.
2c06c99b 183Ports specified in the configuration file with the
184.Cm Port
185option are ignored when a command-line port is specified.
186Ports specified using the
187.Cm ListenAddress
188option override command-line ports.
3c0ef626 189.It Fl q
190Quiet mode.
191Nothing is sent to the system log.
192Normally the beginning,
193authentication, and termination of each connection is logged.
194.It Fl t
195Test mode.
196Only check the validity of the configuration file and sanity of the keys.
e9a17296 197This is useful for updating
3c0ef626 198.Nm
199reliably as configuration options may change.
200.It Fl u Ar len
201This option is used to specify the size of the field
202in the
203.Li utmp
204structure that holds the remote host name.
205If the resolved host name is longer than
206.Ar len ,
207the dotted decimal value will be used instead.
208This allows hosts with very long host names that
209overflow this field to still be uniquely identified.
210Specifying
211.Fl u0
212indicates that only dotted decimal addresses
213should be put into the
214.Pa utmp
215file.
216.Fl u0
6a9b3198 217may also be used to prevent
3c0ef626 218.Nm
219from making DNS requests unless the authentication
220mechanism or configuration requires it.
221Authentication mechanisms that may require DNS include
3c0ef626 222.Cm RhostsRSAAuthentication ,
2c06c99b 223.Cm HostbasedAuthentication ,
3c0ef626 224and using a
225.Cm from="pattern-list"
226option in a key file.
e9a17296 227Configuration options that require DNS include using a
228USER@HOST pattern in
229.Cm AllowUsers
230or
231.Cm DenyUsers .
3c0ef626 232.El
2c06c99b 233.Sh AUTHENTICATION
234The OpenSSH SSH daemon supports SSH protocols 1 and 2.
235Both protocols are supported by default,
236though this can be changed via the
237.Cm Protocol
238option in
f5799ae1 239.Xr sshd_config 5 .
2c06c99b 240Protocol 2 supports both RSA and DSA keys;
241protocol 1 only supports RSA keys.
242For both protocols,
243each host has a host-specific key,
244normally 2048 bits,
245used to identify the host.
246.Pp
247Forward security for protocol 1 is provided through
248an additional server key,
249normally 768 bits,
250generated when the server starts.
251This key is normally regenerated every hour if it has been used, and
252is never stored on disk.
253Whenever a client connects, the daemon responds with its public
254host and server keys.
255The client compares the
256RSA host key against its own database to verify that it has not changed.
257The client then generates a 256-bit random number.
258It encrypts this
259random number using both the host key and the server key, and sends
260the encrypted number to the server.
261Both sides then use this
262random number as a session key which is used to encrypt all further
263communications in the session.
264The rest of the session is encrypted
265using a conventional cipher, currently Blowfish or 3DES, with 3DES
266being used by default.
267The client selects the encryption algorithm
268to use from those offered by the server.
269.Pp
270For protocol 2,
271forward security is provided through a Diffie-Hellman key agreement.
272This key agreement results in a shared session key.
273The rest of the session is encrypted using a symmetric cipher, currently
274128-bit AES, Blowfish, 3DES, CAST128, Arcfour, 192-bit AES, or 256-bit AES.
275The client selects the encryption algorithm
276to use from those offered by the server.
277Additionally, session integrity is provided
278through a cryptographic message authentication code
d4487008 279(hmac-md5, hmac-sha1, umac-64 or hmac-ripemd160).
2c06c99b 280.Pp
281Finally, the server and the client enter an authentication dialog.
282The client tries to authenticate itself using
283host-based authentication,
284public key authentication,
285challenge-response authentication,
286or password authentication.
287.Pp
288Regardless of the authentication type, the account is checked to
289ensure that it is accessible. An account is not accessible if it is
290locked, listed in
291.Cm DenyUsers
292or its group is listed in
293.Cm DenyGroups
294\&. The definition of a locked account is system dependant. Some platforms
295have their own account database (eg AIX) and some modify the passwd field (
296.Ql \&*LK\&*
297on Solaris and UnixWare,
298.Ql \&*
299on HP-UX, containing
300.Ql Nologin
301on Tru64,
302a leading
303.Ql \&*LOCKED\&*
304on FreeBSD and a leading
d4487008 305.Ql \&!
306on most Linuxes).
307If there is a requirement to disable password authentication
2c06c99b 308for the account while allowing still public-key, then the passwd field
309should be set to something other than these values (eg
310.Ql NP
311or
312.Ql \&*NP\&*
313).
314.Pp
2c06c99b 315If the client successfully authenticates itself, a dialog for
316preparing the session is entered.
317At this time the client may request
318things like allocating a pseudo-tty, forwarding X11 connections,
319forwarding TCP connections, or forwarding the authentication agent
320connection over the secure channel.
321.Pp
9108f8d9 322After this, the client either requests a shell or execution of a command.
2c06c99b 323The sides then enter session mode.
324In this mode, either side may send
325data at any time, and such data is forwarded to/from the shell or
326command on the server side, and the user terminal in the client side.
327.Pp
328When the user program terminates and all forwarded X11 and other
329connections have been closed, the server sends command exit status to
330the client, and both sides exit.
3c0ef626 331.Sh LOGIN PROCESS
332When a user successfully logs in,
333.Nm
334does the following:
335.Bl -enum -offset indent
336.It
337If the login is on a tty, and no command has been specified,
338prints last login time and
339.Pa /etc/motd
340(unless prevented in the configuration file or by
665a873d 341.Pa ~/.hushlogin ;
3c0ef626 342see the
343.Sx FILES
344section).
345.It
346If the login is on a tty, records login time.
347.It
348Checks
349.Pa /etc/nologin ;
350if it exists, prints contents and quits
351(unless root).
352.It
353Changes to run with normal user privileges.
354.It
355Sets up basic environment.
356.It
cdd66111 357Reads the file
665a873d 358.Pa ~/.ssh/environment ,
cdd66111 359if it exists, and users are allowed to change their environment.
41b2f314 360See the
361.Cm PermitUserEnvironment
362option in
363.Xr sshd_config 5 .
3c0ef626 364.It
365Changes to user's home directory.
366.It
367If
665a873d 368.Pa ~/.ssh/rc
3c0ef626 369exists, runs it; else if
e9a17296 370.Pa /etc/ssh/sshrc
3c0ef626 371exists, runs
372it; otherwise runs xauth.
373The
374.Dq rc
375files are given the X11
376authentication protocol and cookie in standard input.
9108f8d9 377See
378.Sx SSHRC ,
379below.
3c0ef626 380.It
381Runs user's shell or command.
382.El
9108f8d9 383.Sh SSHRC
384If the file
385.Pa ~/.ssh/rc
386exists,
387.Xr sh 1
388runs it after reading the
389environment files but before starting the user's shell or command.
390It must not produce any output on stdout; stderr must be used
391instead.
392If X11 forwarding is in use, it will receive the "proto cookie" pair in
393its standard input (and
394.Ev DISPLAY
395in its environment).
396The script must call
397.Xr xauth 1
398because
399.Nm
400will not run xauth automatically to add X11 cookies.
401.Pp
402The primary purpose of this file is to run any initialization routines
403which may be needed before the user's home directory becomes
404accessible; AFS is a particular example of such an environment.
405.Pp
406This file will probably contain some initialization code followed by
407something similar to:
408.Bd -literal -offset 3n
409if read proto cookie && [ -n "$DISPLAY" ]; then
410 if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
411 # X11UseLocalhost=yes
412 echo add unix:`echo $DISPLAY |
413 cut -c11-` $proto $cookie
414 else
415 # X11UseLocalhost=no
416 echo add $DISPLAY $proto $cookie
417 fi | xauth -q -
418fi
419.Ed
420.Pp
421If this file does not exist,
422.Pa /etc/ssh/sshrc
423is run, and if that
424does not exist either, xauth is used to add the cookie.
3c0ef626 425.Sh AUTHORIZED_KEYS FILE FORMAT
3c0ef626 426.Cm AuthorizedKeysFile
9108f8d9 427specifies the file containing public keys for
428public key authentication;
429if none is specified, the default is
430.Pa ~/.ssh/authorized_keys .
3c0ef626 431Each line of the file contains one
432key (empty lines and lines starting with a
433.Ql #
434are ignored as
435comments).
9108f8d9 436Protocol 1 public keys consist of the following space-separated fields:
437options, bits, exponent, modulus, comment.
438Protocol 2 public key consist of:
439options, keytype, base64-encoded key, comment.
440The options field is optional;
441its presence is determined by whether the line starts
41b2f314 442with a number or not (the options field never starts with a number).
9108f8d9 443The bits, exponent, modulus, and comment fields give the RSA key for
3c0ef626 444protocol version 1; the
445comment field is not used for anything (but may be convenient for the
446user to identify the key).
447For protocol version 2 the keytype is
448.Dq ssh-dss
449or
450.Dq ssh-rsa .
451.Pp
452Note that lines in this file are usually several hundred bytes long
996d5e62 453(because of the size of the public key encoding) up to a limit of
4548 kilobytes, which permits DSA keys up to 8 kilobits and RSA
455keys up to 16 kilobits.
3c0ef626 456You don't want to type them in; instead, copy the
457.Pa identity.pub ,
9108f8d9 458.Pa id_dsa.pub ,
3c0ef626 459or the
460.Pa id_rsa.pub
461file and edit it.
462.Pp
700318f3 463.Nm
464enforces a minimum RSA key modulus size for protocol 1
465and protocol 2 keys of 768 bits.
466.Pp
3c0ef626 467The options (if present) consist of comma-separated option
468specifications.
469No spaces are permitted, except within double quotes.
470The following option specifications are supported (note
471that option keywords are case-insensitive):
472.Bl -tag -width Ds
3c0ef626 473.It Cm command="command"
474Specifies that the command is executed whenever this key is used for
475authentication.
476The command supplied by the user (if any) is ignored.
477The command is run on a pty if the client requests a pty;
478otherwise it is run without a tty.
6a9b3198 479If an 8-bit clean channel is required,
3c0ef626 480one must not request a pty or should specify
481.Cm no-pty .
482A quote may be included in the command by quoting it with a backslash.
483This option might be useful
41b2f314 484to restrict certain public keys to perform just a specific operation.
3c0ef626 485An example might be a key that permits remote backups but nothing else.
2c06c99b 486Note that the client may specify TCP and/or X11
3c0ef626 487forwarding unless they are explicitly prohibited.
9108f8d9 488The command originally supplied by the client is available in the
489.Ev SSH_ORIGINAL_COMMAND
490environment variable.
3c0ef626 491Note that this option applies to shell, command or subsystem execution.
492.It Cm environment="NAME=value"
493Specifies that the string is to be added to the environment when
494logging in using this key.
495Environment variables set this way
496override other default environment values.
497Multiple options of this type are permitted.
41b2f314 498Environment processing is disabled by default and is
499controlled via the
500.Cm PermitUserEnvironment
501option.
3c0ef626 502This option is automatically disabled if
503.Cm UseLogin
504is enabled.
9108f8d9 505.It Cm from="pattern-list"
506Specifies that in addition to public key authentication, the canonical name
507of the remote host must be present in the comma-separated list of
508patterns.
509The purpose
510of this option is to optionally increase security: public key authentication
511by itself does not trust the network or name servers or anything (but
512the key); however, if somebody somehow steals the key, the key
513permits an intruder to log in from anywhere in the world.
514This additional option makes using a stolen key more difficult (name
515servers and/or routers would have to be compromised in addition to
516just the key).
517.Pp
518See
519.Sx PATTERNS
520in
521.Xr ssh_config 5
522for more information on patterns.
523.It Cm no-agent-forwarding
524Forbids authentication agent forwarding when this key is used for
525authentication.
3c0ef626 526.It Cm no-port-forwarding
2c06c99b 527Forbids TCP forwarding when this key is used for authentication.
3c0ef626 528Any port forward requests by the client will return an error.
9108f8d9 529This might be used, e.g. in connection with the
3c0ef626 530.Cm command
531option.
9108f8d9 532.It Cm no-pty
533Prevents tty allocation (a request to allocate a pty will fail).
47686178 534.It Cm no-user-rc
535Disables execution of
536.Pa ~/.ssh/rc .
3c0ef626 537.It Cm no-X11-forwarding
538Forbids X11 forwarding when this key is used for authentication.
539Any X11 forward requests by the client will return an error.
3c0ef626 540.It Cm permitopen="host:port"
541Limit local
542.Li ``ssh -L''
543port forwarding such that it may only connect to the specified host and
544port.
545IPv6 addresses can be specified with an alternative syntax:
cdd66111 546.Ar host Ns / Ns Ar port .
3c0ef626 547Multiple
548.Cm permitopen
0fff78ff 549options may be applied separated by commas.
550No pattern matching is performed on the specified hostnames,
551they must be literal domains or addresses.
2c06c99b 552.It Cm tunnel="n"
553Force a
554.Xr tun 4
555device on the server.
556Without this option, the next available device will be used if
557the client requests a tunnel.
3c0ef626 558.El
3c0ef626 559.Pp
9108f8d9 560An example authorized_keys file:
561.Bd -literal -offset 3n
562# Comments allowed at start of line
563ssh-rsa AAAAB3Nza...LiPk== user@example.net
564from="*.sales.example.net,!pc.sales.example.net" ssh-rsa
565AAAAB2...19Q== john@example.net
566command="dump /home",no-pty,no-port-forwarding ssh-dss
567AAAAC3...51R== example.net
568permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss
569AAAAB5...21S==
570tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...==
571jane@example.net
572.Ed
3c0ef626 573.Sh SSH_KNOWN_HOSTS FILE FORMAT
574The
6a9b3198 575.Pa /etc/ssh/ssh_known_hosts
3c0ef626 576and
665a873d 577.Pa ~/.ssh/known_hosts
3c0ef626 578files contain host public keys for all known hosts.
579The global file should
580be prepared by the administrator (optional), and the per-user file is
9108f8d9 581maintained automatically: whenever the user connects from an unknown host,
3c0ef626 582its key is added to the per-user file.
583.Pp
584Each line in these files contains the following fields: hostnames,
585bits, exponent, modulus, comment.
586The fields are separated by spaces.
587.Pp
0fff78ff 588Hostnames is a comma-separated list of patterns
9108f8d9 589.Pf ( Ql *
0fff78ff 590and
591.Ql \&?
592act as
3c0ef626 593wildcards); each pattern in turn is matched against the canonical host
594name (when authenticating a client) or against the user-supplied
595name (when authenticating a server).
596A pattern may also be preceded by
0fff78ff 597.Ql \&!
3c0ef626 598to indicate negation: if the host name matches a negated
599pattern, it is not accepted (by that line) even if it matched another
600pattern on the line.
9108f8d9 601A hostname or address may optionally be enclosed within
602.Ql \&[
603and
604.Ql \&]
605brackets then followed by
606.Ql \&:
607and a non-standard port number.
3c0ef626 608.Pp
996d5e62 609Alternately, hostnames may be stored in a hashed form which hides host names
610and addresses should the file's contents be disclosed.
611Hashed hostnames start with a
612.Ql |
613character.
614Only one hashed hostname may appear on a single line and none of the above
615negation or wildcard operators may be applied.
616.Pp
3c0ef626 617Bits, exponent, and modulus are taken directly from the RSA host key; they
9108f8d9 618can be obtained, for example, from
e9a17296 619.Pa /etc/ssh/ssh_host_key.pub .
3c0ef626 620The optional comment field continues to the end of the line, and is not used.
621.Pp
622Lines starting with
623.Ql #
624and empty lines are ignored as comments.
625.Pp
626When performing host authentication, authentication is accepted if any
627matching line has the proper key.
628It is thus permissible (but not
629recommended) to have several lines or different host keys for the same
630names.
631This will inevitably happen when short forms of host names
632from different domains are put in the file.
633It is possible
634that the files contain conflicting information; authentication is
635accepted if valid information can be found from either file.
636.Pp
637Note that the lines in these files are typically hundreds of characters
638long, and you definitely don't want to type in the host keys by hand.
639Rather, generate them by a script
640or by taking
e9a17296 641.Pa /etc/ssh/ssh_host_key.pub
3c0ef626 642and adding the host names at the front.
9108f8d9 643.Pp
644An example ssh_known_hosts file:
645.Bd -literal -offset 3n
646# Comments allowed at start of line
647closenet,...,192.0.2.53 1024 37 159...93 closenet.example.net
648cvs.example.net,192.0.2.10 ssh-rsa AAAA1234.....=
996d5e62 649# A hashed hostname
650|1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
651AAAA1234.....=
652.Ed
3c0ef626 653.Sh FILES
9108f8d9 654.Bl -tag -width Ds -compact
655.It ~/.hushlogin
996d5e62 656This file is used to suppress printing the last login time and
657.Pa /etc/motd ,
658if
659.Cm PrintLastLog
660and
661.Cm PrintMotd ,
662respectively,
663are enabled.
664It does not suppress printing of the banner specified by
665.Cm Banner .
9108f8d9 666.Pp
667.It ~/.rhosts
668This file is used for host-based authentication (see
669.Xr ssh 1
670for more information).
671On some machines this file may need to be
672world-readable if the user's home directory is on an NFS partition,
673because
3c0ef626 674.Nm
9108f8d9 675reads it as root.
676Additionally, this file must be owned by the user,
677and must not have write permissions for anyone else.
678The recommended
679permission for most machines is read/write for the user, and not
3c0ef626 680accessible by others.
681.Pp
9108f8d9 682.It ~/.shosts
683This file is used in exactly the same way as
684.Pa .rhosts ,
685but allows host-based authentication without permitting login with
686rlogin/rsh.
687.Pp
47686178 688.It ~/.ssh/
689This directory is the default location for all user-specific configuration
690and authentication information.
691There is no general requirement to keep the entire contents of this directory
692secret, but the recommended permissions are read/write/execute for the user,
693and not accessible by others.
694.Pp
9108f8d9 695.It ~/.ssh/authorized_keys
696Lists the public keys (RSA/DSA) that can be used for logging in as this user.
697The format of this file is described above.
698The content of the file is not highly sensitive, but the recommended
699permissions are read/write for the user, and not accessible by others.
700.Pp
701If this file, the
702.Pa ~/.ssh
703directory, or the user's home directory are writable
704by other users, then the file could be modified or replaced by unauthorized
705users.
706In this case,
707.Nm
708will not allow it to be used unless the
709.Cm StrictModes
710option has been set to
711.Dq no .
712The recommended permissions can be set by executing
713.Dq chmod go-w ~/ ~/.ssh ~/.ssh/authorized_keys .
714.Pp
715.It ~/.ssh/environment
3c0ef626 716This file is read into the environment at login (if it exists).
717It can only contain empty lines, comment lines (that start with
718.Ql # ) ,
719and assignment lines of the form name=value.
720The file should be writable
721only by the user; it need not be readable by anyone else.
41b2f314 722Environment processing is disabled by default and is
723controlled via the
724.Cm PermitUserEnvironment
725option.
9108f8d9 726.Pp
727.It ~/.ssh/known_hosts
728Contains a list of host keys for all hosts the user has logged into
729that are not already in the systemwide list of known host keys.
730The format of this file is described above.
731This file should be writable only by root/the owner and
732can, but need not be, world-readable.
733.Pp
734.It ~/.ssh/rc
735Contains initialization routines to be run before
736the user's home directory becomes accessible.
737This file should be writable only by the user, and need not be
738readable by anyone else.
739.Pp
740.It /etc/hosts.allow
741.It /etc/hosts.deny
742Access controls that should be enforced by tcp-wrappers are defined here.
743Further details are described in
744.Xr hosts_access 5 .
745.Pp
746.It /etc/hosts.equiv
747This file is for host-based authentication (see
748.Xr ssh 1 ) .
749It should only be writable by root.
750.Pp
751.It /etc/moduli
752Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
753The file format is described in
754.Xr moduli 5 .
755.Pp
756.It /etc/motd
757See
758.Xr motd 5 .
759.Pp
760.It /etc/nologin
761If this file exists,
700318f3 762.Nm
9108f8d9 763refuses to let anyone except root log in.
764The contents of the file
765are displayed to anyone trying to log in, and non-root connections are
766refused.
767The file should be world-readable.
3c0ef626 768.Pp
9108f8d9 769.It /etc/shosts.equiv
770This file is used in exactly the same way as
771.Pa hosts.equiv ,
772but allows host-based authentication without permitting login with
773rlogin/rsh.
774.Pp
9108f8d9 775.It /etc/ssh/ssh_host_key
776.It /etc/ssh/ssh_host_dsa_key
777.It /etc/ssh/ssh_host_rsa_key
778These three files contain the private parts of the host keys.
779These files should only be owned by root, readable only by root, and not
780accessible to others.
781Note that
782.Nm
783does not start if these files are group/world-accessible.
3c0ef626 784.Pp
9108f8d9 785.It /etc/ssh/ssh_host_key.pub
786.It /etc/ssh/ssh_host_dsa_key.pub
787.It /etc/ssh/ssh_host_rsa_key.pub
788These three files contain the public parts of the host keys.
789These files should be world-readable but writable only by
790root.
791Their contents should match the respective private parts.
792These files are not
793really used for anything; they are provided for the convenience of
794the user so their contents can be copied to known hosts files.
795These files are created using
796.Xr ssh-keygen 1 .
3c0ef626 797.Pp
d4487008 798.It /etc/ssh/ssh_known_hosts
799Systemwide list of known host keys.
800This file should be prepared by the
801system administrator to contain the public host keys of all machines in the
802organization.
803The format of this file is described above.
804This file should be writable only by root/the owner and
805should be world-readable.
806.Pp
9108f8d9 807.It /etc/ssh/sshd_config
808Contains configuration data for
809.Nm sshd .
810The file format and configuration options are described in
811.Xr sshd_config 5 .
812.Pp
813.It /etc/ssh/sshrc
814Similar to
815.Pa ~/.ssh/rc ,
816it can be used to specify
3c0ef626 817machine-specific login-time initializations globally.
818This file should be writable only by root, and should be world-readable.
9108f8d9 819.Pp
820.It /var/empty
821.Xr chroot 2
822directory used by
823.Nm
824during privilege separation in the pre-authentication phase.
825The directory should not contain any files and must be owned by root
826and not group or world-writable.
827.Pp
828.It /var/run/sshd.pid
829Contains the process ID of the
830.Nm
831listening for connections (if there are several daemons running
832concurrently for different ports, this contains the process ID of the one
833started last).
834The content of this file is not sensitive; it can be world-readable.
3c0ef626 835.El
3c0ef626 836.Sh SEE ALSO
837.Xr scp 1 ,
838.Xr sftp 1 ,
839.Xr ssh 1 ,
840.Xr ssh-add 1 ,
841.Xr ssh-agent 1 ,
842.Xr ssh-keygen 1 ,
d4487008 843.Xr ssh-keyscan 1 ,
cdd66111 844.Xr chroot 2 ,
845.Xr hosts_access 5 ,
3c0ef626 846.Xr login.conf 5 ,
847.Xr moduli 5 ,
f5799ae1 848.Xr sshd_config 5 ,
cdd66111 849.Xr inetd 8 ,
3c0ef626 850.Xr sftp-server 8
0fff78ff 851.Sh AUTHORS
852OpenSSH is a derivative of the original and free
853ssh 1.2.12 release by Tatu Ylonen.
854Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
855Theo de Raadt and Dug Song
856removed many bugs, re-added newer features and
857created OpenSSH.
858Markus Friedl contributed the support for SSH
859protocol versions 1.5 and 2.0.
860Niels Provos and Markus Friedl contributed support
861for privilege separation.
9108f8d9 862.Sh CAVEATS
863System security is not improved unless
864.Nm rshd ,
865.Nm rlogind ,
866and
867.Nm rexecd
868are disabled (thus completely disabling
869.Xr rlogin
870and
871.Xr rsh
872into the machine).
This page took 0.550072 seconds and 5 git commands to generate.