org.eclipse.jgit.transport

Class OpenSshConfig

java.lang.Object

org.eclipse.jgit.transport.OpenSshConfig

All Implemented Interfaces:

com.jcraft.jsch.ConfigRepository

public class OpenSshConfig
extends Object
implements com.jcraft.jsch.ConfigRepository

Fairly complete configuration parser for the OpenSSH ~/.ssh/config file.

JSch does have its own config file parser OpenSSHConfig since version 0.1.50, but it has a number of problems:

• it splits lines of the format "keyword = value" wrongly: you'd end up with the value "= value".
• its "Host" keyword is not case insensitive.
• it doesn't handle quoted values.
• JSch's OpenSSHConfig doesn't monitor for config file changes.

Therefore implement our own parser to read an OpenSSH configuration file. It makes the critical options available to SshSessionFactory via OpenSshConfig.Host objects returned by lookup(String), and implements a fully conforming ConfigRepository providing ConfigRepository.Configs via getConfig(String).

Limitations compared to the full OpenSSH 7.5 parser:

• This parser does not handle Match or Include keywords.
• This parser does not do host name canonicalization (Jsch ignores it anyway).

Note that OpenSSH's readconf.c is a validating parser; Jsch's ConfigRepository OTOH treats all option values as plain strings, so any validation must happen in Jsch outside of the parser. Thus this parser does not validate option values, except for a few options when constructing a OpenSshConfig.Host object.

This config does %-substitutions for the following tokens:

• %% - single %
• %C - short-hand for %l%h%p%r. See %p and %r below; the replacement may be done partially only and may leave %p or %r or both unreplaced.
• %d - home directory path
• %h - remote host name
• %L - local host name without domain
• %l - FQDN of the local host
• %n - host name as specified in lookup(String)
• %p - port number; replaced only if set in the config
• %r - remote user name; replaced only if set in the config
• %u - local user name

If the config doesn't set the port or the remote user name, %p and %r remain un-substituted. It's the caller's responsibility to replace them with values obtained from the connection URI. %i is not handled; Java has no concept of a "user ID".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenSshConfig.Host Configuration of one "Host" block in the configuration file.

Nested classes/interfaces inherited from interface com.jcraft.jsch.ConfigRepository

com.jcraft.jsch.ConfigRepository.Config

Field Summary

Fields inherited from interface com.jcraft.jsch.ConfigRepository

defaultConfig, nullConfig

Method Summary

Modifier and Type	Method and Description
static OpenSshConfig	get(FS fs) Obtain the user's configuration data.
com.jcraft.jsch.ConfigRepository.Config	getConfig(String hostName)
OpenSshConfig.Host	lookup(String hostName) Locate the configuration for a specific host request.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

get

public static OpenSshConfig get(FS fs)

Obtain the user's configuration data.

The configuration file is always returned to the caller, even if no file exists in the user's home directory at the time the call was made. Lookup requests are cached and are automatically updated if the user modifies the configuration file since the last time it was cached.

Parameters:

fs - the file system abstraction which will be necessary to perform certain file system operations.

Returns:

a caching reader of the user's configuration file.

lookup

public OpenSshConfig.Host lookup(String hostName)

Locate the configuration for a specific host request.

Parameters:

hostName - the name the user has supplied to the SSH tool. This may be a real host name, or it may just be a "Host" block in the configuration file.

Returns:

r configuration for the requested name. Never null.

getConfig

public com.jcraft.jsch.ConfigRepository.Config getConfig(String hostName)

Retrieves the full Config for the given host name. Should be called only by Jsch and tests.

Specified by:

getConfig in interface com.jcraft.jsch.ConfigRepository

Since:

4.9

toString

public String toString()

Overrides:

toString in class Object