Package net.shibboleth.idp.plugin.oidc.op.metadata.impl

Class AlgorithmInfoMetadataValueResolver

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.plugin.oidc.op.metadata.impl.AlgorithmInfoMetadataValueResolver

All Implemented Interfaces:

MetadataValueResolver, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, Resolver<Object,ProfileRequestContext>

public class AlgorithmInfoMetadataValueResolver
extends AbstractIdentifiableInitializableComponent
implements MetadataValueResolver

A MetadataValueResolver for resolving signing/encryption algorithm information from the current SecurityConfiguration.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextLookupStrategy	Strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.
private boolean	resolveEncryptionAlgs	Whether to resolve data and key transport encryption algorithms.
private boolean	resolveKeyTransportEncAlgs	Whether to resolve key transport encryption algorithms.

Constructor Summary

Constructors

Constructor	Description
AlgorithmInfoMetadataValueResolver()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	populateAlgorithmsAgainstPolicy(List<String> algorithms, List<String> candidates, AlgorithmPolicyConfiguration policy)	Verifies the candidates against given policy (inclusion/exclusion) and adds the passed ones to the given list.
Iterable<Object>	resolve(ProfileRequestContext profileRequestContext)
Object	resolveSingle(ProfileRequestContext profileRequestContext)
void	setRelyingPartyContextLookupStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.
void	setResolveEncryptionAlgs(boolean flag)	Set whether to resolve data encryption algorithms.
void	setResolveKeyTransportEncAlgs(boolean flag)	Set whether to resolve key transport algorithms.

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

doInitialize, ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

relyingPartyContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextLookupStrategy

Strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

resolveEncryptionAlgs

private boolean resolveEncryptionAlgs

Whether to resolve data and key transport encryption algorithms. Defaults to false, when signature algorithms are resolved.

resolveKeyTransportEncAlgs

private boolean resolveKeyTransportEncAlgs

Whether to resolve key transport encryption algorithms. Defaults to false, when data encryption algorithms are resolved. This flag is only used when resolveEncryptionAlgs is enabled.

Constructor Details

AlgorithmInfoMetadataValueResolver

public AlgorithmInfoMetadataValueResolver()

Constructor.

Method Details

setRelyingPartyContextLookupStrategy

public void setRelyingPartyContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,RelyingPartyContext> strategy)

Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

Parameters:

strategy - strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext

setResolveEncryptionAlgs

public void setResolveEncryptionAlgs(boolean flag)

Set whether to resolve data encryption algorithms. When set to false, signature algorithms are resolved.

Parameters:

flag - What to set.

setResolveKeyTransportEncAlgs

public void setResolveKeyTransportEncAlgs(boolean flag)

Set whether to resolve key transport algorithms. Defaults to false, when data encryption algorithms are resolved. In any case, resolveEncryptionAlgs must be enabled.

Parameters:

flag - What to set.

resolve

public Iterable<Object> resolve(ProfileRequestContext profileRequestContext)
                         throws ResolverException

Specified by:

resolve in interface Resolver<Object,ProfileRequestContext>

Throws:

ResolverException

populateAlgorithmsAgainstPolicy

protected void populateAlgorithmsAgainstPolicy(List<String> algorithms,
 List<String> candidates,
 AlgorithmPolicyConfiguration policy)

Verifies the candidates against given policy (inclusion/exclusion) and adds the passed ones to the given list.

Parameters:

algorithms - the list where to store the passed candidates

candidates - the candidates to be verified

policy - the policy to be verified against

resolveSingle

public Object resolveSingle(@Nullable
 ProfileRequestContext profileRequestContext)
                     throws ResolverException

Specified by:

resolveSingle in interface Resolver<Object,ProfileRequestContext>

Throws:

ResolverException