Skip to main content

Class: ClusterKeyProvider

Hierarchy

Properties

connectorKeys

Protected connectorKeys: null | ConnectorKeys = null

Inherited from

AbstractKeyProvider.connectorKeys

Defined in

packages/backend/server/src/crypto/abstract-key-provider.ts:20


keyProviderConfig

Protected keyProviderConfig: KeyProviderConfig

Inherited from

AbstractKeyProvider.keyProviderConfig

Defined in

packages/backend/server/src/crypto/abstract-key-provider.ts:19


onActiveKeyUpdate

Protected onActiveKeyUpdate: null | Listener<Promise<void>> = null

Inherited from

AbstractKeyProvider.onActiveKeyUpdate

Defined in

packages/backend/server/src/crypto/abstract-key-provider.ts:21


updateOidcServer

Protected updateOidcServer: Listener<Promise<void>> | () => boolean

Inherited from

AbstractKeyProvider.updateOidcServer

Defined in

packages/backend/server/src/crypto/abstract-key-provider.ts:22

Methods

generateKeys

generateKeys(): Promise<ConnectorKeys>

Returns

Promise<ConnectorKeys>

Overrides

AbstractKeyProvider.generateKeys

Defined in

packages/backend/server/src/crypto/cluster-key-provider.ts:108


getActiveKeys

getActiveKeys(): Promise<ConnectorKeys>

Returns

Promise<ConnectorKeys>

Overrides

AbstractKeyProvider.getActiveKeys

Defined in

packages/backend/server/src/crypto/cluster-key-provider.ts:94


getPublicKeys

getPublicKeys(): Promise<JWK[]>

Returns

Promise<JWK[]>

Overrides

AbstractKeyProvider.getPublicKeys

Defined in

packages/backend/server/src/crypto/cluster-key-provider.ts:82


isConnectorKeys

isConnectorKeys(obj): obj is ConnectorKeys

Parameters

NameType
objunknown

Returns

obj is ConnectorKeys

Inherited from

AbstractKeyProvider.isConnectorKeys

Defined in

packages/backend/server/src/crypto/abstract-key-provider.ts:42


registerCallbacks

registerCallbacks(onActiveKeyUpdate, updateOidcServer): void

Parameters

NameType
onActiveKeyUpdateListener<Promise<any>>
updateOidcServerListener<Promise<any>>

Returns

void

Inherited from

AbstractKeyProvider.registerCallbacks

Defined in

packages/backend/server/src/crypto/abstract-key-provider.ts:76


createKeys

createKeys(alg?, options?): Promise<ConnectorKeys>

Parameters

NameTypeDefault value
algstringKeycloakConnector.REQUIRED_ALGO
options?GenerateKeyPairOptionsundefined

Returns

Promise<ConnectorKeys>

Inherited from

AbstractKeyProvider.createKeys

Defined in

packages/backend/server/src/crypto/abstract-key-provider.ts:44


factory

factory(keyProviderConfig): Promise<ClusterKeyProvider>

Parameters

NameType
keyProviderConfigKeyProviderConfig

Returns

Promise<ClusterKeyProvider>

Defined in

packages/backend/server/src/crypto/cluster-key-provider.ts:498