authentication-zero 0.0.13 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e853cd032072f4c6dc76b99cdff704b392eac57abea2893957b03f93c7069bd
-  data.tar.gz: 49428b1a84e2cd03beba0f9f5a39623f06c33ae20072a691130885391b09d615
+  metadata.gz: efb4d895a3678027d6ead3a365d35a5cd7d5b7fc87c7ffe69140b9f4d9fcd705
+  data.tar.gz: 8757ea47c7e1a86abac000c42689e6e05c987609037a66254308135c4662dc77
 SHA512:
-  metadata.gz: aa5510a1671afde349053941f76876b888b481fbae4839dd7724b38163c3ca37c8a68ad73f2eb1de277f80bfbc3ad9d4e21f5d07613a24f09bc78d9e7b051bec
-  data.tar.gz: 1578a6bc1502f0d1f0f25b6b993f4f1be297f367532ce604f1da5926de5bd9fb38bbcc36705b98c2a8fd3cca933bd2649b81cdc9007fbf4dfcb63065758835a0
+  metadata.gz: e68ee610e427b081e6e462a86651382e556a674242f66154a51727b2c396f907417509a80aa4aaf343433ddf8f02bfb30af099f75b49657232fc47282930a964
+  data.tar.gz: 43afeb2c6e2b0444c5b7970839b698934e37c85befb1b35b60eac0d43128cb22b63a2d18e1fc3d64796628ddebc27e6e879989e11bda9d56a84cbc584439d373

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    authentication-zero (0.0.13)
+    authentication-zero (0.0.17)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,6 +2,31 @@
 
 The purpose of authentication zero is to generate a pre-built authentication system into a rails application (web or api-only) that follows both security and rails best practices. By generating code into the user's application instead of using a library, the user has complete freedom to modify the authentication system so it works best with their app.
 
+## Features
+
+- Sign up
+- Email and password validations
+- Reset the user password and send reset instructions
+- Authentication by cookie (html)
+- Authentication by token (api)
+- Remember me (html)
+- Send e-mail when email is changed
+- Send e-mail when password is changed
+- Cancel my account
+- Log out
+
+## Security and best practices
+
+- [Current attributes](https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html): Abstract super class that provides a thread-isolated attributes singleton, which resets automatically before and after each request.
+- [has_secure_password](https://api.rubyonrails.org/classes/ActiveModel/SecurePassword/ClassMethods.html#method-i-has_secure_password): Adds methods to set and authenticate against a BCrypt password.
+- [has_secure_token](https://api.rubyonrails.org/classes/ActiveRecord/SecureToken/ClassMethods.html#method-i-has_secure_token): Adds methods to generate unique tokens.
+- [signed_id](https://api.rubyonrails.org/classes/ActiveRecord/SignedId.html): Returns a signed id that is tamper proof, so it's safe to send in an email or otherwise share with the outside world.
+- [Signed cookies](https://api.rubyonrails.org/classes/ActionDispatch/Cookies.html): Returns a jar that'll automatically generate a signed representation of cookie value and verify it when reading from the cookie again.
+- [Http only cookies](https://api.rubyonrails.org/classes/ActionDispatch/Cookies.html): A cookie with the httponly attribute is inaccessible to the JavaScript, this precaution helps mitigate cross-site scripting (XSS) attacks.
+- [Log filtering](https://guides.rubyonrails.org/action_controller_overview.html#log-filtering): Parameters 'token' and 'password' are marked [FILTERED] in the log.
+- [Callbacks](https://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html): We use callbacks to send emails after changing an email or password.
+- [Action mailer](https://api.rubyonrails.org/classes/ActionMailer/Base.html): Action Mailer allows you to send email from your application using a mailer model and views.
+
 ## Installation
 
 Add this lines to your application's Gemfile:

data/lib/authentication_zero/version.rb

@@ -1,3 +1,3 @@
 module AuthenticationZero
-  VERSION = "0.0.13"
+  VERSION = "0.0.17"
 end

data/lib/generators/authentication/authentication_generator.rb

@@ -16,7 +16,7 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
   end
 
   def create_mailers
-    template "mailers/email_mailer.rb", "app/mailers/email_mailer.rb"    
+    template "mailers/email_mailer.rb", "app/mailers/email_mailer.rb"
     template "mailers/password_mailer.rb", "app/mailers/password_mailer.rb"
   end
 
@@ -59,7 +59,7 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
 
         private
           def authenticate
-            if #{singular_table_name} = authenticate_with_http_token { |token, _| #{class_name}.find_by_session_token(token) }
+            if #{singular_table_name} = authenticate_with_http_token { |t, _| #{class_name}.find_signed_session_token(t) }
               Current.user = #{singular_table_name}
             else
               request_http_token_authentication
@@ -73,7 +73,7 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
 
         private
           def authenticate
-            if #{singular_table_name} = cookies[:session_token] && #{class_name}.find_by_session_token(cookies[:session_token])
+            if #{singular_table_name} = #{class_name}.find_by_session_token(cookies.signed[:session_token])
               Current.user = #{singular_table_name}
             else
               redirect_to sign_in_path, alert: "You need to sign in or sign up before continuing"

data/lib/generators/authentication/templates/controllers/api/emails_controller.rb.tt

@@ -5,9 +5,6 @@ class EmailsController < ApplicationController
     if !@<%= singular_table_name %>.authenticate(params[:current_password])
       render json: { error: "The current password you entered is incorrect" }, status: :bad_request
     elsif @<%= singular_table_name %>.update(<%= "#{singular_table_name}_params" %>)
-      if @<%= singular_table_name %>.email_previously_changed?
-        EmailMailer.with(email_change: @<%= singular_table_name %>.email_previous_change).changed.deliver_later
-      end
       render json: @<%= singular_table_name %>
     else
       render json: @<%= singular_table_name %>.errors, status: :unprocessable_entity

data/lib/generators/authentication/templates/controllers/api/password_resets_controller.rb.tt

@@ -1,6 +1,5 @@
 class PasswordResetsController < ApplicationController
   skip_before_action :authenticate
-
   before_action :set_<%= singular_table_name %>, only: %i[ edit update ]
 
   def edit
@@ -25,7 +24,7 @@ class PasswordResetsController < ApplicationController
 
   private
     def set_<%= singular_table_name %>
-      @<%= singular_table_name %> = <%= class_name %>.find_signed!(params[:sid], purpose: "password_reset")
+      @<%= singular_table_name %> = <%= class_name %>.find_signed!(params[:token], purpose: "password_reset")
     rescue ActiveSupport::MessageVerifier::InvalidSignature
       render json: { error: "Your token has expired, please request a new one" }, status: :bad_request
     end

data/lib/generators/authentication/templates/controllers/api/passwords_controller.rb.tt

@@ -5,7 +5,6 @@ class PasswordsController < ApplicationController
     if !@<%= singular_table_name %>.authenticate(params[:current_password])
       render json: { error: "The current password you entered is incorrect" }, status: :bad_request
     elsif @<%= singular_table_name %>.update(<%= "#{singular_table_name}_params" %>)
-      PasswordMailer.with(user: @<%= singular_table_name %>).changed.deliver_later
       render json: @<%= singular_table_name %>
     else
       render json: @<%= singular_table_name %>.errors, status: :unprocessable_entity

data/lib/generators/authentication/templates/controllers/api/sessions_controller.rb.tt

@@ -5,9 +5,9 @@ class SessionsController < ApplicationController
     @<%= singular_table_name %> = <%= class_name %>.find_by_email(params[:email])
 
     if @<%= singular_table_name %>.try(:authenticate, params[:password])
-      render json: { session_token: @<%= singular_table_name %>.session_token }
+      render json: { session_token: @<%= singular_table_name %>.signed_session_token }
     else
-      render json: { error: "Invalid session token" }, status: :unauthorized
+      render json: { error: "Invalid email or password" }, status: :unauthorized
     end
   end
 

data/lib/generators/authentication/templates/controllers/html/emails_controller.rb.tt

@@ -8,9 +8,6 @@ class EmailsController < ApplicationController
     if !@<%= singular_table_name %>.authenticate(params[:current_password])
       redirect_to edit_emails_path, alert: "The current password you entered is incorrect"
     elsif @<%= singular_table_name %>.update(<%= "#{singular_table_name}_params" %>)
-      if @<%= singular_table_name %>.email_previously_changed?
-        EmailMailer.with(email_change: @<%= singular_table_name %>.email_previous_change).changed.deliver_later
-      end
       redirect_to root_path, notice: "Your email has been changed successfully"
     else
       render :edit, status: :unprocessable_entity

data/lib/generators/authentication/templates/controllers/html/password_resets_controller.rb.tt

@@ -1,6 +1,5 @@
 class PasswordResetsController < ApplicationController
   skip_before_action :authenticate
-
   before_action :set_<%= singular_table_name %>, only: %i[ edit update ]
 
   def new
@@ -14,7 +13,7 @@ class PasswordResetsController < ApplicationController
       PasswordMailer.with(<%= singular_table_name %>: @<%= singular_table_name %>).reset.deliver_later
       redirect_to sign_in_path, notice: "You will receive an email with instructions on how to reset your password in a few minutes"
     else
-      redirect_to new_password_resets_path, alert: "The email address doesn't exist in our database"
+      redirect_to new_password_resets_path(email_hint: params[:email]), alert: "The email address doesn't exist in our database"
     end
   end
 
@@ -28,7 +27,7 @@ class PasswordResetsController < ApplicationController
 
   private
     def set_<%= singular_table_name %>
-      @<%= singular_table_name %> = <%= class_name %>.find_signed!(params[:sid], purpose: "password_reset")
+      @<%= singular_table_name %> = <%= class_name %>.find_signed!(params[:token], purpose: "password_reset")
     rescue ActiveSupport::MessageVerifier::InvalidSignature
       redirect_to new_password_resets_path, alert: "Your token has expired, please request a new one"
     end

data/lib/generators/authentication/templates/controllers/html/passwords_controller.rb.tt

@@ -8,7 +8,6 @@ class PasswordsController < ApplicationController
     if !@<%= singular_table_name %>.authenticate(params[:current_password])
       redirect_to edit_passwords_path, alert: "The current password you entered is incorrect"
     elsif @<%= singular_table_name %>.update(<%= "#{singular_table_name}_params" %>)
-      PasswordMailer.with(user: @<%= singular_table_name %>).changed.deliver_later
       redirect_to root_path, notice: "Your password has been changed successfully"
     else
       render :edit, status: :unprocessable_entity

data/lib/generators/authentication/templates/controllers/html/registrations_controller.rb.tt

@@ -9,7 +9,7 @@ class RegistrationsController < ApplicationController
     @<%= singular_table_name %> = <%= class_name %>.new(<%= "#{singular_table_name}_params" %>)
 
     if @<%= singular_table_name %>.save
-      cookies[:session_token] = { value: @<%= singular_table_name %>.session_token, httponly: true }
+      cookies.signed[:session_token] = { value: @<%= singular_table_name %>.session_token, httponly: true }
       redirect_to root_path, notice: "Welcome! You have signed up successfully"
     else
       render :new, status: :unprocessable_entity

data/lib/generators/authentication/templates/controllers/html/sessions_controller.rb.tt

@@ -10,9 +10,9 @@ class SessionsController < ApplicationController
 
     if @<%= singular_table_name %>.try(:authenticate, params[:password])
       if params[:remember_me] == "1"
-        cookies.permanent[:session_token] = { value: @<%= singular_table_name %>.session_token, httponly: true }
+        cookies.signed.permanent[:session_token] = { value: @<%= singular_table_name %>.session_token, httponly: true }
       else
-        cookies[:session_token] = { value: @<%= singular_table_name %>.session_token, httponly: true }
+        cookies.signed[:session_token] = { value: @<%= singular_table_name %>.session_token, httponly: true }
       end
 
       redirect_to root_path, notice: "Signed in successfully"

data/lib/generators/authentication/templates/mailers/email_mailer.rb.tt

@@ -1,6 +1,6 @@
 class EmailMailer < ApplicationMailer
   def changed
-    @previous_email, @current_email = params[:email_change]
+    @previous_email, @current_email = params[:change]
     mail to: @previous_email
   end
 end

data/lib/generators/authentication/templates/models/resource.rb.tt

@@ -6,9 +6,30 @@ class <%= class_name %> < ApplicationRecord
   validates :email, format: { with: /\A[^@\s]+@[^@\s]+\z/ }
   validates_length_of :password, minimum: 8, allow_blank: true
 
-  before_validation { self.email = email.downcase.strip }
+  before_validation do
+    self.email = email.downcase.strip
+  end
 
-  def as_json(options)
-    super(options.merge(except: [:password_digest, :session_token]))
-  end  
+  after_update_commit do
+    if self.email_previously_changed?
+      EmailMailer.with(change: self.email_previous_change).changed.deliver_later
+    end
+  end
+
+  after_update_commit do
+    if self.password_digest_previously_changed?
+      PasswordMailer.with(<%= singular_table_name %>: self).changed.deliver_later
+    end
+  end
+<% if options.api? %>
+  def signed_session_token
+    self.class.signed_id_verifier.generate(session_token)
+  end
+
+  def self.find_signed_session_token(signed_session_token)
+    if session_token = signed_id_verifier.verified(signed_session_token)
+      find_by_session_token(session_token)
+    end
+  end
+<% end -%>
 end

data/lib/generators/authentication/templates/views/password_mailer/reset.html.erb.tt

@@ -2,7 +2,7 @@
 
 <p>Can't remember your password for <strong><%%= params[:<%= singular_table_name %>].email %></strong>? That's OK, it happens. Just hit the link below to set a new one.</p>
 
-<p><%%= link_to "Reset my password", edit_password_resets_url(sid: @signed_id) %></p>
+<p><%%= link_to "Reset my password", edit_password_resets_url(token: @signed_id) %></p>
 
 <p>If you did not request a password reset you can safely ignore this email, it expires in 20 minutes. Only someone with access to this email account can reset your password.</p>
 

data/lib/generators/authentication/templates/views/password_mailer/reset.text.erb.tt

@@ -2,7 +2,7 @@ Hey there,
 
 Can't remember your password for <%%= params[:<%= singular_table_name %>].email %>? That's OK, it happens. Just hit the link below to set a new one.
 
-[Reset my password]<%%= edit_password_resets_url(sid: @signed_id) %>
+[Reset my password]<%%= edit_password_resets_url(token: @signed_id) %>
 
 If you did not request a password reset you can safely ignore this email, it expires in 20 minutes. Only someone with access to this email account can reset your password.
 

data/lib/generators/authentication/templates/views/password_resets/edit.html.erb.tt

@@ -13,7 +13,7 @@
     </div>
   <%% end %>
 
-  <%%= hidden_field_tag :sid, params[:sid] %>
+  <%%= hidden_field_tag :token, params[:token] %>
 
   <div>
     <%%= form.label :password, "New password", style: "display: block" %>

data/lib/generators/authentication/templates/views/password_resets/new.html.erb.tt

@@ -5,7 +5,7 @@
 <%%= form_with(url: password_resets_path) do |form| %>
   <div>
     <%%= form.label :email, style: "display: block" %>
-    <%%= form.email_field :email, autofocus: true, required: true %>
+    <%%= form.email_field :email, value: params[:email_hint], autofocus: true, required: true %>
   </div>
 
   <div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authentication-zero
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.17
 platform: ruby
 authors:
 - Nixon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-17 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: