webauthn 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0b7730e28517a0a0c8490fe77a7f1826de3914f7af3ccf6aefcc1e5268e4a45
-  data.tar.gz: 5a9433f01315b4360388d4d08667b041539f5fef43d48034d1deece03d24b48b
+  metadata.gz: f9b0ee13d67d762afc44c92d76d99a7a7f3500c31658a0248a6dfb4d986f3f18
+  data.tar.gz: 888a0fb232facc8e5d02458bc1c94f926ed4b8541cac4b3937cf7bb4098ed0f4
 SHA512:
-  metadata.gz: cbfc86b1a82b1906a1adda4ab47e4cb7a523b520ecb533aa9587e047f463f74eccde0a88bff0ffb3acc037dc163cdbd40bad173c3e35a52492c230432897aeef
-  data.tar.gz: 887545a11d8d387deb137d228fb2f7a0c13f4462d7ca8b9247b68be7cdb40fcf478ee7b53bb5d39d7f89b6230d8c332676c20c7f5623f272522838f14b5213ef
+  metadata.gz: a8f7821dbbc3ce730216ade21b37a23d6c202e1e060b90ed1bfb419c2abeed1ff6867d4ba6730de07d7b0f0eef54306358c894cac95faf90cb09af397f60f49e
+  data.tar.gz: ec06219c2f23352fbeec12c6bdf550b5120403c2dbbc249eb577e1eeb90f16ee1425b8ca857cdcdef884d7e2cd385e1d4e5dfb3cc9173aabc511088cf0627760

data/.gitignore

