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

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

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

公開メンバ関数
	ServletKeycloakAuthMech (AdapterDeploymentContext deploymentContext, UndertowUserSessionManagement userSessionManagement, NodesRegistrationManagement nodesRegistrationManagement, ConfidentialPortManager portManager, String errorPage)
AuthenticationMechanismOutcome	authenticate (HttpServerExchange exchange, SecurityContext securityContext)
UndertowHttpFacade	createFacade (HttpServerExchange exchange)
ChallengeResult	sendChallenge (HttpServerExchange exchange, SecurityContext securityContext)

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

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

限定公開変数類
NodesRegistrationManagement	nodesRegistrationManagement
ConfidentialPortManager	portManager
AdapterDeploymentContext	deploymentContext
UndertowUserSessionManagement	sessionManagement
String	errorPage

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

静的非公開変数類
static final Logger	log = Logger.getLogger(ServletKeycloakAuthMech.class)

詳解

著者

Bill Burke

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

バージョン

Revision

1

構築子と解体子

ServletKeycloakAuthMech()

org.keycloak.adapters.undertow.ServletKeycloakAuthMech.ServletKeycloakAuthMech ( AdapterDeploymentContext  deploymentContext, UndertowUserSessionManagement  userSessionManagement, NodesRegistrationManagement  nodesRegistrationManagement, ConfidentialPortManager  portManager, String  errorPage  )

inline

                                                     {
        super(deploymentContext, userSessionManagement, errorPage);
        this.nodesRegistrationManagement = nodesRegistrationManagement;
        this.portManager = portManager;
    }

関数詳解

authenticate()

AuthenticationMechanismOutcome org.keycloak.adapters.undertow.ServletKeycloakAuthMech.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);

        RequestAuthenticator authenticator = createRequestAuthenticator(deployment, exchange, securityContext, facade);

        return keycloakAuthenticate(exchange, securityContext, authenticator);
    }

createFacade()

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

inline

                                                                        {
        return new OIDCServletUndertowHttpFacade(exchange);
    }

createRequestAuthenticator()

RequestAuthenticator org.keycloak.adapters.undertow.ServletKeycloakAuthMech.createRequestAuthenticator ( KeycloakDeployment  deployment, HttpServerExchange  exchange, SecurityContext  securityContext, UndertowHttpFacade  facade  )

inlineprotected

                                                                                                                                                                                      {

        int confidentialPort = getConfidentilPort(exchange);
        AdapterTokenStore tokenStore = getTokenStore(exchange, facade, deployment, securityContext);
        return new ServletRequestAuthenticator(facade, deployment,
                confidentialPort, securityContext, exchange, tokenStore);
    }

getConfidentilPort()

int org.keycloak.adapters.undertow.ServletKeycloakAuthMech.getConfidentilPort ( HttpServerExchange  exchange )

inlineprotected

                                                                  {
        int confidentialPort = 8443;
        if (exchange.getRequestScheme().equalsIgnoreCase("HTTPS")) {
            confidentialPort = exchange.getHostPort();
        } else if (portManager != null) {
            confidentialPort = portManager.getConfidentialPort(exchange);
        }
        return confidentialPort;
    }

getTokenStore()

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

inlineprotected

                                                                                                                                                              {
        if (deployment.getTokenStore() == TokenStore.SESSION) {
            return new ServletSessionTokenStore(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.ServletKeycloakAuthMech.servePage ( HttpServerExchange  exchange, String  location  )

inlineprotected

                                                                              {
        final ServletRequestContext servletRequestContext = exchange.getAttachment(ServletRequestContext.ATTACHMENT_KEY);
        ServletRequest req = servletRequestContext.getServletRequest();
        ServletResponse resp = servletRequestContext.getServletResponse();
        RequestDispatcher disp = req.getRequestDispatcher(location);
        //make sure the login page is never cached
        exchange.getResponseHeaders().add(Headers.CACHE_CONTROL, "no-cache, no-store, must-revalidate");
        exchange.getResponseHeaders().add(Headers.PRAGMA, "no-cache");
        exchange.getResponseHeaders().add(Headers.EXPIRES, "0");


        try {
            disp.forward(req, resp);
        } catch (ServletException e) {
            throw new RuntimeException(e);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return null;
    }

メンバ詳解

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

log

final Logger org.keycloak.adapters.undertow.ServletKeycloakAuthMech.log = Logger.getLogger(ServletKeycloakAuthMech.class)

staticprivate

nodesRegistrationManagement

NodesRegistrationManagement org.keycloak.adapters.undertow.ServletKeycloakAuthMech.nodesRegistrationManagement

protected

portManager

ConfidentialPortManager org.keycloak.adapters.undertow.ServletKeycloakAuthMech.portManager

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/ServletKeycloakAuthMech.java