summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.549
1 files changed, 37 insertions, 12 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index 4d5b01d3e..412629637 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -33,8 +33,8 @@
33.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 33.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35.\" 35.\"
36.\" $OpenBSD: ssh_config.5,v 1.286 2018/10/03 06:38:35 djm Exp $ 36.\" $OpenBSD: ssh_config.5,v 1.292 2019/03/01 02:16:47 djm Exp $
37.Dd $Mdocdate: October 3 2018 $ 37.Dd $Mdocdate: March 1 2019 $
38.Dt SSH_CONFIG 5 38.Dt SSH_CONFIG 5
39.Os 39.Os
40.Sh NAME 40.Sh NAME
@@ -139,6 +139,7 @@ or the single token
139which always matches. 139which always matches.
140The available criteria keywords are: 140The available criteria keywords are:
141.Cm canonical , 141.Cm canonical ,
142.Cm final ,
142.Cm exec , 143.Cm exec ,
143.Cm host , 144.Cm host ,
144.Cm originalhost , 145.Cm originalhost ,
@@ -148,12 +149,15 @@ and
148The 149The
149.Cm all 150.Cm all
150criteria must appear alone or immediately after 151criteria must appear alone or immediately after
151.Cm canonical . 152.Cm canonical
153or
154.Cm final .
152Other criteria may be combined arbitrarily. 155Other criteria may be combined arbitrarily.
153All criteria but 156All criteria but
154.Cm all 157.Cm all ,
158.Cm canonical ,
155and 159and
156.Cm canonical 160.Cm final
157require an argument. 161require an argument.
158Criteria may be negated by prepending an exclamation mark 162Criteria may be negated by prepending an exclamation mark
159.Pq Sq !\& . 163.Pq Sq !\& .
@@ -163,9 +167,23 @@ The
163keyword matches only when the configuration file is being re-parsed 167keyword matches only when the configuration file is being re-parsed
164after hostname canonicalization (see the 168after hostname canonicalization (see the
165.Cm CanonicalizeHostname 169.Cm CanonicalizeHostname
166option.) 170option).
167This may be useful to specify conditions that work with canonical host 171This may be useful to specify conditions that work with canonical host
168names only. 172names only.
173.Pp
174The
175.Cm final
176keyword requests that the configuration be re-parsed (regardless of whether
177.Cm CanonicalizeHostname
178is enabled), and matches only during this final pass.
179If
180.Cm CanonicalizeHostname
181is enabled, then
182.Cm canonical
183and
184.Cm final
185match during the same pass.
186.Pp
169The 187The
170.Cm exec 188.Cm exec
171keyword executes the specified command under the user's shell. 189keyword executes the specified command under the user's shell.
@@ -1040,7 +1058,6 @@ ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
1040diffie-hellman-group-exchange-sha256, 1058diffie-hellman-group-exchange-sha256,
1041diffie-hellman-group16-sha512, 1059diffie-hellman-group16-sha512,
1042diffie-hellman-group18-sha512, 1060diffie-hellman-group18-sha512,
1043diffie-hellman-group-exchange-sha1,
1044diffie-hellman-group14-sha256, 1061diffie-hellman-group14-sha256,
1045diffie-hellman-group14-sha1 1062diffie-hellman-group14-sha1
1046.Ed 1063.Ed
@@ -1163,11 +1180,13 @@ or
1163.Cm no 1180.Cm no
1164(the default). 1181(the default).
1165.It Cm PKCS11Provider 1182.It Cm PKCS11Provider
1166Specifies which PKCS#11 provider to use. 1183Specifies which PKCS#11 provider to use or
1167The argument to this keyword is the PKCS#11 shared library 1184.Cm none
1185to indicate that no provider should be used (the default).
1186The argument to this keyword is a path to the PKCS#11 shared library
1168.Xr ssh 1 1187.Xr ssh 1
1169should use to communicate with a PKCS#11 token providing the user's 1188should use to communicate with a PKCS#11 token providing keys for user
1170private RSA key. 1189authentication.
1171.It Cm Port 1190.It Cm Port
1172Specifies the port number to connect on the remote host. 1191Specifies the port number to connect on the remote host.
1173The default is 22. 1192The default is 22.
@@ -1245,6 +1264,12 @@ Note that this option will compete with the
1245.Cm ProxyCommand 1264.Cm ProxyCommand
1246option - whichever is specified first will prevent later instances of the 1265option - whichever is specified first will prevent later instances of the
1247other from taking effect. 1266other from taking effect.
1267.Pp
1268Note also that the configuration for the destination host (either supplied
1269via the command-line or the configuration file) is not generally applied
1270to jump hosts.
1271.Pa ~/.ssh/config
1272should be used if specific configuration is required for jump hosts.
1248.It Cm ProxyUseFdpass 1273.It Cm ProxyUseFdpass
1249Specifies that 1274Specifies that
1250.Cm ProxyCommand 1275.Cm ProxyCommand
@@ -1785,7 +1810,7 @@ This is the per-user configuration file.
1785The format of this file is described above. 1810The format of this file is described above.
1786This file is used by the SSH client. 1811This file is used by the SSH client.
1787Because of the potential for abuse, this file must have strict permissions: 1812Because of the potential for abuse, this file must have strict permissions:
1788read/write for the user, and not accessible by others. 1813read/write for the user, and not writable by others.
1789.It Pa /etc/ssh/ssh_config 1814.It Pa /etc/ssh/ssh_config
1790Systemwide configuration file. 1815Systemwide configuration file.
1791This file provides defaults for those 1816This file provides defaults for those