google-authenticator-rails 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be4ed80fe3da97670827efc04c0ff1894ef5306f
-  data.tar.gz: c0e7cce2b99528bcc3ddf35cfca281c538660c1d
+  metadata.gz: ed20f880010144ec35aeb9e7d97741e082a9e1d5
+  data.tar.gz: 1b48c9df0482d39d259fc763e48f23886c066e1d
 SHA512:
-  metadata.gz: 69c2cfaf49bb6a89fbf011d3ea129f7d71f62a11f822203442d934122d593bd89e3483c434ad3d20919c32431cbb9786aeee82a9cc7b7a89ab3933a52af13c41
-  data.tar.gz: d6ff87c9561e9dc03019f353a09ef7255c53dd23080fda86c958195ccaa23ef3dbaadcac33710b4e39bf9891799172345086a267b06ee8b320d3cd0de880c4ae
+  metadata.gz: 8e38d0a84b2a9d610ed5b3bc94124bc7e668cc1c7af5e0bee53071ad3270eb2109d589ea9b6a608137f61e519cc723c05e4996cb957dd1ac99c0a94bd4b3f144
+  data.tar.gz: 95b6fee3b5ecd00fdd804fc9a97f3e386a039504822852f0382d3dc1db951ecea9deef5701574a79e879d80eb79c100da8e034adb00d007eb97580ed07e0e43a

data/README.md

@@ -300,16 +300,25 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-## Other configuration
+## Cookie options
 
-By default, the cookie related to the MfaSession expires in 24 hours, but this can be changed:
+You can configure the MfaSession cookie by creating an initializer:
 
 ```ruby
 # config/initializers/google_authenticator_rails.rb
 
+# The cookie normally expires in 24 hours, you can change this to 1 month
 GoogleAuthenticatorRails.time_until_expiration = 1.month
+
+# You can override the suffix of the cookie's key, by default this is mfa_credentials
+GoogleAuthenticatorRails.cookie_key_suffix = 'mfa_credentials'
+
+# Rails offers a few more cookie options, by default only :httponly is turned on, you can change it to HTTPS only:
+GoogleAuthenticatorRails.cookie_options = { :httponly => true, :secure => true, :domain => :all }
 ```
 
+Additional cookie option symbols can be found in the [Ruby on Rails guide](http://api.rubyonrails.org/classes/ActionDispatch/Cookies.html).
+
 ## Destroying the Cookie
 
 If you want to manually destroy the MFA cookie (for example, when a user logs out), just call

data/lib/google-authenticator-rails.rb

@@ -1,4 +1,4 @@
-# Stuff the gem requireds
+# Stuff the gem requires
 #
 require 'active_support'
 require 'active_record'
@@ -20,15 +20,21 @@ GOOGLE_AUTHENTICATOR_RAILS_PATH = File.dirname(__FILE__) + "/google-authenticato
    require GOOGLE_AUTHENTICATOR_RAILS_PATH + library
  end
 
- # Sets up some basic accessors for use with the ROTP module
+# Sets up some basic accessors for use with the ROTP module
 #
 module GoogleAuthenticatorRails
-  # Drift is set to 6 because ROTP drift is not inclusive.  This allows a drift of 5 seconds.
+  # Drift is set to 6 because ROTP drift is not inclusive. This allows a drift of 5 seconds.
   DRIFT = 6
 
   # How long a Session::Persistence cookie should last.
   @@time_until_expiration = 24.hours
 
+  # Last part of a Session::Persistence cookie's key
+  @@cookie_key_suffix = nil
+
+  # Additional configuration passed to a Session::Persistence cookie.
+  @@cookie_options = { :httponly => true }
+
   def self.generate_password(secret, iteration)
     ROTP::HOTP.new(secret).at(iteration)
   end
@@ -52,4 +58,20 @@ module GoogleAuthenticatorRails
   def self.time_until_expiration=(time_until_expiration)
     @@time_until_expiration = time_until_expiration
   end
+
+  def self.cookie_key_suffix
+    @@cookie_key_suffix
+  end
+
+  def self.cookie_key_suffix=(suffix)
+    @@cookie_key_suffix = suffix
+  end
+
+  def self.cookie_options
+    @@cookie_options
+  end
+
+  def self.cookie_options=(options)
+    @@cookie_options = options
+  end
 end

data/lib/google-authenticator-rails/session/persistence.rb

@@ -59,14 +59,16 @@ module GoogleAuthenticatorRails
 
       def create_cookie(token, user_id)
         value = [token, user_id].join('::')
-        {
+        options = GoogleAuthenticatorRails.cookie_options || {}
+        options.merge(
           :value    => value,
           :expires  => GoogleAuthenticatorRails.time_until_expiration.from_now
-        }
+        )
       end
 
       def cookie_key
-        "#{klass.to_s.downcase}_mfa_credentials"
+        suffix = "#{GoogleAuthenticatorRails.cookie_key_suffix}" || 'mfa_credentials'
+        "#{klass.to_s.downcase}_#{suffix}"
       end
     end
 

data/lib/google-authenticator-rails/version.rb

@@ -1,7 +1,7 @@
 module Google
   module Authenticator
     module Rails
-      VERSION = "1.1.0"
+      VERSION = "1.2.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-authenticator-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jared McFarland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-26 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rotp