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

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

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

公開メンバ関数
	DefaultActionTokenKey ()
	DefaultActionTokenKey (String userId, String actionId, int absoluteExpirationInSecs, UUID actionVerificationNonce)
String	getUserId ()
String	getActionId ()
UUID	getActionVerificationNonce ()
JsonWebToken	id (String id)
JsonWebToken	expiration (int expiration)
JsonWebToken	notBefore (int notBefore)
JsonWebToken	issuedAt (int issuedAt)
JsonWebToken	issuer (String issuer)
JsonWebToken	audience (String... audience)
JsonWebToken	subject (String subject)
JsonWebToken	type (String type)
JsonWebToken	issuedFor (String issuedFor)
String	getId ()
int	getExpiration ()
boolean	isExpired ()
int	getNotBefore ()
boolean	isNotBefore (int allowedTimeSkew)
boolean	isActive ()
boolean	isActive (int allowedTimeSkew)
int	getIssuedAt ()
JsonWebToken	issuedNow ()
String	getIssuer ()
String []	getAudience ()
boolean	hasAudience (String audience)
JsonWebToken	addAudience (String audience)
String	getSubject ()
void	setSubject (String subject)
String	getType ()
String	getIssuedFor ()
Map< String, Object >	getOtherClaims ()
void	setOtherClaims (String name, Object value)
TokenCategory	getCategory ()
int	getExpiration ()
default String	serializeKey ()

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

公開変数類
String	issuedFor

静的公開変数類
static final String	ACTION_TOKEN_USER_ID = "ACTION_TOKEN_USER"
static final String	JSON_FIELD_ACTION_VERIFICATION_NONCE = "nonce"

限定公開変数類
String	id
int	expiration
int	notBefore
int	issuedAt
String	issuer
String []	audience
String	subject
String	type
Map< String, Object >	otherClaims = new HashMap<>()

非公開変数類
UUID	actionVerificationNonce

静的非公開変数類
static final Pattern	DOT = Pattern.compile("\\.")

詳解

著者

hmlnarik

構築子と解体子

DefaultActionTokenKey() [1/2]

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

inline

                                   {
    }

DefaultActionTokenKey() [2/2]

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

inline

                                                                                                                             {
        this.subject = userId;
        this.type = actionId;
        this.expiration = absoluteExpirationInSecs;
        this.actionVerificationNonce = actionVerificationNonce == null ? UUID.randomUUID() : actionVerificationNonce;
    }

関数詳解

addAudience()

JsonWebToken org.keycloak.representations.JsonWebToken.addAudience ( String  audience )

inlineinherited

                                                     {
        if (this.audience == null) {
            this.audience = new String[] { audience };
        } else {
            // Check if audience is already there
            for (String aud : this.audience) {
                if (audience.equals(aud)) {
                    return this;
                }
            }

            String[] newAudience = Arrays.copyOf(this.audience, this.audience.length + 1);
            newAudience[this.audience.length] = audience;
            this.audience = newAudience;
        }
        return this;
    }

audience()

JsonWebToken org.keycloak.representations.JsonWebToken.audience ( String...  audience )

inlineinherited

                                                     {
        this.audience = audience;
        return this;
    }

expiration()

JsonWebToken org.keycloak.representations.JsonWebToken.expiration ( int  expiration )

inlineinherited

                                                   {
        this.expiration = expiration;
        return this;
    }

from()

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

inlinestatic

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

inline

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

                                {
        return getType();
    }

getActionVerificationNonce()

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

inline

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

                                             {
        return actionVerificationNonce;
    }

getAudience()

String [] org.keycloak.representations.JsonWebToken.getAudience ( )

inlineinherited

                                  {
        return audience;
    }

getCategory()

TokenCategory org.keycloak.representations.JsonWebToken.getCategory ( )

inlineinherited

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

                                       {
        return TokenCategory.INTERNAL;
    }

getExpiration() [1/2]

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

inherited

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

getExpiration() [2/2]

int org.keycloak.representations.JsonWebToken.getExpiration ( )

inlineinherited

                               {
        return expiration;
    }

getId()

String org.keycloak.representations.JsonWebToken.getId ( )

inlineinherited

                          {
        return id;
    }

getIssuedAt()

int org.keycloak.representations.JsonWebToken.getIssuedAt ( )

inlineinherited

                             {
        return issuedAt;
    }

getIssuedFor()

String org.keycloak.representations.JsonWebToken.getIssuedFor ( )

inlineinherited

OAuth client the token was issued for.

戻り値

                                 {
        return issuedFor;
    }

getIssuer()

String org.keycloak.representations.JsonWebToken.getIssuer ( )

inlineinherited

                              {
        return issuer;
    }

getNotBefore()

int org.keycloak.representations.JsonWebToken.getNotBefore ( )

inlineinherited

                              {
        return notBefore;
    }

getOtherClaims()

Map<String, Object> org.keycloak.representations.JsonWebToken.getOtherClaims ( )

