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

org.keycloak.keys.JavaKeystoreKeyProviderFactory 連携図

公開メンバ関数
KeyProvider	create (KeycloakSession session, ComponentModel model)

void	validateConfiguration (KeycloakSession session, RealmModel realm, ComponentModel model) throws ComponentValidationException

String	getHelpText ()

List< ProviderConfigProperty >	getConfigProperties ()

String	getId ()

default ProviderType	create (KeycloakSession session)

default boolean	createFallbackKeys (KeycloakSession session, KeyUse keyUse, String algorithm)

default void	init (Config.Scope config)

default void	postInit (KeycloakSessionFactory factory)

default void	close ()

default void	onCreate (KeycloakSession session, RealmModel realm, ComponentModel model)

default void	onUpdate (KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel)

default void	preRemove (KeycloakSession session, RealmModel realm, ComponentModel model)

default List< ProviderConfigProperty >	getCommonProviderConfigProperties ()

default Map< String, Object >	getTypeMetadata ()

default int	order ()

静的公開メンバ関数
static final ProviderConfigurationBuilder	configurationBuilder ()

静的公開変数類
static final String	ID = "java-keystore"

static String	KEYSTORE_KEY = "keystore"

static ProviderConfigProperty	KEYSTORE_PROPERTY = new ProviderConfigProperty(KEYSTORE_KEY, "Keystore", "Path to keys file", STRING_TYPE, null)

static String	KEYSTORE_PASSWORD_KEY = "keystorePassword"

static ProviderConfigProperty	KEYSTORE_PASSWORD_PROPERTY = new ProviderConfigProperty(KEYSTORE_PASSWORD_KEY, "Keystore Password", "Password for the keys", STRING_TYPE, null, true)

static String	KEY_ALIAS_KEY = "keyAlias"

static ProviderConfigProperty	KEY_ALIAS_PROPERTY = new ProviderConfigProperty(KEY_ALIAS_KEY, "Key Alias", "Alias for the private key", STRING_TYPE, null)

static String	KEY_PASSWORD_KEY = "keyPassword"

static ProviderConfigProperty	KEY_PASSWORD_PROPERTY = new ProviderConfigProperty(KEY_PASSWORD_KEY, "Key Password", "Password for the private key", STRING_TYPE, null, true)

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

static final String	HELP_TEXT = "Loads keys from a Java keys file"

static final List< ProviderConfigProperty >	CONFIG_PROPERTIES

詳解

著者: Stian Thorgersen

関数詳解

◆ close()

default void org.keycloak.keys.KeyProviderFactory< T extends KeyProvider >.close ( )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

47 {

48 }

◆ configurationBuilder()

static final ProviderConfigurationBuilder org.keycloak.keys.AbstractRsaKeyProviderFactory.configurationBuilder ( )

inlinestaticinherited

                                                                             {
         return ProviderConfigurationBuilder.create()
                 .property(Attributes.PRIORITY_PROPERTY)
                 .property(Attributes.ENABLED_PROPERTY)
                 .property(Attributes.ACTIVE_PROPERTY)
                 .property(Attributes.RS_ALGORITHM_PROPERTY);
     }

◆ create() [1/2]

default ProviderType org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.create ( KeycloakSession session )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                          {
         return null;
     }

◆ create() [2/2]

KeyProvider org.keycloak.keys.JavaKeystoreKeyProviderFactory.create	(	KeycloakSession	session,
		ComponentModel	model
	)

inline

org.keycloak.keys.KeyProviderFactory< T extends KeyProvider >を実装しています。

                                                                              {
         return new JavaKeystoreKeyProvider(session.getContext().getRealm(), model);
     }

◆ createFallbackKeys()

default boolean org.keycloak.keys.KeyProviderFactory< T extends KeyProvider >.createFallbackKeys	(	KeycloakSession	session,
		KeyUse	keyUse,
		String	algorithm
	)

inlineinherited

org.keycloak.keys.GeneratedRsaKeyProviderFactory, org.keycloak.keys.GeneratedEcdsaKeyProviderFactoryで実装されています。

                                                                                                  {
         return false;
     }

◆ getCommonProviderConfigProperties()

default List<ProviderConfigProperty> org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.getCommonProviderConfigProperties ( )

inlineinherited

These are config properties that are common across all implementation of this component type

戻り値

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >で実装されています。

                                                                      {
         return Collections.EMPTY_LIST;
     }

◆ getConfigProperties()

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

inline

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

                                                               {
         return CONFIG_PROPERTIES;
     }

◆ getHelpText()

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

inline

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

                                 {
         return HELP_TEXT;
     }

◆ getId()

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

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                           {
         return ID;
     }

◆ getTypeMetadata()

default Map<String, Object> org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.getTypeMetadata ( )

inlineinherited

This is metadata about this component type. Its really configuration information about the component type and not an individual instance

戻り値

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >で実装されています。

                                           {
         return Collections.EMPTY_MAP;
 
     }

◆ init()

default void org.keycloak.keys.KeyProviderFactory< T extends KeyProvider >.init ( Config.Scope config )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

39 {

40 }

◆ onCreate()

default void org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.onCreate	(	KeycloakSession	session,
		RealmModel	realm,
		ComponentModel	model
	)

inlineinherited

Called after a component is created

引数

session
realm
model

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactory, org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >で実装されています。

                                                                                    {
 
     }

◆ onUpdate()

default void org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.onUpdate	(	KeycloakSession	session,
		RealmModel	realm,
		ComponentModel	oldModel,
		ComponentModel	newModel
	)

inlineinherited

Called after the component is updated.

引数

session
realm
oldModel	old saved model
newModel	new configuration

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

                                                                                                                {
 
     }

◆ order()

default int org.keycloak.provider.ProviderFactory< T extends Provider >.order ( )

