org.eclipse.jgit.transport.sshd

Class SshdSessionFactory

java.lang.Object

org.eclipse.jgit.transport.SshSessionFactory

org.eclipse.jgit.transport.sshd.SshdSessionFactory

All Implemented Interfaces:

Closeable, AutoCloseable

public class SshdSessionFactory
extends SshSessionFactory
implements Closeable

A SshSessionFactory that uses Apache MINA sshd.

Since:

5.2

Constructor Summary

Constructors

Constructor and Description
SshdSessionFactory() Creates a new SshdSessionFactory without key cache and a DefaultProxyDataFactory.
SshdSessionFactory(KeyCache keyCache, ProxyDataFactory proxies) Creates a new SshdSessionFactory using the given KeyCache and ProxyDataFactory.

Method Summary

Modifier and Type	Method and Description
void	close()
protected KeyPasswordProvider	createKeyPasswordProvider(CredentialsProvider provider) Creates a KeyPasswordProvider for a new session.
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.
protected List<Path>	getDefaultKnownHostsFiles(File sshDir) Gets the list of default user known hosts files.
protected String	getDefaultPreferredAuthentications() Gets the list of default preferred authentication mechanisms.
File	getHomeDirectory() Retrieves the global user home directory
protected KeyCache	getKeyCache() Obtains the KeyCache to use to cache loaded keys.
SshdSession	getSession(URIish uri, CredentialsProvider credentialsProvider, FS fs, int tms) Open (or reuse) a session to a host.
File	getSshDirectory() Retrieves the global .ssh directory
void	setHomeDirectory(File homeDir) Set a global directory to use as the user's home directory
void	setSshDirectory(File sshDir) Set a global directory to use as the .ssh directory

Methods inherited from class org.eclipse.jgit.transport.SshSessionFactory

getInstance, getLocalUserName, releaseSession, setInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

SshdSessionFactory

public SshdSessionFactory()

Creates a new SshdSessionFactory without key cache and a DefaultProxyDataFactory.

SshdSessionFactory

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.

Parameters:

keyCache - KeyCache to use for caching ssh keys, or null to not use a key cache

proxies - ProxyDataFactory to use, or null to not use a proxy database (in which case connections through proxies will not be possible)

Method Detail

getSession

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

Description copied from class: SshSessionFactory

Open (or reuse) a session to a host.

A reasonable UserInfo that can interact with the end-user (if necessary) is installed on the returned session by this method.

The caller must connect the session by invoking connect() if it has not already been connected.

Specified by:

getSession in class SshSessionFactory

Parameters:

uri - URI information about the remote host

credentialsProvider - provider to support authentication, may be null.

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

tms - Timeout value, in milliseconds.

Returns:

a session that can contact the remote host.

Throws:

TransportException - the session could not be created.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

setHomeDirectory

public void setHomeDirectory(@NonNull
                             File homeDir)

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

Parameters:

homeDir - to use

getHomeDirectory

public File getHomeDirectory()

Retrieves the global user home directory

Returns:

the directory, or null if not set

setSshDirectory

public void setSshDirectory(@NonNull
                            File sshDir)

Set a global directory to use as the .ssh directory

Parameters:

sshDir - to use

getSshDirectory

public File getSshDirectory()

Retrieves the global .ssh directory

Returns:

the directory, or null if not set

getDefaultKnownHostsFiles

@NonNull
protected List<Path> getDefaultKnownHostsFiles(@NonNull
                                                        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 -

Returns:

the possibly empty list of default known host file paths.

getDefaultIdentities

@NonNull
protected List<Path> getDefaultIdentities(@NonNull
                                                   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 - the directory that represents ~/.ssh/

Returns:

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

getKeyCache

protected final KeyCache getKeyCache()

Obtains the KeyCache to use to cache loaded keys.

Returns:

the KeyCache, or null if none.

createKeyPasswordProvider

@NonNull
protected KeyPasswordProvider createKeyPasswordProvider(CredentialsProvider provider)

Creates a KeyPasswordProvider for a new session.

Parameters:

provider - the CredentialsProvider to delegate to for user interactions

Returns:

a new KeyPasswordProvider

getDefaultPreferredAuthentications

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:

a comma-separated list of algorithm names, or null if none