Module org.apache.santuario.xmlsec

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

Class PrivateKeyResolver

java.lang.Object

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

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

public class PrivateKeyResolver
extends KeyResolverSpi

Resolves a PrivateKey within a KeyStore based on the KeyInfo hints. For X509Data hints, the certificate associated with the private key entry must match. For a KeyName hint, the KeyName must match the alias of a PrivateKey entry within the KeyStore.

Field Summary

Fields

Modifier and Type	Field	Description
private final KeyStore	keyStore
private static final System.Logger	LOG
private final char[]	password

Constructor Summary

Constructors

Constructor	Description
PrivateKeyResolver(KeyStore keyStore, char[] password)	Constructor.

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.
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
private PrivateKey	resolveX509Certificate(XMLX509Certificate x509Cert)
private PrivateKey	resolveX509Data(Element element, String baseURI)
private PrivateKey	resolveX509IssuerSerial(XMLX509IssuerSerial x509Serial)
private PrivateKey	resolveX509SKI(XMLX509SKI x509SKI)
private PrivateKey	resolveX509SubjectName(XMLX509SubjectName x509SubjectName)

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

keyStore

private final KeyStore keyStore

password

private final char[] password

Constructor Details

PrivateKeyResolver

public PrivateKeyResolver(KeyStore keyStore,
 char[] password)

Constructor.

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)
                                    throws KeyResolverException

Method engineResolvePublicKey

Specified by:

engineResolvePublicKey in class KeyResolverSpi

Returns:

resolved public key from the registered from the element.

Throws:

KeyResolverException

engineResolveX509Certificate

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

Method engineResolveCertificate

Specified by:

engineResolveX509Certificate in class KeyResolverSpi

Returns:

resolved X509Certificate key from the registered from the elements

Throws:

KeyResolverException

engineResolveSecretKey

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

Method engineResolveSecretKey

Specified by:

engineResolveSecretKey in class KeyResolverSpi

Returns:

resolved SecretKey key from the registered from the elements

Throws:

KeyResolverException

engineResolvePrivateKey

public PrivateKey engineResolvePrivateKey(Element element,
 String baseURI,
 StorageResolver storage,
 boolean secureValidation)
                                   throws KeyResolverException

Method engineResolvePrivateKey

Specified by:

engineResolvePrivateKey in class KeyResolverSpi

Returns:

resolved PrivateKey key from the registered from the elements

Throws:

KeyResolverException

resolveX509Data

private PrivateKey resolveX509Data(Element element,
 String baseURI)

resolveX509SKI

private PrivateKey resolveX509SKI(XMLX509SKI x509SKI)
                           throws XMLSecurityException,
KeyStoreException

Throws:

XMLSecurityException

KeyStoreException

resolveX509IssuerSerial

private PrivateKey resolveX509IssuerSerial(XMLX509IssuerSerial x509Serial)
                                    throws KeyStoreException

Throws:

KeyStoreException

resolveX509SubjectName

private PrivateKey resolveX509SubjectName(XMLX509SubjectName x509SubjectName)
                                   throws KeyStoreException

Throws:

KeyStoreException

resolveX509Certificate

private PrivateKey resolveX509Certificate(XMLX509Certificate x509Cert)
                                   throws XMLSecurityException,
KeyStoreException

Throws:

XMLSecurityException

KeyStoreException