Apache Mina SSHD 2.15.0 · org.apache.sshd.client.auth.hostbased.UserAuthHostBased

Modifier and Type	Field and Description
protected final HostKeyIdentityProvider	clientHostKeys
private String	clientHostname
private String	clientUsername
private List<NamedFactory<Signature>>	factories
protected Map.Entry<KeyPair, ? extends Collection<X509Certificate>>	keyInfo
protected Iterator<? extends Map.Entry<KeyPair, ? extends Collection<X509Certificate>>>	keys
public static final String	NAME

Modifier and Type

Field and Description

protected final HostKeyIdentityProvider

clientHostKeys

private String

clientHostname

private String

clientUsername

private List<NamedFactory<Signature>>

factories

protected Map.Entry<KeyPair, ? extends Collection<X509Certificate>>

keyInfo

protected Iterator<? extends Map.Entry<KeyPair, ? extends Collection<X509Certificate>>>

keys

public static final String

NAME

Access	Constructor and Description
public	UserAuthHostBased(HostKeyIdentityProvider clientHostKeys)

Access

Constructor and Description

public

UserAuthHostBased(HostKeyIdentityProvider clientHostKeys)

Modifier and Type	Method and Description
protected byte[]	appendSignature(ClientSession session, String service, String keyType, PublicKey key, byte[] keyBytes, String clientHostname, String clientUsername, Signature verifier, Buffer buffer)
public String	getClientHostname()
public String	getClientUsername()
public List<NamedFactory<Signature>>	getSignatureFactories() Implements org.apache.sshd.common.signature.SignatureFactoriesHolder.getSignatureFactories.
public void	init(ClientSession The `ClientSession` session, String The requesting service name service) Overrides org.apache.sshd.client.auth.AbstractUserAuth.init. Implements org.apache.sshd.client.auth.UserAuth.init.
protected boolean	processAuthDataRequest(ClientSession session, String service, Buffer buffer) Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.processAuthDataRequest.
protected String	resolveClientHostname(ClientSession session)
protected String	resolveClientUsername(ClientSession session)
protected boolean	sendAuthDataRequest(ClientSession session, String service) Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.sendAuthDataRequest.
public void	setClientHostname(String clientHostname)
public void	setClientUsername(String clientUsername)
public void	setSignatureFactories(List<NamedFactory<Signature>> factories) Implements org.apache.sshd.common.signature.SignatureFactoriesManager.setSignatureFactories.
public void	signalAuthMethodFailure(ClientSession The `ClientSession` session, String The requesting service name service, boolean `true` if some partial authentication success so far partial, List<String> The `List` of authentication methods that can continue serverMethods, Buffer The `Buffer` containing the failure message (after having consumed the relevant data from it) buffer) Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodFailure. Signals reception of `SSH_MSG_USERAUTH_FAILURE` message
public void	signalAuthMethodSuccess(ClientSession The `ClientSession` session, String The requesting service name service, Buffer The `Buffer` containing the success message (after having consumed the relevant data from it) buffer) Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodSuccess. Signal reception of `SSH_MSG_USERAUTH_SUCCESS` message

Modifier and Type

Method and Description

protected byte[]

appendSignature(ClientSession session, String service, String keyType, PublicKey key, byte[] keyBytes, String clientHostname, String clientUsername, Signature verifier, Buffer buffer)

public String

getClientHostname()

public String

getClientUsername()

public List<NamedFactory<Signature>>

getSignatureFactories()

Implements org.apache.sshd.common.signature.SignatureFactoriesHolder.getSignatureFactories.

public void

init(ClientSession

The ClientSession

session, String

The requesting service name

service)

Overrides org.apache.sshd.client.auth.AbstractUserAuth.init.

Implements org.apache.sshd.client.auth.UserAuth.init.

protected boolean

processAuthDataRequest(ClientSession session, String service, Buffer buffer)

Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.processAuthDataRequest.

protected String

resolveClientHostname(ClientSession session)

protected String

resolveClientUsername(ClientSession session)

protected boolean

sendAuthDataRequest(ClientSession session, String service)

Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.sendAuthDataRequest.

public void

setClientHostname(String clientHostname)

public void

