Package io.undertow.security.impl
Class ExternalAuthenticationMechanism
java.lang.Object
io.undertow.security.impl.ExternalAuthenticationMechanism
- All Implemented Interfaces:
AuthenticationMechanism
Authentication mechanism that uses an externally provided principal.
WARNING: This method performs no verification. It must only be used if there is no
way for an end user to modify the principal, for example if Undertow is behind a
front end server that is responsible for authentication.
- Author:
- Stuart Douglas
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface io.undertow.security.api.AuthenticationMechanism
AuthenticationMechanism.AuthenticationMechanismOutcome, AuthenticationMechanism.ChallengeResult
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final AttachmentKey<String>
static final AttachmentKey<String>
static final AuthenticationMechanismFactory
static final String
-
Constructor Summary
ConstructorsConstructorDescriptionExternalAuthenticationMechanism
(String name, 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
-
NAME
- See Also:
-
EXTERNAL_PRINCIPAL
-
EXTERNAL_AUTHENTICATION_TYPE
-
-
Constructor Details
-
ExternalAuthenticationMechanism
-
ExternalAuthenticationMechanism
-
ExternalAuthenticationMechanism
public ExternalAuthenticationMechanism()
-
-
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.
-