← Back to branch summary

~ubuntu-branches/ubuntu/lucid/openssh/lucid

« back to all changes in this revision

Viewing changes to ssh_config.5

  • Committer: Bazaar Package Importer
  • Author(s): Colin Watson
  • Date: 2008-09-30 23:09:58 UTC
  • mfrom: (1.13.3 upstream) (29 hardy)
  • mto: This revision was merged to the branch mainline in revision 43.
  • Revision ID: james.westby@ubuntu.com-20080930230958-o6vsgn8c4mm959s0
Tags: 1:5.1p1-3
http://bugs.debian.org/496495
http://bugs.debian.org/498681
* Remove unnecessary ssh-vulnkey output in non-verbose mode when no
  compromised or unknown keys were found (closes: #496495).
* Configure with --disable-strip; dh_strip will deal with stripping
  binaries and will honour DEB_BUILD_OPTIONS (thanks, Bernhard R. Link;
  closes: #498681).
* Fix handling of zero-length server banners (thanks, Tomas Mraz; closes:
  #497026).

Show diffs side-by-side

added added

removed removed

Lines of Context:
ssh_config.5
34
34
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35
35
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36
36
.\"
37
 
.\" $OpenBSD: ssh_config.5,v 1.98 2007/01/10 13:23:22 jmc Exp $
38
 
.Dd September 25, 1999
 
37
.\" $OpenBSD: ssh_config.5,v 1.111 2008/06/26 11:46:31 grunk Exp $
 
38
.Dd $Mdocdate: June 26 2008 $
39
39
.Dt SSH_CONFIG 5
40
40
.Os
41
41
.Sh NAME
72
72
host-specific declarations should be given near the beginning of the
73
73
file, and general defaults at the end.
74
74
.Pp
 
75
Note that the Debian
 
76
.Ic openssh-client
 
77
package sets several options as standard in
 
78
.Pa /etc/ssh/ssh_config
 
79
which are not the default in
 
80
.Xr ssh 1 :
 
81
.Pp
 
82
.Bl -bullet -offset indent -compact
 
83
.It
 
84
.Cm SendEnv No LANG LC_*
 
85
.It
 
86
.Cm HashKnownHosts No yes
 
87
.It
 
88
.Cm GSSAPIAuthentication No yes
 
89
.El
 
90
.Pp
75
91
The configuration file has the following format:
76
92
.Pp
77
93
Empty lines and lines starting with
103
119
.Cm Host
104
120
keyword) to be only for those hosts that match one of the patterns
105
121
given after the keyword.
 
122
If more than one pattern is provided, they should be separated by whitepsace.
106
123
A single
107
124
.Ql *
108
125
as a pattern can be used to provide global
129
146
passphrase/password querying will be disabled.
130
147
In addition, the 
131
148
.Cm ServerAliveInterval 
132
 
and
133
 
.Cm SetupTimeOut
134
 
options will both be set to 300 seconds by default.
 
149
option will be set to 300 seconds by default.
135
150
This option is useful in scripts and other batch jobs where no user
136
151
is present to supply the password,
137
152
and where it is desirable to detect a broken network swiftly.
393
408
Specifies whether
394
409
.Xr ssh 1
395
410
should terminate the connection if it cannot set up all requested
396
 
dynamic, local, and remote port forwardings.
 
411
dynamic, tunnel, local, and remote port forwardings.
397
412
The argument must be
398
413
.Dq yes
399
414
or
603
618
It is possible to have
604
619
multiple identity files specified in configuration files; all these
605
620
identities will be tried in sequence.
 
621
.It Cm KbdInteractiveAuthentication
 
622
Specifies whether to use keyboard-interactive authentication.
 
623
The argument to this keyword must be
 
624
.Dq yes
 
625
or
 
626
.Dq no .
 
627
The default is
 
628
.Dq yes .
606
629
.It Cm KbdInteractiveDevices
607
630
Specifies the list of methods to use in keyboard-interactive authentication.
608
631
Multiple method names must be comma-separated.
618
641
Specifies a command to execute on the local machine after successfully
619
642
connecting to the server.
620
643
The command string extends to the end of the line, and is executed with
621
 
.Pa /bin/sh .
 
644
the user's shell.
 
645
The following escape character substitutions will be performed:
 
646
.Ql %d
 
647
(local user's home directory),
 
648
.Ql %h
 
649
(remote host name),
 
650
.Ql %l
 
651
(local host name),
 
652
.Ql %n
 
653
(host name as provided on the command line),
 
654
.Ql %p
 
655
(remote port),
 
656
.Ql %r
 
657
(remote user name) or
 
658
.Ql %u
 
659
(local user name).
622
660
This directive is ignored unless
623
661
.Cm PermitLocalCommand
624
662
has been enabled.
668
706
for data integrity protection.
669
707
Multiple algorithms must be comma-separated.
670
708
The default is:
671
 
.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
 
709
.Bd -literal -offset indent
 
710
hmac-md5,hmac-sha1,umac-64@openssh.com,
 
711
hmac-ripemd160,hmac-sha1-96,hmac-md5-96
 
712
.Ed
672
713
.It Cm NoHostAuthenticationForLocalhost
673
714
This option can be used if the home directory is shared across machines.
674
715
In this case localhost will refer to a different machine on each of
739
780
Specifies the command to use to connect to the server.
740
781
The command
741
782
string extends to the end of the line, and is executed with
742
 
.Pa /bin/sh .
 
783
the user's shell.
743
784
In the command string,
744
785
.Ql %h
745
786
will be substituted by the host name to
917
958
option is set.
918
959
This option applies to protocol version 2 only.
919
960
.Cm ProtocolKeepAlives
920
 
is a Debian-specific compatibility alias for this option.
921
 
.It Cm SetupTimeOut
922
 
Normally,
923
 
.Nm ssh
924
 
blocks indefinitely whilst waiting to receive the ssh banner and other
925
 
setup protocol from the server, during the session setup.
926
 
This can cause
927
 
.Nm ssh
928
 
to hang under certain circumstances.
929
 
If this option is set,
930
 
.Nm ssh
931
 
will give up if no data from the server is received for the specified
932
 
number of seconds.
933
 
The argument must be an integer.
934
 
The default is 0 (disabled), or 300 if
935
 
.Cm BatchMode
936
 
is set.
937
 
This is a Debian-specific option.
 
961
and
 
962
.Cm SetupTimeOut
 
963
are Debian-specific compatibility aliases for this option.
938
964
.It Cm SmartcardDevice
939
965
Specifies which smartcard device to use.
940
966
The argument to this keyword is the device
1037
1063
.Dq any .
1038
1064
The default is
1039
1065
.Dq any:any .
 
1066
.It Cm UseBlacklistedKeys
 
1067
Specifies whether
 
1068
.Xr ssh 1
 
1069
should use keys recorded in its blacklist of known-compromised keys (see
 
1070
.Xr ssh-vulnkey 1 )
 
1071
for authentication.
 
1072
If
 
1073
.Dq yes ,
 
1074
then attempts to use compromised keys for authentication will be logged but
 
1075
accepted.
 
1076
It is strongly recommended that this be used only to install new authorized
 
1077
keys on the remote system, and even then only with the utmost care.
 
1078
If
 
1079
.Dq no ,
 
1080
then attempts to use compromised keys for authentication will be prevented.
 
1081
The default is
 
1082
.Dq no .
1040
1083
.It Cm UsePrivilegedPort
1041
1084
Specifies whether to use a privileged port for outgoing connections.
1042
1085
The argument must be
1091
1134
.Sx VERIFYING HOST KEYS
1092
1135
in
1093
1136
.Xr ssh 1 .
 
1137
.It Cm VisualHostKey
 
1138
If this flag is set to
 
1139
.Dq yes ,
 
1140
an ASCII art representation of the remote host key fingerprint is
 
1141
printed additionally to the hex fingerprint string.
 
1142
If this flag is set to
 
1143
.Dq no ,
 
1144
only the hex fingerprint string will be printed.
 
1145
The default is
 
1146
.Dq no .
1094
1147
.It Cm XAuthLocation
1095
1148
Specifies the full pathname of the
1096
1149
.Xr xauth 1