webauthn-rails 0.0.1 → 0.1.1

data/lib/generators/webauthn_authentication/webauthn_authentication_generator.rb

@@ -0,0 +1,184 @@
+require "rails/generators/base"
+require "rails/generators/active_record/migration"
+if Rails.version >= "8.1"
+  require "rails/generators/bundle_helper"
+else
+  require "generators/webauthn_authentication/bundle_helper"
+end
+
+class WebauthnAuthenticationGenerator < ::Rails::Generators::Base
+  include ActiveRecord::Generators::Migration
+  if Rails.version >= "8.1"
+    include Rails::Generators::BundleHelper
+  else
+    include BundleHelper
+  end
+
+  source_root File.expand_path("../templates", __FILE__)
+
+  desc "Injects webauthn files to your application."
+
+  class_option :api, type: :boolean,
+    desc: "Generate API-only files, with no view templates"
+
+  class_option :with_rails_authentication, type: :boolean,
+    desc: "Run the Ruby on Rails authentication generator"
+
+  def invoke_rails_authentication
+    invoke "authentication" if options.with_rails_authentication?
+  end
+
+  def modify_sessions_controller
+    if File.exist?(File.join(destination_root, "app/controllers/sessions_controller.rb"))
+      gsub_file "app/controllers/sessions_controller.rb",
+        /^  def create.*?^  end/m,
+        <<~RUBY.strip_heredoc.indent(2)
+          def create
+            if user = User.authenticate_by(params.permit(:email_address, :password))
+              if user.second_factor_enabled?
+                session[:current_authentication] = { user_id: user.id }
+                redirect_to new_second_factor_authentication_path
+              else
+                start_new_session_for user
+                redirect_to after_authentication_url
+              end
+            else
+              redirect_to new_session_path, alert: "Try another email address or password."
+            end
+          end
+        RUBY
+    else
+      raise Thor::Error, "Could not find app/controllers/sessions_controller.rb. Please make sure the Rails Authentication generator was executed, or pass the --with-rails-authentication option."
+    end
+  end
+
+  def inject_to_authentication_concern
+    inject_into_file "app/controllers/concerns/authentication.rb",
+      after: /def terminate_session.*?end\n/m do
+        <<-RUBY.strip_heredoc.indent(4)
+
+          def require_no_authentication
+            redirect_to root_path if find_session_by_cookie
+          end
+        RUBY
+      end
+  end
+
+  def copy_controllers_and_concerns
+    template "app/controllers/passkeys_controller.rb"
+    template "app/controllers/webauthn_sessions_controller.rb"
+    template "app/controllers/second_factor_authentications_controller.rb"
+    template "app/controllers/second_factor_webauthn_credentials_controller.rb"
+  end
+
+  hook_for :template_engine do |template_engine|
+    invoke template_engine unless options.api?
+  end
+
+  def copy_stimulus_controllers
+    if using_importmap? || using_bun? || has_package_json?
+      template "app/javascript/controllers/webauthn_credentials_controller.js"
+
+      if using_bun? || has_package_json?
+        run "bin/rails stimulus:manifest:update"
+      end
+    else
+      puts "You must either be running with node (package.json) or importmap-rails (config/importmap.rb) to use this gem."
+    end
+  end
+
+  def inject_js_packages
+    if using_importmap?
+      say %(Appending: pin "@github/webauthn-json/browser-ponyfill", to: "https://ga.jspm.io/npm:@github/webauthn-json@2.1.1/dist/esm/webauthn-json.browser-ponyfill.js")
+      append_to_file "config/importmap.rb", %(pin "@github/webauthn-json/browser-ponyfill", to: "https://ga.jspm.io/npm:@github/webauthn-json@2.1.1/dist/esm/webauthn-json.browser-ponyfill.js"\n)
+    elsif using_bun?
+      say "Adding webauthn-json to your package manager"
+      run "bun add @github/webauthn-json/browser-ponyfill"
+    elsif has_package_json?
+      say "Adding webauthn-json to your package manager"
+      run "yarn add @github/webauthn-json/browser-ponyfill"
+    else
+      puts "You must either be running with node (package.json) or importmap-rails (config/importmap.rb) to use this gem."
+    end
+  end
+
+  def inject_webauthn_dependency
+    unless File.read(File.expand_path("Gemfile", destination_root)).include?('gem "webauthn"')
+      bundle_command("add webauthn", {}, quiet: true)
+    end
+  end
+
+  def copy_initializer_file
+    template "config/initializers/webauthn.rb"
+  end
+
+  def inject_webauthn_content
+    generate "migration", "AddWebauthnToUsers", "webauthn_id:string"
+    inject_webauthn_content_to_user_model
+
+    inject_into_file "config/routes.rb", after: "Rails.application.routes.draw do\n" do
+      <<-RUBY.strip_heredoc.indent(2)
+        resource :webauthn_session, only: [ :create, :destroy ] do
+          post :get_options, on: :collection
+        end
+
+        resources :passkeys, only: [ :new, :create, :destroy ] do
+          post :create_options, on: :collection
+        end
+
+        resources :second_factor_webauthn_credentials, only: [ :new, :create, :destroy ] do
+          post :create_options, on: :collection
+        end
+
+        resource :second_factor_authentication, only: [ :new, :create ] do
+          post :get_options, on: :collection
+        end
+      RUBY
+    end
+
+    template "app/models/webauthn_credential.rb"
+    generate "migration", "CreateWebauthnCredentials", "user:references! external_id:string:uniq public_key:string nickname:string sign_count:integer{8} authentication_factor:integer{1}!"
+  end
+
+  hook_for :test_framework
+
+  def final_message
+    say ""
+    say "Almost done! Now edit `config/initializers/webauthn.rb` and set the `allowed_origins` and `rp_name` for your app.", :yellow
+  end
+
+  private
+
+  def using_bun?
+    File.exist?(File.join(destination_root, "bun.config.js"))
+  end
+
+  def using_importmap?
+    File.exist?(File.join(destination_root, "config/importmap.rb"))
+  end
+
+  def has_package_json?
+    File.exist?(File.join(destination_root, "package.json"))
+  end
+
+  def inject_webauthn_content_to_user_model
+    inject_into_file "app/models/user.rb", after: "normalizes :email_address, with: ->(e) { e.strip.downcase }\n"  do
+      <<-RUBY.strip_heredoc.indent(2)
+
+        has_many :webauthn_credentials, dependent: :destroy
+        with_options class_name: "WebauthnCredential" do
+          has_many :second_factor_webauthn_credentials, -> { second_factor }
+          has_many :passkeys, -> { passkey }
+        end
+
+        after_initialize do
+          self.webauthn_id ||= WebAuthn.generate_user_id
+        end
+
+        def second_factor_enabled?
+          webauthn_credentials.any?
+        end
+      RUBY
+    end
+  end
+end

