Package com.yubico.webauthn.data

Class PublicKeyCredentialHint

java.lang.Object

com.yubico.webauthn.data.PublicKeyCredentialHint

public final class PublicKeyCredentialHint
extends Object

Hints to guide the user agent in interacting with the user.

For example, the SECURITY_KEY hint may be used to ask the client to emphasize the option of using an external security key, or the CLIENT_DEVICE hint may be used to ask the client to emphasize the option of using a built-in passkey provider.

These hints are not requirements, and do not bind the user-agent, but may guide it in providing the best experience by using contextual information about the request.

See Also:

• StartRegistrationOptions.getHints()
• StartAssertionOptions.getHints()
• PublicKeyCredentialCreationOptions.hints
• PublicKeyCredentialRequestOptions.hints
• §5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)

Field Summary

Fields

Modifier and Type	Field	Description
static final PublicKeyCredentialHint	CLIENT_DEVICE	Indicates that the application believes that users will satisfy this request with an authenticator built into the client device.
static final PublicKeyCredentialHint	HYBRID	Indicates that the application believes that users will satisfy this request with general-purpose authenticators such as smartphones.
static final PublicKeyCredentialHint	SECURITY_KEY	Indicates that the application believes that users will satisfy this request with a physical security key.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NonNull String	getValue()
int	hashCode()
static PublicKeyCredentialHint	of(@NonNull String value)
String	toString()
static PublicKeyCredentialHint	valueOf(String name)
static PublicKeyCredentialHint[]	values()

Methods inherited from class java.lang.Object

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

Field Details

SECURITY_KEY

public static final PublicKeyCredentialHint SECURITY_KEY

Indicates that the application believes that users will satisfy this request with a physical security key.

For example, an enterprise application may set this hint if they have issued security keys to their employees and will only accept those authenticators for registration and authentication. In that case, the application should probably also set attestationTrustSource and set allowUntrustedAttestation to false. See also the webauthn-server-attestation module.

For compatibility with older user agents, when this hint is used in StartRegistrationOptions, the authenticatorSelection.authenticatorAttachment parameter SHOULD be set to AuthenticatorAttachment.CROSS_PLATFORM.

See Also:

• StartRegistrationOptions.StartRegistrationOptionsBuilder.hints(PublicKeyCredentialHint...)
• StartAssertionOptions.StartAssertionOptionsBuilder.hints(PublicKeyCredentialHint...)
• security-key in §5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)
• §5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)

CLIENT_DEVICE

public static final PublicKeyCredentialHint CLIENT_DEVICE

Indicates that the application believes that users will satisfy this request with an authenticator built into the client device.

For compatibility with older user agents, when this hint is used in StartRegistrationOptions, the authenticatorSelection.authenticatorAttachment parameter SHOULD be set to AuthenticatorAttachment.PLATFORM.

See Also:

• StartRegistrationOptions.StartRegistrationOptionsBuilder.hints(PublicKeyCredentialHint...)
• StartAssertionOptions.StartAssertionOptionsBuilder.hints(PublicKeyCredentialHint...)
• client-device in §5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)
• §5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)

HYBRID

public static final PublicKeyCredentialHint HYBRID

Indicates that the application believes that users will satisfy this request with general-purpose authenticators such as smartphones. For example, a consumer application may believe that only a small fraction of their customers possesses dedicated security keys. This option also implies that the local platform authenticator should not be promoted in the UI.

For compatibility with older user agents, when this hint is used in StartRegistrationOptions, the authenticatorSelection.authenticatorAttachment parameter SHOULD be set to AuthenticatorAttachment.CROSS_PLATFORM.

See Also:

• StartRegistrationOptions.StartRegistrationOptionsBuilder.hints(PublicKeyCredentialHint...)
• StartAssertionOptions.StartAssertionOptionsBuilder.hints(PublicKeyCredentialHint...)
• hybrid in §5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)
• §5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)

Method Details

values

public static PublicKeyCredentialHint[] values()

Returns:

An array containing all predefined values of PublicKeyCredentialHint known by this implementation.

of

public static PublicKeyCredentialHint of(@NonNull
 @NonNull String value)

Returns:

If value is the same as that of any of SECURITY_KEY, CLIENT_DEVICE or HYBRID, returns that constant instance. Otherwise returns a new instance containing value.

See Also:

• valueOf(String)

valueOf

public static PublicKeyCredentialHint valueOf(String name)

Returns:

If name equals "SECURITY_KEY", "CLIENT_DEVICE" or "HYBRID", returns the constant by that name.

Throws:

IllegalArgumentException - if name is anything else.

See Also:

• of(String)

getValue

@NonNull
public @NonNull String getValue()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object