setClientUsername(String clientUsername)

public void

setSignatureFactories(List<NamedFactory<Signature>> factories)

Implements org.apache.sshd.common.signature.SignatureFactoriesManager.setSignatureFactories.

public void

signalAuthMethodFailure(ClientSession

The ClientSession

session, String

The requesting service name

service, boolean

true if some partial authentication success so far

partial, List<String>

The List of authentication methods that can continue

serverMethods, Buffer

The Buffer containing the failure message (after having consumed the relevant data from it)

buffer)

Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodFailure.

Signals reception of SSH_MSG_USERAUTH_FAILURE message

public void

signalAuthMethodSuccess(ClientSession

The ClientSession

session, String

The requesting service name

service, Buffer

The Buffer containing the success message (after having consumed the relevant data from it)

buffer)

Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodSuccess.

Signal reception of SSH_MSG_USERAUTH_SUCCESS message

clientHostKeys	back to summary
protected final HostKeyIdentityProvider clientHostKeys

clientHostKeys

back to summary

protected final HostKeyIdentityProvider clientHostKeys

clientHostname	back to summary
private String clientHostname

clientHostname

back to summary

private String clientHostname

clientUsername	back to summary
private String clientUsername

clientUsername

back to summary

private String clientUsername

factories	back to summary
private List<NamedFactory<Signature>> factories

factories

back to summary

private List<NamedFactory<Signature>> factories

keyInfo	back to summary
protected Map.Entry<KeyPair, ? extends Collection<X509Certificate>> keyInfo

keyInfo

back to summary

protected Map.Entry<KeyPair, ? extends Collection<X509Certificate>> keyInfo

keys	back to summary
protected Iterator<? extends Map.Entry<KeyPair, ? extends Collection<X509Certificate>>> keys

keys

back to summary

protected Iterator<? extends Map.Entry<KeyPair, ? extends Collection<X509Certificate>>> keys

NAME	back to summary
public static final String NAME

NAME

back to summary

public static final String NAME

UserAuthHostBased	back to summary
public UserAuthHostBased(HostKeyIdentityProvider clientHostKeys)

UserAuthHostBased

back to summary

public UserAuthHostBased(HostKeyIdentityProvider clientHostKeys)

Method Detail

appendSignature	back to summary
protected byte[] appendSignature(ClientSession session, String service, String keyType, PublicKey key, byte[] keyBytes, String clientHostname, String clientUsername, Signature verifier, Buffer buffer) throws Exception Annotations @SuppressWarnings:checkstyle:ParameterNumber

getClientHostname	back to summary
public String getClientHostname()

getClientUsername	back to summary
public String getClientUsername()

getSignatureFactories back to summary

getSignatureFactories	back to summary
public List<NamedFactory<Signature>> getSignatureFactories() Implements org.apache.sshd.common.signature.SignatureFactoriesHolder.getSignatureFactories. Returns:List<NamedFactory<Signature>> Doc from org.apache.sshd.common.signature.SignatureFactoriesHolder.getSignatureFactories. The list of named `Signature` factories Annotations @Override

public List<NamedFactory<Signature>> getSignatureFactories()

Implements org.apache.sshd.common.signature.SignatureFactoriesHolder.getSignatureFactories.

Returns:List<NamedFactory<Signature>>

Doc from org.apache.sshd.common.signature.SignatureFactoriesHolder.getSignatureFactories.

The list of named Signature factories

Annotations

@Override

init back to summary

init	back to summary
public void init(ClientSession session, String service) throws Exception Overrides org.apache.sshd.client.auth.AbstractUserAuth.init. Implements org.apache.sshd.client.auth.UserAuth.init. Parameters session:ClientSession Doc from org.apache.sshd.client.auth.UserAuth.init. The `ClientSession` service:String Doc from org.apache.sshd.client.auth.UserAuth.init. The requesting service name Annotations @Override Exceptions Exception: Doc from org.apache.sshd.client.auth.UserAuth.init. If failed to initialize the mechanism

public void init(ClientSession session, String service) throws Exception

Overrides org.apache.sshd.client.auth.AbstractUserAuth.init.

Implements org.apache.sshd.client.auth.UserAuth.init.

Parameters

session:ClientSession

Doc from org.apache.sshd.client.auth.UserAuth.init.

The ClientSession

service:String

Doc from org.apache.sshd.client.auth.UserAuth.init.

The requesting service name

Annotations

@Override

Exceptions

Exception:

Doc from org.apache.sshd.client.auth.UserAuth.init.

If failed to initialize the mechanism

processAuthDataRequest	back to summary
protected boolean processAuthDataRequest(ClientSession session, String service, Buffer buffer) throws Exception Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.processAuthDataRequest. Annotations @Override

processAuthDataRequest

back to summary

protected boolean processAuthDataRequest(ClientSession session, String service, Buffer buffer) throws Exception

Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.processAuthDataRequest.

Annotations

@Override

resolveClientHostname	back to summary
protected String resolveClientHostname(ClientSession session)

resolveClientUsername	back to summary
protected String resolveClientUsername(ClientSession session)

sendAuthDataRequest	back to summary
protected boolean sendAuthDataRequest(ClientSession session, String service) throws Exception Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.sendAuthDataRequest. Annotations @Override

sendAuthDataRequest

back to summary

protected boolean sendAuthDataRequest(ClientSession session, String service) throws Exception

Implements abstract org.apache.sshd.client.auth.AbstractUserAuth.sendAuthDataRequest.

Annotations

@Override

setClientHostname	back to summary
public void setClientHostname(String clientHostname)

setClientUsername	back to summary
public void setClientUsername(String clientUsername)

setSignatureFactories	back to summary
public void setSignatureFactories(List<NamedFactory<Signature>> factories) Implements org.apache.sshd.common.signature.SignatureFactoriesManager.setSignatureFactories. Annotations @Override

setSignatureFactories

back to summary

public void setSignatureFactories(List<NamedFactory<Signature>> factories)

Implements org.apache.sshd.common.signature.SignatureFactoriesManager.setSignatureFactories.

Annotations

@Override

signalAuthMethodFailure back to summary

signalAuthMethodFailure	back to summary
public void signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer) throws Exception Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodFailure. Doc from org.apache.sshd.client.auth.UserAuth.signalAuthMethodFailure. Signals reception of `SSH_MSG_USERAUTH_FAILURE` message Parameters session:ClientSession The `ClientSession` service:String The requesting service name partial:boolean `true` if some partial authentication success so far serverMethods:List<String> The `List` of authentication methods that can continue buffer:Buffer The `Buffer` containing the failure message (after having consumed the relevant data from it) Annotations @Override Exceptions Exception: If failed to handle the callback - Note: may cause session close

public void signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer) throws Exception

Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodFailure.

Doc from org.apache.sshd.client.auth.UserAuth.signalAuthMethodFailure.

Signals reception of SSH_MSG_USERAUTH_FAILURE message

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
partial:boolean: true if some partial authentication success so far
serverMethods:List<String>: The List of authentication methods that can continue
buffer:Buffer: The Buffer containing the failure message (after having consumed the relevant data from it)

Annotations

@Override

Exceptions

Exception:: If failed to handle the callback - Note: may cause session close

signalAuthMethodSuccess back to summary

signalAuthMethodSuccess	back to summary
public void signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer) throws Exception Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodSuccess. Doc from org.apache.sshd.client.auth.UserAuth.signalAuthMethodSuccess. Signal reception of `SSH_MSG_USERAUTH_SUCCESS` message Parameters session:ClientSession The `ClientSession` service:String The requesting service name buffer:Buffer The `Buffer` containing the success message (after having consumed the relevant data from it) Annotations @Override Exceptions Exception: If failed to handle the callback - Note: may cause session close

public void signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer) throws Exception

Overrides default org.apache.sshd.client.auth.UserAuth.signalAuthMethodSuccess.

Doc from org.apache.sshd.client.auth.UserAuth.signalAuthMethodSuccess.

Signal reception of SSH_MSG_USERAUTH_SUCCESS message

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
buffer:Buffer: The Buffer containing the success message (after having consumed the relevant data from it)

Annotations

@Override

Exceptions

Exception:: If failed to handle the callback - Note: may cause session close

public Class UserAuthHostBased

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail