org.opensaml.saml2.encryption
Class Encrypter

java.lang.Object
  extended by org.opensaml.xml.encryption.Encrypter
      extended by org.opensaml.saml2.encryption.Encrypter

public class Encrypter
extends org.opensaml.xml.encryption.Encrypter

Encrypter for SAML 2 SAMLObjects which has specific options for generating instances of subtypes of EncryptedElementType.

Overload methods are provided for encrypting various SAML 2 elements to their corresponding encrypted element variant of EncryptedElementType.

Support is also provided for differing placement options for any associated EncryptedKeys that may be generated. The options are:

The default placement is INLINE.

The EncryptedKey forward and back referencing behavior associated with these key placement options is intended to be consistent with the guidelines detailed in SAML 2 Errata E43. See that document for further information.

For information on other parameters and options, and general XML Encryption issues, see Encrypter.


Nested Class Summary
static class Encrypter.KeyPlacement
          Options for where to place the resulting EncryptedKey elements with respect to the associated EncryptedData element.
 
Constructor Summary
Encrypter(org.opensaml.xml.encryption.EncryptionParameters dataEncParams)
          Constructor.
Encrypter(org.opensaml.xml.encryption.EncryptionParameters dataEncParams, org.opensaml.xml.encryption.KeyEncryptionParameters keyEncParam)
          Constructor.
Encrypter(org.opensaml.xml.encryption.EncryptionParameters dataEncParams, java.util.List<org.opensaml.xml.encryption.KeyEncryptionParameters> keyEncParams)
          Constructor.
 
Method Summary
 EncryptedAssertion encrypt(Assertion assertion)
          Encrypt the specified Assertion.
 EncryptedAttribute encrypt(Attribute attribute)
          Encrypt the specified Attribute.
 EncryptedID encrypt(BaseID baseID)
          Encrypt the specified BaseID.
 EncryptedID encrypt(NameID nameID)
          Encrypt the specified NameID.
 NewEncryptedID encrypt(NewID newID)
          Encrypt the specified NewID.
 EncryptedID encryptAsID(Assertion assertion)
          Encrypt the specified Assertion, treating as an identifier and returning an EncryptedID.
 Encrypter.KeyPlacement getKeyPlacement()
          Get the current key placement option.
protected  void linkMultiplePeerKeys(org.opensaml.xml.encryption.EncryptedData encData, java.util.List<org.opensaml.xml.encryption.EncryptedKey> encKeys)
          Link multiple "multicast" EncryptedKeys to the EncryptedData according to guidelines in SAML Errata E43.
protected  void linkSinglePeerKey(org.opensaml.xml.encryption.EncryptedData encData, org.opensaml.xml.encryption.EncryptedKey encKey)
          Link a single EncryptedKey to the EncryptedData according to guidelines in SAML Errata E43.
protected  EncryptedElementType placeKeysAsPeers(EncryptedElementType encElement, org.opensaml.xml.encryption.EncryptedData encData, java.util.List<org.opensaml.xml.encryption.EncryptedKey> encKeys)
          Store the specified EncryptedData and EncryptedKey(s) in the specified instance of EncryptedElementType as peer elements, following SAML 2 Errata E43 guidelines for forward and back referencing between the EncryptedData and EncryptedKey(s).
protected  EncryptedElementType placeKeysInline(EncryptedElementType encElement, org.opensaml.xml.encryption.EncryptedData encData, java.util.List<org.opensaml.xml.encryption.EncryptedKey> encKeys)
          Place the EncryptedKey elements inside the KeyInfo element within the EncryptedData element.
protected  EncryptedElementType processElements(EncryptedElementType encElement, org.opensaml.xml.encryption.EncryptedData encData, java.util.List<org.opensaml.xml.encryption.EncryptedKey> encKeys)
          Handle post-processing of generated EncryptedData and EncryptedKey(s) and storage in the appropriate EncryptedElementType instance.
 void setIDGenerator(IdentifierGenerator newIDGenerator)
          Set the generator to use when creating XML ID attribute values.
 void setKeyPlacement(Encrypter.KeyPlacement newKeyPlacement)
          Set the key placement option.
 
Methods inherited from class org.opensaml.xml.encryption.Encrypter
checkAndMarshall, checkParams, checkParams, checkParams, checkParams, encryptElement, encryptElement, encryptElement, encryptElement, encryptElementContent, encryptElementContent, encryptElementContent, encryptKey, encryptKey, encryptKey, generateEncryptionKey, getJCAProviderName, postProcessApacheEncryptedKey, setJCAProviderName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Encrypter

public Encrypter(org.opensaml.xml.encryption.EncryptionParameters dataEncParams,
                 java.util.List<org.opensaml.xml.encryption.KeyEncryptionParameters> keyEncParams)
Constructor.

Parameters:
dataEncParams - the data encryption parameters
keyEncParams - the key encryption parameters

Encrypter

public Encrypter(org.opensaml.xml.encryption.EncryptionParameters dataEncParams,
                 org.opensaml.xml.encryption.KeyEncryptionParameters keyEncParam)
Constructor.

Parameters:
dataEncParams - the data encryption parameters
keyEncParam - the key encryption parameter

Encrypter

public Encrypter(org.opensaml.xml.encryption.EncryptionParameters dataEncParams)
Constructor.

Parameters:
dataEncParams - the data encryption parameters
Method Detail

setIDGenerator

public void setIDGenerator(IdentifierGenerator newIDGenerator)
Set the generator to use when creating XML ID attribute values.

