Skip to content

Latest commit

 

History

History
118 lines (83 loc) · 4.15 KB

README.md

File metadata and controls

118 lines (83 loc) · 4.15 KB
Raw

Overview

About Authem

Authem is an email-based authentication library for ruby web apps.

Compatibility

Authem requires Ruby 1.9.3 or newer, Rails 4.2 and up

Build Status Code Climate

Documentation

Please see the Authem website for up-to-date documentation: http://authem.org

Multi Channel Authentication (MCA)

Multi Channel Authentication (MCA), a paradigm proposed by Dillon Hafer, adds CSRF protection to Rails APIs without the overhead of making two server calls for each API request.

The general idea is simple:

  1. On sign in the client receives a client_auth_token that auth token is then stored on the client (on local storage, never cookies) and transmitted on every request in the HTTP headers (client-auth-token header). This is the first authentication channel.
  2. The client also gets a session token stored in a session cookie which is automatically submitted by the browser on every request. This is the second authentication channel.
  3. The server gets both client auth token from the headers and session token from the cookies, and uses both to find the user, if they match an Authem::Session in the database record, the current_user is set and the user is signed in. Otherwise the user cannot sign in.

To enable Multi Channel Auth in Authem add the following to your code:

In config/initializers/authem.rb

Authem.configure do |conf|
  conf.verify_client_auth_token = true
end

In your application_controller or any other base controller add this to your authem_for call:

class ApplicationController < ActionController::Base
  # protect_from_forgery with: :exception (you can comment out or delete this line)

  authem_for :user, verify_client_auth_token: true
end

Upgrading to 2.2

If you are upgrading from an older version of Authem (< v2.2.0) you need to create a migration adding the client_token column to your authem_sessions table:

def change
  add_column :authem_sessions, :client_token, null: false
end

You may want to clear or migrate all existing sessions before running this migration.

Upgrading to 2.0

  • Run bundle update authem and make sure you are on the 2.0.x release.
  • Remove references to the old Authem::Config object.
  • Create the new sessions table with rails g authem:session.
  • Replace include Authem::ControllerSupport with authem_for :user.
  • Rename signed_in? to user_signed_in? OR alias_method :signed_in?, :user_signed_in? in your controller.
  • Rename column User#reset_password_token to User#password_reset_token OR alias_attribute :password_reset_token, :reset_password_token in your User model.
  • Replace calls to user#reset_password_token! with user#password_reset_token. Tokens are now generated automatically and the bang method is deprecated.
  • Rename sign_out to sign_out_user OR alias_method :sign_out, :sign_out_user
  • If you were passing a remember flag as the second argument to sign_in, you need to provide an options hash instead. For example, sign_in(user, params[:remember]) would become sign_in(user, remember: params[:remember]).
  • Blank email addresses will now produce the proper "can't be blank" validation message". Update your tests accordingly.
  • Email addresses are no longer automatically downcased when calling find_by_email on your model. You will need to downcase the value manually if you wish to retain this behavior.
  • Specify what to do when authem denies access to a user by adding something like this to your ApplicationController.
def deny_user_access
  redirect_to :sign_in
end

Development

To install all gems for each version of Rails supported run:

$ bundle exec appraisal install

Testing

To run tests for all supported Rails versions:

$ bundle exec appraisal rake

To run the tests for a specific version:

$ bundle exec appraisal rails-5.1 rake

Check the Appraisals file for supported versions.