org.keycloak.protocol.RestartLoginCookie クラス

org.keycloak.protocol.RestartLoginCookie の継承関係図

org.keycloak.protocol.RestartLoginCookie 連携図

公開メンバ関数
Map< String, String >	getNotes ()
void	setNotes (Map< String, String > notes)
String	getClientId ()
void	setClientId (String clientId)
String	getAuthMethod ()
void	setAuthMethod (String authMethod)
String	getRedirectUri ()
void	setRedirectUri (String redirectUri)
String	getAction ()
void	setAction (String action)
	RestartLoginCookie ()
	RestartLoginCookie (AuthenticationSessionModel authSession)
TokenCategory	getCategory ()

静的公開メンバ関数
static void	setRestartCookie (KeycloakSession session, RealmModel realm, ClientConnection connection, UriInfo uriInfo, AuthenticationSessionModel authSession)
static void	expireRestartCookie (RealmModel realm, ClientConnection connection, UriInfo uriInfo)
static AuthenticationSessionModel	restartSession (KeycloakSession session, RealmModel realm, RootAuthenticationSessionModel rootSession, String expectedClientId) throws Exception

静的公開変数類
static final String	KC_RESTART = "KC_RESTART"

限定公開変数類
String	clientId
String	authMethod
String	redirectUri
String	action
Map< String, String >	notes = new HashMap<>()
String	cs

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

詳解

This is an an encoded token that is stored as a cookie so that if there is a client timeout, then the authentication session can be restarted.

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

RestartLoginCookie() [1/2]

org.keycloak.protocol.RestartLoginCookie.RestartLoginCookie ( )

inline

                                {
    }

RestartLoginCookie() [2/2]

org.keycloak.protocol.RestartLoginCookie.RestartLoginCookie ( AuthenticationSessionModel  authSession )

inline

                                                                      {
        this.action = authSession.getAction();
        this.clientId = authSession.getClient().getClientId();
        this.authMethod = authSession.getProtocol();
        this.redirectUri = authSession.getRedirectUri();
        for (Map.Entry<String, String> entry : authSession.getClientNotes().entrySet()) {
            notes.put(entry.getKey(), entry.getValue());
        }
    }

関数詳解

expireRestartCookie()

static void org.keycloak.protocol.RestartLoginCookie.expireRestartCookie ( RealmModel  realm, ClientConnection  connection, UriInfo  uriInfo  )

inlinestatic

                                                                                                           {
        String path = AuthenticationManager.getRealmCookiePath(realm, uriInfo);
        boolean secureOnly = realm.getSslRequired().isRequired(connection);
        CookieHelper.addCookie(KC_RESTART, "", path, null, null, 0, secureOnly, true);
    }

getAction()

String org.keycloak.protocol.RestartLoginCookie.getAction ( )

inline

                              {
        return action;
    }

getAuthMethod()

String org.keycloak.protocol.RestartLoginCookie.getAuthMethod ( )

inline

                                  {
        return authMethod;
    }

getCategory()

TokenCategory org.keycloak.protocol.RestartLoginCookie.getCategory ( )

inline

                                       {
        return TokenCategory.INTERNAL;
    }

getClientId()

String org.keycloak.protocol.RestartLoginCookie.getClientId ( )

inline

                                {
        return clientId;
    }

getNotes()

Map<String, String> org.keycloak.protocol.RestartLoginCookie.getNotes ( )

inline

                                          {
        return notes;
    }

getRedirectUri()

String org.keycloak.protocol.RestartLoginCookie.getRedirectUri ( )

inline

                                   {
        return redirectUri;
    }

restartSession()

static AuthenticationSessionModel org.keycloak.protocol.RestartLoginCookie.restartSession ( KeycloakSession  session, RealmModel  realm, RootAuthenticationSessionModel  rootSession, String  expectedClientId  ) throws Exception

