Modifier and Type	Class and Description
private static class	SshdSessionFactory.Tuple A simple general map key.

Modifier and Type	Field and Description
private final AtomicBoolean	closing
private final Map<SshdSessionFactory.Tuple, HostConfigEntryResolver>	defaultHostConfigEntryResolver
private final Map<SshdSessionFactory.Tuple, Iterable<KeyPair>>	defaultKeys
private final Map<SshdSessionFactory.Tuple, ServerKeyDatabase>	defaultServerKeyDatabase
private File	homeDirectory
private final KeyCache	keyCache
private static final String	MINA_SSHD
private final ProxyDataFactory	proxies
private final Set<SshdSession>	sessions
private File	sshDirectory

Access	Constructor and Description
public	SshdSessionFactory() Creates a new `SshdSessionFactory` without key cache and a `DefaultProxyDataFactory`.
public	SshdSessionFactory(KeyCache `KeyCache` to use for caching ssh keys, or `null` to not use a key cache keyCache, ProxyDataFactory `ProxyDataFactory` to use, or `null` to not use a proxy database (in which case connections through proxies will not be possible) proxies) Creates a new `SshdSessionFactory` using the given `KeyCache` and `ProxyDataFactory`.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
private FilePasswordProvider	Returns: a new `FilePasswordProvider` createFilePasswordProvider(Supplier<KeyPasswordProvider> providing the `KeyPasswordProvider` to delegate to providerFactory) Creates a `FilePasswordProvider` for a new session.
protected KeyPasswordProvider	Returns: a new `KeyPasswordProvider`, or `null` to use the global `KeyPasswordProviderFactory` createKeyPasswordProvider(CredentialsProvider the `CredentialsProvider` to delegate to for user interactions provider) Creates a `KeyPasswordProvider` for a new session.
protected ServerKeyDatabase	Returns: the `ServerKeyDatabase` createServerKeyDatabase(File home directory to use for ~ replacement homeDir, File representing ~/.ssh/ sshDir) Creates a `ServerKeyDatabase` to verify server host keys.
protected SshConfigStore	Returns: A `SshConfigStore`, or `null` if none is to be used createSshConfigStore(File may be used for ~-replacements by the returned config store homeDir, File to use, or `null` if none configFile, String user name of the current user on the local OS localUserName) Obtains a `SshConfigStore`, or `null` if no SSH config is to be used.
protected ConnectorFactory	Returns: the factory, or `null` if no SSH agent support is desired getConnectorFactory() Gets a `ConnectorFactory`.
protected List<Path>	Returns: a possibly empty list of paths containing default identities (private keys) getDefaultIdentities(File the directory that represents ~/.ssh/ sshDir) Gets a list of default identities, i.e., private key files that shall always be tried for public key authentication.
protected Iterable<KeyPair>	Returns: an `Iterable` over the default keys getDefaultKeys(File to look in for keys sshDir) Determines the default keys.
protected List<Path>	Returns: the possibly empty list of default known host file paths. getDefaultKnownHostsFiles(File directory containing ssh configurations sshDir) Gets the list of default user known hosts files.
protected String	Returns: a comma-separated list of mechanism names, or `null` if none getDefaultPreferredAuthentications() Gets the list of default preferred authentication mechanisms.
public File	Returns: the directory, or `null` if not set getHomeDirectory() Retrieves the global user home directory
private HostConfigEntryResolver	Returns: the resolver getHostConfigEntryResolver(File home directory to use for ~ replacement homeDir, File to use for looking for the config file sshDir) Obtain a `HostConfigEntryResolver` to read the ssh config file and to determine host entries for connections.
protected final KeyCache	Returns: the `KeyCache`, or `null` if none. getKeyCache() Obtains the `KeyCache` to use to cache loaded keys.
protected ServerKeyDatabase	Returns: the `ServerKeyDatabase` getServerKeyDatabase(File home directory to use for ~ replacement homeDir, File representing ~/.ssh/ sshDir) Obtains a `ServerKeyDatabase` to verify server host keys.
public SshdSession	getSession(URIish URI of the remote host to connect to uri, CredentialsProvider provider to support authentication, may be `null` if no user input for authentication is needed credentialsProvider, FS the file system abstraction to use for certain file operations, such as reading configuration files fs, int connection timeout for creating the session, in milliseconds tms) Implements abstract org.eclipse.jgit.transport.SshSessionFactory.getSession. Opens (or reuses) a session to a host.
private static List<NamedFactory<Signature>>	Returns: a list of supported signature factories getSignatureFactories() Apache MINA sshd 2.6.0 has removed DSA, DSA_CERT and RSA_CERT.
protected File	Returns: the file (need not exist), or `null` if no config file shall be used getSshConfig(File representing ~/.ssh/ sshDir) Determines the ssh config file.
public File	Returns: the directory, or `null` if not set getSshDirectory() Retrieves the global .ssh directory
public String	getType() Implements abstract org.eclipse.jgit.transport.SshSessionFactory.getType. The name of the type of session factory.
private List<UserAuthFactory>	Returns: the non-empty list of factories. getUserAuthFactories() Gets the user authentication mechanisms (or rather, factories for them).
private Supplier<KeyPasswordProvider>	newKeyPasswordProvider(CredentialsProvider credentials)
private void	register(SshdSession newSession)
public void	setHomeDirectory(File to use homeDir) Set a global directory to use as the user's home directory
public void	setSshDirectory(File to use sshDir) Set a global directory to use as the .ssh directory
private KeyIdentityProvider	Returns: a `KeyIdentityProvider` that provides the given `keys` toKeyIdentityProvider(Iterable<KeyPair> to provide via the returned `KeyIdentityProvider` keys) Converts an `Iterable` of {link KeyPair}s into a `KeyIdentityProvider`.
private void	unregister(SshdSession oldSession)

