webauthn 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e6487b19f172c0c7e96af23d04e47f91bebd2ef7d20f144f99f85e761a2db86
-  data.tar.gz: 7623405e7cd01708f29897a0d4183fbc8c9b2a3dfb06b9c182646ddaf9c6cb0d
+  metadata.gz: c1e5f50210b030860b4f7c5356420c2f462e6d4eae1f1adb254d1c69e90eead5
+  data.tar.gz: aab42b79101469b6783b522bdcefd6cd70c20ca055b10ffa85a2847cb400afab
 SHA512:
-  metadata.gz: d2f8d2137b2ee140a3258fbbff8d62e49264b2eafa80f0726dacc16a742addf75625b9da51696db6f3862a85e63f44ca5fc2b73320b1c256dd1c57f96121de24
-  data.tar.gz: dcb2ea914a14944b4bf7c4682394df12e00ddd4a4b0cc1076a03a7368bf4d563d08b61fbbe27ece3ddcbc05a9ed542d8236c1bfce833669c9b60c5d3387b35b4
+  metadata.gz: eb440aeec87f78c45890e13cb1587eb736b457b791b23644ede24952cd3590ee5ff69a55975a5813cbd34699a21c593463907f592c668356efb1c020f73cecda
+  data.tar.gz: a9b6015c20a893ad8916e0251ff79a3d1871544acb027e1faf7a8553a3c8b70111c7a1beae9a590950e484248a70c490d0d0017f4d9c92fc14935e58cc083642

data/.github/workflows/build.yml

@@ -16,17 +16,13 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - '3.1'
           - '3.0'
           - '2.7'
           - '2.6'
           - '2.5'
           - '2.4'
           - truffleruby
-        gemfile:
-          - openssl_2_2
-          - openssl_2_1
-    env:
-      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1

data/.github/workflows/git.yml

@@ -0,0 +1,21 @@
+# Syntax reference:
+# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
+name: Git Checks
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  # Fixup commits are OK in pull requests, but should generally be squashed
+  # before merging to master, e.g. using `git rebase -i --autosquash master`.
+  # See https://github.com/marketplace/actions/block-autosquash-commits
+  block-fixup:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2.0.0
+      - name: Block autosquash commits
+        uses: xt0rted/block-autosquash-commits-action@v2
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

data/CHANGELOG.md

@@ -6,6 +6,16 @@
 
 - Ability to define multiple relying parties with the introduction of the `WebAuthn::RelyingParty` class ([@padulafacundo], [@brauliomartinezlm])
 
