webauthn 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4cc833d8288e0519614728a71e26e4e7842ec0c597bd7fc839fe9bacbb44c61
-  data.tar.gz: 712c9ad093705954409facf4ee171752ba76865cbca831121a0f88a4c4d9430c
+  metadata.gz: 7a6a15357ab32b764ce0694b5a6cc4950e9298e377c8a93f8b664befb67dffcb
+  data.tar.gz: 3481eba4bbdd21676eda5015c9ebc9d11a92422ab0d57b6fed1da31b2ebc9d14
 SHA512:
-  metadata.gz: 6fd66258429cadca7660ce7c69640b630b13bd21ac4b690d60c37834edcf4b6ce368688186f1b1a23fba8dc4856767314f7a7308e1ae9932f2f51776fabe89cb
-  data.tar.gz: a28362aa5cf1bd451a5b0303750bb55ffd80f2b47c63c9ef04b7f04e300c8b4f997ec0d6a808361503ecb0b780c263d2447c36bde0239657bc3cc5fd6b106719
+  metadata.gz: 78f3d1242e008dac5a7d1b66944f6e64dd2a11baced08a454ca587d5bb7b5a93b2e51052d044f8c34034355ab2536af96438b9178e9b6536e92366cd55fbe495
+  data.tar.gz: 1e4ecf4a58bad0213e0893834f57f5564ce9b2d9d76ad214e35a85d7ede4d693d0d9f55a289fe998ac4ee4479279d7c521afef98fd7ddce1eec1f849d346948d

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [v1.18.0] - 2019-07-27
+
+### Added
+
+- Ability to migrate U2F credentials to WebAuthn ([#211](https://github.com/cedarcode/webauthn-ruby/pull/211)) (@bdewater + @jdongelmans)
+- Ability to skip attestation statement verification ([#219](https://github.com/cedarcode/webauthn-ruby/pull/219)) (@MaximeNdutiye)
+- Ability to configure default credential options timeout ([#243](https://github.com/cedarcode/webauthn-ruby/pull/243)) (@MaximeNdutiye)
+- AttestedCredentialData presence verification ([#237](https://github.com/cedarcode/webauthn-ruby/pull/237))
+- FakeClient learns how to increment sign count ([#225](https://github.com/cedarcode/webauthn-ruby/pull/225))
+
+### Fixed
+
+- Properly verify SafetyNet certificates from input ([#233](https://github.com/cedarcode/webauthn-ruby/pull/233)) (@bdewater)
+- FakeClient default origin URL ([#242](https://github.com/cedarcode/webauthn-ruby/pull/242)) (@kalebtesfay)
+
 ## [v1.17.0] - 2019-06-18
 
 ### Added
@@ -194,6 +209,7 @@ 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.18.0]: https://github.com/cedarcode/webauthn-ruby/compare/v1.17.0...v1.18.0/
 [v1.17.0]: https://github.com/cedarcode/webauthn-ruby/compare/v1.16.0...v1.17.0/
 [v1.16.0]: https://github.com/cedarcode/webauthn-ruby/compare/v1.15.0...v1.16.0/
 [v1.15.0]: https://github.com/cedarcode/webauthn-ruby/compare/v1.14.0...v1.15.0/

data/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+## Contributing to webauthn-ruby
+
+### How?
+
+- Creating a new issue to report a bug
+- Creating a new issue to suggest a new feature
+- Commenting on an existing issue to answer an open question
+- Commenting on an existing issue to ask the reporter for more details to aid reproducing the problem
+- Improving documentation
+- Creating a pull request that fixes an issue (see [beginner friendly issues](https://github.com/cedarcode/webauthn-ruby/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22))
+- Creating a pull request that implements a new feature (worth first creating an issue to discuss the suggested feature)
+
+### Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests and code-style checks. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Some tests require stubbing time with [libfaketime](https://github.com/wolfcw/libfaketime) in order to pass, otherwise they're skipped. You can install this library with your package manager. Follow libfaketime's instructions for your OS to preload the library before running the tests, and use the `DONT_FAKE_MONOTONIC=1 FAKETIME_NO_CACHE=1` options. E.g. when installed via homebrew on macOS:
+```shell
+DYLD_INSERT_LIBRARIES=/usr/local/Cellar/libfaketime/2.9.7_1/lib/faketime/libfaketime.1.dylib DYLD_FORCE_FLAT_NAMESPACE=1 DONT_FAKE_MONOTONIC=1 FAKETIME_NO_CACHE=1 bundle exec rspec
+```
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Styleguide
+
+#### Ruby
+
+We use [rubocop](https://rubygems.org/gems/rubocop) to check ruby code style.
+
+#### Git commit messages
+
+We try to follow [Conventional Commits](https://conventionalcommits.org) specification since `v1.17.0`.
+
+On top of `fix` and `feat` types, we also use optional:
+
+* __build__: Changes that affect the build system or external dependencies
+* __ci__: Changes to the CI configuration files and scripts
+* __docs__: Documentation only changes
+* __perf__: A code change that improves performance
+* __refactor__: A code change that neither fixes a bug nor adds a feature
+* __style__: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+* __test__: Adding missing tests or correcting existing tests
+
+Partially inspired in [Angular's Commit Message Guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines).

data/README.md

@@ -1,4 +1,13 @@
-# WebAuthn ruby server library :key:
+# webauthn-ruby
+
+![banner](webauthn-ruby.png)
+
+[![Gem](https://img.shields.io/gem/v/webauthn.svg?style=flat-square)](https://rubygems.org/gems/webauthn)
+[![Travis](https://img.shields.io/travis/cedarcode/webauthn-ruby/master.svg?style=flat-square)](https://travis-ci.org/cedarcode/webauthn-ruby)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-informational.svg?style=flat-square)](https://conventionalcommits.org)
+[![Join the chat at https://gitter.im/cedarcode/webauthn-ruby](https://badges.gitter.im/cedarcode/webauthn-ruby.svg)](https://gitter.im/cedarcode/webauthn-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+> WebAuthn ruby server library
 
 Makes your Ruby/Rails web server become a functional [WebAuthn Relying Party](https://www.w3.org/TR/webauthn/#webauthn-relying-party).
 
@@ -6,24 +15,40 @@ Takes care of the [server-side operations](https://www.w3.org/TR/webauthn/#rp-op
 [register](https://www.w3.org/TR/webauthn/#registration) or [authenticate](https://www.w3.org/TR/webauthn/#authentication)
 a user [credential](https://www.w3.org/TR/webauthn/#public-key-credential), including the necessary cryptographic checks.
 
-[![Gem](https://img.shields.io/gem/v/webauthn.svg?style=flat-square)](https://rubygems.org/gems/webauthn)
-[![Travis](https://img.shields.io/travis/cedarcode/webauthn-ruby/master.svg?style=flat-square)](https://travis-ci.org/cedarcode/webauthn-ruby)
-[![Join the chat at https://gitter.im/cedarcode/webauthn-ruby](https://badges.gitter.im/cedarcode/webauthn-ruby.svg)](https://gitter.im/cedarcode/webauthn-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+## Table of Contents
+
+- [Security](#security)
+- [Background](#background)
+- [Prerequisites](#prerequisites)
+- [Install](#install)
+- [Usage](#usage)
+- [API](#api)
+- [Attestation Statement Formats](#attestation-statement-formats)
+- [Testing Your Integration](#testing-your-integration)
+- [Contributing](#contributing)
+- [License](#license)
 
-## Why WebAuthn in my web server?
+## Security
+
+If you have discovered a security bug, please send an email to security@cedarcode.com instead of posting to the GitHub issue tracker.
 
-- [Security Benefits for WebAuthn Relying Parties](https://www.w3.org/TR/webauthn/#sctn-rp-benefits)
+## Background
 
-## What is WebAuthn?
+### What is WebAuthn?
 
 WebAuthn (Web Authentication) is a W3C standard for secure public-key authentication on the Web supported by all leading browsers and platforms.
 
+#### Good Intros
+
+- [Guide to Web Authentication](https://webauthn.guide) by Duo
+- [What is WebAuthn?](https://www.yubico.com/webauthn/) by Yubico
+
+#### In Depth
+
 - WebAuthn [W3C Recommendation](https://www.w3.org/TR/webauthn/) (i.e. "The Standard")
-- WebAuthn [intro](https://www.yubico.com/webauthn/) by Yubico
-- WebAuthn [article](https://en.wikipedia.org/wiki/WebAuthn) in Wikipedia
 - [Web Authentication API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API) in MDN
-- WebAuthn [article with talk](https://developers.google.com/web/updates/2018/05/webauthn) in Google Developers
 - How to use [WebAuthn in Android apps](https://developers.google.com/identity/fido/android/native-apps)
+- [Security Benefits for WebAuthn Servers (a.k.a Relying Parties)](https://www.w3.org/TR/webauthn/#sctn-rp-benefits)
 
 ## Prerequisites
 
@@ -41,7 +66,7 @@ For a detailed picture about what is conformant and what not, you can refer to:
 - [FIDO certified products](https://fidoalliance.org/certification/fido-certified-products)
 
 
-## Installation
+## Install
 
 Add this line to your application's Gemfile:
 
@@ -59,7 +84,10 @@ Or install it yourself as:
 
 ## Usage
 
-NOTE: You can find a working example on how to use this gem in a __Rails__ app in [webauthn-rails-demo-app](https://github.com/cedarcode/webauthn-rails-demo-app).
+You can find a working example on how to use this gem in a __Rails__ app in [webauthn-rails-demo-app](https://github.com/cedarcode/webauthn-rails-demo-app).
+
+If you are migrating an existing application from the legacy FIDO U2F JavaScript API to WebAuthn, also refer to
+[`docs/u2f_migration.md`](docs/u2f_migration.md).
 
 ### Configuration
 
@@ -74,6 +102,13 @@ WebAuthn.configure do |config|
   # Relying Party name for display purposes
   config.rp_name = "Example Inc."
 
+  # Optionally configure a client timeout hint, in milliseconds.
+  # This hint specifies how long the browser should wait for an
+  # attestation or an assertion response.
+  # This hint may be overridden by the browser.
+  # https://www.w3.org/TR/webauthn/#dom-publickeycredentialcreationoptions-timeout
+  config.credential_options_timeout = 120000
+
   # 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.
@@ -204,6 +239,10 @@ end
 # Update the stored sign count with the value from `assertion_response.authenticator_data.sign_count`
 ```
 
+## API
+
+_Pending_
+
 ## Attestation Statement Formats
 
 | Attestation Statement Format | Supported? |
@@ -224,43 +263,12 @@ NOTE: Be aware that it is up to you to do "trust path validation" (steps 15 and
 
 The Webauthn spec requires for data that is signed and authenticated. As a result, it can be difficult to create valid test authenticator data when testing your integration. webauthn-ruby exposes [WebAuthn::FakeClient](https://github.com/cedarcode/webauthn-ruby/blob/master/lib/webauthn/fake_client.rb) for you to use in your tests. Example usage can be found in [webauthn-ruby/spec/webauthn/authenticator_assertion_response_spec.rb](https://github.com/cedarcode/webauthn-ruby/blob/master/spec/webauthn/authenticator_assertion_response_spec.rb).
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests and code-style checks. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-Some tests require stubbing time with [libfaketime](https://github.com/wolfcw/libfaketime) in order to pass, otherwise they're skipped. You can install this library with your package manager. Follow libfaketime's instructions for your OS to preload the library before running the tests, and use the `DONT_FAKE_MONOTONIC=1 FAKETIME_NO_CACHE=1` options. E.g. when installed via homebrew on macOS:
-```shell
-DYLD_INSERT_LIBRARIES=/usr/local/Cellar/libfaketime/2.9.7_1/lib/faketime/libfaketime.1.dylib DYLD_FORCE_FLAT_NAMESPACE=1 DONT_FAKE_MONOTONIC=1 FAKETIME_NO_CACHE=1 bundle exec rspec
-```
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-### Commit message format
-
-Each commit message follows the `<type>: <message>` format.
-
-The "message" starts with lowercase and the "type" is one of:
-
-* __build__: Changes that affect the build system or external dependencies
-* __ci__: Changes to the CI configuration files and scripts
-* __docs__: Documentation only changes
-* __feat__: A new feature
-* __fix__: A bug fix
-* __perf__: A code change that improves performance
-* __refactor__: A code change that neither fixes a bug nor adds a feature
-* __style__: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
-* __test__: Adding missing tests or correcting existing tests
-
-Inspired in a subset of [Angular's Commit Message Guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines).
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/cedarcode/webauthn-ruby.
-
-### Security
+See [the contributing file](CONTRIBUTING.md)!
 
-If you have discovered a security bug, please send an email to security@cedarcode.com instead of posting to the GitHub issue tracker.
+Bug reports, feature suggestions, and pull requests are welcome on GitHub at https://github.com/cedarcode/webauthn-ruby.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The library is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/docs/u2f_migration.md

@@ -0,0 +1,96 @@
+# Migrating from U2F to WebAuthn
+
+The Chromium team [recommends](https://groups.google.com/a/chromium.org/forum/#!msg/security-dev/BGWA1d7a6rI/W2avestmBAAJ)
+application developers to switch from the U2F API to the WebAuthn API. This document describes how a Ruby application
+using the [u2f gem by Castle](https://github.com/castle/ruby-u2f) can migrate existing credentials so that their users
+do not experience interruption or need to re-register their security keys.
+
+Note that the migration is one-way: credentials registered using WebAuthn cannot be made compatible with the U2F API.
+It is recommended to successfully migrate authorization flows before migrating registration flows.
+
+## Migrate registered U2F credentials
+
+Assuming you have a registered credential per the u2f gem readme, base64 urlsafe encoded in a database:
+
+```ruby
+# This domain will be used in all code examples. It's a single-facet app but a multi-facet AppID
+# (e.g. https://example.com/app-id.json) will work as well.
+domain = URI("https://login.example.com")
+
+u2f_registration = U2F::U2F.new(domain.to_s).register!(u2f_challenge, u2f_register_response)
+# => #<U2F::Registration:0x00007fd62f43d688
+#  @certificate=
+#   "MIIBCzCBsgIBATAKBggqhkjOPQQDAjASMRAwDgYDVQQDDAdVMkZUZXN0MB4XDTE5MDUzMDE3MjIwM1oXDTIwMDUyOTE3MjIwM1owEjEQMA4GA1UEAwwHVTJGVGVzdDBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABBMKpejumzlH6NxWIx2Ol+EManS9oX5nguG4RT43rZNkyn/zGjdJEhXksN5zT34rLZgFheBgkDGJCdtTPlhVK10wCgYIKoZIzj0EAwIDSAAwRQIhALYxFcROCeifWpv5+wNZIiaO/bGQg8rFBHCw3aHgehdZAiBJ3xFmQh7+Gjxt6CeAcY/k/VVAYu2vP4sUqXnCQFgJUA==",
+#  @key_handle="mbVMRTgzST5xLumckGztJ9VFW6veObfNIYWSn3sTqIY",
+#  @public_key="BOJQXlFg+ZfZKm48FNq2Ye5vSwOscE1i7YsGRSIjIe3GI0OXrSBDADDn0dQlz2iDzZ7LvCwiHz72U1qhVas3vus=">
+```
+
+The `U2fMigrator` class quacks like `WebAuthn::AuthenticatorAttestationResponse` and can be used similarly as documented
+in the [registration verification phase](https://github.com/cedarcode/webauthn-ruby/blob/master/README.md#verification-phase).
+Of course a `verify` instance method is not implemented, as there is no real interaction with an authenticator.
+
+The migrator can be used to convert credentials in real time during authentication while keeping them stored in the U2F
+format, and in a backfill task to store credentials in the new format, depending on how you are approaching your
+migration.
+
+```ruby
+require "webauthn/u2f_migrator"
+
+migrated_credential = WebAuthn::U2fMigrator.new(
+  app_id: domain,
+  certificate: u2f_registration.certificate,
+  key_handle: u2f_registration.key_handle,
+  public_key: u2f_registration.public_key,
+  counter: u2f_registration.counter
+)
+migrated_credential.credential.id
+# => "\x99\xB5LE83I>q.\xE9\x9C\x90l\xED'\xD5E[\xAB\xDE9\xB7\xCD!\x85\x92\x9F{\x13\xA8\x86"
+migrated_credential.credential.public_key
+# => "\xA5\x03& \x01!X \xE2P^Q`\xF9\x97\xD9*n<\x14\xDA\xB6a\xEEoK\x03\xACpMb\xED\x8B\x06E\"#!\xED\xC6\x01\x02\"X #C\x97\xAD C\x000\xE7\xD1\xD4%\xCFh\x83\xCD\x9E\xCB\xBC,\"\x1F>\xF6SZ\xA1U\xAB7\xBE\xEB"
+migrated_credential.authenticator_data.sign_count
+# => 41
+```
+
+## Authenticate migrated U2F credentials
+
+Following the documentation on the [authentication initiation](https://github.com/cedarcode/webauthn-ruby/blob/master/README.md#authentication),
+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:
+
+> The FIDO APIs use an alternative identifier for Relying Parties called an _AppID_, and any credentials created using
+> those APIs will be scoped to that identifier. Without this extension, they would need to be re-registered in order to
+> be scoped to an RP ID.
+
+For the earlier given example `domain` this means:
+- FIDO AppID: `https://login.example.com`
+- Valid RP IDs: `login.example.com` (default) and `example.com`
+
+```ruby
+credential_request_options = WebAuthn.credential_request_options
+credential_request_options[:extensions] = { appid: domain.to_s }
+```
+
+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`.
+
+During authentication verification phase, you must pass either the original AppID or the RP ID as the `rp_id` argument:
+
+> 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/webauthn.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "webauthn/authenticator_attestation_response"
-require "webauthn/authenticator_assertion_response"
 require "webauthn/configuration"
 require "webauthn/credential_creation_options"
 require "webauthn/credential_request_options"

data/lib/webauthn/attestation_statement/android_safetynet.rb

@@ -6,7 +6,7 @@ require "webauthn/attestation_statement/base"
 
 module WebAuthn
   module AttestationStatement
-    # Implements https://www.w3.org/TR/2018/CR-webauthn-20180807/#android-safetynet-attestation
+    # Implements https://www.w3.org/TR/webauthn-1/#sctn-android-safetynet-attestation
     class AndroidSafetynet < Base
       def self.default_trust_store
         OpenSSL::X509::Store.new.tap { |trust_store| trust_store.set_default_paths }
@@ -22,11 +22,9 @@ module WebAuthn
 
       private
 
+      # FIXME: This should be a responsibility of AndroidSafetynet::AttestationResponse#verify
       def trusted_attestation_certificate?(trust_store)
-        signing_certificates.each do |certificate|
-          trust_store.add_cert(certificate)
-        end
-        trust_store.verify(attestation_certificate)
+        trust_store.verify(attestation_certificate, signing_certificates)
       end
 
       def valid_response?(authenticator_data, client_data_hash)

data/lib/webauthn/attestation_statement/fido_u2f.rb

@@ -16,7 +16,7 @@ module WebAuthn
         valid_format? &&
           valid_certificate_public_key? &&
           valid_credential_public_key?(authenticator_data.credential.public_key) &&
-          valid_aaguid?(authenticator_data.attested_credential_data.aaguid) &&
+          valid_aaguid?(authenticator_data.attested_credential_data.raw_aaguid) &&
           valid_signature?(authenticator_data, client_data_hash) &&
           [WebAuthn::AttestationStatement::ATTESTATION_TYPE_BASIC_OR_ATTCA, [attestation_certificate]]
       end

data/lib/webauthn/attestation_statement/packed.rb

@@ -18,7 +18,7 @@ module WebAuthn
           valid_certificate_chain? &&
           valid_ec_public_keys?(authenticator_data.credential) &&
           meet_certificate_requirement? &&
-          matching_aaguid?(authenticator_data.attested_credential_data.aaguid) &&
+          matching_aaguid?(authenticator_data.attested_credential_data.raw_aaguid) &&
           valid_signature?(authenticator_data, client_data_hash) &&
           attestation_type_and_trust_path
       end

data/lib/webauthn/attestation_statement/tpm.rb

@@ -25,7 +25,7 @@ module WebAuthn
             valid_attestation_certificate? &&
             pub_area.valid?(authenticator_data.credential.public_key) &&
             cert_info.valid?(statement["pubArea"], OpenSSL::Digest.digest(cose_algorithm.hash, att_to_be_signed)) &&
-            matching_aaguid?(authenticator_data.attested_credential_data.aaguid) &&
+            matching_aaguid?(authenticator_data.attested_credential_data.raw_aaguid) &&
             [attestation_type, attestation_trust_path]
         when ATTESTATION_TYPE_ECDAA
           raise(

data/lib/webauthn/authenticator_assertion_response.rb

@@ -13,12 +13,16 @@ module WebAuthn
   class SignCountVerificationError < VerificationError; end
 
   class AuthenticatorAssertionResponse < AuthenticatorResponse
-    def initialize(credential_id:, authenticator_data:, signature:, **options)
+    attr_reader :user_handle
+
+    # FIXME: credential_id doesn't belong inside AuthenticatorAssertionResponse
+    def initialize(credential_id:, authenticator_data:, signature:, user_handle: nil, **options)
       super(options)
 
       @credential_id = credential_id
       @authenticator_data_bytes = authenticator_data
       @signature = signature
+      @user_handle = user_handle
     end
 
     def verify(expected_challenge, expected_origin = nil, allowed_credentials:, user_verification: nil, rp_id: nil)

data/lib/webauthn/authenticator_attestation_response.rb

@@ -11,6 +11,7 @@ require "webauthn/client_data"
 
 module WebAuthn
   class AttestationStatementVerificationError < VerificationError; end
+  class AttestedCredentialVerificationError < VerificationError; end
 
   class AuthenticatorAttestationResponse < AuthenticatorResponse
     attr_reader :attestation_type, :attestation_trust_path
@@ -24,7 +25,8 @@ module WebAuthn
     def verify(expected_challenge, expected_origin = nil, user_verification: nil, rp_id: nil)
       super
 
-      verify_item(:attestation_statement)
+      verify_item(:attested_credential)
+      verify_item(:attestation_statement) if WebAuthn.configuration.verify_attestation_statement
 
       true
     end
@@ -58,6 +60,11 @@ module WebAuthn
       WebAuthn::TYPES[:create]
     end
 
+    def valid_attested_credential?
+      authenticator_data.attested_credential_data_included? &&
+        authenticator_data.attested_credential_data.valid?
+    end
+
     def valid_attestation_statement?
       @attestation_type, @attestation_trust_path = attestation_statement.valid?(authenticator_data, client_data.hash)
     end

data/lib/webauthn/authenticator_data/attested_credential_data.rb

@@ -26,10 +26,14 @@ module WebAuthn
         data.length >= AAGUID_LENGTH + ID_LENGTH_LENGTH && valid_credential_public_key?
       end
 
-      def aaguid
+      def raw_aaguid
         data_at(0, AAGUID_LENGTH)
       end
 
+      def aaguid
+        raw_aaguid.unpack("H8H4H4H4H12").join("-")
+      end
+
       def credential
         @credential ||=
           if id

data/lib/webauthn/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "openssl"
+
 module WebAuthn
   def self.configuration
     @configuration ||= Configuration.new
@@ -20,9 +22,13 @@ module WebAuthn
     attr_accessor :origin
     attr_accessor :rp_id
     attr_accessor :rp_name
+    attr_accessor :verify_attestation_statement
+    attr_accessor :credential_options_timeout
 
     def initialize
       @algorithms = DEFAULT_ALGORITHMS.dup
+      @verify_attestation_statement = true
+      @credential_options_timeout = 120000
     end
   end
 end

data/lib/webauthn/credential_creation_options.rb

@@ -42,6 +42,7 @@ module WebAuthn
       options = {
         challenge: challenge,
         pubKeyCredParams: pub_key_cred_params,
+        timeout: timeout,
         user: { id: user.id, name: user.name, displayName: user.display_name },
         rp: { name: rp.name }
       }

data/lib/webauthn/credential_options.rb

@@ -9,5 +9,9 @@ module WebAuthn
     def challenge
       @challenge ||= SecureRandom.random_bytes(CHALLENGE_LENGTH)
     end
+
+    def timeout
+      @timeout = WebAuthn.configuration.credential_options_timeout
+    end
   end
 end

data/lib/webauthn/credential_request_options.rb

@@ -17,7 +17,11 @@ module WebAuthn
     end
 
     def to_h
-      options = { challenge: challenge, allowCredentials: allow_credentials }
+      options = {
+        challenge: challenge,
+        timeout: timeout,
+        allowCredentials: allow_credentials
+      }
 
       if extensions
         options[:extensions] = extensions

data/lib/webauthn/encoder.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "base64"
+
+module WebAuthn
+  class Encoder
+    attr_reader :encoding
+
+    def initialize(encoding = :base64)
+      @encoding = encoding
+    end
+
+    def encode(data)
+      case encoding
+      when :base64
+        Base64.strict_encode64(data)
+      when :base64url
+        Base64.urlsafe_encode64(data, padding: false)
+      when nil, false
+        data
+      else
+        raise "Unsupported or unknown encoding: #{encoding}"
+      end
+    end
+
+    def decode(data)
+      case encoding
+      when :base64
+        Base64.strict_decode64(data)
+      when :base64url
+        Base64.urlsafe_decode64(data)
+      when nil, false
+        data
+      else
+        raise "Unsupported or unknown encoding: #{encoding}"
+      end
+    end
+  end
+end

data/lib/webauthn/fake_authenticator.rb

@@ -12,22 +12,33 @@ module WebAuthn
       @credentials = {}
     end
 
-    def make_credential(rp_id:, client_data_hash:, user_present: true, user_verified: false)
-      credential_id, credential_key = new_credential
+    def make_credential(
+      rp_id:,
+      client_data_hash:,
+      user_present: true,
+      user_verified: false,
+      attested_credential_data: true,
+      sign_count: nil
+    )
+      credential_id, credential_key, credential_sign_count = new_credential
+      sign_count ||= credential_sign_count
 
-      attestation_object = AttestationObject.new(
+      credentials[rp_id] ||= {}
+      credentials[rp_id][credential_id] = {
+        credential_key: credential_key,
+        sign_count: sign_count + 1
+      }
+
+      AttestationObject.new(
         client_data_hash: client_data_hash,
         rp_id_hash: hashed(rp_id),
         credential_id: credential_id,
         credential_key: credential_key,
         user_present: user_present,
-        user_verified: user_verified
+        user_verified: user_verified,
+        attested_credential_data: attested_credential_data,
+        sign_count: sign_count
       ).serialize
-
-      credentials[rp_id] ||= {}
-      credentials[rp_id][credential_id] = credential_key
-
-      attestation_object
     end
 
     def get_assertion(
@@ -36,22 +47,25 @@ module WebAuthn
       user_present: true,
       user_verified: false,
       aaguid: AuthenticatorData::AAGUID,
-      sign_count: 0
+      sign_count: nil
     )
       credential_options = credentials[rp_id]
 
       if credential_options
-        credential_id, credential_key = credential_options.first
+        credential_id, credential = credential_options.first
+        credential_key = credential[:credential_key]
+        credential_sign_count = credential[:sign_count]
 
         authenticator_data = AuthenticatorData.new(
           rp_id_hash: hashed(rp_id),
           user_present: user_present,
           user_verified: user_verified,
           aaguid: aaguid,
-          sign_count: sign_count,
+          sign_count: sign_count || credential_sign_count,
         ).serialize
 
         signature = credential_key.sign("SHA256", authenticator_data + client_data_hash)
+        credential[:sign_count] += 1
 
         {
           credential_id: credential_id,
@@ -68,7 +82,7 @@ module WebAuthn
     attr_reader :credentials
 
     def new_credential
-      [SecureRandom.random_bytes(16), OpenSSL::PKey::EC.new("prime256v1").generate_key]
+      [SecureRandom.random_bytes(16), OpenSSL::PKey::EC.new("prime256v1").generate_key, 0]
     end
 
     def hashed(target)

data/lib/webauthn/fake_authenticator/attestation_object.rb

@@ -12,7 +12,9 @@ module WebAuthn
         credential_id:,
         credential_key:,
         user_present: true,
-        user_verified: false
+        user_verified: false,
+        attested_credential_data: true,
+        sign_count: 0
       )
         @client_data_hash = client_data_hash
         @rp_id_hash = rp_id_hash
@@ -20,6 +22,8 @@ module WebAuthn
         @credential_key = credential_key
         @user_present = user_present
         @user_verified = user_verified
+        @attested_credential_data = attested_credential_data
+        @sign_count = sign_count
       end
 
       def serialize
@@ -32,15 +36,33 @@ module WebAuthn
 
       private
 
-      attr_reader :client_data_hash, :rp_id_hash, :credential_id, :credential_key, :user_present, :user_verified
+      attr_reader(
+        :client_data_hash,
+        :rp_id_hash,
+        :credential_id,
+        :credential_key,
+        :user_present,
+        :user_verified,
+        :attested_credential_data,
+        :sign_count
+      )
 
       def authenticator_data
-        @authenticator_data ||= AuthenticatorData.new(
-          rp_id_hash: rp_id_hash,
-          credential: { id: credential_id, public_key: credential_key.public_key },
-          user_present: user_present,
-          user_verified: user_verified
-        )
+        @authenticator_data ||=
+          begin
+            credential_data =
+              if attested_credential_data
+                { id: credential_id, public_key: credential_key.public_key }
+              end
+
+            AuthenticatorData.new(
+              rp_id_hash: rp_id_hash,
+              credential: credential_data,
+              user_present: user_present,
+              user_verified: user_verified,
+              sign_count: 0
+            )
+          end
       end
     end
   end

data/lib/webauthn/fake_authenticator/authenticator_data.rb

@@ -9,6 +9,8 @@ module WebAuthn
     class AuthenticatorData
       AAGUID = SecureRandom.random_bytes(16)
 
+      attr_reader :sign_count
+
       def initialize(
         rp_id_hash:,
         credential: {
@@ -36,7 +38,7 @@ module WebAuthn
 
       private
 
-      attr_reader :rp_id_hash, :credential, :sign_count, :user_present, :user_verified, :extensions
+      attr_reader :rp_id_hash, :credential, :user_present, :user_verified, :extensions
 
       def flags
         [

data/lib/webauthn/fake_client.rb

@@ -3,6 +3,7 @@
 require "base64"
 require "openssl"
 require "webauthn/authenticator_data"
+require "webauthn/encoder"
 require "webauthn/fake_authenticator"
 
 module WebAuthn
@@ -11,13 +12,24 @@ module WebAuthn
 
     attr_reader :origin, :token_binding
 
-    def initialize(origin = fake_origin, token_binding: nil, authenticator: WebAuthn::FakeAuthenticator.new)
+    def initialize(
+      origin = fake_origin,
+      token_binding: nil,
+      authenticator: WebAuthn::FakeAuthenticator.new,
+      encoding: nil
+    )
       @origin = origin
       @token_binding = token_binding
       @authenticator = authenticator
+      @encoding = encoding
     end
 
-    def create(challenge: fake_challenge, rp_id: nil, user_present: true, user_verified: false)
+    def create(
+      challenge: fake_challenge,
+      rp_id: nil, user_present: true,
+      user_verified: false,
+      attested_credential_data: true
+    )
       rp_id ||= URI.parse(origin).host
 
       client_data_json = data_json_for(:create, challenge)
@@ -27,21 +39,30 @@ module WebAuthn
         rp_id: rp_id,
         client_data_hash: client_data_hash,
         user_present: user_present,
-        user_verified: user_verified
+        user_verified: user_verified,
+        attested_credential_data: attested_credential_data
       )
 
-      id = WebAuthn::AuthenticatorData.new(CBOR.decode(attestation_object)["authData"]).credential.id
+      id =
+        if attested_credential_data
+          WebAuthn::AuthenticatorData.new(CBOR.decode(attestation_object)["authData"]).credential.id
+        else
+          "id-for-pk-without-attested-credential-data"
+        end
 
+      # TODO: return camelCase string keys instead of snakecase symbols
       {
-        id: id,
+        type: "public-key",
+        id: Base64.urlsafe_encode64(id),
+        raw_id: encoder.encode(id),
         response: {
-          attestation_object: attestation_object,
-          client_data_json: client_data_json
+          attestation_object: encoder.encode(attestation_object),
+          client_data_json: encoder.encode(client_data_json)
         }
       }
     end
 
-    def get(challenge: fake_challenge, rp_id: nil, user_present: true, user_verified: false, sign_count: 0)
+    def get(challenge: fake_challenge, rp_id: nil, user_present: true, user_verified: false, sign_count: nil)
       rp_id ||= URI.parse(origin).host
 
       client_data_json = data_json_for(:get, challenge)
@@ -55,24 +76,27 @@ module WebAuthn
         sign_count: sign_count,
       )
 
+      # TODO: return camelCase string keys instead of snakecase symbols
       {
-        id: assertion[:credential_id],
+        type: "public-key",
+        id: Base64.urlsafe_encode64(assertion[:credential_id]),
+        raw_id: encoder.encode(assertion[:credential_id]),
         response: {
-          client_data_json: client_data_json,
-          authenticator_data: assertion[:authenticator_data],
-          signature: assertion[:signature]
+          client_data_json: encoder.encode(client_data_json),
+          authenticator_data: encoder.encode(assertion[:authenticator_data]),
+          signature: encoder.encode(assertion[:signature])
         }
       }
     end
 
     private
 
-    attr_reader :authenticator
+    attr_reader :authenticator, :encoding
 
     def data_json_for(method, challenge)
       data = {
         type: type_for(method),
-        challenge: encode(challenge),
+        challenge: Base64.urlsafe_encode64(challenge, padding: false),
         origin: origin
       }
 
@@ -83,8 +107,8 @@ module WebAuthn
       data.to_json
     end
 
-    def encode(data)
-      Base64.urlsafe_encode64(data, padding: false)
+    def encoder
+      @encoder ||= WebAuthn::Encoder.new(encoding)
     end
 
     def hashed(data)
@@ -96,7 +120,7 @@ module WebAuthn
     end
 
     def fake_origin
-      "http://localhost#{rand(1000)}"
+      "http://localhost#{rand(1000)}.test"
     end
 
     def type_for(method)

data/lib/webauthn/public_key_credential.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "base64"
+require "webauthn/authenticator_assertion_response"
+require "webauthn/authenticator_attestation_response"
+require "webauthn/encoder"
 
 module WebAuthn
   class PublicKeyCredential
@@ -8,6 +11,43 @@ module WebAuthn
 
     attr_reader :type, :id, :raw_id, :response
 
+    def self.from_create(credential, encoding: :base64)
+      encoder = WebAuthn::Encoder.new(encoding)
+
+      new(
+        type: credential["type"],
+        id: credential["id"],
+        raw_id: encoder.decode(credential["rawId"]),
+        response: WebAuthn::AuthenticatorAttestationResponse.new(
+          attestation_object: encoder.decode(credential["response"]["attestationObject"]),
+          client_data_json: encoder.decode(credential["response"]["clientDataJSON"])
+        )
+      )
+    end
+
+    def self.from_get(credential, encoding: :base64)
+      encoder = WebAuthn::Encoder.new(encoding)
+
+      user_handle =
+        if credential["response"]["userHandle"]
+          encoder.decode(credential["response"]["userHandle"])
+        end
+
+      new(
+        type: credential["type"],
+        id: credential["id"],
+        raw_id: encoder.decode(credential["rawId"]),
+        response: WebAuthn::AuthenticatorAssertionResponse.new(
+          # FIXME: credential_id doesn't belong inside AuthenticatorAssertionResponse
+          credential_id: Base64.urlsafe_decode64(credential["id"]),
+          authenticator_data: encoder.decode(credential["response"]["authenticatorData"]),
+          client_data_json: encoder.decode(credential["response"]["clientDataJSON"]),
+          signature: encoder.decode(credential["response"]["signature"]),
+          user_handle: user_handle
+        )
+      )
+    end
+
     def initialize(type:, id:, raw_id:, response:)
       @type = type
       @id = id
@@ -23,6 +63,20 @@ module WebAuthn
       true
     end
 
+    def public_key
+      response&.authenticator_data&.credential&.public_key
+    end
+
+    def user_handle
+      if response.is_a?(WebAuthn::AuthenticatorAssertionResponse)
+        response.user_handle
+      end
+    end
+
+    def sign_count
+      response&.authenticator_data&.sign_count
+    end
+
     private
 
     def valid_type?

data/lib/webauthn/u2f_migrator.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'webauthn/fake_client'
+require 'webauthn/attestation_statement/fido_u2f'
+
+module WebAuthn
+  class U2fMigrator
+    def initialize(app_id:, certificate:, key_handle:, public_key:, counter:)
+      @app_id = app_id
+      @certificate = certificate
+      @key_handle = key_handle
+      @public_key = public_key
+      @counter = counter
+    end
+
+    def authenticator_data
+      @authenticator_data ||= WebAuthn::FakeAuthenticator::AuthenticatorData.new(
+        rp_id_hash: OpenSSL::Digest::SHA256.digest(@app_id.to_s),
+        credential: {
+          id: credential_id,
+          public_key: credential_cose_key
+        },
+        sign_count: @counter,
+        user_present: true,
+        user_verified: false,
+        aaguid: WebAuthn::AttestationStatement::FidoU2f::VALID_ATTESTED_AAGUID,
+      )
+    end
+
+    def credential
+      @credential ||= begin
+        hash = authenticator_data.send(:credential)
+        WebAuthn::AuthenticatorData::AttestedCredentialData::Credential.new(hash[:id], hash[:public_key].serialize)
+      end
+    end
+
+    def attestation_type
+      WebAuthn::AttestationStatement::ATTESTATION_TYPE_BASIC_OR_ATTCA
+    end
+
+    def attestation_trust_path
+      @attestation_trust_path ||= [OpenSSL::X509::Certificate.new(Base64.strict_decode64(@certificate))]
+    end
+
+    private
+
+    # https://fidoalliance.org/specs/fido-v2.0-rd-20180702/fido-client-to-authenticator-protocol-v2.0-rd-20180702.html#u2f-authenticatorMakeCredential-interoperability
+    # Let credentialId be a credentialIdLength byte array initialized with CTAP1/U2F response key handle bytes.
+    def credential_id
+      Base64.urlsafe_decode64(@key_handle)
+    end
+
+    # Let x9encodedUserPublicKey be the user public key returned in the U2F registration response message [U2FRawMsgs].
+    # Let coseEncodedCredentialPublicKey be the result of converting x9encodedUserPublicKey’s value from ANS X9.62 /
+    # Sec-1 v2 uncompressed curve point representation [SEC1V2] to COSE_Key representation ([RFC8152] Section 7).
+    def credential_cose_key
+      decoded_public_key = Base64.strict_decode64(@public_key)
+      if WebAuthn::AttestationStatement::FidoU2f::PublicKey.uncompressed_point?(decoded_public_key)
+        COSE::Key::EC2.new(
+          alg: COSE::Algorithm.by_name("ES256").id,
+          crv: 1,
+          x: decoded_public_key[1..32],
+          y: decoded_public_key[33..-1]
+        )
+      else
+        raise "expected U2F public key to be in uncompressed point format"
+      end
+    end
+  end
+end

data/lib/webauthn/version.rb

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

data/webauthn.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "WebAuthn ruby server library"
   spec.description   = 'WebAuthn ruby server library ― Make your application a W3C Web Authentication conformant
-    Relying Party and allow your users to authenticate with U2F and FIDO 2.0 authenticators.'
+    Relying Party and allow your users to authenticate with U2F and FIDO2 authenticators.'
   spec.homepage      = "https://github.com/cedarcode/webauthn-ruby"
   spec.license       = "MIT"
 
@@ -43,5 +43,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.71.0"
+  spec.add_development_dependency "rubocop", "0.73.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webauthn
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Gonzalo Rodriguez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-18 00:00:00.000000000 Z
+date: 2019-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -183,17 +183,17 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 0.73.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.71.0
+        version: 0.73.0
 description: |-
   WebAuthn ruby server library ― Make your application a W3C Web Authentication conformant
-      Relying Party and allow your users to authenticate with U2F and FIDO 2.0 authenticators.
+      Relying Party and allow your users to authenticate with U2F and FIDO2 authenticators.
 email:
 - gonzalo@cedarcode.com
 - braulio@cedarcode.com
@@ -207,12 +207,14 @@ files:
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docs/u2f_migration.md
 - gemfiles/openssl_2_0.gemfile
 - gemfiles/openssl_2_1.gemfile
 - lib/android_safetynet/attestation_response.rb
@@ -251,6 +253,7 @@ files:
 - lib/webauthn/credential_request_options.rb
 - lib/webauthn/credential_rp_entity.rb
 - lib/webauthn/credential_user_entity.rb
+- lib/webauthn/encoder.rb
 - lib/webauthn/error.rb
 - lib/webauthn/fake_authenticator.rb
 - lib/webauthn/fake_authenticator/attestation_object.rb
@@ -259,7 +262,9 @@ files:
 - lib/webauthn/public_key_credential.rb
 - lib/webauthn/security_utils.rb
 - lib/webauthn/signature_verifier.rb
+- lib/webauthn/u2f_migrator.rb
 - lib/webauthn/version.rb
+- webauthn-ruby.png
 - webauthn.gemspec
 homepage: https://github.com/cedarcode/webauthn-ruby
 licenses: