org.keycloak.authentication.actiontoken.DefaultActionToken クラス

org.keycloak.authentication.actiontoken.DefaultActionToken の継承関係図

org.keycloak.authentication.actiontoken.DefaultActionToken 連携図

公開メンバ関数
	DefaultActionToken ()
String	getCompoundAuthenticationSessionId ()
final void	setCompoundAuthenticationSessionId (String authenticationSessionId)
Map< String, String >	getNotes ()
String	getNote (String name)
final String	setNote (String name, String value)
final String	removeNote (String name)
String	serialize (KeycloakSession session, RealmModel realm, UriInfo uri)
String	getUserId ()
String	getActionId ()
UUID	getActionVerificationNonce ()
int	getExpiration ()
default String	serializeKey ()

静的公開メンバ関数
static DefaultActionTokenKey	from (String serializedKey)

静的公開変数類
static final String	JSON_FIELD_AUTHENTICATION_SESSION_ID = "asid"
static final Predicate< DefaultActionTokenKey >	ACTION_TOKEN_BASIC_CHECKS
static final String	ACTION_TOKEN_USER_ID = "ACTION_TOKEN_USER"
static final String	JSON_FIELD_ACTION_VERIFICATION_NONCE = "nonce"

限定公開メンバ関数
	DefaultActionToken (String userId, String actionId, int absoluteExpirationInSecs, UUID actionVerificationNonce)
	DefaultActionToken (String userId, String actionId, int absoluteExpirationInSecs, UUID actionVerificationNonce, String compoundAuthenticationSessionId)

静的非公開メンバ関数
static String	getIssuer (RealmModel realm, UriInfo uri)

詳解

Part of action token that is intended to be used e.g. in link sent in password-reset email. The token encapsulates user, expected action and its time of expiry.

著者

hmlnarik

構築子と解体子

DefaultActionToken() [1/3]

org.keycloak.authentication.actiontoken.DefaultActionToken.DefaultActionToken ( )

inline

Single-use random value used for verification whether the relevant action is allowed.

                                {
        super(null, null, 0, null);
    }

DefaultActionToken() [2/3]

org.keycloak.authentication.actiontoken.DefaultActionToken.DefaultActionToken ( String  userId, String  actionId, int  absoluteExpirationInSecs, UUID  actionVerificationNonce  )

inlineprotected

引数

userId	User ID
actionId	Action ID
absoluteExpirationInSecs	Absolute expiration time in seconds in timezone of Keycloak.
actionVerificationNonce

                                                                                                                             {
        super(userId, actionId, absoluteExpirationInSecs, actionVerificationNonce);
    }

DefaultActionToken() [3/3]

org.keycloak.authentication.actiontoken.DefaultActionToken.DefaultActionToken ( String  userId, String  actionId, int  absoluteExpirationInSecs, UUID  actionVerificationNonce, String  compoundAuthenticationSessionId  )

inlineprotected

引数

userId	User ID
actionId	Action ID
absoluteExpirationInSecs	Absolute expiration time in seconds in timezone of Keycloak.
actionVerificationNonce

                                                                                                                                                                     {
        super(userId, actionId, absoluteExpirationInSecs, actionVerificationNonce);
        setCompoundAuthenticationSessionId(compoundAuthenticationSessionId);
    }

関数詳解

from()

static DefaultActionTokenKey org.keycloak.authentication.actiontoken.DefaultActionTokenKey.from ( String  serializedKey )

inlinestaticinherited

                                                                   {
        if (serializedKey == null) {
            return null;
        }
        String[] parsed = DOT.split(serializedKey, 4);
        if (parsed.length != 4) {
            return null;
        }

        String userId;
        try {
            userId = new String(Base64.decode(parsed[0]), StandardCharsets.UTF_8);
        } catch (IOException ex) {
            userId = parsed[0];
        }
        return new DefaultActionTokenKey(userId, parsed[3], Integer.parseInt(parsed[1]), UUID.fromString(parsed[2]));
    }

getActionId()

String org.keycloak.authentication.actiontoken.DefaultActionTokenKey.getActionId ( )

inlineinherited

org.keycloak.models.ActionTokenKeyModelを実装しています。

                                {
        return getType();
    }

getActionVerificationNonce()

UUID org.keycloak.authentication.actiontoken.DefaultActionTokenKey.getActionVerificationNonce ( )

inlineinherited

org.keycloak.models.ActionTokenKeyModelを実装しています。

                                             {
        return actionVerificationNonce;
    }

getCompoundAuthenticationSessionId()

String org.keycloak.authentication.actiontoken.DefaultActionToken.getCompoundAuthenticationSessionId ( )

inline

                                                       {
        return (String) getOtherClaims().get(JSON_FIELD_AUTHENTICATION_SESSION_ID);
    }

getExpiration()