data/lib/tasks/webauthn/rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :webauthn_rails do
+#   # Task goes here
+# end

data/lib/webauthn/rails/version.rb

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
 module Webauthn
   module Rails
-    VERSION = "0.0.1"
+    VERSION = "0.1.1"
   end
 end

data/lib/webauthn/rails.rb

@@ -1,10 +1,6 @@
-# frozen_string_literal: true
-
-require_relative "rails/version"
+require "webauthn/rails/version"
 
 module Webauthn
   module Rails
-    class Error < StandardError; end
-    # Your code goes here...
   end
 end

metadata

@@ -1,35 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: webauthn-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
-- Santiago Rodriguez
-autorequire:
-bindir: exe
+- Cedarcode
+autorequire: 
+bindir: bin
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
-dependencies: []
-description: Authentication for Rails using WebAuthn
+date: 2025-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+description: |-
+  Provides a set of generators that will extend your Rails 8+ application's authentication
+      to enable Passkey usage as first or second factor.
 email:
-- santiago.rodriguez@cedarcode.com
+- webauthn@cedarcode.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- CHANGELOG.md
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
+- lib/generators/erb/webauthn_authentication/templates/app/views/passkeys/new.html.erb.tt
+- lib/generators/erb/webauthn_authentication/templates/app/views/second_factor_authentications/new.html.erb.tt
+- lib/generators/erb/webauthn_authentication/templates/app/views/second_factor_webauthn_credentials/new.html.erb.tt
+- lib/generators/erb/webauthn_authentication/webauthn_authentication_generator.rb
+- lib/generators/test_unit/webauthn_authentication/templates/test/controllers/passkeys_controller_test.rb
+- lib/generators/test_unit/webauthn_authentication/templates/test/controllers/second_factor_authentications_controller_test.rb
+- lib/generators/test_unit/webauthn_authentication/templates/test/controllers/second_factor_webauthn_credentials_controller_test.rb
+- lib/generators/test_unit/webauthn_authentication/templates/test/controllers/webauthn_sessions_controller_test.rb
+- lib/generators/test_unit/webauthn_authentication/templates/test/system/manage_webauthn_credentials_test.rb
+- lib/generators/test_unit/webauthn_authentication/templates/test/test_helpers/virtual_authenticator_test_helper.rb
+- lib/generators/test_unit/webauthn_authentication/webauthn_authentication_generator.rb
+- lib/generators/webauthn_authentication/bundle_helper.rb
+- lib/generators/webauthn_authentication/templates/app/controllers/passkeys_controller.rb
+- lib/generators/webauthn_authentication/templates/app/controllers/second_factor_authentications_controller.rb
+- lib/generators/webauthn_authentication/templates/app/controllers/second_factor_webauthn_credentials_controller.rb
+- lib/generators/webauthn_authentication/templates/app/controllers/webauthn_sessions_controller.rb
+- lib/generators/webauthn_authentication/templates/app/javascript/controllers/webauthn_credentials_controller.js
+- lib/generators/webauthn_authentication/templates/app/models/webauthn_credential.rb
+- lib/generators/webauthn_authentication/templates/config/initializers/webauthn.rb
+- lib/generators/webauthn_authentication/webauthn_authentication_generator.rb
+- lib/tasks/webauthn/rails_tasks.rake
 - lib/webauthn/rails.rb
 - lib/webauthn/rails/version.rb
-- sig/webauthn/rails.rbs
 homepage: https://github.com/cedarcode/webauthn-rails
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/cedarcode/webauthn-rails
+  source_code_uri: https://github.com/cedarcode/webauthn-rails
+  changelog_uri: https://github.com/cedarcode/webauthn-rails/blob/main/CHANGELOG.md
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -37,15 +74,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
-summary: Authentication for Rails using WebAuthn
+summary: Authentication for Rails using Passkeys
 test_files: []

data/.rspec

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

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2024-08-02
-
-- Initial release

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Santiago Rodriguez
-
-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/sig/webauthn/rails.rbs

@@ -1,6 +0,0 @@
-module Webauthn
-  module Rails
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-  end
-end