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 java.security.KeyStore	keyStore
private static org.slf4j.Logger	LOG
private char[]	password

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

globalResolver, properties, secureValidation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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.
java.security.PrivateKey	engineLookupAndResolvePrivateKey(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage)	Method engineResolvePrivateKey Method engineLookupAndResolvePrivateKey
java.security.PublicKey	engineLookupAndResolvePublicKey(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage)	Method engineLookupAndResolvePublicKey
java.security.cert.X509Certificate	engineLookupResolveX509Certificate(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage)	Method engineResolveX509Certificate Method engineLookupResolveX509Certificate
javax.crypto.SecretKey	engineResolveSecretKey(org.w3c.dom.Element element, java.lang.String baseURI, StorageResolver storage)	Method engineResolveSecretKey
private java.security.PrivateKey	resolveX509Certificate(XMLX509Certificate x509Cert)
private java.security.PrivateKey	resolveX509Data(org.w3c.dom.Element element, java.lang.String baseURI)
private java.security.PrivateKey	resolveX509IssuerSerial(XMLX509IssuerSerial x509Serial)
private java.security.PrivateKey	resolveX509SKI(XMLX509SKI x509SKI)
private java.security.PrivateKey	resolveX509SubjectName(XMLX509SubjectName x509SubjectName)

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

engineGetProperty, engineLookupAndResolveSecretKey, engineResolvePublicKey, engineResolveX509Certificate, engineSetProperty, getDocFromBytes, setGlobalResolver, setSecureValidation, understandsProperty

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

keyStore

private java.security.KeyStore keyStore

password

private char[] password

Constructor Detail

PrivateKeyResolver

public PrivateKeyResolver(java.security.KeyStore keyStore,
                          char[] password)

Constructor.

Method Detail

engineCanResolve

public 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.

Overrides:

engineCanResolve in class KeyResolverSpi

Parameters:

element -

baseURI -

storage -

Returns:

whether the KeyResolverSpi is able to perform the requested action.

engineLookupAndResolvePublicKey

public java.security.PublicKey engineLookupAndResolvePublicKey(org.w3c.dom.Element element,
                                                               java.lang.String baseURI,
                                                               StorageResolver storage)
                                                        throws KeyResolverException

Method engineLookupAndResolvePublicKey

Overrides:

engineLookupAndResolvePublicKey in class KeyResolverSpi

Parameters:

element -

baseURI -

storage -

Returns:

null if no PublicKey could be obtained

Throws:

KeyResolverException

engineLookupResolveX509Certificate

public java.security.cert.X509Certificate engineLookupResolveX509Certificate(org.w3c.dom.Element element,
                                                                             java.lang.String baseURI,
                                                                             StorageResolver storage)
                                                                      throws KeyResolverException

Method engineResolveX509Certificate Method engineLookupResolveX509Certificate

Overrides:

engineLookupResolveX509Certificate in class KeyResolverSpi

Parameters:

element -

baseURI -

storage -

Returns:

resolved X509Certificate key from the registered from the elements

Throws:

KeyResolverException

engineResolveSecretKey

public javax.crypto.SecretKey engineResolveSecretKey(org.w3c.dom.Element element,
                                                     java.lang.String baseURI,
                                                     StorageResolver storage)
                                              throws KeyResolverException

Method engineResolveSecretKey

Overrides:

engineResolveSecretKey in class KeyResolverSpi

Parameters:

element -

baseURI -

storage -

Returns:

resolved SecretKey key or null if no SecretKey could be obtained

Throws:

KeyResolverException

engineLookupAndResolvePrivateKey

public java.security.PrivateKey engineLookupAndResolvePrivateKey(org.w3c.dom.Element element,
                                                                 java.lang.String baseURI,
                                                                 StorageResolver storage)
                                                          throws KeyResolverException

Method engineResolvePrivateKey Method engineLookupAndResolvePrivateKey

Overrides:

engineLookupAndResolvePrivateKey in class KeyResolverSpi

Parameters:

element -

baseURI -

storage -

Returns:

resolved PrivateKey key or null if no PrivateKey could be obtained

Throws:

KeyResolverException

resolveX509Data

private java.security.PrivateKey resolveX509Data(org.w3c.dom.Element element,
                                                 java.lang.String baseURI)

resolveX509SKI

private java.security.PrivateKey resolveX509SKI(XMLX509SKI x509SKI)
                                         throws XMLSecurityException,
                                                java.security.KeyStoreException

Throws:

XMLSecurityException

java.security.KeyStoreException

resolveX509IssuerSerial

private java.security.PrivateKey resolveX509IssuerSerial(XMLX509IssuerSerial x509Serial)
                                                  throws java.security.KeyStoreException

Throws:

java.security.KeyStoreException

resolveX509SubjectName

private java.security.PrivateKey resolveX509SubjectName(XMLX509SubjectName x509SubjectName)
                                                 throws java.security.KeyStoreException

Throws:

java.security.KeyStoreException

resolveX509Certificate

private java.security.PrivateKey resolveX509Certificate(XMLX509Certificate x509Cert)
                                                 throws XMLSecurityException,
                                                        java.security.KeyStoreException

Throws:

XMLSecurityException

java.security.KeyStoreException