webauthn 2.1.0 → 3.4.0

data/docs/advanced_configuration.md

@@ -0,0 +1,174 @@
+# Advanced Configuration
+
+## Global vs Instance Based Configuration
+
+Which approach suits best your needs will depend on the architecture of your application and how do your users need to register and authenticate to it.
+
+If you have a multi-tenant application, or any application segmenation, where your users register and authenticate to each of these tenants or segments individuallly using different hostnames, or with different security needs, you need to go through [Instance Based Configuration](#instance-based-configuration).
+
+However, if your application is served for just one hostname, or else if your users authenticate to only one subdmain (e.g. your application serves www.example.com and admin.example.com but all you users authenticate through auth.example.com) you can still rely on one [Global Configuration](../README.md#configuration).
+
+If you are still not sure, or want to keep your options open, be aware that [Instance Based Configuration](#instance-based-configuration) is also a valid way of defining a single instance configuration and how you share such configuration across your application, it's up to you.
+
+
+## Instance Based Configuration
+
+Intead of the [Global Configuration](../README.md#configuration) you place in `config/initializers/webauthn.rb`,
+ you can now have an on-demand instance of `WebAuthn::RelyingParty` with the same configuration options, that
+ you can build anywhere in you application, in the following way:
+
+```ruby
+  relying_party = WebAuthn::RelyingParty.new(
+    # This value needs to match `window.location.origin` evaluated by
+    # the User Agent during registration and authentication ceremonies.
+    origin: "https://admin.example.com",
+
+    # Relying Party name for display purposes
+    name: "Admin Site for Example Inc."
+
+    # Optionally configure a client timeout hint, in milliseconds.
+    # This hint specifies how long the browser should wait for any
+    # interaction with the user.
+    # This hint may be overridden by the browser.
+    # https://www.w3.org/TR/webauthn/#dom-publickeycredentialcreationoptions-timeout
+    # credential_options_timeout: 120_000
+
+    # You can optionally specify a different Relying Party ID
+    # (https://www.w3.org/TR/webauthn/#relying-party-identifier)
+    # if it differs from the default one.
+    #
+    # In this case the default would be "admin.example.com", but you can set it to
+    # the suffix "example.com"
+    #
+    # id: "example.com"
+
+    # Configure preferred binary-to-text encoding scheme. This should match the encoding scheme
+    # used in your client-side (user agent) code before sending the credential to the server.
+    # Supported values: `:base64url` (default), `:base64` or `false` to disable all encoding.
+    #
+    # encoding: :base64url
+
+    # Possible values: "ES256", "ES384", "ES512", "PS256", "PS384", "PS512", "RS256", "RS384", "RS512", "RS1"
+    # Default: ["ES256", "PS256", "RS256"]
+    #
+    # algorithms: ["ES384"]
+  )
+```
+
+## Instance Based API
+
+**DISCLAIMER: This API was released on version 3.0.0.alpha1 and is still under evaluation. Although it has been throughly tested and it is fully functional it might be changed until the final release of version 3.0.0.**
+
+The explanation for each ceremony can be found in depth in [Credential Registration](../README.md#credential-registration) and [Credential Authentication](../README.md#credential-authentication) but if you choose this instance based approach to define your WebAuthn configurations and assuming `relying_party` is the result of an instance you get through `WebAuthn::RelyingParty.new(...)` the code in those explanations needs to be updated to:
+
+### Credential Registration
+
+#### Initiation phase
+
+```ruby
+# Generate and store the WebAuthn User ID the first time the user registers a credential
+if !user.webauthn_id
+  user.update!(webauthn_id: WebAuthn.generate_user_id)
+end
+
+options = relying_party.options_for_registration(
+  user: { id: user.webauthn_id, name: user.name },
+  exclude: user.credentials.map { |c| c.external_id }
+)
+
+# Store the newly generated challenge somewhere so you can have it
+# for the verification phase.
+session[:creation_challenge] = options.challenge
+
+# Send `options` back to the browser, so that they can be used
+# to call `navigator.credentials.create({ "publicKey": options })`
+#
+# You can call `options.as_json` to get a ruby hash with a JSON representation if needed.
+
+# If inside a Rails controller, `render json: options` will just work.
+# I.e. it will encode and convert the options to JSON automatically.
+
+# For your frontend code, you might find @github/webauthn-json npm package useful.
+# Especially for handling the necessary decoding of the options, and sending the
+# `PublicKeyCredential` object back to the server.
+```
+
+#### Verification phase
+
+```ruby
+# Assuming you're using @github/webauthn-json package to send the `PublicKeyCredential` object back
+# in params[:publicKeyCredential]:
+begin
+  webauthn_credential = relying_party.verify_registration(
+    params[:publicKeyCredential],
+    params[:create_challenge]
+  )
+
+  # Store Credential ID, Credential Public Key and Sign Count for future authentications
+  user.credentials.create!(
+    external_id: webauthn_credential.id,
+    public_key: webauthn_credential.public_key,
+    sign_count: webauthn_credential.sign_count
+  )
+rescue WebAuthn::Error => e
+  # Handle error
+end
+```
+
+### Credential Authentication
+
+#### Initiation phase
+
+```ruby
+options = relying_party.options_for_authentication(allow: user.credentials.map { |c| c.webauthn_id })
+
+# Store the newly generated challenge somewhere so you can have it
+# for the verification phase.
+session[:authentication_challenge] = options.challenge
+
+# Send `options` back to the browser, so that they can be used
+# to call `navigator.credentials.get({ "publicKey": options })`
+
+# You can call `options.as_json` to get a ruby hash with a JSON representation if needed.
+
+# If inside a Rails controller, `render json: options` will just work.
+# I.e. it will encode and convert the options to JSON automatically.
+
+# For your frontend code, you might find @github/webauthn-json npm package useful.
+# Especially for handling the necessary decoding of the options, and sending the
+# `PublicKeyCredential` object back to the server.
+```
+
+#### Verification phase
+
+```ruby
+begin
+  # Assuming you're using @github/webauthn-json package to send the `PublicKeyCredential` object back
+  # in params[:publicKeyCredential]:
+  webauthn_credential, stored_credential = relying_party.verify_authentication(
+    params[:publicKeyCredential],
+    session[:authentication_challenge]
+  ) do |webauthn_credential|
+    # the returned object needs to respond to #public_key and #sign_count
+    user.credentials.find_by(external_id: webauthn_credential.id)
+  end
+
+  # Update the stored credential sign count with the value from `webauthn_credential.sign_count`
+  stored_credential.update!(sign_count: webauthn_credential.sign_count)
+
+  # Continue with successful sign in or 2FA verification...
+
+rescue WebAuthn::SignCountVerificationError => e
+  # Cryptographic verification of the authenticator data succeeded, but the signature counter was less then or equal
+  # to the stored value. This can have several reasons and depending on your risk tolerance you can choose to fail or
+  # pass authentication. For more information see https://www.w3.org/TR/webauthn/#sign-counter
+rescue WebAuthn::Error => e
+  # Handle error
+end
+```
+
+## Moving from Global to Instance Based Configuration
+
+Adding a configuration for a new instance does not mean you need to get rid of your Global configuration. They can co-exist in your application and be both available for the different usages you might have. `WebAuthn.configuration.relying_party` will always return the global one while `WebAuthn::RelyingParty.new`, executed anywhere in your codebase, will allow you to create a different instance as you see the need. They will not collide and instead operate in isolation without any shared state.
+
+The gem API described in the current [Usage](../README.md#usage) section for the [Global Configuration](../README.md#configuration) approach will still valid but the [Instance Based API](#instance-based-api) also works with the global `relying_party` that is maintain globally at `WebAuthn.configuration.relying_party`.

data/docs/u2f_migration.md

@@ -53,7 +53,7 @@ migrated_credential.authenticator_data.sign_count
 
 ## Authenticate migrated U2F credentials
 
-Following the documentation on the [authentication initiation](https://github.com/cedarcode/webauthn-ruby/blob/master/README.md#authentication),
+Following the documentation on the [authentication initiation](https://github.com/cedarcode/webauthn-ruby/blob/master/README.md#initiation-phase-1),
 you need to specify the [FIDO AppID extension](https://www.w3.org/TR/webauthn/#sctn-appid-extension) for U2F migratedq
 credentials. The WebAuthn standard explains:
 
@@ -65,32 +65,26 @@ For the earlier given example `domain` this means:
 - FIDO AppID: `https://login.example.com`
 - Valid RP IDs: `login.example.com` (default) and `example.com`
 
+You can request the use of the `appid` extension by setting the AppID in the configuration, like this:
+
+```ruby
+WebAuthn.configure do |config|
+  config.legacy_u2f_appid = "https://login.example.com"
+end
+```
+
+By doing this, the `appid` extension will be automatically requested when generating the options for get:
+
 ```ruby
-credential_request_options = WebAuthn.credential_request_options
-credential_request_options[:extensions] = { appid: domain.to_s }
+options = WebAuthn::Credential.options_for_get
 ```
 
 On the frontend, in the resolved value from `navigator.credentials.get({ "publicKey": credentialRequestOptions })` add
 a call to [getClientExtensionResults()](https://www.w3.org/TR/webauthn/#dom-publickeycredential-getclientextensionresults)
 and send its result to your backend alongside the `id`/`rawId` and `response` values. If the authenticator used the AppID
-extension, the returned value will contain `{ "appid": true }`. In the example below, we use `clientExtensionResults`.
+extension, the returned value will contain `{ "appid": true }`.
 
-During authentication verification phase, you must pass either the original AppID or the RP ID as the `rp_id` argument:
+During authentication verification phase, if you followed the [verification phase documentation](https://github.com/cedarcode/webauthn-ruby#verification-phase-1) and have set the AppID in the config, the method `PublicKeyCredentialWithAssertion#verify` will be smart enough to determine if it should use the AppID or the RP ID to verify the WebAuthn credential, depending on the output of the `appid` client extension:
 
 > If true, the AppID was used and thus, when verifying an assertion, the Relying Party MUST expect the `rpIdHash` to be
 > the hash of the _AppID_, not the RP ID.
-
-```ruby
-assertion_response = WebAuthn::AuthenticatorAssertionResponse.new(
-  credential_id: params[:id],
-  authenticator_data: params[:response][:authenticatorData],
-  client_data_json: params[:response][:clientDataJSON],
-  signature: params[:response][:signature],
-)
-
-assertion_response.verify(
-  expected_challenge,
-  allowed_credentials: [credential],
-  rp_id: params[:clientExtensionResults][:appid] ? domain.to_s : domain.host,
-)
-```

data/lib/cose/rsapkcs1_algorithm.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "cose"
+require "cose/algorithm/signature_algorithm"
+require "cose/error"
+require "cose/key/rsa"
+require "openssl/signature_algorithm/rsapkcs1"
+
+class RSAPKCS1Algorithm < COSE::Algorithm::SignatureAlgorithm
+  attr_reader :hash_function
+
+  def initialize(*args, hash_function:)
+    super(*args)
+
+    @hash_function = hash_function
+  end
+
+  private
+
+  def signature_algorithm_class
+    OpenSSL::SignatureAlgorithm::RSAPKCS1
+  end
+
+  def valid_key?(key)
+    to_cose_key(key).is_a?(COSE::Key::RSA)
+  end
+
+  def to_pkey(key)
+    case key
+    when COSE::Key::RSA
+      key.to_pkey
+    when OpenSSL::PKey::RSA
+      key
+    else
+      raise(COSE::Error, "Incompatible key for algorithm")
+    end
+  end
+end
+
+COSE::Algorithm.register(RSAPKCS1Algorithm.new(-257, "RS256", hash_function: "SHA256"))
+COSE::Algorithm.register(RSAPKCS1Algorithm.new(-258, "RS384", hash_function: "SHA384"))
+COSE::Algorithm.register(RSAPKCS1Algorithm.new(-259, "RS512", hash_function: "SHA512"))
+
+# Patch openssl-signature_algorithm gem to support discouraged/deprecated RSA-PKCS#1 with SHA-1
+# (RS1 in JOSE/COSE terminology) algorithm needed for WebAuthn.
+OpenSSL::SignatureAlgorithm::RSAPKCS1.const_set(
+  :ACCEPTED_HASH_FUNCTIONS,
+  OpenSSL::SignatureAlgorithm::RSAPKCS1::ACCEPTED_HASH_FUNCTIONS + ["SHA1"]
+)
+COSE::Algorithm.register(RSAPKCS1Algorithm.new(-65535, "RS1", hash_function: "SHA1"))

data/lib/webauthn/attestation_object.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "cbor"
+require "forwardable"
+require "openssl"
+require "webauthn/attestation_statement"
+require "webauthn/authenticator_data"
+
+module WebAuthn
+  class AttestationObject
+    extend Forwardable
+
+    def self.deserialize(attestation_object, relying_party)
+      from_map(CBOR.decode(attestation_object), relying_party)
+    end
+
+    def self.from_map(map, relying_party)
+      new(
+        authenticator_data: WebAuthn::AuthenticatorData.deserialize(map["authData"]),
+        attestation_statement: WebAuthn::AttestationStatement.from(
+          map["fmt"],
+          map["attStmt"],
+          relying_party: relying_party
+        )
+      )
+    end
+
+    attr_reader :authenticator_data, :attestation_statement, :relying_party
+
+    def initialize(authenticator_data:, attestation_statement:)
+      @authenticator_data = authenticator_data
+      @attestation_statement = attestation_statement
+    end
+
+    def valid_attested_credential?
+      authenticator_data.attested_credential_data_included? &&
+        authenticator_data.attested_credential_data.valid?
+    end
+
+    def valid_attestation_statement?(client_data_hash)
+      attestation_statement.valid?(authenticator_data, client_data_hash)
+    end
+
+    def_delegators :authenticator_data, :credential, :aaguid
+    def_delegators :attestation_statement, :attestation_certificate_key_id
+  end
+end

data/lib/webauthn/attestation_statement/android_key.rb

@@ -1,73 +1,67 @@
 # frozen_string_literal: true
 
+require "android_key_attestation"
 require "openssl"
-require "webauthn/attestation_statement/android_key/key_description"
 require "webauthn/attestation_statement/base"
-require "webauthn/security_utils"
-require "webauthn/signature_verifier"
 
 module WebAuthn
   module AttestationStatement
     class AndroidKey < Base
-      EXTENSION_DATA_OID = "1.3.6.1.4.1.11129.2.1.17"
-
-      # https://android.googlesource.com/platform/hardware/libhardware/+/master/include/hardware/keymaster_defs.h
-      KM_ORIGIN_GENERATED = 0
-      KM_PURPOSE_SIGN = 2
-
       def valid?(authenticator_data, client_data_hash)
         valid_signature?(authenticator_data, client_data_hash) &&
           matching_public_key?(authenticator_data) &&
           valid_attestation_challenge?(client_data_hash) &&
-          all_applications_field_not_present? &&
+          all_applications_fields_not_set? &&
           valid_authorization_list_origin? &&
           valid_authorization_list_purpose? &&
-          [WebAuthn::AttestationStatement::ATTESTATION_TYPE_BASIC, attestation_trust_path]
+          trustworthy?(aaguid: authenticator_data.aaguid) &&
+          [attestation_type, attestation_trust_path]
       end
 
       private
 
-      def valid_signature?(authenticator_data, client_data_hash)
-        WebAuthn::SignatureVerifier
-          .new(algorithm, attestation_certificate.public_key)
-          .verify(signature, authenticator_data.data + client_data_hash)
+      def valid_attestation_challenge?(client_data_hash)
+        android_key_attestation.verify_challenge(client_data_hash)
+      rescue AndroidKeyAttestation::ChallengeMismatchError
+        false
       end
 
-      def matching_public_key?(authenticator_data)
-        attestation_certificate.public_key.to_der == authenticator_data.credential.public_key_object.to_der
+      def valid_certificate_chain?(aaguid: nil, **_)
+        android_key_attestation.verify_certificate_chain(root_certificates: root_certificates(aaguid: aaguid))
+      rescue AndroidKeyAttestation::CertificateVerificationError
+        false
       end
 
-      def valid_attestation_challenge?(client_data_hash)
-        WebAuthn::SecurityUtils.secure_compare(key_description.attestation_challenge, client_data_hash)
-      end
-
-      def all_applications_field_not_present?
-        tee_enforced.all_applications.nil? && software_enforced.all_applications.nil?
+      def all_applications_fields_not_set?
+        !tee_enforced.all_applications && !software_enforced.all_applications
       end
 
       def valid_authorization_list_origin?
-        tee_enforced.origin == KM_ORIGIN_GENERATED || software_enforced.origin == KM_ORIGIN_GENERATED
+        tee_enforced.origin == :generated || software_enforced.origin == :generated
       end
 
       def valid_authorization_list_purpose?
-        tee_enforced.purpose == KM_PURPOSE_SIGN || software_enforced.purpose == KM_PURPOSE_SIGN
+        tee_enforced.purpose == [:sign] || software_enforced.purpose == [:sign]
       end
 
       def tee_enforced
-        key_description.tee_enforced
+        android_key_attestation.tee_enforced
       end
 
       def software_enforced
-        key_description.software_enforced
+        android_key_attestation.software_enforced
+      end
+
+      def attestation_type
+        WebAuthn::AttestationStatement::ATTESTATION_TYPE_BASIC
       end
 
-      def key_description
-        @key_description ||= begin
-          extension_data = attestation_certificate.extensions.detect { |ext| ext.oid == EXTENSION_DATA_OID }
-          raw_key_description = OpenSSL::ASN1.decode(extension_data).value.last
+      def default_root_certificates
+        AndroidKeyAttestation::Statement::GOOGLE_ROOT_CERTIFICATES
+      end
 
-          KeyDescription.new(OpenSSL::ASN1.decode(raw_key_description.value).value)
-        end
+      def android_key_attestation
+        @android_key_attestation ||= AndroidKeyAttestation::Statement.new(*certificates)
       end
     end
   end

data/lib/webauthn/attestation_statement/android_safetynet.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "android_safetynet/attestation_response"
+require "safety_net_attestation"
 require "openssl"
 require "webauthn/attestation_statement/base"
 
@@ -12,11 +12,8 @@ module WebAuthn
         valid_response?(authenticator_data, client_data_hash) &&
           valid_version? &&
           cts_profile_match? &&
-          [WebAuthn::AttestationStatement::ATTESTATION_TYPE_BASIC, attestation_trust_path]
-      end
-
-      def attestation_certificate
-        attestation_response.leaf_certificate
+          trustworthy?(aaguid: authenticator_data.aaguid) &&
+          [attestation_type, attestation_trust_path]
       end
 
       private
@@ -25,8 +22,9 @@ module WebAuthn
         nonce = Digest::SHA256.base64digest(authenticator_data.data + client_data_hash)
 
         begin
-          attestation_response.verify(nonce, trustworthiness: false)
-        rescue ::AndroidSafetynet::AttestationResponse::VerificationError
+          attestation_response
+            .verify(nonce, trusted_certificates: root_certificates(aaguid: authenticator_data.aaguid), time: time)
+        rescue SafetyNetAttestation::Error
           false
         end
       end
@@ -40,12 +38,30 @@ module WebAuthn
         attestation_response.cts_profile_match?
       end
 
-      def attestation_trust_path
-        attestation_response.certificate_chain
+      def valid_certificate_chain?(**_)
+        # Already performed as part of #valid_response?
+        true
+      end
+
+      def attestation_type
+        WebAuthn::AttestationStatement::ATTESTATION_TYPE_BASIC
+      end
+
+      # SafetyNetAttestation returns full chain including root, WebAuthn expects only the x5c certificates
+      def certificates
+        attestation_response.certificate_chain[0..-2]
       end
 
       def attestation_response
-        @attestation_response ||= ::AndroidSafetynet::AttestationResponse.new(statement["response"])
+        @attestation_response ||= SafetyNetAttestation::Statement.new(statement["response"])
+      end
+
+      def default_root_certificates
+        SafetyNetAttestation::Statement::GOOGLE_ROOT_CERTIFICATES
+      end
+
+      def time
+        Time.now
       end
     end
   end

data/lib/webauthn/attestation_statement/apple.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "openssl"
+require "webauthn/attestation_statement/base"
+
+module WebAuthn
+  module AttestationStatement
+    class Apple < Base
+      # Source: https://www.apple.com/certificateauthority/private/
+      ROOT_CERTIFICATE =
+        OpenSSL::X509::Certificate.new(<<~PEM)
+          -----BEGIN CERTIFICATE-----
+          MIICEjCCAZmgAwIBAgIQaB0BbHo84wIlpQGUKEdXcTAKBggqhkjOPQQDAzBLMR8w
+          HQYDVQQDDBZBcHBsZSBXZWJBdXRobiBSb290IENBMRMwEQYDVQQKDApBcHBsZSBJ
+          bmMuMRMwEQYDVQQIDApDYWxpZm9ybmlhMB4XDTIwMDMxODE4MjEzMloXDTQ1MDMx
+          NTAwMDAwMFowSzEfMB0GA1UEAwwWQXBwbGUgV2ViQXV0aG4gUm9vdCBDQTETMBEG
+          A1UECgwKQXBwbGUgSW5jLjETMBEGA1UECAwKQ2FsaWZvcm5pYTB2MBAGByqGSM49
+          AgEGBSuBBAAiA2IABCJCQ2pTVhzjl4Wo6IhHtMSAzO2cv+H9DQKev3//fG59G11k
+          xu9eI0/7o6V5uShBpe1u6l6mS19S1FEh6yGljnZAJ+2GNP1mi/YK2kSXIuTHjxA/
+          pcoRf7XkOtO4o1qlcaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUJtdk
+          2cV4wlpn0afeaxLQG2PxxtcwDgYDVR0PAQH/BAQDAgEGMAoGCCqGSM49BAMDA2cA
+          MGQCMFrZ+9DsJ1PW9hfNdBywZDsWDbWFp28it1d/5w2RPkRX3Bbn/UbDTNLx7Jr3
+          jAGGiQIwHFj+dJZYUJR786osByBelJYsVZd2GbHQu209b5RCmGQ21gpSAk9QZW4B
+          1bWeT0vT
+          -----END CERTIFICATE-----
+        PEM
+
+      NONCE_EXTENSION_OID = "1.2.840.113635.100.8.2"
+
+      def valid?(authenticator_data, client_data_hash)
+        valid_nonce?(authenticator_data, client_data_hash) &&
+          matching_public_key?(authenticator_data) &&
+          trustworthy? &&
+          [attestation_type, attestation_trust_path]
+      end
+
+      private
+
+      def valid_nonce?(authenticator_data, client_data_hash)
+        extension = cred_cert&.find_extension(NONCE_EXTENSION_OID)
+
+        if extension
+          sequence = OpenSSL::ASN1.decode(extension.value_der)
+
+          sequence.tag == OpenSSL::ASN1::SEQUENCE &&
+            sequence.value.size == 1 &&
+            sequence.value[0].value[0].value ==
+              OpenSSL::Digest::SHA256.digest(authenticator_data.data + client_data_hash)
+        end
+      end
+
+      def attestation_type
+        WebAuthn::AttestationStatement::ATTESTATION_TYPE_ANONCA
+      end
+
+      def cred_cert
+        attestation_certificate
+      end
+
+      def default_root_certificates
+        [ROOT_CERTIFICATE]
+      end
+    end
+  end
+end