Implement experimental support for SPC response type

emlun · emlun · commit b62ee4398c0c · 2023-07-05T21:45:15.000+02:00
diff --git a/NEWS b/NEWS
@@ -1,9 +1,15 @@
 == Version 2.6.0 (unreleased) ==
 
+New features:
+
 * Added method `getParsedPublicKey(): java.security.PublicKey` to
   `RegistrationResult` and `RegisteredCredential`.
  ** Thanks to Jakob Heher (A-SIT) for the contribution, see
     https://github.com/Yubico/java-webauthn-server/pull/299
+* (Experimental) Added option `isSecurePaymentConfirmation(boolean)` to
+  `FinishAssertionOptions`. When set, `RelyingParty.finishAssertion()` will
+  adapt the validation logic for a Secure Payment Confirmation (SPC) response
+  instead of an ordinary WebAuthn response. See the JavaDoc for details.
 
 
 == Version 2.5.0 ==
diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/FinishAssertionOptions.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/FinishAssertionOptions.java
@@ -27,8 +27,10 @@
 import com.yubico.webauthn.data.AuthenticatorAssertionResponse;
 import com.yubico.webauthn.data.ByteArray;
 import com.yubico.webauthn.data.ClientAssertionExtensionOutputs;
+import com.yubico.webauthn.data.CollectedClientData;
 import com.yubico.webauthn.data.PublicKeyCredential;
 import java.util.Optional;
+import java.util.Set;
 import lombok.Builder;
 import lombok.NonNull;
 import lombok.Value;
