oracle.security.xmlsec.wss.util

Class WSSKeyRetriever

java.lang.Object

oracle.security.xmlsec.keys.retrieval.KeyRetriever

oracle.security.xmlsec.wss.util.WSSKeyRetriever

public class WSSKeyRetriever
extends KeyRetriever

This class server as an utility for extracting keys from dsig:KeyInfo instances containing wsse elements. It can only retrieve information located in the same org.w3c.dom.Document instance.

Users should override this class to implement retrieval of keys from persistant storage.

Constructor Summary

Constructors

Constructor and Description
WSSKeyRetriever()

Method Summary

Modifier and Type	Method and Description
java.security.cert.X509Certificate	processCert(KeyInfoData kid) Parse the KeyInfo data and obtain the X509Certificate certificate.
java.security.PrivateKey	processPrivateKey(KeyInfoData kid) Parse the KeyInfo data and obtain the private key.
javax.crypto.SecretKey	processSymmetricKey(KeyInfoData kid) Parse the KeyInfo data and obtain the symmetric key.
protected java.security.cert.X509Certificate	retrieveCertificate(KeyInfoData keyInfo) Retrieves the certificate identified by the given KeyInfoData.
protected java.security.PrivateKey	retrievePrivateKey(KeyInfoData keyInfo) Retrieves the private key identified by the given KeyInfoData.
protected java.security.PublicKey	retrievePublicKey(KeyInfoData keyInfo) Retrieves the public key identified by the given KeyInfoData.
protected javax.crypto.SecretKey	retrieveSymmetricKey(KeyInfoData keyInfo) Retrieves the secret key identified by the given KeyInfoData.

Methods inherited from class oracle.security.xmlsec.keys.retrieval.KeyRetriever

addKeyRetriever, getAuthenticator, getCertificate, getCertificate, getPrivateKey, getPrivateKey, getPublicKey, getPublicKey, getSymmetricKey, getSymmetricKey, removeKeyRetriever, retrieveCertificate, retrievePrivateKey, retrievePublicKey, retrieveSymmetricKey, setAuthenticator, setCertificateValidator, validateCertificate, validateCertificate, validateCertificate

Methods inherited from class java.lang.Object

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

Constructor Detail

WSSKeyRetriever

public WSSKeyRetriever()

Method Detail

retrieveCertificate

protected java.security.cert.X509Certificate retrieveCertificate(KeyInfoData keyInfo)
                                                          throws KeyRetrievalException

Description copied from class: KeyRetriever

Retrieves the certificate identified by the given KeyInfoData. If this method is not overridden it always returns null.

Overrides:

retrieveCertificate in class KeyRetriever

Parameters:

keyInfo - A KeyInfoData to be used to locate the certificate.

Returns:

A X509Certificate, or null if none could be located.

Throws:

StorageAuthenticationException - If an error occurs authenticating to the key source.

KeyRetrievalException

retrievePublicKey

protected java.security.PublicKey retrievePublicKey(KeyInfoData keyInfo)
                                             throws KeyRetrievalException

Description copied from class: KeyRetriever

Retrieves the public key identified by the given KeyInfoData. If this method is not overridden it always returns null.

Overrides:

retrievePublicKey in class KeyRetriever

Parameters:

keyInfo - A KeyInfoData to be used to locate the public key.

Returns:

A PublicKey, or null if none could be located.

Throws:

StorageAuthenticationException - If an error occurs authenticating to the key source.

KeyRetrievalException

retrievePrivateKey

protected java.security.PrivateKey retrievePrivateKey(KeyInfoData keyInfo)
                                               throws KeyRetrievalException

Description copied from class: KeyRetriever

Retrieves the private key identified by the given KeyInfoData. If this method is not overridden it always returns null.

Overrides:

retrievePrivateKey in class KeyRetriever

Parameters:

keyInfo - A KeyInfoData to be used to locate the private key.

Returns:

A PrivateKey, or null if none could be located.

Throws:

StorageAuthenticationException - If an error occurs authenticating to the key source.

KeyRetrievalException

retrieveSymmetricKey

protected javax.crypto.SecretKey retrieveSymmetricKey(KeyInfoData keyInfo)
                                               throws KeyRetrievalException

Description copied from class: KeyRetriever

Retrieves the secret key identified by the given KeyInfoData. If this method is not overridden it always returns null.

Overrides:

retrieveSymmetricKey in class KeyRetriever

Parameters:

keyInfo - A KeyInfoData to be used to locate the secret key.

Returns:

A SecretKey, or null if none could be located.

Throws:

StorageAuthenticationException - If an error occurs authenticating to the key source.

KeyRetrievalException

processCert

public java.security.cert.X509Certificate processCert(KeyInfoData kid)
                                               throws WSSException

Parse the KeyInfo data and obtain the X509Certificate certificate. This method assumes that the reference points to a X.509 certificate token in the same Document.

Parameters:

kid - The wsse:SecurityTokenReference element.

Returns:

Returns the X509Certificate certificate or null.

Throws:

WSSException

processPrivateKey

public java.security.PrivateKey processPrivateKey(KeyInfoData kid)
                                           throws WSSException

Parse the KeyInfo data and obtain the private key.

Parameters:

kid - The wsse:SecurityTokenReference element.

Returns:

Returns the private key or null.

Throws:

WSSException

processSymmetricKey

public javax.crypto.SecretKey processSymmetricKey(KeyInfoData kid)
                                           throws WSSException

Parse the KeyInfo data and obtain the symmetric key.

Parameters:

kid - The wsse:SecurityTokenReference element.

Returns:

Returns the symmetric key or null.

Throws:

WSSException