3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 .\" All rights reserved
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".
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.
17 .\" Redistribution and use in source and binary forms, with or without
18 .\" modification, are permitted provided that the following conditions
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.
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.
37 .\" $OpenBSD: sshd.8,v 1.109 2001/04/02 14:15:31 stevesk Exp $
38 .Dd September 25, 1999
43 .Nd OpenSSH ssh daemon
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
54 .Op Fl V Ar client_protocol_id
57 (SSH Daemon) is the daemon program for
59 Together these programs replace rlogin and rsh, and
60 provide secure encrypted communications between two untrusted hosts
61 over an insecure network.
62 The programs are intended to be as easy to
63 install and use as possible.
66 is the daemon that listens for connections from clients.
67 It is normally started at boot from
70 daemon for each incoming connection.
71 The forked daemons handle
72 key exchange, encryption, authentication, command execution,
74 This implementation of
76 supports both SSH protocol version 1 and 2 simultaneously.
80 .Ss SSH protocol version 1
82 Each host has a host-specific RSA key
83 (normally 1024 bits) used to identify the host.
85 the daemon starts, it generates a server RSA key (normally 768 bits).
86 This key is normally regenerated every hour if it has been used, and
87 is never stored on disk.
89 Whenever a client connects the daemon responds with its public
91 The client compares the
92 RSA host key against its own database to verify that it has not changed.
93 The client then generates a 256 bit random number.
95 random number using both the host key and the server key, and sends
96 the encrypted number to the server.
97 Both sides then use this
98 random number as a session key which is used to encrypt all further
99 communications in the session.
100 The rest of the session is encrypted
101 using a conventional cipher, currently Blowfish or 3DES, with 3DES
102 being used by default.
103 The client selects the encryption algorithm
104 to use from those offered by the server.
106 Next, the server and the client enter an authentication dialog.
107 The client tries to authenticate itself using
111 authentication combined with RSA host
112 authentication, RSA challenge-response authentication, or password
113 based authentication.
115 Rhosts authentication is normally disabled
116 because it is fundamentally insecure, but can be enabled in the server
117 configuration file if desired.
118 System security is not improved unless
124 are disabled (thus completely disabling
130 .Ss SSH protocol version 2
132 Version 2 works similarly:
133 Each host has a host-specific DSA key used to identify the host.
134 However, when the daemon starts, it does not generate a server key.
135 Forward security is provided through a Diffie-Hellman key agreement.
136 This key agreement results in a shared session key.
137 The rest of the session is encrypted using a symmetric cipher, currently
138 Blowfish, 3DES, CAST128, Arcfour, 128 bit AES, or 256 bit AES.
139 The client selects the encryption algorithm
140 to use from those offered by the server.
141 Additionally, session integrity is provided
142 through a cryptographic message authentication code
143 (hmac-sha1 or hmac-md5).
145 Protocol version 2 provides a public key based
146 user authentication method (PubkeyAuthentication)
147 and conventional password authentication.
149 .Ss Command execution and data forwarding
151 If the client successfully authenticates itself, a dialog for
152 preparing the session is entered.
153 At this time the client may request
154 things like allocating a pseudo-tty, forwarding X11 connections,
155 forwarding TCP/IP connections, or forwarding the authentication agent
156 connection over the secure channel.
158 Finally, the client either requests a shell or execution of a command.
159 The sides then enter session mode.
160 In this mode, either side may send
161 data at any time, and such data is forwarded to/from the shell or
162 command on the server side, and the user terminal in the client side.
164 When the user program terminates and all forwarded X11 and other
165 connections have been closed, the server sends command exit status to
166 the client, and both sides exit.
169 can be configured using command-line options or a configuration
171 Command-line options override values specified in the
175 rereads its configuration file when it receives a hangup signal,
177 by executing itself with the name it was started as, ie.
180 The options are as follows:
183 Specifies the number of bits in the server key (default 768).
187 The server sends verbose debug output to the system
188 log, and does not put itself in the background.
189 The server also will not fork and will only process one connection.
190 This option is only intended for debugging for the server.
191 Multiple -d options increases the debugging level.
193 .It Fl f Ar configuration_file
194 Specifies the name of the configuration file.
196 .Pa /etc/sshd_config .
198 refuses to start if there is no configuration file.
199 .It Fl g Ar login_grace_time
200 Gives the grace time for clients to authenticate themselves (default
202 If the client fails to authenticate the user within
203 this many seconds, the server disconnects and exits.
204 A value of zero indicates no limit.
205 .It Fl h Ar host_key_file
206 Specifies the file from which the host key is read (default
207 .Pa /etc/ssh_host_key ) .
208 This option must be given if
210 is not run as root (as the normal
211 host file is normally not readable by anyone but root).
212 It is possible to have multiple host key files for
213 the different protocol versions.
217 is being run from inetd.
220 from inetd because it needs to generate the server key before it can
221 respond to the client, and this may take tens of seconds.
222 Clients would have to wait too long if the key was regenerated every time.
223 However, with small key sizes (e.g., 512) using
227 .It Fl k Ar key_gen_time
228 Specifies how often the server key is regenerated (default 3600
229 seconds, or one hour).
230 The motivation for regenerating the key fairly
231 often is that the key is not stored anywhere, and after about an hour,
232 it becomes impossible to recover the key for decrypting intercepted
233 communications even if the machine is cracked into or physically
235 A value of zero indicates that the key will never be regenerated.
237 Specifies the port on which the server listens for connections
241 Nothing is sent to the system log.
242 Normally the beginning,
243 authentication, and termination of each connection is logged.
245 This option is used to specify the size of the field
248 structure that holds the remote host name.
249 If the resolved host name is longer than
251 the dotted decimal value will be used instead.
252 This allows hosts with very long host names that
253 overflow this field to still be uniquely identified.
256 indicates that only dotted decimal addresses
257 should be put into the
261 When this option is specified
263 will not detach and does not become a daemon.
264 This allows easy monitoring of
266 .It Fl V Ar client_protocol_id
267 SSH-2 compatibility mode.
268 When this option is specified
270 assumes the client has sent the supplied version string
272 Protocol Version Identification Exchange.
273 This option is not intended to be called directly.
277 to use IPv4 addresses only.
281 to use IPv6 addresses only.
283 .Sh CONFIGURATION FILE
285 reads configuration data from
287 (or the file specified with
289 on the command line).
290 The file contains keyword-value pairs, one per line.
293 and empty lines are interpreted as comments.
295 The following keywords are possible.
297 .It Cm AFSTokenPassing
298 Specifies whether an AFS token may be forwarded to the server.
302 This keyword can be followed by a list of group names, separated
304 If specified, login is allowed only for users whose primary
305 group or supplementary group list matches one of the patterns.
310 wildcards in the patterns.
311 Only group names are valid; a numerical group ID isn't recognized.
312 By default login is allowed regardless of the group list.
314 .It Cm AllowTcpForwarding
315 Specifies whether TCP forwarding is permitted.
318 Note that disabling TCP forwarding does not improve security unless
319 users are also denied shell access, as they can always install their
323 This keyword can be followed by a list of user names, separated
325 If specified, login is allowed only for users names that
326 match one of the patterns.
331 wildcards in the patterns.
332 Only user names are valid; a numerical user ID isn't recognized.
333 By default login is allowed regardless of the user name.
336 In some jurisdictions, sending a warning message before authentication
337 may be relevant for getting legal protection.
338 The contents of the specified file are sent to the remote user before
339 authentication is allowed.
340 This option is only available for protocol version 2.
342 .It Cm ChallengeResponseAuthentication
345 authentication is allowed.
346 Currently there is only support for
352 Specifies the ciphers allowed for protocol version 2.
353 Multiple ciphers must be comma-separated.
355 .Dq aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour.
359 should check for new mail for interactive logins.
363 This keyword can be followed by a number of group names, separated
365 Users whose primary group or supplementary group list matches
366 one of the patterns aren't allowed to log in.
371 wildcards in the patterns.
372 Only group names are valid; a numerical group ID isn't recognized.
373 By default login is allowed regardless of the group list.
376 This keyword can be followed by a number of user names, separated
378 Login is disallowed for user names that match one of the patterns.
382 can be used as wildcards in the patterns.
383 Only user names are valid; a numerical user ID isn't recognized.
384 By default login is allowed regardless of the user name.
386 Specifies whether remote hosts are allowed to connect to ports
387 forwarded for the client.
395 Specifies the file containing the private host keys (default
396 .Pa /etc/ssh_host_key )
397 used by SSH protocol versions 1 and 2.
400 will refuse to use a file if it is group/world-accessible.
401 It is possible to have multiple host key files.
403 keys are used for version 1 and
407 are used for version 2 of the SSH protocol.
413 files will not be used in authentication.
416 .Pa /etc/shosts.equiv
420 .It Cm IgnoreUserKnownHosts
423 should ignore the user's
424 .Pa $HOME/.ssh/known_hosts
426 .Cm RhostsRSAAuthentication .
430 Specifies whether the system should send keepalive messages to the
432 If they are sent, death of the connection or crash of one
433 of the machines will be properly noticed.
434 However, this means that
435 connections will die if the route is down temporarily, and some people
437 On the other hand, if keepalives are not sent,
438 sessions may hang indefinitely on the server, leaving
440 users and consuming server resources.
444 (to send keepalives), and the server will notice
445 if the network goes down or the client host reboots.
446 This avoids infinitely hanging sessions.
448 To disable keepalives, the value should be set to
450 in both the server and the client configuration files.
451 .It Cm KerberosAuthentication
452 Specifies whether Kerberos authentication is allowed.
453 This can be in the form of a Kerberos ticket, or if
454 .Cm PasswordAuthentication
455 is yes, the password provided by the user will be validated through
457 To use this option, the server needs a
458 Kerberos servtab which allows the verification of the KDC's identity.
461 .It Cm KerberosOrLocalPasswd
462 If set then if password authentication through Kerberos fails then
463 the password will be validated via any additional local mechanism
468 .It Cm KerberosTgtPassing
469 Specifies whether a Kerberos TGT may be forwarded to the server.
472 as this only works when the Kerberos KDC is actually an AFS kaserver.
473 .It Cm KerberosTicketCleanup
474 Specifies whether to automatically destroy the user's ticket cache
478 .It Cm KeyRegenerationInterval
479 The server key is automatically regenerated after this many seconds
480 (if it has been used).
481 The purpose of regeneration is to prevent
482 decrypting captured sessions by later breaking into the machine and
484 The key is never stored anywhere.
485 If the value is 0, the key is never regenerated.
486 The default is 3600 (seconds).
488 Specifies what local address
491 The default is to listen to all local addresses.
492 Multiple options of this type are permitted.
495 options must precede this option.
496 .It Cm LoginGraceTime
497 The server disconnects after this time if the user has not
498 successfully logged in.
499 If the value is 0, there is no time limit.
500 The default is 600 (seconds).
502 Gives the verbosity level that is used when logging messages from
504 The possible values are:
505 QUIET, FATAL, ERROR, INFO, VERBOSE and DEBUG.
507 Logging with level DEBUG violates the privacy of users
508 and is not recommended.
510 Specifies the available MAC (message authentication code) algorithms.
511 The MAC algorithm is used in protocol version 2
512 for data integrity protection.
513 Multiple algorithms must be comma-separated.
517 ``hmac-md5,hmac-sha1,hmac-ripemd160,hmac-ripemd160@openssh.com,
518 hmac-sha1-96,hmac-md5-96''
521 Specifies the maximum number of concurrent unauthenticated connections to the
524 Additional connections will be dropped until authentication succeeds or the
526 expires for a connection.
529 Alternatively, random early drop can be enabled by specifying
530 the three colon separated values
534 will refuse connection attempts with a probability of
537 if there are currently
540 unauthenticated connections.
541 The probability increases linearly and all connection attempts
542 are refused if the number of unauthenticated connections reaches
545 .It Cm PasswordAuthentication
546 Specifies whether password authentication is allowed.
549 Note that this option applies to both protocol versions 1 and 2.
550 .It Cm PermitEmptyPasswords
551 When password authentication is allowed, it specifies whether the
552 server allows login to accounts with empty password strings.
555 .It Cm PermitRootLogin
556 Specifies whether root can login using
560 .Dq without-password ,
561 .Dq forced-commands-only
567 If this option is set to
569 password authentication is disabled for root.
571 If this option is set to
572 .Dq forced-commands-only
573 root login with public key authentication will be allowed,
576 option has been specified
577 (which may be useful for taking remote backups even if root login is
578 normally not allowed). All other authentication methods are disabled
581 If this option is set to
583 root is not allowed to login.
585 Specifies the file that contains the process identifier of the
589 .Pa /var/run/sshd.pid .
591 Specifies the port number that
595 Multiple options of this type are permitted.
599 should print the date and time when the user last logged in.
607 when a user logs in interactively.
608 (On some systems it is also printed by the shell,
614 Specifies the protocol versions
617 The possible values are
621 Multiple versions must be comma-separated.
624 .It Cm PubkeyAuthentication
625 Specifies whether public key authentication is allowed.
628 Note that this option applies to protocol version 2 only.
629 .It Cm ReverseMappingCheck
632 should try to verify the remote host name and check that
633 the resolved host name for the remote IP address maps back to the
634 very same IP address.
637 .It Cm RhostsAuthentication
638 Specifies whether authentication using rhosts or /etc/hosts.equiv
640 Normally, this method should not be permitted because it is insecure.
641 .Cm RhostsRSAAuthentication
643 instead, because it performs RSA-based host authentication in addition
644 to normal rhosts or /etc/hosts.equiv authentication.
647 .It Cm RhostsRSAAuthentication
648 Specifies whether rhosts or /etc/hosts.equiv authentication together
649 with successful RSA host authentication is allowed.
652 .It Cm RSAAuthentication
653 Specifies whether pure RSA authentication is allowed.
656 Note that this option applies to protocol version 1 only.
658 Defines the number of bits in the server key.
659 The minimum value is 512, and the default is 768.
663 should check file modes and ownership of the
664 user's files and home directory before accepting login.
665 This is normally desirable because novices sometimes accidentally leave their
666 directory or files world-writable.
670 Configures an external subsystem (e.g., file transfer daemon).
671 Arguments should be a subsystem name and a command to execute upon subsystem
677 file transfer subsystem.
678 By default no subsystems are defined.
679 Note that this option applies to protocol version 2 only.
680 .It Cm SyslogFacility
681 Gives the facility code that is used when logging messages from
683 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
684 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
689 is used for interactive login sessions.
692 is never used for remote command execution.
695 .It Cm X11DisplayOffset
696 Specifies the first display number available for
701 from interfering with real X11 servers.
704 Specifies whether X11 forwarding is permitted.
707 Note that disabling X11 forwarding does not improve security in any
708 way, as users can always install their own forwarders.
710 Specifies the location of the
714 .Pa /usr/X11R6/bin/xauth .
717 When a user successfully logs in,
720 .Bl -enum -offset indent
722 If the login is on a tty, and no command has been specified,
723 prints last login time and
725 (unless prevented in the configuration file or by
726 .Pa $HOME/.hushlogin ;
731 If the login is on a tty, records login time.
735 if it exists, prints contents and quits
738 Changes to run with normal user privileges.
740 Sets up basic environment.
743 .Pa $HOME/.ssh/environment
746 Changes to user's home directory.
750 exists, runs it; else if
753 it; otherwise runs xauth.
756 files are given the X11
757 authentication protocol and cookie in standard input.
759 Runs user's shell or command.
761 .Sh AUTHORIZED_KEYS FILE FORMAT
763 .Pa $HOME/.ssh/authorized_keys
764 file lists the RSA keys that are
765 permitted for RSA authentication in SSH protocols 1.3 and 1.5
767 .Pa $HOME/.ssh/authorized_keys2
768 file lists the DSA and RSA keys that are
769 permitted for public key authentication (PubkeyAuthentication)
772 Each line of the file contains one
773 key (empty lines and lines starting with a
777 Each RSA public key consists of the following fields, separated by
778 spaces: options, bits, exponent, modulus, comment.
779 Each protocol version 2 public key consists of:
780 options, keytype, base64 encoded key, comment.
782 are optional; its presence is determined by whether the line starts
783 with a number or not (the option field never starts with a number).
784 The bits, exponent, modulus and comment fields give the RSA key for
785 protocol version 1; the
786 comment field is not used for anything (but may be convenient for the
787 user to identify the key).
788 For protocol version 2 the keytype is
793 Note that lines in this file are usually several hundred bytes long
794 (because of the size of the RSA key modulus).
795 You don't want to type them in; instead, copy the
801 The options (if present) consist of comma-separated option
803 No spaces are permitted, except within double quotes.
804 The following option specifications are supported:
806 .It Cm from="pattern-list"
807 Specifies that in addition to RSA authentication, the canonical name
808 of the remote host must be present in the comma-separated list of
814 The list may also contain
815 patterns negated by prefixing them with
817 if the canonical host name matches a negated pattern, the key is not accepted.
819 of this option is to optionally increase security: RSA authentication
820 by itself does not trust the network or name servers or anything (but
821 the key); however, if somebody somehow steals the key, the key
822 permits an intruder to log in from anywhere in the world.
823 This additional option makes using a stolen key more difficult (name
824 servers and/or routers would have to be compromised in addition to
826 .It Cm command="command"
827 Specifies that the command is executed whenever this key is used for
829 The command supplied by the user (if any) is ignored.
830 The command is run on a pty if the connection requests a pty;
831 otherwise it is run without a tty.
832 Note that if you want a 8-bit clean channel,
833 you must not request a pty or should specify
835 A quote may be included in the command by quoting it with a backslash.
836 This option might be useful
837 to restrict certain RSA keys to perform just a specific operation.
838 An example might be a key that permits remote backups but nothing else.
839 Note that the client may specify TCP/IP and/or X11
840 forwarding unless they are explicitly prohibited.
841 .It Cm environment="NAME=value"
842 Specifies that the string is to be added to the environment when
843 logging in using this key.
844 Environment variables set this way
845 override other default environment values.
846 Multiple options of this type are permitted.
847 .It Cm no-port-forwarding
848 Forbids TCP/IP forwarding when this key is used for authentication.
849 Any port forward requests by the client will return an error.
850 This might be used, e.g., in connection with the
853 .It Cm no-X11-forwarding
854 Forbids X11 forwarding when this key is used for authentication.
855 Any X11 forward requests by the client will return an error.
856 .It Cm no-agent-forwarding
857 Forbids authentication agent forwarding when this key is used for
860 Prevents tty allocation (a request to allocate a pty will fail).
861 .It Cm permitopen="host:port"
864 port-forwading such that it may only connect to the specified host and
867 options may be applied seperated by commas. No pattern matching is
868 performed on the specified hostnames, they must be literal domains or
872 1024 33 12121.\|.\|.\|312314325 ylo@foo.bar
874 from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23.\|.\|.\|2334 ylo@niksula
876 command="dump /home",no-pty,no-port-forwarding 1024 33 23.\|.\|.\|2323 backup.hut.fi
878 permitopen="10.2.1.55:80",permitopen="10.2.1.56:25" 1024 33 23.\|.\|.\|2323
879 .Sh SSH_KNOWN_HOSTS FILE FORMAT
881 .Pa /etc/ssh_known_hosts ,
882 .Pa /etc/ssh_known_hosts2 ,
883 .Pa $HOME/.ssh/known_hosts ,
885 .Pa $HOME/.ssh/known_hosts2
886 files contain host public keys for all known hosts.
887 The global file should
888 be prepared by the administrator (optional), and the per-user file is
889 maintained automatically: whenever the user connects from an unknown host
890 its key is added to the per-user file.
892 Each line in these files contains the following fields: hostnames,
893 bits, exponent, modulus, comment.
894 The fields are separated by spaces.
896 Hostnames is a comma-separated list of patterns ('*' and '?' act as
897 wildcards); each pattern in turn is matched against the canonical host
898 name (when authenticating a client) or against the user-supplied
899 name (when authenticating a server).
900 A pattern may also be preceded by
902 to indicate negation: if the host name matches a negated
903 pattern, it is not accepted (by that line) even if it matched another
906 Bits, exponent, and modulus are taken directly from the RSA host key; they
907 can be obtained, e.g., from
908 .Pa /etc/ssh_host_key.pub .
909 The optional comment field continues to the end of the line, and is not used.
913 and empty lines are ignored as comments.
915 When performing host authentication, authentication is accepted if any
916 matching line has the proper key.
917 It is thus permissible (but not
918 recommended) to have several lines or different host keys for the same
920 This will inevitably happen when short forms of host names
921 from different domains are put in the file.
923 that the files contain conflicting information; authentication is
924 accepted if valid information can be found from either file.
926 Note that the lines in these files are typically hundreds of characters
927 long, and you definitely don't want to type in the host keys by hand.
928 Rather, generate them by a script
930 .Pa /etc/ssh_host_key.pub
931 and adding the host names at the front.
933 closenet,closenet.hut.fi,.\|.\|.\|,130.233.208.41 1024 37 159.\|.\|.93 closenet.hut.fi
936 .It Pa /etc/sshd_config
937 Contains configuration data for
939 This file should be writable by root only, but it is recommended
940 (though not necessary) that it be world-readable.
941 .It Pa /etc/ssh_host_key, /etc/ssh_host_dsa_key, /etc/ssh_host_rsa_key
942 These three files contain the private parts of the
943 (SSH1, SSH2 DSA, and SSH2 RSA) host keys.
944 These files should only be owned by root, readable only by root, and not
945 accessible to others.
948 does not start if this file is group/world-accessible.
949 .It Pa /etc/ssh_host_key.pub, /etc/ssh_host_dsa_key.pub, /etc/ssh_host_rsa_key.pub
950 These three files contain the public parts of the
951 (SSH1, SSH2 DSA, and SSH2 RSA) host keys.
952 These files should be world-readable but writable only by
954 Their contents should match the respective private parts.
956 really used for anything; they are provided for the convenience of
957 the user so their contents can be copied to known hosts files.
958 These files are created using
961 Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
962 .It Pa /var/run/sshd.pid
963 Contains the process ID of the
965 listening for connections (if there are several daemons running
966 concurrently for different ports, this contains the pid of the one
968 The content of this file is not sensitive; it can be world-readable.
969 .It Pa $HOME/.ssh/authorized_keys
970 Lists the RSA keys that can be used to log into the user's account.
971 This file must be readable by root (which may on some machines imply
972 it being world-readable if the user's home directory resides on an NFS
974 It is recommended that it not be accessible by others.
975 The format of this file is described above.
976 Users will place the contents of their
978 files into this file, as described in
980 .It Pa $HOME/.ssh/authorized_keys2
981 Lists the DSA keys that can be used to log into the user's account.
982 This file must be readable by root (which may on some machines imply
983 it being world-readable if the user's home directory resides on an NFS
985 It is recommended that it not be accessible by others.
986 The format of this file is described above.
987 Users will place the contents of their
989 files into this file, as described in
991 .It Pa "/etc/ssh_known_hosts" and "$HOME/.ssh/known_hosts"
992 These files are consulted when using rhosts with RSA host
993 authentication to check the public key of the host.
994 The key must be listed in one of these files to be accepted.
995 The client uses the same files
996 to verify that it is connecting to the correct remote host.
997 These files should be writable only by root/the owner.
998 .Pa /etc/ssh_known_hosts
999 should be world-readable, and
1000 .Pa $HOME/.ssh/known_hosts
1001 can but need not be world-readable.
1003 If this file exists,
1005 refuses to let anyone except root log in.
1006 The contents of the file
1007 are displayed to anyone trying to log in, and non-root connections are
1009 The file should be world-readable.
1010 .It Pa /etc/hosts.allow, /etc/hosts.deny
1013 support, tcp-wrappers access controls may be defined here as described in
1014 .Xr hosts_access 5 .
1015 .It Pa $HOME/.rhosts
1016 This file contains host-username pairs, separated by a space, one per
1018 The given user on the corresponding host is permitted to log in
1020 The same file is used by rlogind and rshd.
1022 be writable only by the user; it is recommended that it not be
1023 accessible by others.
1025 If is also possible to use netgroups in the file.
1027 name may be of the form +@groupname to specify all hosts or all users
1029 .It Pa $HOME/.shosts
1031 this file is exactly the same as for
1033 However, this file is
1034 not used by rlogin and rshd, so using this permits access using SSH only.
1035 .It Pa /etc/hosts.equiv
1036 This file is used during
1039 In the simplest form, this file contains host names, one per line.
1041 those hosts are permitted to log in without a password, provided they
1042 have the same user name on both machines.
1043 The host name may also be
1044 followed by a user name; such users are permitted to log in as
1046 user on this machine (except root).
1047 Additionally, the syntax
1049 can be used to specify netgroups.
1050 Negated entries start with
1053 If the client host/user is successfully matched in this file, login is
1054 automatically permitted provided the client and server user names are the
1056 Additionally, successful RSA host authentication is normally required.
1057 This file must be writable only by root; it is recommended
1058 that it be world-readable.
1060 .Sy "Warning: It is almost never a good idea to use user names in"
1062 Beware that it really means that the named user(s) can log in as
1064 which includes bin, daemon, adm, and other accounts that own critical
1065 binaries and directories.
1066 Using a user name practically grants the user root access.
1067 The only valid use for user names that I can think
1068 of is in negative entries.
1070 Note that this warning also applies to rsh/rlogin.
1071 .It Pa /etc/shosts.equiv
1072 This is processed exactly as
1073 .Pa /etc/hosts.equiv .
1074 However, this file may be useful in environments that want to run both
1076 .It Pa $HOME/.ssh/environment
1077 This file is read into the environment at login (if it exists).
1078 It can only contain empty lines, comment lines (that start with
1080 and assignment lines of the form name=value.
1081 The file should be writable
1082 only by the user; it need not be readable by anyone else.
1083 .It Pa $HOME/.ssh/rc
1084 If this file exists, it is run with /bin/sh after reading the
1085 environment files but before starting the user's shell or command.
1086 If X11 spoofing is in use, this will receive the "proto cookie" pair in
1094 The primary purpose of this file is to run any initialization routines
1095 which may be needed before the user's home directory becomes
1096 accessible; AFS is a particular example of such an environment.
1098 This file will probably contain some initialization code followed by
1099 something similar to: "if read proto cookie; then echo add $DISPLAY
1100 $proto $cookie | xauth -q -; fi".
1102 If this file does not exist,
1105 does not exist either, xauth is used to store the cookie.
1107 This file should be writable only by the user, and need not be
1108 readable by anyone else.
1112 This can be used to specify
1113 machine-specific login-time initializations globally.
1114 This file should be writable only by root, and should be world-readable.
1117 OpenSSH is a derivative of the original and free
1118 ssh 1.2.12 release by Tatu Ylonen.
1119 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1120 Theo de Raadt and Dug Song
1121 removed many bugs, re-added newer features and
1123 Markus Friedl contributed the support for SSH
1124 protocol versions 1.5 and 2.0.
andersk / openssh.git / blob