Add experimental feature annotations

Author: emlun

webauthn-server-core/src/main/java/com/yubico/webauthn/AssertionResultV2.java

@@ -42,7 +42,13 @@
 import lombok.NonNull;
 import lombok.Value;
 
-/** The result of a call to {@link RelyingPartyV2#finishAssertion(FinishAssertionOptions)}. */
+/**
+ * The result of a call to {@link RelyingPartyV2#finishAssertion(FinishAssertionOptions)}.
+ *
+ * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+ *     before reaching a mature release.
+ */
+@Deprecated
 @Value
 public class AssertionResultV2<C extends CredentialRecord> {
 
@@ -65,8 +71,11 @@ public class AssertionResultV2<C extends CredentialRecord> {
    * <i>before</i> the assertion operation, not the new state. When updating your database state,
    * use the signature counter and backup state from {@link #getSignatureCount()}, {@link
    * #isBackupEligible()} and {@link #isBackedUp()} instead.
+   *
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
    */
-  private final C credential;
+  @Deprecated private final C credential;
 
   /**
    * <code>true</code> if and only if at least one of the following is true:

webauthn-server-core/src/main/java/com/yubico/webauthn/CredentialRecord.java

@@ -8,28 +8,66 @@
 
 /**
  * @see <a href="https://w3c.github.io/webauthn/#credential-record">Credential Record</a>
+ * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+ *     before reaching a mature release.
  */
+@Deprecated
 public interface CredentialRecord {
 
+  /**
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
+   */
+  @Deprecated
   @NonNull
   ByteArray getCredentialId();
 
+  /**
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
+   */
+  @Deprecated
   @NonNull
   ByteArray getUserHandle();
 
+  /**
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
+   */
+  @Deprecated
   @NonNull
   ByteArray getPublicKeyCose();
 
+  /**
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
+   */
+  @Deprecated
   long getSignatureCount();
 
+  /**
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
+   */
+  @Deprecated
   @NonNull
   default Optional<Set<AuthenticatorTransport>> getTransports() {
     return Optional.empty();
   }
 
   // boolean isUvInitialized();
 
+  /**
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
+   */
+  @Deprecated
   Optional<Boolean> isBackupEligible();
 
+  /**
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
+   */
+  @Deprecated
   Optional<Boolean> isBackedUp();
 }

webauthn-server-core/src/main/java/com/yubico/webauthn/CredentialRepositoryV2.java

@@ -35,7 +35,11 @@
  * <p>This is used by {@link RelyingParty} to look up credentials and credential IDs.
  *
  * <p>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<C extends CredentialRecord> {
 
   /**
@@ -47,7 +51,10 @@ public interface CredentialRepositoryV2<C extends CredentialRecord> {
    * @return a {@link Set} containing one {@link PublicKeyCredentialDescriptor} 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.
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
    */
+  @Deprecated
   Set<PublicKeyCredentialDescriptor> getCredentialIdsForUserHandle(ByteArray userHandle);
 
   /**
@@ -61,7 +68,10 @@ public interface CredentialRepositoryV2<C extends CredentialRecord> {
    *     credential with credential ID <code>credentialId</code>, if any. If the credential does not
    *     exist or is registered to a different user handle than <code>userHandle</code>, 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<C> lookup(ByteArray credentialId, ByteArray userHandle);
 
   /**
@@ -72,6 +82,9 @@ public interface CredentialRepositoryV2<C extends CredentialRecord> {
    *
    * @return <code>true</code> 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);
 }

webauthn-server-core/src/main/java/com/yubico/webauthn/RelyingParty.java

@@ -609,7 +609,10 @@ public RelyingPartyBuilder credentialRepository(CredentialRepository credentialR
          * credentialRepository} is a required parameter.
          *
          * @see #credentialRepository(CredentialRepository)
+         * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be
+         *     deleted before reaching a mature release.
          */
+        @Deprecated
         public <C extends CredentialRecord>
             RelyingPartyV2.RelyingPartyV2Builder<C> credentialRepositoryV2(
                 CredentialRepositoryV2<C> credentialRepository) {

webauthn-server-core/src/main/java/com/yubico/webauthn/RelyingPartyV2.java

@@ -139,8 +139,13 @@ public class RelyingPartyV2<C extends CredentialRecord> {
    */
   @NonNull private final CredentialRepositoryV2<C> credentialRepository;
 
-  /** TODO */
-  private final UsernameRepository usernameRepository;
+  /**
+   * TODO
+   *
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
+   */
+  @Deprecated private final UsernameRepository usernameRepository;
 
   /**
    * The extension input to set for the <code>appid</code> and <code>appidExclude</code> extensions.

webauthn-server-core/src/main/java/com/yubico/webauthn/UsernameRepository.java

@@ -30,8 +30,12 @@
 /**
  * An abstraction of optional database lookups needed by this library.
  *
- * <p>This is used by {@link RelyingParty} to look up usernames and user handles.
+ * <p>This is used by {@link RelyingPartyV2} to look up usernames and user handles.
+ *
+ * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+ *     before reaching a mature release.
  */
+@Deprecated
 public interface UsernameRepository {
 
   /**
@@ -40,7 +44,11 @@ public interface UsernameRepository {
    *
    * <p>Used to look up the user handle based on the username, for authentication ceremonies where
    * the username is already given.
+   *
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
    */
+  @Deprecated
   Optional<ByteArray> getUserHandleForUsername(String username);
 
   /**
@@ -49,6 +57,10 @@ public interface UsernameRepository {
    *
    * <p>Used to look up the username based on the user handle, for username-less authentication
    * ceremonies.
+   *
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
    */
+  @Deprecated
   Optional<String> getUsernameForUserHandle(ByteArray userHandle);
 }