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

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

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

公開メンバ関数
	AbstractUndertowKeycloakAuthMech (AdapterDeploymentContext deploymentContext, UndertowUserSessionManagement sessionManagement, String errorPage)
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)

限定公開変数類
AdapterDeploymentContext	deploymentContext
UndertowUserSessionManagement	sessionManagement
String	errorPage

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

詳解

Abstract base class for a Keycloak-enabled Undertow AuthenticationMechanism.

著者

Stan Silvert ssilv.nosp@m.ert@.nosp@m.redha.nosp@m.t.co.nosp@m.m (C) 2014 Red Hat Inc.

構築子と解体子

AbstractUndertowKeycloakAuthMech()

org.keycloak.adapters.undertow.AbstractUndertowKeycloakAuthMech.AbstractUndertowKeycloakAuthMech ( AdapterDeploymentContext  deploymentContext, UndertowUserSessionManagement  sessionManagement, String  errorPage  )

inline

                                                                                                                                                           {
        this.deploymentContext = deploymentContext;
        this.sessionManagement = sessionManagement;
        this.errorPage = errorPage;
    }

関数詳解

createFacade()

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

inline

                                                                        {
        return new OIDCUndertowHttpFacade(exchange);
    }

getTokenStore()

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

inlineprotected

                                                                                                                                                              {
        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  )

inlineprotected

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 )

inlineprotected

                                                                                {

        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  )

inline

                                                                                                       {
        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  )

inlinestaticpackage

                                                                                       {
        // 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  )

inlineprotected

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

メンバ詳解

deploymentContext

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

protected

errorPage

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

protected

KEYCLOAK_CHALLENGE_ATTACHMENT_KEY

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

static

sessionManagement

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

protected

---

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

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