Package io.undertow.security.impl
Class ClientCertAuthenticationMechanism
java.lang.Object
io.undertow.security.impl.ClientCertAuthenticationMechanism
- All Implemented Interfaces:
AuthenticationMechanism
The Client Cert based authentication mechanism.
When authenticate is called the current request is checked to see if it a SSL request, this is further checked to identify if the client has been verified at the SSL level.
- Author:
- Darran Lofthouse
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface io.undertow.security.api.AuthenticationMechanism
AuthenticationMechanism.AuthenticationMechanismOutcome, AuthenticationMechanism.ChallengeResult
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionClientCertAuthenticationMechanism
(boolean forceRenegotiation) ClientCertAuthenticationMechanism
(String mechanismName) ClientCertAuthenticationMechanism
(String mechanismName, boolean forceRenegotiation) ClientCertAuthenticationMechanism
(String mechanismName, boolean forceRenegotiation, IdentityManager identityManager) -
Method Summary
Modifier and TypeMethodDescriptionauthenticate
(HttpServerExchange exchange, SecurityContext securityContext) Perform authentication of the request.sendChallenge
(HttpServerExchange exchange, SecurityContext securityContext) Send an authentication challenge to the remote client.
-
Field Details
-
FACTORY
-
FORCE_RENEGOTIATION
- See Also:
-
-
Constructor Details
-
ClientCertAuthenticationMechanism
public ClientCertAuthenticationMechanism() -
ClientCertAuthenticationMechanism
public ClientCertAuthenticationMechanism(boolean forceRenegotiation) -
ClientCertAuthenticationMechanism
-
ClientCertAuthenticationMechanism
-
ClientCertAuthenticationMechanism
public ClientCertAuthenticationMechanism(String mechanismName, boolean forceRenegotiation, IdentityManager identityManager)
-
-
Method Details
-
authenticate
public AuthenticationMechanism.AuthenticationMechanismOutcome authenticate(HttpServerExchange exchange, SecurityContext securityContext) Description copied from interface:AuthenticationMechanism
Perform authentication of the request. Any potentially blocking work should be performed in the handoff executor provided- Specified by:
authenticate
in interfaceAuthenticationMechanism
- Parameters:
exchange
- The exchange- Returns:
-
sendChallenge
public AuthenticationMechanism.ChallengeResult sendChallenge(HttpServerExchange exchange, SecurityContext securityContext) Description copied from interface:AuthenticationMechanism
Send an authentication challenge to the remote client.The individual mechanisms should update the response headers and body of the message as appropriate however they should not set the response code, instead that should be indicated in the
AuthenticationMechanism.ChallengeResult
and the most appropriate overall response code will be selected. This method should not returnnull
.- Specified by:
sendChallenge
in interfaceAuthenticationMechanism
- Parameters:
exchange
- The exchangesecurityContext
- The security context- Returns:
- A
AuthenticationMechanism.ChallengeResult
indicating if a challenge was sent and the desired response code.
-