Parameters:
newIDGenerator - the new IdentifierGenerator to use

getKeyPlacement

public Encrypter.KeyPlacement getKeyPlacement()
Get the current key placement option.

Returns:
returns the key placement option.

setKeyPlacement

public void setKeyPlacement(Encrypter.KeyPlacement newKeyPlacement)
Set the key placement option.

Parameters:
newKeyPlacement - The new key placement option to set

encrypt

public EncryptedAssertion encrypt(Assertion assertion)
                           throws org.opensaml.xml.encryption.EncryptionException
Encrypt the specified Assertion.

Parameters:
assertion - the Assertion to encrypt
Returns:
an EncryptedAssertion
Throws:
org.opensaml.xml.encryption.EncryptionException - thrown when encryption generates an error

encryptAsID

public EncryptedID encryptAsID(Assertion assertion)
                        throws org.opensaml.xml.encryption.EncryptionException
Encrypt the specified Assertion, treating as an identifier and returning an EncryptedID.

Parameters:
assertion - the Assertion to encrypt
Returns:
an EncryptedID
Throws:
org.opensaml.xml.encryption.EncryptionException - thrown when encryption generates an error

encrypt

public EncryptedAttribute encrypt(Attribute attribute)
                           throws org.opensaml.xml.encryption.EncryptionException
Encrypt the specified Attribute.

Parameters:
attribute - the Attribute to encrypt
Returns:
an EncryptedAttribute
Throws:
org.opensaml.xml.encryption.EncryptionException - thrown when encryption generates an error

encrypt

public EncryptedID encrypt(NameID nameID)
                    throws org.opensaml.xml.encryption.EncryptionException
Encrypt the specified NameID.

Parameters:
nameID - the NameID to encrypt
Returns:
an EncryptedID
Throws:
org.opensaml.xml.encryption.EncryptionException - thrown when encryption generates an error

encrypt

public EncryptedID encrypt(BaseID baseID)
                    throws org.opensaml.xml.encryption.EncryptionException
Encrypt the specified BaseID.

Parameters:
baseID - the BaseID to encrypt
Returns:
an EncryptedID
Throws:
org.opensaml.xml.encryption.EncryptionException - thrown when encryption generates an error

encrypt

public NewEncryptedID encrypt(NewID newID)
                       throws org.opensaml.xml.encryption.EncryptionException
Encrypt the specified NewID.

Parameters:
newID - the NewID to encrypt
Returns:
a NewEncryptedID
Throws:
org.opensaml.xml.encryption.EncryptionException - thrown when encryption generates an error

processElements

protected EncryptedElementType processElements(EncryptedElementType encElement,
                                               org.opensaml.xml.encryption.EncryptedData encData,
                                               java.util.List<org.opensaml.xml.encryption.EncryptedKey> encKeys)
                                        throws org.opensaml.xml.encryption.EncryptionException
Handle post-processing of generated EncryptedData and EncryptedKey(s) and storage in the appropriate EncryptedElementType instance.

Parameters:
encElement - the EncryptedElementType instance which will hold the encrypted data and keys
encData - the EncryptedData object
encKeys - the list of EncryptedKey objects
Returns:
the processed EncryptedElementType instance
Throws:
org.opensaml.xml.encryption.EncryptionException - thrown when processing encounters an error

placeKeysInline

protected EncryptedElementType placeKeysInline(EncryptedElementType encElement,
                                               org.opensaml.xml.encryption.EncryptedData encData,
                                               java.util.List<org.opensaml.xml.encryption.EncryptedKey> encKeys)
Place the EncryptedKey elements inside the KeyInfo element within the EncryptedData element. Although operationally trivial, this method is provided so that subclasses may override or augment as desired.

Parameters:
encElement - the EncryptedElementType instance which will hold the encrypted data and keys
encData - the EncryptedData object
encKeys - the list of EncryptedKey objects
Returns:
the processed EncryptedElementType instance

placeKeysAsPeers

protected EncryptedElementType placeKeysAsPeers(EncryptedElementType encElement,
                                                org.opensaml.xml.encryption.EncryptedData encData,
                                                java.util.List<org.opensaml.xml.encryption.EncryptedKey> encKeys)
Store the specified EncryptedData and EncryptedKey(s) in the specified instance of EncryptedElementType as peer elements, following SAML 2 Errata E43 guidelines for forward and back referencing between the EncryptedData and EncryptedKey(s).

Parameters:
encElement - a specialization of EncryptedElementType to store the encrypted data and keys
encData - the EncryptedData to store
encKeys - the EncryptedKey(s) to store
Returns:
the resulting specialization of EncryptedElementType

linkSinglePeerKey

protected void linkSinglePeerKey(org.opensaml.xml.encryption.EncryptedData encData,
                                 org.opensaml.xml.encryption.EncryptedKey encKey)
Link a single EncryptedKey to the EncryptedData according to guidelines in SAML Errata E43.

Parameters:
encData - the EncryptedData
encKey - the EncryptedKey

linkMultiplePeerKeys

protected void linkMultiplePeerKeys(org.opensaml.xml.encryption.EncryptedData encData,
                                    java.util.List<org.opensaml.xml.encryption.EncryptedKey> encKeys)
Link multiple "multicast" EncryptedKeys to the EncryptedData according to guidelines in SAML Errata E43.

Parameters:
encData - the EncryptedData
encKeys - the list of EncryptedKeys


Copyright © 2006-2012 Internet2. All Rights Reserved.