Add JavaDoc to COSEAlgorithmIdentifier constants

Author: emlun

NEWS

@@ -2,6 +2,7 @@
 
 New features:
 
+* Added JavaDoc to `COSEAlgorithmIdentifier` constants.
 * (Experimental) Added a new suite of interfaces, starting with
   `CredentialRepositoryV2`. `RelyingParty` can now be configured with a
   `CredentialRepositoryV2` instance instead of a `CredentialRepository`

webauthn-server-core/src/main/java/com/yubico/webauthn/data/COSEAlgorithmIdentifier.java

@@ -38,18 +38,109 @@
  * registered in the IANA COSE Algorithms registry, for instance, -7 for "ES256" and -257 for
  * "RS256".
  *
+ * @since 0.3.0
  * @see <a
  *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#typedefdef-cosealgorithmidentifier">§5.10.5.
  *     Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier)</a>
  */
 public enum COSEAlgorithmIdentifier {
+
+  /**
+   * The signature scheme Ed25519 as defined in <a href="https://www.rfc-editor.org/rfc/rfc8032">RFC
+   * 8032</a>.
+   *
+   * <p>Note: This COSE identifier does not in general identify the full Ed25519 parameter suite,
+   * but is specialized to that meaning within the WebAuthn API.
+   *
+   * @since 1.4.0
+   * @see <a href="https://www.iana.org/assignments/cose/cose.xhtml#algorithms">COSE Algorithms
+   *     registry</a>
+   * @see <a href="https://www.rfc-editor.org/rfc/rfc8032">RFC 8032</a>
+   * @see <a href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-alg-identifier">WebAuthn
+   *     §5.8.5. Cryptographic Algorithm Identifier (typedef <code>COSEAlgorithmIdentifier</code>
+   *     )</a>
+   */
   EdDSA(-8),
+
+  /**
+   * ECDSA with SHA-256 on the NIST P-256 curve.
+   *
+   * <p>Note: This COSE identifier does not in general restrict the curve to P-256, but is
+   * specialized to that meaning within the WebAuthn API.
+   *
+   * @since 0.3.0
+   * @see <a href="https://www.iana.org/assignments/cose/cose.xhtml#algorithms">COSE Algorithms
+   *     registry</a>
+   * @see <a href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-alg-identifier">WebAuthn
+   *     §5.8.5. Cryptographic Algorithm Identifier (typedef <code>COSEAlgorithmIdentifier</code>
+   *     )</a>
+   */
   ES256(-7),
+
+  /**
+   * ECDSA with SHA-384 on the NIST P-384 curve.
+   *
+   * <p>Note: This COSE identifier does not in general restrict the curve to P-384, but is
+   * specialized to that meaning within the WebAuthn API.
+   *
+   * @since 2.1.0
+   * @see <a href="https://www.iana.org/assignments/cose/cose.xhtml#algorithms">COSE Algorithms
+   *     registry</a>
+   * @see <a href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-alg-identifier">WebAuthn
+   *     §5.8.5. Cryptographic Algorithm Identifier (typedef <code>COSEAlgorithmIdentifier</code>
+   *     )</a>
+   */
   ES384(-35),
+
+  /**
+   * ECDSA with SHA-512 on the NIST P-521 curve.
+   *
+   * <p>Note: This COSE identifier does not in general restrict the curve to P-521, but is
+   * specialized to that meaning within the WebAuthn API.
+   *
+   * @since 2.1.0
+   * @see <a href="https://www.iana.org/assignments/cose/cose.xhtml#algorithms">COSE Algorithms
+   *     registry</a>
+   * @see <a href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-alg-identifier">WebAuthn
+   *     §5.8.5. Cryptographic Algorithm Identifier (typedef <code>COSEAlgorithmIdentifier</code>
+   *     )</a>
+   */
   ES512(-36),
+
+  /**
+   * RSASSA-PKCS1-v1_5 using SHA-256.
+   *
+   * @since 0.3.0
+   * @see <a href="https://www.iana.org/assignments/cose/cose.xhtml#algorithms">COSE Algorithms
+   *     registry</a>
+   */
   RS256(-257),
+
+  /**
+   * RSASSA-PKCS1-v1_5 using SHA-384.
+   *
+   * @since 2.4.0
+   * @see <a href="https://www.iana.org/assignments/cose/cose.xhtml#algorithms">COSE Algorithms
+   *     registry</a>
+   */
   RS384(-258),
+
+  /**
+   * RSASSA-PKCS1-v1_5 using SHA-512.
+   *
+   * @since 2.4.0
+   * @see <a href="https://www.iana.org/assignments/cose/cose.xhtml#algorithms">COSE Algorithms
+   *     registry</a>
+   */
   RS512(-259),
+
+  /**
+   * RSASSA-PKCS1-v1_5 using SHA-1.
+   *
+   * @since 1.5.0
+   * @see <a href="https://www.iana.org/assignments/cose/cose.xhtml#algorithms">COSE Algorithms
+   *     registry</a>
+   */
   RS1(-65535);
 
   @JsonValue @Getter private final long id;
@@ -65,6 +156,7 @@ public enum COSEAlgorithmIdentifier {
    *     COSEAlgorithmIdentifier}
    * @return The {@link COSEAlgorithmIdentifier} instance whose {@link #getId() id} equals <code>id
    *     </code>, if any.
+   * @since 0.3.0
    * @see <a href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#sctn-alg-identifier">§5.8.5.
    *     Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier)</a>
    */
@@ -80,6 +172,7 @@ public static Optional<COSEAlgorithmIdentifier> fromId(long id) {
    *     COSEAlgorithmIdentifier}, if possible. Returns empty if the {@link COSEAlgorithmIdentifier}
    *     enum has no constant matching the <code>alg</code> value.
    * @throws IllegalArgumentException if <code>publicKeyCose</code> is not a well-formed COSE_Key.
+   * @since 2.1.0
    */
   public static Optional<COSEAlgorithmIdentifier> fromPublicKey(@NonNull ByteArray publicKeyCose) {
     final CBORObject ALG = CBORObject.FromObject(3);