devise_fido_usf 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59961973d33d05c3d1acecdc6a20311c6ed689bb
-  data.tar.gz: b4f0b4864b95e48713223bd4737683800dbe1ee4
+  metadata.gz: 3b48a4f1044ad80161f4a34f1e9183f7e6d6510b
+  data.tar.gz: 59c3b152a8ea51fbd37861bf3a174d25d424a25c
 SHA512:
-  metadata.gz: 1f8f8fe488eab32d6a388a976ee003e9e7079a59a3b9ebf7b00935d8f7a78d4c3d845fcebe76245e3ff03fe6523c09cdd76fe730cfb55db42f9d38d2fc72ae5c
-  data.tar.gz: 4269013dd754c4441a046878f91e6d0ceb6aebc7ec2c6b8ba16b1a64e8f48799f2114ac78946a637ec22d32cff48aa9bfe85488acd94cd15c6a08a6ef8ee33ba
+  metadata.gz: c7bb25909771d8cdffce85019dbf01ce3dac763d1607293cf55bf932f7dd459adae911f1baebd3e89d81c354e3abef155bcb6b996dfef09d5658a89764f59485
+  data.tar.gz: 9ae1f30f3555a93cb51d8a95cc88e18cde4ad3f37a3b80afb20d0940014864a95018ffe44a71a30e51918b2534cdda07514681b3ab8aa0e45d27a4b9257e6862

data/README.md

@@ -10,23 +10,66 @@
 
 A gem which allows Rails Devise users to authenticate against a second factor.
 
-## Installation
-Add this line to your application's Gemfile:
+## Getting started
+Devise FIDO U2F works with Rails 5.1 and Devise 4.3 onwards. You need to add it to your application's Gemfile with:
 
 ```ruby
 gem 'devise_fido_usf'
 ```
 
-And then execute:
+Afterwards, run `bundle install` to install it.
+
+Before being able to use it you need to set it up by running its installation generator:
+
+```bash
+$ rails generate devise_fido_usf:install
+```
+
+During installation some instructions will be output to your console. Please follow these instructions carefully.
+Specifically, you need to adapt your Devise models to include both the FIDO U2F registration and authentication modules. For example you need to add to `app/models/user.rb` the following lines:
+
+
+```ruby
+devise :fido_usf_registerable, :fido_usf_authenticatable', ...
+
+```
+
+Please ensure that the CSRF token check is always prepended on the action chain of your `ApplicationController`. Edit file `app/controllers/application_controller.rb` and change the `protect_from_forgery` line to include `prepend: true`:
+
+```ruby
+class ApplicationController < ActionController::Base
+  # Prepend the verification of the CSRF token before the action chain.
+  protect_from_forgery with: :exception, prepend: true
+  ...
+end
+
+```
+
+You need to include `u2f-api.js` in your javascript's asset chain by editing `app/assets/javascript/application.js` to include:
+
+```javascript
+//= require u2f-api
+```
+
+Now Devise with FIDO U2F is activated. Before using it, you need to migrate pending database changes by executing
+
 ```bash
-$ bundle
+$ rails db:migrate
 ```
 
-Or install it yourself as:
+Remember: To use it you always needs to run your development server with SSL. Otherwise, the FIDO U2F protocol will not allow registration or authentication!
+
+## FIDO U2F Views
+
+To enable the user to register a FIDO U2F device and to change the appeareance of the authentication screens you need to customize its views.
+You can install the `devise_fido_usf` views by running
+
 ```bash
-$ gem install devise_fido_usf
+rails generate devise_fido_usf:views
 ```
 
+After that, you need to adapt the views to your needs. Take a look at the ![Devise FIDO U2F example app](https://github.com/cyberdeck/devise-fido-u2f-example-app) how it could be integrated into a Rails 5.1 application running Bootstrap v4.
+
 ## Contributing
 This is my first developed and published gem. If you find something unusual or uncommon within my code, please drop me a note how to fix it or make it better. Thank you!
 

data/app/controllers/devise/fido_usf_registrations_controller.rb

@@ -47,11 +47,14 @@ class Devise::FidoUsfRegistrationsController < ApplicationController
       flash[:success] = I18n.t('fido_usf.flashs.device.registered')
     rescue U2F::Error => e
       @error_message = "Unable to register: #{e.class.name}"
-      flash[:error] = @error_message
+      flash[:error] = @error_message 
     ensure
       session.delete(:challenges)
     end
 
-    redirect_to user_fido_usf_registration_path()
+    respond_to do |format|
+      format.js
+      format.html { redirect_to user_fido_usf_registration_url }
+    end
   end
 end

data/lib/devise_fido_usf/version.rb

@@ -1,3 +1,3 @@
 module DeviseFidoUsf
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/generators/templates/README

@@ -4,7 +4,11 @@ Device FIDO U2F successfully installed to your application.
 
 You need to:
 
-1) Adapt your Devise models to include both the FIDO U2F registration and
+1) Migrate database changes by running
+
+   'rails db:migrate'
+
+2) Adapt your Devise models to include both the FIDO U2F registration and
    authentication modules, e.g. change
 
    'devise :database_authenticable ...'
@@ -14,7 +18,7 @@ You need to:
    'devise :database_authenticable ..., 
     :fido_usf_registerable, :fido_usf_authenticatable'
 
-2) Modify your application controller 
+3) Modify your application controller 
    (i.e. app/controllers/application_controller.rb) to always prepend the 
    'protect_from_forgery' within the action chain, e.g. change
 
@@ -24,12 +28,12 @@ You need to:
 
    'protect_from_forgery with: :exception, prepend: true'
 
-3) Add 'u2f-api.js' to your javascript assets, e.g. include in
+4) Add 'u2f-api.js' to your javascript assets, e.g. include in
    'app/assets/javascript/application.js' the following statement:
 
    '//= require u2f-api'
 
-4) You need to run your server with SSL. Otherwise U2F refuses to work.
+5) You need to run your server with SSL. Otherwise U2F refuses to work.
    Probably you want to install the "thin" gem and use:
 
    'thin start --ssl -p 3000'
@@ -37,7 +41,7 @@ You need to:
    to start your development server.
 
 
-DISCLAIMER: IF YOU DO NOT APPLY BOTH CHANGES, IT IS LIKELY THAT 
+DISCLAIMER: IF YOU DO NOT APPLY ALL  CHANGES, IT IS LIKELY THAT 
 FIDO U2F WILL NOT WORK AS EXPECTED!
 
 ===============================================================================

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_fido_usf
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - H. Gregor Molter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails