Package org.keycloak.crypto

Interface SignatureProviderFactory

All Superinterfaces:

ProviderFactory<SignatureProvider>

All Known Implementing Classes:

EdDSASignatureProviderFactory, ES256SignatureProviderFactory, ES384SignatureProviderFactory, ES512SignatureProviderFactory, HS256SignatureProviderFactory, HS384SignatureProviderFactory, HS512SignatureProviderFactory, PS256SignatureProviderFactory, PS384SignatureProviderFactory, PS512SignatureProviderFactory, RS256SignatureProviderFactory, RS384SignatureProviderFactory, RS512SignatureProviderFactory

public interface SignatureProviderFactory
extends ProviderFactory<SignatureProvider>

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	EC_PRIVATE_JWK_CLAIMS
static final Set<String>	OCT_PRIVATE_JWK_CLAIMS
static final Set<String>	OKP_PRIVATE_JWK_CLAIMS
static final Set<String>	RSA_PRIVATE_JWK_CLAIMS

Method Summary

Modifier and Type	Method	Description
default void	close()	This is called when the server shuts down.
Set<String>	getJwkPrivateKeyClaims()	Returns the JWK claim names that represent private key material for the algorithm supported by this provider implementation.
default void	init(Config.Scope config)	Only called once when the factory is first created.
default void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized

Methods inherited from interface org.keycloak.provider.ProviderFactory

create, dependsOn, getConfigMetadata, getId, order

Field Details

RSA_PRIVATE_JWK_CLAIMS

static final Set<String> RSA_PRIVATE_JWK_CLAIMS

EC_PRIVATE_JWK_CLAIMS

static final Set<String> EC_PRIVATE_JWK_CLAIMS

OKP_PRIVATE_JWK_CLAIMS

static final Set<String> OKP_PRIVATE_JWK_CLAIMS

OCT_PRIVATE_JWK_CLAIMS

static final Set<String> OCT_PRIVATE_JWK_CLAIMS

Method Details

init

default void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created.

Specified by:

init in interface ProviderFactory<SignatureProvider>

postInit

default void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<SignatureProvider>

close

default void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<SignatureProvider>

getJwkPrivateKeyClaims

Set<String> getJwkPrivateKeyClaims()

Returns the JWK claim names that represent private key material for the algorithm supported by this provider implementation.