int org.keycloak.models.ActionTokenKeyModel.getExpiration ( )

inherited

Returns absolute number of seconds since the epoch in UTC timezone when the token expires.

getIssuer()

static String org.keycloak.authentication.actiontoken.DefaultActionToken.getIssuer ( RealmModel  realm, UriInfo  uri  )

inlinestaticprivate

                                                                   {
        return Urls.realmIssuer(uri.getBaseUri(), realm.getName());
    }

getNote()

String org.keycloak.authentication.actiontoken.DefaultActionToken.getNote ( String  name )

inline

org.keycloak.models.ActionTokenValueModelを実装しています。

                                       {
        Object res = getOtherClaims().get(name);
        return res instanceof String ? (String) res : null;
    }

getNotes()

Map<String, String> org.keycloak.authentication.actiontoken.DefaultActionToken.getNotes ( )

inline

org.keycloak.models.ActionTokenValueModelを実装しています。

                                          {
        Map<String, String> res = new HashMap<>();
        if (getCompoundAuthenticationSessionId() != null) {
            res.put(JSON_FIELD_AUTHENTICATION_SESSION_ID, getCompoundAuthenticationSessionId());
        }
        return res;
    }

getUserId()

String org.keycloak.authentication.actiontoken.DefaultActionTokenKey.getUserId ( )

inlineinherited

org.keycloak.models.ActionTokenKeyModelを実装しています。

                              {
        return getSubject();
    }

removeNote()

final String org.keycloak.authentication.actiontoken.DefaultActionToken.removeNote ( String  name )

inline

Removes given note, and returns original value (or

null 

when no value was present)

戻り値

see description

                                                {
        Object res = getOtherClaims().remove(name);
        return res instanceof String ? (String) res : null;
    }

serialize()

String org.keycloak.authentication.actiontoken.DefaultActionToken.serialize ( KeycloakSession  session, RealmModel  realm, UriInfo  uri  )

inline

Updates the following fields and serializes this token into a signed JWT. The list of updated fields follows:

• id 

  : random nonce

• issuedAt 

  : Current time

• issuer 

  : URI of the given realm

• audience 

  : URI of the given realm (same as issuer)

引数

session
realm
uri

戻り値

                                                                                    {
        String issuerUri = getIssuer(realm, uri);

        this
          .issuedAt(Time.currentTime())
          .id(getActionVerificationNonce().toString())
          .issuer(issuerUri)
          .audience(issuerUri);

        return session.tokens().encode(this);
    }

serializeKey()

default String org.keycloak.models.ActionTokenKeyModel.serializeKey ( )

inlineinherited

                                  {
        String userId = getUserId();
        String encodedUserId = userId == null ? "" : Base64.encodeBytes(userId.getBytes(StandardCharsets.UTF_8));
        return String.format("%s.%d.%s.%s", encodedUserId, getExpiration(), getActionVerificationNonce(), getActionId());
    }

setCompoundAuthenticationSessionId()

final void org.keycloak.authentication.actiontoken.DefaultActionToken.setCompoundAuthenticationSessionId ( String  authenticationSessionId )

inline

                                                                                         {
        setOtherClaims(JSON_FIELD_AUTHENTICATION_SESSION_ID, authenticationSessionId);
    }

setNote()

final String org.keycloak.authentication.actiontoken.DefaultActionToken.setNote ( String  name, String  value  )

inline

Sets value of the given note

戻り値

original value (or

null 

when no value was present)

                                                           {
        Object res = value == null
          ? getOtherClaims().remove(name)
          : getOtherClaims().put(name, value);
        return res instanceof String ? (String) res : null;
    }

メンバ詳解

ACTION_TOKEN_BASIC_CHECKS

final Predicate<DefaultActionTokenKey> org.keycloak.authentication.actiontoken.DefaultActionToken.ACTION_TOKEN_BASIC_CHECKS

static

初期値:

= t -> {
        if (t.getActionVerificationNonce() == null) {
            throw new VerificationException("Nonce not present.");
        }

        return true;
    }

ACTION_TOKEN_USER_ID

final String org.keycloak.authentication.actiontoken.DefaultActionTokenKey.ACTION_TOKEN_USER_ID = "ACTION_TOKEN_USER"

staticinherited

The authenticationSession note with ID of the user authenticated via the action token

JSON_FIELD_ACTION_VERIFICATION_NONCE

final String org.keycloak.authentication.actiontoken.DefaultActionTokenKey.JSON_FIELD_ACTION_VERIFICATION_NONCE = "nonce"

staticinherited

JSON_FIELD_AUTHENTICATION_SESSION_ID

final String org.keycloak.authentication.actiontoken.DefaultActionToken.JSON_FIELD_AUTHENTICATION_SESSION_ID = "asid"

static

---

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

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/authentication/actiontoken/DefaultActionToken.java