com.yubico.webauthn.CredentialRepositoryV2 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webauthn-server-core Show documentation
Yubico WebAuthn server core API
The newest version!
// Copyright (c) 2018, Yubico AB
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package com.yubico.webauthn;

import com.yubico.webauthn.data.ByteArray;
import com.yubico.webauthn.data.PublicKeyCredentialDescriptor;
import java.util.Optional;
import java.util.Set;

/**
 * An abstraction of database lookups needed by this library.
 *
 * This is used by {@link RelyingPartyV2} to look up credentials and credential IDs.
 *
 * 
Unlike {@link CredentialRepository}, this interface does not require support for usernames.
 *
 * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
 *     before reaching a mature release.
 */
@Deprecated
public interface CredentialRepositoryV2 {

  /**
   * Get the credential IDs of all credentials registered to the user with the given user handle.
   *
   * 
After a successful registration ceremony, the {@link RegistrationResult#getKeyId()} method
   * returns a value suitable for inclusion in this set.
   *
   * 
Note that the {@link CredentialRecord} interface extends from the expected {@link
   * ToPublicKeyCredentialDescriptor} return type, so this method MAY return a {@link Set} of the
   * same item type as the value returned by the {@link #lookup(ByteArray, ByteArray)} method.
   *
   * 
Implementations MUST NOT return null. The returned {@link Set} MUST NOT contain null.
   *
   * @return a {@link Set} containing one {@link PublicKeyCredentialDescriptor} (or value that
   *     implements {@link ToPublicKeyCredentialDescriptor}, for example {@link CredentialRecord})
   *     for each credential registered to the given user. The set MUST NOT be null, but MAY be
   *     empty if the user does not exist or has no credentials.
   * @see ToPublicKeyCredentialDescriptor
   * @see CredentialRecord
   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
   *     before reaching a mature release.
   */
  @Deprecated
  Set getCredentialDescriptorsForUserHandle(
      ByteArray userHandle);

  /**
   * Look up the public key, backup flags and current signature count for the given credential
   * registered to the given user.
   *
   * 
The returned {@link CredentialRecord} is not expected to be long-lived. It may be read
   * directly from a database or assembled from other components.
   *
   * @return a {@link CredentialRecord} describing the current state of the registered credential
   *     with credential ID credentialId, if any. If the credential does not exist or
   *     is registered to a different user handle than userHandle, return {@link
   *     Optional#empty()}.
   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
   *     before reaching a mature release.
   */
  @Deprecated
  Optional lookup(ByteArray credentialId, ByteArray userHandle);

  /**
   * Check whether any credential exists with the given credential ID, regardless of what user it is
   * registered to.
   *
   * This is used to refuse registration of duplicate credential IDs.
   *
   * @return true if and only if the credential database contains at least one
   *     credential with the given credential ID.
   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
   *     before reaching a mature release.
   */
  @Deprecated
  boolean credentialIdExists(ByteArray credentialId);
}