Inherited from org.eclipse.jgit.transport.SshSessionFactory:: getInstance getLocalUserName releaseSession setInstance

Field Detail

closing	back to summary
private final AtomicBoolean closing

defaultHostConfigEntryResolver	back to summary
private final Map<SshdSessionFactory.Tuple, HostConfigEntryResolver> defaultHostConfigEntryResolver

defaultKeys	back to summary
private final Map<SshdSessionFactory.Tuple, Iterable<KeyPair>> defaultKeys

defaultServerKeyDatabase	back to summary
private final Map<SshdSessionFactory.Tuple, ServerKeyDatabase> defaultServerKeyDatabase

homeDirectory	back to summary
private File homeDirectory

keyCache	back to summary
private final KeyCache keyCache

MINA_SSHD	back to summary
private static final String MINA_SSHD

proxies	back to summary
private final ProxyDataFactory proxies

sessions	back to summary
private final Set<SshdSession> sessions

sshDirectory	back to summary
private File sshDirectory

Constructor Detail

SshdSessionFactory	back to summary
public SshdSessionFactory() Creates a new `SshdSessionFactory` without key cache and a `DefaultProxyDataFactory`.

SshdSessionFactory back to summary

SshdSessionFactory	back to summary
public SshdSessionFactory(KeyCache keyCache, ProxyDataFactory proxies) Creates a new `SshdSessionFactory` using the given `KeyCache` and `ProxyDataFactory`. The `keyCache` is used for all sessions created through this session factory; cached keys are destroyed when the session factory is `closed`. Caching ssh keys in memory for an extended period of time is generally considered bad practice, but there may be circumstances where using a `KeyCache` is still the right choice, for instance to avoid that a user gets prompted several times for the same password for the same key. In general, however, it is preferable not to use a key cache but to use a `KeyPasswordProvider` that has access to some secure storage and can save and retrieve passwords from there without user interaction. Another approach is to use an SSH agent. Note that the underlying ssh library (Apache MINA sshd) may or may not keep ssh keys in memory for unspecified periods of time irrespective of the use of a `KeyCache`. By default, the factory uses the `java.util.ServiceLoader` to find a `ConnectorFactory` for creating a `Connector` to connect to a running SSH agent. If it finds one, the SSH agent is used in publickey authentication. If there is none, no SSH agent will ever be contacted. Note that one can define `IdentitiesOnly yes` for a host entry in the `~/.ssh/config` file to bypass the SSH agent in any case. Parameters keyCache:KeyCache `KeyCache` to use for caching ssh keys, or `null` to not use a key cache proxies:ProxyDataFactory `ProxyDataFactory` to use, or `null` to not use a proxy database (in which case connections through proxies will not be possible)

