]> andersk Git - gssapi-openssh.git/blame - openssh/sshd.8
merged OpenSSH 3.5p1 to trunk
[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.\"
d03f4262 37.\" $OpenBSD: sshd.8,v 1.193 2002/09/24 20:59:44 todd Exp $
3c0ef626 38.Dd September 25, 1999
39.Dt SSHD 8
40.Os
41.Sh NAME
42.Nm sshd
43.Nd OpenSSH SSH daemon
44.Sh SYNOPSIS
45.Nm sshd
46.Op Fl deiqtD46
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
e9702f7d 52.Op Fl o Ar option
3c0ef626 53.Op Fl p Ar port
54.Op Fl u Ar len
55.Sh DESCRIPTION
56.Nm
57(SSH Daemon) is the daemon program for
58.Xr ssh 1 .
59Together these programs replace rlogin and rsh, and
60provide secure encrypted communications between two untrusted hosts
61over an insecure network.
62The programs are intended to be as easy to
63install and use as possible.
64.Pp
65.Nm
66is the daemon that listens for connections from clients.
67It is normally started at boot from
68.Pa /etc/rc .
69It forks a new
70daemon for each incoming connection.
71The forked daemons handle
72key exchange, encryption, authentication, command execution,
73and data exchange.
74This implementation of
75.Nm
76supports both SSH protocol version 1 and 2 simultaneously.
77.Nm
78works as follows.
79.Pp
80.Ss SSH protocol version 1
81.Pp
82Each host has a host-specific RSA key
83(normally 1024 bits) used to identify the host.
84Additionally, when
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
89Whenever a client connects the daemon responds with its public
90host and server keys.
91The client compares the
92RSA host key against its own database to verify that it has not changed.
93The client then generates a 256 bit random number.
94It encrypts this
95random number using both the host key and the server key, and sends
96the encrypted number to the server.
97Both sides then use this
98random number as a session key which is used to encrypt all further
99communications in the session.
100The rest of the session is encrypted
101using a conventional cipher, currently Blowfish or 3DES, with 3DES
102being used by default.
103The client selects the encryption algorithm
104to use from those offered by the server.
105.Pp
106Next, the server and the client enter an authentication dialog.
107The client tries to authenticate itself using
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
117configuration file if desired.
118System security is not improved unless
350391c5 119.Nm rshd ,
120.Nm rlogind ,
3c0ef626 121and
350391c5 122.Xr rexecd
3c0ef626 123are disabled (thus completely disabling
350391c5 124.Xr rlogin
3c0ef626 125and
350391c5 126.Xr rsh
3c0ef626 127into the machine).
128.Pp
129.Ss SSH protocol version 2
130.Pp
131Version 2 works similarly:
132Each host has a host-specific key (RSA or DSA) used to identify the host.
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.
136.Pp
137The rest of the session is encrypted using a symmetric cipher, currently
138128 bit AES, Blowfish, 3DES, CAST128, Arcfour, 192 bit AES, or 256 bit AES.
139The client selects the encryption algorithm
140to use from those offered by the server.
141Additionally, session integrity is provided
142through a cryptographic message authentication code
143(hmac-sha1 or hmac-md5).
144.Pp
145Protocol version 2 provides a public key based
146user (PubkeyAuthentication) or
147client host (HostbasedAuthentication) authentication method,
148conventional password authentication and challenge response based methods.
149.Pp
150.Ss Command execution and data forwarding
151.Pp
152If the client successfully authenticates itself, a dialog for
153preparing the session is entered.
154At this time the client may request
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.
160The sides then enter session mode.
161In this mode, either side may send
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
171file.
172Command-line options override values specified in the
173configuration file.
174.Pp
175.Nm
176rereads its configuration file when it receives a hangup signal,
177.Dv SIGHUP ,
178by executing itself with the name it was started as, i.e.,
179.Pa /usr/sbin/sshd .
180.Pp
181The options are as follows:
182.Bl -tag -width Ds
183.It Fl b Ar bits
184Specifies the number of bits in the ephemeral protocol version 1
185server key (default 768).
186.It Fl d
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.
192Multiple -d options increase the debugging level.
193Maximum is 3.
194.It Fl e
195When this option is specified,
196.Nm
197will send the output to the standard error instead of the system log.
198.It Fl f Ar configuration_file
199Specifies the name of the configuration file.
200The default is
e9702f7d 201.Pa /etc/ssh/sshd_config .
3c0ef626 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
d03f4262 206120 seconds).
3c0ef626 207If the client fails to authenticate the user within
208this many seconds, the server disconnects and exits.
209A value of zero indicates no limit.
210.It Fl h Ar host_key_file
e9702f7d 211Specifies a file from which a host key is read.
3c0ef626 212This option must be given if
213.Nm
214is not run as root (as the normal
e9702f7d 215host key files are normally not readable by anyone but root).
216The default is
217.Pa /etc/ssh/ssh_host_key
218for protocol version 1, and
219.Pa /etc/ssh/ssh_host_rsa_key
220and
221.Pa /etc/ssh/ssh_host_dsa_key
222for protocol version 2.
3c0ef626 223It is possible to have multiple host key files for
224the different protocol versions and host key algorithms.
225.It Fl i
226Specifies that
227.Nm
228is being run from inetd.
229.Nm
230is normally not run
231from inetd because it needs to generate the server key before it can
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.
234However, with small key sizes (e.g., 512) using
235.Nm
236from inetd may
237be feasible.
238.It Fl k Ar key_gen_time
239Specifies how often the ephemeral protocol version 1 server key is
240regenerated (default 3600 seconds, or one hour).
241The motivation for regenerating the key fairly
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
245seized.
246A value of zero indicates that the key will never be regenerated.
e9702f7d 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.
3c0ef626 251.It Fl p Ar port
252Specifies the port on which the server listens for connections
253(default 22).
e9702f7d 254Multiple port options are permitted.
255Ports specified in the configuration file are ignored when a
256command-line port is specified.
3c0ef626 257.It Fl q
258Quiet mode.
259Nothing is sent to the system log.
260Normally the beginning,
261authentication, and termination of each connection is logged.
262.It Fl t
263Test mode.
264Only check the validity of the configuration file and sanity of the keys.
e9702f7d 265This is useful for updating
3c0ef626 266.Nm
267reliably as configuration options may change.
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.
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.
e9702f7d 296Configuration options that require DNS include using a
297USER@HOST pattern in
298.Cm AllowUsers
299or
300.Cm DenyUsers .
3c0ef626 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 .
307.It Fl 4
308Forces
309.Nm
310to use IPv4 addresses only.
311.It Fl 6
312Forces
313.Nm
314to use IPv6 addresses only.
315.El
316.Sh CONFIGURATION FILE
317.Nm
318reads configuration data from
e9702f7d 319.Pa /etc/ssh/sshd_config
3c0ef626 320(or the file specified with
321.Fl f
322on the command line).
44a053a3 323The file format and configuration options are described in
324.Xr sshd_config 5 .
3c0ef626 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,
332prints last login time and
333.Pa /etc/motd
334(unless prevented in the configuration file or by
335.Pa $HOME/.hushlogin ;
336see the
337.Sx FILES
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
d03f4262 353if it exists and users are allowed to change their environment.
354See the
355.Cm PermitUserEnvironment
356option in
357.Xr sshd_config 5 .
3c0ef626 358.It
359Changes to user's home directory.
360.It
361If
362.Pa $HOME/.ssh/rc
363exists, runs it; else if
e9702f7d 364.Pa /etc/ssh/sshrc
3c0ef626 365exists, runs
366it; otherwise runs xauth.
367The
368.Dq rc
369files are given the X11
370authentication protocol and cookie in standard input.
371.It
372Runs user's shell or command.
373.El
374.Sh AUTHORIZED_KEYS FILE FORMAT
375.Pa $HOME/.ssh/authorized_keys
376is the default file that lists the public keys that are
377permitted for RSA authentication in protocol version 1
378and for public key authentication (PubkeyAuthentication)
379in protocol version 2.
380.Cm AuthorizedKeysFile
381may be used to specify an alternative file.
382.Pp
383Each line of the file contains one
384key (empty lines and lines starting with a
385.Ql #
386are ignored as
387comments).
388Each RSA public key consists of the following fields, separated by
389spaces: options, bits, exponent, modulus, comment.
390Each protocol version 2 public key consists of:
391options, keytype, base64 encoded key, comment.
d03f4262 392The options field
393is optional; its presence is determined by whether the line starts
394with a number or not (the options field never starts with a number).
3c0ef626 395The bits, exponent, modulus and comment fields give the RSA key for
396protocol version 1; the
397comment field is not used for anything (but may be convenient for the
398user to identify the key).
399For protocol version 2 the keytype is
400.Dq ssh-dss
401or
402.Dq ssh-rsa .
403.Pp
404Note that lines in this file are usually several hundred bytes long
d03f4262 405(because of the size of the public key encoding).
3c0ef626 406You don't want to type them in; instead, copy the
407.Pa identity.pub ,
408.Pa id_dsa.pub
409or the
410.Pa id_rsa.pub
411file and edit it.
412.Pp
350391c5 413.Nm
414enforces a minimum RSA key modulus size for protocol 1
415and protocol 2 keys of 768 bits.
416.Pp
3c0ef626 417The options (if present) consist of comma-separated option
418specifications.
419No spaces are permitted, except within double quotes.
420The following option specifications are supported (note
421that option keywords are case-insensitive):
422.Bl -tag -width Ds
423.It Cm from="pattern-list"
d03f4262 424Specifies that in addition to public key authentication, the canonical name
3c0ef626 425of the remote host must be present in the comma-separated list of
426patterns
427.Pf ( Ql *
428and
429.Ql ?
430serve as wildcards).
431The list may also contain
432patterns negated by prefixing them with
433.Ql ! ;
434if the canonical host name matches a negated pattern, the key is not accepted.
435The purpose
d03f4262 436of this option is to optionally increase security: public key authentication
3c0ef626 437by itself does not trust the network or name servers or anything (but
438the key); however, if somebody somehow steals the key, the key
439permits an intruder to log in from anywhere in the world.
440This additional option makes using a stolen key more difficult (name
441servers and/or routers would have to be compromised in addition to
442just the key).
443.It Cm command="command"
444Specifies that the command is executed whenever this key is used for
445authentication.
446The command supplied by the user (if any) is ignored.
447The command is run on a pty if the client requests a pty;
448otherwise it is run without a tty.
449If a 8-bit clean channel is required,
450one must not request a pty or should specify
451.Cm no-pty .
452A quote may be included in the command by quoting it with a backslash.
453This option might be useful
d03f4262 454to restrict certain public keys to perform just a specific operation.
3c0ef626 455An example might be a key that permits remote backups but nothing else.
456Note that the client may specify TCP/IP and/or X11
457forwarding unless they are explicitly prohibited.
458Note that this option applies to shell, command or subsystem execution.
459.It Cm environment="NAME=value"
460Specifies that the string is to be added to the environment when
461logging in using this key.
462Environment variables set this way
463override other default environment values.
464Multiple options of this type are permitted.
d03f4262 465Environment processing is disabled by default and is
466controlled via the
467.Cm PermitUserEnvironment
468option.
3c0ef626 469This option is automatically disabled if
470.Cm UseLogin
471is enabled.
472.It Cm no-port-forwarding
473Forbids TCP/IP forwarding when this key is used for authentication.
474Any port forward requests by the client will return an error.
475This might be used, e.g., in connection with the
476.Cm command
477option.
478.It Cm no-X11-forwarding
479Forbids X11 forwarding when this key is used for authentication.
480Any X11 forward requests by the client will return an error.
481.It Cm no-agent-forwarding
482Forbids authentication agent forwarding when this key is used for
483authentication.
484.It Cm no-pty
485Prevents tty allocation (a request to allocate a pty will fail).
486.It Cm permitopen="host:port"
487Limit local
488.Li ``ssh -L''
489port forwarding such that it may only connect to the specified host and
490port.
491IPv6 addresses can be specified with an alternative syntax:
492.Ar host/port .
493Multiple
494.Cm permitopen
495options may be applied separated by commas. No pattern matching is
496performed on the specified hostnames, they must be literal domains or
497addresses.
498.El
499.Ss Examples
5001024 33 12121.\|.\|.\|312314325 ylo@foo.bar
501.Pp
502from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23.\|.\|.\|2334 ylo@niksula
503.Pp
504command="dump /home",no-pty,no-port-forwarding 1024 33 23.\|.\|.\|2323 backup.hut.fi
505.Pp
506permitopen="10.2.1.55:80",permitopen="10.2.1.56:25" 1024 33 23.\|.\|.\|2323
507.Sh SSH_KNOWN_HOSTS FILE FORMAT
508The
e9702f7d 509.Pa /etc/ssh/ssh_known_hosts ,
3c0ef626 510and
511.Pa $HOME/.ssh/known_hosts
512files contain host public keys for all known hosts.
513The global file should
514be prepared by the administrator (optional), and the per-user file is
515maintained automatically: whenever the user connects from an unknown host
516its key is added to the per-user file.
517.Pp
518Each line in these files contains the following fields: hostnames,
519bits, exponent, modulus, comment.
520The fields are separated by spaces.
521.Pp
522Hostnames is a comma-separated list of patterns ('*' and '?' act as
523wildcards); each pattern in turn is matched against the canonical host
524name (when authenticating a client) or against the user-supplied
525name (when authenticating a server).
526A pattern may also be preceded by
527.Ql !
528to indicate negation: if the host name matches a negated
529pattern, it is not accepted (by that line) even if it matched another
530pattern on the line.
531.Pp
532Bits, exponent, and modulus are taken directly from the RSA host key; they
533can be obtained, e.g., from
e9702f7d 534.Pa /etc/ssh/ssh_host_key.pub .
3c0ef626 535The optional comment field continues to the end of the line, and is not used.
536.Pp
537Lines starting with
538.Ql #
539and empty lines are ignored as comments.
540.Pp
541When performing host authentication, authentication is accepted if any
542matching line has the proper key.
543It is thus permissible (but not
544recommended) to have several lines or different host keys for the same
545names.
546This will inevitably happen when short forms of host names
547from different domains are put in the file.
548It is possible
549that the files contain conflicting information; authentication is
550accepted if valid information can be found from either file.
551.Pp
552Note that the lines in these files are typically hundreds of characters
553long, and you definitely don't want to type in the host keys by hand.
554Rather, generate them by a script
555or by taking
e9702f7d 556.Pa /etc/ssh/ssh_host_key.pub
3c0ef626 557and adding the host names at the front.
558.Ss Examples
559.Bd -literal
560closenet,.\|.\|.\|,130.233.208.41 1024 37 159.\|.\|.93 closenet.hut.fi
561cvs.openbsd.org,199.185.137.3 ssh-rsa AAAA1234.....=
562.Ed
563.Sh FILES
564.Bl -tag -width Ds
e9702f7d 565.It Pa /etc/ssh/sshd_config
3c0ef626 566Contains configuration data for
567.Nm sshd .
44a053a3 568The file format and configuration options are described in
569.Xr sshd_config 5 .
e9702f7d 570.It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key
3c0ef626 571These three files contain the private parts of the host keys.
572These files should only be owned by root, readable only by root, and not
573accessible to others.
574Note that
575.Nm
576does not start if this file is group/world-accessible.
e9702f7d 577.It Pa /etc/ssh/ssh_host_key.pub, /etc/ssh/ssh_host_dsa_key.pub, /etc/ssh/ssh_host_rsa_key.pub
3c0ef626 578These three files contain the public parts of the host keys.
579These files should be world-readable but writable only by
580root.
581Their contents should match the respective private parts.
582These files are not
583really used for anything; they are provided for the convenience of
584the user so their contents can be copied to known hosts files.
585These files are created using
586.Xr ssh-keygen 1 .
587.It Pa /etc/moduli
588Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
d03f4262 589The file format is described in
590.Xr moduli 5 .
276b07a3 591.It Pa /var/empty
592.Xr chroot 2
593directory used by
594.Nm
595during privilege separation in the pre-authentication phase.
596The directory should not contain any files and must be owned by root
597and not group or world-writable.
3c0ef626 598.It Pa /var/run/sshd.pid
599Contains the process ID of the
600.Nm
601listening for connections (if there are several daemons running
276b07a3 602concurrently for different ports, this contains the process ID of the one
3c0ef626 603started last).
604The content of this file is not sensitive; it can be world-readable.
605.It Pa $HOME/.ssh/authorized_keys
606Lists the public keys (RSA or DSA) that can be used to log into the user's account.
607This file must be readable by root (which may on some machines imply
608it being world-readable if the user's home directory resides on an NFS
609volume).
610It is recommended that it not be accessible by others.
611The format of this file is described above.
612Users will place the contents of their
613.Pa identity.pub ,
614.Pa id_dsa.pub
615and/or
616.Pa id_rsa.pub
617files into this file, as described in
618.Xr ssh-keygen 1 .
e9702f7d 619.It Pa "/etc/ssh/ssh_known_hosts" and "$HOME/.ssh/known_hosts"
3c0ef626 620These files are consulted when using rhosts with RSA host
621authentication or protocol version 2 hostbased authentication
622to check the public key of the host.
623The key must be listed in one of these files to be accepted.
624The client uses the same files
625to verify that it is connecting to the correct remote host.
626These files should be writable only by root/the owner.
e9702f7d 627.Pa /etc/ssh/ssh_known_hosts
3c0ef626 628should be world-readable, and
629.Pa $HOME/.ssh/known_hosts
630can but need not be world-readable.
631.It Pa /etc/nologin
632If this file exists,
633.Nm
634refuses to let anyone except root log in.
635The contents of the file
636are displayed to anyone trying to log in, and non-root connections are
637refused.
638The file should be world-readable.
639.It Pa /etc/hosts.allow, /etc/hosts.deny
640Access controls that should be enforced by tcp-wrappers are defined here.
641Further details are described in
642.Xr hosts_access 5 .
643.It Pa $HOME/.rhosts
644This file contains host-username pairs, separated by a space, one per
645line.
646The given user on the corresponding host is permitted to log in
647without password.
648The same file is used by rlogind and rshd.
649The file must
650be writable only by the user; it is recommended that it not be
651accessible by others.
652.Pp
653If is also possible to use netgroups in the file.
654Either host or user
655name may be of the form +@groupname to specify all hosts or all users
656in the group.
657.It Pa $HOME/.shosts
658For ssh,
659this file is exactly the same as for
660.Pa .rhosts .
661However, this file is
662not used by rlogin and rshd, so using this permits access using SSH only.
663.It Pa /etc/hosts.equiv
664This file is used during
665.Pa .rhosts
666authentication.
667In the simplest form, this file contains host names, one per line.
668Users on
669those hosts are permitted to log in without a password, provided they
670have the same user name on both machines.
671The host name may also be
672followed by a user name; such users are permitted to log in as
673.Em any
674user on this machine (except root).
675Additionally, the syntax
676.Dq +@group
677can be used to specify netgroups.
678Negated entries start with
679.Ql \&- .
680.Pp
681If the client host/user is successfully matched in this file, login is
682automatically permitted provided the client and server user names are the
683same.
684Additionally, successful RSA host authentication is normally required.
685This file must be writable only by root; it is recommended
686that it be world-readable.
687.Pp
688.Sy "Warning: It is almost never a good idea to use user names in"
689.Pa hosts.equiv .
690Beware that it really means that the named user(s) can log in as
691.Em anybody ,
692which includes bin, daemon, adm, and other accounts that own critical
693binaries and directories.
694Using a user name practically grants the user root access.
695The only valid use for user names that I can think
696of is in negative entries.
697.Pp
698Note that this warning also applies to rsh/rlogin.
699.It Pa /etc/shosts.equiv
700This is processed exactly as
701.Pa /etc/hosts.equiv .
702However, this file may be useful in environments that want to run both
703rsh/rlogin and ssh.
704.It Pa $HOME/.ssh/environment
705This file is read into the environment at login (if it exists).
706It can only contain empty lines, comment lines (that start with
707.Ql # ) ,
708and assignment lines of the form name=value.
709The file should be writable
710only by the user; it need not be readable by anyone else.
d03f4262 711Environment processing is disabled by default and is
712controlled via the
713.Cm PermitUserEnvironment
714option.
3c0ef626 715.It Pa $HOME/.ssh/rc
716If this file exists, it is run with /bin/sh after reading the
717environment files but before starting the user's shell or command.
350391c5 718It must not produce any output on stdout; stderr must be used
719instead.
720If X11 forwarding is in use, it will receive the "proto cookie" pair in
721its standard input (and
3c0ef626 722.Ev DISPLAY
350391c5 723in its environment).
724The script must call
3c0ef626 725.Xr xauth 1
350391c5 726because
727.Nm
728will not run xauth automatically to add X11 cookies.
3c0ef626 729.Pp
730The primary purpose of this file is to run any initialization routines
731which may be needed before the user's home directory becomes
732accessible; AFS is a particular example of such an environment.
733.Pp
734This file will probably contain some initialization code followed by
735something similar to:
736.Bd -literal
350391c5 737if read proto cookie && [ -n "$DISPLAY" ]; then
738 if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
739 # X11UseLocalhost=yes
d03f4262 740 echo add unix:`echo $DISPLAY |
350391c5 741 cut -c11-` $proto $cookie
742 else
743 # X11UseLocalhost=no
d03f4262 744 echo add $DISPLAY $proto $cookie
745 fi | xauth -q -
350391c5 746fi
3c0ef626 747.Ed
748.Pp
749If this file does not exist,
e9702f7d 750.Pa /etc/ssh/sshrc
3c0ef626 751is run, and if that
350391c5 752does not exist either, xauth is used to add the cookie.
3c0ef626 753.Pp
754This file should be writable only by the user, and need not be
755readable by anyone else.
e9702f7d 756.It Pa /etc/ssh/sshrc
3c0ef626 757Like
758.Pa $HOME/.ssh/rc .
759This can be used to specify
760machine-specific login-time initializations globally.
761This file should be writable only by root, and should be world-readable.
762.El
763.Sh AUTHORS
764OpenSSH is a derivative of the original and free
765ssh 1.2.12 release by Tatu Ylonen.
766Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
767Theo de Raadt and Dug Song
768removed many bugs, re-added newer features and
769created OpenSSH.
770Markus Friedl contributed the support for SSH
771protocol versions 1.5 and 2.0.
350391c5 772Niels Provos and Markus Friedl contributed support
773for privilege separation.
3c0ef626 774.Sh SEE ALSO
775.Xr scp 1 ,
776.Xr sftp 1 ,
777.Xr ssh 1 ,
778.Xr ssh-add 1 ,
779.Xr ssh-agent 1 ,
780.Xr ssh-keygen 1 ,
781.Xr login.conf 5 ,
782.Xr moduli 5 ,
44a053a3 783.Xr sshd_config 5 ,
3c0ef626 784.Xr sftp-server 8
785.Rs
786.%A T. Ylonen
787.%A T. Kivinen
788.%A M. Saarinen
789.%A T. Rinne
790.%A S. Lehtinen
791.%T "SSH Protocol Architecture"
350391c5 792.%N draft-ietf-secsh-architecture-12.txt
793.%D January 2002
3c0ef626 794.%O work in progress material
795.Re
796.Rs
797.%A M. Friedl
798.%A N. Provos
799.%A W. A. Simpson
800.%T "Diffie-Hellman Group Exchange for the SSH Transport Layer Protocol"
350391c5 801.%N draft-ietf-secsh-dh-group-exchange-02.txt
802.%D January 2002
3c0ef626 803.%O work in progress material
804.Re
This page took 0.166873 seconds and 5 git commands to generate.