Package net.shibboleth.idp.plugin.authn.webauthn.policy.impl

Class FunctionalCredentialPolicyRule

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.plugin.authn.webauthn.policy.impl.AbstractCredentialPolicyRule

net.shibboleth.idp.plugin.authn.webauthn.policy.impl.FunctionalCredentialPolicyRule

All Implemented Interfaces:

CredentialPolicy, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class FunctionalCredentialPolicyRule
extends AbstractCredentialPolicyRule

A CredentialPolicy that evaluates a BiFunction to determine if a credential should be accepted or rejected.

Nested Class Summary

Nested classes/interfaces inherited from interface net.shibboleth.idp.plugin.authn.webauthn.policy.CredentialPolicy

CredentialPolicy.CredentialPolicyOutcome

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private BiFunction<EnhancedCredentialRecord,FunctionalRuleContext,CredentialPolicy.CredentialPolicyOutcome>	rule	The function to run.

Constructor Summary

Constructors

Constructor	Description
FunctionalCredentialPolicyRule()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected CredentialPolicy.CredentialPolicyOutcome	doEvaluate(EnhancedCredentialRecord credential, ProfileRequestContext prc, WebAuthnAuthenticationContext webAuthnContext)	Execute the policy.
void	setRule(BiFunction<EnhancedCredentialRecord,FunctionalRuleContext,CredentialPolicy.CredentialPolicyOutcome> function)	Set the policy function to run.

Methods inherited from class net.shibboleth.idp.plugin.authn.webauthn.policy.impl.AbstractCredentialPolicyRule

evaluate, getFidoMetadataService, setActivationCondition, setActivationConditionStrategy, setFidoMetadataService, setWebAuthnContextLookupStrategy

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.

rule

@Nonnull
private BiFunction<EnhancedCredentialRecord,FunctionalRuleContext,CredentialPolicy.CredentialPolicyOutcome> rule

The function to run. By default this returns CredentialPolicy.CredentialPolicyOutcome.IGNORE.

Constructor Details

FunctionalCredentialPolicyRule

public FunctionalCredentialPolicyRule()

Constructor.

Method Details

setRule

public void setRule(@Nonnull
 BiFunction<EnhancedCredentialRecord,FunctionalRuleContext,CredentialPolicy.CredentialPolicyOutcome> function)

Set the policy function to run.

Parameters:

function - the rule to set.

doEvaluate

protected CredentialPolicy.CredentialPolicyOutcome doEvaluate(EnhancedCredentialRecord credential,
 ProfileRequestContext prc,
 WebAuthnAuthenticationContext webAuthnContext)

Execute the policy. Implementations should override this method.

Specified by:

doEvaluate in class AbstractCredentialPolicyRule

Parameters:

credential - the credential to check the policy rules for

prc - the profile request context

webAuthnContext - the WebAuthn authentication context

Returns:

the credential policy outcome