]>
Commit | Line | Data |
---|---|---|
bf740959 | 1 | .\" -*- nroff -*- |
2 | .\" | |
bf740959 | 3 | .\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
bf740959 | 4 | .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
5 | .\" All rights reserved | |
6 | .\" | |
bcbf86ec | 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 | .\" | |
f3c7c613 | 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. | |
bcbf86ec | 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. | |
bf740959 | 25 | .\" |
bcbf86ec | 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. | |
bf740959 | 36 | .\" |
60dacb4b | 37 | .\" $OpenBSD: sshd.8,v 1.208 2005/06/08 03:50:00 djm Exp $ |
bf740959 | 38 | .Dd September 25, 1999 |
39 | .Dt SSHD 8 | |
40 | .Os | |
41 | .Sh NAME | |
42 | .Nm sshd | |
da89cf4d | 43 | .Nd OpenSSH SSH daemon |
bf740959 | 44 | .Sh SYNOPSIS |
45 | .Nm sshd | |
6691e41b | 46 | .Bk -words |
433e60ac | 47 | .Op Fl 46Ddeiqt |
bf740959 | 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 | |
2717fa0f | 53 | .Op Fl o Ar option |
bf740959 | 54 | .Op Fl p Ar port |
c345cf9d | 55 | .Op Fl u Ar len |
6691e41b | 56 | .Ek |
f54651ce | 57 | .Sh DESCRIPTION |
bf740959 | 58 | .Nm |
2c86906e | 59 | (SSH Daemon) is the daemon program for |
bf740959 | 60 | .Xr ssh 1 . |
3189621b | 61 | Together these programs replace rlogin and rsh, and |
bf740959 | 62 | provide secure encrypted communications between two untrusted hosts |
4fe2af09 | 63 | over an insecure network. |
64 | The programs are intended to be as easy to | |
bf740959 | 65 | install and use as possible. |
66 | .Pp | |
67 | .Nm | |
4fe2af09 | 68 | is the daemon that listens for connections from clients. |
f54651ce | 69 | It is normally started at boot from |
bf740959 | 70 | .Pa /etc/rc . |
71 | It forks a new | |
4fe2af09 | 72 | daemon for each incoming connection. |
73 | The forked daemons handle | |
bf740959 | 74 | key exchange, encryption, authentication, command execution, |
75 | and data exchange. | |
1d1ffb87 | 76 | This implementation of |
77 | .Nm | |
78 | supports both SSH protocol version 1 and 2 simultaneously. | |
bf740959 | 79 | .Nm |
6691e41b | 80 | works as follows: |
1d1ffb87 | 81 | .Ss SSH protocol version 1 |
4fe2af09 | 82 | Each host has a host-specific RSA key |
60dacb4b | 83 | (normally 2048 bits) used to identify the host. |
4fe2af09 | 84 | Additionally, when |
bf740959 | 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 | |
6691e41b | 89 | Whenever a client connects, the daemon responds with its public |
3189621b | 90 | host and server keys. |
4fe2af09 | 91 | The client compares the |
1d1ffb87 | 92 | RSA host key against its own database to verify that it has not changed. |
433e60ac | 93 | The client then generates a 256-bit random number. |
4fe2af09 | 94 | It encrypts this |
bf740959 | 95 | random number using both the host key and the server key, and sends |
4fe2af09 | 96 | the encrypted number to the server. |
3189621b | 97 | Both sides then use this |
bf740959 | 98 | random number as a session key which is used to encrypt all further |
4fe2af09 | 99 | communications in the session. |
100 | The rest of the session is encrypted | |
3189621b | 101 | using a conventional cipher, currently Blowfish or 3DES, with 3DES |
7368a6c8 | 102 | being used by default. |
4fe2af09 | 103 | The client selects the encryption algorithm |
bf740959 | 104 | to use from those offered by the server. |
105 | .Pp | |
4fe2af09 | 106 | Next, the server and the client enter an authentication dialog. |
107 | The client tries to authenticate itself using | |
433e60ac | 108 | .Em .rhosts |
bf740959 | 109 | authentication combined with RSA host |
110 | authentication, RSA challenge-response authentication, or password | |
111 | based authentication. | |
112 | .Pp | |
3e6e3da0 | 113 | Regardless of the authentication type, the account is checked to |
114 | ensure that it is accessible. An account is not accessible if it is | |
115 | locked, listed in | |
116 | .Cm DenyUsers | |
117 | or its group is listed in | |
118 | .Cm DenyGroups | |
119 | \&. The definition of a locked account is system dependant. Some platforms | |
120 | have their own account database (eg AIX) and some modify the passwd field ( | |
121 | .Ql \&*LK\&* | |
122 | on Solaris, | |
123 | .Ql \&* | |
124 | on HP-UX, containing | |
125 | .Ql Nologin | |
278f9900 | 126 | on Tru64, |
127 | a leading | |
128 | .Ql \&*LOCKED\&* | |
129 | on FreeBSD and a leading | |
3e6e3da0 | 130 | .Ql \&!! |
131 | on Linux). If there is a requirement to disable password authentication | |
132 | for the account while allowing still public-key, then the passwd field | |
133 | should be set to something other than these values (eg | |
134 | .Ql NP | |
135 | or | |
136 | .Ql \&*NP\&* | |
137 | ). | |
138 | .Pp | |
7e276482 | 139 | .Nm rshd , |
140 | .Nm rlogind , | |
bf740959 | 141 | and |
6691e41b | 142 | .Nm rexecd |
bf740959 | 143 | are disabled (thus completely disabling |
7e276482 | 144 | .Xr rlogin |
bf740959 | 145 | and |
7e276482 | 146 | .Xr rsh |
3189621b | 147 | into the machine). |
1d1ffb87 | 148 | .Ss SSH protocol version 2 |
c345cf9d | 149 | Version 2 works similarly: |
7f19f8bb | 150 | Each host has a host-specific key (RSA or DSA) used to identify the host. |
1d1ffb87 | 151 | However, when the daemon starts, it does not generate a server key. |
152 | Forward security is provided through a Diffie-Hellman key agreement. | |
153 | This key agreement results in a shared session key. | |
da89cf4d | 154 | .Pp |
51c251f0 | 155 | The rest of the session is encrypted using a symmetric cipher, currently |
433e60ac | 156 | 128-bit AES, Blowfish, 3DES, CAST128, Arcfour, 192-bit AES, or 256-bit AES. |
1d1ffb87 | 157 | The client selects the encryption algorithm |
158 | to use from those offered by the server. | |
159 | Additionally, session integrity is provided | |
d0c832f3 | 160 | through a cryptographic message authentication code |
1d1ffb87 | 161 | (hmac-sha1 or hmac-md5). |
162 | .Pp | |
163 | Protocol version 2 provides a public key based | |
da89cf4d | 164 | user (PubkeyAuthentication) or |
165 | client host (HostbasedAuthentication) authentication method, | |
166 | conventional password authentication and challenge response based methods. | |
1d1ffb87 | 167 | .Ss Command execution and data forwarding |
bf740959 | 168 | If the client successfully authenticates itself, a dialog for |
4fe2af09 | 169 | preparing the session is entered. |
170 | At this time the client may request | |
bf740959 | 171 | things like allocating a pseudo-tty, forwarding X11 connections, |
172 | forwarding TCP/IP connections, or forwarding the authentication agent | |
173 | connection over the secure channel. | |
174 | .Pp | |
175 | Finally, the client either requests a shell or execution of a command. | |
4fe2af09 | 176 | The sides then enter session mode. |
177 | In this mode, either side may send | |
bf740959 | 178 | data at any time, and such data is forwarded to/from the shell or |
179 | command on the server side, and the user terminal in the client side. | |
180 | .Pp | |
181 | When the user program terminates and all forwarded X11 and other | |
182 | connections have been closed, the server sends command exit status to | |
183 | the client, and both sides exit. | |
184 | .Pp | |
185 | .Nm | |
433e60ac | 186 | can be configured using command-line options or a configuration file |
187 | (by default | |
188 | .Xr sshd_config 5 ) . | |
4fe2af09 | 189 | Command-line options override values specified in the |
bf740959 | 190 | configuration file. |
191 | .Pp | |
9d6b7add | 192 | .Nm |
193 | rereads its configuration file when it receives a hangup signal, | |
409edaba | 194 | .Dv SIGHUP , |
7b7385da | 195 | by executing itself with the name and options it was started with, e.g., |
409edaba | 196 | .Pa /usr/sbin/sshd . |
9d6b7add | 197 | .Pp |
bf740959 | 198 | The options are as follows: |
199 | .Bl -tag -width Ds | |
433e60ac | 200 | .It Fl 4 |
201 | Forces | |
202 | .Nm | |
203 | to use IPv4 addresses only. | |
204 | .It Fl 6 | |
205 | Forces | |
206 | .Nm | |
207 | to use IPv6 addresses only. | |
bf740959 | 208 | .It Fl b Ar bits |
da89cf4d | 209 | Specifies the number of bits in the ephemeral protocol version 1 |
210 | server key (default 768). | |
433e60ac | 211 | .It Fl D |
212 | When this option is specified, | |
213 | .Nm | |
214 | will not detach and does not become a daemon. | |
215 | This allows easy monitoring of | |
216 | .Nm sshd . | |
bf740959 | 217 | .It Fl d |
4fe2af09 | 218 | Debug mode. |
219 | The server sends verbose debug output to the system | |
220 | log, and does not put itself in the background. | |
221 | The server also will not fork and will only process one connection. | |
222 | This option is only intended for debugging for the server. | |
6691e41b | 223 | Multiple |
224 | .Fl d | |
225 | options increase the debugging level. | |
94ec8c6b | 226 | Maximum is 3. |
da89cf4d | 227 | .It Fl e |
228 | When this option is specified, | |
229 | .Nm | |
230 | will send the output to the standard error instead of the system log. | |
bf740959 | 231 | .It Fl f Ar configuration_file |
4fe2af09 | 232 | Specifies the name of the configuration file. |
233 | The default is | |
2a8a6488 | 234 | .Pa /etc/ssh/sshd_config . |
bf740959 | 235 | .Nm |
236 | refuses to start if there is no configuration file. | |
237 | .It Fl g Ar login_grace_time | |
238 | Gives the grace time for clients to authenticate themselves (default | |
3445ca02 | 239 | 120 seconds). |
4fe2af09 | 240 | If the client fails to authenticate the user within |
241 | this many seconds, the server disconnects and exits. | |
242 | A value of zero indicates no limit. | |
bf740959 | 243 | .It Fl h Ar host_key_file |
0f84fe37 | 244 | Specifies a file from which a host key is read. |
bf740959 | 245 | This option must be given if |
246 | .Nm | |
247 | is not run as root (as the normal | |
0f84fe37 | 248 | host key files are normally not readable by anyone but root). |
249 | The default is | |
2a8a6488 | 250 | .Pa /etc/ssh/ssh_host_key |
0f84fe37 | 251 | for protocol version 1, and |
2a8a6488 | 252 | .Pa /etc/ssh/ssh_host_rsa_key |
0f84fe37 | 253 | and |
2a8a6488 | 254 | .Pa /etc/ssh/ssh_host_dsa_key |
0f84fe37 | 255 | for protocol version 2. |
8abcdba4 | 256 | It is possible to have multiple host key files for |
da89cf4d | 257 | the different protocol versions and host key algorithms. |
bf740959 | 258 | .It Fl i |
259 | Specifies that | |
260 | .Nm | |
6691e41b | 261 | is being run from |
262 | .Xr inetd 8 . | |
bf740959 | 263 | .Nm |
264 | is normally not run | |
265 | from inetd because it needs to generate the server key before it can | |
4fe2af09 | 266 | respond to the client, and this may take tens of seconds. |
267 | Clients would have to wait too long if the key was regenerated every time. | |
610cd5c6 | 268 | However, with small key sizes (e.g., 512) using |
bf740959 | 269 | .Nm |
270 | from inetd may | |
271 | be feasible. | |
272 | .It Fl k Ar key_gen_time | |
da89cf4d | 273 | Specifies how often the ephemeral protocol version 1 server key is |
274 | regenerated (default 3600 seconds, or one hour). | |
4fe2af09 | 275 | The motivation for regenerating the key fairly |
433e60ac | 276 | often is that the key is not stored anywhere, and after about an hour |
bf740959 | 277 | it becomes impossible to recover the key for decrypting intercepted |
278 | communications even if the machine is cracked into or physically | |
4fe2af09 | 279 | seized. |
280 | A value of zero indicates that the key will never be regenerated. | |
2717fa0f | 281 | .It Fl o Ar option |
282 | Can be used to give options in the format used in the configuration file. | |
283 | This is useful for specifying options for which there is no separate | |
284 | command-line flag. | |
433e60ac | 285 | For full details of the options, and their values, see |
286 | .Xr sshd_config 5 . | |
bf740959 | 287 | .It Fl p Ar port |
288 | Specifies the port on which the server listens for connections | |
289 | (default 22). | |
135113a3 | 290 | Multiple port options are permitted. |
291 | Ports specified in the configuration file are ignored when a | |
292 | command-line port is specified. | |
bf740959 | 293 | .It Fl q |
4fe2af09 | 294 | Quiet mode. |
295 | Nothing is sent to the system log. | |
296 | Normally the beginning, | |
bf740959 | 297 | authentication, and termination of each connection is logged. |
f87f09aa | 298 | .It Fl t |
299 | Test mode. | |
300 | Only check the validity of the configuration file and sanity of the keys. | |
184eed6a | 301 | This is useful for updating |
f87f09aa | 302 | .Nm |
303 | reliably as configuration options may change. | |
c345cf9d | 304 | .It Fl u Ar len |
305 | This option is used to specify the size of the field | |
306 | in the | |
307 | .Li utmp | |
308 | structure that holds the remote host name. | |
309 | If the resolved host name is longer than | |
310 | .Ar len , | |
311 | the dotted decimal value will be used instead. | |
312 | This allows hosts with very long host names that | |
313 | overflow this field to still be uniquely identified. | |
314 | Specifying | |
315 | .Fl u0 | |
316 | indicates that only dotted decimal addresses | |
317 | should be put into the | |
318 | .Pa utmp | |
319 | file. | |
e675b851 | 320 | .Fl u0 |
6691e41b | 321 | may also be used to prevent |
e675b851 | 322 | .Nm |
323 | from making DNS requests unless the authentication | |
324 | mechanism or configuration requires it. | |
325 | Authentication mechanisms that may require DNS include | |
e675b851 | 326 | .Cm RhostsRSAAuthentication , |
327 | .Cm HostbasedAuthentication | |
328 | and using a | |
329 | .Cm from="pattern-list" | |
330 | option in a key file. | |
f464aad8 | 331 | Configuration options that require DNS include using a |
332 | USER@HOST pattern in | |
333 | .Cm AllowUsers | |
334 | or | |
335 | .Cm DenyUsers . | |
bf740959 | 336 | .El |
337 | .Sh CONFIGURATION FILE | |
338 | .Nm | |
f54651ce | 339 | reads configuration data from |
2a8a6488 | 340 | .Pa /etc/ssh/sshd_config |
bf740959 | 341 | (or the file specified with |
342 | .Fl f | |
4fe2af09 | 343 | on the command line). |
588df31a | 344 | The file format and configuration options are described in |
345 | .Xr sshd_config 5 . | |
bf740959 | 346 | .Sh LOGIN PROCESS |
347 | When a user successfully logs in, | |
348 | .Nm | |
349 | does the following: | |
350 | .Bl -enum -offset indent | |
351 | .It | |
352 | If the login is on a tty, and no command has been specified, | |
f54651ce | 353 | prints last login time and |
bf740959 | 354 | .Pa /etc/motd |
355 | (unless prevented in the configuration file or by | |
140e3e97 | 356 | .Pa ~/.hushlogin ; |
bf740959 | 357 | see the |
f54651ce | 358 | .Sx FILES |
bf740959 | 359 | section). |
360 | .It | |
361 | If the login is on a tty, records login time. | |
362 | .It | |
363 | Checks | |
364 | .Pa /etc/nologin ; | |
365 | if it exists, prints contents and quits | |
366 | (unless root). | |
367 | .It | |
368 | Changes to run with normal user privileges. | |
369 | .It | |
370 | Sets up basic environment. | |
371 | .It | |
433e60ac | 372 | Reads the file |
140e3e97 | 373 | .Pa ~/.ssh/environment , |
433e60ac | 374 | if it exists, and users are allowed to change their environment. |
35453849 | 375 | See the |
6a342527 | 376 | .Cm PermitUserEnvironment |
35453849 | 377 | option in |
6a342527 | 378 | .Xr sshd_config 5 . |
bf740959 | 379 | .It |
380 | Changes to user's home directory. | |
381 | .It | |
382 | If | |
140e3e97 | 383 | .Pa ~/.ssh/rc |
bf740959 | 384 | exists, runs it; else if |
af98ced9 | 385 | .Pa /etc/ssh/sshrc |
bf740959 | 386 | exists, runs |
4fe2af09 | 387 | it; otherwise runs xauth. |
388 | The | |
bf740959 | 389 | .Dq rc |
390 | files are given the X11 | |
391 | authentication protocol and cookie in standard input. | |
392 | .It | |
393 | Runs user's shell or command. | |
394 | .El | |
395 | .Sh AUTHORIZED_KEYS FILE FORMAT | |
140e3e97 | 396 | .Pa ~/.ssh/authorized_keys |
96a7b0cc | 397 | is the default file that lists the public keys that are |
398 | permitted for RSA authentication in protocol version 1 | |
399 | and for public key authentication (PubkeyAuthentication) | |
da89cf4d | 400 | in protocol version 2. |
96a7b0cc | 401 | .Cm AuthorizedKeysFile |
c8445989 | 402 | may be used to specify an alternative file. |
8abcdba4 | 403 | .Pp |
4fe2af09 | 404 | Each line of the file contains one |
bf740959 | 405 | key (empty lines and lines starting with a |
406 | .Ql # | |
407 | are ignored as | |
4fe2af09 | 408 | comments). |
8abcdba4 | 409 | Each RSA public key consists of the following fields, separated by |
4fe2af09 | 410 | spaces: options, bits, exponent, modulus, comment. |
8abcdba4 | 411 | Each protocol version 2 public key consists of: |
412 | options, keytype, base64 encoded key, comment. | |
755c4339 | 413 | The options field |
414 | is optional; its presence is determined by whether the line starts | |
415 | with a number or not (the options field never starts with a number). | |
8abcdba4 | 416 | The bits, exponent, modulus and comment fields give the RSA key for |
417 | protocol version 1; the | |
bf740959 | 418 | comment field is not used for anything (but may be convenient for the |
419 | user to identify the key). | |
8abcdba4 | 420 | For protocol version 2 the keytype is |
421 | .Dq ssh-dss | |
422 | or | |
423 | .Dq ssh-rsa . | |
bf740959 | 424 | .Pp |
425 | Note that lines in this file are usually several hundred bytes long | |
ea067773 | 426 | (because of the size of the public key encoding) up to a limit of |
427 | 8 kilobytes, which permits DSA keys up to 8 kilobits and RSA | |
428 | keys up to 16 kilobits. | |
4fe2af09 | 429 | You don't want to type them in; instead, copy the |
c0ecc314 | 430 | .Pa identity.pub , |
8abcdba4 | 431 | .Pa id_dsa.pub |
c0ecc314 | 432 | or the |
433 | .Pa id_rsa.pub | |
bf740959 | 434 | file and edit it. |
435 | .Pp | |
3bc822df | 436 | .Nm |
437 | enforces a minimum RSA key modulus size for protocol 1 | |
438 | and protocol 2 keys of 768 bits. | |
439 | .Pp | |
c345cf9d | 440 | The options (if present) consist of comma-separated option |
4fe2af09 | 441 | specifications. |
442 | No spaces are permitted, except within double quotes. | |
54bf768d | 443 | The following option specifications are supported (note |
444 | that option keywords are case-insensitive): | |
bf740959 | 445 | .Bl -tag -width Ds |
446 | .It Cm from="pattern-list" | |
755c4339 | 447 | Specifies that in addition to public key authentication, the canonical name |
bf740959 | 448 | of the remote host must be present in the comma-separated list of |
4fe2af09 | 449 | patterns |
09dc8896 | 450 | .Pf ( Ql \&* |
4fe2af09 | 451 | and |
9a26a6e2 | 452 | .Ql \&? |
4fe2af09 | 453 | serve as wildcards). |
454 | The list may also contain | |
455 | patterns negated by prefixing them with | |
9a26a6e2 | 456 | .Ql \&! ; |
4fe2af09 | 457 | if the canonical host name matches a negated pattern, the key is not accepted. |
458 | The purpose | |
755c4339 | 459 | of this option is to optionally increase security: public key authentication |
bf740959 | 460 | by itself does not trust the network or name servers or anything (but |
461 | the key); however, if somebody somehow steals the key, the key | |
4fe2af09 | 462 | permits an intruder to log in from anywhere in the world. |
463 | This additional option makes using a stolen key more difficult (name | |
bf740959 | 464 | servers and/or routers would have to be compromised in addition to |
465 | just the key). | |
466 | .It Cm command="command" | |
467 | Specifies that the command is executed whenever this key is used for | |
4fe2af09 | 468 | authentication. |
469 | The command supplied by the user (if any) is ignored. | |
9658ecbc | 470 | The command is run on a pty if the client requests a pty; |
4fe2af09 | 471 | otherwise it is run without a tty. |
6691e41b | 472 | If an 8-bit clean channel is required, |
91789042 | 473 | one must not request a pty or should specify |
61e96248 | 474 | .Cm no-pty . |
4fe2af09 | 475 | A quote may be included in the command by quoting it with a backslash. |
476 | This option might be useful | |
755c4339 | 477 | to restrict certain public keys to perform just a specific operation. |
4fe2af09 | 478 | An example might be a key that permits remote backups but nothing else. |
d0c832f3 | 479 | Note that the client may specify TCP/IP and/or X11 |
480 | forwarding unless they are explicitly prohibited. | |
4cdbc654 | 481 | Note that this option applies to shell, command or subsystem execution. |
bf740959 | 482 | .It Cm environment="NAME=value" |
483 | Specifies that the string is to be added to the environment when | |
4fe2af09 | 484 | logging in using this key. |
485 | Environment variables set this way | |
486 | override other default environment values. | |
487 | Multiple options of this type are permitted. | |
35453849 | 488 | Environment processing is disabled by default and is |
489 | controlled via the | |
490 | .Cm PermitUserEnvironment | |
491 | option. | |
2548961d | 492 | This option is automatically disabled if |
493 | .Cm UseLogin | |
494 | is enabled. | |
bf740959 | 495 | .It Cm no-port-forwarding |
496 | Forbids TCP/IP forwarding when this key is used for authentication. | |
4fe2af09 | 497 | Any port forward requests by the client will return an error. |
498 | This might be used, e.g., in connection with the | |
bf740959 | 499 | .Cm command |
500 | option. | |
501 | .It Cm no-X11-forwarding | |
502 | Forbids X11 forwarding when this key is used for authentication. | |
503 | Any X11 forward requests by the client will return an error. | |
504 | .It Cm no-agent-forwarding | |
505 | Forbids authentication agent forwarding when this key is used for | |
506 | authentication. | |
507 | .It Cm no-pty | |
508 | Prevents tty allocation (a request to allocate a pty will fail). | |
dc504afd | 509 | .It Cm permitopen="host:port" |
3730bb22 | 510 | Limit local |
dc504afd | 511 | .Li ``ssh -L'' |
b2ae83b8 | 512 | port forwarding such that it may only connect to the specified host and |
ed787d14 | 513 | port. |
514 | IPv6 addresses can be specified with an alternative syntax: | |
433e60ac | 515 | .Ar host Ns / Ns Ar port . |
ed787d14 | 516 | Multiple |
dc504afd | 517 | .Cm permitopen |
3cbc677d | 518 | options may be applied separated by commas. |
519 | No pattern matching is performed on the specified hostnames, | |
520 | they must be literal domains or addresses. | |
bf740959 | 521 | .El |
522 | .Ss Examples | |
433e60ac | 523 | 1024 33 12121...312314325 ylo@foo.bar |
bf740959 | 524 | .Pp |
433e60ac | 525 | from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23...2334 ylo@niksula |
bf740959 | 526 | .Pp |
433e60ac | 527 | command="dump /home",no-pty,no-port-forwarding 1024 33 23...2323 backup.hut.fi |
dc504afd | 528 | .Pp |
433e60ac | 529 | permitopen="10.2.1.55:80",permitopen="10.2.1.56:25" 1024 33 23...2323 |
bf740959 | 530 | .Sh SSH_KNOWN_HOSTS FILE FORMAT |
f54651ce | 531 | The |
6691e41b | 532 | .Pa /etc/ssh/ssh_known_hosts |
f54651ce | 533 | and |
140e3e97 | 534 | .Pa ~/.ssh/known_hosts |
4fe2af09 | 535 | files contain host public keys for all known hosts. |
536 | The global file should | |
537 | be prepared by the administrator (optional), and the per-user file is | |
c345cf9d | 538 | maintained automatically: whenever the user connects from an unknown host |
4fe2af09 | 539 | its key is added to the per-user file. |
bf740959 | 540 | .Pp |
541 | Each line in these files contains the following fields: hostnames, | |
4fe2af09 | 542 | bits, exponent, modulus, comment. |
543 | The fields are separated by spaces. | |
bf740959 | 544 | .Pp |
09dc8896 | 545 | Hostnames is a comma-separated list of patterns |
3cbc677d | 546 | .Pf ( Ql \&* |
547 | and | |
548 | .Ql \&? | |
9a26a6e2 | 549 | act as |
bf740959 | 550 | wildcards); each pattern in turn is matched against the canonical host |
551 | name (when authenticating a client) or against the user-supplied | |
4fe2af09 | 552 | name (when authenticating a server). |
553 | A pattern may also be preceded by | |
9a26a6e2 | 554 | .Ql \&! |
bf740959 | 555 | to indicate negation: if the host name matches a negated |
556 | pattern, it is not accepted (by that line) even if it matched another | |
557 | pattern on the line. | |
558 | .Pp | |
5c63c2ab | 559 | Alternately, hostnames may be stored in a hashed form which hides host names |
c79ae9fd | 560 | and addresses should the file's contents be disclosed. |
561 | Hashed hostnames start with a | |
562 | .Ql | | |
5c63c2ab | 563 | character. |
564 | Only one hashed hostname may appear on a single line and none of the above | |
565 | negation or wildcard operators may be applied. | |
566 | .Pp | |
1d1ffb87 | 567 | Bits, exponent, and modulus are taken directly from the RSA host key; they |
bf740959 | 568 | can be obtained, e.g., from |
2a8a6488 | 569 | .Pa /etc/ssh/ssh_host_key.pub . |
bf740959 | 570 | The optional comment field continues to the end of the line, and is not used. |
571 | .Pp | |
572 | Lines starting with | |
573 | .Ql # | |
574 | and empty lines are ignored as comments. | |
575 | .Pp | |
576 | When performing host authentication, authentication is accepted if any | |
4fe2af09 | 577 | matching line has the proper key. |
578 | It is thus permissible (but not | |
bf740959 | 579 | recommended) to have several lines or different host keys for the same |
4fe2af09 | 580 | names. |
581 | This will inevitably happen when short forms of host names | |
582 | from different domains are put in the file. | |
583 | It is possible | |
bf740959 | 584 | that the files contain conflicting information; authentication is |
585 | accepted if valid information can be found from either file. | |
586 | .Pp | |
587 | Note that the lines in these files are typically hundreds of characters | |
588 | long, and you definitely don't want to type in the host keys by hand. | |
589 | Rather, generate them by a script | |
f54651ce | 590 | or by taking |
2a8a6488 | 591 | .Pa /etc/ssh/ssh_host_key.pub |
bf740959 | 592 | and adding the host names at the front. |
593 | .Ss Examples | |
da89cf4d | 594 | .Bd -literal |
433e60ac | 595 | closenet,...,130.233.208.41 1024 37 159...93 closenet.hut.fi |
da89cf4d | 596 | cvs.openbsd.org,199.185.137.3 ssh-rsa AAAA1234.....= |
597 | .Ed | |
5c63c2ab | 598 | .Bd -literal |
599 | # A hashed hostname | |
600 | |1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa | |
601 | AAAA1234.....= | |
602 | .Ed | |
bf740959 | 603 | .Sh FILES |
604 | .Bl -tag -width Ds | |
2a8a6488 | 605 | .It Pa /etc/ssh/sshd_config |
bf740959 | 606 | Contains configuration data for |
607 | .Nm sshd . | |
588df31a | 608 | The file format and configuration options are described in |
609 | .Xr sshd_config 5 . | |
2a8a6488 | 610 | .It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key |
da89cf4d | 611 | These three files contain the private parts of the host keys. |
b8dc87d3 | 612 | These files should only be owned by root, readable only by root, and not |
bf740959 | 613 | accessible to others. |
614 | Note that | |
615 | .Nm | |
616 | does not start if this file is group/world-accessible. | |
2a8a6488 | 617 | .It Pa /etc/ssh/ssh_host_key.pub, /etc/ssh/ssh_host_dsa_key.pub, /etc/ssh/ssh_host_rsa_key.pub |
da89cf4d | 618 | These three files contain the public parts of the host keys. |
b8dc87d3 | 619 | These files should be world-readable but writable only by |
4fe2af09 | 620 | root. |
b8dc87d3 | 621 | Their contents should match the respective private parts. |
622 | These files are not | |
623 | really used for anything; they are provided for the convenience of | |
624 | the user so their contents can be copied to known hosts files. | |
625 | These files are created using | |
bf740959 | 626 | .Xr ssh-keygen 1 . |
e2432638 | 627 | .It Pa /etc/moduli |
c523303b | 628 | Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange". |
f1dcc34e | 629 | The file format is described in |
630 | .Xr moduli 5 . | |
75653d3e | 631 | .It Pa /var/empty |
632 | .Xr chroot 2 | |
633 | directory used by | |
634 | .Nm | |
635 | during privilege separation in the pre-authentication phase. | |
636 | The directory should not contain any files and must be owned by root | |
637 | and not group or world-writable. | |
5f4fdfae | 638 | .It Pa /var/run/sshd.pid |
bf740959 | 639 | Contains the process ID of the |
640 | .Nm | |
641 | listening for connections (if there are several daemons running | |
baa08b92 | 642 | concurrently for different ports, this contains the process ID of the one |
4fe2af09 | 643 | started last). |
c345cf9d | 644 | The content of this file is not sensitive; it can be world-readable. |
140e3e97 | 645 | .It Pa ~/.ssh/authorized_keys |
da89cf4d | 646 | Lists the public keys (RSA or DSA) that can be used to log into the user's account. |
1d1ffb87 | 647 | This file must be readable by root (which may on some machines imply |
648 | it being world-readable if the user's home directory resides on an NFS | |
649 | volume). | |
650 | It is recommended that it not be accessible by others. | |
651 | The format of this file is described above. | |
652 | Users will place the contents of their | |
96a7b0cc | 653 | .Pa identity.pub , |
1d1ffb87 | 654 | .Pa id_dsa.pub |
c0ecc314 | 655 | and/or |
656 | .Pa id_rsa.pub | |
1d1ffb87 | 657 | files into this file, as described in |
658 | .Xr ssh-keygen 1 . | |
140e3e97 | 659 | .It Pa "/etc/ssh/ssh_known_hosts", "~/.ssh/known_hosts" |
6a17f9c2 | 660 | These files are consulted when using rhosts with RSA host |
f49bc4f7 | 661 | authentication or protocol version 2 hostbased authentication |
662 | to check the public key of the host. | |
4fe2af09 | 663 | The key must be listed in one of these files to be accepted. |
5bbb5681 | 664 | The client uses the same files |
e91c60f2 | 665 | to verify that it is connecting to the correct remote host. |
4fe2af09 | 666 | These files should be writable only by root/the owner. |
2a8a6488 | 667 | .Pa /etc/ssh/ssh_known_hosts |
bf740959 | 668 | should be world-readable, and |
140e3e97 | 669 | .Pa ~/.ssh/known_hosts |
6691e41b | 670 | can, but need not be, world-readable. |
a333272d | 671 | .It Pa /etc/motd |
672 | See | |
673 | .Xr motd 5 . | |
140e3e97 | 674 | .It Pa ~/.hushlogin |
a333272d | 675 | This file is used to suppress printing the last login time and |
676 | .Pa /etc/motd , | |
677 | if | |
678 | .Cm PrintLastLog | |
679 | and | |
680 | .Cm PrintMotd , | |
681 | respectively, | |
682 | are enabled. | |
683 | It does not suppress printing of the banner specified by | |
684 | .Cm Banner . | |
bf740959 | 685 | .It Pa /etc/nologin |
f54651ce | 686 | If this file exists, |
bf740959 | 687 | .Nm |
4fe2af09 | 688 | refuses to let anyone except root log in. |
689 | The contents of the file | |
bf740959 | 690 | are displayed to anyone trying to log in, and non-root connections are |
4fe2af09 | 691 | refused. |
692 | The file should be world-readable. | |
bf740959 | 693 | .It Pa /etc/hosts.allow, /etc/hosts.deny |
5b263aae | 694 | Access controls that should be enforced by tcp-wrappers are defined here. |
695 | Further details are described in | |
bf740959 | 696 | .Xr hosts_access 5 . |
140e3e97 | 697 | .It Pa ~/.rhosts |
6f5abc1e | 698 | This file is used during |
699 | .Cm RhostsRSAAuthentication | |
700 | and | |
701 | .Cm HostbasedAuthentication | |
702 | and contains host-username pairs, separated by a space, one per | |
4fe2af09 | 703 | line. |
704 | The given user on the corresponding host is permitted to log in | |
6691e41b | 705 | without a password. |
4fe2af09 | 706 | The same file is used by rlogind and rshd. |
bf740959 | 707 | The file must |
708 | be writable only by the user; it is recommended that it not be | |
709 | accessible by others. | |
710 | .Pp | |
433e60ac | 711 | It is also possible to use netgroups in the file. |
4fe2af09 | 712 | Either host or user |
bf740959 | 713 | name may be of the form +@groupname to specify all hosts or all users |
714 | in the group. | |
140e3e97 | 715 | .It Pa ~/.shosts |
bf740959 | 716 | For ssh, |
717 | this file is exactly the same as for | |
718 | .Pa .rhosts . | |
719 | However, this file is | |
720 | not used by rlogin and rshd, so using this permits access using SSH only. | |
c345cf9d | 721 | .It Pa /etc/hosts.equiv |
bf740959 | 722 | This file is used during |
6f5abc1e | 723 | .Cm RhostsRSAAuthentication |
724 | and | |
725 | .Cm HostbasedAuthentication | |
4fe2af09 | 726 | authentication. |
727 | In the simplest form, this file contains host names, one per line. | |
728 | Users on | |
bf740959 | 729 | those hosts are permitted to log in without a password, provided they |
4fe2af09 | 730 | have the same user name on both machines. |
731 | The host name may also be | |
bf740959 | 732 | followed by a user name; such users are permitted to log in as |
733 | .Em any | |
4fe2af09 | 734 | user on this machine (except root). |
735 | Additionally, the syntax | |
bf740959 | 736 | .Dq +@group |
4fe2af09 | 737 | can be used to specify netgroups. |
738 | Negated entries start with | |
bf740959 | 739 | .Ql \&- . |
740 | .Pp | |
741 | If the client host/user is successfully matched in this file, login is | |
742 | automatically permitted provided the client and server user names are the | |
4fe2af09 | 743 | same. |
6f5abc1e | 744 | Additionally, successful client host key authentication is required. |
4fe2af09 | 745 | This file must be writable only by root; it is recommended |
bf740959 | 746 | that it be world-readable. |
747 | .Pp | |
748 | .Sy "Warning: It is almost never a good idea to use user names in" | |
749 | .Pa hosts.equiv . | |
750 | Beware that it really means that the named user(s) can log in as | |
751 | .Em anybody , | |
752 | which includes bin, daemon, adm, and other accounts that own critical | |
4fe2af09 | 753 | binaries and directories. |
754 | Using a user name practically grants the user root access. | |
755 | The only valid use for user names that I can think | |
bf740959 | 756 | of is in negative entries. |
757 | .Pp | |
758 | Note that this warning also applies to rsh/rlogin. | |
5f4fdfae | 759 | .It Pa /etc/shosts.equiv |
bf740959 | 760 | This is processed exactly as |
761 | .Pa /etc/hosts.equiv . | |
762 | However, this file may be useful in environments that want to run both | |
763 | rsh/rlogin and ssh. | |
140e3e97 | 764 | .It Pa ~/.ssh/environment |
4fe2af09 | 765 | This file is read into the environment at login (if it exists). |
766 | It can only contain empty lines, comment lines (that start with | |
bf740959 | 767 | .Ql # ) , |
4fe2af09 | 768 | and assignment lines of the form name=value. |
769 | The file should be writable | |
bf740959 | 770 | only by the user; it need not be readable by anyone else. |
35453849 | 771 | Environment processing is disabled by default and is |
772 | controlled via the | |
773 | .Cm PermitUserEnvironment | |
774 | option. | |
140e3e97 | 775 | .It Pa ~/.ssh/rc |
6691e41b | 776 | If this file exists, it is run with |
777 | .Pa /bin/sh | |
778 | after reading the | |
4fe2af09 | 779 | environment files but before starting the user's shell or command. |
d4c6ddff | 780 | It must not produce any output on stdout; stderr must be used |
781 | instead. | |
782 | If X11 forwarding is in use, it will receive the "proto cookie" pair in | |
783 | its standard input (and | |
bf740959 | 784 | .Ev DISPLAY |
d4c6ddff | 785 | in its environment). |
786 | The script must call | |
bf740959 | 787 | .Xr xauth 1 |
d4c6ddff | 788 | because |
789 | .Nm | |
790 | will not run xauth automatically to add X11 cookies. | |
bf740959 | 791 | .Pp |
792 | The primary purpose of this file is to run any initialization routines | |
793 | which may be needed before the user's home directory becomes | |
794 | accessible; AFS is a particular example of such an environment. | |
795 | .Pp | |
796 | This file will probably contain some initialization code followed by | |
da89cf4d | 797 | something similar to: |
798 | .Bd -literal | |
d4c6ddff | 799 | if read proto cookie && [ -n "$DISPLAY" ]; then |
800 | if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then | |
801 | # X11UseLocalhost=yes | |
cb11b555 | 802 | echo add unix:`echo $DISPLAY | |
d4c6ddff | 803 | cut -c11-` $proto $cookie |
804 | else | |
805 | # X11UseLocalhost=no | |
cb11b555 | 806 | echo add $DISPLAY $proto $cookie |
807 | fi | xauth -q - | |
d4c6ddff | 808 | fi |
da89cf4d | 809 | .Ed |
bf740959 | 810 | .Pp |
811 | If this file does not exist, | |
2a8a6488 | 812 | .Pa /etc/ssh/sshrc |
bf740959 | 813 | is run, and if that |
d4c6ddff | 814 | does not exist either, xauth is used to add the cookie. |
bf740959 | 815 | .Pp |
816 | This file should be writable only by the user, and need not be | |
817 | readable by anyone else. | |
2a8a6488 | 818 | .It Pa /etc/ssh/sshrc |
bf740959 | 819 | Like |
140e3e97 | 820 | .Pa ~/.ssh/rc . |
bf740959 | 821 | This can be used to specify |
4fe2af09 | 822 | machine-specific login-time initializations globally. |
823 | This file should be writable only by root, and should be world-readable. | |
089fbbd2 | 824 | .El |
bf740959 | 825 | .Sh SEE ALSO |
bf740959 | 826 | .Xr scp 1 , |
61e96248 | 827 | .Xr sftp 1 , |
bf740959 | 828 | .Xr ssh 1 , |
829 | .Xr ssh-add 1 , | |
830 | .Xr ssh-agent 1 , | |
831 | .Xr ssh-keygen 1 , | |
433e60ac | 832 | .Xr chroot 2 , |
833 | .Xr hosts_access 5 , | |
248bad82 | 834 | .Xr login.conf 5 , |
835 | .Xr moduli 5 , | |
588df31a | 836 | .Xr sshd_config 5 , |
433e60ac | 837 | .Xr inetd 8 , |
a5a2da3b | 838 | .Xr sftp-server 8 |
2cad6cef | 839 | .Rs |
840 | .%A T. Ylonen | |
841 | .%A T. Kivinen | |
842 | .%A M. Saarinen | |
843 | .%A T. Rinne | |
844 | .%A S. Lehtinen | |
845 | .%T "SSH Protocol Architecture" | |
17f5e68a | 846 | .%N draft-ietf-secsh-architecture-12.txt |
847 | .%D January 2002 | |
2cad6cef | 848 | .%O work in progress material |
849 | .Re | |
da89cf4d | 850 | .Rs |
851 | .%A M. Friedl | |
852 | .%A N. Provos | |
853 | .%A W. A. Simpson | |
854 | .%T "Diffie-Hellman Group Exchange for the SSH Transport Layer Protocol" | |
17f5e68a | 855 | .%N draft-ietf-secsh-dh-group-exchange-02.txt |
856 | .%D January 2002 | |
da89cf4d | 857 | .%O work in progress material |
858 | .Re | |
be193d89 | 859 | .Sh AUTHORS |
860 | OpenSSH is a derivative of the original and free | |
861 | ssh 1.2.12 release by Tatu Ylonen. | |
862 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, | |
863 | Theo de Raadt and Dug Song | |
864 | removed many bugs, re-added newer features and | |
865 | created OpenSSH. | |
866 | Markus Friedl contributed the support for SSH | |
867 | protocol versions 1.5 and 2.0. | |
868 | Niels Provos and Markus Friedl contributed support | |
869 | for privilege separation. |