Module org.apache.santuario.xmlsec
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
TheEncryptedKeyResolveris 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. TheEncryptedKeyResolvercan 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 java.lang.Stringalgorithmprivate java.util.List<KeyResolverSpi>internalKeyResolversprivate java.security.Keykekprivate static java.lang.System.LoggerLOG
-
Constructor Summary
Constructors Constructor Description EncryptedKeyResolver(java.lang.String algorithm, java.security.Key kek, java.util.List<KeyResolverSpi> internalKeyResolvers)Constructor used for when a KEK has been setEncryptedKeyResolver(java.lang.String algorithm, java.util.List<KeyResolverSpi> internalKeyResolvers)Constructor for use when a KEK needs to be derived from a KeyInfo list
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleanengineCanResolve(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage)This method returns whether the KeyResolverSpi is able to perform the requested action.protected java.security.PrivateKeyengineResolvePrivateKey(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage, boolean secureValidation)Method engineResolvePrivateKeyprotected java.security.PublicKeyengineResolvePublicKey(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage, boolean secureValidation)Method engineResolvePublicKeyprotected javax.crypto.SecretKeyengineResolveSecretKey(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage, boolean secureValidation)Method engineResolveSecretKeyprotected java.security.cert.X509CertificateengineResolveX509Certificate(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage, boolean secureValidation)Method engineResolveCertificate-
Methods inherited from class org.apache.xml.security.keys.keyresolver.KeyResolverSpi
engineLookupAndResolvePrivateKey, engineLookupAndResolvePublicKey, engineLookupAndResolveSecretKey, engineLookupResolveX509Certificate, getDocFromBytes
-
-
-
-
Field Detail
-
LOG
private static final java.lang.System.Logger LOG
-
kek
private final java.security.Key kek
-
algorithm
private final java.lang.String algorithm
-
internalKeyResolvers
private final java.util.List<KeyResolverSpi> internalKeyResolvers
-
-
Constructor Detail
-
EncryptedKeyResolver
public EncryptedKeyResolver(java.lang.String algorithm, java.util.List<KeyResolverSpi> internalKeyResolvers)Constructor for use when a KEK needs to be derived from a KeyInfo list- Parameters:
algorithm-internalKeyResolvers-
-
EncryptedKeyResolver
public EncryptedKeyResolver(java.lang.String algorithm, java.security.Key kek, java.util.List<KeyResolverSpi> internalKeyResolvers)Constructor used for when a KEK has been set- Parameters:
algorithm-kek-internalKeyResolvers-
-
-
Method Detail
-
engineCanResolve
protected boolean engineCanResolve(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage)This method returns whether the KeyResolverSpi is able to perform the requested action.- Specified by:
engineCanResolvein classKeyResolverSpi- Returns:
- whether the KeyResolverSpi is able to perform the requested action.
-
engineResolvePublicKey
protected java.security.PublicKey engineResolvePublicKey(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage, boolean secureValidation)Method engineResolvePublicKey- Specified by:
engineResolvePublicKeyin classKeyResolverSpi- Returns:
- resolved public key from the registered from the element.
-
engineResolveX509Certificate
protected java.security.cert.X509Certificate engineResolveX509Certificate(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage, boolean secureValidation)Method engineResolveCertificate- Specified by:
engineResolveX509Certificatein classKeyResolverSpi- Returns:
- resolved X509Certificate key from the registered from the elements
-
engineResolveSecretKey
protected javax.crypto.SecretKey engineResolveSecretKey(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage, boolean secureValidation)Method engineResolveSecretKey- Specified by:
engineResolveSecretKeyin classKeyResolverSpi- Returns:
- resolved SecretKey key from the registered from the elements
-
engineResolvePrivateKey
protected java.security.PrivateKey engineResolvePrivateKey(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage, boolean secureValidation)Method engineResolvePrivateKey- Specified by:
engineResolvePrivateKeyin classKeyResolverSpi- Returns:
- resolved PrivateKey key from the registered from the elements
-
-