Package com.cloudbees.jenkins.plugins.sshcredentials.impl

Class TrileadSSHPublicKeyAuthenticator

java.lang.Object

com.cloudbees.jenkins.plugins.sshcredentials.SSHAuthenticator<com.trilead.ssh2.Connection,SSHUserPrivateKey>

com.cloudbees.jenkins.plugins.sshcredentials.impl.TrileadSSHPublicKeyAuthenticator

public class TrileadSSHPublicKeyAuthenticator
extends SSHAuthenticator<com.trilead.ssh2.Connection,SSHUserPrivateKey>

Does public key auth with a Connection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TrileadSSHPublicKeyAuthenticator.Factory	Extension point to allow plugging in SSHAuthenticator implementations for the many SSH client libraries available.

Nested classes/interfaces inherited from class com.cloudbees.jenkins.plugins.sshcredentials.SSHAuthenticator

SSHAuthenticator.Mode

Constructor Summary

Constructors

Constructor	Description
TrileadSSHPublicKeyAuthenticator(com.trilead.ssh2.Connection connection, SSHUserPrivateKey user)	Constructor.
TrileadSSHPublicKeyAuthenticator(com.trilead.ssh2.Connection connection, SSHUserPrivateKey user, String username)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canAuthenticate()	Returns true if the bound connection is in a state where authentication can be tried using the supplied credentials.
protected boolean	doAuthenticate()	SPI for authenticating the bound connection using the supplied credentials.

Methods inherited from class com.cloudbees.jenkins.plugins.sshcredentials.SSHAuthenticator

authenticate, authenticate, authenticateOrFail, filter, getAuthenticationMode, getConnection, getListener, getPrivateKeys, getUser, getUsername, isAuthenticated, isSupported, matcher, matcher, newInstance, newInstance, newInstance, setListener

Methods inherited from class java.lang.Object

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

Constructor Details

TrileadSSHPublicKeyAuthenticator

public TrileadSSHPublicKeyAuthenticator(com.trilead.ssh2.Connection connection,
 SSHUserPrivateKey user)

Constructor.

Parameters:

connection - the connection we will be authenticating.

TrileadSSHPublicKeyAuthenticator

public TrileadSSHPublicKeyAuthenticator(@NonNull
 com.trilead.ssh2.Connection connection,
 @NonNull
 SSHUserPrivateKey user,
 @CheckForNull
 String username)

Constructor.

Parameters:

connection - the connection we will be authenticating.

Method Details

canAuthenticate

public boolean canAuthenticate()

Returns true if the bound connection is in a state where authentication can be tried using the supplied credentials.

Subclasses can override this if they can tell whether it is possible to make an authentication attempt, default implementation is one-shot always.

Overrides:

canAuthenticate in class SSHAuthenticator<com.trilead.ssh2.Connection,SSHUserPrivateKey>

Returns:

true if the bound connection is in a state where authentication can be tried using the supplied credentials.

doAuthenticate

protected boolean doAuthenticate()

SPI for authenticating the bound connection using the supplied credentials.

As a guideline, authentication errors should be reported to SSHAuthenticator.getListener() before this method returns with false. This helps an user better understand what is tried and failing. Logging can be used in addition to this to capture further details. (in contrast, please avoid reporting a success to the listener to improve S/N ratio)

Specified by:

doAuthenticate in class SSHAuthenticator<com.trilead.ssh2.Connection,SSHUserPrivateKey>

Returns:

true if and only if authentication was successful.