devise-webauthn 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8083a823cce7edf858475a062ea009193c3a86cf9b4a821db1dd2715430580d4
-  data.tar.gz: df00de569113a642c13f87cc4f6c93836acb5c5df1ef1cecfe492b01247a17aa
+  metadata.gz: bf586d5c54c83dcd4dd18c38e2dfe2c8d16cd86dc90e3c5c09b516d3c60dff04
+  data.tar.gz: 5a56dc38f1bd836b69dae7057f44ba95868b1edbfe5820eab77466ec2db59ffd
 SHA512:
-  metadata.gz: ce764390d121fc68bd1732d655700ccae382ced384a24f350256f2bb633910d0038972637a8e9f4f5e512d0e13030c53851f7288733fb233e8d86fe00ab5c8b8
-  data.tar.gz: d2072d245253437be40005c81b9879f22f0a7c0fa3e0e3cd39b9b03f812aa05cdcd7404cbd4123afac473785364472f3e025dbdf025ae3f74af117854dcbca38
+  metadata.gz: c62d4d71fd255dbf5867c76a524ed2b8e22df167e537e52a928f5a88351291ccb4cc74aef5e0466b27c42242d6b0ab105e67acc2ba9d7cb673625ff0b31100b4
+  data.tar.gz: fefeab5ad1470d5a2eb3f451c823763f237c8fe3f302f46d02917bbf337a0ab3011fc518b209d6105aed7ca23c21cb8ef9621f360a6a980204d3fe28508cf552

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ruby.yml

@@ -8,7 +8,7 @@ jobs:
 
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -69,7 +69,7 @@ jobs:
 
     steps:
     - name: Check out repository code
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - "spec/internal/**/*"
+    - "spec/tmp/**/*"
     - "vendor/**/*"
     - "gemfiles/**/*"
     - "lib/devise/strategies/database_authenticatable.rb"

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## [v0.2.2](https://github.com/cedarcode/devise-webauthn/compare/v0.2.1...v0.2.2/) - 2025-12-11
+
+- Generate webauthn credentials table with not null constraints in attributes that must be present.
+- Update controllers and views generators to generate 2FA-related controllers and views.
+- Add flash messages when removing credentials.
+
 ## [v0.2.1](https://github.com/cedarcode/devise-webauthn/compare/v0.2.0...v0.2.1/) - 2025-12-10
 
 - Add form helpers for security key registration and 2FA authentication.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devise-webauthn (0.2.1)
+    devise-webauthn (0.2.2)
       devise (~> 4.9)
       webauthn (~> 3.0)
 

data/app/controllers/devise/passkeys_controller.rb

@@ -23,7 +23,12 @@ module Devise
     end
 
     def destroy
-      resource.passkeys.destroy(params[:id])
+      if resource.passkeys.destroy(params[:id])
+        set_flash_message! :notice, :passkey_deleted
+      else
+        set_flash_message! :alert, :passkey_deletion_failed, scope: :"devise.failure"
+      end
+
       redirect_to after_update_path
     end
 

data/app/controllers/devise/second_factor_webauthn_credentials_controller.rb

@@ -23,7 +23,12 @@ module Devise
     end
 
     def destroy
-      resource.second_factor_webauthn_credentials.destroy(params[:id])
+      if resource.second_factor_webauthn_credentials.destroy(params[:id])
+        set_flash_message! :notice, :security_key_deleted
+      else
+        set_flash_message! :alert, :security_key_deletion_failed, scope: :"devise.failure"
+      end
+
       redirect_to after_update_path
     end
 

data/config/locales/en.yml

@@ -2,11 +2,15 @@ en:
   devise:
     passkeys:
       passkey_created: "Passkey created successfully."
+      passkey_deleted: "Passkey deleted successfully."
     second_factor_webauthn_credentials:
       security_key_created: "Security Key created successfully."
+      security_key_deleted: "Security Key deleted successfully."
     failure:
       passkey_not_found: "Your passkey doesn't exist or is not valid."
       passkey_verification_failed: "Passkey verification failed."
+      passkey_deletion_failed: "Passkey deletion failed."
+      security_key_deletion_failed: "Security Key deletion failed."
       sign_in_not_initiated: "Sign in was not initiated."
       two_factor_required: "Two-factor authentication is required to sign in."
       webauthn_credential_not_found: "Your WebAuthn credential doesn't exist or is not valid."

data/lib/devise/webauthn/test/authenticator_helpers.rb

@@ -11,6 +11,48 @@ module Devise
           options.resident_key = true
           page.driver.browser.add_virtual_authenticator(options)
         end
+
+        def add_passkey_to_authenticator(authenticator, resource)
+          add_credential_to_authenticator(authenticator, resource, passkey: true)
+        end
+
+        def add_security_key_to_authenticator(authenticator, resource)
+          add_credential_to_authenticator(authenticator, resource, passkey: false)
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
+        def add_credential_to_authenticator(authenticator, resource, passkey:)
+          credential_id = SecureRandom.random_bytes(16)
+          encoded_credential_id = Base64.urlsafe_encode64(credential_id)
+          key = OpenSSL::PKey.generate_key("ED25519")
+          encoded_private_key = Base64.urlsafe_encode64(key.private_to_der)
+
+          cose_public_key = COSE::Key::OKP.from_pkey(OpenSSL::PKey.read(key.public_to_der))
+          cose_public_key.alg = -8
+          encoded_cose_public_key = Base64.urlsafe_encode64(cose_public_key.serialize)
+
+          credential_json = {
+            "credentialId" => encoded_credential_id,
+            "isResidentCredential" => passkey,
+            "rpId" => "localhost",
+            "privateKey" => encoded_private_key,
+            "signCount" => 0
+          }
+          credential_json["userHandle"] = resource.webauthn_id if passkey
+
+          authenticator.add_credential(credential_json)
+
+          resource.webauthn_credentials.create!(
+            name: "My Credential",
+            external_id: Base64.urlsafe_encode64(credential_id, padding: false),
+            public_key: encoded_cose_public_key,
+            sign_count: 0,
+            authentication_factor: passkey ? :first_factor : :second_factor
+          )
+        end
+        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/AbcSize
       end
     end
   end

