Package io.quarkus.security.webauthn

Interface WebAuthnUserProvider

public interface WebAuthnUserProvider
Implement this interface in order to tell Quarkus WebAuthn how to look up WebAuthn credentials, store new credentials, or update the credentials' counter, as well as what roles those credentials map to.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.smallrye.mutiny.Uni<List<io.vertx.ext.auth.webauthn.Authenticator>>
    findWebAuthnCredentialsByCredID(String credentialId)
    Look up a WebAuthn credential by credential ID
    io.smallrye.mutiny.Uni<List<io.vertx.ext.auth.webauthn.Authenticator>>
    findWebAuthnCredentialsByUserName(String userName)
    Look up a WebAuthn credential by username
    default Set<String>
    getRoles(String userName)
    Returns the set of roles for the given username
    io.smallrye.mutiny.Uni<Void>
    updateOrStoreWebAuthnCredentials(io.vertx.ext.auth.webauthn.Authenticator authenticator)
    If this credential's combination of user and credential ID does not exist, then store the new credential.

  • Method Details

    • findWebAuthnCredentialsByUserName

      io.smallrye.mutiny.Uni<List<io.vertx.ext.auth.webauthn.Authenticator>> findWebAuthnCredentialsByUserName(String userName)
      Look up a WebAuthn credential by username
      Parameters:
      userName - the username
      Returns:
      a list of credentials for this username

    • findWebAuthnCredentialsByCredID

      io.smallrye.mutiny.Uni<List<io.vertx.ext.auth.webauthn.Authenticator>> findWebAuthnCredentialsByCredID(String credentialId)
      Look up a WebAuthn credential by credential ID
      Parameters:
      credentialId - the credential ID

    • updateOrStoreWebAuthnCredentials

      io.smallrye.mutiny.Uni<Void> updateOrStoreWebAuthnCredentials(io.vertx.ext.auth.webauthn.Authenticator authenticator)
      If this credential's combination of user and credential ID does not exist, then store the new credential. If it already exists, then only update its counter
      Parameters:
      authenticator - the new credential if it does not exist, or the credential to update
      Returns:
      a uni completion object

    • getRoles

      default Set<String> getRoles(String userName)
      Returns the set of roles for the given username
      Parameters:
      userName - the username
      Returns:
      the set of roles (defaults to an empty set)