@@ -12,4 +12,4 @@
 
 /Gemfile.lock
 /gemfiles/*.gemfile.lock
-/.byebug_history
+.byebug_history

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
+--order rand
 --color

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [v1.13.0] - 2019-04-09
+
+### Added
+
+- Verify 'none' attestation statement is really empty.
+- Verify 'packed' attestation statement certificates start/end dates.
+- Verify 'packed' attestation statement signature algorithm.
+- Verify 'fiod-u2f attestation statement AAGUID is zeroed out. Thank you @bdewater.
+- Verify 'android-key' attestation statement signature algorithm.
+- Verify assertion response signature algorithm.
+- Verify collectedClientData.tokenBinding format.
+- `WebAuthn.credential_creation_options` now accept `rp_name`, `user_id`, `user_name` and `display_name` as keyword arguments. Thank you @bdewater.
+
 ## [v1.12.0] - 2019-04-03
 
 ### Added
@@ -153,7 +166,8 @@ Note: Both additions should help making it compatible with Chrome for Android 70
   - `WebAuthn::AuthenticatorAttestationResponse.valid?` can be used to validate fido-u2f attestations returned by the browser
 - Works with ruby 2.5
 
-[v1.12.0]: https://github.com/cedarcode/webauthn-ruby/compare/v1.12.0...v1.12.0/
+[v1.13.0]: https://github.com/cedarcode/webauthn-ruby/compare/v1.12.0...v1.13.0/
+[v1.12.0]: https://github.com/cedarcode/webauthn-ruby/compare/v1.11.0...v1.12.0/
 [v1.11.0]: https://github.com/cedarcode/webauthn-ruby/compare/v1.10.0...v1.11.0/
 [v1.10.0]: https://github.com/cedarcode/webauthn-ruby/compare/v1.9.0...v1.10.0/
 [v1.9.0]: https://github.com/cedarcode/webauthn-ruby/compare/v1.8.0...v1.9.0/

data/README.md

@@ -95,8 +95,13 @@ attestation_response = WebAuthn::AuthenticatorAttestationResponse.new(
 # the User Agent as part of the verification phase.
 original_origin = "https://www.example.com"
 
+# In the case that a Relying Party ID (https://www.w3.org/TR/webauthn/#relying-party-identifier) different from `original_origin` was used on
+# `navigator.credentials.create`, it needs to specified for verification.
+# Otherwise, you can ignore passing in this value to the `verify` method below.
+rp_id = "example.com"
+
 begin
-  attestation_response.verify(original_challenge, original_origin)
+  attestation_response.verify(original_challenge, original_origin, rp_id: rp_id)
 
   # 1. Register the new user and
   # 2. Keep Credential ID and Credential Public Key under storage
@@ -157,6 +162,11 @@ assertion_response = WebAuthn::AuthenticatorAssertionResponse.new(
 # the User Agent as part of the verification phase.
 original_origin = "https://www.example.com"
 
+# In the case that a Relying Party ID (https://www.w3.org/TR/webauthn/#relying-party-identifier) different from `original_origin` was used on
+# `navigator.credentials.get`, it needs to be specified for verification.
+# Otherwise, you can ignore passing in this value to the `verify` method below.`
+rp_id = "example.com"
+
 # This hash must have the id and its corresponding public key of the
 # previously stored credential for the user that is attempting to sign in.
 allowed_credential = {
@@ -165,7 +175,7 @@ allowed_credential = {
 }
 
 begin
-  assertion_response.verify(original_challenge, original_origin, allowed_credentials: [allowed_credential])
+  assertion_response.verify(original_challenge, original_origin, allowed_credentials: [allowed_credential], rp_id: rp_id)
 
   # Sign in the user
 rescue WebAuthn::VerificationError => e

data/lib/cose/algorithm.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# TODO: Move this to cose gem
+module COSE
+  # https://tools.ietf.org/html/rfc8152#section-8.1
+  Algorithm = Struct.new(:id, :name, :hash, :key_curve) do
+    @registered = {}
+
+    def self.register(id, name, hash, key_curve)
+      @registered[id] = COSE::Algorithm.new(id, name, hash, key_curve)
+    end
+
+    def self.find(id)
+      @registered[id]
+    end
+
+    def self.by_name(name)
+      @registered.values.detect { |algorithm| algorithm.name == name }
+    end
+
+    def value
+      id
+    end
+  end
+end
+
+COSE::Algorithm.register(-7, "ES256", "SHA256", "prime256v1")

data/lib/webauthn.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "cose/ecdsa"
+require "cose/algorithm"
 require "webauthn/authenticator_attestation_response"
 require "webauthn/authenticator_assertion_response"
 require "webauthn/security_utils"
@@ -11,18 +11,21 @@ require "securerandom"
 require "json"
 
 module WebAuthn
-  CRED_PARAM_ES256 = { type: "public-key", alg: COSE::ECDSA::ALG_ES256 }.freeze
-  RP_NAME = "web-server"
-  USER_ID = "1"
-  USER_NAME = "web-user"
+  CRED_PARAM_ES256 = { type: "public-key", alg: COSE::Algorithm.by_name("ES256").id }.freeze
   TYPES = { create: "webauthn.create", get: "webauthn.get" }.freeze
 
-  def self.credential_creation_options
+  # TODO: make keyword arguments mandatory in next major version
+  def self.credential_creation_options(
+    rp_name: "web-server",
+    user_name: "web-user",
+    display_name: "web-user",
+    user_id: "1"
+  )
     {
       challenge: challenge,
       pubKeyCredParams: [CRED_PARAM_ES256],
-      rp: { name: RP_NAME },
-      user: { name: USER_NAME, displayName: USER_NAME, id: USER_ID }
+      rp: { name: rp_name },
+      user: { name: user_name, displayName: display_name, id: user_id }
     }
   end
 

data/lib/webauthn/attestation_statement/android_key.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "cose/algorithm"
 require "openssl"
 require "webauthn/attestation_statement/android_key/key_description"
 require "webauthn/attestation_statement/base"
@@ -26,11 +27,17 @@ module WebAuthn
       private
 
       def valid_signature?(authenticator_data, client_data_hash)
-        attestation_certificate.public_key.verify(
-          OpenSSL::Digest::SHA256.new,
-          signature,
-          authenticator_data.data + client_data_hash
-        )
+        cose_algorithm = COSE::Algorithm.find(algorithm)
+
+        if cose_algorithm
+          attestation_certificate.public_key.verify(
+            cose_algorithm.hash,
+            signature,
+            authenticator_data.data + client_data_hash
+          )
+        else
+          raise "Unsupported algorithm #{algorithm}"
+        end
       end
 
       def matching_public_key?(authenticator_data)
@@ -87,6 +94,10 @@ module WebAuthn
       def signature
         statement["sig"]
       end
+
+      def algorithm
+        statement["alg"]
+      end
     end
   end
 end

data/lib/webauthn/attestation_statement/fido_u2f.rb

@@ -8,12 +8,14 @@ module WebAuthn
   module AttestationStatement
     class FidoU2f < Base
       VALID_ATTESTATION_CERTIFICATE_COUNT = 1
-      VALID_ATTESTATION_CERTIFICATE_KEY_CURVE = "prime256v1"
+      VALID_ATTESTATION_CERTIFICATE_ALGORITHM = COSE::Algorithm.by_name("ES256")
+      VALID_ATTESTED_AAGUID = 0.chr * WebAuthn::AuthenticatorData::AttestedCredentialData::AAGUID_LENGTH
 
       def valid?(authenticator_data, client_data_hash)
         valid_format? &&
           valid_certificate_public_key? &&
           valid_credential_public_key?(authenticator_data.credential.public_key) &&
+          valid_aaguid?(authenticator_data.attested_credential_data.aaguid) &&
           valid_signature?(authenticator_data, client_data_hash) &&
           [WebAuthn::AttestationStatement::ATTESTATION_TYPE_BASIC_OR_ATTCA, [attestation_certificate]]
       end
@@ -31,7 +33,7 @@ module WebAuthn
 
       def valid_certificate_public_key?
         certificate_public_key.is_a?(OpenSSL::PKey::EC) &&
-          certificate_public_key.group.curve_name == VALID_ATTESTATION_CERTIFICATE_KEY_CURVE &&
+          certificate_public_key.group.curve_name == VALID_ATTESTATION_CERTIFICATE_ALGORITHM.key_curve &&
           certificate_public_key.check_key
       end
 
@@ -51,9 +53,13 @@ module WebAuthn
         statement["x5c"]
       end
 
+      def valid_aaguid?(attested_credential_data_aaguid)
+        attested_credential_data_aaguid == VALID_ATTESTED_AAGUID
+      end
+
       def valid_signature?(authenticator_data, client_data_hash)
         certificate_public_key.verify(
-          "SHA256",
+          VALID_ATTESTATION_CERTIFICATE_ALGORITHM.hash,
           signature,
           verification_data(authenticator_data, client_data_hash)
         )

data/lib/webauthn/attestation_statement/fido_u2f/public_key.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "cose/ecdsa"
+require "cose/algorithm"
 require "cose/key/ec2"
 require "webauthn/attestation_statement/base"
 
@@ -25,7 +25,7 @@ module WebAuthn
           data.size >= COORDINATE_LENGTH * 2 &&
             cose_key.x.length == COORDINATE_LENGTH &&
             cose_key.y.length == COORDINATE_LENGTH &&
-            cose_key.alg == COSE::ECDSA::ALG_ES256
+            cose_key.alg == COSE::Algorithm.by_name("ES256").id
         end
 
         def to_uncompressed_point

data/lib/webauthn/attestation_statement/none.rb

@@ -6,7 +6,11 @@ module WebAuthn
   module AttestationStatement
     class None < Base
       def valid?(*_args)
-        [WebAuthn::AttestationStatement::ATTESTATION_TYPE_NONE, nil]
+        if statement == {}
+          [WebAuthn::AttestationStatement::ATTESTATION_TYPE_NONE, nil]
+        else
+          false
+        end
       end
     end
   end

data/lib/webauthn/attestation_statement/packed.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "cose/algorithm"
 require "openssl"
 require "webauthn/attestation_statement/base"
 
@@ -13,7 +14,9 @@ module WebAuthn
         check_unsupported_feature
 
         valid_format? &&
-          valid_certificate_chain?(authenticator_data.credential) &&
+          valid_algorithm?(authenticator_data.credential) &&
+          valid_certificate_chain? &&
+          valid_public_keys?(authenticator_data.credential) &&
           meet_certificate_requirement? &&
           matching_aaguid?(authenticator_data.attested_credential_data.aaguid) &&
           valid_signature?(authenticator_data, client_data_hash) &&
@@ -22,6 +25,14 @@ module WebAuthn
 
       private
 
+      def valid_algorithm?(credential)
+        !self_attestation? || algorithm == COSE::Key.deserialize(credential.public_key).alg
+      end
+
+      def self_attestation?
+        !raw_attestation_certificates && !raw_ecdaa_key_id
+      end
+
       def algorithm
         statement["alg"]
       end
@@ -60,7 +71,16 @@ module WebAuthn
         attestation_certificate_chain&.first
       end
 
-      def valid_certificate_chain?(credential)
+      def valid_certificate_chain?
+        if attestation_certificate_chain
+          attestation_certificate_chain[1..-1].all? { |c| certificate_in_use?(c) }
+        else
+          true
+        end
+      end
+
+      # TODO: Reevaluate this check
+      def valid_public_keys?(credential)
         public_keys = attestation_certificate_chain&.map(&:public_key) || [credential.public_key_object]
         public_keys.all? do |public_key|
           public_key.is_a?(OpenSSL::PKey::EC) && public_key.check_key
@@ -73,6 +93,7 @@ module WebAuthn
           subject = attestation_certificate.subject.to_a
 
           attestation_certificate.version == 2 &&
+            certificate_in_use?(attestation_certificate) &&
             subject.assoc('OU')&.at(1) == "Authenticator Attestation" &&
             attestation_certificate.extensions.find { |ext| ext.oid == 'basicConstraints' }&.value == 'CA:FALSE'
         else
@@ -92,12 +113,24 @@ module WebAuthn
         end
       end
 
+      def certificate_in_use?(certificate)
+        now = Time.now
+
+        certificate.not_before < now && now < certificate.not_after
+      end
+
       def valid_signature?(authenticator_data, client_data_hash)
-        (attestation_certificate&.public_key || authenticator_data.credential.public_key_object).verify(
-          "SHA256",
-          signature,
-          verification_data(authenticator_data, client_data_hash)
-        )
+        cose_algorithm = COSE::Algorithm.find(algorithm)
+
+        if cose_algorithm
+          (attestation_certificate&.public_key || authenticator_data.credential.public_key_object).verify(
+            cose_algorithm.hash,
+            signature,
+            verification_data(authenticator_data, client_data_hash)
+          )
+        else
+          raise "Unsupported algorithm #{algorithm}"
+        end
       end
 
       def verification_data(authenticator_data, client_data_hash)

data/lib/webauthn/authenticator_assertion_response.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "cose/algorithm"
 require "cose/key"
 require "webauthn/attestation_statement/fido_u2f/public_key"
 require "webauthn/authenticator_response"
@@ -21,7 +22,7 @@ module WebAuthn
       super(original_challenge, original_origin, rp_id: rp_id)
 
       verify_item(:credential, allowed_credentials)
-      verify_item(:signature, credential_public_key(allowed_credentials))
+      verify_item(:signature, credential_cose_key(allowed_credentials))
 
       true
     end
@@ -34,12 +35,18 @@ module WebAuthn
 
     attr_reader :credential_id, :authenticator_data_bytes, :signature
 
-    def valid_signature?(credential_public_key)
-      credential_public_key.verify(
-        "SHA256",
-        signature,
-        authenticator_data_bytes + client_data.hash
-      )
+    def valid_signature?(credential_cose_key)
+      cose_algorithm = COSE::Algorithm.find(credential_cose_key.alg)
+
+      if cose_algorithm
+        credential_cose_key.to_pkey.verify(
+          cose_algorithm.hash,
+          signature,
+          authenticator_data_bytes + client_data.hash
+        )
+      else
+        raise "Unsupported algorithm #{credential_cose_key.alg}"
+      end
     end
 
     def valid_credential?(allowed_credentials)
@@ -48,7 +55,7 @@ module WebAuthn
       allowed_credential_ids.include?(credential_id)
     end
 
-    def credential_public_key(allowed_credentials)
+    def credential_cose_key(allowed_credentials)
       matched_credential = allowed_credentials.find do |credential|
         credential[:id] == credential_id
       end
@@ -64,15 +71,14 @@ module WebAuthn
         # Given that the credential public key is expected to be stored long-term by the gem
         # user and later be passed as one of the allowed_credentials arguments in the
         # AuthenticatorAssertionResponse.verify call, we then need to support the two formats.
-        group = OpenSSL::PKey::EC::Group.new("prime256v1")
-        key = OpenSSL::PKey::EC.new(group)
-        public_key_bn = OpenSSL::BN.new(matched_credential[:public_key], 2)
-        public_key = OpenSSL::PKey::EC::Point.new(group, public_key_bn)
-        key.public_key = public_key
-
-        key
+        COSE::Key::EC2.new(
+          alg: COSE::Algorithm.by_name("ES256").id,
+          crv: 1,
+          x: matched_credential[:public_key][1..32],
+          y: matched_credential[:public_key][33..-1]
+        )
       else
-        COSE::Key.deserialize(matched_credential[:public_key]).to_pkey
+        COSE::Key.deserialize(matched_credential[:public_key])
       end
     end
 

data/lib/webauthn/authenticator_response.rb

@@ -9,6 +9,7 @@ module WebAuthn
   class ChallengeVerificationError < VerificationError; end
   class OriginVerificationError < VerificationError; end
   class RpIdVerificationError < VerificationError; end
+  class TokenBindingVerificationError < VerificationError; end
   class TypeVerificationError < VerificationError; end
   class UserPresenceVerificationError < VerificationError; end
 
@@ -19,6 +20,7 @@ module WebAuthn
 
     def verify(original_challenge, original_origin, rp_id: nil)
       verify_item(:type)
+      verify_item(:token_binding)
       verify_item(:challenge, original_challenge)
       verify_item(:origin, original_origin)
       verify_item(:authenticator_data)
@@ -56,6 +58,10 @@ module WebAuthn
       client_data.type == type
     end
 
+    def valid_token_binding?
+      client_data.valid_token_binding_format?
+    end
+
     def valid_challenge?(original_challenge)
       WebAuthn::SecurityUtils.secure_compare(Base64.urlsafe_decode64(client_data.challenge), original_challenge)
     end

data/lib/webauthn/client_data.rb

@@ -7,6 +7,8 @@ module WebAuthn
   class ClientDataMissingError < Error; end
 
   class ClientData
+    VALID_TOKEN_BINDING_STATUSES = ["present", "supported", "not-supported"].freeze
+
     def initialize(client_data_json)
       @client_data_json = client_data_json
     end
@@ -23,6 +25,18 @@ module WebAuthn
       data["origin"]
     end
 
+    def token_binding
+      data["tokenBinding"]
+    end
+
+    def valid_token_binding_format?
+      if token_binding
+        token_binding.is_a?(Hash) && VALID_TOKEN_BINDING_STATUSES.include?(token_binding["status"])
+      else
+        true
+      end
+    end
+
     def hash
       OpenSSL::Digest::SHA256.digest(client_data_json)
     end

data/lib/webauthn/fake_authenticator.rb

@@ -32,7 +32,7 @@ module WebAuthn
       attestation_object
     end
 
-    def get_assertion(rp_id:, client_data_hash:, user_present: true, user_verified: false)
+    def get_assertion(rp_id:, client_data_hash:, user_present: true, user_verified: false, aaguid: AAGUID)
       credential_options = credentials[rp_id]
 
       if credential_options
@@ -41,7 +41,8 @@ module WebAuthn
         authenticator_data = AuthenticatorData.new(
           rp_id_hash: hashed(rp_id),
           user_present: user_present,
-          user_verified: user_verified
+          user_verified: user_verified,
+          aaguid: aaguid,
         ).serialize
 
         signature = credential_key.sign("SHA256", authenticator_data + client_data_hash)

data/lib/webauthn/fake_authenticator/authenticator_data.rb

@@ -7,12 +7,14 @@ require "securerandom"
 module WebAuthn
   class FakeAuthenticator
     class AuthenticatorData
-      def initialize(rp_id_hash:, credential: nil, sign_count: 0, user_present: true, user_verified: !user_present)
+      def initialize(rp_id_hash:, credential: nil, sign_count: 0, user_present: true, user_verified: !user_present,
+                     aaguid: WebAuthn::FakeAuthenticator::AAGUID)
         @rp_id_hash = rp_id_hash
         @credential = credential
         @sign_count = sign_count
         @user_present = user_present
         @user_verified = user_verified
+        @aaguid = aaguid
       end
 
       def serialize
@@ -45,7 +47,7 @@ module WebAuthn
       def attested_credential_data
         @attested_credential_data ||=
           if credential
-            WebAuthn::FakeAuthenticator::AAGUID +
+            @aaguid +
               [credential[:id].length].pack("n*") +
               credential[:id] +
               cose_credential_public_key

data/lib/webauthn/fake_client.rb

@@ -8,10 +8,11 @@ module WebAuthn
   class FakeClient
     TYPES = { create: "webauthn.create", get: "webauthn.get" }.freeze
 
-    attr_reader :origin
+    attr_reader :origin, :token_binding
 
-    def initialize(origin = fake_origin, authenticator: WebAuthn::FakeAuthenticator.new)
+    def initialize(origin = fake_origin, token_binding: nil, authenticator: WebAuthn::FakeAuthenticator.new)
       @origin = origin
+      @token_binding = token_binding
       @authenticator = authenticator
     end
 
@@ -67,11 +68,17 @@ module WebAuthn
     attr_reader :authenticator
 
     def data_json_for(method, challenge)
-      {
+      data = {
         type: type_for(method),
         challenge: encode(challenge),
         origin: origin
-      }.to_json
+      }
+
+      if token_binding
+        data[:tokenBinding] = token_binding
+      end
+
+      data.to_json
     end
 
     def encode(data)

data/lib/webauthn/version.rb

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

data/webauthn.gemspec

@@ -41,5 +41,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "byebug", "~> 11.0"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.8"
-  spec.add_development_dependency "rubocop", "0.65.0"
+  spec.add_development_dependency "rubocop", "0.67.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webauthn
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Gonzalo Rodriguez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cbor
@@ -169,14 +169,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.65.0
+        version: 0.67.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.65.0
+        version: 0.67.2
 description: Make your Ruby/Rails web server become a conformant WebAuthn Relying
   Party
 email:
@@ -200,7 +200,7 @@ files:
 - bin/setup
 - gemfiles/openssl_2_0.gemfile
 - gemfiles/openssl_2_1.gemfile
-- lib/cose/ecdsa.rb
+- lib/cose/algorithm.rb
 - lib/webauthn.rb
 - lib/webauthn/attestation_statement.rb
 - lib/webauthn/attestation_statement/android_key.rb

data/lib/cose/ecdsa.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module COSE
-  module ECDSA
-    ALG_ES256 = -7
-  end
-end