de.adesso.softauthn

Class CredentialsContainer

java.lang.Object

de.adesso.softauthn.CredentialsContainer

public class CredentialsContainer
extends java.lang.Object

This class emulates the behaviour of the CredentialsContainer browser API for WebAuthn credentials, allowing you to create and get WebAuthn credentials, similar to how you would use navigator.credentials... in a browser.

See Also:

CredentialsContainer

API Note:

Not all CredentialsContainer methods are provided:

• store() does not have any functionality in WebAuthn.
• preventSilentAccess() has no use in this library's scope.

Constructor Summary

Constructors

Constructor and Description
CredentialsContainer(Origin origin, java.util.List<? extends Authenticator> authenticators) Creates a new CredentialsContainer with the specified Origin and a list of "known" authenticators.

Method Summary

Modifier and Type	Method and Description
com.yubico.webauthn.data.PublicKeyCredential<com.yubico.webauthn.data.AuthenticatorAttestationResponse,com.yubico.webauthn.data.ClientRegistrationExtensionOutputs>	create(com.yubico.webauthn.data.PublicKeyCredentialCreationOptions publicKey) Implementation of CredentialsContainer.create() for WebAuthn.
com.yubico.webauthn.data.PublicKeyCredential<com.yubico.webauthn.data.AuthenticatorAssertionResponse,com.yubico.webauthn.data.ClientAssertionExtensionOutputs>	get(com.yubico.webauthn.data.PublicKeyCredentialRequestOptions publicKey) Implementation of CredentialsContainer.get() for WebAuthn.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialsContainer

public CredentialsContainer(Origin origin,
                            java.util.List<? extends Authenticator> authenticators)

Creates a new CredentialsContainer with the specified Origin and a list of "known" authenticators.

Parameters:

origin - The origin of the emulated "context".

authenticators - A list of authenticators that are available to this container. This list will be queried to create/get WebAuthn credentials.

Method Detail

create

public com.yubico.webauthn.data.PublicKeyCredential<com.yubico.webauthn.data.AuthenticatorAttestationResponse,com.yubico.webauthn.data.ClientRegistrationExtensionOutputs> create(com.yubico.webauthn.data.PublicKeyCredentialCreationOptions publicKey)

Implementation of CredentialsContainer.create() for WebAuthn.

Parameters:

publicKey - The PublicKeyCredentialOptions provided by the Relying Party.

Returns:

The newly created PublicKeyCredential.

Throws:

java.lang.IllegalArgumentException - if the parameters are malformed in any way or some security check fails

java.lang.IllegalStateException - if an authenticator throws one.

See Also:

Create a New Credential

get

public com.yubico.webauthn.data.PublicKeyCredential<com.yubico.webauthn.data.AuthenticatorAssertionResponse,com.yubico.webauthn.data.ClientAssertionExtensionOutputs> get(com.yubico.webauthn.data.PublicKeyCredentialRequestOptions publicKey)

Implementation of CredentialsContainer.get() for WebAuthn.

Parameters:

publicKey - The PublicKeyCredentialRequestOptions provided by the Relying Party.

Returns:

The PublicKeyCredential object with the assertion.

Throws:

java.lang.IllegalArgumentException - if any of the parameters are malformed in any way or a security check fails.

java.lang.RuntimeException - if any other unexpected exception occurs during the assertion process.

See Also:

Use an Existing Credential to Make an Assertion

Implementation Note:

This implementation does not pre-filter the list of allowed credentials for every authenticator. Instead, it passes the full list of allowed credential to every requested authenticator. Furthermore, it performs no filtering based on available transports because that is not relevant to software authenticators.