]> andersk Git - gssapi-openssh.git/blame - openssh/sshd.8
Import of OpenSSH 3.3p1
[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.\"
f5799ae1 37.\" $OpenBSD: sshd.8,v 1.184 2002/06/20 19:56:07 stevesk 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
e9a17296 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
700318f3 119.Nm rshd ,
120.Nm rlogind ,
3c0ef626 121and
700318f3 122.Xr rexecd
3c0ef626 123are disabled (thus completely disabling
700318f3 124.Xr rlogin
3c0ef626 125and
700318f3 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
e9a17296 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
206600 seconds).
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
e9a17296 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
e9a17296 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.
e9a17296 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).
e9a17296 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.
e9a17296 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.
e9a17296 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
e9a17296 319.Pa /etc/ssh/sshd_config
3c0ef626 320(or the file specified with
321.Fl f
322on the command line).
f5799ae1 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
353if it exists.
354.It
355Changes to user's home directory.
356.It
357If
358.Pa $HOME/.ssh/rc
359exists, runs it; else if
e9a17296 360.Pa /etc/ssh/sshrc
3c0ef626 361exists, runs
362it; otherwise runs xauth.
363The
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
371.Pa $HOME/.ssh/authorized_keys
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)
375in protocol version 2.
376.Cm AuthorizedKeysFile
377may be used to specify an alternative file.
378.Pp
379Each line of the file contains one
380key (empty lines and lines starting with a
381.Ql #
382are ignored as
383comments).
384Each RSA public key consists of the following fields, separated by
385spaces: options, bits, exponent, modulus, comment.
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
390with a number or not (the option field never starts with a number).
391The bits, exponent, modulus and comment fields give the RSA key for
392protocol version 1; the
393comment field is not used for anything (but may be convenient for the
394user to identify the key).
395For protocol version 2 the keytype is
396.Dq ssh-dss
397or
398.Dq ssh-rsa .
399.Pp
400Note that lines in this file are usually several hundred bytes long
401(because of the size of the RSA key modulus).
402You don't want to type them in; instead, copy the
403.Pa identity.pub ,
404.Pa id_dsa.pub
405or the
406.Pa id_rsa.pub
407file and edit it.
408.Pp
700318f3 409.Nm
410enforces a minimum RSA key modulus size for protocol 1
411and protocol 2 keys of 768 bits.
412.Pp
3c0ef626 413The options (if present) consist of comma-separated option
414specifications.
415No spaces are permitted, except within double quotes.
416The following option specifications are supported (note
417that option keywords are case-insensitive):
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
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
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
435permits an intruder to log in from anywhere in the world.
436This additional option makes using a stolen key more difficult (name
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
441authentication.
442The command supplied by the user (if any) is ignored.
443The command is run on a pty if the client requests a pty;
444otherwise it is run without a tty.
445If a 8-bit clean channel is required,
446one must not request a pty or should specify
447.Cm no-pty .
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.
452Note that the client may specify TCP/IP and/or X11
453forwarding unless they are explicitly prohibited.
454Note that this option applies to shell, command or subsystem execution.
455.It Cm environment="NAME=value"
456Specifies that the string is to be added to the environment when
457logging in using this key.
458Environment variables set this way
459override other default environment values.
460Multiple options of this type are permitted.
461This option is automatically disabled if
462.Cm UseLogin
463is enabled.
464.It Cm no-port-forwarding
465Forbids TCP/IP forwarding when this key is used for authentication.
466Any port forward requests by the client will return an error.
467This might be used, e.g., in connection with the
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).
478.It Cm permitopen="host:port"
479Limit local
480.Li ``ssh -L''
481port forwarding such that it may only connect to the specified host and
482port.
483IPv6 addresses can be specified with an alternative syntax:
484.Ar host/port .
485Multiple
486.Cm permitopen
487options may be applied separated by commas. No pattern matching is
488performed on the specified hostnames, they must be literal domains or
489addresses.
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
497.Pp
498permitopen="10.2.1.55:80",permitopen="10.2.1.56:25" 1024 33 23.\|.\|.\|2323
499.Sh SSH_KNOWN_HOSTS FILE FORMAT
500The
e9a17296 501.Pa /etc/ssh/ssh_known_hosts ,
3c0ef626 502and
503.Pa $HOME/.ssh/known_hosts
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
507maintained automatically: whenever the user connects from an unknown host
508its key is added to the per-user file.
509.Pp
510Each line in these files contains the following fields: hostnames,
511bits, exponent, modulus, comment.
512The fields are separated by spaces.
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
517name (when authenticating a server).
518A pattern may also be preceded by
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
524Bits, exponent, and modulus are taken directly from the RSA host key; they
525can be obtained, e.g., from
e9a17296 526.Pa /etc/ssh/ssh_host_key.pub .
3c0ef626 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
534matching line has the proper key.
535It is thus permissible (but not
536recommended) to have several lines or different host keys for the same
537names.
538This will inevitably happen when short forms of host names
539from different domains are put in the file.
540It is possible
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
547or by taking
e9a17296 548.Pa /etc/ssh/ssh_host_key.pub
3c0ef626 549and adding the host names at the front.
550.Ss Examples
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
555.Sh FILES
556.Bl -tag -width Ds
e9a17296 557.It Pa /etc/ssh/sshd_config
3c0ef626 558Contains configuration data for
559.Nm sshd .
f5799ae1 560The file format and configuration options are described in
561.Xr sshd_config 5 .
e9a17296 562.It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key
3c0ef626 563These three files contain the private parts of the host keys.
564These files should only be owned by root, readable only by root, and not
565accessible to others.
566Note that
567.Nm
568does not start if this file is group/world-accessible.
e9a17296 569.It Pa /etc/ssh/ssh_host_key.pub, /etc/ssh/ssh_host_dsa_key.pub, /etc/ssh/ssh_host_rsa_key.pub
3c0ef626 570These three files contain the public parts of the host keys.
571These files should be world-readable but writable only by
572root.
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
578.Xr ssh-keygen 1 .
579.It Pa /etc/moduli
580Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
581.It Pa /var/run/sshd.pid
582Contains the process ID of the
583.Nm
584listening for connections (if there are several daemons running
585concurrently for different ports, this contains the pid of the one
586started last).
587The content of this file is not sensitive; it can be world-readable.
588.It Pa $HOME/.ssh/authorized_keys
589Lists the public keys (RSA or DSA) that can be used to log into the user's account.
590This file must be readable by root (which may on some machines imply
591it being world-readable if the user's home directory resides on an NFS
592volume).
593It is recommended that it not be accessible by others.
594The format of this file is described above.
595Users will place the contents of their
596.Pa identity.pub ,
597.Pa id_dsa.pub
598and/or
599.Pa id_rsa.pub
600files into this file, as described in
601.Xr ssh-keygen 1 .
e9a17296 602.It Pa "/etc/ssh/ssh_known_hosts" and "$HOME/.ssh/known_hosts"
3c0ef626 603These files are consulted when using rhosts with RSA host
604authentication or protocol version 2 hostbased authentication
605to check the public key of the host.
606The key must be listed in one of these files to be accepted.
607The client uses the same files
608to verify that it is connecting to the correct remote host.
609These files should be writable only by root/the owner.
e9a17296 610.Pa /etc/ssh/ssh_known_hosts
3c0ef626 611should be world-readable, and
612.Pa $HOME/.ssh/known_hosts
613can but need not be world-readable.
614.It Pa /etc/nologin
615If this file exists,
616.Nm
617refuses to let anyone except root log in.
618The contents of the file
619are displayed to anyone trying to log in, and non-root connections are
620refused.
621The file should be world-readable.
622.It Pa /etc/hosts.allow, /etc/hosts.deny
623Access controls that should be enforced by tcp-wrappers are defined here.
624Further details are described in
625.Xr hosts_access 5 .
626.It Pa $HOME/.rhosts
627This file contains host-username pairs, separated by a space, one per
628line.
629The given user on the corresponding host is permitted to log in
630without password.
631The same file is used by rlogind and rshd.
632The file must
633be writable only by the user; it is recommended that it not be
634accessible by others.
635.Pp
636If is also possible to use netgroups in the file.
637Either host or user
638name may be of the form +@groupname to specify all hosts or all users
639in the group.
640.It Pa $HOME/.shosts
641For ssh,
642this file is exactly the same as for
643.Pa .rhosts .
644However, this file is
645not used by rlogin and rshd, so using this permits access using SSH only.
646.It Pa /etc/hosts.equiv
647This file is used during
648.Pa .rhosts
649authentication.
650In the simplest form, this file contains host names, one per line.
651Users on
652those hosts are permitted to log in without a password, provided they
653have the same user name on both machines.
654The host name may also be
655followed by a user name; such users are permitted to log in as
656.Em any
657user on this machine (except root).
658Additionally, the syntax
659.Dq +@group
660can be used to specify netgroups.
661Negated entries start with
662.Ql \&- .
663.Pp
664If the client host/user is successfully matched in this file, login is
665automatically permitted provided the client and server user names are the
666same.
667Additionally, successful RSA host authentication is normally required.
668This file must be writable only by root; it is recommended
669that it be world-readable.
670.Pp
671.Sy "Warning: It is almost never a good idea to use user names in"
672.Pa hosts.equiv .
673Beware that it really means that the named user(s) can log in as
674.Em anybody ,
675which includes bin, daemon, adm, and other accounts that own critical
676binaries and directories.
677Using a user name practically grants the user root access.
678The only valid use for user names that I can think
679of is in negative entries.
680.Pp
681Note that this warning also applies to rsh/rlogin.
682.It Pa /etc/shosts.equiv
683This is processed exactly as
684.Pa /etc/hosts.equiv .
685However, this file may be useful in environments that want to run both
686rsh/rlogin and ssh.
687.It Pa $HOME/.ssh/environment
688This file is read into the environment at login (if it exists).
689It can only contain empty lines, comment lines (that start with
690.Ql # ) ,
691and assignment lines of the form name=value.
692The file should be writable
693only by the user; it need not be readable by anyone else.
694.It Pa $HOME/.ssh/rc
695If this file exists, it is run with /bin/sh after reading the
696environment files but before starting the user's shell or command.
700318f3 697It must not produce any output on stdout; stderr must be used
698instead.
699If X11 forwarding is in use, it will receive the "proto cookie" pair in
700its standard input (and
3c0ef626 701.Ev DISPLAY
700318f3 702in its environment).
703The script must call
3c0ef626 704.Xr xauth 1
700318f3 705because
706.Nm
707will not run xauth automatically to add X11 cookies.
3c0ef626 708.Pp
709The primary purpose of this file is to run any initialization routines
710which may be needed before the user's home directory becomes
711accessible; AFS is a particular example of such an environment.
712.Pp
713This file will probably contain some initialization code followed by
714something similar to:
715.Bd -literal
700318f3 716if read proto cookie && [ -n "$DISPLAY" ]; then
717 if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
718 # X11UseLocalhost=yes
719 xauth add unix:`echo $DISPLAY |
720 cut -c11-` $proto $cookie
721 else
722 # X11UseLocalhost=no
723 xauth add $DISPLAY $proto $cookie
3c0ef626 724 fi
700318f3 725fi
3c0ef626 726.Ed
727.Pp
728If this file does not exist,
e9a17296 729.Pa /etc/ssh/sshrc
3c0ef626 730is run, and if that
700318f3 731does not exist either, xauth is used to add the cookie.
3c0ef626 732.Pp
733This file should be writable only by the user, and need not be
734readable by anyone else.
e9a17296 735.It Pa /etc/ssh/sshrc
3c0ef626 736Like
737.Pa $HOME/.ssh/rc .
738This can be used to specify
739machine-specific login-time initializations globally.
740This file should be writable only by root, and should be world-readable.
741.El
742.Sh AUTHORS
743OpenSSH is a derivative of the original and free
744ssh 1.2.12 release by Tatu Ylonen.
745Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
746Theo de Raadt and Dug Song
747removed many bugs, re-added newer features and
748created OpenSSH.
749Markus Friedl contributed the support for SSH
750protocol versions 1.5 and 2.0.
700318f3 751Niels Provos and Markus Friedl contributed support
752for privilege separation.
3c0ef626 753.Sh SEE ALSO
754.Xr scp 1 ,
755.Xr sftp 1 ,
756.Xr ssh 1 ,
757.Xr ssh-add 1 ,
758.Xr ssh-agent 1 ,
759.Xr ssh-keygen 1 ,
760.Xr login.conf 5 ,
761.Xr moduli 5 ,
f5799ae1 762.Xr sshd_config 5 ,
3c0ef626 763.Xr sftp-server 8
764.Rs
765.%A T. Ylonen
766.%A T. Kivinen
767.%A M. Saarinen
768.%A T. Rinne
769.%A S. Lehtinen
770.%T "SSH Protocol Architecture"
700318f3 771.%N draft-ietf-secsh-architecture-12.txt
772.%D January 2002
3c0ef626 773.%O work in progress material
774.Re
775.Rs
776.%A M. Friedl
777.%A N. Provos
778.%A W. A. Simpson
779.%T "Diffie-Hellman Group Exchange for the SSH Transport Layer Protocol"
700318f3 780.%N draft-ietf-secsh-dh-group-exchange-02.txt
781.%D January 2002
3c0ef626 782.%O work in progress material
783.Re
This page took 0.157408 seconds and 5 git commands to generate.