public SshdSessionFactory(KeyCache keyCache, ProxyDataFactory proxies)

Creates a new SshdSessionFactory using the given KeyCache and ProxyDataFactory. The keyCache is used for all sessions created through this session factory; cached keys are destroyed when the session factory is closed.

Caching ssh keys in memory for an extended period of time is generally considered bad practice, but there may be circumstances where using a KeyCache is still the right choice, for instance to avoid that a user gets prompted several times for the same password for the same key. In general, however, it is preferable not to use a key cache but to use a KeyPasswordProvider that has access to some secure storage and can save and retrieve passwords from there without user interaction. Another approach is to use an SSH agent.

Note that the underlying ssh library (Apache MINA sshd) may or may not keep ssh keys in memory for unspecified periods of time irrespective of the use of a KeyCache.

By default, the factory uses the java.util.ServiceLoader to find a ConnectorFactory for creating a Connector to connect to a running SSH agent. If it finds one, the SSH agent is used in publickey authentication. If there is none, no SSH agent will ever be contacted. Note that one can define IdentitiesOnly yes for a host entry in the ~/.ssh/config file to bypass the SSH agent in any case.

Parameters

keyCache:KeyCache: KeyCache to use for caching ssh keys, or null to not use a key cache
proxies:ProxyDataFactory: ProxyDataFactory to use, or null to not use a proxy database (in which case connections through proxies will not be possible)

Method Detail

close back to summary

close	back to summary
public void close() Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override

public void close()

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

createFilePasswordProvider back to summary

createFilePasswordProvider	back to summary
private FilePasswordProvider createFilePasswordProvider(Supplier<KeyPasswordProvider> providerFactory) Creates a `FilePasswordProvider` for a new session. Parameters providerFactory:Supplier<KeyPasswordProvider> providing the `KeyPasswordProvider` to delegate to Returns:FilePasswordProvider a new `FilePasswordProvider` Annotations @NonNull

private FilePasswordProvider createFilePasswordProvider(Supplier<KeyPasswordProvider> providerFactory)

Creates a FilePasswordProvider for a new session.

Parameters

providerFactory:Supplier<KeyPasswordProvider>: providing the KeyPasswordProvider to delegate to

Returns:FilePasswordProvider

a new FilePasswordProvider

Annotations

@NonNull

createKeyPasswordProvider back to summary

createKeyPasswordProvider	back to summary
protected KeyPasswordProvider createKeyPasswordProvider(CredentialsProvider provider) Creates a `KeyPasswordProvider` for a new session. Parameters provider:CredentialsProvider the `CredentialsProvider` to delegate to for user interactions Returns:KeyPasswordProvider a new `KeyPasswordProvider`, or `null` to use the global `KeyPasswordProviderFactory`

protected KeyPasswordProvider createKeyPasswordProvider(CredentialsProvider provider)

Creates a KeyPasswordProvider for a new session.

Parameters

provider:CredentialsProvider: the CredentialsProvider to delegate to for user interactions

Returns:KeyPasswordProvider

a new KeyPasswordProvider, or null to use the global KeyPasswordProviderFactory

createServerKeyDatabase back to summary

createServerKeyDatabase	back to summary
protected ServerKeyDatabase createServerKeyDatabase(File homeDir, File sshDir) Creates a `ServerKeyDatabase` to verify server host keys. The default implementation returns a `ServerKeyDatabase` that recognizes the two openssh standard files `~/.ssh/known_hosts` and `~/.ssh/known_hosts2` as well as any files configured via the `UserKnownHostsFile` option in the ssh config file. Parameters homeDir:File home directory to use for ~ replacement sshDir:File representing ~/.ssh/ Returns:ServerKeyDatabase the `ServerKeyDatabase` Annotations @NonNull Since 5.8

protected ServerKeyDatabase createServerKeyDatabase(File homeDir, File sshDir)

Creates a ServerKeyDatabase to verify server host keys. The default implementation returns a ServerKeyDatabase that recognizes the two openssh standard files ~/.ssh/known_hosts and ~/.ssh/known_hosts2 as well as any files configured via the UserKnownHostsFile option in the ssh config file.

Parameters

homeDir:File: home directory to use for ~ replacement
sshDir:File: representing ~/.ssh/

Returns:ServerKeyDatabase

the ServerKeyDatabase

Annotations

@NonNull

Since

5.8

createSshConfigStore back to summary

createSshConfigStore	back to summary
protected SshConfigStore createSshConfigStore(File homeDir, File configFile, String localUserName) Obtains a `SshConfigStore`, or `null` if no SSH config is to be used. The default implementation returns `null` if `configFile == null` and otherwise an OpenSSH-compatible store reading host entries from the given file. Parameters homeDir:File may be used for ~-replacements by the returned config store configFile:File to use, or `null` if none localUserName:String user name of the current user on the local OS Returns:SshConfigStore A `SshConfigStore`, or `null` if none is to be used Since 5.8

protected SshConfigStore createSshConfigStore(File homeDir, File configFile, String localUserName)

Obtains a SshConfigStore, or null if no SSH config is to be used. The default implementation returns null if configFile == null and otherwise an OpenSSH-compatible store reading host entries from the given file.

Parameters

homeDir:File: may be used for ~-replacements by the returned config store
configFile:File: to use, or null if none
localUserName:String: user name of the current user on the local OS

Returns:SshConfigStore

A SshConfigStore, or null if none is to be used

Since

5.8

getConnectorFactory back to summary

getConnectorFactory	back to summary
protected ConnectorFactory getConnectorFactory() Gets a `ConnectorFactory`. If this returns `null`, SSH agents are not supported. The default implementation uses `ConnectorFactory#getDefault()` Returns:ConnectorFactory the factory, or `null` if no SSH agent support is desired Since 6.0

protected ConnectorFactory getConnectorFactory()

Gets a ConnectorFactory. If this returns null, SSH agents are not supported.

The default implementation uses ConnectorFactory#getDefault()

Returns:ConnectorFactory: the factory, or null if no SSH agent support is desired
Since: 6.0

getDefaultIdentities back to summary

getDefaultIdentities	back to summary
protected List<Path> getDefaultIdentities(File sshDir) Gets a list of default identities, i.e., private key files that shall always be tried for public key authentication. Typically those are ~/.ssh/id_dsa, ~/.ssh/id_rsa, and so on. The default implementation returns the files defined in `SshConstants#DEFAULT_IDENTITIES`. Parameters sshDir:File the directory that represents ~/.ssh/ Returns:List<Path> a possibly empty list of paths containing default identities (private keys) Annotations @NonNull

protected List<Path> getDefaultIdentities(File sshDir)

Gets a list of default identities, i.e., private key files that shall always be tried for public key authentication. Typically those are ~/.ssh/id_dsa, ~/.ssh/id_rsa, and so on. The default implementation returns the files defined in SshConstants#DEFAULT_IDENTITIES.

Parameters

sshDir:File: the directory that represents ~/.ssh/

Returns:List<Path>

a possibly empty list of paths containing default identities (private keys)

Annotations

@NonNull

getDefaultKeys back to summary

getDefaultKeys	back to summary
protected Iterable<KeyPair> getDefaultKeys(File sshDir) Determines the default keys. The default implementation will lazy load the `default identity files`. Subclasses may override and return an `Iterable` of whatever keys are appropriate. If the returned iterable lazily loads keys, it should be an instance of `AbstractResourceKeyPairProvider` so that the session can later pass it the `password provider` wrapped as a `FilePasswordProvider` via `AbstractResourceKeyPairProvider#setPasswordFinder(FilePasswordProvider)` so that encrypted, password-protected keys can be loaded. The default implementation uses exactly this mechanism; class `CachingKeyPairProvider` may serve as a model for a customized lazy-loading `Iterable` implementation If the `Iterable` returned has the keys already pre-loaded or otherwise doesn't need to decrypt encrypted keys, it can be any `Iterable`, for instance a simple `List`. Parameters sshDir:File to look in for keys Returns:Iterable<KeyPair> an `Iterable` over the default keys Annotations @NonNull Since 5.3

