Class: AbstractKeyProvider
Hierarchy
-
AbstractKeyProvider
Constructors
constructor
• new AbstractKeyProvider(keyProviderConfig): AbstractKeyProvider
Parameters
| Name | Type |
|---|---|
keyProviderConfig | KeyProviderConfig |
Returns
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:25
Properties
connectorKeys
• Protected connectorKeys: null | ConnectorKeys = null
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:20
keyProviderConfig
• Protected keyProviderConfig: KeyProviderConfig
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:19
onActiveKeyUpdate
• Protected onActiveKeyUpdate: null | Listener<Promise<void>> = null
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:21
updateOidcServer
• Protected updateOidcServer: Listener<Promise<void>> | () => boolean
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:22
Methods
generateKeys
▸ generateKeys(): Promise<ConnectorKeys>
Returns
Promise<ConnectorKeys>
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:33
getActiveKeys
▸ getActiveKeys(): Promise<ConnectorKeys>
Returns
Promise<ConnectorKeys>
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:40
getPublicKeys
▸ getPublicKeys(): Promise<JWK[]>
Returns
Promise<JWK[]>
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:45
importFromSerializable
▸ importFromSerializable(serializedKeys): Promise<ConnectorKeys>
Parameters
| Name | Type |
|---|---|
serializedKeys | ConnectorKeysSerializable |
Returns
Promise<ConnectorKeys>
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:86
isConnectorKeys
▸ isConnectorKeys(obj): obj is ConnectorKeys
Parameters
| Name | Type |
|---|---|
obj | unknown |
Returns
obj is ConnectorKeys
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:47
registerCallbacks
▸ registerCallbacks(onActiveKeyUpdate, updateOidcServer): void
Parameters
| Name | Type |
|---|---|
onActiveKeyUpdate | Listener<Promise<any>> |
updateOidcServer | Listener<Promise<any>> |
Returns
void
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:102
serializeConnectorKeys
▸ serializeConnectorKeys(connectorKeys): Promise<ConnectorKeysSerializable>
Parameters
| Name | Type |
|---|---|
connectorKeys | ConnectorKeys |
Returns
Promise<ConnectorKeysSerializable>
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:94
triggerKeySync
▸ triggerKeySync(): void
Returns
void
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:35
createKeys
▸ createKeys(alg?, options?): Promise<ConnectorKeys>
Parameters
| Name | Type | Default value |
|---|---|---|
alg | string | KeycloakConnector.REQUIRED_ALGO |
options? | GenerateKeyPairOptions | undefined |
Returns
Promise<ConnectorKeys>
Defined in
packages/backend/server/src/crypto/abstract-key-provider.ts:49