Package io.hanko.sdk.webauthn.protocol

Class AuthenticatorSelectionCriteria

java.lang.Object

io.hanko.sdk.webauthn.protocol.AuthenticatorSelectionCriteria

public class AuthenticatorSelectionCriteria
extends Object

WebAuthn Relying Parties may use the AuthenticatorSelectionCriteria to specify their requirements regarding authenticator attributes.

See Also:

Web Authentication Level 1 - 5.4.4. Authenticator Selection Criteria

Constructor Summary

Constructors

Constructor	Description
AuthenticatorSelectionCriteria()	Construct AuthenticatorSelectionCriteria.
AuthenticatorSelectionCriteria(AuthenticatorAttachment authenticatorAttachment, boolean requireResidentKey, UserVerificationRequirement userVerification)	Construct AuthenticatorSelectionCriteria.

Method Summary

Modifier and Type	Method	Description
AuthenticatorAttachment	getAuthenticatorAttachment()	Get the AuthenticatorAttachment.
UserVerificationRequirement	getUserVerification()	Get the UserVerificationRequirement.
boolean	isRequireResidentKey()	Get the resident key requirement.
void	setAuthenticatorAttachment(AuthenticatorAttachment authenticatorAttachment)	Set the AuthenticatorAttachment.
void	setRequireResidentKey(boolean requireResidentKey)	Get the resident key requirement.
void	setUserVerification(UserVerificationRequirement userVerification)	Set the UserVerificationRequirement.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticatorSelectionCriteria

public AuthenticatorSelectionCriteria()

Construct AuthenticatorSelectionCriteria.

AuthenticatorSelectionCriteria

public AuthenticatorSelectionCriteria(AuthenticatorAttachment authenticatorAttachment,
 boolean requireResidentKey,
 UserVerificationRequirement userVerification)

Construct AuthenticatorSelectionCriteria.

Parameters:

authenticatorAttachment - nullable, the AuthenticatorAttachment

requireResidentKey - whether a credential should be registered as a resident key, defaults to false

userVerification - nullable, the UserVerificationRequirement

Method Details

getAuthenticatorAttachment

public AuthenticatorAttachment getAuthenticatorAttachment()

Get the AuthenticatorAttachment.

Returns:

the AuthenticatorAttachment

setAuthenticatorAttachment

public void setAuthenticatorAttachment(AuthenticatorAttachment authenticatorAttachment)

Set the AuthenticatorAttachment.

Parameters:

authenticatorAttachment - the AuthenticatorAttachment

isRequireResidentKey

public boolean isRequireResidentKey()

Get the resident key requirement.

Returns:

true, if a resident key should be created using these selection criteria, false otherwise

setRequireResidentKey

public void setRequireResidentKey(boolean requireResidentKey)

Get the resident key requirement.

Parameters:

requireResidentKey - the resident key requirement set to true, if a resident key should be created using these selection criteria, false otherwise

getUserVerification

public UserVerificationRequirement getUserVerification()

Get the UserVerificationRequirement.

Returns:

the UserVerificationRequirement

setUserVerification

public void setUserVerification(UserVerificationRequirement userVerification)

Set the UserVerificationRequirement.

Parameters:

userVerification - the UserVerificationRequirement