org.forgerock.opendj.security

Interface ExternalKeyWrappingStrategy

public interface ExternalKeyWrappingStrategy

A service provider interface for externalizing the strategy used for wrapping individual private/secret keys. Applications can configure an LDAP keystore to delegate key wrapping responsibilities by setting the KeyStoreParameters.EXTERNAL_KEY_WRAPPING_STRATEGY option.

Method Summary

Modifier and Type	Method and Description
ByteSequence	unwrapKey(ByteSequence wrappedKey) Unwraps the provided wrapped key.
ByteSequence	wrapKey(ByteSequence unwrappedKey) Wraps the provided encoded key.

Method Detail

wrapKey

ByteSequence wrapKey(ByteSequence unwrappedKey)
              throws LocalizedKeyStoreException

Wraps the provided encoded key.

Parameters:

unwrappedKey - The non-null key to be wrapped. The format of the unwrapped key is unspecified.

Returns:

The non-null protected key. The format of the returned wrapped key is implementation defined.

Throws:

LocalizedKeyStoreException - If an unexpected problem occurred when wrapping the key.

unwrapKey

ByteSequence unwrapKey(ByteSequence wrappedKey)
                throws LocalizedKeyStoreException

Unwraps the provided wrapped key.

Parameters:

wrappedKey - The non-null key to be unwrapped. The format of the wrapped key is implementation defined and must have been produced via a call to ExternalKeyWrappingStrategy.wrapKey(ByteSequence).

Returns:

The non-null unwrapped key which must contain exactly the same content passed to ExternalKeyWrappingStrategy.wrapKey(ByteSequence).

Throws:

LocalizedKeyStoreException - If an unexpected problem occurred when unwrapping the key.