Class JschConfigSessionFactory
java.lang.Object
org.eclipse.jgit.transport.SshSessionFactory
org.eclipse.jgit.transport.ssh.jsch.JschConfigSessionFactory
The base session factory that loads known hosts and private keys from
$HOME/.ssh.
This is the default implementation used by JGit and provides most of the compatibility necessary to match OpenSSH, a popular implementation of SSH used by C Git.
The factory does not provide UI behavior. Override the method
configure(org.eclipse.jgit.transport.ssh.jsch.OpenSshConfig.Host, Session)
to supply appropriate UserInfo to the session.
- Since:
- 6.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class -
Field Summary
FieldsModifier and TypeFieldDescriptionWe use different Jsch instances for hosts that have an IdentityFile configured in ~/.ssh/config.private OpenSshConfigprivate com.jcraft.jsch.JSchprivate static final Stringprivate static final org.slf4j.Logger -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidconfigure(OpenSshConfig.Host hc, com.jcraft.jsch.Session session) Provide additional configuration for the session based on the host information.protected voidconfigureJSch(com.jcraft.jsch.JSch jsch) Provide additional configuration for the JSch instance.private voidcopyConfigValueToSession(com.jcraft.jsch.Session session, com.jcraft.jsch.ConfigRepository.Config cfg, String from, String to) private voidcopyGlobalConfigIfNotSet(String from, String to) protected com.jcraft.jsch.JSchcreateDefaultJSch(FS fs) Create default instance of jschcom.jcraft.jsch.SessioncreateSession(CredentialsProvider credentialsProvider, FS fs, String user, String pass, String host, int port, OpenSshConfig.Host hc) Use for tests onlyprotected com.jcraft.jsch.SessioncreateSession(OpenSshConfig.Host hc, String user, String host, int port, FS fs) Create a new remote session for the requested address.protected com.jcraft.jsch.JSchgetJSch(OpenSshConfig.Host hc, FS fs) Obtain the JSch used to create new sessions.getSession(URIish uri, CredentialsProvider credentialsProvider, FS fs, int tms) Opens (or reuses) a session to a host.getType()The name of the type of session factory.private static StringhostName(com.jcraft.jsch.Session s) private static voididentities(com.jcraft.jsch.JSch sch, FS fs) private static booleanisAuthenticationCanceled(com.jcraft.jsch.JSchException e) private static booleanisAuthenticationFailed(com.jcraft.jsch.JSchException e) private static voidknownHosts(com.jcraft.jsch.JSch sch, FS fs) private static voidloadIdentity(com.jcraft.jsch.JSch sch, File priv) private voidsafeConfig(com.jcraft.jsch.Session session, com.jcraft.jsch.ConfigRepository.Config cfg) voidsetConfig(OpenSshConfig config) Set theOpenSshConfigto use.private static voidsetPreferredKeyTypesOrder(com.jcraft.jsch.Session session) private voidsetUserName(com.jcraft.jsch.Session session, String userName) Methods inherited from class org.eclipse.jgit.transport.SshSessionFactory
getInstance, getLocalUserName, releaseSession, setInstance
-
Field Details
-
JSCH
- See Also:
-
LOG
private static final org.slf4j.Logger LOG -
byIdentityFile
We use different Jsch instances for hosts that have an IdentityFile configured in ~/.ssh/config. Jsch by default would cache decrypted keys only per session, which results in repeated password prompts. Using different Jsch instances, we can cache the keys on these instances so that they will be re-used for successive sessions, and thus the user is prompted for a key password only once while Eclipse runs. -
defaultJSch
private com.jcraft.jsch.JSch defaultJSch -
config
-
-
Constructor Details
-
JschConfigSessionFactory
public JschConfigSessionFactory()
-
-
Method Details
-
getSession
public RemoteSession getSession(URIish uri, CredentialsProvider credentialsProvider, FS fs, int tms) throws TransportException Opens (or reuses) a session to a host. The returned session is connected and authenticated and is ready for further use.- Specified by:
getSessionin classSshSessionFactory- Parameters:
uri- URI of the remote host to connect tocredentialsProvider- provider to support authentication, may benullif no user input for authentication is neededfs- the file system abstraction to use for certain file operations, such as reading configuration filestms- connection timeout for creating the session, in milliseconds- Returns:
- a connected and authenticated session for communicating with the
remote host given by the
uri - Throws:
TransportException- if the session could not be created
-
getType
Description copied from class:SshSessionFactoryThe name of the type of session factory.- Specified by:
getTypein classSshSessionFactory- Returns:
- the name of the type of session factory.
-
isAuthenticationFailed
private static boolean isAuthenticationFailed(com.jcraft.jsch.JSchException e) -
isAuthenticationCanceled
private static boolean isAuthenticationCanceled(com.jcraft.jsch.JSchException e) -
createSession
public com.jcraft.jsch.Session createSession(CredentialsProvider credentialsProvider, FS fs, String user, String pass, String host, int port, OpenSshConfig.Host hc) throws com.jcraft.jsch.JSchException Use for tests only- Parameters:
credentialsProvider-fs-user-pass-host-port-hc-- Returns:
- session
- Throws:
com.jcraft.jsch.JSchException
-
safeConfig
private void safeConfig(com.jcraft.jsch.Session session, com.jcraft.jsch.ConfigRepository.Config cfg) -
setPreferredKeyTypesOrder
private static void setPreferredKeyTypesOrder(com.jcraft.jsch.Session session) -
hostName
-
copyConfigValueToSession
-
setUserName
-
createSession
protected com.jcraft.jsch.Session createSession(OpenSshConfig.Host hc, String user, String host, int port, FS fs) throws com.jcraft.jsch.JSchException Create a new remote session for the requested address.- Parameters:
hc- host configurationuser- login to authenticate as.host- server name to connect to.port- port number of the SSH daemon (typically 22).fs- the file system abstraction which will be necessary to perform certain file system operations.- Returns:
- new session instance, but otherwise unconfigured.
- Throws:
com.jcraft.jsch.JSchException- the session could not be created.
-
configureJSch
protected void configureJSch(com.jcraft.jsch.JSch jsch) Provide additional configuration for the JSch instance. This method could be overridden to supply a preferredIdentityRepository.- Parameters:
jsch- jsch instance- Since:
- 4.5
-
configure
Provide additional configuration for the session based on the host information. This method could be used to supplyUserInfo.- Parameters:
hc- host configurationsession- session to configure
-
getJSch
protected com.jcraft.jsch.JSch getJSch(OpenSshConfig.Host hc, FS fs) throws com.jcraft.jsch.JSchException Obtain the JSch used to create new sessions.- Parameters:
hc- host configurationfs- the file system abstraction which will be necessary to perform certain file system operations.- Returns:
- the JSch instance to use.
- Throws:
com.jcraft.jsch.JSchException- the user configuration could not be created.
-
createDefaultJSch
Create default instance of jsch- Parameters:
fs- the file system abstraction which will be necessary to perform certain file system operations.- Returns:
- the new default JSch implementation.
- Throws:
com.jcraft.jsch.JSchException- known host keys cannot be loaded.
-
copyGlobalConfigIfNotSet
-
knownHosts
private static void knownHosts(com.jcraft.jsch.JSch sch, FS fs) throws com.jcraft.jsch.JSchException - Throws:
com.jcraft.jsch.JSchException
-
identities
-
loadIdentity
-
setConfig
Set theOpenSshConfigto use. Intended for use in tests.- Parameters:
config- to use
-