Skip navigation links
A B C D E G I M N O P S T U W Y 

A

aaguid(byte[]) - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticatorBuilder
The aaguid of the resulting authenticator.
attachment(AuthenticatorAttachment) - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticatorBuilder
Set the attachment of this authenticator.
Authenticator - Interface in de.adesso.softauthn
The Authenticator interface represents the API provided by WebAuthn authenticators as specified by the WebAuthn spec (see below).
AuthenticatorAssertionData - Class in de.adesso.softauthn
Data returned by an authenticator upon performing an assertion.
AuthenticatorAssertionData(ByteArray, ByteArray, ByteArray, ByteArray) - Constructor for class de.adesso.softauthn.AuthenticatorAssertionData
Public constructor of this data class.
Authenticators - Class in de.adesso.softauthn
Utility class that provides definitions for commonly seen types of authenticators.

B

BrokenAuthenticator - Class in de.adesso.softauthn.authenticator
Authenticator implementation that behaves like some other kind of Authenticator but always computes an invalid signature when creating an assertion.
BrokenAuthenticator(Authenticator) - Constructor for class de.adesso.softauthn.authenticator.BrokenAuthenticator
Create a new broken authenticator.
build() - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticatorBuilder
Build the WebAuthnAuthenticator object using the parameters configured in this builder.
builder() - Static method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticator
Creates a new builder that can be used to configure instances of this class.

C

create(PublicKeyCredentialCreationOptions) - Method in class de.adesso.softauthn.CredentialsContainer
Implementation of CredentialsContainer.create() for WebAuthn.
CredentialsContainer - Class in de.adesso.softauthn
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.
CredentialsContainer(Origin, List<? extends Authenticator>) - Constructor for class de.adesso.softauthn.CredentialsContainer
Creates a new CredentialsContainer with the specified Origin and a list of "known" authenticators.
credentialSelection(Function<? super Set<PublicKeyCredentialSource>, PublicKeyCredentialSource>) - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticatorBuilder
Set the function that will be called if multiple credentials have been found that match the requirements set by the relying party.

D

de.adesso.softauthn - package de.adesso.softauthn
 
de.adesso.softauthn.authenticator - package de.adesso.softauthn.authenticator
 
de.adesso.softauthn.counter - package de.adesso.softauthn.counter
 
deserialize(ByteArray) - Static method in class de.adesso.softauthn.PublicKeyCredentialSource
Deserialize the given byte array to reconstruct the credential source it represents.

E

effectiveDomain() - Method in class de.adesso.softauthn.Origin
Computes the effective domain of this origin.

G

get(PublicKeyCredentialRequestOptions) - Method in class de.adesso.softauthn.CredentialsContainer
Implementation of CredentialsContainer.get() for WebAuthn.
getAssertion(String, byte[], List<PublicKeyCredentialDescriptor>, boolean, byte[]) - Method in class de.adesso.softauthn.authenticator.BrokenAuthenticator
Implementation that creates invalid assertions.
getAssertion(String, byte[], List<PublicKeyCredentialDescriptor>, boolean, byte[]) - Method in interface de.adesso.softauthn.Authenticator
Method that will be called by a client platform to create an assertion for an existing credential.
getAssertion(String, byte[], List<PublicKeyCredentialDescriptor>, boolean, byte[]) - Method in class de.adesso.softauthn.authenticator.NopAuthenticator
Implementation that always throws an UnsupportedOperationException.
getAssertion(String, byte[], List<PublicKeyCredentialDescriptor>, boolean, byte[]) - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticator
 
getAttachment() - Method in class de.adesso.softauthn.authenticator.BrokenAuthenticator
 
getAttachment() - Method in interface de.adesso.softauthn.Authenticator
Returns this authenticator's attachment.
getAttachment() - Method in class de.adesso.softauthn.authenticator.NopAuthenticator
 
getAttachment() - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticator
 
