summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
authorColin Watson <cjwatson@debian.org>2004-03-01 02:25:32 +0000
committerColin Watson <cjwatson@debian.org>2004-03-01 02:25:32 +0000
commitea8116a11e3de70036dbc665ccb0d486cf89cac9 (patch)
treed73ccdff78d8608e156465af42e6a1b3527fb2d6 /ssh_config.5
parente39b311381a5609cc05acf298c42fba196dc524b (diff)
parentf5bda272678ec6dccaa5f29379cf60cb855018e8 (diff)
Merge 3.8p1 to the trunk. This builds and runs, but I haven't tested it
extensively yet. ProtocolKeepAlives is now just a compatibility alias for ServerAliveInterval.
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.5144
1 files changed, 104 insertions, 40 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index 2ca7ce02f..25485f3da 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -34,7 +34,7 @@
34.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 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. 35.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36.\" 36.\"
37.\" $OpenBSD: ssh_config.5,v 1.20 2003/09/02 18:50:06 jmc Exp $ 37.\" $OpenBSD: ssh_config.5,v 1.28 2003/12/16 15:49:51 markus Exp $
38.Dd September 25, 1999 38.Dd September 25, 1999
39.Dt SSH_CONFIG 5 39.Dt SSH_CONFIG 5
40.Os 40.Os
@@ -128,7 +128,7 @@ If set to
128.Dq yes , 128.Dq yes ,
129passphrase/password querying will be disabled. 129passphrase/password querying will be disabled.
130In addition, the 130In addition, the
131.Cm ProtocolKeepAlives 131.Cm ServerAliveInterval
132and 132and
133.Cm SetupTimeOut 133.Cm SetupTimeOut
134options will both be set to 300 seconds by default. 134options will both be set to 300 seconds by default.
@@ -193,7 +193,6 @@ Specifies the ciphers allowed for protocol version 2
193in order of preference. 193in order of preference.
194Multiple ciphers must be comma-separated. 194Multiple ciphers must be comma-separated.
195The default is 195The default is
196.Pp
197.Bd -literal 196.Bd -literal
198 ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour, 197 ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
199 aes192-cbc,aes256-cbc'' 198 aes192-cbc,aes256-cbc''
@@ -267,6 +266,7 @@ or
267.Dq no . 266.Dq no .
268The default is 267The default is
269.Dq no . 268.Dq no .
269This option should be placed in the non-hostspecific section.
270See 270See
271.Xr ssh-keysign 8 271.Xr ssh-keysign 8
272for more information. 272for more information.
@@ -313,9 +313,27 @@ The default is
313.Pp 313.Pp
314X11 forwarding should be enabled with caution. 314X11 forwarding should be enabled with caution.
315Users with the ability to bypass file permissions on the remote host 315Users with the ability to bypass file permissions on the remote host
316(for the user's X authorization database) 316(for the user's X11 authorization database)
317can access the local X11 display through the forwarded connection. 317can access the local X11 display through the forwarded connection.
318An attacker may then be able to perform activities such as keystroke monitoring. 318An attacker may then be able to perform activities such as keystroke monitoring
319if the
320.Cm ForwardX11Trusted
321option is also enabled.
322.It Cm ForwardX11Trusted
323If the this option is set to
324.Dq yes
325then remote X11 clients will have full access to the original X11 display.
326If this option is set to
327.Dq no
328then remote X11 clients will be considered untrusted and prevented
329from stealing or tampering with data belonging to trusted X11
330clients.
331.Pp
332The default is
333.Dq no .
334.Pp
335See the X11 SECURITY extension specification for full details on
336the restrictions imposed on untrusted clients.
319.It Cm GatewayPorts 337.It Cm GatewayPorts
320Specifies whether remote hosts are allowed to connect to local 338Specifies whether remote hosts are allowed to connect to local
321forwarded ports. 339forwarded ports.
@@ -339,11 +357,9 @@ Specifies a file to use for the global
339host key database instead of 357host key database instead of
340.Pa /etc/ssh/ssh_known_hosts . 358.Pa /etc/ssh/ssh_known_hosts .
341.It Cm GSSAPIAuthentication 359.It Cm GSSAPIAuthentication
342Specifies whether authentication based on GSSAPI may be used, either using 360Specifies whether user authentication based on GSSAPI is allowed.
343the result of a successful key exchange, or using GSSAPI user
344authentication.
345The default is 361The default is
346.Dq yes . 362.Dq no .
347Note that this option applies to protocol version 2 only. 363Note that this option applies to protocol version 2 only.
348.It Cm GSSAPIDelegateCredentials 364.It Cm GSSAPIDelegateCredentials
349Forward (delegate) credentials to the server. 365Forward (delegate) credentials to the server.
@@ -397,29 +413,6 @@ syntax to refer to a user's home directory.
397It is possible to have 413It is possible to have
398multiple identity files specified in configuration files; all these 414multiple identity files specified in configuration files; all these
399identities will be tried in sequence. 415identities will be tried in sequence.
400.It Cm KeepAlive
401Specifies whether the system should send TCP keepalive messages to the
402other side.
403If they are sent, death of the connection or crash of one
404of the machines will be properly noticed.
405This option only uses TCP keepalives (as opposed to using ssh level
406keepalives), so takes a long time to notice when the connection dies.
407As such, you probably want
408the
409.Cm ProtocolKeepAlives
410option as well.
411However, this means that
412connections will die if the route is down temporarily, and some people
413find it annoying.
414.Pp
415The default is
416.Dq yes
417(to send keepalives), and the client will notice
418if the network goes down or the remote host dies.
419This is important in scripts, and many users want it too.
420.Pp
421To disable keepalives, the value should be set to
422.Dq no .
423.It Cm LocalForward 416.It Cm LocalForward
424Specifies that a TCP/IP port on the local machine be forwarded over 417Specifies that a TCP/IP port on the local machine be forwarded over
425the secure channel to the specified host and port from the remote machine. 418the secure channel to the specified host and port from the remote machine.
@@ -495,14 +488,6 @@ This means that
495.Nm ssh 488.Nm ssh
496tries version 2 and falls back to version 1 489tries version 2 and falls back to version 1
497if version 2 is not available. 490if version 2 is not available.
498.It Cm ProtocolKeepAlives
499Specifies the interval in seconds at which IGNORE packets will be sent to
500the server during idle periods.
501Use this option in scripts to detect when the network fails.
502The argument must be an integer.
503The default is 0 (disabled), or 300 if the
504.Cm BatchMode
505option is set.
506.It Cm ProxyCommand 491.It Cm ProxyCommand
507Specifies the command to use to connect to the server. 492Specifies the command to use to connect to the server.
508The command 493The command
@@ -574,6 +559,45 @@ running.
574The default is 559The default is
575.Dq yes . 560.Dq yes .
576Note that this option applies to protocol version 1 only. 561Note that this option applies to protocol version 1 only.
562.It Cm ServerAliveInterval
563Sets a timeout interval in seconds after which if no data has been received
564from the server,
565.Nm ssh
566will send a message through the encrypted
567channel to request a response from the server.
568The default
569is 0, indicating that these messages will not be sent to the server,
570or 300 if the
571.Cm BatchMode
572option is set.
573This option applies to protocol version 2 only.
574.It Cm ServerAliveCountMax
575Sets the number of server alive messages (see above) which may be
576sent without
577.Nm ssh
578receiving any messages back from the server.
579If this threshold is reached while server alive messages are being sent,
580.Nm ssh
581will disconnect from the server, terminating the session.
582It is important to note that the use of server alive messages is very
583different from
584.Cm TCPKeepAlive
585(below).
586The server alive messages are sent through the encrypted channel
587and therefore will not be spoofable.
588The TCP keepalive option enabled by
589.Cm TCPKeepAlive
590is spoofable.
591The server alive mechanism is valuable when the client or
592server depend on knowing when a connection has become inactive.
593.Pp
594The default value is 3.
595If, for example,
596.Cm ServerAliveInterval
597(above) is set to 15, and
598.Cm ServerAliveCountMax
599is left at the default, if the server becomes unresponsive ssh
600will disconnect after approximately 45 seconds.
577.It Cm SetupTimeOut 601.It Cm SetupTimeOut
578Normally, 602Normally,
579.Nm ssh 603.Nm ssh
@@ -632,6 +656,29 @@ or
632.Dq ask . 656.Dq ask .
633The default is 657The default is
634.Dq ask . 658.Dq ask .
659.It Cm TCPKeepAlive
660Specifies whether the system should send TCP keepalive messages to the
661other side.
662If they are sent, death of the connection or crash of one
663of the machines will be properly noticed.
664This option only uses TCP keepalives (as opposed to using ssh level
665keepalives), so takes a long time to notice when the connection dies.
666As such, you probably want
667the
668.Cm ServerAliveInterval
669option as well.
670However, this means that
671connections will die if the route is down temporarily, and some people
672find it annoying.
673.Pp
674The default is
675.Dq yes
676(to send TCP keepalive messages), and the client will notice
677if the network goes down or the remote host dies.
678This is important in scripts, and many users want it too.
679.Pp
680To disable TCP keepalive messages, the value should be set to
681.Dq no .
635.It Cm UsePrivilegedPort 682.It Cm UsePrivilegedPort
636Specifies whether to use a privileged port for outgoing connections. 683Specifies whether to use a privileged port for outgoing connections.
637The argument must be 684The argument must be
@@ -661,6 +708,23 @@ host key database instead of
661.It Cm VerifyHostKeyDNS 708.It Cm VerifyHostKeyDNS
662Specifies whether to verify the remote key using DNS and SSHFP resource 709Specifies whether to verify the remote key using DNS and SSHFP resource
663records. 710records.
711If this option is set to
712.Dq yes ,
713the client will implicitly trust keys that match a secure fingerprint
714from DNS.
715Insecure fingerprints will be handled as if this option was set to
716.Dq ask .
717If this option is set to
718.Dq ask ,
719information on fingerprint match will be displayed, but the user will still
720need to confirm new host keys according to the
721.Cm StrictHostKeyChecking
722option.
723The argument must be
724.Dq yes ,
725.Dq no
726or
727.Dq ask .
664The default is 728The default is
665.Dq no . 729.Dq no .
666Note that this option applies to protocol version 2 only. 730Note that this option applies to protocol version 2 only.