org.opensaml.saml2.encryption

クラス Encrypter

java.lang.Object

org.opensaml.xml.encryption.Encrypter

org.opensaml.saml2.encryption.Encrypter

public class Encrypter
extends Encrypter

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

Overloaded 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:

• INLINE: EncryptedKeys will placed inside the KeyInfo element of the EncryptedData element
• PEER: EncryptedKeys will be placed as peer elements of the EncryptedData inside the EncryptedElementType element

The default placement is PEER.

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.

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	Encrypter.KeyPlacement Options for where to place the resulting EncryptedKey elements with respect to the associated EncryptedData element.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
Encrypter(EncryptionParameters dataEncParams) Constructor.
Encrypter(EncryptionParameters dataEncParams, KeyEncryptionParameters keyEncParam) Constructor.
Encrypter(EncryptionParameters dataEncParams, List<KeyEncryptionParameters> keyEncParams) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
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(EncryptedData encData, List<EncryptedKey> encKeys) Link multiple "multicast" EncryptedKeys to the EncryptedData according to guidelines in SAML Errata E43.
protected void	linkSinglePeerKey(EncryptedData encData, EncryptedKey encKey) Link a single EncryptedKey to the EncryptedData according to guidelines in SAML Errata E43.
protected EncryptedElementType	placeKeysAsPeers(EncryptedElementType encElement, EncryptedData encData, List<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, EncryptedData encData, List<EncryptedKey> encKeys) Place the EncryptedKey elements inside the KeyInfo element within the EncryptedData element.
protected EncryptedElementType	processElements(EncryptedElementType encElement, EncryptedData encData, List<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.

クラスから継承されたメソッド org.opensaml.xml.encryption.Encrypter

checkAndMarshall, checkParams, checkParams, checkParams, checkParams, encryptElement, encryptElement, encryptElement, encryptElement, encryptElementContent, encryptElementContent, encryptElementContent, encryptKey, encryptKey, encryptKey, generateEncryptionKey, getJCAProviderName, postProcessApacheEncryptedKey, setJCAProviderName

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

Encrypter

public Encrypter(EncryptionParameters dataEncParams,
         List<KeyEncryptionParameters> keyEncParams)

Constructor.

パラメータ:

dataEncParams - the data encryption parameters

keyEncParams - the key encryption parameters

Encrypter

public Encrypter(EncryptionParameters dataEncParams,
         KeyEncryptionParameters keyEncParam)

Constructor.

パラメータ:

dataEncParams - the data encryption parameters

keyEncParam - the key encryption parameter

Encrypter

public Encrypter(EncryptionParameters dataEncParams)

Constructor.

パラメータ:

dataEncParams - the data encryption parameters

メソッドの詳細

setIDGenerator

public void setIDGenerator(IdentifierGenerator newIDGenerator)

Set the generator to use when creating XML ID attribute values.

パラメータ:

newIDGenerator - the new IdentifierGenerator to use

getKeyPlacement

public Encrypter.KeyPlacement getKeyPlacement()

Get the current key placement option.

戻り値:

returns the key placement option.

setKeyPlacement

public void setKeyPlacement(Encrypter.KeyPlacement newKeyPlacement)

Set the key placement option.

パラメータ:

newKeyPlacement - The new key placement option to set

encrypt

public EncryptedAssertion encrypt(Assertion assertion)
                           throws EncryptionException

Encrypt the specified Assertion.

パラメータ:

assertion - the Assertion to encrypt

戻り値:

an EncryptedAssertion

例外:

EncryptionException - thrown when encryption generates an error

encryptAsID

public EncryptedID encryptAsID(Assertion assertion)
                        throws EncryptionException

Encrypt the specified Assertion, treating as an identifier and returning an EncryptedID.

パラメータ:

assertion - the Assertion to encrypt

戻り値:

an EncryptedID

例外:

EncryptionException - thrown when encryption generates an error

encrypt

public EncryptedAttribute encrypt(Attribute attribute)
                           throws EncryptionException

Encrypt the specified Attribute.

パラメータ:

attribute - the Attribute to encrypt

戻り値:

an EncryptedAttribute

例外:

EncryptionException - thrown when encryption generates an error

encrypt

public EncryptedID encrypt(NameID nameID)
                    throws EncryptionException

Encrypt the specified NameID.

パラメータ:

nameID - the NameID to encrypt

戻り値:

an EncryptedID

例外:

EncryptionException - thrown when encryption generates an error

encrypt

public EncryptedID encrypt(BaseID baseID)
                    throws EncryptionException

Encrypt the specified BaseID.

パラメータ:

baseID - the BaseID to encrypt

戻り値:

an EncryptedID

例外:

EncryptionException - thrown when encryption generates an error

encrypt

public NewEncryptedID encrypt(NewID newID)
                       throws EncryptionException

Encrypt the specified NewID.

パラメータ:

newID - the NewID to encrypt

戻り値:

a NewEncryptedID

例外:

EncryptionException - thrown when encryption generates an error

processElements

protected EncryptedElementType processElements(EncryptedElementType encElement,
                                   EncryptedData encData,
                                   List<EncryptedKey> encKeys)
                                        throws EncryptionException

Handle post-processing of generated EncryptedData and EncryptedKey(s) and storage in the appropriate EncryptedElementType instance.

パラメータ:

encElement - the EncryptedElementType instance which will hold the encrypted data and keys

encData - the EncryptedData object

encKeys - the list of EncryptedKey objects

戻り値:

the processed EncryptedElementType instance

例外:

EncryptionException - thrown when processing encounters an error

placeKeysInline

protected EncryptedElementType placeKeysInline(EncryptedElementType encElement,
                                   EncryptedData encData,
                                   List<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.

パラメータ:

encElement - the EncryptedElementType instance which will hold the encrypted data and keys

encData - the EncryptedData object

encKeys - the list of EncryptedKey objects

戻り値:

the processed EncryptedElementType instance

placeKeysAsPeers

protected EncryptedElementType placeKeysAsPeers(EncryptedElementType encElement,
                                    EncryptedData encData,
                                    List<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).

パラメータ:

encElement - a specialization of EncryptedElementType to store the encrypted data and keys

encData - the EncryptedData to store

encKeys - the EncryptedKey(s) to store

戻り値:

the resulting specialization of EncryptedElementType

linkSinglePeerKey

protected void linkSinglePeerKey(EncryptedData encData,
                     EncryptedKey encKey)

Link a single EncryptedKey to the EncryptedData according to guidelines in SAML Errata E43.

パラメータ:

encData - the EncryptedData

encKey - the EncryptedKey

linkMultiplePeerKeys

protected void linkMultiplePeerKeys(EncryptedData encData,
                        List<EncryptedKey> encKeys)

Link multiple "multicast" EncryptedKeys to the EncryptedData according to guidelines in SAML Errata E43.

パラメータ:

encData - the EncryptedData

encKeys - the list of EncryptedKeys