getAuthenticatorData() - Method in class de.adesso.softauthn.AuthenticatorAssertionData
See constructor for a description of this field.
getCredentialId() - Method in class de.adesso.softauthn.AuthenticatorAssertionData
See constructor for a description of this field.
getDomain() - Method in class de.adesso.softauthn.Origin
Get the domain of this origin.
getHost() - Method in class de.adesso.softauthn.Origin
Get the host of this origin.
getId() - Method in class de.adesso.softauthn.PublicKeyCredentialSource
Returns the credential id if set, otherwise null.
getKey() - Method in class de.adesso.softauthn.PublicKeyCredentialSource
See constructor for a description of this field.
getPort() - Method in class de.adesso.softauthn.Origin
Get the port of this origin.
getRpId() - Method in class de.adesso.softauthn.PublicKeyCredentialSource
See constructor for a description of this field.
getScheme() - Method in class de.adesso.softauthn.Origin
Get the scheme of this origin.
getSignature() - Method in class de.adesso.softauthn.AuthenticatorAssertionData
See constructor for a description of this field.
getType() - Method in class de.adesso.softauthn.PublicKeyCredentialSource
See constructor for a description of this field.
getUserHandle() - Method in class de.adesso.softauthn.AuthenticatorAssertionData
See constructor for a description of this field.
getUserHandle() - Method in class de.adesso.softauthn.PublicKeyCredentialSource
See constructor for a description of this field.
GlobalSignatureCounter - Class in de.adesso.softauthn.counter
A signature counter implementation that counts the total number of performed signatures rather than maintaining a separate count for each known credential.
GlobalSignatureCounter() - Constructor for class de.adesso.softauthn.counter.GlobalSignatureCounter
Creates a global signature counter with the initial value 0 and an increment of 1.
GlobalSignatureCounter(int, int) - Constructor for class de.adesso.softauthn.counter.GlobalSignatureCounter
Creates a global signature counter with the given initial value and increment.

I

increment(ByteArray) - Method in class de.adesso.softauthn.counter.GlobalSignatureCounter
 
increment(ByteArray) - Method in class de.adesso.softauthn.counter.NoSignatureCounter
 
increment(ByteArray) - Method in class de.adesso.softauthn.counter.PerCredentialSignatureCounter
 
increment(ByteArray) - Method in interface de.adesso.softauthn.counter.SignatureCounter
Increment the signature count associated with the given credential ID.
initialize(ByteArray) - Method in class de.adesso.softauthn.counter.GlobalSignatureCounter
 
initialize(ByteArray) - Method in class de.adesso.softauthn.counter.NoSignatureCounter
 
initialize(ByteArray) - Method in class de.adesso.softauthn.counter.PerCredentialSignatureCounter
 
initialize(ByteArray) - Method in interface de.adesso.softauthn.counter.SignatureCounter
Initialize the signature count for a given credential ID.

M

makeCredential(byte[], RelyingPartyIdentity, UserIdentity, boolean, boolean, List<PublicKeyCredentialParameters>, Set<PublicKeyCredentialDescriptor>, boolean, byte[]) - Method in class de.adesso.softauthn.authenticator.BrokenAuthenticator
 
makeCredential(byte[], RelyingPartyIdentity, UserIdentity, boolean, boolean, List<PublicKeyCredentialParameters>, Set<PublicKeyCredentialDescriptor>, boolean, byte[]) - Method in interface de.adesso.softauthn.Authenticator
Method that will be called by a client platform to create a new credential on this authenticator.
makeCredential(byte[], RelyingPartyIdentity, UserIdentity, boolean, boolean, List<PublicKeyCredentialParameters>, Set<PublicKeyCredentialDescriptor>, boolean, byte[]) - Method in class de.adesso.softauthn.authenticator.NopAuthenticator
Implementation that always throws an UnsupportedOperationException.
makeCredential(byte[], RelyingPartyIdentity, UserIdentity, boolean, boolean, List<PublicKeyCredentialParameters>, Set<PublicKeyCredentialDescriptor>, boolean, byte[]) - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticator
 

N

NopAuthenticator - Class in de.adesso.softauthn.authenticator
Authenticator implementation that does nothing except throw an exception when asked to create an attestation or an assertion.
NopAuthenticator(AuthenticatorAttachment) - Constructor for class de.adesso.softauthn.authenticator.NopAuthenticator
Creates a NopAuthenticator with the given attachment.
NoSignatureCounter - Class in de.adesso.softauthn.counter
A signature counter implementation that always returns 0 and effectively does nothing.
NoSignatureCounter() - Constructor for class de.adesso.softauthn.counter.NoSignatureCounter
 

O

Origin - Class in de.adesso.softauthn
Data class that contains information associated with a web origin.
Origin(String, String, int, String) - Constructor for class de.adesso.softauthn.Origin
Create an origin with the given values.

P

