org.keycloak.keys

Interface KeyProvider

All Superinterfaces:

Provider

public interface KeyProvider
extends Provider

Author:

Stian Thorgersen

Method Summary

Modifier and Type	Method and Description
X509Certificate	getCertificate(String kid) Return the certificate for the specified kid, or null if the kid is unknown.
List<KeyMetadata>	getKeyMetadata() Return metadata about all keypairs held by the provider
String	getKid() Return the KID for the active keypair, or null if no active key is available.
PrivateKey	getPrivateKey() Return the private key for the active keypair, or null if no active key is available.
PublicKey	getPublicKey(String kid) Return the public key for the specified kid, or null if the kid is unknown.

Methods inherited from interface org.keycloak.provider.Provider

close

Method Detail

getKid

String getKid()

Return the KID for the active keypair, or null if no active key is available.

Returns:

getPrivateKey

PrivateKey getPrivateKey()

Return the private key for the active keypair, or null if no active key is available.

Returns:

getPublicKey

PublicKey getPublicKey(String kid)

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

Parameters:

kid -

Returns:

getCertificate

X509Certificate getCertificate(String kid)

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

Parameters:

kid -

Returns:

getKeyMetadata

List<KeyMetadata> getKeyMetadata()

Return metadata about all keypairs held by the provider

Returns: