sshd.8 30.9 KB
Newer Older
1 2 3 4 5
.\"
.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
.\"                    All rights reserved
.\"
6 7 8 9 10 11
.\" As far as I am concerned, the code I have written for this software
.\" can be used freely for any purpose.  Any derived versions of this
.\" software must be clearly marked as such, and if the derived work is
.\" incompatible with the protocol description in the RFC file, it must be
.\" called by a name other than "ssh" or "Secure Shell".
.\"
12 13 14
.\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
.\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
.\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
15 16 17 18 19 20 21 22 23
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
24
.\"
25 26 27 28 29 30 31 32 33 34
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35
.\"
djm@openbsd.org's avatar
djm@openbsd.org committed
36 37
.\" $OpenBSD: sshd.8,v 1.279 2015/05/01 07:11:47 djm Exp $
.Dd $Mdocdate: May 1 2015 $
38 39 40 41
.Dt SSHD 8
.Os
.Sh NAME
.Nm sshd
42
.Nd OpenSSH SSH daemon
43 44
.Sh SYNOPSIS
.Nm sshd
45
.Bk -words
46
.Op Fl 46DdeiqTt
47
.Op Fl b Ar bits
48
.Op Fl C Ar connection_spec
Damien Miller's avatar
Damien Miller committed
49
.Op Fl c Ar host_certificate_file
50
.Op Fl E Ar log_file
51 52 53 54
.Op Fl f Ar config_file
.Op Fl g Ar login_grace_time
.Op Fl h Ar host_key_file
.Op Fl k Ar key_gen_time
55
.Op Fl o Ar option
56
.Op Fl p Ar port
57
.Op Fl u Ar len
58
.Ek
59
.Sh DESCRIPTION
60
.Nm
61
(OpenSSH Daemon) is the daemon program for
62
.Xr ssh 1 .
63
Together these programs replace rlogin and rsh,
64
and provide secure encrypted communications between two untrusted hosts
Damien Miller's avatar
Damien Miller committed
65
over an insecure network.
66 67
.Pp
.Nm
68
listens for connections from clients.
69
It is normally started at boot from
70
.Pa /etc/init.d/ssh .
71
It forks a new
Damien Miller's avatar
Damien Miller committed
72 73
daemon for each incoming connection.
The forked daemons handle
74 75 76 77
key exchange, encryption, authentication, command execution,
and data exchange.
.Pp
.Nm
78 79
can be configured using command-line options or a configuration file
(by default
80 81
.Xr sshd_config 5 ) ;
command-line options override values specified in the
82
configuration file.
Damien Miller's avatar
Damien Miller committed
83 84
.Nm
rereads its configuration file when it receives a hangup signal,
85
.Dv SIGHUP ,
86
by executing itself with the name and options it was started with, e.g.\&
87
.Pa /usr/sbin/sshd .
Damien Miller's avatar
Damien Miller committed
88
.Pp
89 90
The options are as follows:
.Bl -tag -width Ds
91 92 93 94 95 96 97 98
.It Fl 4
Forces
.Nm
to use IPv4 addresses only.
.It Fl 6
Forces
.Nm
to use IPv6 addresses only.
99
.It Fl b Ar bits
100
Specifies the number of bits in the ephemeral protocol version 1
101
server key (default 1024).
102 103 104 105 106 107 108 109 110 111 112 113 114
.It Fl C Ar connection_spec
Specify the connection parameters to use for the
.Fl T
extended test mode.
If provided, any
.Cm Match
directives in the configuration file
that would apply to the specified user, host, and address will be set before
the configuration is written to standard output.
The connection parameters are supplied as keyword=value pairs.
The keywords are
.Dq user ,
.Dq host ,
115 116
.Dq laddr ,
.Dq lport ,
117 118 119 120 121
and
.Dq addr .
All are required and may be supplied in any order, either with multiple
.Fl C
options or as a comma-separated list.
122 123 124 125 126 127 128 129 130
.It Fl c Ar host_certificate_file
Specifies a path to a certificate file to identify
.Nm
during key exchange.
The certificate file must match a host key file specified using the
.Fl h
option or the
.Cm HostKey
configuration directive.
131 132 133 134 135 136
.It Fl D
When this option is specified,
.Nm
will not detach and does not become a daemon.
This allows easy monitoring of
.Nm sshd .
137
.It Fl d
Damien Miller's avatar
Damien Miller committed
138
Debug mode.
139 140
The server sends verbose debug output to standard error,
and does not put itself in the background.
Damien Miller's avatar
Damien Miller committed
141 142
The server also will not fork and will only process one connection.
This option is only intended for debugging for the server.
143 144 145
Multiple
.Fl d
options increase the debugging level.
146
Maximum is 3.
147 148 149 150
.It Fl E Ar log_file
Append debug logs to
.Ar log_file
instead of the system log.
151
.It Fl e
152
Write debug logs to standard error instead of the system log.
153
.It Fl f Ar config_file
Damien Miller's avatar
Damien Miller committed
154 155
Specifies the name of the configuration file.
The default is
156
.Pa /etc/ssh/sshd_config .
157 158 159 160
.Nm
refuses to start if there is no configuration file.
.It Fl g Ar login_grace_time
Gives the grace time for clients to authenticate themselves (default
161
120 seconds).
Damien Miller's avatar
Damien Miller committed
162 163 164
If the client fails to authenticate the user within
this many seconds, the server disconnects and exits.
A value of zero indicates no limit.
165
.It Fl h Ar host_key_file
166
Specifies a file from which a host key is read.
167 168 169
This option must be given if
.Nm
is not run as root (as the normal
170 171
host key files are normally not readable by anyone but root).
The default is
172
.Pa /etc/ssh/ssh_host_key
173
for protocol version 1, and
174
.Pa /etc/ssh/ssh_host_dsa_key ,
175 176
.Pa /etc/ssh/ssh_host_ecdsa_key .
.Pa /etc/ssh/ssh_host_ed25519_key
177
and
178
.Pa /etc/ssh/ssh_host_rsa_key
179
for protocol version 2.
180
It is possible to have multiple host key files for
181
the different protocol versions and host key algorithms.
182 183 184
.It Fl i
Specifies that
.Nm
185 186
is being run from
.Xr inetd 8 .
187 188 189
.Nm
is normally not run
from inetd because it needs to generate the server key before it can
Damien Miller's avatar
Damien Miller committed
190 191
respond to the client, and this may take tens of seconds.
Clients would have to wait too long if the key was regenerated every time.
192
However, with small key sizes (e.g. 512) using
193 194 195 196
.Nm
from inetd may
be feasible.
.It Fl k Ar key_gen_time
197 198
Specifies how often the ephemeral protocol version 1 server key is
regenerated (default 3600 seconds, or one hour).
Damien Miller's avatar
Damien Miller committed
199
The motivation for regenerating the key fairly
200
often is that the key is not stored anywhere, and after about an hour
201 202
it becomes impossible to recover the key for decrypting intercepted
communications even if the machine is cracked into or physically
Damien Miller's avatar
Damien Miller committed
203 204
seized.
A value of zero indicates that the key will never be regenerated.
205 206 207 208
.It Fl o Ar option
Can be used to give options in the format used in the configuration file.
This is useful for specifying options for which there is no separate
command-line flag.
209 210
For full details of the options, and their values, see
.Xr sshd_config 5 .
211 212 213
.It Fl p Ar port
Specifies the port on which the server listens for connections
(default 22).
214
Multiple port options are permitted.
215 216 217 218 219 220
Ports specified in the configuration file with the
.Cm Port
option are ignored when a command-line port is specified.
Ports specified using the
.Cm ListenAddress
option override command-line ports.
221
.It Fl q
Damien Miller's avatar
Damien Miller committed
222 223 224
Quiet mode.
Nothing is sent to the system log.
Normally the beginning,
225
authentication, and termination of each connection is logged.
226 227 228 229 230 231 232 233 234
.It Fl T
Extended test mode.
Check the validity of the configuration file, output the effective configuration
to stdout and then exit.
Optionally,
.Cm Match
rules may be applied by specifying the connection parameters using one or more
.Fl C
options.
235 236 237 238 239 240
.It Fl t
Test mode.
Only check the validity of the configuration file and sanity of the keys.
This is useful for updating
.Nm
reliably as configuration options may change.
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
.It Fl u Ar len
This option is used to specify the size of the field
in the
.Li utmp
structure that holds the remote host name.
If the resolved host name is longer than
.Ar len ,
the dotted decimal value will be used instead.
This allows hosts with very long host names that
overflow this field to still be uniquely identified.
Specifying
.Fl u0
indicates that only dotted decimal addresses
should be put into the
.Pa utmp
file.
257
.Fl u0
258
may also be used to prevent
259 260 261 262 263
.Nm
from making DNS requests unless the authentication
mechanism or configuration requires it.
Authentication mechanisms that may require DNS include
.Cm RhostsRSAAuthentication ,
264
.Cm HostbasedAuthentication ,
265 266 267
and using a
.Cm from="pattern-list"
option in a key file.
268 269 270 271 272
Configuration options that require DNS include using a
USER@HOST pattern in
.Cm AllowUsers
or
.Cm DenyUsers .
273
.El
274 275
.Sh AUTHENTICATION
The OpenSSH SSH daemon supports SSH protocols 1 and 2.
276
The default is to use protocol 2 only,
277 278 279 280
though this can be changed via the
.Cm Protocol
option in
.Xr sshd_config 5 .
sobrado@openbsd.org's avatar
sobrado@openbsd.org committed
281
Protocol 2 supports DSA, ECDSA, Ed25519 and RSA keys;
282 283 284 285 286
protocol 1 only supports RSA keys.
For both protocols,
each host has a host-specific key,
normally 2048 bits,
used to identify the host.
287
.Pp
288 289 290 291
Forward security for protocol 1 is provided through
an additional server key,
normally 768 bits,
generated when the server starts.
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
This key is normally regenerated every hour if it has been used, and
is never stored on disk.
Whenever a client connects, the daemon responds with its public
host and server keys.
The client compares the
RSA host key against its own database to verify that it has not changed.
The client then generates a 256-bit random number.
It encrypts this
random number using both the host key and the server key, and sends
the encrypted number to the server.
Both sides then use this
random number as a session key which is used to encrypt all further
communications in the session.
The rest of the session is encrypted
using a conventional cipher, currently Blowfish or 3DES, with 3DES
being used by default.
The client selects the encryption algorithm
to use from those offered by the server.
.Pp
311 312 313 314 315 316 317 318 319
For protocol 2,
forward security is provided through a Diffie-Hellman key agreement.
This key agreement results in a shared session key.
The rest of the session is encrypted using a symmetric cipher, currently
128-bit AES, Blowfish, 3DES, CAST128, Arcfour, 192-bit AES, or 256-bit AES.
The client selects the encryption algorithm
to use from those offered by the server.
Additionally, session integrity is provided
through a cryptographic message authentication code
320
(hmac-md5, hmac-sha1, umac-64, umac-128, hmac-ripemd160,
321
hmac-sha2-256 or hmac-sha2-512).
322 323
.Pp
Finally, the server and the client enter an authentication dialog.
324
The client tries to authenticate itself using
325 326 327 328
host-based authentication,
public key authentication,
challenge-response authentication,
or password authentication.
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
.Pp
Regardless of the authentication type, the account is checked to
ensure that it is accessible.  An account is not accessible if it is
locked, listed in
.Cm DenyUsers
or its group is listed in
.Cm DenyGroups
\&.  The definition of a locked account is system dependant. Some platforms
have their own account database (eg AIX) and some modify the passwd field (
.Ql \&*LK\&*
on Solaris and UnixWare,
.Ql \&*
on HP-UX, containing
.Ql Nologin
on Tru64,
a leading
.Ql \&*LOCKED\&*
on FreeBSD and a leading
347 348 349
.Ql \&!
on most Linuxes).
If there is a requirement to disable password authentication
350 351 352 353 354 355 356 357 358 359 360 361 362 363
for the account while allowing still public-key, then the passwd field
should be set to something other than these values (eg
.Ql NP
or
.Ql \&*NP\&*
).
.Pp
If the client successfully authenticates itself, a dialog for
preparing the session is entered.
At this time the client may request
things like allocating a pseudo-tty, forwarding X11 connections,
forwarding TCP connections, or forwarding the authentication agent
connection over the secure channel.
.Pp
364
After this, the client either requests a shell or execution of a command.
365 366 367 368 369 370 371 372
The sides then enter session mode.
In this mode, either side may send
data at any time, and such data is forwarded to/from the shell or
command on the server side, and the user terminal in the client side.
.Pp
When the user program terminates and all forwarded X11 and other
connections have been closed, the server sends command exit status to
the client, and both sides exit.
373 374 375 376 377 378 379
.Sh LOGIN PROCESS
When a user successfully logs in,
.Nm
does the following:
.Bl -enum -offset indent
.It
If the login is on a tty, and no command has been specified,
380
prints last login time and
381 382
.Pa /etc/motd
(unless prevented in the configuration file or by
383
.Pa ~/.hushlogin ;
384
see the
385
.Sx FILES
386 387 388 389 390 391 392 393 394 395 396 397 398
section).
.It
If the login is on a tty, records login time.
.It
Checks
.Pa /etc/nologin ;
if it exists, prints contents and quits
(unless root).
.It
Changes to run with normal user privileges.
.It
Sets up basic environment.
.It
399
Reads the file
400
.Pa ~/.ssh/environment ,
401
if it exists, and users are allowed to change their environment.
402
See the
403
.Cm PermitUserEnvironment
404
option in
405
.Xr sshd_config 5 .
406 407 408 409
.It
Changes to user's home directory.
.It
If
410
.Pa ~/.ssh/rc
411 412 413 414
exists and the
.Xr sshd_config 5
.Cm PermitUserRC
option is set, runs it; else if
415
.Pa /etc/ssh/sshrc
416
exists, runs
Damien Miller's avatar
Damien Miller committed
417 418
it; otherwise runs xauth.
The
419 420 421
.Dq rc
files are given the X11
authentication protocol and cookie in standard input.
422 423 424
See
.Sx SSHRC ,
below.
425 426
.It
Runs user's shell or command.
djm@openbsd.org's avatar
djm@openbsd.org committed
427 428
All commands are run under the user's login shell as specified in the
system password database.
429
.El
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
.Sh SSHRC
If the file
.Pa ~/.ssh/rc
exists,
.Xr sh 1
runs it after reading the
environment files but before starting the user's shell or command.
It must not produce any output on stdout; stderr must be used
instead.
If X11 forwarding is in use, it will receive the "proto cookie" pair in
its standard input (and
.Ev DISPLAY
in its environment).
The script must call
.Xr xauth 1
because
.Nm
will not run xauth automatically to add X11 cookies.
.Pp
The primary purpose of this file is to run any initialization routines
which may be needed before the user's home directory becomes
accessible; AFS is a particular example of such an environment.
.Pp
This file will probably contain some initialization code followed by
something similar to:
.Bd -literal -offset 3n
if read proto cookie && [ -n "$DISPLAY" ]; then
	if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
		# X11UseLocalhost=yes
		echo add unix:`echo $DISPLAY |
		    cut -c11-` $proto $cookie
	else
		# X11UseLocalhost=no
		echo add $DISPLAY $proto $cookie
	fi | xauth -q -
