Module org.apache.santuario.xmlsec

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

Class RetrievalMethodResolver

java.lang.Object

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

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

public class RetrievalMethodResolver
extends KeyResolverSpi

The RetrievalMethodResolver can retrieve public keys and certificates from other locations. The location is specified using the ds:RetrievalMethod element which points to the location. This includes the handling of raw (binary) X.509 certificate which are not encapsulated in an XML structure. If the retrieval process encounters an element which the RetrievalMethodResolver cannot handle itself, resolving of the extracted element is delegated back to the KeyResolver mechanism.

Field Summary

Fields

Modifier and Type	Field	Description
private static final System.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
RetrievalMethodResolver()

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
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
private static Element	getDocumentElement(Set<Node> set)
private static X509Certificate	getRawCertificate(XMLSignatureInput resource)
private static Element	obtainReferenceElement(XMLSignatureInput resource, boolean secureValidation)
private static X509Certificate	resolveCertificate(Element e, String baseURI, StorageResolver storage, boolean secureValidation)	Retrieves a x509Certificate from the given information
private static XMLSignatureInput	resolveInput(RetrievalMethod rm, String baseURI, boolean secureValidation)	Resolves the input from the given retrieval method
private static PublicKey	resolveKey(Element e, String baseURI, StorageResolver storage, boolean secureValidation)	Retrieves a PublicKey from the given information

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

Constructor Details

RetrievalMethodResolver

public RetrievalMethodResolver()

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

resolveCertificate

private static X509Certificate resolveCertificate(Element e,
 String baseURI,
 StorageResolver storage,
 boolean secureValidation)
                                           throws KeyResolverException

Retrieves a x509Certificate from the given information

Parameters:

e -

baseURI -

storage -

Returns:

a x509Certificate from the given information

Throws:

KeyResolverException

resolveKey

private static PublicKey resolveKey(Element e,
 String baseURI,
 StorageResolver storage,
 boolean secureValidation)
                             throws KeyResolverException

Retrieves a PublicKey from the given information

Parameters:

e -

baseURI -

storage -

secureValidation -

Returns:

a PublicKey from the given information

Throws:

KeyResolverException

obtainReferenceElement

private static Element obtainReferenceElement(XMLSignatureInput resource,
 boolean secureValidation)
                                       throws CanonicalizationException,
XMLParserException,
IOException,
KeyResolverException

Throws:

CanonicalizationException

XMLParserException

IOException

KeyResolverException

getRawCertificate

private static X509Certificate getRawCertificate(XMLSignatureInput resource)
                                          throws CanonicalizationException,
IOException,
CertificateException

Throws:

CanonicalizationException

IOException

CertificateException

resolveInput

private static XMLSignatureInput resolveInput(RetrievalMethod rm,
 String baseURI,
 boolean secureValidation)
                                       throws XMLSecurityException

Resolves the input from the given retrieval method

Returns:

the input from the given retrieval method

Throws:

XMLSecurityException

engineResolveSecretKey

public 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

getDocumentElement

private static Element getDocumentElement(Set<Node> set)