]>
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 | .\" |
f464aad8 | 37 | .\" $OpenBSD: sshd.8,v 1.170 2002/02/28 20:46:10 stevesk 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 | |
2043936f | 46 | .Op Fl deiqtD46 |
bf740959 | 47 | .Op Fl b Ar bits |
48 | .Op Fl f Ar config_file | |
49 | .Op Fl g Ar login_grace_time | |
50 | .Op Fl h Ar host_key_file | |
51 | .Op Fl k Ar key_gen_time | |
2717fa0f | 52 | .Op Fl o Ar option |
bf740959 | 53 | .Op Fl p Ar port |
c345cf9d | 54 | .Op Fl u Ar len |
f54651ce | 55 | .Sh DESCRIPTION |
bf740959 | 56 | .Nm |
2c86906e | 57 | (SSH Daemon) is the daemon program for |
bf740959 | 58 | .Xr ssh 1 . |
3189621b | 59 | Together these programs replace rlogin and rsh, and |
bf740959 | 60 | provide secure encrypted communications between two untrusted hosts |
4fe2af09 | 61 | over an insecure network. |
62 | The programs are intended to be as easy to | |
bf740959 | 63 | install and use as possible. |
64 | .Pp | |
65 | .Nm | |
4fe2af09 | 66 | is the daemon that listens for connections from clients. |
f54651ce | 67 | It is normally started at boot from |
bf740959 | 68 | .Pa /etc/rc . |
69 | It forks a new | |
4fe2af09 | 70 | daemon for each incoming connection. |
71 | The forked daemons handle | |
bf740959 | 72 | key exchange, encryption, authentication, command execution, |
73 | and data exchange. | |
1d1ffb87 | 74 | This implementation of |
75 | .Nm | |
76 | supports both SSH protocol version 1 and 2 simultaneously. | |
bf740959 | 77 | .Nm |
4fe2af09 | 78 | works as follows. |
1d1ffb87 | 79 | .Pp |
80 | .Ss SSH protocol version 1 | |
81 | .Pp | |
4fe2af09 | 82 | Each host has a host-specific RSA key |
83 | (normally 1024 bits) used to identify the host. | |
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 | |
3189621b | 89 | Whenever a client connects the daemon responds with its public |
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. |
4fe2af09 | 93 | The client then generates a 256 bit random number. |
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 | |
bf740959 | 108 | .Pa .rhosts |
109 | authentication, | |
110 | .Pa .rhosts | |
111 | authentication combined with RSA host | |
112 | authentication, RSA challenge-response authentication, or password | |
113 | based authentication. | |
114 | .Pp | |
115 | Rhosts authentication is normally disabled | |
116 | because it is fundamentally insecure, but can be enabled in the server | |
4fe2af09 | 117 | configuration file if desired. |
118 | System security is not improved unless | |
bf740959 | 119 | .Xr rshd 8 , |
120 | .Xr rlogind 8 , | |
bf740959 | 121 | and |
9495bfc5 | 122 | .Xr rexecd 8 |
bf740959 | 123 | are disabled (thus completely disabling |
124 | .Xr rlogin 1 | |
125 | and | |
126 | .Xr rsh 1 | |
3189621b | 127 | into the machine). |
bf740959 | 128 | .Pp |
1d1ffb87 | 129 | .Ss SSH protocol version 2 |
130 | .Pp | |
c345cf9d | 131 | Version 2 works similarly: |
7f19f8bb | 132 | Each host has a host-specific key (RSA or DSA) used to identify the host. |
1d1ffb87 | 133 | However, when the daemon starts, it does not generate a server key. |
134 | Forward security is provided through a Diffie-Hellman key agreement. | |
135 | This key agreement results in a shared session key. | |
da89cf4d | 136 | .Pp |
51c251f0 | 137 | The rest of the session is encrypted using a symmetric cipher, currently |
da89cf4d | 138 | 128 bit AES, Blowfish, 3DES, CAST128, Arcfour, 192 bit AES, or 256 bit AES. |
1d1ffb87 | 139 | The client selects the encryption algorithm |
140 | to use from those offered by the server. | |
141 | Additionally, session integrity is provided | |
d0c832f3 | 142 | through a cryptographic message authentication code |
1d1ffb87 | 143 | (hmac-sha1 or hmac-md5). |
144 | .Pp | |
145 | Protocol version 2 provides a public key based | |
da89cf4d | 146 | user (PubkeyAuthentication) or |
147 | client host (HostbasedAuthentication) authentication method, | |
148 | conventional password authentication and challenge response based methods. | |
1d1ffb87 | 149 | .Pp |
150 | .Ss Command execution and data forwarding | |
151 | .Pp | |
bf740959 | 152 | If the client successfully authenticates itself, a dialog for |
4fe2af09 | 153 | preparing the session is entered. |
154 | At this time the client may request | |
bf740959 | 155 | things like allocating a pseudo-tty, forwarding X11 connections, |
156 | forwarding TCP/IP connections, or forwarding the authentication agent | |
157 | connection over the secure channel. | |
158 | .Pp | |
159 | Finally, the client either requests a shell or execution of a command. | |
4fe2af09 | 160 | The sides then enter session mode. |
161 | In this mode, either side may send | |
bf740959 | 162 | data at any time, and such data is forwarded to/from the shell or |
163 | command on the server side, and the user terminal in the client side. | |
164 | .Pp | |
165 | When the user program terminates and all forwarded X11 and other | |
166 | connections have been closed, the server sends command exit status to | |
167 | the client, and both sides exit. | |
168 | .Pp | |
169 | .Nm | |
170 | can be configured using command-line options or a configuration | |
4fe2af09 | 171 | file. |
172 | Command-line options override values specified in the | |
bf740959 | 173 | configuration file. |
174 | .Pp | |
9d6b7add | 175 | .Nm |
176 | rereads its configuration file when it receives a hangup signal, | |
409edaba | 177 | .Dv SIGHUP , |
a5a2da3b | 178 | by executing itself with the name it was started as, i.e., |
409edaba | 179 | .Pa /usr/sbin/sshd . |
9d6b7add | 180 | .Pp |
bf740959 | 181 | The options are as follows: |
182 | .Bl -tag -width Ds | |
183 | .It Fl b Ar bits | |
da89cf4d | 184 | Specifies the number of bits in the ephemeral protocol version 1 |
185 | server key (default 768). | |
bf740959 | 186 | .It Fl d |
4fe2af09 | 187 | Debug mode. |
188 | The server sends verbose debug output to the system | |
189 | log, and does not put itself in the background. | |
190 | The server also will not fork and will only process one connection. | |
191 | This option is only intended for debugging for the server. | |
da89cf4d | 192 | Multiple -d options increase the debugging level. |
94ec8c6b | 193 | Maximum is 3. |
da89cf4d | 194 | .It Fl e |
195 | When this option is specified, | |
196 | .Nm | |
197 | will send the output to the standard error instead of the system log. | |
bf740959 | 198 | .It Fl f Ar configuration_file |
4fe2af09 | 199 | Specifies the name of the configuration file. |
200 | The default is | |
2a8a6488 | 201 | .Pa /etc/ssh/sshd_config . |
bf740959 | 202 | .Nm |
203 | refuses to start if there is no configuration file. | |
204 | .It Fl g Ar login_grace_time | |
205 | Gives the grace time for clients to authenticate themselves (default | |
ee5e6612 | 206 | 600 seconds). |
4fe2af09 | 207 | If the client fails to authenticate the user within |
208 | this many seconds, the server disconnects and exits. | |
209 | A value of zero indicates no limit. | |
bf740959 | 210 | .It Fl h Ar host_key_file |
0f84fe37 | 211 | Specifies a file from which a host key is read. |
bf740959 | 212 | This option must be given if |
213 | .Nm | |
214 | is not run as root (as the normal | |
0f84fe37 | 215 | host key files are normally not readable by anyone but root). |
216 | The default is | |
2a8a6488 | 217 | .Pa /etc/ssh/ssh_host_key |
0f84fe37 | 218 | for protocol version 1, and |
2a8a6488 | 219 | .Pa /etc/ssh/ssh_host_rsa_key |
0f84fe37 | 220 | and |
2a8a6488 | 221 | .Pa /etc/ssh/ssh_host_dsa_key |
0f84fe37 | 222 | for protocol version 2. |
8abcdba4 | 223 | It is possible to have multiple host key files for |
da89cf4d | 224 | the different protocol versions and host key algorithms. |
bf740959 | 225 | .It Fl i |
226 | Specifies that | |
227 | .Nm | |
f54651ce | 228 | is being run from inetd. |
bf740959 | 229 | .Nm |
230 | is normally not run | |
231 | from inetd because it needs to generate the server key before it can | |
4fe2af09 | 232 | respond to the client, and this may take tens of seconds. |
233 | Clients would have to wait too long if the key was regenerated every time. | |
610cd5c6 | 234 | However, with small key sizes (e.g., 512) using |
bf740959 | 235 | .Nm |
236 | from inetd may | |
237 | be feasible. | |
238 | .It Fl k Ar key_gen_time | |
da89cf4d | 239 | Specifies how often the ephemeral protocol version 1 server key is |
240 | regenerated (default 3600 seconds, or one hour). | |
4fe2af09 | 241 | The motivation for regenerating the key fairly |
bf740959 | 242 | often is that the key is not stored anywhere, and after about an hour, |
243 | it becomes impossible to recover the key for decrypting intercepted | |
244 | communications even if the machine is cracked into or physically | |
4fe2af09 | 245 | seized. |
246 | A value of zero indicates that the key will never be regenerated. | |
2717fa0f | 247 | .It Fl o Ar option |
248 | Can be used to give options in the format used in the configuration file. | |
249 | This is useful for specifying options for which there is no separate | |
250 | command-line flag. | |
bf740959 | 251 | .It Fl p Ar port |
252 | Specifies the port on which the server listens for connections | |
253 | (default 22). | |
135113a3 | 254 | Multiple port options are permitted. |
255 | Ports specified in the configuration file are ignored when a | |
256 | command-line port is specified. | |
bf740959 | 257 | .It Fl q |
4fe2af09 | 258 | Quiet mode. |
259 | Nothing is sent to the system log. | |
260 | Normally the beginning, | |
bf740959 | 261 | authentication, and termination of each connection is logged. |
f87f09aa | 262 | .It Fl t |
263 | Test mode. | |
264 | Only check the validity of the configuration file and sanity of the keys. | |
184eed6a | 265 | This is useful for updating |
f87f09aa | 266 | .Nm |
267 | reliably as configuration options may change. | |
c345cf9d | 268 | .It Fl u Ar len |
269 | This option is used to specify the size of the field | |
270 | in the | |
271 | .Li utmp | |
272 | structure that holds the remote host name. | |
273 | If the resolved host name is longer than | |
274 | .Ar len , | |
275 | the dotted decimal value will be used instead. | |
276 | This allows hosts with very long host names that | |
277 | overflow this field to still be uniquely identified. | |
278 | Specifying | |
279 | .Fl u0 | |
280 | indicates that only dotted decimal addresses | |
281 | should be put into the | |
282 | .Pa utmp | |
283 | file. | |
e675b851 | 284 | .Fl u0 |
285 | is also be used to prevent | |
286 | .Nm | |
287 | from making DNS requests unless the authentication | |
288 | mechanism or configuration requires it. | |
289 | Authentication mechanisms that may require DNS include | |
290 | .Cm RhostsAuthentication , | |
291 | .Cm RhostsRSAAuthentication , | |
292 | .Cm HostbasedAuthentication | |
293 | and using a | |
294 | .Cm from="pattern-list" | |
295 | option in a key file. | |
f464aad8 | 296 | Configuration options that require DNS include using a |
297 | USER@HOST pattern in | |
298 | .Cm AllowUsers | |
299 | or | |
300 | .Cm DenyUsers . | |
8abcdba4 | 301 | .It Fl D |
302 | When this option is specified | |
303 | .Nm | |
304 | will not detach and does not become a daemon. | |
305 | This allows easy monitoring of | |
306 | .Nm sshd . | |
48e671d5 | 307 | .It Fl 4 |
308 | Forces | |
309 | .Nm | |
310 | to use IPv4 addresses only. | |
311 | .It Fl 6 | |
312 | Forces | |
313 | .Nm | |
314 | to use IPv6 addresses only. | |
bf740959 | 315 | .El |
316 | .Sh CONFIGURATION FILE | |
317 | .Nm | |
f54651ce | 318 | reads configuration data from |
2a8a6488 | 319 | .Pa /etc/ssh/sshd_config |
bf740959 | 320 | (or the file specified with |
321 | .Fl f | |
4fe2af09 | 322 | on the command line). |
54bf768d | 323 | The file contains keyword-argument pairs, one per line. |
4fe2af09 | 324 | Lines starting with |
bf740959 | 325 | .Ql # |
326 | and empty lines are interpreted as comments. | |
327 | .Pp | |
54bf768d | 328 | The possible |
329 | keywords and their meanings are as follows (note that | |
330 | keywords are case-insensitive and arguments are case-sensitive): | |
bf740959 | 331 | .Bl -tag -width Ds |
332 | .It Cm AFSTokenPassing | |
4fe2af09 | 333 | Specifies whether an AFS token may be forwarded to the server. |
334 | Default is | |
bf740959 | 335 | .Dq yes . |
336 | .It Cm AllowGroups | |
dfafef8f | 337 | This keyword can be followed by a list of group name patterns, separated |
4fe2af09 | 338 | by spaces. |
339 | If specified, login is allowed only for users whose primary | |
c6a69271 | 340 | group or supplementary group list matches one of the patterns. |
bf740959 | 341 | .Ql \&* |
342 | and | |
343 | .Ql ? | |
344 | can be used as | |
4fe2af09 | 345 | wildcards in the patterns. |
91789042 | 346 | Only group names are valid; a numerical group ID is not recognized. |
dfafef8f | 347 | By default, login is allowed for all groups. |
bf740959 | 348 | .Pp |
33de75a3 | 349 | .It Cm AllowTcpForwarding |
350 | Specifies whether TCP forwarding is permitted. | |
351 | The default is | |
352 | .Dq yes . | |
353 | Note that disabling TCP forwarding does not improve security unless | |
354 | users are also denied shell access, as they can always install their | |
355 | own forwarders. | |
356 | .Pp | |
bf740959 | 357 | .It Cm AllowUsers |
dfafef8f | 358 | This keyword can be followed by a list of user name patterns, separated |
4fe2af09 | 359 | by spaces. |
360 | If specified, login is allowed only for users names that | |
bf740959 | 361 | match one of the patterns. |
362 | .Ql \&* | |
363 | and | |
364 | .Ql ? | |
365 | can be used as | |
4fe2af09 | 366 | wildcards in the patterns. |
91789042 | 367 | Only user names are valid; a numerical user ID is not recognized. |
dfafef8f | 368 | By default, login is allowed for all users. |
80f8f24f | 369 | If the pattern takes the form USER@HOST then USER and HOST |
91789042 | 370 | are separately checked, restricting logins to particular |
80f8f24f | 371 | users from particular hosts. |
bf740959 | 372 | .Pp |
c8445989 | 373 | .It Cm AuthorizedKeysFile |
7f19f8bb | 374 | Specifies the file that contains the public keys that can be used |
375 | for user authentication. | |
c8445989 | 376 | .Cm AuthorizedKeysFile |
377 | may contain tokens of the form %T which are substituted during connection | |
ae897d7c | 378 | set-up. The following tokens are defined: %% is replaced by a literal '%', |
c8445989 | 379 | %h is replaced by the home directory of the user being authenticated and |
380 | %u is replaced by the username of that user. | |
381 | After expansion, | |
382 | .Cm AuthorizedKeysFile | |
f740438e | 383 | is taken to be an absolute path or one relative to the user's home |
c8445989 | 384 | directory. |
385 | The default is | |
cb362b5e | 386 | .Dq .ssh/authorized_keys . |
eea39c02 | 387 | .It Cm Banner |
388 | In some jurisdictions, sending a warning message before authentication | |
389 | may be relevant for getting legal protection. | |
390 | The contents of the specified file are sent to the remote user before | |
391 | authentication is allowed. | |
392 | This option is only available for protocol version 2. | |
393 | .Pp | |
657297ff | 394 | .It Cm ChallengeResponseAuthentication |
248bad82 | 395 | Specifies whether challenge response authentication is allowed. |
396 | All authentication styles from | |
397 | .Xr login.conf 5 | |
398 | are supported. | |
657297ff | 399 | The default is |
400 | .Dq yes . | |
a18395da | 401 | .It Cm Ciphers |
402 | Specifies the ciphers allowed for protocol version 2. | |
403 | Multiple ciphers must be comma-separated. | |
404 | The default is | |
ba218fbe | 405 | .Pp |
406 | .Bd -literal | |
407 | ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour, | |
408 | aes192-cbc,aes256-cbc'' | |
409 | .Ed | |
3ffc6336 | 410 | .It Cm ClientAliveInterval |
411 | Sets a timeout interval in seconds after which if no data has been received | |
3730bb22 | 412 | from the client, |
3ffc6336 | 413 | .Nm |
414 | will send a message through the encrypted | |
84fc17bf | 415 | channel to request a response from the client. |
416 | The default | |
3ffc6336 | 417 | is 0, indicating that these messages will not be sent to the client. |
84fc17bf | 418 | This option applies to protocol version 2 only. |
3ffc6336 | 419 | .It Cm ClientAliveCountMax |
420 | Sets the number of client alive messages (see above) which may be | |
421 | sent without | |
422 | .Nm | |
423 | receiving any messages back from the client. If this threshold is | |
3730bb22 | 424 | reached while client alive messages are being sent, |
3ffc6336 | 425 | .Nm |
426 | will disconnect the client, terminating the session. It is important | |
3730bb22 | 427 | to note that the use of client alive messages is very different from |
713d61f7 | 428 | .Cm KeepAlive |
84fc17bf | 429 | (below). The client alive messages are sent through the |
3ffc6336 | 430 | encrypted channel and therefore will not be spoofable. The TCP keepalive |
84fc17bf | 431 | option enabled by |
713d61f7 | 432 | .Cm KeepAlive |
91789042 | 433 | is spoofable. The client alive mechanism is valuable when the client or |
434 | server depend on knowing when a connection has become inactive. | |
84fc17bf | 435 | .Pp |
91789042 | 436 | The default value is 3. If |
84fc17bf | 437 | .Cm ClientAliveInterval |
91789042 | 438 | (above) is set to 15, and |
fc7eca52 | 439 | .Cm ClientAliveCountMax |
440 | is left at the default, unresponsive ssh clients | |
3730bb22 | 441 | will be disconnected after approximately 45 seconds. |
bf740959 | 442 | .It Cm DenyGroups |
dfafef8f | 443 | This keyword can be followed by a list of group name patterns, separated |
4fe2af09 | 444 | by spaces. |
dfafef8f | 445 | Login is disallowed for users whose primary group or supplementary |
446 | group list matches one of the patterns. | |
bf740959 | 447 | .Ql \&* |
448 | and | |
449 | .Ql ? | |
450 | can be used as | |
4fe2af09 | 451 | wildcards in the patterns. |
91789042 | 452 | Only group names are valid; a numerical group ID is not recognized. |
dfafef8f | 453 | By default, login is allowed for all groups. |
bf740959 | 454 | .Pp |
455 | .It Cm DenyUsers | |
dfafef8f | 456 | This keyword can be followed by a list of user name patterns, separated |
4fe2af09 | 457 | by spaces. |
458 | Login is disallowed for user names that match one of the patterns. | |
bf740959 | 459 | .Ql \&* |
460 | and | |
461 | .Ql ? | |
4fe2af09 | 462 | can be used as wildcards in the patterns. |
91789042 | 463 | Only user names are valid; a numerical user ID is not recognized. |
dfafef8f | 464 | By default, login is allowed for all users. |
ebb1bf1a | 465 | If the pattern takes the form USER@HOST then USER and HOST |
466 | are separately checked, restricting logins to particular | |
467 | users from particular hosts. | |
1d1ffb87 | 468 | .It Cm GatewayPorts |
469 | Specifies whether remote hosts are allowed to connect to ports | |
470 | forwarded for the client. | |
70068acc | 471 | By default, |
472 | .Nm | |
473 | binds remote port forwardings to the loopback addresss. This | |
474 | prevents other remote hosts from connecting to forwarded ports. | |
475 | .Cm GatewayPorts | |
476 | can be used to specify that | |
477 | .Nm | |
478 | should bind remote port forwardings to the wildcard address, | |
479 | thus allowing remote hosts to connect to forwarded ports. | |
1d1ffb87 | 480 | The argument must be |
481 | .Dq yes | |
482 | or | |
483 | .Dq no . | |
484 | The default is | |
485 | .Dq no . | |
da89cf4d | 486 | .It Cm HostbasedAuthentication |
487 | Specifies whether rhosts or /etc/hosts.equiv authentication together | |
488 | with successful public key client host authentication is allowed | |
489 | (hostbased authentication). | |
490 | This option is similar to | |
491 | .Cm RhostsRSAAuthentication | |
492 | and applies to protocol version 2 only. | |
493 | The default is | |
494 | .Dq no . | |
bf740959 | 495 | .It Cm HostKey |
0f84fe37 | 496 | Specifies a file containing a private host key |
497 | used by SSH. | |
498 | The default is | |
2a8a6488 | 499 | .Pa /etc/ssh/ssh_host_key |
0f84fe37 | 500 | for protocol version 1, and |
2a8a6488 | 501 | .Pa /etc/ssh/ssh_host_rsa_key |
0f84fe37 | 502 | and |
2a8a6488 | 503 | .Pa /etc/ssh/ssh_host_dsa_key |
0f84fe37 | 504 | for protocol version 2. |
bf740959 | 505 | Note that |
506 | .Nm | |
42f11eb2 | 507 | will refuse to use a file if it is group/world-accessible. |
fa08c86b | 508 | It is possible to have multiple host key files. |
509 | .Dq rsa1 | |
510 | keys are used for version 1 and | |
511 | .Dq dsa | |
512 | or | |
513 | .Dq rsa | |
514 | are used for version 2 of the SSH protocol. | |
bf740959 | 515 | .It Cm IgnoreRhosts |
c8d54615 | 516 | Specifies that |
517 | .Pa .rhosts | |
f54651ce | 518 | and |
c8d54615 | 519 | .Pa .shosts |
da89cf4d | 520 | files will not be used in |
521 | .Cm RhostsAuthentication , | |
522 | .Cm RhostsRSAAuthentication | |
523 | or | |
524 | .Cm HostbasedAuthentication . | |
525 | .Pp | |
bf740959 | 526 | .Pa /etc/hosts.equiv |
527 | and | |
f54651ce | 528 | .Pa /etc/shosts.equiv |
4fe2af09 | 529 | are still used. |
f54651ce | 530 | The default is |
c8d54615 | 531 | .Dq yes . |
b4748e2f | 532 | .It Cm IgnoreUserKnownHosts |
533 | Specifies whether | |
534 | .Nm | |
535 | should ignore the user's | |
536 | .Pa $HOME/.ssh/known_hosts | |
537 | during | |
da89cf4d | 538 | .Cm RhostsRSAAuthentication |
539 | or | |
540 | .Cm HostbasedAuthentication . | |
b4748e2f | 541 | The default is |
542 | .Dq no . | |
bf740959 | 543 | .It Cm KeepAlive |
3b5a1b05 | 544 | Specifies whether the system should send TCP keepalive messages to the |
4fe2af09 | 545 | other side. |
546 | If they are sent, death of the connection or crash of one | |
547 | of the machines will be properly noticed. | |
548 | However, this means that | |
bf740959 | 549 | connections will die if the route is down temporarily, and some people |
4fe2af09 | 550 | find it annoying. |
d0c832f3 | 551 | On the other hand, if keepalives are not sent, |
bf740959 | 552 | sessions may hang indefinitely on the server, leaving |
553 | .Dq ghost | |
554 | users and consuming server resources. | |
555 | .Pp | |
556 | The default is | |
557 | .Dq yes | |
558 | (to send keepalives), and the server will notice | |
3b5a1b05 | 559 | if the network goes down or the client host crashes. |
4fe2af09 | 560 | This avoids infinitely hanging sessions. |
bf740959 | 561 | .Pp |
562 | To disable keepalives, the value should be set to | |
3b5a1b05 | 563 | .Dq no . |
bf740959 | 564 | .It Cm KerberosAuthentication |
4fe2af09 | 565 | Specifies whether Kerberos authentication is allowed. |
566 | This can be in the form of a Kerberos ticket, or if | |
bf740959 | 567 | .Cm PasswordAuthentication |
568 | is yes, the password provided by the user will be validated through | |
94ec8c6b | 569 | the Kerberos KDC. |
570 | To use this option, the server needs a | |
c345cf9d | 571 | Kerberos servtab which allows the verification of the KDC's identity. |
4fe2af09 | 572 | Default is |
bf740959 | 573 | .Dq yes . |
574 | .It Cm KerberosOrLocalPasswd | |
575 | If set then if password authentication through Kerberos fails then | |
576 | the password will be validated via any additional local mechanism | |
577 | such as | |
188adeb2 | 578 | .Pa /etc/passwd . |
4fe2af09 | 579 | Default is |
bf740959 | 580 | .Dq yes . |
581 | .It Cm KerberosTgtPassing | |
582 | Specifies whether a Kerberos TGT may be forwarded to the server. | |
f54651ce | 583 | Default is |
bf740959 | 584 | .Dq no , |
585 | as this only works when the Kerberos KDC is actually an AFS kaserver. | |
586 | .It Cm KerberosTicketCleanup | |
587 | Specifies whether to automatically destroy the user's ticket cache | |
4fe2af09 | 588 | file on logout. |
589 | Default is | |
bf740959 | 590 | .Dq yes . |
591 | .It Cm KeyRegenerationInterval | |
da89cf4d | 592 | In protocol version 1, the ephemeral server key is automatically regenerated |
593 | after this many seconds (if it has been used). | |
4fe2af09 | 594 | The purpose of regeneration is to prevent |
bf740959 | 595 | decrypting captured sessions by later breaking into the machine and |
4fe2af09 | 596 | stealing the keys. |
597 | The key is never stored anywhere. | |
598 | If the value is 0, the key is never regenerated. | |
599 | The default is 3600 (seconds). | |
bf740959 | 600 | .It Cm ListenAddress |
6e9944b8 | 601 | Specifies the local addresses |
da89cf4d | 602 | .Nm |
bf740959 | 603 | should listen on. |
6e9944b8 | 604 | The following forms may be used: |
605 | .Pp | |
606 | .Bl -item -offset indent -compact | |
607 | .It | |
608 | .Cm ListenAddress | |
b8a297f1 | 609 | .Sm off |
610 | .Ar host No | Ar IPv4_addr No | Ar IPv6_addr | |
611 | .Sm on | |
6e9944b8 | 612 | .It |
613 | .Cm ListenAddress | |
b8a297f1 | 614 | .Sm off |
615 | .Ar host No | Ar IPv4_addr No : Ar port | |
616 | .Sm on | |
6e9944b8 | 617 | .It |
618 | .Cm ListenAddress | |
b8a297f1 | 619 | .Sm off |
620 | .Oo | |
621 | .Ar host No | Ar IPv6_addr Oc : Ar port | |
622 | .Sm on | |
6e9944b8 | 623 | .El |
624 | .Pp | |
625 | If | |
b8a297f1 | 626 | .Ar port |
6e9944b8 | 627 | is not specified, |
da89cf4d | 628 | .Nm |
6e9944b8 | 629 | will listen on the address and all prior |
630 | .Cm Port | |
631 | options specified. The default is to listen on all local | |
632 | addresses. Multiple | |
633 | .Cm ListenAddress | |
634 | options are permitted. Additionally, any | |
635 | .Cm Port | |
636 | options must precede this option for non port qualified addresses. | |
bf740959 | 637 | .It Cm LoginGraceTime |
638 | The server disconnects after this time if the user has not | |
4fe2af09 | 639 | successfully logged in. |
640 | If the value is 0, there is no time limit. | |
bf740959 | 641 | The default is 600 (seconds). |
6a17f9c2 | 642 | .It Cm LogLevel |
643 | Gives the verbosity level that is used when logging messages from | |
644 | .Nm sshd . | |
645 | The possible values are: | |
60015649 | 646 | QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3. |
647 | The default is INFO. DEBUG and DEBUG1 are equivalent. DEBUG2 | |
648 | and DEBUG3 each specify higher levels of debugging output. | |
649 | Logging with a DEBUG level violates the privacy of users | |
6a17f9c2 | 650 | and is not recommended. |
b2552997 | 651 | .It Cm MACs |
652 | Specifies the available MAC (message authentication code) algorithms. | |
653 | The MAC algorithm is used in protocol version 2 | |
654 | for data integrity protection. | |
655 | Multiple algorithms must be comma-separated. | |
656 | The default is | |
47bf6266 | 657 | .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 . |
089fbbd2 | 658 | .It Cm MaxStartups |
659 | Specifies the maximum number of concurrent unauthenticated connections to the | |
660 | .Nm | |
661 | daemon. | |
662 | Additional connections will be dropped until authentication succeeds or the | |
663 | .Cm LoginGraceTime | |
664 | expires for a connection. | |
665 | The default is 10. | |
c345cf9d | 666 | .Pp |
667 | Alternatively, random early drop can be enabled by specifying | |
668 | the three colon separated values | |
669 | .Dq start:rate:full | |
94ec8c6b | 670 | (e.g., "10:30:60"). |
c345cf9d | 671 | .Nm |
6f37606e | 672 | will refuse connection attempts with a probability of |
c345cf9d | 673 | .Dq rate/100 |
674 | (30%) | |
675 | if there are currently | |
676 | .Dq start | |
677 | (10) | |
678 | unauthenticated connections. | |
6f37606e | 679 | The probability increases linearly and all connection attempts |
c345cf9d | 680 | are refused if the number of unauthenticated connections reaches |
681 | .Dq full | |
682 | (60). | |
10f72868 | 683 | .It Cm PAMAuthenticationViaKbdInt |
684 | Specifies whether PAM challenge response authentication is allowed. This | |
685 | allows the use of most PAM challenge response authentication modules, but | |
686 | it will allow password authentication regardless of whether | |
687 | .Cm PasswordAuthentication | |
688 | is disabled. | |
689 | The default is | |
690 | .Dq no . | |
bf740959 | 691 | .It Cm PasswordAuthentication |
692 | Specifies whether password authentication is allowed. | |
693 | The default is | |
694 | .Dq yes . | |
695 | .It Cm PermitEmptyPasswords | |
696 | When password authentication is allowed, it specifies whether the | |
4fe2af09 | 697 | server allows login to accounts with empty password strings. |
698 | The default is | |
c8d54615 | 699 | .Dq no . |
bf740959 | 700 | .It Cm PermitRootLogin |
46f23b8d | 701 | Specifies whether root can login using |
bf740959 | 702 | .Xr ssh 1 . |
703 | The argument must be | |
704 | .Dq yes , | |
15853e93 | 705 | .Dq without-password , |
706 | .Dq forced-commands-only | |
bf740959 | 707 | or |
708 | .Dq no . | |
709 | The default is | |
710 | .Dq yes . | |
15853e93 | 711 | .Pp |
712 | If this option is set to | |
bf740959 | 713 | .Dq without-password |
15853e93 | 714 | password authentication is disabled for root. |
bf740959 | 715 | .Pp |
15853e93 | 716 | If this option is set to |
717 | .Dq forced-commands-only | |
718 | root login with public key authentication will be allowed, | |
719 | but only if the | |
bf740959 | 720 | .Ar command |
15853e93 | 721 | option has been specified |
bf740959 | 722 | (which may be useful for taking remote backups even if root login is |
15853e93 | 723 | normally not allowed). All other authentication methods are disabled |
724 | for root. | |
46f23b8d | 725 | .Pp |
726 | If this option is set to | |
727 | .Dq no | |
728 | root is not allowed to login. | |
0fbe8c74 | 729 | .It Cm PidFile |
730 | Specifies the file that contains the process identifier of the | |
731 | .Nm | |
732 | daemon. | |
733 | The default is | |
734 | .Pa /var/run/sshd.pid . | |
bf740959 | 735 | .It Cm Port |
736 | Specifies the port number that | |
737 | .Nm | |
4fe2af09 | 738 | listens on. |
739 | The default is 22. | |
48e671d5 | 740 | Multiple options of this type are permitted. |
da89cf4d | 741 | See also |
742 | .Cm ListenAddress . | |
4f4648f9 | 743 | .It Cm PrintLastLog |
744 | Specifies whether | |
745 | .Nm | |
746 | should print the date and time when the user last logged in. | |
747 | The default is | |
748 | .Dq yes . | |
bf740959 | 749 | .It Cm PrintMotd |
750 | Specifies whether | |
751 | .Nm | |
f54651ce | 752 | should print |
bf740959 | 753 | .Pa /etc/motd |
4fe2af09 | 754 | when a user logs in interactively. |
755 | (On some systems it is also printed by the shell, | |
bf740959 | 756 | .Pa /etc/profile , |
4fe2af09 | 757 | or equivalent.) |
758 | The default is | |
bf740959 | 759 | .Dq yes . |
f54651ce | 760 | .It Cm Protocol |
761 | Specifies the protocol versions | |
762 | .Nm | |
763 | should support. | |
764 | The possible values are | |
765 | .Dq 1 | |
766 | and | |
767 | .Dq 2 . | |
768 | Multiple versions must be comma-separated. | |
769 | The default is | |
6023325e | 770 | .Dq 2,1 . |
657297ff | 771 | .It Cm PubkeyAuthentication |
772 | Specifies whether public key authentication is allowed. | |
773 | The default is | |
774 | .Dq yes . | |
775 | Note that this option applies to protocol version 2 only. | |
bf740959 | 776 | .It Cm RhostsAuthentication |
777 | Specifies whether authentication using rhosts or /etc/hosts.equiv | |
4fe2af09 | 778 | files is sufficient. |
779 | Normally, this method should not be permitted because it is insecure. | |
bf740959 | 780 | .Cm RhostsRSAAuthentication |
781 | should be used | |
782 | instead, because it performs RSA-based host authentication in addition | |
783 | to normal rhosts or /etc/hosts.equiv authentication. | |
784 | The default is | |
785 | .Dq no . | |
da89cf4d | 786 | This option applies to protocol version 1 only. |
bf740959 | 787 | .It Cm RhostsRSAAuthentication |
788 | Specifies whether rhosts or /etc/hosts.equiv authentication together | |
4fe2af09 | 789 | with successful RSA host authentication is allowed. |
790 | The default is | |
c8d54615 | 791 | .Dq no . |
da89cf4d | 792 | This option applies to protocol version 1 only. |
bf740959 | 793 | .It Cm RSAAuthentication |
4fe2af09 | 794 | Specifies whether pure RSA authentication is allowed. |
795 | The default is | |
bf740959 | 796 | .Dq yes . |
da89cf4d | 797 | This option applies to protocol version 1 only. |
bf740959 | 798 | .It Cm ServerKeyBits |
da89cf4d | 799 | Defines the number of bits in the ephemeral protocol version 1 server key. |
4fe2af09 | 800 | The minimum value is 512, and the default is 768. |
bf740959 | 801 | .It Cm StrictModes |
802 | Specifies whether | |
803 | .Nm | |
804 | should check file modes and ownership of the | |
4fe2af09 | 805 | user's files and home directory before accepting login. |
806 | This is normally desirable because novices sometimes accidentally leave their | |
807 | directory or files world-writable. | |
808 | The default is | |
bf740959 | 809 | .Dq yes . |
38c295d6 | 810 | .It Cm Subsystem |
94ec8c6b | 811 | Configures an external subsystem (e.g., file transfer daemon). |
812 | Arguments should be a subsystem name and a command to execute upon subsystem | |
813 | request. | |
b5e300c2 | 814 | The command |
815 | .Xr sftp-server 8 | |
816 | implements the | |
817 | .Dq sftp | |
818 | file transfer subsystem. | |
38c295d6 | 819 | By default no subsystems are defined. |
820 | Note that this option applies to protocol version 2 only. | |
bf740959 | 821 | .It Cm SyslogFacility |
822 | Gives the facility code that is used when logging messages from | |
823 | .Nm sshd . | |
824 | The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, | |
4fe2af09 | 825 | LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. |
826 | The default is AUTH. | |
bf740959 | 827 | .It Cm UseLogin |
828 | Specifies whether | |
829 | .Xr login 1 | |
fa649821 | 830 | is used for interactive login sessions. |
ff027d84 | 831 | The default is |
832 | .Dq no . | |
fa649821 | 833 | Note that |
834 | .Xr login 1 | |
c345cf9d | 835 | is never used for remote command execution. |
3730bb22 | 836 | Note also, that if this is enabled, |
837 | .Cm X11Forwarding | |
ff027d84 | 838 | will be disabled because |
839 | .Xr login 1 | |
840 | does not know how to handle | |
3730bb22 | 841 | .Xr xauth 1 |
ff027d84 | 842 | cookies. |
bf4c5edc | 843 | .It Cm VerifyReverseMapping |
844 | Specifies whether | |
845 | .Nm | |
846 | should try to verify the remote host name and check that | |
847 | the resolved host name for the remote IP address maps back to the | |
848 | very same IP address. | |
849 | The default is | |
850 | .Dq no . | |
bf740959 | 851 | .It Cm X11DisplayOffset |
852 | Specifies the first display number available for | |
853 | .Nm sshd Ns 's | |
4fe2af09 | 854 | X11 forwarding. |
855 | This prevents | |
bf740959 | 856 | .Nm |
857 | from interfering with real X11 servers. | |
c8d54615 | 858 | The default is 10. |
7b2ea3a1 | 859 | .It Cm X11Forwarding |
4fe2af09 | 860 | Specifies whether X11 forwarding is permitted. |
861 | The default is | |
c8d54615 | 862 | .Dq no . |
7b2ea3a1 | 863 | Note that disabling X11 forwarding does not improve security in any |
864 | way, as users can always install their own forwarders. | |
3730bb22 | 865 | X11 forwarding is automatically disabled if |
866 | .Cm UseLogin | |
867 | is enabled. | |
e6e573bd | 868 | .It Cm X11UseLocalhost |
869 | Specifies whether | |
870 | .Nm | |
871 | should bind the X11 forwarding server to the loopback address or to | |
872 | the wildcard address. By default, | |
873 | .Nm | |
874 | binds the forwarding server to the loopback address and sets the | |
875 | hostname part of the | |
876 | .Ev DISPLAY | |
877 | environment variable to | |
878 | .Dq localhost . | |
879 | This prevents remote hosts from connecting to the fake display. | |
880 | However, some older X11 clients may not function with this | |
881 | configuration. | |
882 | .Cm X11UseLocalhost | |
883 | may be set to | |
884 | .Dq no | |
885 | to specify that the forwarding server should be bound to the wildcard | |
886 | address. | |
887 | The argument must be | |
888 | .Dq yes | |
889 | or | |
890 | .Dq no . | |
891 | The default is | |
892 | .Dq yes . | |
fa649821 | 893 | .It Cm XAuthLocation |
894 | Specifies the location of the | |
895 | .Xr xauth 1 | |
896 | program. | |
897 | The default is | |
898 | .Pa /usr/X11R6/bin/xauth . | |
bf740959 | 899 | .El |
e2b1fb42 | 900 | .Ss Time Formats |
901 | .Pp | |
902 | .Nm | |
903 | command-line arguments and configuration file options that specify time | |
904 | may be expressed using a sequence of the form: | |
905 | .Sm off | |
906 | .Ar time Oo Ar qualifier Oc , | |
907 | .Sm on | |
908 | where | |
909 | .Ar time | |
910 | is a positive integer value and | |
911 | .Ar qualifier | |
912 | is one of the following: | |
913 | .Pp | |
914 | .Bl -tag -width Ds -compact -offset indent | |
915 | .It Cm <none> | |
916 | seconds | |
917 | .It Cm s | Cm S | |
918 | seconds | |
919 | .It Cm m | Cm M | |
920 | minutes | |
921 | .It Cm h | Cm H | |
922 | hours | |
923 | .It Cm d | Cm D | |
924 | days | |
925 | .It Cm w | Cm W | |
926 | weeks | |
927 | .El | |
928 | .Pp | |
929 | Each member of the sequence is added together to calculate | |
930 | the total time value. | |
931 | .Pp | |
932 | Time format examples: | |
933 | .Pp | |
934 | .Bl -tag -width Ds -compact -offset indent | |
935 | .It 600 | |
936 | 600 seconds (10 minutes) | |
937 | .It 10m | |
938 | 10 minutes | |
939 | .It 1h30m | |
940 | 1 hour 30 minutes (90 minutes) | |
941 | .El | |
bf740959 | 942 | .Sh LOGIN PROCESS |
943 | When a user successfully logs in, | |
944 | .Nm | |
945 | does the following: | |
946 | .Bl -enum -offset indent | |
947 | .It | |
948 | If the login is on a tty, and no command has been specified, | |
f54651ce | 949 | prints last login time and |
bf740959 | 950 | .Pa /etc/motd |
951 | (unless prevented in the configuration file or by | |
952 | .Pa $HOME/.hushlogin ; | |
953 | see the | |
f54651ce | 954 | .Sx FILES |
bf740959 | 955 | section). |
956 | .It | |
957 | If the login is on a tty, records login time. | |
958 | .It | |
959 | Checks | |
960 | .Pa /etc/nologin ; | |
961 | if it exists, prints contents and quits | |
962 | (unless root). | |
963 | .It | |
964 | Changes to run with normal user privileges. | |
965 | .It | |
966 | Sets up basic environment. | |
967 | .It | |
968 | Reads | |
969 | .Pa $HOME/.ssh/environment | |
970 | if it exists. | |
971 | .It | |
972 | Changes to user's home directory. | |
973 | .It | |
974 | If | |
975 | .Pa $HOME/.ssh/rc | |
976 | exists, runs it; else if | |
af98ced9 | 977 | .Pa /etc/ssh/sshrc |
bf740959 | 978 | exists, runs |
4fe2af09 | 979 | it; otherwise runs xauth. |
980 | The | |
bf740959 | 981 | .Dq rc |
982 | files are given the X11 | |
983 | authentication protocol and cookie in standard input. | |
984 | .It | |
985 | Runs user's shell or command. | |
986 | .El | |
987 | .Sh AUTHORIZED_KEYS FILE FORMAT | |
bf740959 | 988 | .Pa $HOME/.ssh/authorized_keys |
96a7b0cc | 989 | is the default file that lists the public keys that are |
990 | permitted for RSA authentication in protocol version 1 | |
991 | and for public key authentication (PubkeyAuthentication) | |
da89cf4d | 992 | in protocol version 2. |
96a7b0cc | 993 | .Cm AuthorizedKeysFile |
c8445989 | 994 | may be used to specify an alternative file. |
8abcdba4 | 995 | .Pp |
4fe2af09 | 996 | Each line of the file contains one |
bf740959 | 997 | key (empty lines and lines starting with a |
998 | .Ql # | |
999 | are ignored as | |
4fe2af09 | 1000 | comments). |
8abcdba4 | 1001 | Each RSA public key consists of the following fields, separated by |
4fe2af09 | 1002 | spaces: options, bits, exponent, modulus, comment. |
8abcdba4 | 1003 | Each protocol version 2 public key consists of: |
1004 | options, keytype, base64 encoded key, comment. | |
1005 | The options fields | |
1006 | are optional; its presence is determined by whether the line starts | |
bf740959 | 1007 | with a number or not (the option field never starts with a number). |
8abcdba4 | 1008 | The bits, exponent, modulus and comment fields give the RSA key for |
1009 | protocol version 1; the | |
bf740959 | 1010 | comment field is not used for anything (but may be convenient for the |
1011 | user to identify the key). | |
8abcdba4 | 1012 | For protocol version 2 the keytype is |
1013 | .Dq ssh-dss | |
1014 | or | |
1015 | .Dq ssh-rsa . | |
bf740959 | 1016 | .Pp |
1017 | Note that lines in this file are usually several hundred bytes long | |
4fe2af09 | 1018 | (because of the size of the RSA key modulus). |
1019 | You don't want to type them in; instead, copy the | |
c0ecc314 | 1020 | .Pa identity.pub , |
8abcdba4 | 1021 | .Pa id_dsa.pub |
c0ecc314 | 1022 | or the |
1023 | .Pa id_rsa.pub | |
bf740959 | 1024 | file and edit it. |
1025 | .Pp | |
c345cf9d | 1026 | The options (if present) consist of comma-separated option |
4fe2af09 | 1027 | specifications. |
1028 | No spaces are permitted, except within double quotes. | |
54bf768d | 1029 | The following option specifications are supported (note |
1030 | that option keywords are case-insensitive): | |
bf740959 | 1031 | .Bl -tag -width Ds |
1032 | .It Cm from="pattern-list" | |
1033 | Specifies that in addition to RSA authentication, the canonical name | |
1034 | of the remote host must be present in the comma-separated list of | |
4fe2af09 | 1035 | patterns |
1036 | .Pf ( Ql * | |
1037 | and | |
1038 | .Ql ? | |
1039 | serve as wildcards). | |
1040 | The list may also contain | |
1041 | patterns negated by prefixing them with | |
1042 | .Ql ! ; | |
1043 | if the canonical host name matches a negated pattern, the key is not accepted. | |
1044 | The purpose | |
bf740959 | 1045 | of this option is to optionally increase security: RSA authentication |
1046 | by itself does not trust the network or name servers or anything (but | |
1047 | the key); however, if somebody somehow steals the key, the key | |
4fe2af09 | 1048 | permits an intruder to log in from anywhere in the world. |
1049 | This additional option makes using a stolen key more difficult (name | |
bf740959 | 1050 | servers and/or routers would have to be compromised in addition to |
1051 | just the key). | |
1052 | .It Cm command="command" | |
1053 | Specifies that the command is executed whenever this key is used for | |
4fe2af09 | 1054 | authentication. |
1055 | The command supplied by the user (if any) is ignored. | |
9658ecbc | 1056 | The command is run on a pty if the client requests a pty; |
4fe2af09 | 1057 | otherwise it is run without a tty. |
91789042 | 1058 | If a 8-bit clean channel is required, |
1059 | one must not request a pty or should specify | |
61e96248 | 1060 | .Cm no-pty . |
4fe2af09 | 1061 | A quote may be included in the command by quoting it with a backslash. |
1062 | This option might be useful | |
1063 | to restrict certain RSA keys to perform just a specific operation. | |
1064 | An example might be a key that permits remote backups but nothing else. | |
d0c832f3 | 1065 | Note that the client may specify TCP/IP and/or X11 |
1066 | forwarding unless they are explicitly prohibited. | |
4cdbc654 | 1067 | Note that this option applies to shell, command or subsystem execution. |
bf740959 | 1068 | .It Cm environment="NAME=value" |
1069 | Specifies that the string is to be added to the environment when | |
4fe2af09 | 1070 | logging in using this key. |
1071 | Environment variables set this way | |
1072 | override other default environment values. | |
1073 | Multiple options of this type are permitted. | |
2548961d | 1074 | This option is automatically disabled if |
1075 | .Cm UseLogin | |
1076 | is enabled. | |
bf740959 | 1077 | .It Cm no-port-forwarding |
1078 | Forbids TCP/IP forwarding when this key is used for authentication. | |
4fe2af09 | 1079 | Any port forward requests by the client will return an error. |
1080 | This might be used, e.g., in connection with the | |
bf740959 | 1081 | .Cm command |
1082 | option. | |
1083 | .It Cm no-X11-forwarding | |
1084 | Forbids X11 forwarding when this key is used for authentication. | |
1085 | Any X11 forward requests by the client will return an error. | |
1086 | .It Cm no-agent-forwarding | |
1087 | Forbids authentication agent forwarding when this key is used for | |
1088 | authentication. | |
1089 | .It Cm no-pty | |
1090 | Prevents tty allocation (a request to allocate a pty will fail). | |
dc504afd | 1091 | .It Cm permitopen="host:port" |
3730bb22 | 1092 | Limit local |
dc504afd | 1093 | .Li ``ssh -L'' |
b2ae83b8 | 1094 | port forwarding such that it may only connect to the specified host and |
ed787d14 | 1095 | port. |
1096 | IPv6 addresses can be specified with an alternative syntax: | |
1097 | .Ar host/port . | |
1098 | Multiple | |
dc504afd | 1099 | .Cm permitopen |
3730bb22 | 1100 | options may be applied separated by commas. No pattern matching is |
1101 | performed on the specified hostnames, they must be literal domains or | |
dc504afd | 1102 | addresses. |
bf740959 | 1103 | .El |
1104 | .Ss Examples | |
1105 | 1024 33 12121.\|.\|.\|312314325 ylo@foo.bar | |
1106 | .Pp | |
1107 | from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23.\|.\|.\|2334 ylo@niksula | |
1108 | .Pp | |
1109 | command="dump /home",no-pty,no-port-forwarding 1024 33 23.\|.\|.\|2323 backup.hut.fi | |
dc504afd | 1110 | .Pp |
1111 | permitopen="10.2.1.55:80",permitopen="10.2.1.56:25" 1024 33 23.\|.\|.\|2323 | |
bf740959 | 1112 | .Sh SSH_KNOWN_HOSTS FILE FORMAT |
f54651ce | 1113 | The |
2a8a6488 | 1114 | .Pa /etc/ssh/ssh_known_hosts , |
f54651ce | 1115 | and |
f49bc4f7 | 1116 | .Pa $HOME/.ssh/known_hosts |
4fe2af09 | 1117 | files contain host public keys for all known hosts. |
1118 | The global file should | |
1119 | be prepared by the administrator (optional), and the per-user file is | |
c345cf9d | 1120 | maintained automatically: whenever the user connects from an unknown host |
4fe2af09 | 1121 | its key is added to the per-user file. |
bf740959 | 1122 | .Pp |
1123 | Each line in these files contains the following fields: hostnames, | |
4fe2af09 | 1124 | bits, exponent, modulus, comment. |
1125 | The fields are separated by spaces. | |
bf740959 | 1126 | .Pp |
1127 | Hostnames is a comma-separated list of patterns ('*' and '?' act as | |
1128 | wildcards); each pattern in turn is matched against the canonical host | |
1129 | name (when authenticating a client) or against the user-supplied | |
4fe2af09 | 1130 | name (when authenticating a server). |
1131 | A pattern may also be preceded by | |
bf740959 | 1132 | .Ql ! |
1133 | to indicate negation: if the host name matches a negated | |
1134 | pattern, it is not accepted (by that line) even if it matched another | |
1135 | pattern on the line. | |
1136 | .Pp | |
1d1ffb87 | 1137 | Bits, exponent, and modulus are taken directly from the RSA host key; they |
bf740959 | 1138 | can be obtained, e.g., from |
2a8a6488 | 1139 | .Pa /etc/ssh/ssh_host_key.pub . |
bf740959 | 1140 | The optional comment field continues to the end of the line, and is not used. |
1141 | .Pp | |
1142 | Lines starting with | |
1143 | .Ql # | |
1144 | and empty lines are ignored as comments. | |
1145 | .Pp | |
1146 | When performing host authentication, authentication is accepted if any | |
4fe2af09 | 1147 | matching line has the proper key. |
1148 | It is thus permissible (but not | |
bf740959 | 1149 | recommended) to have several lines or different host keys for the same |
4fe2af09 | 1150 | names. |
1151 | This will inevitably happen when short forms of host names | |
1152 | from different domains are put in the file. | |
1153 | It is possible | |
bf740959 | 1154 | that the files contain conflicting information; authentication is |
1155 | accepted if valid information can be found from either file. | |
1156 | .Pp | |
1157 | Note that the lines in these files are typically hundreds of characters | |
1158 | long, and you definitely don't want to type in the host keys by hand. | |
1159 | Rather, generate them by a script | |
f54651ce | 1160 | or by taking |
2a8a6488 | 1161 | .Pa /etc/ssh/ssh_host_key.pub |
bf740959 | 1162 | and adding the host names at the front. |
1163 | .Ss Examples | |
da89cf4d | 1164 | .Bd -literal |
1165 | closenet,.\|.\|.\|,130.233.208.41 1024 37 159.\|.\|.93 closenet.hut.fi | |
1166 | cvs.openbsd.org,199.185.137.3 ssh-rsa AAAA1234.....= | |
1167 | .Ed | |
bf740959 | 1168 | .Sh FILES |
1169 | .Bl -tag -width Ds | |
2a8a6488 | 1170 | .It Pa /etc/ssh/sshd_config |
bf740959 | 1171 | Contains configuration data for |
1172 | .Nm sshd . | |
1173 | This file should be writable by root only, but it is recommended | |
1174 | (though not necessary) that it be world-readable. | |
2a8a6488 | 1175 | .It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key |
da89cf4d | 1176 | These three files contain the private parts of the host keys. |
b8dc87d3 | 1177 | These files should only be owned by root, readable only by root, and not |
bf740959 | 1178 | accessible to others. |
1179 | Note that | |
1180 | .Nm | |
1181 | does not start if this file is group/world-accessible. | |
2a8a6488 | 1182 | .It Pa /etc/ssh/ssh_host_key.pub, /etc/ssh/ssh_host_dsa_key.pub, /etc/ssh/ssh_host_rsa_key.pub |
da89cf4d | 1183 | These three files contain the public parts of the host keys. |
b8dc87d3 | 1184 | These files should be world-readable but writable only by |
4fe2af09 | 1185 | root. |
b8dc87d3 | 1186 | Their contents should match the respective private parts. |
1187 | These files are not | |
1188 | really used for anything; they are provided for the convenience of | |
1189 | the user so their contents can be copied to known hosts files. | |
1190 | These files are created using | |
bf740959 | 1191 | .Xr ssh-keygen 1 . |
e2432638 | 1192 | .It Pa /etc/moduli |
c523303b | 1193 | Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange". |
5f4fdfae | 1194 | .It Pa /var/run/sshd.pid |
bf740959 | 1195 | Contains the process ID of the |
1196 | .Nm | |
1197 | listening for connections (if there are several daemons running | |
1198 | concurrently for different ports, this contains the pid of the one | |
4fe2af09 | 1199 | started last). |
c345cf9d | 1200 | The content of this file is not sensitive; it can be world-readable. |
bf740959 | 1201 | .It Pa $HOME/.ssh/authorized_keys |
da89cf4d | 1202 | Lists the public keys (RSA or DSA) that can be used to log into the user's account. |
1d1ffb87 | 1203 | This file must be readable by root (which may on some machines imply |
1204 | it being world-readable if the user's home directory resides on an NFS | |
1205 | volume). | |
1206 | It is recommended that it not be accessible by others. | |
1207 | The format of this file is described above. | |
1208 | Users will place the contents of their | |
96a7b0cc | 1209 | .Pa identity.pub , |
1d1ffb87 | 1210 | .Pa id_dsa.pub |
c0ecc314 | 1211 | and/or |
1212 | .Pa id_rsa.pub | |
1d1ffb87 | 1213 | files into this file, as described in |
1214 | .Xr ssh-keygen 1 . | |
2a8a6488 | 1215 | .It Pa "/etc/ssh/ssh_known_hosts" and "$HOME/.ssh/known_hosts" |
6a17f9c2 | 1216 | These files are consulted when using rhosts with RSA host |
f49bc4f7 | 1217 | authentication or protocol version 2 hostbased authentication |
1218 | to check the public key of the host. | |
4fe2af09 | 1219 | The key must be listed in one of these files to be accepted. |
5bbb5681 | 1220 | The client uses the same files |
e91c60f2 | 1221 | to verify that it is connecting to the correct remote host. |
4fe2af09 | 1222 | These files should be writable only by root/the owner. |
2a8a6488 | 1223 | .Pa /etc/ssh/ssh_known_hosts |
bf740959 | 1224 | should be world-readable, and |
1225 | .Pa $HOME/.ssh/known_hosts | |
1226 | can but need not be world-readable. | |
1227 | .It Pa /etc/nologin | |
f54651ce | 1228 | If this file exists, |
bf740959 | 1229 | .Nm |
4fe2af09 | 1230 | refuses to let anyone except root log in. |
1231 | The contents of the file | |
bf740959 | 1232 | are displayed to anyone trying to log in, and non-root connections are |
4fe2af09 | 1233 | refused. |
1234 | The file should be world-readable. | |
bf740959 | 1235 | .It Pa /etc/hosts.allow, /etc/hosts.deny |
5b263aae | 1236 | Access controls that should be enforced by tcp-wrappers are defined here. |
1237 | Further details are described in | |
bf740959 | 1238 | .Xr hosts_access 5 . |
1239 | .It Pa $HOME/.rhosts | |
1240 | This file contains host-username pairs, separated by a space, one per | |
4fe2af09 | 1241 | line. |
1242 | The given user on the corresponding host is permitted to log in | |
1243 | without password. | |
1244 | The same file is used by rlogind and rshd. | |
bf740959 | 1245 | The file must |
1246 | be writable only by the user; it is recommended that it not be | |
1247 | accessible by others. | |
1248 | .Pp | |
4fe2af09 | 1249 | If is also possible to use netgroups in the file. |
1250 | Either host or user | |
bf740959 | 1251 | name may be of the form +@groupname to specify all hosts or all users |
1252 | in the group. | |
1253 | .It Pa $HOME/.shosts | |
1254 | For ssh, | |
1255 | this file is exactly the same as for | |
1256 | .Pa .rhosts . | |
1257 | However, this file is | |
1258 | not used by rlogin and rshd, so using this permits access using SSH only. | |
c345cf9d | 1259 | .It Pa /etc/hosts.equiv |
bf740959 | 1260 | This file is used during |
1261 | .Pa .rhosts | |
4fe2af09 | 1262 | authentication. |
1263 | In the simplest form, this file contains host names, one per line. | |
1264 | Users on | |
bf740959 | 1265 | those hosts are permitted to log in without a password, provided they |
4fe2af09 | 1266 | have the same user name on both machines. |
1267 | The host name may also be | |
bf740959 | 1268 | followed by a user name; such users are permitted to log in as |
1269 | .Em any | |
4fe2af09 | 1270 | user on this machine (except root). |
1271 | Additionally, the syntax | |
bf740959 | 1272 | .Dq +@group |
4fe2af09 | 1273 | can be used to specify netgroups. |
1274 | Negated entries start with | |
bf740959 | 1275 | .Ql \&- . |
1276 | .Pp | |
1277 | If the client host/user is successfully matched in this file, login is | |
1278 | automatically permitted provided the client and server user names are the | |
4fe2af09 | 1279 | same. |
1280 | Additionally, successful RSA host authentication is normally required. | |
1281 | This file must be writable only by root; it is recommended | |
bf740959 | 1282 | that it be world-readable. |
1283 | .Pp | |
1284 | .Sy "Warning: It is almost never a good idea to use user names in" | |
1285 | .Pa hosts.equiv . | |
1286 | Beware that it really means that the named user(s) can log in as | |
1287 | .Em anybody , | |
1288 | which includes bin, daemon, adm, and other accounts that own critical | |
4fe2af09 | 1289 | binaries and directories. |
1290 | Using a user name practically grants the user root access. | |
1291 | The only valid use for user names that I can think | |
bf740959 | 1292 | of is in negative entries. |
1293 | .Pp | |
1294 | Note that this warning also applies to rsh/rlogin. | |
5f4fdfae | 1295 | .It Pa /etc/shosts.equiv |
bf740959 | 1296 | This is processed exactly as |
1297 | .Pa /etc/hosts.equiv . | |
1298 | However, this file may be useful in environments that want to run both | |
1299 | rsh/rlogin and ssh. | |
1300 | .It Pa $HOME/.ssh/environment | |
4fe2af09 | 1301 | This file is read into the environment at login (if it exists). |
1302 | It can only contain empty lines, comment lines (that start with | |
bf740959 | 1303 | .Ql # ) , |
4fe2af09 | 1304 | and assignment lines of the form name=value. |
1305 | The file should be writable | |
bf740959 | 1306 | only by the user; it need not be readable by anyone else. |
1307 | .It Pa $HOME/.ssh/rc | |
1308 | If this file exists, it is run with /bin/sh after reading the | |
4fe2af09 | 1309 | environment files but before starting the user's shell or command. |
1310 | If X11 spoofing is in use, this will receive the "proto cookie" pair in | |
bf740959 | 1311 | standard input (and |
1312 | .Ev DISPLAY | |
4fe2af09 | 1313 | in environment). |
1314 | This must call | |
bf740959 | 1315 | .Xr xauth 1 |
1316 | in that case. | |
1317 | .Pp | |
1318 | The primary purpose of this file is to run any initialization routines | |
1319 | which may be needed before the user's home directory becomes | |
1320 | accessible; AFS is a particular example of such an environment. | |
1321 | .Pp | |
1322 | This file will probably contain some initialization code followed by | |
da89cf4d | 1323 | something similar to: |
1324 | .Bd -literal | |
1325 | if read proto cookie; then | |
1326 | echo add $DISPLAY $proto $cookie | xauth -q - | |
1327 | fi | |
1328 | .Ed | |
bf740959 | 1329 | .Pp |
1330 | If this file does not exist, | |
2a8a6488 | 1331 | .Pa /etc/ssh/sshrc |
bf740959 | 1332 | is run, and if that |
1333 | does not exist either, xauth is used to store the cookie. | |
1334 | .Pp | |
1335 | This file should be writable only by the user, and need not be | |
1336 | readable by anyone else. | |
2a8a6488 | 1337 | .It Pa /etc/ssh/sshrc |
bf740959 | 1338 | Like |
1339 | .Pa $HOME/.ssh/rc . | |
1340 | This can be used to specify | |
4fe2af09 | 1341 | machine-specific login-time initializations globally. |
1342 | This file should be writable only by root, and should be world-readable. | |
089fbbd2 | 1343 | .El |
fa08c86b | 1344 | .Sh AUTHORS |
7f5c4295 | 1345 | OpenSSH is a derivative of the original and free |
1346 | ssh 1.2.12 release by Tatu Ylonen. | |
1347 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, | |
1348 | Theo de Raadt and Dug Song | |
1349 | removed many bugs, re-added newer features and | |
1350 | created OpenSSH. | |
1351 | Markus Friedl contributed the support for SSH | |
1352 | protocol versions 1.5 and 2.0. | |
bf740959 | 1353 | .Sh SEE ALSO |
bf740959 | 1354 | .Xr scp 1 , |
61e96248 | 1355 | .Xr sftp 1 , |
bf740959 | 1356 | .Xr ssh 1 , |
1357 | .Xr ssh-add 1 , | |
1358 | .Xr ssh-agent 1 , | |
1359 | .Xr ssh-keygen 1 , | |
248bad82 | 1360 | .Xr login.conf 5 , |
1361 | .Xr moduli 5 , | |
a5a2da3b | 1362 | .Xr sftp-server 8 |
2cad6cef | 1363 | .Rs |
1364 | .%A T. Ylonen | |
1365 | .%A T. Kivinen | |
1366 | .%A M. Saarinen | |
1367 | .%A T. Rinne | |
1368 | .%A S. Lehtinen | |
1369 | .%T "SSH Protocol Architecture" | |
1930af48 | 1370 | .%N draft-ietf-secsh-architecture-09.txt |
1371 | .%D July 2001 | |
2cad6cef | 1372 | .%O work in progress material |
1373 | .Re | |
da89cf4d | 1374 | .Rs |
1375 | .%A M. Friedl | |
1376 | .%A N. Provos | |
1377 | .%A W. A. Simpson | |
1378 | .%T "Diffie-Hellman Group Exchange for the SSH Transport Layer Protocol" | |
7d747e89 | 1379 | .%N draft-ietf-secsh-dh-group-exchange-01.txt |
1380 | .%D April 2001 | |
da89cf4d | 1381 | .%O work in progress material |
1382 | .Re |