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