@@ -59,6 +61,41 @@ public class FinishAssertionOptions {
    */
   private final ByteArray callerTokenBindingId;
 
+  /**
+   * EXPERIMENTAL FEATURE:
+   *
+   * <p>If set to <code>false</code> (the default), the <code>"type"</code> property in the <a
+   * href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#dictionary-client-data">collected
+   * client data</a> of the assertion will be verified to equal <code>"webauthn.get"</code>.
+   *
+   * <p>If set to <code>true</code>, it will instead be verified to equal <code>"payment.get"</code>
+   * .
+   *
+   * <p>NOTE: If you're using <a
+   * href="https://www.w3.org/TR/2023/CR-secure-payment-confirmation-20230615/">Secure Payment
+   * Confirmation</a> (SPC), you likely also need to relax the origin validation logic. Right now
+   * this library only supports matching against a finite {@link Set} of acceptable origins. If
+   * necessary, your application may validate the origin externally (see {@link
+   * PublicKeyCredential#getResponse()}, {@link AuthenticatorAssertionResponse#getClientData()} and
+   * {@link CollectedClientData#getOrigin()}) and construct a new {@link RelyingParty} instance for
+   * each SPC response, setting the {@link RelyingParty.RelyingPartyBuilder#origins(Set) origins}
+   * setting on that instance to contain the pre-validated origin value.
+   *
+   * <p>Better support for relaxing origin validation may be added as the feature matures.
+   *
+   * @deprecated EXPERIMENTAL: This is an experimental feature. It is likely to change or be deleted
+   *     before reaching a mature release.
+   * @see <a href="https://www.w3.org/TR/2023/CR-secure-payment-confirmation-20230615/">Secure
+   *     Payment Confirmation</a>
+   * @see <a
+   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#dictionary-client-data">5.8.1.
+   *     Client Data Used in WebAuthn Signatures (dictionary CollectedClientData)</a>
+   * @see RelyingParty.RelyingPartyBuilder#origins(Set)
+   * @see CollectedClientData
+   * @see CollectedClientData#getOrigin()
+   */
+  @Deprecated @Builder.Default private final boolean isSecurePaymentConfirmation = false;
+
   /**
    * The <a href="https://tools.ietf.org/html/rfc8471#section-3.2">token binding ID</a> of the
    * connection to the client, if any.
diff --git a/webauthn-server-core/src/main/java/com/yubico/webauthn/FinishAssertionSteps.java b/webauthn-server-core/src/main/java/com/yubico/webauthn/FinishAssertionSteps.java
@@ -50,6 +50,7 @@
 final class FinishAssertionSteps {
 
   private static final String CLIENT_DATA_TYPE = "webauthn.get";
+  private static final String SPC_CLIENT_DATA_TYPE = "payment.get";
 
   private final AssertionRequest request;
   private final PublicKeyCredential<AuthenticatorAssertionResponse, ClientAssertionExtensionOutputs>
@@ -61,6 +62,7 @@ final class FinishAssertionSteps {
   private final boolean allowOriginPort;
   private final boolean allowOriginSubdomain;
   private final boolean validateSignatureCounter;
+  private final boolean isSecurePaymentConfirmation;
 
   FinishAssertionSteps(RelyingParty rp, FinishAssertionOptions options) {
     this.request = options.getRequest();
@@ -72,6 +74,7 @@ final class FinishAssertionSteps {
     this.allowOriginPort = rp.isAllowOriginPort();
     this.allowOriginSubdomain = rp.isAllowOriginSubdomain();
     this.validateSignatureCounter = rp.isValidateSignatureCounter();
+    this.isSecurePaymentConfirmation = options.isSecurePaymentConfirmation();
   }
 
   public Step5 begin() {
@@ -288,10 +291,12 @@ class Step11 implements Step<Step12> {
 
     @Override
     public void validate() {
+      final String expectedType =
+          isSecurePaymentConfirmation ? SPC_CLIENT_DATA_TYPE : CLIENT_DATA_TYPE;
       assertTrue(
-          CLIENT_DATA_TYPE.equals(clientData.getType()),
+          expectedType.equals(clientData.getType()),
           "The \"type\" in the client data must be exactly \"%s\", was: %s",
-          CLIENT_DATA_TYPE,
+          expectedType,
           clientData.getType());
     }
 
diff --git a/webauthn-server-core/src/test/scala/com/yubico/webauthn/RelyingPartyAssertionSpec.scala b/webauthn-server-core/src/test/scala/com/yubico/webauthn/RelyingPartyAssertionSpec.scala
@@ -27,6 +27,7 @@ package com.yubico.webauthn
 import com.fasterxml.jackson.core.`type`.TypeReference
 import com.fasterxml.jackson.databind.node.JsonNodeFactory
 import com.fasterxml.jackson.databind.node.ObjectNode
+import com.fasterxml.jackson.databind.node.TextNode
 import com.upokecenter.cbor.CBORObject
 import com.yubico.internal.util.JacksonCodecs
 import com.yubico.webauthn.data.AssertionExtensionInputs
@@ -179,6 +180,7 @@ class RelyingPartyAssertionSpec
       credentialId: ByteArray = Defaults.credentialId,
       credentialKey: KeyPair = Defaults.credentialKey,
       credentialRepository: Option[CredentialRepository] = None,
+      isSecurePaymentConfirmation: Option[Boolean] = None,
       origins: Option[Set[String]] = None,
       requestedExtensions: AssertionExtensionInputs =
         Defaults.requestedExtensions,
@@ -283,6 +285,10 @@ class RelyingPartyAssertionSpec
       .response(response)
       .callerTokenBindingId(callerTokenBindingId.toJava)
 
+    isSecurePaymentConfirmation foreach { isSpc =>
+      fao.isSecurePaymentConfirmation(isSpc)
+    }
+
     builder
       .build()
       ._finishAssertion(fao.build())
@@ -941,14 +947,18 @@ class RelyingPartyAssertionSpec
             step.validations shouldBe a[Success[_]]
           }
 
-          def assertFails(typeString: String): Unit = {
+          def assertFails(
+              typeString: String,
+              isSecurePaymentConfirmation: Option[Boolean] = None,
+          ): Unit = {
             val steps = finishAssertion(
               clientDataJson = JacksonCodecs.json.writeValueAsString(
                 JacksonCodecs.json
                   .readTree(Defaults.clientDataJson)
                   .asInstanceOf[ObjectNode]
                   .set("type", jsonFactory.textNode(typeString))
-              )
+              ),
+              isSecurePaymentConfirmation = isSecurePaymentConfirmation,
             )
             val step: FinishAssertionSteps#Step11 =
               steps.begin.next.next.next.next.next
@@ -973,6 +983,72 @@ class RelyingPartyAssertionSpec
           it("""The string "webauthn.create" fails.""") {
             assertFails("webauthn.create")
           }
+
+          it("""The string "payment.get" fails.""") {
+            assertFails("payment.get")
+          }
+
+          describe("If the isSecurePaymentConfirmation option is set,") {
+            it("the default test case fails.") {
+              val steps =
+                finishAssertion(isSecurePaymentConfirmation = Some(true))
+              val step: FinishAssertionSteps#Step11 =
+                steps.begin.next.next.next.next.next
+
+              step.validations shouldBe a[Failure[_]]
+              step.validations.failed.get shouldBe an[IllegalArgumentException]
+            }
+
+            it("""the default test case succeeds if type is overwritten with the value "payment.get".""") {
+              val json = JacksonCodecs.json()
+              val steps = finishAssertion(
+                isSecurePaymentConfirmation = Some(true),
+                clientDataJson = json.writeValueAsString(
+                  json
+                    .readTree(Defaults.clientDataJson)
+                    .asInstanceOf[ObjectNode]
+                    .set[ObjectNode]("type", new TextNode("payment.get"))
+                ),
+              )
+              val step: FinishAssertionSteps#Step11 =
+                steps.begin.next.next.next.next.next
+
+              step.validations shouldBe a[Success[_]]
+            }
+
+            it("""any value other than "payment.get" fails.""") {
+              forAll { (typeString: String) =>
+                whenever(typeString != "payment.get") {
+                  assertFails(
+                    typeString,
+                    isSecurePaymentConfirmation = Some(true),
+                  )
+                }
+              }
+              forAll(Gen.alphaNumStr) { (typeString: String) =>
+                whenever(typeString != "payment.get") {
+                  assertFails(
+                    typeString,
+                    isSecurePaymentConfirmation = Some(true),
+                  )
+                }
+              }
+            }
+
+            it("""the string "webauthn.create" fails.""") {
+              assertFails(
+                "webauthn.create",
+                isSecurePaymentConfirmation = Some(true),
+              )
+            }
+
+            it("""the string "webauthn.get" fails.""") {
+              assertFails(
+                "webauthn.get",
+                isSecurePaymentConfirmation = Some(true),
+              )
+            }
+          }
         }
 
         it("12. Verify that the value of C.challenge equals the base64url encoding of options.challenge.") {
