5 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
7 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8 .\" All rights reserved
10 .\" Created: Sat Apr 22 21:55:14 1995 ylo
14 .Dd September 25, 1999
19 .Nd secure shell daemon
24 .Op Fl f Ar config_file
25 .Op Fl g Ar login_grace_time
26 .Op Fl h Ar host_key_file
27 .Op Fl k Ar key_gen_time
29 .Op Fl V Ar client_protocol_id
32 (Secure Shell Daemon) is the daemon program for
34 Together these programs replace rlogin and rsh programs, and
35 provide secure encrypted communications between two untrusted hosts
36 over an insecure network.
37 The programs are intended to be as easy to
38 install and use as possible.
41 is the daemon that listens for connections from clients.
42 It is normally started at boot from
45 daemon for each incoming connection.
46 The forked daemons handle
47 key exchange, encryption, authentication, command execution,
52 Each host has a host-specific RSA key
53 (normally 1024 bits) used to identify the host.
55 the daemon starts, it generates a server RSA key (normally 768 bits).
56 This key is normally regenerated every hour if it has been used, and
57 is never stored on disk.
59 Whenever a client connects the daemon, the daemon sends its host
60 and server public keys to the client.
61 The client compares the
62 host key against its own database to verify that it has not changed.
63 The client then generates a 256 bit random number.
65 random number using both the host key and the server key, and sends
66 the encrypted number to the server.
67 Both sides then start to use this
68 random number as a session key which is used to encrypt all further
69 communications in the session.
70 The rest of the session is encrypted
71 using a conventional cipher, currently Blowfish and 3DES, with 3DES
72 being used by default.
73 The client selects the encryption algorithm
74 to use from those offered by the server.
76 Next, the server and the client enter an authentication dialog.
77 The client tries to authenticate itself using
81 authentication combined with RSA host
82 authentication, RSA challenge-response authentication, or password
85 Rhosts authentication is normally disabled
86 because it is fundamentally insecure, but can be enabled in the server
87 configuration file if desired.
88 System security is not improved unless
94 are disabled (thus completely disabling
100 If the client successfully authenticates itself, a dialog for
101 preparing the session is entered.
102 At this time the client may request
103 things like allocating a pseudo-tty, forwarding X11 connections,
104 forwarding TCP/IP connections, or forwarding the authentication agent
105 connection over the secure channel.
107 Finally, the client either requests a shell or execution of a command.
108 The sides then enter session mode.
109 In this mode, either side may send
110 data at any time, and such data is forwarded to/from the shell or
111 command on the server side, and the user terminal in the client side.
113 When the user program terminates and all forwarded X11 and other
114 connections have been closed, the server sends command exit status to
115 the client, and both sides exit.
118 can be configured using command-line options or a configuration
120 Command-line options override values specified in the
124 rereads its configuration file when it receives a hangup signal,
127 The options are as follows:
130 Specifies the number of bits in the server key (default 768).
134 The server sends verbose debug output to the system
135 log, and does not put itself in the background.
136 The server also will not fork and will only process one connection.
137 This option is only intended for debugging for the server.
138 .It Fl f Ar configuration_file
139 Specifies the name of the configuration file.
141 .Pa /etc/sshd_config .
143 refuses to start if there is no configuration file.
144 .It Fl g Ar login_grace_time
145 Gives the grace time for clients to authenticate themselves (default
147 If the client fails to authenticate the user within
148 this many seconds, the server disconnects and exits.
149 A value of zero indicates no limit.
150 .It Fl h Ar host_key_file
151 Specifies the file from which the host key is read (default
152 .Pa /etc/ssh_host_key ) .
153 This option must be given if
155 is not run as root (as the normal
156 host file is normally not readable by anyone but root).
160 is being run from inetd.
163 from inetd because it needs to generate the server key before it can
164 respond to the client, and this may take tens of seconds.
165 Clients would have to wait too long if the key was regenerated every time.
166 However, with small key sizes (e.g., 512) using
170 .It Fl k Ar key_gen_time
171 Specifies how often the server key is regenerated (default 3600
172 seconds, or one hour).
173 The motivation for regenerating the key fairly
174 often is that the key is not stored anywhere, and after about an hour,
175 it becomes impossible to recover the key for decrypting intercepted
176 communications even if the machine is cracked into or physically
178 A value of zero indicates that the key will never be regenerated.
180 Specifies the port on which the server listens for connections
184 Nothing is sent to the system log.
185 Normally the beginning,
186 authentication, and termination of each connection is logged.
188 Do not print an error message if RSA support is missing.
189 .It Fl V Ar client_protocol_id
190 SSH2 compatibility mode.
191 When this options is specified
193 assumes the client has sent the given version string
195 Protocol Version Identification Exchange.
199 to use IPv4 addresses only.
203 to use IPv6 addresses only.
205 .Sh CONFIGURATION FILE
207 reads configuration data from
209 (or the file specified with
211 on the command line).
212 The file contains keyword-value pairs, one per line.
215 and empty lines are interpreted as comments.
217 The following keywords are possible.
219 .It Cm AFSTokenPassing
220 Specifies whether an AFS token may be forwarded to the server.
224 This keyword can be followed by a number of group names, separated
226 If specified, login is allowed only for users whose primary
227 group matches one of the patterns.
232 wildcards in the patterns.
233 Only group names are valid, a numerical group ID isn't recognized.
234 By default login is allowed regardless of the primary group.
237 This keyword can be followed by a number of user names, separated
239 If specified, login is allowed only for users names that
240 match one of the patterns.
245 wildcards in the patterns.
246 Only user names are valid, a numerical user ID isn't recognized.
247 By default login is allowed regardless of the user name.
250 Specifies the ciphers allowed for protocol version 2.
251 Multiple ciphers must be comma-separated.
253 .Dq blowfish-cbc,3des-cbc,arcfour,cast128-cbc .
257 should check for new mail for interactive logins.
261 This keyword can be followed by a number of group names, separated
263 Users whose primary group matches one of the patterns
264 aren't allowed to log in.
269 wildcards in the patterns.
270 Only group names are valid, a numerical group ID isn't recognized.
271 By default login is allowed regardless of the primary group.
274 This keyword can be followed by a number of user names, separated
276 Login is disallowed for user names that match one of the patterns.
280 can be used as wildcards in the patterns.
281 Only user names are valid, a numerical user ID isn't recognized.
282 By default login is allowed regardless of the user name.
284 Specifies the file containing the private host key (default
285 .Pa /etc/ssh_host_key ) .
288 does not start if this file is group/world-accessible.
294 files will not be used in authentication.
297 .Pa /etc/shosts.equiv
301 .It Cm IgnoreUserKnownHosts
304 should ignore the user's
305 .Pa $HOME/.ssh/known_hosts
307 .Cm RhostsRSAAuthentication .
311 Specifies whether the system should send keepalive messages to the
313 If they are sent, death of the connection or crash of one
314 of the machines will be properly noticed.
315 However, this means that
316 connections will die if the route is down temporarily, and some people
318 On the other hand, if keepalives are not send,
319 sessions may hang indefinitely on the server, leaving
321 users and consuming server resources.
325 (to send keepalives), and the server will notice
326 if the network goes down or the client host reboots.
327 This avoids infinitely hanging sessions.
329 To disable keepalives, the value should be set to
331 in both the server and the client configuration files.
332 .It Cm KerberosAuthentication
333 Specifies whether Kerberos authentication is allowed.
334 This can be in the form of a Kerberos ticket, or if
335 .Cm PasswordAuthentication
336 is yes, the password provided by the user will be validated through
340 .It Cm KerberosOrLocalPasswd
341 If set then if password authentication through Kerberos fails then
342 the password will be validated via any additional local mechanism
348 .It Cm KerberosTgtPassing
349 Specifies whether a Kerberos TGT may be forwarded to the server.
352 as this only works when the Kerberos KDC is actually an AFS kaserver.
353 .It Cm KerberosTicketCleanup
354 Specifies whether to automatically destroy the user's ticket cache
358 .It Cm KeyRegenerationInterval
359 The server key is automatically regenerated after this many seconds
360 (if it has been used).
361 The purpose of regeneration is to prevent
362 decrypting captured sessions by later breaking into the machine and
364 The key is never stored anywhere.
365 If the value is 0, the key is never regenerated.
366 The default is 3600 (seconds).
368 Specifies what local address
371 The default is to listen to all local addresses.
372 Multiple options of this type are permitted.
375 options must precede this option.
376 .It Cm LoginGraceTime
377 The server disconnects after this time if the user has not
378 successfully logged in.
379 If the value is 0, there is no time limit.
380 The default is 600 (seconds).
382 Gives the verbosity level that is used when logging messages from
384 The possible values are:
385 QUIET, FATAL, ERROR, INFO, VERBOSE and DEBUG.
387 Logging with level DEBUG violates the privacy of users
388 and is not recommended.
389 .It Cm PasswordAuthentication
390 Specifies whether password authentication is allowed.
393 .It Cm PermitEmptyPasswords
394 When password authentication is allowed, it specifies whether the
395 server allows login to accounts with empty password strings.
398 .It Cm PermitRootLogin
399 Specifies whether the root can log in using
408 If this options is set to
410 only password authentication is disabled for root.
412 Root login with RSA authentication when the
415 specified will be allowed regardless of the value of this setting
416 (which may be useful for taking remote backups even if root login is
417 normally not allowed).
419 Specifies the port number that
423 Multiple options of this type are permitted.
429 when a user logs in interactively.
430 (On some systems it is also printed by the shell,
436 Specifies the protocol versions
439 The possible values are
443 Multiple versions must be comma-separated.
448 Random number generation uses other techniques.
449 .It Cm RhostsAuthentication
450 Specifies whether authentication using rhosts or /etc/hosts.equiv
452 Normally, this method should not be permitted because it is insecure.
453 .Cm RhostsRSAAuthentication
455 instead, because it performs RSA-based host authentication in addition
456 to normal rhosts or /etc/hosts.equiv authentication.
459 .It Cm RhostsRSAAuthentication
460 Specifies whether rhosts or /etc/hosts.equiv authentication together
461 with successful RSA host authentication is allowed.
464 .It Cm RSAAuthentication
465 Specifies whether pure RSA authentication is allowed.
469 Defines the number of bits in the server key.
470 The minimum value is 512, and the default is 768.
471 .It Cm SkeyAuthentication
474 authentication is allowed.
477 Note that s/key authentication is enabled only if
478 .Cm PasswordAuthentication
483 should check file modes and ownership of the
484 user's files and home directory before accepting login.
485 This is normally desirable because novices sometimes accidentally leave their
486 directory or files world-writable.
489 .It Cm SyslogFacility
490 Gives the facility code that is used when logging messages from
492 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
493 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
501 .It Cm X11DisplayOffset
502 Specifies the first display number available for
507 from interfering with real X11 servers.
510 Specifies whether X11 forwarding is permitted.
513 Note that disabling X11 forwarding does not improve security in any
514 way, as users can always install their own forwarders.
517 When a user successfully logs in,
520 .Bl -enum -offset indent
522 If the login is on a tty, and no command has been specified,
523 prints last login time and
525 (unless prevented in the configuration file or by
526 .Pa $HOME/.hushlogin ;
531 If the login is on a tty, records login time.
535 if it exists, prints contents and quits
538 Changes to run with normal user privileges.
540 Sets up basic environment.
543 .Pa $HOME/.ssh/environment
546 Changes to user's home directory.
550 exists, runs it; else if
553 it; otherwise runs xauth.
556 files are given the X11
557 authentication protocol and cookie in standard input.
559 Runs user's shell or command.
561 .Sh AUTHORIZED_KEYS FILE FORMAT
563 .Pa $HOME/.ssh/authorized_keys
564 file lists the RSA keys that are
565 permitted for RSA authentication.
566 Each line of the file contains one
567 key (empty lines and lines starting with a
571 Each line consists of the following fields, separated by
572 spaces: options, bits, exponent, modulus, comment.
574 is optional; its presence is determined by whether the line starts
575 with a number or not (the option field never starts with a number).
576 The bits, exponent, modulus and comment fields give the RSA key; the
577 comment field is not used for anything (but may be convenient for the
578 user to identify the key).
580 Note that lines in this file are usually several hundred bytes long
581 (because of the size of the RSA key modulus).
582 You don't want to type them in; instead, copy the
586 The options (if present) consists of comma-separated option
588 No spaces are permitted, except within double quotes.
589 The following option specifications are supported:
591 .It Cm from="pattern-list"
592 Specifies that in addition to RSA authentication, the canonical name
593 of the remote host must be present in the comma-separated list of
599 The list may also contain
600 patterns negated by prefixing them with
602 if the canonical host name matches a negated pattern, the key is not accepted.
604 of this option is to optionally increase security: RSA authentication
605 by itself does not trust the network or name servers or anything (but
606 the key); however, if somebody somehow steals the key, the key
607 permits an intruder to log in from anywhere in the world.
608 This additional option makes using a stolen key more difficult (name
609 servers and/or routers would have to be compromised in addition to
611 .It Cm command="command"
612 Specifies that the command is executed whenever this key is used for
614 The command supplied by the user (if any) is ignored.
615 The command is run on a pty if the connection requests a pty;
616 otherwise it is run without a tty.
617 A quote may be included in the command by quoting it with a backslash.
618 This option might be useful
619 to restrict certain RSA keys to perform just a specific operation.
620 An example might be a key that permits remote backups but nothing else.
621 Notice that the client may specify TCP/IP and/or X11
622 forwardings unless they are explicitly prohibited.
623 .It Cm environment="NAME=value"
624 Specifies that the string is to be added to the environment when
625 logging in using this key.
626 Environment variables set this way
627 override other default environment values.
628 Multiple options of this type are permitted.
629 .It Cm no-port-forwarding
630 Forbids TCP/IP forwarding when this key is used for authentication.
631 Any port forward requests by the client will return an error.
632 This might be used, e.g., in connection with the
635 .It Cm no-X11-forwarding
636 Forbids X11 forwarding when this key is used for authentication.
637 Any X11 forward requests by the client will return an error.
638 .It Cm no-agent-forwarding
639 Forbids authentication agent forwarding when this key is used for
642 Prevents tty allocation (a request to allocate a pty will fail).
645 1024 33 12121.\|.\|.\|312314325 ylo@foo.bar
647 from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23.\|.\|.\|2334 ylo@niksula
649 command="dump /home",no-pty,no-port-forwarding 1024 33 23.\|.\|.\|2323 backup.hut.fi
650 .Sh SSH_KNOWN_HOSTS FILE FORMAT
652 .Pa /etc/ssh_known_hosts
654 .Pa $HOME/.ssh/known_hosts
655 files contain host public keys for all known hosts.
656 The global file should
657 be prepared by the administrator (optional), and the per-user file is
658 maintained automatically: whenever the user connects an unknown host
659 its key is added to the per-user file.
661 Each line in these files contains the following fields: hostnames,
662 bits, exponent, modulus, comment.
663 The fields are separated by spaces.
665 Hostnames is a comma-separated list of patterns ('*' and '?' act as
666 wildcards); each pattern in turn is matched against the canonical host
667 name (when authenticating a client) or against the user-supplied
668 name (when authenticating a server).
669 A pattern may also be preceded by
671 to indicate negation: if the host name matches a negated
672 pattern, it is not accepted (by that line) even if it matched another
675 Bits, exponent, and modulus are taken directly from the host key; they
676 can be obtained, e.g., from
677 .Pa /etc/ssh_host_key.pub .
678 The optional comment field continues to the end of the line, and is not used.
682 and empty lines are ignored as comments.
684 When performing host authentication, authentication is accepted if any
685 matching line has the proper key.
686 It is thus permissible (but not
687 recommended) to have several lines or different host keys for the same
689 This will inevitably happen when short forms of host names
690 from different domains are put in the file.
692 that the files contain conflicting information; authentication is
693 accepted if valid information can be found from either file.
695 Note that the lines in these files are typically hundreds of characters
696 long, and you definitely don't want to type in the host keys by hand.
697 Rather, generate them by a script
699 .Pa /etc/ssh_host_key.pub
700 and adding the host names at the front.
702 closenet,closenet.hut.fi,.\|.\|.\|,130.233.208.41 1024 37 159.\|.\|.93 closenet.hut.fi
705 .It Pa /etc/sshd_config
706 Contains configuration data for
708 This file should be writable by root only, but it is recommended
709 (though not necessary) that it be world-readable.
710 .It Pa /etc/ssh_host_key
711 Contains the private part of the host key.
712 This file should only be owned by root, readable only by root, and not
713 accessible to others.
716 does not start if this file is group/world-accessible.
717 .It Pa /etc/ssh_host_key.pub
718 Contains the public part of the host key.
719 This file should be world-readable but writable only by
721 Its contents should match the private part.
723 really used for anything; it is only provided for the convenience of
724 the user so its contents can be copied to known hosts files.
725 These two files are created using
727 .It Pa /var/run/sshd.pid
728 Contains the process ID of the
730 listening for connections (if there are several daemons running
731 concurrently for different ports, this contains the pid of the one
733 The contents of this file are not sensitive; it can be world-readable.
734 .It Pa $HOME/.ssh/authorized_keys
735 Lists the RSA keys that can be used to log into the user's account.
736 This file must be readable by root (which may on some machines imply
737 it being world-readable if the user's home directory resides on an NFS
739 It is recommended that it not be accessible by others.
740 The format of this file is described above.
741 .It Pa "/etc/ssh_known_hosts" and "$HOME/.ssh/known_hosts"
742 These files are consulted when using rhosts with RSA host
743 authentication to check the public key of the host.
744 The key must be listed in one of these files to be accepted.
745 The client uses the same files
746 to verify that the remote host is the one we intended to connect.
747 These files should be writable only by root/the owner.
748 .Pa /etc/ssh_known_hosts
749 should be world-readable, and
750 .Pa $HOME/.ssh/known_hosts
751 can but need not be world-readable.
755 refuses to let anyone except root log in.
756 The contents of the file
757 are displayed to anyone trying to log in, and non-root connections are
759 The file should be world-readable.
760 .It Pa /etc/hosts.allow, /etc/hosts.deny
763 support, tcp-wrappers access controls may be defined here as described in
766 This file contains host-username pairs, separated by a space, one per
768 The given user on the corresponding host is permitted to log in
770 The same file is used by rlogind and rshd.
772 be writable only by the user; it is recommended that it not be
773 accessible by others.
775 If is also possible to use netgroups in the file.
777 name may be of the form +@groupname to specify all hosts or all users
781 this file is exactly the same as for
783 However, this file is
784 not used by rlogin and rshd, so using this permits access using SSH only.
786 This file is used during
789 In the simplest form, this file contains host names, one per line.
791 those hosts are permitted to log in without a password, provided they
792 have the same user name on both machines.
793 The host name may also be
794 followed by a user name; such users are permitted to log in as
796 user on this machine (except root).
797 Additionally, the syntax
799 can be used to specify netgroups.
800 Negated entries start with
803 If the client host/user is successfully matched in this file, login is
804 automatically permitted provided the client and server user names are the
806 Additionally, successful RSA host authentication is normally required.
807 This file must be writable only by root; it is recommended
808 that it be world-readable.
810 .Sy "Warning: It is almost never a good idea to use user names in"
812 Beware that it really means that the named user(s) can log in as
814 which includes bin, daemon, adm, and other accounts that own critical
815 binaries and directories.
816 Using a user name practically grants the user root access.
817 The only valid use for user names that I can think
818 of is in negative entries.
820 Note that this warning also applies to rsh/rlogin.
821 .It Pa /etc/shosts.equiv
822 This is processed exactly as
823 .Pa /etc/hosts.equiv .
824 However, this file may be useful in environments that want to run both
826 .It Pa $HOME/.ssh/environment
827 This file is read into the environment at login (if it exists).
828 It can only contain empty lines, comment lines (that start with
830 and assignment lines of the form name=value.
831 The file should be writable
832 only by the user; it need not be readable by anyone else.
834 If this file exists, it is run with /bin/sh after reading the
835 environment files but before starting the user's shell or command.
836 If X11 spoofing is in use, this will receive the "proto cookie" pair in
844 The primary purpose of this file is to run any initialization routines
845 which may be needed before the user's home directory becomes
846 accessible; AFS is a particular example of such an environment.
848 This file will probably contain some initialization code followed by
849 something similar to: "if read proto cookie; then echo add $DISPLAY
850 $proto $cookie | xauth -q -; fi".
852 If this file does not exist,
855 does not exist either, xauth is used to store the cookie.
857 This file should be writable only by the user, and need not be
858 readable by anyone else.
862 This can be used to specify
863 machine-specific login-time initializations globally.
864 This file should be writable only by root, and should be world-readable.
867 is a derivative of the original (free) ssh 1.2.12 release by Tatu Ylonen,
868 but with bugs removed and newer features re-added.
870 1.2.12 release, newer versions of the original ssh bore successively
871 more restrictive licenses, and thus demand for a free version was born.
872 This version of OpenSSH
875 has all components of a restrictive nature (i.e., patents, see
877 directly removed from the source code; any licensed or patented components
881 has been updated to support ssh protocol 1.5, making it compatible with
882 all other ssh protocol 1 clients and servers.
884 contains added support for
886 authentication and ticket passing.
888 supports one-time password authentication with
892 The libraries described in
894 are required for proper operation.