inlineinherited

org.keycloak.protocol.docker.DockerAuthV2ProtocolFactory, org.keycloak.urls.HostnameProviderFactory, org.keycloak.protocol.oidc.ext.OIDCExtProviderFactoryで実装されています。

                         {
         return 0;
     }

◆ postInit()

default void org.keycloak.keys.KeyProviderFactory< T extends KeyProvider >.postInit ( KeycloakSessionFactory factory )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

43 {

44 }

◆ preRemove()

default void org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.preRemove	(	KeycloakSession	session,
		RealmModel	realm,
		ComponentModel	model
	)

inlineinherited

Called before the component is removed.

引数

session
realm
model	model of the component, which is going to be removed

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

                                                                                     {
 
     }

◆ validateConfiguration()

void org.keycloak.keys.JavaKeystoreKeyProviderFactory.validateConfiguration	(	KeycloakSession	session,
		RealmModel	realm,
		ComponentModel	model
	)		throws ComponentValidationException

inline

org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >を実装しています。

                                                                                                                                            {
         super.validateConfiguration(session, realm, model);
 
         ConfigurationValidationHelper.check(model)
                 .checkSingle(KEYSTORE_PROPERTY, true)
                 .checkSingle(KEYSTORE_PASSWORD_PROPERTY, true)
                 .checkSingle(KEY_ALIAS_PROPERTY, true)
                 .checkSingle(KEY_PASSWORD_PROPERTY, true);
 
         try {
             new JavaKeystoreKeyProvider(session.getContext().getRealm(), model)
                     .loadKey(session.getContext().getRealm(), model);
         } catch (Throwable t) {
             logger.error("Failed to load keys.", t);
             throw new ComponentValidationException("Failed to load keys. " + t.getMessage(), t);
         }
     }

メンバ詳解

◆ CONFIG_PROPERTIES

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

staticprivate

初期値:

= AbstractRsaKeyProviderFactory.configurationBuilder()
            .property(KEYSTORE_PROPERTY)
            .property(KEYSTORE_PASSWORD_PROPERTY)
            .property(KEY_ALIAS_PROPERTY)
            .property(KEY_PASSWORD_PROPERTY)
            .build()

◆ HELP_TEXT

final String org.keycloak.keys.JavaKeystoreKeyProviderFactory.HELP_TEXT = "Loads keys from a Java keys file"

staticprivate

◆ ID

final String org.keycloak.keys.JavaKeystoreKeyProviderFactory.ID = "java-keystore"

static

◆ KEY_ALIAS_KEY

String org.keycloak.keys.JavaKeystoreKeyProviderFactory.KEY_ALIAS_KEY = "keyAlias"

static

◆ KEY_ALIAS_PROPERTY

ProviderConfigProperty org.keycloak.keys.JavaKeystoreKeyProviderFactory.KEY_ALIAS_PROPERTY = new ProviderConfigProperty(KEY_ALIAS_KEY, "Key Alias", "Alias for the private key", STRING_TYPE, null)

static

◆ KEY_PASSWORD_KEY

String org.keycloak.keys.JavaKeystoreKeyProviderFactory.KEY_PASSWORD_KEY = "keyPassword"

static

◆ KEY_PASSWORD_PROPERTY

ProviderConfigProperty org.keycloak.keys.JavaKeystoreKeyProviderFactory.KEY_PASSWORD_PROPERTY = new ProviderConfigProperty(KEY_PASSWORD_KEY, "Key Password", "Password for the private key", STRING_TYPE, null, true)

static

◆ KEYSTORE_KEY

String org.keycloak.keys.JavaKeystoreKeyProviderFactory.KEYSTORE_KEY = "keystore"

static

◆ KEYSTORE_PASSWORD_KEY

String org.keycloak.keys.JavaKeystoreKeyProviderFactory.KEYSTORE_PASSWORD_KEY = "keystorePassword"

static

◆ KEYSTORE_PASSWORD_PROPERTY

ProviderConfigProperty org.keycloak.keys.JavaKeystoreKeyProviderFactory.KEYSTORE_PASSWORD_PROPERTY = new ProviderConfigProperty(KEYSTORE_PASSWORD_KEY, "Keystore Password", "Password for the keys", STRING_TYPE, null, true)

static

◆ KEYSTORE_PROPERTY

ProviderConfigProperty org.keycloak.keys.JavaKeystoreKeyProviderFactory.KEYSTORE_PROPERTY = new ProviderConfigProperty(KEYSTORE_KEY, "Keystore", "Path to keys file", STRING_TYPE, null)

static

◆ logger

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

staticprivate

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

D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/keys/JavaKeystoreKeyProviderFactory.java

公開メンバ関数

静的公開メンバ関数

静的公開変数類

静的非公開変数類

詳解

関数詳解

◆ close()

◆ configurationBuilder()

◆ create() [1/2]

◆ create() [2/2]

◆ createFallbackKeys()

◆ getCommonProviderConfigProperties()

◆ getConfigProperties()

◆ getHelpText()

◆ getId()

◆ getTypeMetadata()

◆ init()

◆ onCreate()

◆ onUpdate()

◆ order()

◆ postInit()

◆ preRemove()

◆ validateConfiguration()

メンバ詳解

◆ CONFIG_PROPERTIES

◆ HELP_TEXT

◆ ID

◆ KEY_ALIAS_KEY

◆ KEY_ALIAS_PROPERTY

◆ KEY_PASSWORD_KEY

◆ KEY_PASSWORD_PROPERTY

◆ KEYSTORE_KEY

◆ KEYSTORE_PASSWORD_KEY

◆ KEYSTORE_PASSWORD_PROPERTY

◆ KEYSTORE_PROPERTY

◆ logger