Package net.shibboleth.idp.plugin.authn.webauthn.context

Class WebAuthnManagementContext

java.lang.Object
org.opensaml.messaging.context.BaseContext
net.shibboleth.idp.plugin.authn.webauthn.context.WebAuthnManagementContext
All Implemented Interfaces:
Iterable<BaseContext>
public class WebAuthnManagementContext extends BaseContext
A WebAuthn admin management context for the management admin flow.

  • Field Details

    • principalName

      @Nullable private String principalName
      Canonical principal name of the authenticated user, acting as an admin.

    • searchUsername

      @Nullable private String searchUsername
      The username of the user to find and manage credentials for. This username will likely mutate based on subject canonicalization into the username of the user stored in the credential repository.

    • rawSearchUsername

      @Nullable private String rawSearchUsername
      The raw username entered by the admin to search for. Is not transformed or canonicalized in anyway.

    • foundCredentials

      @Nullable @Unmodifiable @NotLive private Collection<EnhancedCredentialRecord> foundCredentials
      The located set of credentials registered for the given searchUsername.

    • credentialIdToRemove

      @Nullable private byte[] credentialIdToRemove
      The ID of a credential that is going to be removed.

  • Constructor Details

    • WebAuthnManagementContext

      public WebAuthnManagementContext()

  • Method Details

    • getPrincipalName

      @Nullable public String getPrincipalName()
      Get the canonical principal name of the authenticated subject.
      Returns:
      the canonical principal name

    • setPrincipalName

      @Nonnull public WebAuthnManagementContext setPrincipalName(@Nullable String name)
      Set the canonical principal name of the authenticated subject.
      Parameters:
      name - the canonical principal name
      Returns:
      this context

    • getSearchUsername

      @Nullable public String getSearchUsername()
      Get the username of the user to find and manage credentials for.
      Returns:
      the username to search for

    • setSearchUsername

      @Nonnull public WebAuthnManagementContext setSearchUsername(@Nullable String name)
      Set the username of the user to find and manage credentials for.
      Parameters:
      name - the username to search for
      Returns:
      this context

    • getRawSearchUsername

      @Nullable public String getRawSearchUsername()
      Gets the raw username entered by the admin to search for.
      Returns:
      the raw username entered by the admin
      Since:
      1.1.0

    • setRawSearchUsername

      @Nonnull public WebAuthnManagementContext setRawSearchUsername(@Nullable String name)
      Sets the raw username entered by the admin to search for.
      Parameters:
      name - the raw username entered by the admin
      Returns:
      this context
      Since:
      1.1.0

    • setFoundCredentials

      @Nonnull public WebAuthnManagementContext setFoundCredentials(@Nullable Collection<EnhancedCredentialRecord> credentials)
      Set the credentials found to belong to the given searchUsername.
      Parameters:
      credentials - the set of credentials
      Returns:
      this context

    • getFoundCredentials

      @Nonnull @Unmodifiable @NotLive public Collection<EnhancedCredentialRecord> getFoundCredentials()
      Get the credentials found to belong to the given searchUsername.
      Returns:
      the credentials.

    • setCredentialIdToRemove

      @Nonnull public WebAuthnManagementContext setCredentialIdToRemove(@Nullable byte[] id)
      Set the ID of the credential that is going to be removed.
      Parameters:
      id - the credential identifier
      Returns:
      this context

    • getCredentialIdToRemove

      @Nullable public byte[] getCredentialIdToRemove()
      Get the ID of the credential that is going to be removed.
      Returns:
      the credential id to remove.