]> andersk Git - openssh.git/blob - sshd.8
1b1e9645cfd335253cd97c1d949e5cf582e96326
[openssh.git] / sshd.8
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 .\"
37 .\" $OpenBSD: sshd.8,v 1.93 2001/02/11 12:59:25 markus Exp $
38 .Dd September 25, 1999
39 .Dt SSHD 8
40 .Os
41 .Sh NAME
42 .Nm sshd
43 .Nd secure shell daemon
44 .Sh SYNOPSIS
45 .Nm sshd
46 .Op Fl diqD46
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
52 .Op Fl p Ar port
53 .Op Fl u Ar len
54 .Op Fl V Ar client_protocol_id
55 .Sh DESCRIPTION
56 .Nm
57 (Secure Shell Daemon) is the daemon program for
58 .Xr ssh 1 .
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.
64 .Pp
65 .Nm
66 is the daemon that listens for connections from clients.
67 It is normally started at boot from
68 .Pa /etc/rc .
69 It forks a new
70 daemon for each incoming connection.
71 The forked daemons handle
72 key exchange, encryption, authentication, command execution,
73 and data exchange.
74 This implementation of
75 .Nm
76 supports both SSH protocol version 1 and 2 simultaneously.
77 .Nm
78 works as follows.
79 .Pp
80 .Ss SSH protocol version 1
81 .Pp
82 Each host has a host-specific RSA key
83 (normally 1024 bits) used to identify the host.
84 Additionally, when
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.
88 .Pp
89 Whenever a client connects the daemon responds with its public
90 host and server keys.
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.
94 It encrypts this
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.
105 .Pp
106 Next, the server and the client enter an authentication dialog.
107 The client tries to authenticate itself using
108 .Pa .rhosts
109 authentication,
110 .Pa .rhosts
111 authentication combined with RSA host
112 authentication, RSA challenge-response authentication, or password
113 based authentication.
114 .Pp
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
119 .Xr rshd 8 ,
120 .Xr rlogind 8 ,
121 .Xr rexecd 8 ,
122 and
123 .Xr rexd 8
124 are disabled (thus completely disabling
125 .Xr rlogin 1
126 and
127 .Xr rsh 1
128 into the machine).
129 .Pp
130 .Ss SSH protocol version 2
131 .Pp
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
138 using a symmetric cipher, currently
139 Blowfish, 3DES or CAST128 in CBC mode or Arcfour.
140 The client selects the encryption algorithm
141 to use from those offered by the server.
142 Additionally, session integrity is provided
143 through a cryptographic message authentication code
144 (hmac-sha1 or hmac-md5).
145 .Pp
146 Protocol version 2 provides a public key based
147 user authentication method (PubkeyAuthentication)
148 and conventional password authentication.
149 .Pp
150 .Ss Command execution and data forwarding
151 .Pp
152 If the client successfully authenticates itself, a dialog for
153 preparing the session is entered.
154 At this time the client may request
155 things like allocating a pseudo-tty, forwarding X11 connections,
156 forwarding TCP/IP connections, or forwarding the authentication agent
157 connection over the secure channel.
158 .Pp
159 Finally, the client either requests a shell or execution of a command.
160 The sides then enter session mode.
161 In this mode, either side may send
162 data at any time, and such data is forwarded to/from the shell or
163 command on the server side, and the user terminal in the client side.
164 .Pp
165 When the user program terminates and all forwarded X11 and other
166 connections have been closed, the server sends command exit status to
167 the client, and both sides exit.
168 .Pp
169 .Nm
170 can be configured using command-line options or a configuration
171 file.
172 Command-line options override values specified in the
173 configuration file.
174 .Pp
175 .Nm
176 rereads its configuration file when it receives a hangup signal,
177 .Dv SIGHUP .
178 .Pp
179 The options are as follows:
180 .Bl -tag -width Ds
181 .It Fl b Ar bits
182 Specifies the number of bits in the server key (default 768).
183 .Pp
184 .It Fl d
185 Debug mode.
186 The server sends verbose debug output to the system
187 log, and does not put itself in the background.
188 The server also will not fork and will only process one connection.
189 This option is only intended for debugging for the server.
190 Multiple -d options increases the debugging level.
191 Maximum is 3.
192 .It Fl f Ar configuration_file
193 Specifies the name of the configuration file.
194 The default is
195 .Pa /etc/sshd_config .
196 .Nm
197 refuses to start if there is no configuration file.
198 .It Fl g Ar login_grace_time
199 Gives the grace time for clients to authenticate themselves (default
200 600 seconds).
201 If the client fails to authenticate the user within
202 this many seconds, the server disconnects and exits.
203 A value of zero indicates no limit.
204 .It Fl h Ar host_key_file
205 Specifies the file from which the host key is read (default
206 .Pa /etc/ssh_host_key ) .
207 This option must be given if
208 .Nm
209 is not run as root (as the normal
210 host file is normally not readable by anyone but root).
211 It is possible to have multiple host key files for
212 the different protocol versions.
213 .It Fl i
214 Specifies that
215 .Nm
216 is being run from inetd.
217 .Nm
218 is normally not run
219 from inetd because it needs to generate the server key before it can
220 respond to the client, and this may take tens of seconds.
221 Clients would have to wait too long if the key was regenerated every time.
222 However, with small key sizes (e.g., 512) using
223 .Nm
224 from inetd may
225 be feasible.
226 .It Fl k Ar key_gen_time
227 Specifies how often the server key is regenerated (default 3600
228 seconds, or one hour).
229 The motivation for regenerating the key fairly
230 often is that the key is not stored anywhere, and after about an hour,
231 it becomes impossible to recover the key for decrypting intercepted
232 communications even if the machine is cracked into or physically
233 seized.
234 A value of zero indicates that the key will never be regenerated.
235 .It Fl p Ar port
236 Specifies the port on which the server listens for connections
237 (default 22).
238 .It Fl q
239 Quiet mode.
240 Nothing is sent to the system log.
241 Normally the beginning,
242 authentication, and termination of each connection is logged.
243 .It Fl u Ar len
244 This option is used to specify the size of the field
245 in the
246 .Li utmp
247 structure that holds the remote host name.
248 If the resolved host name is longer than
249 .Ar len ,
250 the dotted decimal value will be used instead.
251 This allows hosts with very long host names that
252 overflow this field to still be uniquely identified.
253 Specifying
254 .Fl u0
255 indicates that only dotted decimal addresses
256 should be put into the
257 .Pa utmp
258 file.
259 .It Fl D
260 When this option is specified
261 .Nm
262 will not detach and does not become a daemon.
263 This allows easy monitoring of
264 .Nm sshd .
265 .It Fl V Ar client_protocol_id
266 SSH-2 compatibility mode.
267 When this option is specified
268 .Nm
269 assumes the client has sent the supplied version string
270 and skips the
271 Protocol Version Identification Exchange.
272 This option is not intended to be called directly.
273 .It Fl 4
274 Forces
275 .Nm
276 to use IPv4 addresses only.
277 .It Fl 6
278 Forces
279 .Nm
280 to use IPv6 addresses only.
281 .El
282 .Sh CONFIGURATION FILE
283 .Nm
284 reads configuration data from
285 .Pa /etc/sshd_config
286 (or the file specified with
287 .Fl f
288 on the command line).
289 The file contains keyword-value pairs, one per line.
290 Lines starting with
291 .Ql #
292 and empty lines are interpreted as comments.
293 .Pp
294 The following keywords are possible.
295 .Bl -tag -width Ds
296 .It Cm AFSTokenPassing
297 Specifies whether an AFS token may be forwarded to the server.
298 Default is
299 .Dq yes .
300 .It Cm AllowGroups
301 This keyword can be followed by a list of group names, separated
302 by spaces.
303 If specified, login is allowed only for users whose primary
304 group or supplementary group list matches one of the patterns.
305 .Ql \&*
306 and
307 .Ql ?
308 can be used as
309 wildcards in the patterns.
310 Only group names are valid; a numerical group ID isn't recognized.
311 By default login is allowed regardless of the group list.
312 .Pp
313 .It Cm AllowTcpForwarding
314 Specifies whether TCP forwarding is permitted.
315 The default is
316 .Dq yes .
317 Note that disabling TCP forwarding does not improve security unless
318 users are also denied shell access, as they can always install their
319 own forwarders.
320 .Pp
321 .It Cm AllowUsers
322 This keyword can be followed by a list of user names, separated
323 by spaces.
324 If specified, login is allowed only for users names that
325 match one of the patterns.
326 .Ql \&*
327 and
328 .Ql ?
329 can be used as
330 wildcards in the patterns.
331 Only user names are valid; a numerical user ID isn't recognized.
332 By default login is allowed regardless of the user name.
333 .Pp
334 .It Cm Banner
335 In some jurisdictions, sending a warning message before authentication
336 may be relevant for getting legal protection.
337 The contents of the specified file are sent to the remote user before
338 authentication is allowed.
339 This option is only available for protocol version 2.
340 .Pp
341 .It Cm Ciphers
342 Specifies the ciphers allowed for protocol version 2.
343 Multiple ciphers must be comma-separated.
344 The default is
345 .Dq 3des-cbc,blowfish-cbc,cast128-cbc,arcfour,aes128-cbc .
346 .It Cm CheckMail
347 Specifies whether
348 .Nm
349 should check for new mail for interactive logins.
350 The default is
351 .Dq no .
352 .It Cm DenyGroups
353 This keyword can be followed by a number of group names, separated
354 by spaces.
355 Users whose primary group or supplementary group list matches
356 one of the patterns aren't allowed to log in.
357 .Ql \&*
358 and
359 .Ql ?
360 can be used as
361 wildcards in the patterns.
362 Only group names are valid; a numerical group ID isn't recognized.
363 By default login is allowed regardless of the group list.
364 .Pp
365 .It Cm DenyUsers
366 This keyword can be followed by a number of user names, separated
367 by spaces.
368 Login is disallowed for user names that match one of the patterns.
369 .Ql \&*
370 and
371 .Ql ?
372 can be used as wildcards in the patterns.
373 Only user names are valid; a numerical user ID isn't recognized.
374 By default login is allowed regardless of the user name.
375 .It Cm PubkeyAuthentication
376 Specifies whether public key authentication is allowed.
377 The default is
378 .Dq yes .
379 Note that this option applies to protocol version 2 only.
380 .It Cm GatewayPorts
381 Specifies whether remote hosts are allowed to connect to ports
382 forwarded for the client.
383 The argument must be
384 .Dq yes
385 or
386 .Dq no .
387 The default is
388 .Dq no .
389 .It Cm HostKey
390 Specifies the file containing the private host keys (default
391 .Pa /etc/ssh_host_key )
392 used by SSH protocol versions 1 and 2.
393 Note that
394 .Nm
395 will refuse to use a file if it is group/world-accessible.
396 It is possible to have multiple host key files.
397 .Dq rsa1
398 keys are used for version 1 and
399 .Dq dsa
400 or
401 .Dq rsa
402 are used for version 2 of the SSH protocol.
403 .It Cm IgnoreRhosts
404 Specifies that
405 .Pa .rhosts
406 and
407 .Pa .shosts
408 files will not be used in authentication.
409 .Pa /etc/hosts.equiv
410 and
411 .Pa /etc/shosts.equiv
412 are still used.
413 The default is
414 .Dq yes .
415 .It Cm IgnoreUserKnownHosts
416 Specifies whether
417 .Nm
418 should ignore the user's
419 .Pa $HOME/.ssh/known_hosts
420 during
421 .Cm RhostsRSAAuthentication .
422 The default is
423 .Dq no .
424 .It Cm KeepAlive
425 Specifies whether the system should send keepalive messages to the
426 other side.
427 If they are sent, death of the connection or crash of one
428 of the machines will be properly noticed.
429 However, this means that
430 connections will die if the route is down temporarily, and some people
431 find it annoying.
432 On the other hand, if keepalives are not sent,
433 sessions may hang indefinitely on the server, leaving
434 .Dq ghost
435 users and consuming server resources.
436 .Pp
437 The default is
438 .Dq yes
439 (to send keepalives), and the server will notice
440 if the network goes down or the client host reboots.
441 This avoids infinitely hanging sessions.
442 .Pp
443 To disable keepalives, the value should be set to
444 .Dq no
445 in both the server and the client configuration files.
446 .It Cm KerberosAuthentication
447 Specifies whether Kerberos authentication is allowed.
448 This can be in the form of a Kerberos ticket, or if
449 .Cm PasswordAuthentication
450 is yes, the password provided by the user will be validated through
451 the Kerberos KDC.
452 To use this option, the server needs a
453 Kerberos servtab which allows the verification of the KDC's identity.
454 Default is
455 .Dq yes .
456 .It Cm KerberosOrLocalPasswd
457 If set then if password authentication through Kerberos fails then
458 the password will be validated via any additional local mechanism
459 such as
460 .Pa /etc/passwd .
461 Default is
462 .Dq yes .
463 .It Cm KerberosTgtPassing
464 Specifies whether a Kerberos TGT may be forwarded to the server.
465 Default is
466 .Dq no ,
467 as this only works when the Kerberos KDC is actually an AFS kaserver.
468 .It Cm KerberosTicketCleanup
469 Specifies whether to automatically destroy the user's ticket cache
470 file on logout.
471 Default is
472 .Dq yes .
473 .It Cm KeyRegenerationInterval
474 The server key is automatically regenerated after this many seconds
475 (if it has been used).
476 The purpose of regeneration is to prevent
477 decrypting captured sessions by later breaking into the machine and
478 stealing the keys.
479 The key is never stored anywhere.
480 If the value is 0, the key is never regenerated.
481 The default is 3600 (seconds).
482 .It Cm ListenAddress
483 Specifies what local address
484 .Nm
485 should listen on.
486 The default is to listen to all local addresses.
487 Multiple options of this type are permitted.
488 Additionally, the
489 .Cm Ports
490 options must precede this option.
491 .It Cm LoginGraceTime
492 The server disconnects after this time if the user has not
493 successfully logged in.
494 If the value is 0, there is no time limit.
495 The default is 600 (seconds).
496 .It Cm LogLevel
497 Gives the verbosity level that is used when logging messages from
498 .Nm sshd .
499 The possible values are:
500 QUIET, FATAL, ERROR, INFO, VERBOSE and DEBUG.
501 The default is INFO.
502 Logging with level DEBUG violates the privacy of users
503 and is not recommended.
504 .It Cm MACs
505 Specifies the available MAC (message authentication code) algorithms.
506 The MAC algorithm is used in protocol version 2
507 for data integrity protection.
508 Multiple algorithms must be comma-separated.
509 The default is
510 .Pp
511 .Bd -literal
512   ``hmac-sha1,hmac-md5,hmac-ripemd160,hmac-ripemd160@openssh.com,
513     hmac-sha1-96,hmac-md5-96''
514 .Ed
515 .It Cm MaxStartups
516 Specifies the maximum number of concurrent unauthenticated connections to the
517 .Nm
518 daemon.
519 Additional connections will be dropped until authentication succeeds or the
520 .Cm LoginGraceTime
521 expires for a connection.
522 The default is 10.
523 .Pp
524 Alternatively, random early drop can be enabled by specifying
525 the three colon separated values
526 .Dq start:rate:full
527 (e.g., "10:30:60").
528 .Nm
529 will refuse connection attempts with a probability of
530 .Dq rate/100
531 (30%)
532 if there are currently
533 .Dq start
534 (10)
535 unauthenticated connections.
536 The probability increases linearly and all connection attempts
537 are refused if the number of unauthenticated connections reaches
538 .Dq full
539 (60).
540 .It Cm PasswordAuthentication
541 Specifies whether password authentication is allowed.
542 The default is
543 .Dq yes .
544 Note that this option applies to both protocol versions 1 and 2.
545 .It Cm PermitEmptyPasswords
546 When password authentication is allowed, it specifies whether the
547 server allows login to accounts with empty password strings.
548 The default is
549 .Dq no .
550 .It Cm PermitRootLogin
551 Specifies whether the root can log in using
552 .Xr ssh 1 .
553 The argument must be
554 .Dq yes ,
555 .Dq without-password
556 or
557 .Dq no .
558 The default is
559 .Dq yes .
560 If this options is set to
561 .Dq without-password
562 only password authentication is disabled for root.
563 .Pp
564 Root login with RSA authentication when the
565 .Ar command
566 option has been
567 specified will be allowed regardless of the value of this setting
568 (which may be useful for taking remote backups even if root login is
569 normally not allowed).
570 .It Cm PidFile
571 Specifies the file that contains the process identifier of the
572 .Nm
573 daemon.
574 The default is
575 .Pa /var/run/sshd.pid .
576 .It Cm Port
577 Specifies the port number that
578 .Nm
579 listens on.
580 The default is 22.
581 Multiple options of this type are permitted.
582 .It Cm PrintMotd
583 Specifies whether
584 .Nm
585 should print
586 .Pa /etc/motd
587 when a user logs in interactively.
588 (On some systems it is also printed by the shell,
589 .Pa /etc/profile ,
590 or equivalent.)
591 The default is
592 .Dq yes .
593 .It Cm Protocol
594 Specifies the protocol versions
595 .Nm
596 should support.
597 The possible values are
598 .Dq 1
599 and
600 .Dq 2 .
601 Multiple versions must be comma-separated.
602 The default is
603 .Dq 1 .
604 .It Cm RandomSeed
605 Obsolete.
606 Random number generation uses other techniques.
607 .It Cm ReverseMappingCheck
608 Specifies whether
609 .Nm
610 should try to verify the remote host name and check that
611 the resolved host name for the remote IP address maps back to the
612 very same IP address.
613 The default is
614 .Dq no .
615 .It Cm RhostsAuthentication
616 Specifies whether authentication using rhosts or /etc/hosts.equiv
617 files is sufficient.
618 Normally, this method should not be permitted because it is insecure.
619 .Cm RhostsRSAAuthentication
620 should be used
621 instead, because it performs RSA-based host authentication in addition
622 to normal rhosts or /etc/hosts.equiv authentication.
623 The default is
624 .Dq no .
625 .It Cm RhostsRSAAuthentication
626 Specifies whether rhosts or /etc/hosts.equiv authentication together
627 with successful RSA host authentication is allowed.
628 The default is
629 .Dq no .
630 .It Cm RSAAuthentication
631 Specifies whether pure RSA authentication is allowed.
632 The default is
633 .Dq yes .
634 Note that this option applies to protocol version 1 only.
635 .It Cm ServerKeyBits
636 Defines the number of bits in the server key.
637 The minimum value is 512, and the default is 768.
638 .It Cm ChallengeResponseAuthentication
639 Specifies whether
640 challenge reponse
641 authentication is allowed.
642 Currently there is only support for
643 .Xr skey 1
644 authentication.
645 The default is
646 .Dq yes .
647 .It Cm StrictModes
648 Specifies whether
649 .Nm
650 should check file modes and ownership of the
651 user's files and home directory before accepting login.
652 This is normally desirable because novices sometimes accidentally leave their
653 directory or files world-writable.
654 The default is
655 .Dq yes .
656 .It Cm Subsystem
657 Configures an external subsystem (e.g., file transfer daemon).
658 Arguments should be a subsystem name and a command to execute upon subsystem
659 request.
660 The command
661 .Xr sftp-server 8
662 implements the
663 .Dq sftp
664 file transfer subsystem.
665 By default no subsystems are defined.
666 Note that this option applies to protocol version 2 only.
667 .It Cm SyslogFacility
668 Gives the facility code that is used when logging messages from
669 .Nm sshd .
670 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
671 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
672 The default is AUTH.
673 .It Cm UseLogin
674 Specifies whether
675 .Xr login 1
676 is used for interactive login sessions.
677 Note that
678 .Xr login 1
679 is never used for remote command execution.
680 The default is
681 .Dq no .
682 .It Cm X11DisplayOffset
683 Specifies the first display number available for
684 .Nm sshd Ns 's
685 X11 forwarding.
686 This prevents
687 .Nm
688 from interfering with real X11 servers.
689 The default is 10.
690 .It Cm X11Forwarding
691 Specifies whether X11 forwarding is permitted.
692 The default is
693 .Dq no .
694 Note that disabling X11 forwarding does not improve security in any
695 way, as users can always install their own forwarders.
696 .It Cm XAuthLocation
697 Specifies the location of the
698 .Xr xauth 1
699 program.
700 The default is
701 .Pa /usr/X11R6/bin/xauth .
702 .El
703 .Sh LOGIN PROCESS
704 When a user successfully logs in,
705 .Nm
706 does the following:
707 .Bl -enum -offset indent
708 .It
709 If the login is on a tty, and no command has been specified,
710 prints last login time and
711 .Pa /etc/motd
712 (unless prevented in the configuration file or by
713 .Pa $HOME/.hushlogin ;
714 see the
715 .Sx FILES
716 section).
717 .It
718 If the login is on a tty, records login time.
719 .It
720 Checks
721 .Pa /etc/nologin ;
722 if it exists, prints contents and quits
723 (unless root).
724 .It
725 Changes to run with normal user privileges.
726 .It
727 Sets up basic environment.
728 .It
729 Reads
730 .Pa $HOME/.ssh/environment
731 if it exists.
732 .It
733 Changes to user's home directory.
734 .It
735 If
736 .Pa $HOME/.ssh/rc
737 exists, runs it; else if
738 .Pa /etc/sshrc
739 exists, runs
740 it; otherwise runs xauth.
741 The
742 .Dq rc
743 files are given the X11
744 authentication protocol and cookie in standard input.
745 .It
746 Runs user's shell or command.
747 .El
748 .Sh AUTHORIZED_KEYS FILE FORMAT
749 The
750 .Pa $HOME/.ssh/authorized_keys
751 file lists the RSA keys that are
752 permitted for RSA authentication in SSH protocols 1.3 and 1.5
753 Similarly, the
754 .Pa $HOME/.ssh/authorized_keys2
755 file lists the DSA and RSA keys that are
756 permitted for public key authentication (PubkeyAuthentication)
757 in SSH protocol 2.0.
758 .Pp
759 Each line of the file contains one
760 key (empty lines and lines starting with a
761 .Ql #
762 are ignored as
763 comments).
764 Each RSA public key consists of the following fields, separated by
765 spaces: options, bits, exponent, modulus, comment.
766 Each protocol version 2 public key consists of:
767 options, keytype, base64 encoded key, comment.
768 The options fields
769 are optional; its presence is determined by whether the line starts
770 with a number or not (the option field never starts with a number).
771 The bits, exponent, modulus and comment fields give the RSA key for
772 protocol version 1; the
773 comment field is not used for anything (but may be convenient for the
774 user to identify the key).
775 For protocol version 2 the keytype is
776 .Dq ssh-dss
777 or
778 .Dq ssh-rsa .
779 .Pp
780 Note that lines in this file are usually several hundred bytes long
781 (because of the size of the RSA key modulus).
782 You don't want to type them in; instead, copy the
783 .Pa identity.pub
784 or the
785 .Pa id_dsa.pub
786 file and edit it.
787 .Pp
788 The options (if present) consist of comma-separated option
789 specifications.
790 No spaces are permitted, except within double quotes.
791 The following option specifications are supported:
792 .Bl -tag -width Ds
793 .It Cm from="pattern-list"
794 Specifies that in addition to RSA authentication, the canonical name
795 of the remote host must be present in the comma-separated list of
796 patterns
797 .Pf ( Ql *
798 and
799 .Ql ?
800 serve as wildcards).
801 The list may also contain
802 patterns negated by prefixing them with
803 .Ql ! ;
804 if the canonical host name matches a negated pattern, the key is not accepted.
805 The purpose
806 of this option is to optionally increase security: RSA authentication
807 by itself does not trust the network or name servers or anything (but
808 the key); however, if somebody somehow steals the key, the key
809 permits an intruder to log in from anywhere in the world.
810 This additional option makes using a stolen key more difficult (name
811 servers and/or routers would have to be compromised in addition to
812 just the key).
813 .It Cm command="command"
814 Specifies that the command is executed whenever this key is used for
815 authentication.
816 The command supplied by the user (if any) is ignored.
817 The command is run on a pty if the connection requests a pty;
818 otherwise it is run without a tty.
819 Note that if you want a 8-bit clean channel,
820 you must not request a pty or should specify
821 .Cm no-pty .
822 A quote may be included in the command by quoting it with a backslash.
823 This option might be useful
824 to restrict certain RSA keys to perform just a specific operation.
825 An example might be a key that permits remote backups but nothing else.
826 Note that the client may specify TCP/IP and/or X11
827 forwarding unless they are explicitly prohibited.
828 .It Cm environment="NAME=value"
829 Specifies that the string is to be added to the environment when
830 logging in using this key.
831 Environment variables set this way
832 override other default environment values.
833 Multiple options of this type are permitted.
834 .It Cm no-port-forwarding
835 Forbids TCP/IP forwarding when this key is used for authentication.
836 Any port forward requests by the client will return an error.
837 This might be used, e.g., in connection with the
838 .Cm command
839 option.
840 .It Cm no-X11-forwarding
841 Forbids X11 forwarding when this key is used for authentication.
842 Any X11 forward requests by the client will return an error.
843 .It Cm no-agent-forwarding
844 Forbids authentication agent forwarding when this key is used for
845 authentication.
846 .It Cm no-pty
847 Prevents tty allocation (a request to allocate a pty will fail).
848 .El
849 .Ss Examples
850 1024 33 12121.\|.\|.\|312314325 ylo@foo.bar
851 .Pp
852 from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23.\|.\|.\|2334 ylo@niksula
853 .Pp
854 command="dump /home",no-pty,no-port-forwarding 1024 33 23.\|.\|.\|2323 backup.hut.fi
855 .Sh SSH_KNOWN_HOSTS FILE FORMAT
856 The
857 .Pa /etc/ssh_known_hosts ,
858 .Pa /etc/ssh_known_hosts2 ,
859 .Pa $HOME/.ssh/known_hosts ,
860 and
861 .Pa $HOME/.ssh/known_hosts2
862 files contain host public keys for all known hosts.
863 The global file should
864 be prepared by the administrator (optional), and the per-user file is
865 maintained automatically: whenever the user connects from an unknown host
866 its key is added to the per-user file.
867 .Pp
868 Each line in these files contains the following fields: hostnames,
869 bits, exponent, modulus, comment.
870 The fields are separated by spaces.
871 .Pp
872 Hostnames is a comma-separated list of patterns ('*' and '?' act as
873 wildcards); each pattern in turn is matched against the canonical host
874 name (when authenticating a client) or against the user-supplied
875 name (when authenticating a server).
876 A pattern may also be preceded by
877 .Ql !
878 to indicate negation: if the host name matches a negated
879 pattern, it is not accepted (by that line) even if it matched another
880 pattern on the line.
881 .Pp
882 Bits, exponent, and modulus are taken directly from the RSA host key; they
883 can be obtained, e.g., from
884 .Pa /etc/ssh_host_key.pub .
885 The optional comment field continues to the end of the line, and is not used.
886 .Pp
887 Lines starting with
888 .Ql #
889 and empty lines are ignored as comments.
890 .Pp
891 When performing host authentication, authentication is accepted if any
892 matching line has the proper key.
893 It is thus permissible (but not
894 recommended) to have several lines or different host keys for the same
895 names.
896 This will inevitably happen when short forms of host names
897 from different domains are put in the file.
898 It is possible
899 that the files contain conflicting information; authentication is
900 accepted if valid information can be found from either file.
901 .Pp
902 Note that the lines in these files are typically hundreds of characters
903 long, and you definitely don't want to type in the host keys by hand.
904 Rather, generate them by a script
905 or by taking
906 .Pa /etc/ssh_host_key.pub
907 and adding the host names at the front.
908 .Ss Examples
909 closenet,closenet.hut.fi,.\|.\|.\|,130.233.208.41 1024 37 159.\|.\|.93 closenet.hut.fi
910 .Sh FILES
911 .Bl -tag -width Ds
912 .It Pa /etc/sshd_config
913 Contains configuration data for
914 .Nm sshd .
915 This file should be writable by root only, but it is recommended
916 (though not necessary) that it be world-readable.
917 .It Pa /etc/ssh_host_key
918 Contains the private part of the host key.
919 This file should only be owned by root, readable only by root, and not
920 accessible to others.
921 Note that
922 .Nm
923 does not start if this file is group/world-accessible.
924 .It Pa /etc/ssh_host_key.pub
925 Contains the public part of the host key.
926 This file should be world-readable but writable only by
927 root.
928 Its contents should match the private part.
929 This file is not
930 really used for anything; it is only provided for the convenience of
931 the user so its contents can be copied to known hosts files.
932 These two files are created using
933 .Xr ssh-keygen 1 .
934 .It Pa /etc/primes
935 Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
936 .It Pa /var/run/sshd.pid
937 Contains the process ID of the
938 .Nm
939 listening for connections (if there are several daemons running
940 concurrently for different ports, this contains the pid of the one
941 started last).
942 The content of this file is not sensitive; it can be world-readable.
943 .It Pa $HOME/.ssh/authorized_keys
944 Lists the RSA keys that can be used to log into the user's account.
945 This file must be readable by root (which may on some machines imply
946 it being world-readable if the user's home directory resides on an NFS
947 volume).
948 It is recommended that it not be accessible by others.
949 The format of this file is described above.
950 Users will place the contents of their
951 .Pa identity.pub
952 files into this file, as described in
953 .Xr ssh-keygen 1 .
954 .It Pa $HOME/.ssh/authorized_keys2
955 Lists the DSA keys that can be used to log into the user's account.
956 This file must be readable by root (which may on some machines imply
957 it being world-readable if the user's home directory resides on an NFS
958 volume).
959 It is recommended that it not be accessible by others.
960 The format of this file is described above.
961 Users will place the contents of their
962 .Pa id_dsa.pub
963 files into this file, as described in
964 .Xr ssh-keygen 1 .
965 .It Pa "/etc/ssh_known_hosts" and "$HOME/.ssh/known_hosts"
966 These files are consulted when using rhosts with RSA host
967 authentication to check the public key of the host.
968 The key must be listed in one of these files to be accepted.
969 The client uses the same files
970 to verify that the remote host is the one it intended to connect.
971 These files should be writable only by root/the owner.
972 .Pa /etc/ssh_known_hosts
973 should be world-readable, and
974 .Pa $HOME/.ssh/known_hosts
975 can but need not be world-readable.
976 .It Pa /etc/nologin
977 If this file exists,
978 .Nm
979 refuses to let anyone except root log in.
980 The contents of the file
981 are displayed to anyone trying to log in, and non-root connections are
982 refused.
983 The file should be world-readable.
984 .It Pa /etc/hosts.allow, /etc/hosts.deny
985 If compiled with
986 .Sy LIBWRAP
987 support, tcp-wrappers access controls may be defined here as described in
988 .Xr hosts_access 5 .
989 .It Pa $HOME/.rhosts
990 This file contains host-username pairs, separated by a space, one per
991 line.
992 The given user on the corresponding host is permitted to log in
993 without password.
994 The same file is used by rlogind and rshd.
995 The file must
996 be writable only by the user; it is recommended that it not be
997 accessible by others.
998 .Pp
999 If is also possible to use netgroups in the file.
1000 Either host or user
1001 name may be of the form +@groupname to specify all hosts or all users
1002 in the group.
1003 .It Pa $HOME/.shosts
1004 For ssh,
1005 this file is exactly the same as for
1006 .Pa .rhosts .
1007 However, this file is
1008 not used by rlogin and rshd, so using this permits access using SSH only.
1009 .It Pa /etc/hosts.equiv
1010 This file is used during
1011 .Pa .rhosts
1012 authentication.
1013 In the simplest form, this file contains host names, one per line.
1014 Users on
1015 those hosts are permitted to log in without a password, provided they
1016 have the same user name on both machines.
1017 The host name may also be
1018 followed by a user name; such users are permitted to log in as
1019 .Em any
1020 user on this machine (except root).
1021 Additionally, the syntax
1022 .Dq +@group
1023 can be used to specify netgroups.
1024 Negated entries start with
1025 .Ql \&- .
1026 .Pp
1027 If the client host/user is successfully matched in this file, login is
1028 automatically permitted provided the client and server user names are the
1029 same.
1030 Additionally, successful RSA host authentication is normally required.
1031 This file must be writable only by root; it is recommended
1032 that it be world-readable.
1033 .Pp
1034 .Sy "Warning: It is almost never a good idea to use user names in"
1035 .Pa hosts.equiv .
1036 Beware that it really means that the named user(s) can log in as
1037 .Em anybody ,
1038 which includes bin, daemon, adm, and other accounts that own critical
1039 binaries and directories.
1040 Using a user name practically grants the user root access.
1041 The only valid use for user names that I can think
1042 of is in negative entries.
1043 .Pp
1044 Note that this warning also applies to rsh/rlogin.
1045 .It Pa /etc/shosts.equiv
1046 This is processed exactly as
1047 .Pa /etc/hosts.equiv .
1048 However, this file may be useful in environments that want to run both
1049 rsh/rlogin and ssh.
1050 .It Pa $HOME/.ssh/environment
1051 This file is read into the environment at login (if it exists).
1052 It can only contain empty lines, comment lines (that start with
1053 .Ql # ) ,
1054 and assignment lines of the form name=value.
1055 The file should be writable
1056 only by the user; it need not be readable by anyone else.
1057 .It Pa $HOME/.ssh/rc
1058 If this file exists, it is run with /bin/sh after reading the
1059 environment files but before starting the user's shell or command.
1060 If X11 spoofing is in use, this will receive the "proto cookie" pair in
1061 standard input (and
1062 .Ev DISPLAY
1063 in environment).
1064 This must call
1065 .Xr xauth 1
1066 in that case.
1067 .Pp
1068 The primary purpose of this file is to run any initialization routines
1069 which may be needed before the user's home directory becomes
1070 accessible; AFS is a particular example of such an environment.
1071 .Pp
1072 This file will probably contain some initialization code followed by
1073 something similar to: "if read proto cookie; then echo add $DISPLAY
1074 $proto $cookie | xauth -q -; fi".
1075 .Pp
1076 If this file does not exist,
1077 .Pa /etc/sshrc
1078 is run, and if that
1079 does not exist either, xauth is used to store the cookie.
1080 .Pp
1081 This file should be writable only by the user, and need not be
1082 readable by anyone else.
1083 .It Pa /etc/sshrc
1084 Like
1085 .Pa $HOME/.ssh/rc .
1086 This can be used to specify
1087 machine-specific login-time initializations globally.
1088 This file should be writable only by root, and should be world-readable.
1089 .El
1090 .Sh AUTHORS
1091 OpenSSH is a derivative of the original and free
1092 ssh 1.2.12 release by Tatu Ylonen.
1093 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1094 Theo de Raadt and Dug Song
1095 removed many bugs, re-added newer features and
1096 created OpenSSH.
1097 Markus Friedl contributed the support for SSH
1098 protocol versions 1.5 and 2.0.
1099 .Sh SEE ALSO
1100 .Xr scp 1 ,
1101 .Xr sftp 1 ,
1102 .Xr sftp-server 8 ,
1103 .Xr ssh 1 ,
1104 .Xr ssh-add 1 ,
1105 .Xr ssh-agent 1 ,
1106 .Xr ssh-keygen 1 ,
1107 .Xr rlogin 1 ,
1108 .Xr rsh 1
This page took 0.111412 seconds and 3 git commands to generate.