PerCredentialSignatureCounter - Class in de.adesso.softauthn.counter
An implementation of SignatureCounter that maintains a separate signature count for each credential ID.
PerCredentialSignatureCounter() - Constructor for class de.adesso.softauthn.counter.PerCredentialSignatureCounter
Creates a counter that will increment the signature count of a credential by 1 when PerCredentialSignatureCounter.increment(ByteArray) is called.
PerCredentialSignatureCounter(int) - Constructor for class de.adesso.softauthn.counter.PerCredentialSignatureCounter
Creates a counter that will increment the signature count of a credential by the specified amount when PerCredentialSignatureCounter.increment(ByteArray) is called.
platform() - Static method in class de.adesso.softauthn.Authenticators
Creates an authenticator configuration that uses platform attachment, supports user verification and resident keys.
PublicKeyCredentialSource - Class in de.adesso.softauthn
A data class that stores information associated with a credential.
PublicKeyCredentialSource(PublicKeyCredentialType, OneKey, String, ByteArray) - Constructor for class de.adesso.softauthn.PublicKeyCredentialSource
Public constructor of this data class.

S

serialize() - Method in class de.adesso.softauthn.PublicKeyCredentialSource
Encodes this credential source to a byte array so it can be encrypted and used as the credential id for server-side credential storage
serialized() - Method in class de.adesso.softauthn.Origin
Computes the serialization of this origin.
setCredentialId(ByteArray) - Method in class de.adesso.softauthn.AuthenticatorAssertionData
Set the credential id to some new value.
setId(ByteArray) - Method in class de.adesso.softauthn.PublicKeyCredentialSource
Set the credential ID, for example to the serialized version of this credential source itself for server-side credentials or a randomly generated byte array for client-side discoverable credentials.
signatureCounter(SignatureCounter) - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticatorBuilder
Set the signature counter style that should be used by the authenticator.
SignatureCounter - Interface in de.adesso.softauthn.counter
An interface that allows authenticators to keep track of the number of signatures they have performed.
supportAlgorithms(COSEAlgorithmIdentifier...) - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticatorBuilder
Set the list of supported cryptographic algorithms for this authenticator.
supportAlgorithms(Collection<COSEAlgorithmIdentifier>) - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticatorBuilder
Set the list of supported cryptographic algorithms for this authenticator.
supportClientSideDiscoverablePublicKeyCredentialSources(boolean) - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticatorBuilder
Set whether this authenticator should support client side discoverable credentials aka resident keys, i.e.
supportsClientSideDiscoverablePublicKeyCredentialSources() - Method in class de.adesso.softauthn.authenticator.BrokenAuthenticator
 
supportsClientSideDiscoverablePublicKeyCredentialSources() - Method in class de.adesso.softauthn.authenticator.NopAuthenticator
 
supportsClientSideDiscoverablePublicKeyCredentialSources() - Method in interface de.adesso.softauthn.Authenticator
Returns whether this authenticator supports the creation of client-side discoverable credentials, also known as resident keys.
supportsClientSideDiscoverablePublicKeyCredentialSources() - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticator
 
supportsUserVerification() - Method in class de.adesso.softauthn.authenticator.BrokenAuthenticator
 
supportsUserVerification() - Method in class de.adesso.softauthn.authenticator.NopAuthenticator
 
supportsUserVerification() - Method in interface de.adesso.softauthn.Authenticator
Returns whether this authenticator can perform user verification.
supportsUserVerification() - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticator
 
supportUserVerification(boolean) - Method in class de.adesso.softauthn.authenticator.WebAuthnAuthenticatorBuilder
Set whether this authenticator should support user verification.

T

toString() - Method in class de.adesso.softauthn.Origin
 
toString() - Method in class de.adesso.softauthn.PublicKeyCredentialSource
 

U

u2f() - Static method in class de.adesso.softauthn.Authenticators
Creates an authenticator configuration that imitates a "legacy" U2F authenticator that doesn't support the new WebAuthn features.

W

WebAuthnAuthenticator - Class in de.adesso.softauthn.authenticator
An implementation of Authenticator that attempts to cover most of the WebAuthn specification for authenticators.
WebAuthnAuthenticator(byte[], AuthenticatorAttachment, Collection<COSEAlgorithmIdentifier>, boolean, boolean, SignatureCounter, Function<? super Set<PublicKeyCredentialSource>, PublicKeyCredentialSource>) - Constructor for class de.adesso.softauthn.authenticator.WebAuthnAuthenticator
 
WebAuthnAuthenticatorBuilder - Class in de.adesso.softauthn.authenticator
Builder class for WebAuthnAuthenticator.
WebAuthnAuthenticatorBuilder() - Constructor for class de.adesso.softauthn.authenticator.WebAuthnAuthenticatorBuilder
 

Y

yubikey5Nfc() - Static method in class de.adesso.softauthn.Authenticators
Creates an authenticator configuration that behaves like a Yubikey 5 NFC (cross-platform attachment, support for resident keys, support for user verification, per-credential signature counter and the model's AAGUID).
A B C D E G I M N O P S T U W Y 
Skip navigation links