Interface PublicKeyAuthenticationReporter
public interface PublicKeyAuthenticationReporter
Provides report about the client side public key authentication progress
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondefault voidsignalAuthenticationAttempt(ClientSession session, String service, KeyPair identity, String signature) Sending the initial request to use public key authenticationdefault voidsignalAuthenticationExhausted(ClientSession session, String service) Signals end of public key attempts and optionally switching to other authentication methods.default voidsignalAuthenticationFailure(ClientSession session, String service, KeyPair identity, boolean partial, List<String> serverMethods) default voidsignalAuthenticationSuccess(ClientSession session, String service, KeyPair identity) default voidsignalIdentitySkipped(ClientSession session, String service, KeyPair identity) AKeyPairis is present, but is not attempted because no signature factory for it could be found.default voidsignalSignatureAttempt(ClientSession session, String service, KeyPair identity, String signature, byte[] signed) Sending the signed response to the server's challenge
-
Method Details
-
signalAuthenticationAttempt
default void signalAuthenticationAttempt(ClientSession session, String service, KeyPair identity, String signature) throws Exception Sending the initial request to use public key authentication- Parameters:
session- TheClientSessionservice- The requesting service nameidentity- TheKeyPairidentity being attempted - Note: for agent based authentications the private key may benullsignature- The type of signature that is being used- Throws:
Exception- If failed to handle the callback - Note: may cause session close
-
signalAuthenticationExhausted
Signals end of public key attempts and optionally switching to other authentication methods. Note: neithersignalAuthenticationSuccessnorsignalAuthenticationFailureare invoked.- Parameters:
session- TheClientSessionservice- The requesting service name- Throws:
Exception- If failed to handle the callback - Note: may cause session close
-
signalIdentitySkipped
default void signalIdentitySkipped(ClientSession session, String service, KeyPair identity) throws Exception AKeyPairis is present, but is not attempted because no signature factory for it could be found.- Parameters:
session- TheClientSessionservice- The requesting service nameidentity- TheKeyPairidentity being skipped - Note: for agent based authentications the private key may benull- Throws:
Exception- If failed to handle the callback - Note: may cause session close
-
signalSignatureAttempt
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- TheClientSessionservice- The requesting service nameidentity- TheKeyPairidentity being attempted - Note: for agent based authentications the private key may benullsignature- The type of signature that is being usedsigned- The generated signature data- Throws:
Exception- If failed to handle the callback - Note: may cause session close
-
signalAuthenticationSuccess
default void signalAuthenticationSuccess(ClientSession session, String service, KeyPair identity) throws Exception - Parameters:
session- TheClientSessionservice- The requesting service nameidentity- TheKeyPairidentity being attempted - Note: for agent based authentications the private key may benull- Throws:
Exception- If failed to handle the callback - Note: may cause session close
-
signalAuthenticationFailure
default void signalAuthenticationFailure(ClientSession session, String service, KeyPair identity, boolean partial, List<String> serverMethods) throws Exception - Parameters:
session- TheClientSessionservice- The requesting service nameidentity- TheKeyPairidentity being attempted - Note: for agent based authentications the private key may benullpartial-trueif some partial authentication success so farserverMethods- TheListof authentication methods that can continue- Throws:
Exception- If failed to handle the callback - Note: may cause session close
-