Package net.shibboleth.oidc.security.jose.impl

Class BasicEncryptionConfiguration

java.lang.Object

org.opensaml.xmlsec.impl.BasicAlgorithmPolicyConfiguration

net.shibboleth.oidc.security.jose.impl.BasicEncryptionConfiguration

All Implemented Interfaces:

EncryptionConfiguration, AlgorithmPolicyConfiguration

public class BasicEncryptionConfiguration
extends BasicAlgorithmPolicyConfiguration
implements EncryptionConfiguration

Basic implementation of EncryptionConfiguration for handling JWE encryption.

Since:

2.2.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensaml.xmlsec.AlgorithmPolicyConfiguration

AlgorithmPolicyConfiguration.Precedence

Field Summary

Fields

Modifier and Type	Field	Description
private CredentialResolver	contentEncryptionKeyCredentialResolver	The content encryption key (CEK) resolver.
private List<String>	dataEncryptionAlgorithms	Data encryption algorithm URIs.
private CredentialResolver	kekKeyCredentialResolver	The EncryptedKey's credential resolver.
private List<String>	keyTransportEncryptionAlgorithms	Key transport encryption algorithm URIs.

Fields inherited from class org.opensaml.xmlsec.impl.BasicAlgorithmPolicyConfiguration

DEFAULT_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
BasicEncryptionConfiguration()	Constructor.

Method Summary

Modifier and Type	Method	Description
CredentialResolver	getContentEncryptionKeyCredentialResolver()	Get the CredentialResolver to resolve the content encryption key.
List<String>	getDataEncryptionAlgorithms()	Get the list of preferred data encryption algorithm URIs, in preference order.
CredentialResolver	getKEKCredentialResolver()	Get the CredentialResolver to resolve the key encryption or key wrapping key.
List<String>	getKeyTransportEncryptionAlgorithms()	Get the list of preferred key transport encryption algorithm URIs, in preference order.
void	setContentEncryptionKeyCredentialResolver(CredentialResolver resolver)	Set the CredentialResolver to resolve the content encryption key.
void	setDataEncryptionAlgorithms(List<String> algorithms)	Set the data encryption algorithms to use.
void	setKEKCredentialResolver(CredentialResolver resolver)	Set the CredentialResolver to resolve the key encryption or key wrapping key.
void	setKeyTransportEncryptionAlgorithms(List<String> algorithms)	Set the key transport encryption algorithms to use.

Methods inherited from class org.opensaml.xmlsec.impl.BasicAlgorithmPolicyConfiguration

getExcludedAlgorithms, getIncludedAlgorithms, getIncludeExcludePrecedence, isExcludeMerge, isIncludeMerge, setExcludedAlgorithms, setExcludeMerge, setIncludedAlgorithms, setIncludeExcludePrecedence, setIncludeMerge

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.xmlsec.AlgorithmPolicyConfiguration

getExcludedAlgorithms, getIncludedAlgorithms, getIncludeExcludePrecedence, isExcludeMerge, isIncludeMerge

Field Detail

dataEncryptionAlgorithms

@Nonnull
@NonnullElements
private List<String> dataEncryptionAlgorithms

Data encryption algorithm URIs.

keyTransportEncryptionAlgorithms

@Nonnull
@NonnullElements
private List<String> keyTransportEncryptionAlgorithms

Key transport encryption algorithm URIs.

kekKeyCredentialResolver

@Nullable
private CredentialResolver kekKeyCredentialResolver

The EncryptedKey's credential resolver.

contentEncryptionKeyCredentialResolver

@Nullable
private CredentialResolver contentEncryptionKeyCredentialResolver

The content encryption key (CEK) resolver.

Constructor Detail

BasicEncryptionConfiguration

public BasicEncryptionConfiguration()

Constructor.

Method Detail

getContentEncryptionKeyCredentialResolver

@Nullable
public CredentialResolver getContentEncryptionKeyCredentialResolver()

Description copied from interface: EncryptionConfiguration

Get the CredentialResolver to resolve the content encryption key.

Specified by:

getContentEncryptionKeyCredentialResolver in interface EncryptionConfiguration

Returns:

the KeyInfoCredentialResolver instance

setContentEncryptionKeyCredentialResolver

public void setContentEncryptionKeyCredentialResolver(@Nullable
                                                      CredentialResolver resolver)

Set the CredentialResolver to resolve the content encryption key.

Parameters:

resolver - the CredentialResolver instance

getKEKCredentialResolver

@Nullable
public CredentialResolver getKEKCredentialResolver()

Description copied from interface: EncryptionConfiguration

Get the CredentialResolver to resolve the key encryption or key wrapping key.

Specified by:

getKEKCredentialResolver in interface EncryptionConfiguration

Returns:

the CredentialResolver instance

setKEKCredentialResolver

public void setKEKCredentialResolver(@Nullable
                                     CredentialResolver resolver)

Set the CredentialResolver to resolve the key encryption or key wrapping key.

Parameters:

resolver - the CredentialResolver instance

getDataEncryptionAlgorithms

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public List<String> getDataEncryptionAlgorithms()

Get the list of preferred data encryption algorithm URIs, in preference order.

Specified by:

getDataEncryptionAlgorithms in interface EncryptionConfiguration

Returns:

the list of algorithm URIs, may be empty

setDataEncryptionAlgorithms

public void setDataEncryptionAlgorithms(@Nullable @NonnullElements
                                        List<String> algorithms)

Set the data encryption algorithms to use.

Parameters:

algorithms - the list of algorithms

getKeyTransportEncryptionAlgorithms

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public List<String> getKeyTransportEncryptionAlgorithms()

Get the list of preferred key transport encryption algorithm URIs, in preference order.

Specified by:

getKeyTransportEncryptionAlgorithms in interface EncryptionConfiguration

Returns:

the list of algorithm URIs, may be empty

setKeyTransportEncryptionAlgorithms

public void setKeyTransportEncryptionAlgorithms(@Nullable @NonnullElements
                                                List<String> algorithms)

Set the key transport encryption algorithms to use.

Parameters:

algorithms - the list of algorithms