Module com.webauthn4j.core

Package com.webauthn4j.data

Class AuthenticationParameters

java.lang.Object

com.webauthn4j.data.CoreAuthenticationParameters

com.webauthn4j.data.AuthenticationParameters

public class AuthenticationParameters
extends CoreAuthenticationParameters

WebAuthn authentication parameters

Constructor Summary

Constructors

Constructor	Description
AuthenticationParameters(@NotNull ServerProperty serverProperty, @NotNull Authenticator authenticator, boolean userVerificationRequired)	Deprecated. Deprecated as allowCredentials verification was introduced from WebAuthn Level2.
AuthenticationParameters(@NotNull ServerProperty serverProperty, @NotNull Authenticator authenticator, boolean userVerificationRequired, boolean userPresenceRequired)	Deprecated. Deprecated as allowCredentials verification was introduced from WebAuthn Level2.
AuthenticationParameters(@NotNull ServerProperty serverProperty, @NotNull Authenticator authenticator, @Nullable List<byte[]> allowCredentials, boolean userVerificationRequired)	Deprecated. Deprecated as Authenticator is replaced with CredentialRecord AuthenticationParameters constructor
AuthenticationParameters(@NotNull ServerProperty serverProperty, @NotNull Authenticator authenticator, @Nullable List<byte[]> allowCredentials, boolean userVerificationRequired, boolean userPresenceRequired)	Deprecated. Deprecated as Authenticator is replaced with CredentialRecord AuthenticationParameters constructor
AuthenticationParameters(@NotNull ServerProperty serverProperty, @NotNull CredentialRecord credentialRecord, @Nullable List<byte[]> allowCredentials, boolean userVerificationRequired)	AuthenticationParameters constructor
AuthenticationParameters(@NotNull ServerProperty serverProperty, @NotNull CredentialRecord credentialRecord, @Nullable List<byte[]> allowCredentials, boolean userVerificationRequired, boolean userPresenceRequired)	AuthenticationParameters constructor

Method Summary

Modifier and Type	Method	Description
@NotNull Authenticator	getAuthenticator()
@NotNull ServerProperty	getServerProperty()

Methods inherited from class com.webauthn4j.data.CoreAuthenticationParameters

equals, getAllowCredentials, hashCode, isUserPresenceRequired, isUserVerificationRequired, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AuthenticationParameters

public AuthenticationParameters(@NotNull
 @NotNull ServerProperty serverProperty,
 @NotNull
 @NotNull CredentialRecord credentialRecord,
 @Nullable
 @Nullable List<byte[]> allowCredentials,
 boolean userVerificationRequired,
 boolean userPresenceRequired)

AuthenticationParameters constructor

Parameters:

serverProperty - server property

credentialRecord - credential record

allowCredentials - allowed credentialId list. If all credentialId(s) are allowed, pass null

userVerificationRequired - true if user verification is required. Otherwise, false

userPresenceRequired - true if user presence is required. Otherwise, false

AuthenticationParameters

public AuthenticationParameters(@NotNull
 @NotNull ServerProperty serverProperty,
 @NotNull
 @NotNull CredentialRecord credentialRecord,
 @Nullable
 @Nullable List<byte[]> allowCredentials,
 boolean userVerificationRequired)

AuthenticationParameters constructor

Parameters:

serverProperty - server property

credentialRecord - credential record

allowCredentials - allowed credentialId list. If all credentialId(s) are allowed, pass null

userVerificationRequired - true if user verification is required. Otherwise, false

AuthenticationParameters

@Deprecated
public AuthenticationParameters(@NotNull
 @NotNull ServerProperty serverProperty,
 @NotNull
 @NotNull Authenticator authenticator,
 @Nullable
 @Nullable List<byte[]> allowCredentials,
 boolean userVerificationRequired,
 boolean userPresenceRequired)

Deprecated.

Deprecated as Authenticator is replaced with CredentialRecord AuthenticationParameters constructor

Parameters:

serverProperty - server property

authenticator - authenticator

allowCredentials - allowed credentialId list. If all credentialId(s) are allowed, pass null

userVerificationRequired - true if user verification is required. Otherwise, false

userPresenceRequired - true if user presence is required. Otherwise, false

AuthenticationParameters

@Deprecated
public AuthenticationParameters(@NotNull
 @NotNull ServerProperty serverProperty,
 @NotNull
 @NotNull Authenticator authenticator,
 @Nullable
 @Nullable List<byte[]> allowCredentials,
 boolean userVerificationRequired)

Deprecated.

Deprecated as Authenticator is replaced with CredentialRecord AuthenticationParameters constructor

Parameters:

serverProperty - server property

authenticator - authenticator

allowCredentials - allowed credentialId list. If all credentialId(s) are allowed, pass null

userVerificationRequired - true if user verification is required. Otherwise, false

AuthenticationParameters

@Deprecated
public AuthenticationParameters(@NotNull
 @NotNull ServerProperty serverProperty,
 @NotNull
 @NotNull Authenticator authenticator,
 boolean userVerificationRequired,
 boolean userPresenceRequired)

Deprecated.

Deprecated as allowCredentials verification was introduced from WebAuthn Level2.

AuthenticationParameters

@Deprecated
public AuthenticationParameters(@NotNull
 @NotNull ServerProperty serverProperty,
 @NotNull
 @NotNull Authenticator authenticator,
 boolean userVerificationRequired)

Deprecated.

Deprecated as allowCredentials verification was introduced from WebAuthn Level2.

Method Details

getServerProperty

@NotNull
public @NotNull ServerProperty getServerProperty()

Overrides:

getServerProperty in class CoreAuthenticationParameters

getAuthenticator

@NotNull
public @NotNull Authenticator getAuthenticator()

Overrides:

getAuthenticator in class CoreAuthenticationParameters