inlinestatic

                                                                                                                                                  {
        Cookie cook = session.getContext().getRequestHeaders().getCookies().get(KC_RESTART);
        if (cook ==  null) {
            logger.debug("KC_RESTART cookie doesn't exist");
            return null;
        }
        String encodedCookie = cook.getValue();

        RestartLoginCookie cookie = session.tokens().decode(encodedCookie, RestartLoginCookie.class);
        if (cookie == null) {
            logger.debug("Failed to verify encoded RestartLoginCookie");
            return null;
        }

        ClientModel client = realm.getClientByClientId(cookie.getClientId());
        if (client == null) return null;

        // Restart just if client from cookie matches client from the URL.
        if (!client.getClientId().equals(expectedClientId)) {
            logger.debugf("Skip restarting from the KC_RESTART. Clients doesn't match: Cookie client: %s, Requested client: %s", client.getClientId(), expectedClientId);
            return null;
        }

        // Need to create brand new session and setup cookie
        if (rootSession == null) {
            rootSession = new AuthenticationSessionManager(session).createAuthenticationSession(realm, true);
        }

        AuthenticationSessionModel authSession = rootSession.createAuthenticationSession(client);
        authSession.setProtocol(cookie.getAuthMethod());
        authSession.setRedirectUri(cookie.getRedirectUri());
        authSession.setAction(cookie.getAction());
        for (Map.Entry<String, String> entry : cookie.getNotes().entrySet()) {
            authSession.setClientNote(entry.getKey(), entry.getValue());
        }

        return authSession;
    }

setAction()

void org.keycloak.protocol.RestartLoginCookie.setAction ( String  action )

inline

                                         {
        this.action = action;
    }

setAuthMethod()

void org.keycloak.protocol.RestartLoginCookie.setAuthMethod ( String  authMethod )

inline

                                                 {
        this.authMethod = authMethod;
    }

setClientId()

void org.keycloak.protocol.RestartLoginCookie.setClientId ( String  clientId )

inline

                                             {
        this.clientId = clientId;
    }

setNotes()

void org.keycloak.protocol.RestartLoginCookie.setNotes ( Map< String, String >  notes )

inline

                                                    {
        this.notes = notes;
    }

setRedirectUri()

void org.keycloak.protocol.RestartLoginCookie.setRedirectUri ( String  redirectUri )

inline

                                                   {
        this.redirectUri = redirectUri;
    }

setRestartCookie()

static void org.keycloak.protocol.RestartLoginCookie.setRestartCookie ( KeycloakSession  session, RealmModel  realm, ClientConnection  connection, UriInfo  uriInfo, AuthenticationSessionModel  authSession  )

inlinestatic

                                                                                                                                                                         {
        RestartLoginCookie restart = new RestartLoginCookie(authSession);
        String encoded = session.tokens().encode(restart);
        String path = AuthenticationManager.getRealmCookiePath(realm, uriInfo);
        boolean secureOnly = realm.getSslRequired().isRequired(connection);
        CookieHelper.addCookie(KC_RESTART, encoded, path, null, null, -1, secureOnly, true);
    }

メンバ詳解

action

String org.keycloak.protocol.RestartLoginCookie.action

protected

authMethod

String org.keycloak.protocol.RestartLoginCookie.authMethod

protected

clientId

String org.keycloak.protocol.RestartLoginCookie.clientId

protected

cs

String org.keycloak.protocol.RestartLoginCookie.cs

protected

KC_RESTART

final String org.keycloak.protocol.RestartLoginCookie.KC_RESTART = "KC_RESTART"

static

logger

final Logger org.keycloak.protocol.RestartLoginCookie.logger = Logger.getLogger(RestartLoginCookie.class)

staticprivate

notes

Map<String, String> org.keycloak.protocol.RestartLoginCookie.notes = new HashMap<>()

protected

redirectUri

String org.keycloak.protocol.RestartLoginCookie.redirectUri

protected

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/protocol/RestartLoginCookie.java