org.keycloak.adapters.undertow.UndertowAuthenticationMechanism クラス

org.keycloak.adapters.undertow.UndertowAuthenticationMechanism の継承関係図

org.keycloak.adapters.undertow.UndertowAuthenticationMechanism 連携図

公開メンバ関数
	UndertowAuthenticationMechanism (AdapterDeploymentContext deploymentContext, UndertowUserSessionManagement sessionManagement, NodesRegistrationManagement nodesRegistrationManagement, int confidentialPort, String errorPage)
AuthenticationMechanismOutcome	authenticate (HttpServerExchange exchange, SecurityContext securityContext)
ChallengeResult	sendChallenge (HttpServerExchange exchange, SecurityContext securityContext)
UndertowHttpFacade	createFacade (HttpServerExchange exchange)

静的公開変数類
static final AttachmentKey< AuthChallenge >	KEYCLOAK_CHALLENGE_ATTACHMENT_KEY = AttachmentKey.create(AuthChallenge.class)

限定公開メンバ関数
Integer	servePage (final HttpServerExchange exchange, final String location)
void	registerNotifications (final SecurityContext securityContext)
AuthenticationMechanismOutcome	keycloakAuthenticate (HttpServerExchange exchange, SecurityContext securityContext, RequestAuthenticator authenticator)
AdapterTokenStore	getTokenStore (HttpServerExchange exchange, HttpFacade facade, KeycloakDeployment deployment, SecurityContext securityContext)

限定公開変数類
NodesRegistrationManagement	nodesRegistrationManagement
int	confidentialPort
AdapterDeploymentContext	deploymentContext
UndertowUserSessionManagement	sessionManagement
String	errorPage

静的関数
static void	sendRedirect (final HttpServerExchange exchange, final String location)

詳解

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

UndertowAuthenticationMechanism()

org.keycloak.adapters.undertow.UndertowAuthenticationMechanism.UndertowAuthenticationMechanism ( AdapterDeploymentContext  deploymentContext, UndertowUserSessionManagement  sessionManagement, NodesRegistrationManagement  nodesRegistrationManagement, int  confidentialPort, String  errorPage  )

inline

                                                                                                                                            {
        super(deploymentContext, sessionManagement, errorPage);
        this.nodesRegistrationManagement = nodesRegistrationManagement;
        this.confidentialPort = confidentialPort;
    }

関数詳解

authenticate()

AuthenticationMechanismOutcome org.keycloak.adapters.undertow.UndertowAuthenticationMechanism.authenticate ( HttpServerExchange  exchange, SecurityContext  securityContext  )

inline

                                                                                                                     {
        UndertowHttpFacade facade = createFacade(exchange);
        KeycloakDeployment deployment = deploymentContext.resolveDeployment(facade);
        if (!deployment.isConfigured()) {
            return AuthenticationMechanismOutcome.NOT_ATTEMPTED;
        }

        nodesRegistrationManagement.tryRegister(deployment);

        AdapterTokenStore tokenStore = getTokenStore(exchange, facade, deployment, securityContext);
        RequestAuthenticator authenticator = new UndertowRequestAuthenticator(facade, deployment, confidentialPort, securityContext, exchange, tokenStore);

        return keycloakAuthenticate(exchange, securityContext, authenticator);
    }

createFacade()

UndertowHttpFacade org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.createFacade ( HttpServerExchange  exchange )

inlineinherited

                                                                        {
        return new OIDCUndertowHttpFacade(exchange);
    }

getTokenStore()

AdapterTokenStore org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.getTokenStore ( HttpServerExchange  exchange, HttpFacade  facade, KeycloakDeployment  deployment, SecurityContext  securityContext  )

inlineprotectedinherited

                                                                                                                                                              {
        if (deployment.getTokenStore() == TokenStore.SESSION) {
            return new UndertowSessionTokenStore(exchange, deployment, sessionManagement, securityContext);
        } else {
            return new UndertowCookieTokenStore(facade, deployment, securityContext);
        }
    }

keycloakAuthenticate()

AuthenticationMechanismOutcome org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.keycloakAuthenticate ( HttpServerExchange  exchange, SecurityContext  securityContext, RequestAuthenticator  authenticator  )