inlineinherited

This is a map of any other claims and data that might be in the IDToken. Could be custom claims set up by the auth server

戻り値

                                                {
        return otherClaims;
    }

getSubject()

String org.keycloak.representations.JsonWebToken.getSubject ( )

inlineinherited

                               {
        return subject;
    }

getType()

String org.keycloak.representations.JsonWebToken.getType ( )

inlineinherited

                            {
        return type;
    }

getUserId()

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

inline

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

                              {
        return getSubject();
    }

hasAudience()

boolean org.keycloak.representations.JsonWebToken.hasAudience ( String  audience )

inlineinherited

                                                {
        if (this.audience == null) return false;
        for (String a : this.audience) {
            if (a.equals(audience)) {
                return true;
            }
        }
        return false;
    }

id()

JsonWebToken org.keycloak.representations.JsonWebToken.id ( String  id )

inlineinherited

                                      {
        this.id = id;
        return this;
    }

isActive() [1/2]

boolean org.keycloak.representations.JsonWebToken.isActive ( )

inlineinherited

Tests that the token is not expired and is not-before.

戻り値

                              {
        return isActive(0);
    }

isActive() [2/2]

boolean org.keycloak.representations.JsonWebToken.isActive ( int  allowedTimeSkew )

inlineinherited

                                                 {
        return (!isExpired() || expiration == 0) && (isNotBefore(allowedTimeSkew) || notBefore == 0);
    }

isExpired()

boolean org.keycloak.representations.JsonWebToken.isExpired ( )

inlineinherited

                               {
        return Time.currentTime() > expiration;
    }

isNotBefore()

boolean org.keycloak.representations.JsonWebToken.isNotBefore ( int  allowedTimeSkew )

inlineinherited

                                                    {
        return Time.currentTime() + allowedTimeSkew >= notBefore;
    }

issuedAt()

JsonWebToken org.keycloak.representations.JsonWebToken.issuedAt ( int  issuedAt )

inlineinherited

                                               {
        this.issuedAt = issuedAt;
        return this;
    }

issuedFor()

JsonWebToken org.keycloak.representations.JsonWebToken.issuedFor ( String  issuedFor )

inlineinherited

                                                    {
        this.issuedFor = issuedFor;
        return this;
    }

issuedNow()

JsonWebToken org.keycloak.representations.JsonWebToken.issuedNow ( )

inlineinherited

Set issuedAt to the current time

                                    {
        issuedAt = Time.currentTime();
        return this;
    }

issuer()

JsonWebToken org.keycloak.representations.JsonWebToken.issuer ( String  issuer )

inlineinherited

                                              {
        this.issuer = issuer;
        return this;
    }

notBefore()

JsonWebToken org.keycloak.representations.JsonWebToken.notBefore ( int  notBefore )

inlineinherited

                                                 {
        this.notBefore = notBefore;
        return 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());
    }

setOtherClaims()

void org.keycloak.representations.JsonWebToken.setOtherClaims ( String  name, Object  value  )

inlineinherited

                                                          {
        otherClaims.put(name, value);
    }

setSubject()

void org.keycloak.representations.JsonWebToken.setSubject ( String  subject )

inlineinherited

                                           {
        this.subject = subject;
    }

subject()

JsonWebToken org.keycloak.representations.JsonWebToken.subject ( String  subject )

inlineinherited

                                                {
        this.subject = subject;
        return this;
    }

type()

JsonWebToken org.keycloak.representations.JsonWebToken.type ( String  type )

inlineinherited

                                          {
        this.type = type;
        return this;
    }

メンバ詳解

ACTION_TOKEN_USER_ID

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

static

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

actionVerificationNonce

UUID org.keycloak.authentication.actiontoken.DefaultActionTokenKey.actionVerificationNonce

private

audience

String [] org.keycloak.representations.JsonWebToken.audience

protectedinherited

DOT

final Pattern org.keycloak.authentication.actiontoken.DefaultActionTokenKey.DOT = Pattern.compile("\\.")

staticprivate

expiration

int org.keycloak.representations.JsonWebToken.expiration

protectedinherited

id

String org.keycloak.representations.JsonWebToken.id

protectedinherited

issuedAt

int org.keycloak.representations.JsonWebToken.issuedAt

protectedinherited

issuedFor

String org.keycloak.representations.JsonWebToken.issuedFor

inherited

issuer

String org.keycloak.representations.JsonWebToken.issuer

protectedinherited

JSON_FIELD_ACTION_VERIFICATION_NONCE

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

static

notBefore

int org.keycloak.representations.JsonWebToken.notBefore

protectedinherited

otherClaims

Map<String, Object> org.keycloak.representations.JsonWebToken.otherClaims = new HashMap<>()

protectedinherited

subject

String org.keycloak.representations.JsonWebToken.subject

protectedinherited

type

String org.keycloak.representations.JsonWebToken.type

protectedinherited

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/authentication/actiontoken/DefaultActionTokenKey.java