fi
.Ed
.Pp
If this file does not exist,
.Pa /etc/ssh/sshrc
is run, and if that
does not exist either, xauth is used to add the cookie.
472
.Sh AUTHORIZED_KEYS FILE FORMAT
473
.Cm AuthorizedKeysFile
474
specifies the files containing public keys for
475
public key authentication;
476
if none is specified, the default is
Damien Miller's avatar
Damien Miller committed
477 478 479
.Pa ~/.ssh/authorized_keys
and
.Pa ~/.ssh/authorized_keys2 .
Damien Miller's avatar
Damien Miller committed
480
Each line of the file contains one
481 482 483
key (empty lines and lines starting with a
.Ql #
are ignored as
Damien Miller's avatar
Damien Miller committed
484
comments).
485 486 487 488 489 490
Protocol 1 public keys consist of the following space-separated fields:
options, bits, exponent, modulus, comment.
Protocol 2 public key consist of:
options, keytype, base64-encoded key, comment.
The options field is optional;
its presence is determined by whether the line starts
491
with a number or not (the options field never starts with a number).
492
The bits, exponent, modulus, and comment fields give the RSA key for
493
protocol version 1; the
494 495
comment field is not used for anything (but may be convenient for the
user to identify the key).
496
For protocol version 2 the keytype is
497 498 499
.Dq ecdsa-sha2-nistp256 ,
.Dq ecdsa-sha2-nistp384 ,
.Dq ecdsa-sha2-nistp521 ,
500
.Dq ssh-ed25519 ,
501 502 503
.Dq ssh-dss
or
.Dq ssh-rsa .
504 505
.Pp
Note that lines in this file are usually several hundred bytes long
506 507 508
(because of the size of the public key encoding) up to a limit of
8 kilobytes, which permits DSA keys up to 8 kilobits and RSA
keys up to 16 kilobits.
Damien Miller's avatar
Damien Miller committed
509
You don't want to type them in; instead, copy the
510
.Pa identity.pub ,
511
.Pa id_dsa.pub ,
512
.Pa id_ecdsa.pub ,
513
.Pa id_ed25519.pub ,
514 515
or the
.Pa id_rsa.pub
516 517
file and edit it.
.Pp
518 519 520 521
.Nm
enforces a minimum RSA key modulus size for protocol 1
and protocol 2 keys of 768 bits.
.Pp
522
The options (if present) consist of comma-separated option
Damien Miller's avatar
Damien Miller committed
523 524
specifications.
No spaces are permitted, except within double quotes.
525 526
The following option specifications are supported (note
that option keywords are case-insensitive):
527
.Bl -tag -width Ds
528
.It Cm cert-authority
Damien Miller's avatar
Damien Miller committed
529 530 531 532 533 534
Specifies that the listed key is a certification authority (CA) that is
trusted to validate signed certificates for user authentication.
.Pp
Certificates may encode access restrictions similar to these key options.
If both certificate restrictions and key options are present, the most
restrictive union of the two is applied.
535 536
.It Cm command="command"
Specifies that the command is executed whenever this key is used for
Damien Miller's avatar
Damien Miller committed
537 538
authentication.
The command supplied by the user (if any) is ignored.
539
The command is run on a pty if the client requests a pty;
Damien Miller's avatar
Damien Miller committed
540
otherwise it is run without a tty.
541
If an 8-bit clean channel is required,
542
one must not request a pty or should specify
543
.Cm no-pty .
Damien Miller's avatar
Damien Miller committed
544 545
A quote may be included in the command by quoting it with a backslash.
This option might be useful
546
to restrict certain public keys to perform just a specific operation.
Damien Miller's avatar
Damien Miller committed
547
An example might be a key that permits remote backups but nothing else.
548
Note that the client may specify TCP and/or X11
Damien Miller's avatar
Damien Miller committed
549
forwarding unless they are explicitly prohibited.
550 551 552
The command originally supplied by the client is available in the
.Ev SSH_ORIGINAL_COMMAND
environment variable.
553
Note that this option applies to shell, command or subsystem execution.
Damien Miller's avatar
Damien Miller committed
554 555 556 557
Also note that this command may be superseded by either a
.Xr sshd_config 5
.Cm ForceCommand
directive or a command embedded in a certificate.
558 559
.It Cm environment="NAME=value"
Specifies that the string is to be added to the environment when
Damien Miller's avatar
Damien Miller committed
560 561 562 563
logging in using this key.
Environment variables set this way
override other default environment values.
Multiple options of this type are permitted.
564 565 566 567
Environment processing is disabled by default and is
controlled via the
.Cm PermitUserEnvironment
option.
568 569 570
This option is automatically disabled if
.Cm UseLogin
is enabled.
571
.It Cm from="pattern-list"
572
Specifies that in addition to public key authentication, either the canonical
573
name of the remote host or its IP address must be present in the
574
comma-separated list of patterns.
575
See PATTERNS in
576 577
.Xr ssh_config 5
for more information on patterns.
578 579 580 581
.Pp
In addition to the wildcard matching that may be applied to hostnames or
addresses, a
.Cm from
582
stanza may match IP addresses using CIDR address/masklen notation.
583 584 585 586 587 588 589 590
.Pp
The purpose of this option is to optionally increase security: public key
authentication by itself does not trust the network or name servers or
anything (but the key); however, if somebody somehow steals the key, the key
permits an intruder to log in from anywhere in the world.
This additional option makes using a stolen key more difficult (name
servers and/or routers would have to be compromised in addition to
just the key).
591 592 593
.It Cm no-agent-forwarding
Forbids authentication agent forwarding when this key is used for
authentication.
594
.It Cm no-port-forwarding
595
Forbids TCP forwarding when this key is used for authentication.
Damien Miller's avatar
Damien Miller committed
596
Any port forward requests by the client will return an error.
597
This might be used, e.g. in connection with the
598 599
.Cm command
option.
600 601
.It Cm no-pty
Prevents tty allocation (a request to allocate a pty will fail).
602
.It Cm no-user-rc
603
Disables execution of
604
.Pa ~/.ssh/rc .
605 606 607
.It Cm no-X11-forwarding
Forbids X11 forwarding when this key is used for authentication.
Any X11 forward requests by the client will return an error.
608
.It Cm permitopen="host:port"
bentley@openbsd.org's avatar
bentley@openbsd.org committed
609 610 611 612
Limit local port forwarding with
.Xr ssh 1
.Fl L
such that it may only connect to the specified host and port.
613
IPv6 addresses can be specified by enclosing the address in square brackets.
614
Multiple
615
.Cm permitopen
616 617 618
options may be applied separated by commas.
No pattern matching is performed on the specified hostnames,
they must be literal domains or addresses.
619 620 621
A port specification of
.Cm *
matches any port.
622 623 624 625 626 627 628 629 630 631 632
.It Cm principals="principals"
On a
.Cm cert-authority
line, specifies allowed principals for certificate authentication as a
comma-separated list.
At least one name from the list must appear in the certificate's
list of principals for the certificate to be accepted.
This option is ignored for keys that are not marked as trusted certificate
signers using the
.Cm cert-authority
option.
633 634 635 636 637 638
.It Cm tunnel="n"
Force a
.Xr tun 4
device on the server.
Without this option, the next available device will be used if
the client requests a tunnel.
639 640
.El
.Pp
641
An example authorized_keys file:
642
.Bd -literal -offset 3n
643 644
# Comments allowed at start of line
ssh-rsa AAAAB3Nza...LiPk== user@example.net
645 646 647 648 649 650 651 652
from="*.sales.example.net,!pc.sales.example.net" ssh-rsa
AAAAB2...19Q== john@example.net
command="dump /home",no-pty,no-port-forwarding ssh-dss
AAAAC3...51R== example.net
permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss
AAAAB5...21S==
tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...==
jane@example.net
653
.Ed
654
.Sh SSH_KNOWN_HOSTS FILE FORMAT
655
The
656
.Pa /etc/ssh/ssh_known_hosts
657
and
658
.Pa ~/.ssh/known_hosts
Damien Miller's avatar
Damien Miller committed
659 660 661
files contain host public keys for all known hosts.
The global file should
be prepared by the administrator (optional), and the per-user file is
662
maintained automatically: whenever the user connects from an unknown host,
Damien Miller's avatar
Damien Miller committed
663
its key is added to the per-user file.
664
.Pp
665 666
Each line in these files contains the following fields: markers (optional),
hostnames, bits, exponent, modulus, comment.
Damien Miller's avatar
Damien Miller committed
667
The fields are separated by spaces.
668
.Pp
669 670 671 672 673 674 675 676 677
The marker is optional, but if it is present then it must be one of
.Dq @cert-authority ,
to indicate that the line contains a certification authority (CA) key,
or
.Dq @revoked ,
to indicate that the key contained on the line is revoked and must not ever
be accepted.
Only one marker should be used on a key line.
.Pp
678
Hostnames is a comma-separated list of patterns
679
.Pf ( Ql *
680 681
and
.Ql \&?
682
act as
683 684
wildcards); each pattern in turn is matched against the canonical host
name (when authenticating a client) or against the user-supplied
Damien Miller's avatar
Damien Miller committed
685 686
name (when authenticating a server).
A pattern may also be preceded by
687
.Ql \&!
688 689 690
to indicate negation: if the host name matches a negated
pattern, it is not accepted (by that line) even if it matched another
pattern on the line.
691 692 693 694 695 696
A hostname or address may optionally be enclosed within
.Ql \&[
and
.Ql \&]
brackets then followed by
.Ql \&:
697
and a non-standard port number.
698
.Pp
699
Alternately, hostnames may be stored in a hashed form which hides host names
700 701 702
and addresses should the file's contents be disclosed.
Hashed hostnames start with a
.Ql |
703 704 705 706
character.
Only one hashed hostname may appear on a single line and none of the above
negation or wildcard operators may be applied.
.Pp
707
Bits, exponent, and modulus are taken directly from the RSA host key; they
708
can be obtained, for example, from
709
.Pa /etc/ssh/ssh_host_key.pub .
710 711 712 713 714 715 716
The optional comment field continues to the end of the line, and is not used.
.Pp
Lines starting with
.Ql #
and empty lines are ignored as comments.
.Pp
When performing host authentication, authentication is accepted if any
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
matching line has the proper key; either one that matches exactly or,
if the server has presented a certificate for authentication, the key
of the certification authority that signed the certificate.
For a key to be trusted as a certification authority, it must use the
.Dq @cert-authority
marker described above.
.Pp
The known hosts file also provides a facility to mark keys as revoked,
for example when it is known that the associated private key has been
stolen.
Revoked keys are specified by including the
.Dq @revoked
marker at the beginning of the key line, and are never accepted for
authentication or as certification authorities, but instead will
produce a warning from
.Xr ssh 1
when they are encountered.
.Pp
It is permissible (but not
736
recommended) to have several lines or different host keys for the same
Damien Miller's avatar
Damien Miller committed
737 738 739 740
names.
This will inevitably happen when short forms of host names
from different domains are put in the file.
It is possible
741 742 743 744 745
that the files contain conflicting information; authentication is
accepted if valid information can be found from either file.
.Pp
Note that the lines in these files are typically hundreds of characters
long, and you definitely don't want to type in the host keys by hand.
746 747
Rather, generate them by a script,
.Xr ssh-keyscan 1
748
or by taking
749
.Pa /etc/ssh/ssh_host_key.pub
750
and adding the host names at the front.
751
.Xr ssh-keygen 1
752
also offers some basic automated editing for
753 754 755
.Pa ~/.ssh/known_hosts
including removing hosts matching a host name and converting all host
names to their hashed representations.
756 757 758 759 760 761
.Pp
An example ssh_known_hosts file:
.Bd -literal -offset 3n
# Comments allowed at start of line
closenet,...,192.0.2.53 1024 37 159...93 closenet.example.net
cvs.example.net,192.0.2.10 ssh-rsa AAAA1234.....=
762 763 764
# A hashed hostname
|1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
AAAA1234.....=
765 766 767 768
# A revoked key
@revoked * ssh-rsa AAAAB5W...
# A CA key, accepted for any host in *.mydomain.com or *.mydomain.org
@cert-authority *.mydomain.org,*.mydomain.com ssh-rsa AAAAB5W...
769
.Ed
770
.Sh FILES
771
.Bl -tag -width Ds -compact
772
.It Pa ~/.hushlogin
773 774 775 776 777 778 779 780 781 782
This file is used to suppress printing the last login time and
.Pa /etc/motd ,
if
.Cm PrintLastLog
and
.Cm PrintMotd ,
respectively,
are enabled.
It does not suppress printing of the banner specified by
.Cm Banner .
783
.Pp
784
.It Pa ~/.rhosts
785 786 787 788 789 790 791 792 793 794 795 796
This file is used for host-based authentication (see
.Xr ssh 1
for more information).
On some machines this file may need to be
world-readable if the user's home directory is on an NFS partition,
because
.Nm
reads it as root.
Additionally, this file must be owned by the user,
and must not have write permissions for anyone else.
The recommended
permission for most machines is read/write for the user, and not
797 798
accessible by others.
.Pp
799
.It Pa ~/.shosts
800 801 802 803
This file is used in exactly the same way as
.Pa .rhosts ,
but allows host-based authentication without permitting login with
rlogin/rsh.
804
.Pp
805
.It Pa ~/.ssh/
806 807 808 809 810 811
This directory is the default location for all user-specific configuration
and authentication information.
There is no general requirement to keep the entire contents of this directory
secret, but the recommended permissions are read/write/execute for the user,
and not accessible by others.
.Pp
812
.It Pa ~/.ssh/authorized_keys
sobrado@openbsd.org's avatar
sobrado@openbsd.org committed
813
Lists the public keys (DSA, ECDSA, Ed25519, RSA)
814
that can be used for logging in as this user.
815
The format of this file is described above.
816
The content of the file is not highly sensitive, but the recommended
817
permissions are read/write for the user, and not accessible by others.
818
.Pp
819 820 821 822 823 824 825 826 827 828 829 830
If this file, the
.Pa ~/.ssh
directory, or the user's home directory are writable
by other users, then the file could be modified or replaced by unauthorized
users.
In this case,
.Nm
will not allow it to be used unless the
.Cm StrictModes
option has been set to
.Dq no .
.Pp
831
.It Pa ~/.ssh/environment
Damien Miller's avatar
Damien Miller committed
832 833
This file is read into the environment at login (if it exists).
It can only contain empty lines, comment lines (that start with
834
.Ql # ) ,
Damien Miller's avatar
Damien Miller committed
835 836
and assignment lines of the form name=value.
The file should be writable
837
only by the user; it need not be readable by anyone else.
838 839 840 841
Environment processing is disabled by default and is
controlled via the
.Cm PermitUserEnvironment
option.
842
.Pp
843
.It Pa ~/.ssh/known_hosts
844 845 846 847
Contains a list of host keys for all hosts the user has logged into
that are not already in the systemwide list of known host keys.
The format of this file is described above.
This file should be writable only by root/the owner and
848 849
can, but need not be, world-readable.
.Pp
850
.It Pa ~/.ssh/rc
851 852
Contains initialization routines to be run before
the user's home directory becomes accessible.
853 854
This file should be writable only by the user, and need not be
readable by anyone else.
855
.Pp
856 857 858 859 860 861
.It Pa /etc/hosts.allow
.It Pa /etc/hosts.deny
Access controls that should be enforced by tcp-wrappers are defined here.
Further details are described in
.Xr hosts_access 5 .
.Pp
862
.It Pa /etc/hosts.equiv
863 864 865
This file is for host-based authentication (see
.Xr ssh 1 ) .
It should only be writable by root.
866
.Pp
867
.It Pa /etc/ssh/moduli
868 869 870 871
Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
The file format is described in
.Xr moduli 5 .
.Pp
872
.It Pa /etc/motd
873 874 875
See
.Xr motd 5 .
.Pp
876
.It Pa /etc/nologin
877 878 879 880 881 882 883 884
If this file exists,
.Nm
refuses to let anyone except root log in.
The contents of the file
are displayed to anyone trying to log in, and non-root connections are
refused.
The file should be world-readable.
.Pp
885
.It Pa /etc/shosts.equiv
886 887 888 889
This file is used in exactly the same way as
.Pa hosts.equiv ,
but allows host-based authentication without permitting login with
rlogin/rsh.
890
.Pp
891 892
.It Pa /etc/ssh/ssh_host_key
.It Pa /etc/ssh/ssh_host_dsa_key
893
.It Pa /etc/ssh/ssh_host_ecdsa_key
894
.It Pa /etc/ssh/ssh_host_ed25519_key
895
.It Pa /etc/ssh/ssh_host_rsa_key
896
These files contain the private parts of the host keys.
897 898 899 900
These files should only be owned by root, readable only by root, and not
accessible to others.
Note that
.Nm
901
does not start if these files are group/world-accessible.
902
.Pp
903 904
.It Pa /etc/ssh/ssh_host_key.pub
.It Pa /etc/ssh/ssh_host_dsa_key.pub
905
.It Pa /etc/ssh/ssh_host_ecdsa_key.pub
906
.It Pa /etc/ssh/ssh_host_ed25519_key.pub
907
.It Pa /etc/ssh/ssh_host_rsa_key.pub
908
These files contain the public parts of the host keys.
909 910 911 912 913 914 915 916 917
These files should be world-readable but writable only by
root.
Their contents should match the respective private parts.
These files are not
really used for anything; they are provided for the convenience of
the user so their contents can be copied to known hosts files.
These files are created using
.Xr ssh-keygen 1 .
.Pp
918
.It Pa /etc/ssh/ssh_known_hosts
919 920 921 922 923 924 925 926
Systemwide list of known host keys.
This file should be prepared by the
system administrator to contain the public host keys of all machines in the
organization.
The format of this file is described above.
This file should be writable only by root/the owner and
should be world-readable.
.Pp
927
.It Pa /etc/ssh/sshd_config
928 929 930 931 932
Contains configuration data for
.Nm sshd .
The file format and configuration options are described in
.Xr sshd_config 5 .
.Pp
933
.It Pa /etc/ssh/sshrc
934 935 936
Similar to
.Pa ~/.ssh/rc ,
it can be used to specify
Damien Miller's avatar
Damien Miller committed
937 938
machine-specific login-time initializations globally.
This file should be writable only by root, and should be world-readable.
939
.Pp
940
.It Pa /var/empty
941 942 943 944 945 946 947
.Xr chroot 2
directory used by
.Nm
during privilege separation in the pre-authentication phase.
The directory should not contain any files and must be owned by root
and not group or world-writable.
.Pp
948
.It Pa /var/run/sshd.pid
949 950 951 952 953 954
Contains the process ID of the
.Nm
listening for connections (if there are several daemons running
concurrently for different ports, this contains the process ID of the one
started last).
The content of this file is not sensitive; it can be world-readable.
955
.El
956 957
.Sh SEE ALSO
.Xr scp 1 ,
958
.Xr sftp 1 ,
959 960 961 962
.Xr ssh 1 ,
.Xr ssh-add 1 ,
.Xr ssh-agent 1 ,
.Xr ssh-keygen 1 ,
963
.Xr ssh-keyscan 1 ,
964
.Xr chroot 2 ,
965
.Xr hosts_access 5 ,
966
.Xr moduli 5 ,
967
.Xr sshd_config 5 ,
968
.Xr inetd 8 ,
969
.Xr sftp-server 8
970 971 972 973 974 975 976 977 978 979 980
.Sh AUTHORS
OpenSSH is a derivative of the original and free
ssh 1.2.12 release by Tatu Ylonen.
Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
Theo de Raadt and Dug Song
removed many bugs, re-added newer features and
created OpenSSH.
Markus Friedl contributed the support for SSH
protocol versions 1.5 and 2.0.
Niels Provos and Markus Friedl contributed support
for privilege separation.