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

org.keycloak.keys.GeneratedRsaKeyProviderFactory 連携図

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

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

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

String	getHelpText ()

List< ProviderConfigProperty >	getConfigProperties ()

String	getId ()

default ProviderType	create (KeycloakSession session)

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 = "rsa-generated"

非公開メンバ関数
void	generateKeys (RealmModel realm, ComponentModel model, int size)

void	generateCertificate (RealmModel realm, ComponentModel model, KeyPair keyPair)

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

static final String	HELP_TEXT = "Generates RSA keys and creates a self-signed certificate"

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.GeneratedRsaKeyProviderFactory.create	(	KeycloakSession	session,
		ComponentModel	model
	)

inline

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

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

◆ createFallbackKeys()

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

inline

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

                                                                                                 {
         if (keyUse.equals(KeyUse.SIG) && (algorithm.equals(Algorithm.RS256) || algorithm.equals(Algorithm.RS384) || algorithm.equals(Algorithm.RS512))) {
             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;
         }
     }

◆ generateCertificate()

void org.keycloak.keys.GeneratedRsaKeyProviderFactory.generateCertificate	(	RealmModel	realm,
		ComponentModel	model,
		KeyPair	keyPair
	)

inlineprivate

                                                                                               {
         try {
             Certificate certificate = CertificateUtils.generateV1SelfSignedCertificate(keyPair, realm.getName());
             model.put(Attributes.CERTIFICATE_KEY, PemUtils.encodeCertificate(certificate));
         } catch (Throwable t) {
             throw new ComponentValidationException("Failed to generate certificate", t);
         }
     }

◆ generateKeys()

void org.keycloak.keys.GeneratedRsaKeyProviderFactory.generateKeys	(	RealmModel	realm,
		ComponentModel	model,
		int	size
	)

inlineprivate

                                                                                 {
         KeyPair keyPair;
         try {
             keyPair = KeyUtils.generateRsaKeyPair(size);
             model.put(Attributes.PRIVATE_KEY_KEY, PemUtils.encodeKey(keyPair.getPrivate()));
         } catch (Throwable t) {
             throw new ComponentValidationException("Failed to generate keys", t);
         }
 
         generateCertificate(realm, model, keyPair);
     }

◆ 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.GeneratedRsaKeyProviderFactory.getConfigProperties ( )

inline

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

                                                               {
         return CONFIG_PROPERTIES;
     }

◆ getHelpText()

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

inline

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

                                 {
         return HELP_TEXT;
     }

◆ getId()

String org.keycloak.keys.GeneratedRsaKeyProviderFactory.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.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

                                                                                                                {
 
     }

◆ order()

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

inlineinherited

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

                                                                                     {
 
     }

◆ validateConfiguration()

void org.keycloak.keys.GeneratedRsaKeyProviderFactory.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).checkList(Attributes.KEY_SIZE_PROPERTY, false);
 
         int size = model.get(Attributes.KEY_SIZE_KEY, 2048);
 
         if (!(model.contains(Attributes.PRIVATE_KEY_KEY) && model.contains(Attributes.CERTIFICATE_KEY))) {
             generateKeys(realm, model, size);
 
             logger.debugv("Generated keys for {0}", realm.getName());
         } else {
             PrivateKey privateKey = PemUtils.decodePrivateKey(model.get(Attributes.PRIVATE_KEY_KEY));
             int currentSize = ((RSAPrivateKey) privateKey).getModulus().bitLength();
             if (currentSize != size) {
                 generateKeys(realm, model, size);
 
                 logger.debugv("Key size changed, generating new keys for {0}", realm.getName());
             }
         }
     }

メンバ詳解

◆ CONFIG_PROPERTIES

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

staticprivate

初期値:

= AbstractRsaKeyProviderFactory.configurationBuilder()
            .property(Attributes.KEY_SIZE_PROPERTY)
            .build()

◆ HELP_TEXT

final String org.keycloak.keys.GeneratedRsaKeyProviderFactory.HELP_TEXT = "Generates RSA keys and creates a self-signed certificate"

staticprivate

◆ ID

final String org.keycloak.keys.GeneratedRsaKeyProviderFactory.ID = "rsa-generated"

static

◆ logger

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

staticprivate

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

D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/keys/GeneratedRsaKeyProviderFactory.java

公開メンバ関数

静的公開メンバ関数

静的公開変数類

非公開メンバ関数

静的非公開変数類

詳解

関数詳解

◆ close()

◆ configurationBuilder()

◆ create() [1/2]

◆ create() [2/2]

◆ createFallbackKeys()

◆ generateCertificate()

◆ generateKeys()

◆ getCommonProviderConfigProperties()

◆ getConfigProperties()

◆ getHelpText()

◆ getId()

◆ getTypeMetadata()

◆ init()

◆ onCreate()

◆ onUpdate()

◆ order()

◆ postInit()

◆ preRemove()

◆ validateConfiguration()

メンバ詳解

◆ CONFIG_PROPERTIES

◆ HELP_TEXT

◆ ID

◆ logger