Awesome Open Source
Awesome Open Source

Passwordless

Travis Rubygems codecov

Add authentication to your Rails app without all the icky-ness of passwords.


Table of Contents

Installation

Add the passwordless gem to your Gemfile:

gem 'passwordless'

Install it and copy over the migrations:

$ bundle
$ bin/rails passwordless:install:migrations

Usage

Passwordless creates a single model called Passwordless::Session. It doesn't come with its own User model, it expects you to create one:

$ bin/rails generate model User email

Then specify which field on your User record is the email field with:

class User < ApplicationRecord
  validates :email, presence: true, uniqueness: { case_sensitive: false }

  passwordless_with :email # <-- here!
end

Finally, mount the engine in your routes:

Rails.application.routes.draw do
  passwordless_for :users

  # other routes
end

Getting the current user, restricting access, the usual

Passwordless doesn't give you current_user automatically. Here's how you could add it:

class ApplicationController < ActionController::Base
  include Passwordless::ControllerHelpers # <-- This!

  # ...

  helper_method :current_user

  private

  def current_user
    @current_user ||= authenticate_by_session(User)
  end

  def require_user!
    return if current_user
    redirect_to root_path, flash: { error: 'You are not worthy!' }
  end
end

Et voilà:

class VerySecretThingsController < ApplicationController
  before_action :require_user!

  def index
    @things = current_user.very_secret_things
  end
end

Providing your own templates

Override passwordless' bundled views by adding your own. passwordless has 2 action views and 1 mailer view:

# the form where the user inputs their email address
app/views/passwordless/sessions/new.html.erb
# shown after a user requests a magic link
app/views/passwordless/sessions/create.html.erb
# the mail with the magic link that gets sent
app/views/passwordless/mailer/magic_link.text.erb

If you'd like to let the user know whether or not a record was found, @resource is provided to the view. You may override app/views/passwordless/session/create.html.erb for example like so:

<% if @resource.present? %>
  <p>User found, check your inbox</p>
<% else %>
  <p>No user found with the provided email address</p>
<% end %>

See the bundled views.

Registering new users

Because your User record is like any other record, you create one like you normally would. Passwordless provides a helper method to sign in the created user after it is saved – like so:

class UsersController < ApplicationController
  include Passwordless::ControllerHelpers # <-- This!
  # (unless you already have it in your ApplicationController)

  def create
    @user = User.new user_params

    if @user.save
      sign_in @user # <-- This!
      redirect_to @user, flash: { notice: 'Welcome!' }
    else
      render :new
    end
  end

  # ...
end

URLs and links

By default, Passwordless uses the resource name given to passwordless_for to generate its routes and helpers.

passwordless_for :users
  # <%= users.sign_in_path %> # => /users/sign_in

passwordless_for :users, at: '/', as: :auth
  # <%= auth.sign_in_path %> # => /sign_in

Also be sure to specify ActionMailer's default_url_options.host.

Customize the way to send magic link

By default, magic link will send by email. You can customize this method. For example, you can send magic link via SMS.

config/initializers/passwordless.rb

Passwordless.after_session_save = lambda do |session, request|
  # Default behavior is
  # Passwordless::Mailer.magic_link(session).deliver_now

  # You can change behavior to do something with session model. For example,
  # session.authenticatable.send_sms
end

You can access user model through authenticatable.

Generate your own magic links

Currently there is not an officially supported way to generate your own magic links to send in your own mailers.

However, you can accomplish this with the following snippet of code.

session = Passwordless::Session.new({
  authenticatable: @manager,
  user_agent: 'Command Line',
  remote_addr: 'unknown',
})
session.save!
@magic_link = send(Passwordless.mounted_as).token_sign_in_url(session.token)

You can further customize this URL by specifying the destination path to be redirected to after the user has logged in. You can do this by adding the destination_path query parameter to the end of the URL. For example

@magic_link = "#{@magic_link}?destination_path=/your-custom-path"

Overrides

By default passwordless uses the passwordless_with column to case insensitively fetch the resource.

You can override this and provide your own customer fetcher by defining a class method fetch_resource_for_passwordless in your passwordless model. The method will be called with the downcased email and should return an ActiveRecord instance of the model.

Example time:

Let's say we would like to fetch the record and if it doesn't exist, create automatically.

class User < ApplicationRecord
  def self.fetch_resource_for_passwordless(email)
    find_or_create_by(email: email)
  end
end

Configuration

The following configuration parameters are supported. You can override these for example in initializers/passwordless.rb.

The default values are shown below. It's recommended to only include the ones that you specifically want to override.

Passwordless.default_from_address = "[email protected]"
Passwordless.parent_mailer = "ActionMailer::Base"
Passwordless.token_generator = Passwordless::UrlSafeBase64Generator.new # Used to generate magic link tokens.
Passwordless.restrict_token_reuse = false # By default a magic link token can be used multiple times.
Passwordless.redirect_back_after_sign_in = true # When enabled the user will be redirected to their previous page, or a page specified by the `destination_path` query parameter, if available.

Passwordless.expires_at = lambda { 1.year.from_now } # How long until a passwordless session expires.
Passwordless.timeout_at = lambda { 1.hour.from_now } # How long until a magic link expires.

# Default redirection paths
Passwordless.success_redirect_path = '/' # When a user succeeds in logging in.
Passwordless.failure_redirect_path = '/' # When a a login is failed for any reason.
Passwordless.sign_out_redirect_path = '/' # When a user logs out.

Customizing token generation

By default Passwordless generates tokens using SecureRandom.urlsafe_base64 but you can change that by setting Passwordless.token_generator to something else that responds to call(session) eg.:

Passwordless.token_generator = -> (session) {
  "probably-stupid-token-#{session.user_agent}-#{Time.current}"
}

Session is going to keep generating tokens until it finds one that hasn't been used yet. So be sure to use some kind of method where matches are unlikely.

Token and Session Expiry

Token timeout is the time by which the sign in token is invalidated. Post the timeout, the token cannot be used to sign-in to the app and the user would need to request it again.

Session expiry is the expiration time of the session of a logged in user. Once this is expired, user would need to log back in to create a new session.

Token timeout

By default, sign in tokens generated by Passwordless are made invalid after 1.hour from the time they are generated. If you wish you can override this and supply your custom Proc function that will return a valid datetime object. Make sure the generated time is in the future.

Make sure to use a .callable object, like a proc or lambda as it will be called everytime a session is created.

Passwordless.timeout_at = lambda { 2.hours.from_now }

Session Expiry

Session expiry is the time when the actual session is itself expired, i.e. users will be logged out and has to sign back in post this expiry time. By default, sessions are valid for 1.year from the time they are generated. You can override by providing your custom Proc function that returns a datetime object.

Make sure to use a .callable object, like a proc or lambda as it will be called everytime a session is created.

Passwordless.expires_at = lambda { 24.hours.from_now }

Redirecting back after sign-in

By default Passwordless will redirect back to where the user wanted to go if it knows where that is, so you'll have to help it. Passwordless::ControllerHelpers provide a method for this:

class ApplicationController < ActionController::Base
  include Passwordless::ControllerHelpers # <-- Probably already have this!

  # ...

  def require_user!
    return if current_user
    save_passwordless_redirect_location!(User) # <-- here we go!
    redirect_to root_path, flash: {error: 'You are not worthy!'}
  end
end

This can be turned off with Passwordless.redirect_back_after_sign_in = false but if you just don't save the previous destination, you'll be fine.

Claiming tokens

Opt-in for marking tokens as claimed so they can only be used once.

config/initializers/passwordless.rb

# Default is `false`
Passwordless.restrict_token_reuse = true

Supporting UUID primary keys

If your users table uses UUIDs for its primary keys, you will need to add a migration to change the type of passwordless' authenticatable_id field to match your primary key type (this will also involve dropping and recreating associated indices).

Here is an example migration you can use:

class SupportUuidInPasswordlessSessions < ActiveRecord::Migration[6.0]
  def change
    remove_index :passwordless_sessions, column: [:authenticatable_type, :authenticatable_id] if index_exists? :authenticatable_type, :authenticatable_id
    remove_column :passwordless_sessions, :authenticatable_id
    add_column :passwordless_sessions, :authenticatable_id, :uuid
    add_index :passwordless_sessions, [:authenticatable_type, :authenticatable_id], name: 'authenticatable'
  end
end

Alternatively, you can use add_reference with type: :uuid in your migration (see its docs here: https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-add_reference).

Upgrading an existing Rails app

The simplest way to update your sessions table is with a single migration:

Example migration
bin/rails generate migration add_claimed_at_to_passwordless_sessions
class AddClaimedAtToPasswordlessSessions < ActiveRecord::Migration[5.2]
  def change
    add_column :passwordless_sessions, :claimed_at, :datetime
  end
end

Testing helpers

To help with testing, a set of test helpers are provided.

If you are using RSpec, add the following line to your spec/rails_helper.rb or spec/spec_helper.rb if rails_helper.rb does not exist:

require "passwordless/test_helpers"

If you are using TestUnit, add this line to your test/test_helper.rb:

require "passwordless/test_helpers"

Then in your controller, request, and system tests/specs, you can utilize the following methods:

passwordless_sign_in(user) # signs you in as a user
passwordless_sign_out # signs out user

E-mail security

There's no reason that this approach should be less secure than the usual username/password combo. In fact this is most often a more secure option, as users don't get to choose the weak passwords they still use. In a way this is just the same as having each user go through "Forgot password" on every login.

But be aware that when everyone authenticates via emails you send, the way you send those mails becomes a weak spot. Email services usually provide a log of all the mails you send so if your app's account is compromised, every user in the system is as well. (This is the same for "Forgot password".) Reddit was compromised using this method.

Ideally you should set up your email provider to not log these mails. And be sure to turn on 2-factor auth if your provider supports it.

Alternatives

  • OTP JWT -- Passwordless JSON Web Tokens

License

MIT


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
ruby (12,916
rails (670
authentication (492
engine (224