authentication-zero 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ace4c68009deb2e2a34a3320b53ee2c319d795efd0e22256164b27b774c10df
-  data.tar.gz: c54f843f81f32b9ad20876c6bc2a2aa6417cd493dfeeab67f30606d501c5e776
+  metadata.gz: 60cf049a1db63ab5db00eae68715cb06a09e9a7901453050c44193ea0fa2c3ef
+  data.tar.gz: 0e4373e8deb0556129a6aa8dc07222dcff48f5e79c156120c9e1fc90ac9444a5
 SHA512:
-  metadata.gz: 51bea8df73af396e6aeff95c9d89649cec269a753b7e025efbde2ec4c1479b5083a275da54e68206b94a6589e9f86577f97a602bda02f424c2d610dc8d00c916
-  data.tar.gz: 7a779d25f193d024d466ced745649968e50b4cd54fd17a85cffa2cc47f3aec61ef46ba245ec1dc8b728a1d1b52713f108586e99779e77f5ecec0c895bddb300f
+  metadata.gz: 9168e4d6d3aa6873a56dab1cdb2b53f1640f71de184b73041430c4ee64e804eacc4e853ddc768d7be8189db41f4bdc69f66c3be61bc903adff40fbb491a38dad
+  data.tar.gz: 5f96ab18052f21ac747ed35edd5c9f2afec612c423bac8626a8eaf05970e78d782af567b3d9c831787ecb2d77c9eb823e604cb7b639a560df630aeac6193ac5e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Authentication Zero 2.7.0 (March 2, 2022) ##
+
+* Implemented omniauth
+
 ## Authentication Zero 2.6.0 (March 1, 2022) ##
 
 * Implemented ratelimit

data/Gemfile.lock

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

data/README.md

@@ -11,12 +11,13 @@ The purpose of authentication zero is to generate a pre-built authentication sys
 - Checks if a password has been found in any data breach (--pwned)
 - Authentication by cookie
 - Authentication by token (--api)
+- Social Login with OmniAuth (--omniauth)
 - Ask password before sensitive data changes, aka: sudo
 - Reset the user password and send reset instructions
 - Reset the user password only from verified emails
 - Lock sending reset password email after many attempts (--lockable)
 - Rate limiting for your app, 1000 reqs/hour (--ratelimit)
-- Send e-mail notification when your email has been changed
+- Send e-mail confirmation when your email has been changed
 - Send e-mail notification when someone has logged into your account
 - Manage multiple sessions & devices
 - Cancel my account

data/lib/authentication_zero/version.rb

@@ -1,3 +1,3 @@
 module AuthenticationZero
-  VERSION = "2.6.0"
+  VERSION = "2.7.0"
 end

data/lib/generators/authentication/authentication_generator.rb

@@ -7,6 +7,7 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
   class_option :pwned,     type: :boolean, desc: "Add pwned password validation"
   class_option :lockable,  type: :boolean, desc: "Add password reset locking"
   class_option :ratelimit, type: :boolean, desc: "Add request rate limiting"
+  class_option :omniauth,  type: :boolean, desc: "Add social login support"
 
   source_root File.expand_path("templates", __dir__)
 
@@ -14,18 +15,30 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
     uncomment_lines "Gemfile", /"bcrypt"/
     uncomment_lines "Gemfile", /"redis"/  if options.lockable?
     uncomment_lines "Gemfile", /"kredis"/ if options.lockable?
-    gem "pwned", comment: "Use Pwned to check if a password has been found in any of the huge data breaches [https://github.com/philnash/pwned]" if options.pwned?
-    gem "rack-ratelimit", group: :production, comment: "Use Rack::Ratelimit to rate limit requests" if options.ratelimit?
+
+    if options.pwned?
+      gem "pwned", comment: "Use Pwned to check if a password has been found in any of the huge data breaches [https://github.com/philnash/pwned]"
+    end
+
+    if options.ratelimit?
+      gem "rack-ratelimit", group: :production, comment: "Use Rack::Ratelimit to rate limit requests [https://github.com/jeremy/rack-ratelimit]"
+    end
+
+    if omniauth?
+      gem "omniauth", comment: "Use OmniAuth to support multi-provider authentication [https://github.com/omniauth/omniauth]"
+      gem "omniauth-rails_csrf_protection", comment: "Provides a mitigation against CVE-2015-9284 [https://github.com/cookpad/omniauth-rails_csrf_protection]"
+    end
   end
 
   def create_configuration_files
      copy_file "config/redis/shared.yml", "config/redis/shared.yml" if options.lockable?
+     copy_file "config/initializers/omniauth.rb", "config/initializers/omniauth.rb" if omniauth?
   end
 
   def add_environment_configurations
      ratelimit_code = <<~CODE
       # Rate limit general requests by IP address in a rate of 1000 requests per hour
-      config.middleware.use(Rack::Ratelimit, name: "General", rate: [1000, 1.hour], logger: Rails.logger, redis: Redis.new) { |env| ActionDispatch::Request.new(env).ip }
+      config.middleware.use(Rack::Ratelimit, name: "General", rate: [1000, 1.hour], redis: Redis.new, logger: Rails.logger) { |env| ActionDispatch::Request.new(env).ip }
     CODE
 
     environment ratelimit_code, env: "production" if options.ratelimit?
@@ -34,6 +47,7 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
   def create_migrations
     migration_template "migrations/create_table_migration.rb", "#{db_migrate_path}/create_#{table_name}.rb"
     migration_template "migrations/create_sessions_migration.rb", "#{db_migrate_path}/create_sessions.rb"
+    migration_template "migrations/add_omniauth_migration.rb", "#{db_migrate_path}/add_omniauth_to_#{table_name}.rb" if omniauth?
   end
 
   def create_models
@@ -92,6 +106,7 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
 
   def create_controllers
     directory "controllers/#{format_folder}", "app/controllers"
+    directory "controllers/omniauth", "app/controllers" if omniauth?
   end
 
   def create_views
@@ -108,6 +123,12 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
   end
 
   def add_routes
+    if omniauth?
+      route "post '/auth/:provider/callback', to: 'omniauth_sessions#create'"
+      route "get '/auth/:provider/callback', to: 'omniauth_sessions#create'"
+      route "get '/auth/failure', to: 'omniauth_sessions#failure'"
+    end
+
     route "resource :sudo, only: [:new, :create]"
     route "resource :registration, only: :destroy"
     route "resource :password_reset, only: [:new, :edit, :create, :update]"
@@ -130,4 +151,8 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
     def format_folder
       options.api? ? "api" : "html"
     end
+
+    def omniauth?
+      options.omniauth? && !options.api?
+    end
 end

data/lib/generators/authentication/templates/config/initializers/omniauth.rb

@@ -0,0 +1,3 @@
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :developer unless Rails.env.production? # You should replace it with your provider
+end

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

@@ -25,8 +25,7 @@ class SessionsController < ApplicationController
   end
 
   def destroy
-    @session.destroy
-    redirect_to sessions_path, notice: "That session has been logged out"
+    @session.destroy; redirect_to(sessions_path, notice: "That session has been logged out")
   end
 
   private

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

@@ -5,7 +5,11 @@ class SudosController < ApplicationController
   def create
     session = Current.session
 
+<% if options.omniauth? -%>
+    if session.<%= singular_table_name %>.authenticate(params[:password]) || session.<%= singular_table_name %>.provider
+<% else -%>
     if session.<%= singular_table_name %>.authenticate(params[:password])
+<% end -%>
       session.update!(sudo_at: Time.current); redirect_to(params[:proceed_to_url])
     else
       redirect_to new_sudo_path(proceed_to_url: params[:proceed_to_url]), alert: "The password you entered is incorrect"

data/lib/generators/authentication/templates/controllers/omniauth/omniauth_sessions_controller.rb.tt

@@ -0,0 +1,38 @@
+class OmniauthSessionsController < ApplicationController
+  skip_before_action :verify_authenticity_token
+  skip_before_action :authenticate
+
+  def create
+    @<%= singular_table_name %> = <%= class_name %>.where(omniauth_params).first_or_initialize(<%= "#{singular_table_name}_params" %>)
+
+    if @<%= singular_table_name %>.save
+      session = @<%= singular_table_name %>.sessions.create!(session_params)
+      cookies.signed.permanent[:session_token] = { value: session.id, httponly: true }
+
+      redirect_to root_path, notice: "Signed in successfully"
+    else
+      redirect_to sign_in_path, alert: "Authentication failed"
+    end
+  end
+
+  def failure
+    redirect_to sign_in_path, alert: params[:message]
+  end
+
+  private
+    def omniauth_params
+      { provider: omniauth.provider, uid: omniauth.uid }
+    end
+
+    def <%= "#{singular_table_name}_params" %>
+      { email: omniauth.info.email, password: SecureRandom::base58, verified: true }
+    end
+
+    def session_params
+      { user_agent: request.user_agent, ip_address: request.remote_ip, sudo_at: Time.current }
+    end
+
+    def omniauth
+      request.env["omniauth.auth"]
+    end
+end

data/lib/generators/authentication/templates/erb/sessions/new.html.erb.tt

@@ -18,6 +18,11 @@
     <%%= form.submit "Sign in" %>
   </div>
 <%% end %>
+<% if options.omniauth? %>
+<div>
+  <%%= button_to "Sign in with OmniAuth", "/auth/developer", "data-turbo" => false %>
+</div>
+<% end -%>
 
 <br>
 

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

@@ -8,7 +8,7 @@ class IdentityMailer < ApplicationMailer
 
   def email_verify_confirmation
     @<%= singular_table_name %> = params[:<%= singular_table_name %>]
-    @signed_id = @<%= singular_table_name %>.signed_id(purpose: @<%= singular_table_name %>.email, expires_in: 3.days)
+    @signed_id = @<%= singular_table_name %>.signed_id(purpose: @<%= singular_table_name %>.email, expires_in: 2.days)
 
     mail to: @<%= singular_table_name %>.email, subject: "Verify your email"
   end

data/lib/generators/authentication/templates/migrations/add_omniauth_migration.rb.tt

@@ -0,0 +1,8 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    add_column :<%= table_name %>, :provider, :string
+    add_column :<%= table_name %>, :uid, :string
+  end
+
+  add_index :<%= table_name %>, [:provider, :uid], unique: true
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authentication-zero
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Nixon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-03-02 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -32,6 +32,7 @@ files:
 - lib/authentication_zero/version.rb
 - lib/generators/authentication/USAGE
 - lib/generators/authentication/authentication_generator.rb
+- lib/generators/authentication/templates/config/initializers/omniauth.rb
 - lib/generators/authentication/templates/config/redis/shared.yml
 - lib/generators/authentication/templates/controllers/api/email_verifications_controller.rb.tt
 - lib/generators/authentication/templates/controllers/api/emails_controller.rb.tt
@@ -47,6 +48,7 @@ files:
 - lib/generators/authentication/templates/controllers/html/registrations_controller.rb.tt
 - lib/generators/authentication/templates/controllers/html/sessions_controller.rb.tt
 - lib/generators/authentication/templates/controllers/html/sudos_controller.rb.tt
+- lib/generators/authentication/templates/controllers/omniauth/omniauth_sessions_controller.rb.tt
 - lib/generators/authentication/templates/erb/emails/edit.html.erb.tt
 - lib/generators/authentication/templates/erb/identity_mailer/email_verify_confirmation.html.erb.tt
 - lib/generators/authentication/templates/erb/identity_mailer/email_verify_confirmation.text.erb.tt
@@ -63,6 +65,7 @@ files:
 - lib/generators/authentication/templates/erb/sudos/new.html.erb.tt
 - lib/generators/authentication/templates/mailers/identity_mailer.rb.tt
 - lib/generators/authentication/templates/mailers/session_mailer.rb.tt
+- lib/generators/authentication/templates/migrations/add_omniauth_migration.rb.tt
 - lib/generators/authentication/templates/migrations/create_sessions_migration.rb.tt
 - lib/generators/authentication/templates/migrations/create_table_migration.rb.tt
 - lib/generators/authentication/templates/models/current.rb.tt