inlineprotectedinherited

Call this inside your authenticate method.

                                                                                                                                                                    {
        AuthOutcome outcome = authenticator.authenticate();
        if (outcome == AuthOutcome.AUTHENTICATED) {
            registerNotifications(securityContext);
            return AuthenticationMechanismOutcome.AUTHENTICATED;
        }
        AuthChallenge challenge = authenticator.getChallenge();
        if (challenge != null) {
            exchange.putAttachment(KEYCLOAK_CHALLENGE_ATTACHMENT_KEY, challenge);
        }

        if (outcome == AuthOutcome.FAILED) {
            return AuthenticationMechanismOutcome.NOT_AUTHENTICATED;
        }
        return AuthenticationMechanismOutcome.NOT_ATTEMPTED;
    }

registerNotifications()

void org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.registerNotifications ( final SecurityContext  securityContext )

inlineprotectedinherited

                                                                                {

        final NotificationReceiver logoutReceiver = new NotificationReceiver() {
            @Override
            public void handleNotification(SecurityNotification notification) {
                if (notification.getEventType() != SecurityNotification.EventType.LOGGED_OUT) return;

                HttpServerExchange exchange = notification.getExchange();
                UndertowHttpFacade facade = createFacade(exchange);
                KeycloakDeployment deployment = deploymentContext.resolveDeployment(facade);
                KeycloakSecurityContext ksc = exchange.getAttachment(OIDCUndertowHttpFacade.KEYCLOAK_SECURITY_CONTEXT_KEY);
                if (!deployment.isBearerOnly() && ksc != null && ksc instanceof RefreshableKeycloakSecurityContext) {
                    ((RefreshableKeycloakSecurityContext) ksc).logout(deployment);
                }
                AdapterTokenStore tokenStore = getTokenStore(exchange, facade, deployment, securityContext);
                tokenStore.logout();
            }
        };

        securityContext.registerNotificationReceiver(logoutReceiver);
    }

sendChallenge()

ChallengeResult org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.sendChallenge ( HttpServerExchange  exchange, SecurityContext  securityContext  )

inlineinherited

                                                                                                       {
        AuthChallenge challenge = exchange.getAttachment(KEYCLOAK_CHALLENGE_ATTACHMENT_KEY);
        if (challenge != null) {
            UndertowHttpFacade facade = createFacade(exchange);
            if (challenge.challenge(facade)) {
                return new ChallengeResult(true, exchange.getResponseCode());
            }
        }
        return new ChallengeResult(false);
    }

sendRedirect()

static void org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.sendRedirect ( final HttpServerExchange  exchange, final String  location  )

inlinestaticpackageinherited

                                                                                       {
        // TODO - String concatenation to construct URLS is extremely error prone - switch to a URI which will better handle this.
        String loc = exchange.getRequestScheme() + "://" + exchange.getHostAndPort() + location;
        exchange.getResponseHeaders().put(Headers.LOCATION, loc);
    }

servePage()

Integer org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.servePage ( final HttpServerExchange  exchange, final String  location  )

inlineprotectedinherited

                                                                                          {
        sendRedirect(exchange, location);
        return StatusCodes.TEMPORARY_REDIRECT;
    }

メンバ詳解

confidentialPort

int org.keycloak.adapters.undertow.UndertowAuthenticationMechanism.confidentialPort

protected

deploymentContext

AdapterDeploymentContext org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.deploymentContext

protectedinherited

errorPage

String org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.errorPage

protectedinherited

KEYCLOAK_CHALLENGE_ATTACHMENT_KEY

final AttachmentKey<AuthChallenge> org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.KEYCLOAK_CHALLENGE_ATTACHMENT_KEY = AttachmentKey.create(AuthChallenge.class)

staticinherited

nodesRegistrationManagement

NodesRegistrationManagement org.keycloak.adapters.undertow.UndertowAuthenticationMechanism.nodesRegistrationManagement

protected

sessionManagement

UndertowUserSessionManagement org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.sessionManagement

protectedinherited

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/keycloak/doxygen/src/adapters/oidc/undertow/src/main/java/org/keycloak/adapters/undertow/UndertowAuthenticationMechanism.java