Module org.apache.santuario.xmlsec

Package org.apache.xml.security.keys.keyresolver.implementations

Class EncryptedKeyResolver

java.lang.Object

org.apache.xml.security.keys.keyresolver.KeyResolverSpi

org.apache.xml.security.keys.keyresolver.implementations.EncryptedKeyResolver

public class EncryptedKeyResolver
extends KeyResolverSpi

The EncryptedKeyResolver is not a generic resolver. It can only be for specific instantiations, as the key being unwrapped will always be of a particular type and will always have been wrapped by another key which needs to be recursively resolved. The EncryptedKeyResolver can therefore only be instantiated with an algorithm. It can also be instantiated with a key (the KEK) or will search the static KeyResolvers to find the appropriate key.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	algorithm
private final List<KeyResolverSpi>	internalKeyResolvers
private final Key	kek
private static final System.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
EncryptedKeyResolver(String algorithm, Key kek, List<KeyResolverSpi> internalKeyResolvers)	Constructor used for when a KEK has been set
EncryptedKeyResolver(String algorithm, List<KeyResolverSpi> internalKeyResolvers)	Constructor for use when a KEK needs to be derived from a KeyInfo list

Method Summary

Modifier and Type	Method	Description
protected boolean	engineCanResolve(Element element, String baseURI, StorageResolver storage)	This method returns whether the KeyResolverSpi is able to perform the requested action.
protected PrivateKey	engineResolvePrivateKey(Element element, String baseURI, StorageResolver storage, boolean secureValidation)	Method engineResolvePrivateKey
protected PublicKey	engineResolvePublicKey(Element element, String baseURI, StorageResolver storage, boolean secureValidation)	Method engineResolvePublicKey
protected SecretKey	engineResolveSecretKey(Element element, String baseURI, StorageResolver storage, boolean secureValidation)	Method engineResolveSecretKey
protected X509Certificate	engineResolveX509Certificate(Element element, String baseURI, StorageResolver storage, boolean secureValidation)	Method engineResolveCertificate

Methods inherited from class org.apache.xml.security.keys.keyresolver.KeyResolverSpi

engineLookupAndResolvePrivateKey, engineLookupAndResolvePublicKey, engineLookupAndResolveSecretKey, engineLookupResolveX509Certificate, getDocFromBytes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG

private static final System.Logger LOG

kek

private final Key kek

algorithm

private final String algorithm

internalKeyResolvers

private final List<KeyResolverSpi> internalKeyResolvers

Constructor Details

EncryptedKeyResolver

public EncryptedKeyResolver(String algorithm,
 List<KeyResolverSpi> internalKeyResolvers)

Constructor for use when a KEK needs to be derived from a KeyInfo list

Parameters:

algorithm -

internalKeyResolvers -

EncryptedKeyResolver

public EncryptedKeyResolver(String algorithm,
 Key kek,
 List<KeyResolverSpi> internalKeyResolvers)

Constructor used for when a KEK has been set

Parameters:

algorithm -

kek -

internalKeyResolvers -

Method Details

engineCanResolve

protected boolean engineCanResolve(Element element,
 String baseURI,
 StorageResolver storage)

This method returns whether the KeyResolverSpi is able to perform the requested action.

Specified by:

engineCanResolve in class KeyResolverSpi

Returns:

whether the KeyResolverSpi is able to perform the requested action.

engineResolvePublicKey

protected PublicKey engineResolvePublicKey(Element element,
 String baseURI,
 StorageResolver storage,
 boolean secureValidation)

Method engineResolvePublicKey

Specified by:

engineResolvePublicKey in class KeyResolverSpi

Returns:

resolved public key from the registered from the element.

engineResolveX509Certificate

protected X509Certificate engineResolveX509Certificate(Element element,
 String baseURI,
 StorageResolver storage,
 boolean secureValidation)

Method engineResolveCertificate

Specified by:

engineResolveX509Certificate in class KeyResolverSpi

Returns:

resolved X509Certificate key from the registered from the elements

engineResolveSecretKey

protected SecretKey engineResolveSecretKey(Element element,
 String baseURI,
 StorageResolver storage,
 boolean secureValidation)

Method engineResolveSecretKey

Specified by:

engineResolveSecretKey in class KeyResolverSpi

Returns:

resolved SecretKey key from the registered from the elements

engineResolvePrivateKey

protected PrivateKey engineResolvePrivateKey(Element element,
 String baseURI,
 StorageResolver storage,
 boolean secureValidation)

Method engineResolvePrivateKey

Specified by:

engineResolvePrivateKey in class KeyResolverSpi

Returns:

resolved PrivateKey key from the registered from the elements