Apache Mina SSHD 2.15.0 · org.apache.sshd.client.auth.pubkey.PublicKeyAuthenticationReporter

Method Summary

Modifier and Type	Method and Description
public default void	signalAuthenticationAttempt(ClientSession The `ClientSession` session, String The requesting service name service, KeyPair The `KeyPair` identity being attempted - Note: for agent based authentications the private key may be `null` identity, String The type of signature that is being used signature) Sending the initial request to use public key authentication
public default void	signalAuthenticationExhausted(ClientSession The `ClientSession` session, String The requesting service name service) Signals end of public key attempts and optionally switching to other authentication methods Note neither `signalAuthenticationSuccess` nor `signalAuthenticationFailure` are invoked.
public default void	signalAuthenticationFailure(ClientSession The `ClientSession` session, String The requesting service name service, KeyPair The `KeyPair` identity being attempted - Note: for agent based authentications the private key may be `null` identity, boolean `true` if some partial authentication success so far partial, List<String> The `List` of authentication methods that can continue serverMethods)
public default void	signalAuthenticationSuccess(ClientSession The `ClientSession` session, String The requesting service name service, KeyPair The `KeyPair` identity being attempted - Note: for agent based authentications the private key may be `null` identity)
public default void	signalIdentitySkipped(ClientSession The `ClientSession` session, String The requesting service name service, KeyPair The `KeyPair` identity being skipped - Note: for agent based authentications the private key may be `null` identity) A `KeyPair` is is present, but is not attempted because no signature factory for it could be found.
public default void	signalSignatureAttempt(ClientSession The `ClientSession` session, String The requesting service name service, KeyPair The `KeyPair` identity being attempted - Note: for agent based authentications the private key may be `null` identity, String The type of signature that is being used signature, byte[] The generated signature data signed) Sending the signed response to the server's challenge

Method Detail

signalAuthenticationAttempt back to summary

signalAuthenticationAttempt	back to summary
public default void signalAuthenticationAttempt(ClientSession session, String service, KeyPair identity, String signature) throws Exception Sending the initial request to use public key authentication Parameters session:ClientSession The `ClientSession` service:String The requesting service name identity:KeyPair The `KeyPair` identity being attempted - Note: for agent based authentications the private key may be `null` signature:String The type of signature that is being used Exceptions Exception: If failed to handle the callback - Note: may cause session close

public default void signalAuthenticationAttempt(ClientSession session, String service, KeyPair identity, String signature) throws Exception

Sending the initial request to use public key authentication

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
identity:KeyPair: The KeyPair identity being attempted - Note: for agent based authentications the private key may be null
signature:String: The type of signature that is being used

Exceptions

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

signalAuthenticationExhausted back to summary

signalAuthenticationExhausted	back to summary
public default void signalAuthenticationExhausted(ClientSession session, String service) throws Exception Signals end of public key attempts and optionally switching to other authentication methods Note neither `signalAuthenticationSuccess` nor `signalAuthenticationFailure` are invoked. Parameters session:ClientSession The `ClientSession` service:String The requesting service name Exceptions Exception: If failed to handle the callback - Note: may cause session close

public default void signalAuthenticationExhausted(ClientSession session, String service) throws Exception

Signals end of public key attempts and optionally switching to other authentication methods

Note

neither signalAuthenticationSuccess nor signalAuthenticationFailure are invoked.

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name

Exceptions

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

signalAuthenticationFailure back to summary

signalAuthenticationFailure	back to summary
public default void signalAuthenticationFailure(ClientSession session, String service, KeyPair identity, boolean partial, List<String> serverMethods) throws Exception Parameters session:ClientSession The `ClientSession` service:String The requesting service name identity:KeyPair The `KeyPair` identity being attempted - Note: for agent based authentications the private key may be `null` partial:boolean `true` if some partial authentication success so far serverMethods:List<String> The `List` of authentication methods that can continue Exceptions Exception: If failed to handle the callback - Note: may cause session close

public default void signalAuthenticationFailure(ClientSession session, String service, KeyPair identity, boolean partial, List<String> serverMethods) throws Exception

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
identity:KeyPair: The KeyPair identity being attempted - Note: for agent based authentications the private key may be null
partial:boolean: true if some partial authentication success so far
serverMethods:List<String>: The List of authentication methods that can continue

Exceptions

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

signalAuthenticationSuccess back to summary

signalAuthenticationSuccess	back to summary
public default void signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity) throws Exception Parameters session:ClientSession The `ClientSession` service:String The requesting service name identity:KeyPair The `KeyPair` identity being attempted - Note: for agent based authentications the private key may be `null` Exceptions Exception: If failed to handle the callback - Note: may cause session close

public default void signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity) throws Exception

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
identity:KeyPair: The KeyPair identity being attempted - Note: for agent based authentications the private key may be null

Exceptions

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

signalIdentitySkipped back to summary

signalIdentitySkipped	back to summary
public default void signalIdentitySkipped(ClientSession session, String service, KeyPair identity) throws Exception A `KeyPair` is is present, but is not attempted because no signature factory for it could be found. Parameters session:ClientSession The `ClientSession` service:String The requesting service name identity:KeyPair The `KeyPair` identity being skipped - Note: for agent based authentications the private key may be `null` Exceptions Exception: If failed to handle the callback - Note: may cause session close

public default void signalIdentitySkipped(ClientSession session, String service, KeyPair identity) throws Exception

A KeyPair is is present, but is not attempted because no signature factory for it could be found.

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
identity:KeyPair: The KeyPair identity being skipped - Note: for agent based authentications the private key may be null

Exceptions

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

signalSignatureAttempt back to summary

signalSignatureAttempt	back to summary
public default void signalSignatureAttempt(ClientSession session, String service, KeyPair identity, String signature, byte[] signed) throws Exception Sending the signed response to the server's challenge Parameters session:ClientSession The `ClientSession` service:String The requesting service name identity:KeyPair The `KeyPair` identity being attempted - Note: for agent based authentications the private key may be `null` signature:String The type of signature that is being used signed:byte[] The generated signature data Exceptions Exception: If failed to handle the callback - Note: may cause session close

public default void signalSignatureAttempt(ClientSession session, String service, KeyPair identity, String signature, byte[] signed) throws Exception

Sending the signed response to the server's challenge

Parameters

session:ClientSession: The ClientSession
service:String: The requesting service name
identity:KeyPair: The KeyPair identity being attempted - Note: for agent based authentications the private key may be null
signature:String: The type of signature that is being used
signed:byte[]: The generated signature data

Exceptions

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

public Interface PublicKeyAuthenticationReporter

Method Summary

Method Detail