devise-passwordless 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08511edac883e2b94811e349d41ce761a7d5771e55b628450bd1e02d835f0374'
+  data.tar.gz: 9d0f442ffed9f59818a370c8bdc815f362367bd24a6c09fc66b0097009992cd9
+SHA512:
+  metadata.gz: 405e6a4ee5dbb3c66dcd079a92642e01dfb10b336d5e220f8a05f0814a2ac50ef47e78aa13e734b4aec4ce2891eb8cde900854984c3c84193afb1ff05e5b8481
+  data.tar.gz: 933e273120b795b3b1eb1bb96a4672c9f3da7645ed7df55046eddc57197307afd9aadee5612fb047980cceed3fc5c2348f5388bb5b19df87191e9ee57e2fdb0f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in devise-passwordless.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Abe Voelker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# Devise::Passwordless
+
+A passwordless login strategy for [Devise][]
+
+## Installation
+
+You should already have Devise installed. Then add this gem:
+
+```ruby
+gem "devise-passwordless"
+```
+
+Then run the generator to automatically update your Devise initializer:
+
+```
+rails g devise:passwordless:install
+```
+
+Merge these YAML values into your `devise.en.yml` file:
+
+```yaml
+en:
+  devise:
+    failure:
+      passwordless_invalid: "Invalid or expired login link."
+    mailer:
+      passwordless_link:
+        subject: "Here's your magic link"
+```
+
+## Usage
+
+This gem adds an `:email_authenticatable` strategy that can be used in your Devise models for passwordless authentication. This strategy plays well with most other Devise strategies.
+
+For example, for a User model, you could do this (other strategies optional and not an exhaustive list):
+
+```ruby
+class User < ApplicationRecord
+  devise :email_authenticatable,
+         :registerable,
+         :rememberable,
+         :validatable,
+         :confirmable
+end
+```
+
+**Note** if using the `:rememberable` strategy for "remember me" functionality, you'll need to add a `remember_token` column to your resource, as there is no password salt to use for validating cookies:
+
+```ruby
+change_table :users do |t|
+  t.string :remember_token, limit: 20
+end
+```
+
+**Note** if using the `:confirmable` strategy, you may want to override the default Devise behavior of requiring a fresh login after email confirmation (e.g. [this](https://stackoverflow.com/a/39010334/215168) or [this](https://stackoverflow.com/a/25865526/215168) approach). Otherwise, users will have to get a fresh login link after confirming their email, which makes no sense if they just confirmed they own the email address.
+
+## Configuration
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[Devise]: https://github.com/heartcombo/devise

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "devise/passwordless"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/devise-passwordless.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "devise/passwordless/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "devise-passwordless"
+  spec.version       = Devise::Passwordless::VERSION
+  spec.authors       = ["Abe Voelker"]
+  spec.email         = ["_@abevoelker.com"]
+
+  spec.summary       = %q{Passwordless (email-only) login strategy for Devise}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/abevoelker/devise-passwordless"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "devise"
+  spec.add_dependency "rails"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/devise/models/email_authenticatable.rb

@@ -0,0 +1,53 @@
+require 'devise/strategies/email_authenticatable'
+
+module Devise
+  module Models
+    module EmailAuthenticatable
+      extend ActiveSupport::Concern
+
+      def password_required?
+        false
+      end
+
+      # Not having a password method breaks the :validatable module
+      def password
+        nil
+      end
+
+      # A callback initiated after successfully authenticating. This can be
+      # used to insert your own logic that is only run after the user successfully
+      # authenticates.
+      #
+      # Example:
+      #
+      #   def after_passwordless_authentication
+      #     self.update_attribute(:invite_code, nil)
+      #   end
+      #
+      def after_passwordless_authentication
+      end
+
+      protected
+
+      module ClassMethods
+        # We assume this method already gets the sanitized values from the
+        # EmailAuthenticatable strategy. If you are using this method on
+        # your own, be sure to sanitize the conditions hash to only include
+        # the proper fields.
+        def find_for_email_authentication(conditions)
+          find_for_authentication(conditions)
+        end
+
+        Devise::Models.config(self, :passwordless_login_within, :passwordless_secret_key)
+      end
+    end
+  end
+end
+
+module Devise
+  mattr_accessor :passwordless_login_within
+  @@passwordless_login_within = 20.minutes
+
+  mattr_accessor :passwordless_secret_key
+  @@passwordless_secret_key = nil
+end

data/lib/devise/passwordless.rb

@@ -0,0 +1,3 @@
+require "devise/passwordless/version"
+require "devise/models/email_authenticatable"
+require "generators/devise/passwordless/install_generator"

data/lib/devise/passwordless/login_token.rb

@@ -0,0 +1,57 @@
+module Devise::Passwordless
+  class LoginToken
+    class InvalidOrExpiredTokenError < StandardError; end
+
+    def self.encode(resource)
+      now = Time.current
+      len = ActiveSupport::MessageEncryptor.key_len
+      salt = SecureRandom.random_bytes(len)
+      key = ActiveSupport::KeyGenerator.new(self.secret_key).generate_key(salt, len)
+      crypt = ActiveSupport::MessageEncryptor.new(key, serializer: JSON)
+      encrypted_data = crypt.encrypt_and_sign({
+        data: {
+          resource: {
+            key: resource.to_key,
+            email: resource.email,
+          },
+        },
+        created_at: now.to_f,
+      })
+      salt_base64 = Base64.strict_encode64(salt)
+      "#{salt_base64}:#{encrypted_data}"
+    end
+
+    def self.decode(token, as_of=Time.current, expire_duration=Devise.passwordless_login_within)
+      raise InvalidOrExpiredTokenError if token.blank?
+      salt_base64, encrypted_data = token.split(":")
+      begin
+        salt = Base64.strict_decode64(salt_base64)
+      rescue ArgumentError
+        raise InvalidOrExpiredTokenError
+      end
+      len = ActiveSupport::MessageEncryptor.key_len
+      key = ActiveSupport::KeyGenerator.new(self.secret_key).generate_key(salt, len)
+      crypt = ActiveSupport::MessageEncryptor.new(key, serializer: JSON)
+      begin
+        decrypted_data = crypt.decrypt_and_verify(encrypted_data)
+      rescue ActiveSupport::MessageVerifier::InvalidSignature, ActiveSupport::MessageEncryptor::InvalidMessage
+        raise InvalidOrExpiredTokenError
+      end
+
+      created_at = ActiveSupport::TimeZone["UTC"].at(decrypted_data["created_at"])
+      if as_of.to_f > (created_at + expire_duration).to_f
+        raise InvalidOrExpiredTokenError
+      end
+
+      decrypted_data
+    end
+
+    def self.secret_key
+      if Devise.passwordless_secret_key.present?
+        Devise.passwordless_secret_key
+      else
+        Devise.secret_key
+      end
+    end
+  end
+end

data/lib/devise/passwordless/mailer.rb

@@ -0,0 +1,9 @@
+if defined?(Devise::Mailer)
+  Devise::Mailer.class_eval do
+    def passwordless_link(record, remember_me, opts = {})
+      @remember_me = remember_me
+      @token = Devise::Passwordless::LoginToken.encode(record)
+      devise_mail(record, :passwordless_link, opts)
+    end
+  end
+end

data/lib/devise/passwordless/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module Passwordless
+    VERSION = "0.1.0"
+  end
+end

data/lib/devise/strategies/email_authenticatable.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "devise"
+require "devise/strategies/authenticatable"
+require "devise/passwordless/login_token"
+
+module Devise
+  module Strategies
+    class EmailAuthenticatable < Authenticatable
+      #undef :password
+      #undef :password=
+      attr_accessor :token
+
+      def valid_for_http_auth?
+        super && http_auth_hash[:token].present?
+      end
+
+      def valid_for_params_auth?
+        super && params_auth_hash[:token].present?
+      end
+
+      def authenticate!
+        data = begin
+          x = Devise::Passwordless::LoginToken.decode(self.token)
+          x["data"]
+        rescue Devise::Passwordless::LoginToken::InvalidOrExpiredTokenError
+          fail!(:passwordless_invalid)
+          return
+        end
+
+        resource = mapping.to.find_by(id: data["resource"]["key"])
+        if validate(resource)
+          remember_me(resource)
+          resource.after_passwordless_authentication
+          success!(resource)
+        else
+          fail!(:passwordless_invalid)
+        end
+      end
+
+      private
+
+      # Sets the authentication hash and the token from params_auth_hash or http_auth_hash.
+      def with_authentication_hash(auth_type, auth_values)
+        self.authentication_hash, self.authentication_type = {}, auth_type
+        self.token = auth_values[:token]
+
+        parse_authentication_key_values(auth_values, authentication_keys) &&
+        parse_authentication_key_values(request_values, request_keys)
+      end
+    end
+  end
+end
+
+Warden::Strategies.add(:email_authenticatable, Devise::Strategies::EmailAuthenticatable)
+
+Devise.add_module(:email_authenticatable, {
+  strategy: true,
+  controller: :sessions,
+  model: "devise/models/email_authenticatable",
+  #route: { email_authenticatable: [nil, :new, :edit] }
+  route: :session
+})

data/lib/generators/devise/passwordless/install_generator.rb

@@ -0,0 +1,42 @@
+require "rails/generators"
+require "yaml"
+
+module Devise::Passwordless
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Updates the Devise initializer to add passwordless config options"
+
+      def update_devise_initializer
+        inject_into_file 'config/initializers/devise.rb', before: /^end$/ do <<~'CONFIG'.indent(2)
+
+          # ==> Configuration for :email_authenticatable
+
+          # Time period after a magic login link is sent out that it will be valid for.
+          # config.passwordless_login_within = 20.minutes
+        
+          # The secret key used to generate passwordless login tokens. The default
+          # value is nil, which means defer to Devise's `secret_key` config value.
+          # Changing this key will render invalid all existing passwordless login
+          # tokens. You can generate your own value with e.g. `rake secret`
+          # config.passwordless_secret_key = nil
+        CONFIG
+        end
+      end
+
+      def update_devise_yaml
+        devise_yaml = "config/locales/devise.en.yml"
+        begin
+          config = YAML.load_file(devise_yaml)
+        rescue Errno::ENOENT
+          STDERR.puts "Couldn't find devise.en.yml - skipping patch"
+          return
+        end
+        config["en"]["devise"]["failure"]["passwordless_invalid"] = "Invalid or expired login link."
+        config["en"]["devise"]["mailer"]["passwordless_link"] = {subject: "Your login link"}
+        File.open(devise_yaml, "w") do |f|
+          f.write(config.to_yaml)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: devise-passwordless
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abe Voelker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- _@abevoelker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- devise-passwordless.gemspec
+- lib/devise/models/email_authenticatable.rb
+- lib/devise/passwordless.rb
+- lib/devise/passwordless/login_token.rb
+- lib/devise/passwordless/mailer.rb
+- lib/devise/passwordless/version.rb
+- lib/devise/strategies/email_authenticatable.rb
+- lib/generators/devise/passwordless/install_generator.rb
+homepage: https://github.com/abevoelker/devise-passwordless
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/abevoelker/devise-passwordless
+  source_code_uri: https://github.com/abevoelker/devise-passwordless
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Passwordless (email-only) login strategy for Devise
+test_files: []