protected Iterable<KeyPair> getDefaultKeys(File sshDir)

Determines the default keys. The default implementation will lazy load the default identity files.

Subclasses may override and return an Iterable of whatever keys are appropriate. If the returned iterable lazily loads keys, it should be an instance of AbstractResourceKeyPairProvider so that the session can later pass it the password provider wrapped as a FilePasswordProvider via AbstractResourceKeyPairProvider#setPasswordFinder(FilePasswordProvider) so that encrypted, password-protected keys can be loaded.

The default implementation uses exactly this mechanism; class CachingKeyPairProvider may serve as a model for a customized lazy-loading Iterable implementation

If the Iterable returned has the keys already pre-loaded or otherwise doesn't need to decrypt encrypted keys, it can be any Iterable, for instance a simple List.

Parameters

sshDir:File: to look in for keys

Returns:Iterable<KeyPair>

an Iterable over the default keys

Annotations

@NonNull

Since

5.3

getDefaultKnownHostsFiles back to summary

getDefaultKnownHostsFiles	back to summary
protected List<Path> getDefaultKnownHostsFiles(File sshDir) Gets the list of default user known hosts files. The default returns ~/.ssh/known_hosts and ~/.ssh/known_hosts2. The ssh config `UserKnownHostsFile` overrides this default. Parameters sshDir:File directory containing ssh configurations Returns:List<Path> the possibly empty list of default known host file paths. Annotations @NonNull

protected List<Path> getDefaultKnownHostsFiles(File sshDir)

Gets the list of default user known hosts files. The default returns ~/.ssh/known_hosts and ~/.ssh/known_hosts2. The ssh config UserKnownHostsFile overrides this default.

Parameters

sshDir:File: directory containing ssh configurations

Returns:List<Path>

the possibly empty list of default known host file paths.

Annotations

@NonNull

getDefaultPreferredAuthentications back to summary

getDefaultPreferredAuthentications	back to summary
protected String getDefaultPreferredAuthentications() Gets the list of default preferred authentication mechanisms. If `null` is returned the openssh default list will be in effect. If the ssh config defines `PreferredAuthentications` the value from the ssh config takes precedence. Returns:String a comma-separated list of mechanism names, or `null` if none

protected String getDefaultPreferredAuthentications()

Gets the list of default preferred authentication mechanisms. If null is returned the openssh default list will be in effect. If the ssh config defines PreferredAuthentications the value from the ssh config takes precedence.

Returns:String: a comma-separated list of mechanism names, or null if none

getHomeDirectory back to summary

getHomeDirectory	back to summary
public File getHomeDirectory() Retrieves the global user home directory Returns:File the directory, or `null` if not set

public File getHomeDirectory()

Retrieves the global user home directory

Returns:File: the directory, or null if not set

getHostConfigEntryResolver back to summary

getHostConfigEntryResolver	back to summary
private HostConfigEntryResolver getHostConfigEntryResolver(File homeDir, File sshDir) Obtain a `HostConfigEntryResolver` to read the ssh config file and to determine host entries for connections. Parameters homeDir:File home directory to use for ~ replacement sshDir:File to use for looking for the config file Returns:HostConfigEntryResolver the resolver Annotations @NonNull

private HostConfigEntryResolver getHostConfigEntryResolver(File homeDir, File sshDir)

Obtain a HostConfigEntryResolver to read the ssh config file and to determine host entries for connections.

Parameters

homeDir:File: home directory to use for ~ replacement
sshDir:File: to use for looking for the config file

Returns:HostConfigEntryResolver

the resolver

Annotations

@NonNull

getKeyCache back to summary

getKeyCache	back to summary
protected final KeyCache getKeyCache() Obtains the `KeyCache` to use to cache loaded keys. Returns:KeyCache the `KeyCache`, or `null` if none.

protected final KeyCache getKeyCache()

Obtains the KeyCache to use to cache loaded keys.

Returns:KeyCache: the KeyCache, or null if none.

getServerKeyDatabase back to summary

getServerKeyDatabase	back to summary
protected ServerKeyDatabase getServerKeyDatabase(File homeDir, File sshDir) Obtains a `ServerKeyDatabase` to verify server host keys. The default implementation returns a `ServerKeyDatabase` that recognizes the two openssh standard files `~/.ssh/known_hosts` and `~/.ssh/known_hosts2` as well as any files configured via the `UserKnownHostsFile` option in the ssh config file. Parameters homeDir:File home directory to use for ~ replacement sshDir:File representing ~/.ssh/ Returns:ServerKeyDatabase the `ServerKeyDatabase` Annotations @NonNull Since 5.5

protected ServerKeyDatabase getServerKeyDatabase(File homeDir, File sshDir)

Obtains a ServerKeyDatabase to verify server host keys. The default implementation returns a ServerKeyDatabase that recognizes the two openssh standard files ~/.ssh/known_hosts and ~/.ssh/known_hosts2 as well as any files configured via the UserKnownHostsFile option in the ssh config file.

Parameters

homeDir:File: home directory to use for ~ replacement
sshDir:File: representing ~/.ssh/

Returns:ServerKeyDatabase

the ServerKeyDatabase

Annotations

@NonNull

Since

5.5

getSession back to summary

getSession	back to summary
public SshdSession getSession(URIish uri, CredentialsProvider credentialsProvider, FS fs, int tms) throws TransportException Implements abstract org.eclipse.jgit.transport.SshSessionFactory.getSession. Doc from org.eclipse.jgit.transport.SshSessionFactory.getSession. Opens (or reuses) a session to a host. The returned session is connected and authenticated and is ready for further use. Parameters uri:URIish URI of the remote host to connect to credentialsProvider:CredentialsProvider provider to support authentication, may be `null` if no user input for authentication is needed fs:FS the file system abstraction to use for certain file operations, such as reading configuration files tms:int connection timeout for creating the session, in milliseconds Returns:SshdSession a connected and authenticated session for communicating with the remote host given by the `uri` Annotations @Override Exceptions TransportException: if the session could not be created

public SshdSession getSession(URIish uri, CredentialsProvider credentialsProvider, FS fs, int tms) throws TransportException

Implements abstract org.eclipse.jgit.transport.SshSessionFactory.getSession.

Doc from org.eclipse.jgit.transport.SshSessionFactory.getSession.

Opens (or reuses) a session to a host. The returned session is connected and authenticated and is ready for further use.

Parameters

uri:URIish: URI of the remote host to connect to
credentialsProvider:CredentialsProvider: provider to support authentication, may be null if no user input for authentication is needed
fs:FS: the file system abstraction to use for certain file operations, such as reading configuration files
tms:int: connection timeout for creating the session, in milliseconds

Returns:SshdSession

a connected and authenticated session for communicating with the remote host given by the uri

Annotations

@Override

Exceptions

TransportException:: if the session could not be created

getSignatureFactories	back to summary
private static List<NamedFactory<Signature>> getSignatureFactories() Apache MINA sshd 2.6.0 has removed DSA, DSA_CERT and RSA_CERT. We have to set it up explicitly to still allow users to connect with DSA keys. Returns:List<NamedFactory<Signature>> a list of supported signature factories Annotations @SuppressWarnings:deprecation

getSignatureFactories

back to summary

private static List<NamedFactory<Signature>> getSignatureFactories()

Apache MINA sshd 2.6.0 has removed DSA, DSA_CERT and RSA_CERT. We have to set it up explicitly to still allow users to connect with DSA keys.

Returns:List<NamedFactory<Signature>>

a list of supported signature factories

Annotations

@SuppressWarnings:deprecation

getSshConfig back to summary

getSshConfig	back to summary
protected File getSshConfig(File sshDir) Determines the ssh config file. The default implementation returns ~/.ssh/config. If the file does not exist and is created later it will be picked up. To not use a config file at all, return `null`. Parameters sshDir:File representing ~/.ssh/ Returns:File the file (need not exist), or `null` if no config file shall be used Since 5.5

protected File getSshConfig(File sshDir)

Determines the ssh config file. The default implementation returns ~/.ssh/config. If the file does not exist and is created later it will be picked up. To not use a config file at all, return null.

Parameters

sshDir:File: representing ~/.ssh/

Returns:File

the file (need not exist), or null if no config file shall be used

Since

5.5

getSshDirectory back to summary

getSshDirectory	back to summary
public File getSshDirectory() Retrieves the global .ssh directory Returns:File the directory, or `null` if not set

public File getSshDirectory()

Retrieves the global .ssh directory

Returns:File: the directory, or null if not set

getType	back to summary
public String getType() Implements abstract org.eclipse.jgit.transport.SshSessionFactory.getType. Doc from org.eclipse.jgit.transport.SshSessionFactory.getType. The name of the type of session factory. Returns:String the name of the type of session factory. Annotations @Override

getType

back to summary

public String getType()

Implements abstract org.eclipse.jgit.transport.SshSessionFactory.getType.

Doc from org.eclipse.jgit.transport.SshSessionFactory.getType.

The name of the type of session factory.

Returns:String

the name of the type of session factory.

Annotations

@Override

getUserAuthFactories back to summary

getUserAuthFactories	back to summary
private List<UserAuthFactory> getUserAuthFactories() Gets the user authentication mechanisms (or rather, factories for them). By default this returns gssapi-with-mic, public-key, password, and keyboard-interactive, in that order. The order is only significant if the ssh config does not set `PreferredAuthentications`; if it is set, the order defined there will be taken. Returns:List<UserAuthFactory> the non-empty list of factories. Annotations @NonNull

private List<UserAuthFactory> getUserAuthFactories()

Gets the user authentication mechanisms (or rather, factories for them). By default this returns gssapi-with-mic, public-key, password, and keyboard-interactive, in that order. The order is only significant if the ssh config does not set PreferredAuthentications; if it is set, the order defined there will be taken.

Returns:List<UserAuthFactory>

the non-empty list of factories.

Annotations

@NonNull

newKeyPasswordProvider	back to summary
private Supplier<KeyPasswordProvider> newKeyPasswordProvider(CredentialsProvider credentials)

register	back to summary
private void register(SshdSession newSession) throws IOException

setHomeDirectory	back to summary
public void setHomeDirectory(File homeDir) Set a global directory to use as the user's home directory Parameters homeDir:File to use

setHomeDirectory

back to summary

public void setHomeDirectory(File homeDir)

Set a global directory to use as the user's home directory

Parameters

homeDir:File: to use

setSshDirectory	back to summary
public void setSshDirectory(File sshDir) Set a global directory to use as the .ssh directory Parameters sshDir:File to use

setSshDirectory

back to summary

public void setSshDirectory(File sshDir)

Set a global directory to use as the .ssh directory

Parameters

sshDir:File: to use

toKeyIdentityProvider back to summary

toKeyIdentityProvider	back to summary
private KeyIdentityProvider toKeyIdentityProvider(Iterable<KeyPair> keys) Converts an `Iterable` of {link KeyPair}s into a `KeyIdentityProvider`. Parameters keys:Iterable<KeyPair> to provide via the returned `KeyIdentityProvider` Returns:KeyIdentityProvider a `KeyIdentityProvider` that provides the given `keys`

private KeyIdentityProvider toKeyIdentityProvider(Iterable<KeyPair> keys)

Converts an Iterable of {link KeyPair}s into a KeyIdentityProvider.

Parameters

keys:Iterable<KeyPair>: to provide via the returned KeyIdentityProvider

Returns:KeyIdentityProvider

a KeyIdentityProvider that provides the given keys

unregister	back to summary
private void unregister(SshdSession oldSession)

org.eclipse.jgit.transport.sshd back to summary

private final Class SshdSessionFactory.Tuple

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.transport.sshd.SshdSessionFactory.Tuple

A simple general map key.

Field Summary

Modifier and Type	Field and Description
private Object[]	objects

Constructor Summary

Access	Constructor and Description
public	Tuple(Object[] objects)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

objects	back to summary
private Object[] objects

Constructor Detail

Tuple	back to summary
public Tuple(Object[] objects)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

public Class SshdSessionFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class SshdSessionFactory.Tuple

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail