summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.5121
1 files changed, 65 insertions, 56 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index 44208b431..7a435a90e 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.7 2003/03/28 10:11:43 jmc Exp $ 37.\" $OpenBSD: ssh_config.5,v 1.20 2003/09/02 18:50:06 jmc 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
@@ -104,7 +104,7 @@ keyword) to be only for those hosts that match one of the patterns
104given after the keyword. 104given after the keyword.
105.Ql \&* 105.Ql \&*
106and 106and
107.Ql ? 107.Ql \&?
108can be used as wildcards in the 108can be used as wildcards in the
109patterns. 109patterns.
110A single 110A single
@@ -115,13 +115,14 @@ The host is the
115.Ar hostname 115.Ar hostname
116argument given on the command line (i.e., the name is not converted to 116argument given on the command line (i.e., the name is not converted to
117a canonicalized host name before matching). 117a canonicalized host name before matching).
118.It Cm AFSTokenPassing 118.It Cm AddressFamily
119Specifies whether to pass AFS tokens to remote host. 119Specifies which address family to use when connecting.
120The argument to this keyword must be 120Valid arguments are
121.Dq yes 121.Dq any ,
122or 122.Dq inet
123.Dq no . 123(Use IPv4 only) or
124This option applies to protocol version 1 only. 124.Dq inet6
125(Use IPv6 only.)
125.It Cm BatchMode 126.It Cm BatchMode
126If set to 127If set to
127.Dq yes , 128.Dq yes ,
@@ -227,18 +228,41 @@ Specifies the number of tries (one per second) to make before exiting.
227The argument must be an integer. 228The argument must be an integer.
228This may be useful in scripts if the connection sometimes fails. 229This may be useful in scripts if the connection sometimes fails.
229The default is 1. 230The default is 1.
231.It Cm ConnectTimeout
232Specifies the timeout (in seconds) used when connecting to the ssh
233server, instead of using the default system TCP timeout.
234This value is used only when the target is down or really unreachable,
235not when it refuses the connection.
230.It Cm DynamicForward 236.It Cm DynamicForward
231Specifies that a TCP/IP port on the local machine be forwarded 237Specifies that a TCP/IP port on the local machine be forwarded
232over the secure channel, and the application 238over the secure channel, and the application
233protocol is then used to determine where to connect to from the 239protocol is then used to determine where to connect to from the
234remote machine. 240remote machine.
235The argument must be a port number. 241The argument must be a port number.
236Currently the SOCKS4 protocol is supported, and 242Currently the SOCKS4 and SOCKS5 protocols are supported, and
237.Nm ssh 243.Nm ssh
238will act as a SOCKS4 server. 244will act as a SOCKS server.
239Multiple forwardings may be specified, and 245Multiple forwardings may be specified, and
240additional forwardings can be given on the command line. 246additional forwardings can be given on the command line.
241Only the superuser can forward privileged ports. 247Only the superuser can forward privileged ports.
248.It Cm EnableSSHKeysign
249Setting this option to
250.Dq yes
251in the global client configuration file
252.Pa /etc/ssh/ssh_config
253enables the use of the helper program
254.Xr ssh-keysign 8
255during
256.Cm HostbasedAuthentication .
257The argument must be
258.Dq yes
259or
260.Dq no .
261The default is
262.Dq no .
263See
264.Xr ssh-keysign 8
265for more information.
242.It Cm EscapeChar 266.It Cm EscapeChar
243Sets the escape character (default: 267Sets the escape character (default:
244.Ql ~ ) . 268.Ql ~ ) .
@@ -307,6 +331,18 @@ The default is
307Specifies a file to use for the global 331Specifies a file to use for the global
308host key database instead of 332host key database instead of
309.Pa /etc/ssh/ssh_known_hosts . 333.Pa /etc/ssh/ssh_known_hosts .
334.It Cm GSSAPIAuthentication
335Specifies whether authentication based on GSSAPI may be used, either using
336the result of a successful key exchange, or using GSSAPI user
337authentication.
338The default is
339.Dq yes .
340Note that this option applies to protocol version 2 only.
341.It Cm GSSAPIDelegateCredentials
342Forward (delegate) credentials to the server.
343The default is
344.Dq no .
345Note that this option applies to protocol version 2 only.
310.It Cm HostbasedAuthentication 346.It Cm HostbasedAuthentication
311Specifies whether to try rhosts based authentication with public key 347Specifies whether to try rhosts based authentication with public key
312authentication. 348authentication.
@@ -339,7 +375,8 @@ Numeric IP addresses are also permitted (both on the command line and in
339specifications). 375specifications).
340.It Cm IdentityFile 376.It Cm IdentityFile
341Specifies a file from which the user's RSA or DSA authentication identity 377Specifies a file from which the user's RSA or DSA authentication identity
342is read. The default is 378is read.
379The default is
343.Pa $HOME/.ssh/identity 380.Pa $HOME/.ssh/identity
344for protocol version 1, and 381for protocol version 1, and
345.Pa $HOME/.ssh/id_rsa 382.Pa $HOME/.ssh/id_rsa
@@ -370,19 +407,6 @@ This is important in scripts, and many users want it too.
370.Pp 407.Pp
371To disable keepalives, the value should be set to 408To disable keepalives, the value should be set to
372.Dq no . 409.Dq no .
373.It Cm KerberosAuthentication
374Specifies whether Kerberos authentication will be used.
375The argument to this keyword must be
376.Dq yes
377or
378.Dq no .
379.It Cm KerberosTgtPassing
380Specifies whether a Kerberos TGT will be forwarded to the server.
381This will only work if the Kerberos server is actually an AFS kaserver.
382The argument to this keyword must be
383.Dq yes
384or
385.Dq no .
386.It Cm LocalForward 410.It Cm LocalForward
387Specifies that a TCP/IP port on the local machine be forwarded over 411Specifies that a TCP/IP port on the local machine be forwarded over
388the secure channel to the specified host and port from the remote machine. 412the secure channel to the specified host and port from the remote machine.
@@ -436,7 +460,8 @@ Specifies the port number to connect on the remote host.
436Default is 22. 460Default is 22.
437.It Cm PreferredAuthentications 461.It Cm PreferredAuthentications
438Specifies the order in which the client should try protocol 2 462Specifies the order in which the client should try protocol 2
439authentication methods. This allows a client to prefer one method (e.g. 463authentication methods.
464This allows a client to prefer one method (e.g.
440.Cm keyboard-interactive ) 465.Cm keyboard-interactive )
441over another method (e.g. 466over another method (e.g.
442.Cm password ) 467.Cm password )
@@ -504,26 +529,6 @@ IPv6 addresses can be specified with an alternative syntax:
504Multiple forwardings may be specified, and additional 529Multiple forwardings may be specified, and additional
505forwardings can be given on the command line. 530forwardings can be given on the command line.
506Only the superuser can forward privileged ports. 531Only the superuser can forward privileged ports.
507.It Cm RhostsAuthentication
508Specifies whether to try rhosts based authentication.
509Note that this
510declaration only affects the client side and has no effect whatsoever
511on security.
512Most servers do not permit RhostsAuthentication because it
513is not secure (see
514.Cm RhostsRSAAuthentication ) .
515The argument to this keyword must be
516.Dq yes
517or
518.Dq no .
519The default is
520.Dq no .
521This option applies to protocol version 1 only and requires
522.Nm ssh
523to be setuid root and
524.Cm UsePrivilegedPort
525to be set to
526.Dq yes .
527.It Cm RhostsRSAAuthentication 532.It Cm RhostsRSAAuthentication
528Specifies whether to try rhosts based authentication with RSA host 533Specifies whether to try rhosts based authentication with RSA host
529authentication. 534authentication.
@@ -549,12 +554,12 @@ The default is
549.Dq yes . 554.Dq yes .
550Note that this option applies to protocol version 1 only. 555Note that this option applies to protocol version 1 only.
551.It Cm SmartcardDevice 556.It Cm SmartcardDevice
552Specifies which smartcard device to use. The argument to this keyword is 557Specifies which smartcard device to use.
553the device 558The argument to this keyword is the device
554.Nm ssh 559.Nm ssh
555should use to communicate with a smartcard used for storing the user's 560should use to communicate with a smartcard used for storing the user's
556private RSA key. By default, no device is specified and smartcard support 561private RSA key.
557is not activated. 562By default, no device is specified and smartcard support is not activated.
558.It Cm StrictHostKeyChecking 563.It Cm StrictHostKeyChecking
559If this flag is set to 564If this flag is set to
560.Dq yes , 565.Dq yes ,
@@ -604,11 +609,9 @@ If set to
604must be setuid root. 609must be setuid root.
605Note that this option must be set to 610Note that this option must be set to
606.Dq yes 611.Dq yes
607if 612for
608.Cm RhostsAuthentication
609and
610.Cm RhostsRSAAuthentication 613.Cm RhostsRSAAuthentication
611authentications are needed with older servers. 614with older servers.
612.It Cm User 615.It Cm User
613Specifies the user to log in as. 616Specifies the user to log in as.
614This can be useful when a different user name is used on different machines. 617This can be useful when a different user name is used on different machines.
@@ -618,6 +621,12 @@ having to remember to give the user name on the command line.
618Specifies a file to use for the user 621Specifies a file to use for the user
619host key database instead of 622host key database instead of
620.Pa $HOME/.ssh/known_hosts . 623.Pa $HOME/.ssh/known_hosts .
624.It Cm VerifyHostKeyDNS
625Specifies whether to verify the remote key using DNS and SSHFP resource
626records.
627The default is
628.Dq no .
629Note that this option applies to protocol version 2 only.
621.It Cm XAuthLocation 630.It Cm XAuthLocation
622Specifies the full pathname of the 631Specifies the full pathname of the
623.Xr xauth 1 632.Xr xauth 1
@@ -643,6 +652,8 @@ values that are not specified in the user's configuration file, and
643for those users who do not have a configuration file. 652for those users who do not have a configuration file.
644This file must be world-readable. 653This file must be world-readable.
645.El 654.El
655.Sh SEE ALSO
656.Xr ssh 1
646.Sh AUTHORS 657.Sh AUTHORS
647OpenSSH is a derivative of the original and free 658OpenSSH is a derivative of the original and free
648ssh 1.2.12 release by Tatu Ylonen. 659ssh 1.2.12 release by Tatu Ylonen.
@@ -652,5 +663,3 @@ removed many bugs, re-added newer features and
652created OpenSSH. 663created OpenSSH.
653Markus Friedl contributed the support for SSH 664Markus Friedl contributed the support for SSH
654protocol versions 1.5 and 2.0. 665protocol versions 1.5 and 2.0.
655.Sh SEE ALSO
656.Xr ssh 1