Package org.keycloak.models

Interface KeyManager

All Known Implementing Classes:

DefaultKeyManager

public interface KeyManager

Author:

Stian Thorgersen

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	KeyManager.ActiveAesKey
static class	KeyManager.ActiveHmacKey
static class	KeyManager.ActiveRsaKey

Method Summary

Modifier and Type	Method	Description
KeyManager.ActiveAesKey	getActiveAesKey(RealmModel realm)	Deprecated.
KeyManager.ActiveHmacKey	getActiveHmacKey(RealmModel realm)	Deprecated.
KeyWrapper	getActiveKey(RealmModel realm, KeyUse use, String algorithm)
KeyManager.ActiveRsaKey	getActiveRsaKey(RealmModel realm)	Deprecated.
List<SecretKeyMetadata>	getAesKeys(RealmModel realm)	Deprecated.
SecretKey	getAesSecretKey(RealmModel realm, String kid)	Deprecated.
List<SecretKeyMetadata>	getHmacKeys(RealmModel realm)	Deprecated.
SecretKey	getHmacSecretKey(RealmModel realm, String kid)	Deprecated.
KeyWrapper	getKey(RealmModel realm, String kid, KeyUse use, String algorithm)
default KeyWrapper	getKeyIncludingDisabled(RealmModel realm, String kid, KeyUse use, String algorithm)	Returns the key for the given kid regardless of the key status, so unlike getKey(RealmModel, String, KeyUse, String) it also returns disabled keys.
Stream<KeyWrapper>	getKeysStream(RealmModel realm)	Returns all KeyWrapper for the given realm.
Stream<KeyWrapper>	getKeysStream(RealmModel realm, KeyUse use, String algorithm)	Returns all KeyWrapper for the given realm that match given criteria.
Certificate	getRsaCertificate(RealmModel realm, String kid)	Deprecated.
List<RsaKeyMetadata>	getRsaKeys(RealmModel realm)	Deprecated.
PublicKey	getRsaPublicKey(RealmModel realm, String kid)	Deprecated.

Method Details

getActiveKey

KeyWrapper getActiveKey(RealmModel realm,
 KeyUse use,
 String algorithm)

getKey

KeyWrapper getKey(RealmModel realm,
 String kid,
 KeyUse use,
 String algorithm)

getKeyIncludingDisabled

default KeyWrapper getKeyIncludingDisabled(RealmModel realm,
 String kid,
 KeyUse use,
 String algorithm)

Returns the key for the given kid regardless of the key status, so unlike getKey(RealmModel, String, KeyUse, String) it also returns disabled keys. Useful for features that reserve a dedicated realm key which should not serve regular realm signing.

getKeysStream

Stream<KeyWrapper> getKeysStream(RealmModel realm)

Returns all KeyWrapper for the given realm.

Parameters:

realm - RealmModel.

Returns:

Stream of all KeyWrapper in the realm. Never returns null.

getKeysStream

Stream<KeyWrapper> getKeysStream(RealmModel realm,
 KeyUse use,
 String algorithm)

Returns all KeyWrapper for the given realm that match given criteria.

Parameters:

realm - RealmModel.

use - KeyUse.

algorithm - String.

Returns:

Stream of all KeyWrapper in the realm. Never returns null.

getActiveRsaKey

@Deprecated
KeyManager.ActiveRsaKey getActiveRsaKey(RealmModel realm)

Deprecated.

getRsaPublicKey

@Deprecated
PublicKey getRsaPublicKey(RealmModel realm,
 String kid)

Deprecated.

getRsaCertificate

@Deprecated
Certificate getRsaCertificate(RealmModel realm,
 String kid)

Deprecated.

getRsaKeys

@Deprecated
List<RsaKeyMetadata> getRsaKeys(RealmModel realm)

Deprecated.

getActiveHmacKey

@Deprecated
KeyManager.ActiveHmacKey getActiveHmacKey(RealmModel realm)

Deprecated.

getHmacSecretKey

@Deprecated
SecretKey getHmacSecretKey(RealmModel realm,
 String kid)

Deprecated.

getHmacKeys

@Deprecated
List<SecretKeyMetadata> getHmacKeys(RealmModel realm)

Deprecated.

getActiveAesKey

@Deprecated
KeyManager.ActiveAesKey getActiveAesKey(RealmModel realm)

Deprecated.

getAesSecretKey

@Deprecated
SecretKey getAesSecretKey(RealmModel realm,
 String kid)

Deprecated.

getAesKeys

@Deprecated
List<SecretKeyMetadata> getAesKeys(RealmModel realm)

Deprecated.