webauthn 2.5.2 → 3.0.0.alpha1

data/script/ci/install-openssl

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -e
+
+if [[ "$LIBSSL" == "1.0" ]]; then
+  sudo apt-get install libssl1.0-dev
+fi

data/script/ci/install-ruby

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -e
+
+source "$HOME/.rvm/scripts/rvm"
+
+if [[ "$LIBSSL" == "1.0" ]]; then
+  rvm use --install $RB --autolibs=read-only --disable-binary
+elif [[ "$LIBSSL" == "1.1" ]]; then
+  rvm use --install $RB --binary --fuzzy
+fi
+
+[[ "`ruby -ropenssl -e 'puts OpenSSL::OPENSSL_VERSION'`" =~ "OpenSSL $LIBSSL" ]] || { echo "Wrong libssl version"; exit 1; }

data/webauthn.gemspec

@@ -37,16 +37,17 @@ Gem::Specification.new do |spec|
   spec.add_dependency "awrence", "~> 1.1"
   spec.add_dependency "bindata", "~> 2.4"
   spec.add_dependency "cbor", "~> 0.5.9"
-  spec.add_dependency "cose", "~> 1.1"
-  spec.add_dependency "openssl", ">= 2.2", "< 3.1"
+  spec.add_dependency "cose", "~> 1.0"
+  spec.add_dependency "openssl", "~> 2.0"
   spec.add_dependency "safety_net_attestation", "~> 0.4.0"
-  spec.add_dependency "tpm-key_attestation", "~> 0.11.0"
+  spec.add_dependency "securecompare", "~> 1.0"
+  spec.add_dependency "tpm-key_attestation", "~> 0.9.0"
 
+  spec.add_development_dependency "appraisal", "~> 2.3.0"
   spec.add_development_dependency "bundler", ">= 1.17", "< 3.0"
   spec.add_development_dependency "byebug", "~> 11.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.8"
-  spec.add_development_dependency "rubocop", "~> 1.9.1"
-  spec.add_development_dependency "rubocop-rake", "~> 0.5.1"
-  spec.add_development_dependency "rubocop-rspec", "~> 2.2.0"
+  spec.add_development_dependency "rubocop", "0.80.1"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.38.1"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: webauthn
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 3.0.0.alpha1
 platform: ruby
 authors:
 - Gonzalo Rodriguez
 - Braulio Martinez
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: android_key_attestation
@@ -73,34 +73,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: openssl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: safety_net_attestation
   requirement: !ruby/object:Gem::Requirement
@@ -115,20 +109,48 @@ 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -195,44 +217,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 0.80.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.9.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.80.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 1.38.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 1.38.1
 description: |-
   WebAuthn ruby server library ― Make your application a W3C Web Authentication conformant
       Relying Party and allow your users to authenticate with U2F and FIDO2 authenticators.
@@ -243,11 +251,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/build.yml"
-- ".github/workflows/git.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -257,15 +265,18 @@ files:
 - SECURITY.md
 - bin/console
 - bin/setup
-- docs/advanced_configuration.md
 - docs/u2f_migration.md
+- gemfiles/cose_head.gemfile
+- gemfiles/openssl_2_0.gemfile
+- gemfiles/openssl_2_1.gemfile
+- gemfiles/openssl_2_2.gemfile
+- gemfiles/openssl_head.gemfile
 - lib/cose/rsapkcs1_algorithm.rb
 - lib/webauthn.rb
 - lib/webauthn/attestation_object.rb
 - lib/webauthn/attestation_statement.rb
 - lib/webauthn/attestation_statement/android_key.rb
 - lib/webauthn/attestation_statement/android_safetynet.rb
-- lib/webauthn/attestation_statement/apple.rb
 - lib/webauthn/attestation_statement/base.rb
 - lib/webauthn/attestation_statement/fido_u2f.rb
 - lib/webauthn/attestation_statement/fido_u2f/public_key.rb
@@ -302,8 +313,12 @@ 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/relying_party.rb
+- lib/webauthn/security_utils.rb
 - lib/webauthn/u2f_migrator.rb
 - lib/webauthn/version.rb
+- script/ci/install-openssl
+- script/ci/install-ruby
 - webauthn.gemspec
 homepage: https://github.com/cedarcode/webauthn-ruby
 licenses:
@@ -312,7 +327,7 @@ metadata:
   bug_tracker_uri: https://github.com/cedarcode/webauthn-ruby/issues
   changelog_uri: https://github.com/cedarcode/webauthn-ruby/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/cedarcode/webauthn-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -323,12 +338,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: WebAuthn ruby server library
 test_files: []

data/.github/workflows/build.yml

@@ -1,32 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: build
-
-on: push
-
-jobs:
-  test:
-    runs-on: ubuntu-20.04
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby:
-          - '3.1'
-          - '3.0'
-          - '2.7'
-          - '2.6'
-          - '2.5'
-          - '2.4'
-          - truffleruby
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - run: bundle exec rake

data/.github/workflows/git.yml

@@ -1,21 +0,0 @@
-# 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/docs/advanced_configuration.md

@@ -1,174 +0,0 @@
-# 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/lib/webauthn/attestation_statement/apple.rb

@@ -1,65 +0,0 @@
-# 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