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