org.keycloak.keys

Interface SecretKeyProvider

All Superinterfaces:

KeyProvider<SecretKeyMetadata>, Provider

All Known Subinterfaces:

AesKeyProvider, HmacKeyProvider

public interface SecretKeyProvider
extends KeyProvider<SecretKeyMetadata>

Base for secret key providers (HMAC, AES)

Author:

Marek Posolda

Method Summary

Modifier and Type	Method and Description
String	getJavaAlgorithmName() Return name of Java (JCA) algorithm of the key.
SecretKey	getSecretKey() Return the active secret key, or null if no active key is available.
SecretKey	getSecretKey(String kid) Return the secret key for the specified kid, or null if the kid is unknown.

Methods inherited from interface org.keycloak.keys.KeyProvider

getKeyMetadata, getKid, getType

Methods inherited from interface org.keycloak.provider.Provider

close

Method Detail

getSecretKey

SecretKey getSecretKey()

Return the active secret key, or null if no active key is available.

Returns:

getSecretKey

SecretKey getSecretKey(String kid)

Return the secret key for the specified kid, or null if the kid is unknown.

Parameters:

kid -

Returns:

getJavaAlgorithmName

String getJavaAlgorithmName()

Return name of Java (JCA) algorithm of the key. For example: HmacSHA256

Returns: