org.forgerock.openam.secrets

Interface KeyStoreKeyIdProvider

public interface KeyStoreKeyIdProvider

This interface allows customization of the key ID values associated with public keys stored in KeyStoreSecretStores.

Since:

AM 7.0.0

Warning: Evolving API

This type (including all methods, constructors and fields) is continuing to evolve and so should be expected to change, potentially in backwards-incompatible ways even in a minor release. Changes are documented at the time of product release.

Method Summary

Modifier and Type	Method and Description
String	getKeyId(KeyUse keyUse, String alias, PublicKey publicKey, Optional<Certificate> certificate) Determine the key ID for the provided public key.

Method Detail

getKeyId

String getKeyId(KeyUse keyUse,
                String alias,
                PublicKey publicKey,
                Optional<Certificate> certificate)

Determine the key ID for the provided public key. The key ID value should be calculated consistently, that is: for the same key use, internal ID, public key combination this method should always return the same value.

Parameters:

keyUse - Whether the key in question is used for signing or encryption.

alias - The keystore alias for this key.

publicKey - The public key.

certificate - The public certificate.

Returns:

The key ID of the provided public key.