data/lib/devise/webauthn/version.rb

@@ -2,6 +2,6 @@
 
 module Devise
   module Webauthn
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

data/lib/generators/devise/webauthn/controllers_generator.rb

@@ -5,7 +5,11 @@ require "rails/generators"
 module Devise
   module Webauthn
     class ControllersGenerator < Rails::Generators::Base
-      CONTROLLERS = %w[passkeys].freeze
+      CONTROLLERS = %w[
+        passkeys
+        second_factor_webauthn_credentials
+        two_factor_authentications
+      ].freeze
 
       desc "Create inherited Devise::Webauthn controllers in your app/controllers folder."
 

data/lib/generators/devise/webauthn/templates/controllers/second_factor_webauthn_credentials_controller.rb.tt

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class <%= @scope_prefix %>SecondFactorWebauthnCredentialsController < Devise::SecondFactorWebauthnCredentialsController
+  # GET /resource/second_factor_webauthn_credentials/new
+  # def new
+  #   super
+  # end
+
+  # POST /second_factor_webauthn_credentials/passkeys
+  # def create
+  #   super
+  # end
+
+  # DELETE /resource/second_factor_webauthn_credentials/:id
+  # def destroy
+  #  super
+  # end
+
+  # private
+
+  # Verifies the security key coming in the params and saves it to the database.
+  # def verify_and_save_security_key(security_key_from_params)
+  #   super
+  # end
+
+  # The default url to be used after creating a second factor key. You can overwrite
+  # this method in your own SecondFactorWebauthnCredentialsController.
+  # def after_update_path
+  #   super
+  # end
+end

data/lib/generators/devise/webauthn/templates/controllers/two_factor_authentications_controller.rb.tt

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class <%= @scope_prefix %>TwoFactorAuthenticationsController < Devise::TwoFactorAuthenticationsController
+  # GET /resource/two_factor_authentication/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/two_factor_authentication
+  # def create
+  #   super
+  # end
+end

data/lib/generators/devise/webauthn/views_generator.rb

@@ -22,7 +22,9 @@ module Devise
           end
         else
           view_directory :passkeys
+          view_directory :second_factor_webauthn_credentials
           view_directory :sessions
+          view_directory :two_factor_authentications
         end
       end
 

data/lib/generators/devise/webauthn/webauthn_credential_model/templates/webauthn_credential_migration.rb.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateWebauthnCredentials < ActiveRecord::Migration[<%= Rails.version.to_f %>]
+  def change
+    create_table :webauthn_credentials do |t|
+      t.string :external_id, null: false
+      t.string :name, null: false
+      t.text :public_key, null: false
+      t.integer :sign_count, limit: 8, null: false
+      t.references :<%= user_model_name %>, null: false, foreign_key: true
+      t.integer :authentication_factor, limit: 1, null: false
+
+      t.timestamps
+    end
+    add_index :webauthn_credentials, :external_id, unique: true
+  end
+end

data/lib/generators/devise/webauthn/webauthn_credential_model/webauthn_credential_model_generator.rb

@@ -6,22 +6,28 @@ require "rails/generators/active_record"
 module Devise
   module Webauthn
     class WebauthnCredentialModelGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
       hide!
       namespace "devise:webauthn:webauthn_credential_model"
 
+      source_root File.expand_path("templates", __dir__)
+
       desc "Generate a WebauthnCredential model with the required fields for WebAuthn"
       class_option :resource_name, type: :string, default: "user", desc: "The resource name for Devise (default: user)"
 
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
       def generate_model
-        invoke "active_record:model", [
-          "webauthn_credential",
-          "external_id:string:uniq",
-          "name:string",
-          "public_key:text",
-          "sign_count:integer{8}",
-          "#{user_model_name}:references",
-          "authentication_factor:integer{1}"
-        ]
+        invoke "active_record:model", ["webauthn_credential"], migration: false
+      end
+
+      # TODO: Remove this in favor of strandard model generator with
+      # not null modifier (`!`) once we drop support for Rails < 8.
+      def generate_migration
+        migration_template "webauthn_credential_migration.rb.erb", "db/migrate/create_webauthn_credentials.rb"
       end
 
       def inject_webauthn_credential_content

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise-webauthn
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Cedarcode
@@ -44,6 +44,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
+- ".github/dependabot.yml"
 - ".github/workflows/release.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -95,7 +96,10 @@ files:
 - lib/generators/devise/webauthn/stimulus/templates/webauthn_credentials_controller.js
 - lib/generators/devise/webauthn/templates/controllers/README
 - lib/generators/devise/webauthn/templates/controllers/passkeys_controller.rb.tt
+- lib/generators/devise/webauthn/templates/controllers/second_factor_webauthn_credentials_controller.rb.tt
+- lib/generators/devise/webauthn/templates/controllers/two_factor_authentications_controller.rb.tt
 - lib/generators/devise/webauthn/views_generator.rb
+- lib/generators/devise/webauthn/webauthn_credential_model/templates/webauthn_credential_migration.rb.erb
 - lib/generators/devise/webauthn/webauthn_credential_model/webauthn_credential_model_generator.rb
 - lib/generators/devise/webauthn/webauthn_id/webauthn_id_generator.rb
 homepage: https://github.com/cedarcode/devise-webauthn