+## [v2.5.1] - 2022-03-20
+
+### Added
+
+- Updated openssl support to be ~>2.2 [@bdewater]
+
+### Removed
+
+- Removed dependency [secure_compare dependency] (https://rubygems.org/gems/secure_compare/versions/0.0.1) and use OpenSSL#secure_compare instead [@bdewater]
+
 ## [v2.5.0] - 2021-03-14
 
 ### Added
@@ -325,6 +335,7 @@ Note: Both additions should help making it compatible with Chrome for Android 70
 - Works with ruby 2.5
 
 [v3.0.0.alpha1]: https://github.com/cedarcode/webauthn-ruby/compare/2-stable...v3.0.0.alpha1/
+[v2.5.1]: https://github.com/cedarcode/webauthn-ruby/compare/v2.5.0...v2.5.1/
 [v2.5.0]: https://github.com/cedarcode/webauthn-ruby/compare/v2.4.1...v2.5.0/
 [v2.4.1]: https://github.com/cedarcode/webauthn-ruby/compare/v2.4.0...v2.4.1/
 [v2.4.0]: https://github.com/cedarcode/webauthn-ruby/compare/v2.3.0...v2.4.0/
@@ -367,3 +378,5 @@ Note: Both additions should help making it compatible with Chrome for Android 70
 [@lgarron]: https://github.com/lgarron
 [@juanarias93]: https://github.com/juanarias93
 [@kingjan1999]: https://github.com/@kingjan1999
+[@jdongelmans]: https://github.com/jdongelmans
+[@petergoldstein]: https://github.com/petergoldstein

data/README.md

@@ -96,6 +96,8 @@ If you are migrating an existing application from the legacy FIDO U2F JavaScript
 
 ### Configuration
 
+If you have a multi-tenant application or just need to configure WebAuthn differently for separate parts of your application (e.g. if your users authenticate to different subdomains in the same application), we strongly recommend you look at this [Advanced Configuration](docs/advanced_configuration.md) section instead of this.
+
 For a Rails application this would go in `config/initializers/webauthn.rb`.
 
 ```ruby

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"
+    #
+    # rp_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::RelytingParty.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_create(
+  user: { id: user.webauthn_id, name: user.name },
+  exclude: user.credentials.map { |c| c.webauthn_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!(
+    webauthn_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_get(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
+    # the returned object needs to respond to #public_key and #sign_count
+    user.credentials.find_by(webauthn_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

@@ -82,7 +82,7 @@ During authentication verification phase, you must pass either the original AppI
 
 ```ruby
 assertion_response = WebAuthn::AuthenticatorAssertionResponse.new(
-  credential_id: params[:id],
+  user_handle: params[:response][:userHandle],
   authenticator_data: params[:response][:authenticatorData],
   client_data_json: params[:response][:clientDataJSON],
   signature: params[:response][:signature],
@@ -90,7 +90,8 @@ assertion_response = WebAuthn::AuthenticatorAssertionResponse.new(
 
 assertion_response.verify(
   expected_challenge,
-  allowed_credentials: [credential],
+  public_key: credential.public_key,
+  sign_count: credential.count,
   rp_id: params[:clientExtensionResults][:appid] ? domain.to_s : domain.host,
 )
 ```

data/lib/webauthn/attestation_statement/apple.rb

@@ -37,10 +37,10 @@ module WebAuthn
       private
 
       def valid_nonce?(authenticator_data, client_data_hash)
-        extension = cred_cert&.extensions&.detect { |ext| ext.oid == NONCE_EXTENSION_OID }
+        extension = cred_cert&.find_extension(NONCE_EXTENSION_OID)
 
         if extension
-          sequence = OpenSSL::ASN1.decode(OpenSSL::ASN1.decode(extension.to_der).value[1].value)
+          sequence = OpenSSL::ASN1.decode(extension.value_der)
 
           sequence.tag == OpenSSL::ASN1::SEQUENCE &&
             sequence.value.size == 1 &&

data/lib/webauthn/attestation_statement/base.rb

@@ -45,7 +45,7 @@ module WebAuthn
       end
 
       def attestation_certificate_key_id
-        raw_subject_key_identifier&.unpack("H*")&.[](0)
+        attestation_certificate.subject_key_identifier&.unpack("H*")&.[](0)
       end
 
       private
@@ -53,12 +53,10 @@ module WebAuthn
       attr_reader :statement
 
       def matching_aaguid?(attested_credential_data_aaguid)
-        extension = attestation_certificate&.extensions&.detect { |ext| ext.oid == AAGUID_EXTENSION_OID }
+        extension = attestation_certificate&.find_extension(AAGUID_EXTENSION_OID)
         if extension
-          # `extension.value` mangles data into ASCII, so we must manually compare bytes
-          # see https://github.com/ruby/openssl/pull/234
-          extension.to_der[-WebAuthn::AuthenticatorData::AttestedCredentialData::AAGUID_LENGTH..-1] ==
-            attested_credential_data_aaguid
+          aaguid_value = OpenSSL::ASN1.decode(extension.value_der).value
+          aaguid_value == attested_credential_data_aaguid
         else
           true
         end
@@ -141,15 +139,6 @@ module WebAuthn
         end
       end
 
-      def raw_subject_key_identifier
-        extension = attestation_certificate.extensions.detect { |ext| ext.oid == "subjectKeyIdentifier" }
-        return unless extension
-
-        ext_asn1 = OpenSSL::ASN1.decode(extension.to_der)
-        ext_value = ext_asn1.value.last
-        OpenSSL::ASN1.decode(ext_value.value).value
-      end
-
       def valid_signature?(authenticator_data, client_data_hash, public_key = attestation_certificate.public_key)
         raise("Incompatible algorithm and key") unless cose_algorithm.compatible_key?(public_key)
 

data/lib/webauthn/attestation_statement/packed.rb

@@ -46,7 +46,7 @@ module WebAuthn
 
           attestation_certificate.version == 2 &&
             subject.assoc('OU')&.at(1) == "Authenticator Attestation" &&
-            attestation_certificate.extensions.find { |ext| ext.oid == 'basicConstraints' }&.value == 'CA:FALSE'
+            attestation_certificate.find_extension('basicConstraints')&.value == 'CA:FALSE'
         else
           true
         end

data/lib/webauthn/authenticator_response.rb

@@ -3,7 +3,6 @@
 require "webauthn/authenticator_data"
 require "webauthn/client_data"
 require "webauthn/error"
-require "webauthn/security_utils"
 
 module WebAuthn
   TYPES = { create: "webauthn.create", get: "webauthn.get" }.freeze
@@ -79,7 +78,7 @@ module WebAuthn
     end
 
     def valid_challenge?(expected_challenge)
-      WebAuthn::SecurityUtils.secure_compare(client_data.challenge, expected_challenge)
+      OpenSSL.secure_compare(client_data.challenge, expected_challenge)
     end
 
     def valid_origin?(expected_origin)

data/lib/webauthn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebAuthn
-  VERSION = "2.5.0"
+  VERSION = "2.5.1"
 end

data/webauthn.gemspec

@@ -38,12 +38,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "bindata", "~> 2.4"
   spec.add_dependency "cbor", "~> 0.5.9"
   spec.add_dependency "cose", "~> 1.1"
-  spec.add_dependency "openssl", "~> 2.1"
+  spec.add_dependency "openssl", "~> 2.2"
   spec.add_dependency "safety_net_attestation", "~> 0.4.0"
-  spec.add_dependency "securecompare", "~> 1.0"
   spec.add_dependency "tpm-key_attestation", "~> 0.10.0"
 
-  spec.add_development_dependency "appraisal", "~> 2.4"
   spec.add_development_dependency "bundler", ">= 1.17", "< 3.0"
   spec.add_development_dependency "byebug", "~> 11.0"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webauthn
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Gonzalo Rodriguez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-14 00:00:00.000000000 Z
+date: 2022-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: android_key_attestation
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: safety_net_attestation
   requirement: !ruby/object:Gem::Requirement
@@ -109,20 +109,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: securecompare
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: tpm-key_attestation
   requirement: !ruby/object:Gem::Requirement
@@ -137,20 +123,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -266,10 +238,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build.yml"
+- ".github/workflows/git.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- Appraisals
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -279,9 +251,8 @@ files:
 - SECURITY.md
 - bin/console
 - bin/setup
+- docs/advanced_configuration.md
 - docs/u2f_migration.md
-- gemfiles/openssl_2_1.gemfile
-- gemfiles/openssl_2_2.gemfile
 - lib/cose/rsapkcs1_algorithm.rb
 - lib/webauthn.rb
 - lib/webauthn/attestation_object.rb
@@ -325,7 +296,6 @@ files:
 - lib/webauthn/public_key_credential/user_entity.rb
 - lib/webauthn/public_key_credential_with_assertion.rb
 - lib/webauthn/public_key_credential_with_attestation.rb
-- lib/webauthn/security_utils.rb
 - lib/webauthn/u2f_migrator.rb
 - lib/webauthn/version.rb
 - webauthn.gemspec
@@ -351,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: WebAuthn ruby server library

data/Appraisals

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-appraise "openssl_2_2" do
-  gem "openssl", "~> 2.2.0"
-end
-
-appraise "openssl_2_1" do
-  gem "openssl", "~> 2.1.0"
-end

data/gemfiles/openssl_2_1.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "openssl", "~> 2.1.0"
-
-gemspec path: "../"

data/gemfiles/openssl_2_2.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "openssl", "~> 2.2.0"
-
-gemspec path: "../"

data/lib/webauthn/security_utils.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require "securecompare"
-
-module WebAuthn
-  module SecurityUtils
-    # Constant time string comparison, for variable length strings.
-    # This code was adapted from Rails ActiveSupport::SecurityUtils
-    #
-    # The values are first processed by SHA256, so that we don't leak length info
-    # via timing attacks.
-    def secure_compare(first_string, second_string)
-      first_string_sha256 = ::Digest::SHA256.digest(first_string)
-      second_string_sha256 = ::Digest::SHA256.digest(second_string)
-
-      SecureCompare.compare(first_string_sha256, second_string_sha256) && first_string == second_string
-    end
-    module_function :secure_compare
-  end
-end