Recommend RegistrationResult.getPublicKeyCose() as argument to Regist…

…eredCredential
Yubico · Nov 4, 2021 · 945fed5 · 945fed5
1 parent a692324
commit 945fed5
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/RegisteredCredential.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/RegisteredCredential.java
@@ -144,6 +144,9 @@ public class Step3 {
          * {@link RegisteredCredentialBuilder#publicKeyCose(ByteArray) publicKeyCose} is a required
          * parameter.
          *
+         * <p>The return value of {@link RegistrationResult#getPublicKeyCose()} is a suitable
+         * argument for this method.
+         *
          * <p>Alternatively, the public key can be specified using the {@link
          * #publicKeyEs256Raw(ByteArray)} method if the key is stored in the U2F format (<code>
          * ALG_KEY_ECC_X962_RAW</code> as specified in <a
@@ -187,6 +190,9 @@ public RegisteredCredentialBuilder publicKeyEs256Raw(ByteArray publicKeyEs256Raw
      * href="https://tools.ietf.org/html/rfc8152">RFC 8152</a>. This method overwrites {@link
      * #publicKeyEs256Raw(ByteArray)}.
      *
+     * <p>The return value of {@link RegistrationResult#getPublicKeyCose()} is a suitable argument
+     * for this method.
+     *
      * <p>This is used to verify the {@link AuthenticatorAssertionResponse#getSignature() signature}
      * in authentication assertions.
      *