org.keycloak.keys.GeneratedHmacKeyProviderFactory クラス

org.keycloak.keys.GeneratedHmacKeyProviderFactory の継承関係図

org.keycloak.keys.GeneratedHmacKeyProviderFactory 連携図

公開メンバ関数
GeneratedHmacKeyProvider	create (KeycloakSession session, ComponentModel model)
boolean	createFallbackKeys (KeycloakSession session, KeyUse keyUse, String algorithm)
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties ()
String	getId ()
void	validateConfiguration (KeycloakSession session, RealmModel realm, ComponentModel model) throws ComponentValidationException

静的公開変数類
static final String	ID = "hmac-generated"
static final int	DEFAULT_HMAC_KEY_SIZE = 64

限定公開メンバ関数
Logger	logger ()
int	getDefaultKeySize ()

静的非公開変数類
static final Logger	logger = Logger.getLogger(GeneratedHmacKeyProviderFactory.class)
static final String	HELP_TEXT = "Generates HMAC secret key"
static final List< ProviderConfigProperty >	CONFIG_PROPERTIES

詳解

著者

Stian Thorgersen

関数詳解

create()

GeneratedHmacKeyProvider org.keycloak.keys.GeneratedHmacKeyProviderFactory.create ( KeycloakSession  session, ComponentModel  model  )

inline

                                                                                          {
        return new GeneratedHmacKeyProvider(model);
    }

createFallbackKeys()

boolean org.keycloak.keys.GeneratedHmacKeyProviderFactory.createFallbackKeys ( KeycloakSession  session, KeyUse  keyUse, String  algorithm  )

inline

                                                                                                {
        if (keyUse.equals(KeyUse.SIG) && (algorithm.equals(Algorithm.HS256) || algorithm.equals(Algorithm.HS384) || algorithm.equals(Algorithm.HS512))) {
            RealmModel realm = session.getContext().getRealm();

            ComponentModel generated = new ComponentModel();
            generated.setName("fallback-" + algorithm);
            generated.setParentId(realm.getId());
            generated.setProviderId(ID);
            generated.setProviderType(KeyProvider.class.getName());

            MultivaluedHashMap<String, String> config = new MultivaluedHashMap<>();
            config.putSingle(Attributes.PRIORITY_KEY, "-100");
            config.putSingle(Attributes.ALGORITHM_KEY, algorithm);
            generated.setConfig(config);

            realm.addComponentModel(generated);

            return true;
        } else {
            return false;
        }
    }

getConfigProperties()

List<ProviderConfigProperty> org.keycloak.keys.GeneratedHmacKeyProviderFactory.getConfigProperties ( )

inline

                                                              {
        return CONFIG_PROPERTIES;
    }

getDefaultKeySize()

int org.keycloak.keys.GeneratedHmacKeyProviderFactory.getDefaultKeySize ( )

inlineprotected

                                      {
        return DEFAULT_HMAC_KEY_SIZE;
    }

getHelpText()

String org.keycloak.keys.GeneratedHmacKeyProviderFactory.getHelpText ( )

inline

                                {
        return HELP_TEXT;
    }

getId()

String org.keycloak.keys.GeneratedHmacKeyProviderFactory.getId ( )

inline

                          {
        return ID;
    }

logger()

Logger org.keycloak.keys.GeneratedHmacKeyProviderFactory.logger ( )

inlineprotected

                              {
        return logger;
    }

validateConfiguration()

void org.keycloak.keys.AbstractGeneratedSecretKeyProviderFactory< T extends KeyProvider >.validateConfiguration ( KeycloakSession  session, RealmModel  realm, ComponentModel  model  ) throws ComponentValidationException

inlineinherited

                                                                                                                                           {
        ConfigurationValidationHelper validation = SecretKeyProviderUtils.validateConfiguration(model);
        validation.checkList(Attributes.SECRET_SIZE_PROPERTY, false);

        int size = model.get(Attributes.SECRET_SIZE_KEY, getDefaultKeySize());

        if (!(model.contains(Attributes.SECRET_KEY))) {
            generateSecret(model, size);
            logger().debugv("Generated secret for {0}", realm.getName());
        } else {
            int currentSize = Base64Url.decode(model.get(Attributes.SECRET_KEY)).length;
            if (currentSize != size) {
                generateSecret(model, size);
                logger().debugv("Secret size changed, generating new secret for {0}", realm.getName());
            }
        }
    }

メンバ詳解

CONFIG_PROPERTIES

final List<ProviderConfigProperty> org.keycloak.keys.GeneratedHmacKeyProviderFactory.CONFIG_PROPERTIES

staticprivate

初期値:

= SecretKeyProviderUtils.configurationBuilder()
            .property(Attributes.SECRET_SIZE_PROPERTY)
            .property(Attributes.HS_ALGORITHM_PROPERTY)
            .build()

DEFAULT_HMAC_KEY_SIZE

final int org.keycloak.keys.GeneratedHmacKeyProviderFactory.DEFAULT_HMAC_KEY_SIZE = 64

static

HELP_TEXT

final String org.keycloak.keys.GeneratedHmacKeyProviderFactory.HELP_TEXT = "Generates HMAC secret key"

staticprivate

ID

final String org.keycloak.keys.GeneratedHmacKeyProviderFactory.ID = "hmac-generated"

static

logger

final Logger org.keycloak.keys.GeneratedHmacKeyProviderFactory.logger = Logger.getLogger(GeneratedHmacKeyProviderFactory.class)

staticprivate

---

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

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