aikotoba 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0d639e691f230c3bcb02686f18ecef8dab6a4fecf9310121c8e581a4079ab62
-  data.tar.gz: 169419bd1301489504a2d1049ee9f1c939432b95b0b6eea33df195b43bee0c6d
+  metadata.gz: 173aca2780a3086a9276f56c4bd59a1c4aedb6aa2a8f2d3e29068f00e8a5f417
+  data.tar.gz: d96bea3b841912e7586c07a984e58c6b0daea49109a3b73bc3cc90090cf7434f
 SHA512:
-  metadata.gz: 3bae2cfbf6a1ccacc972abf66057b83b85261ac642800a563ea81b416d83f19f154049d5c9ccc8af0fa6d49c31eec38a0a19cdf3e9ffcd1920e556f02941d0f4
-  data.tar.gz: 347e3fbde3a2af2a02828faabebd94ca67adfe1c71e97f93c7c42e1ab2d83ee6bdee3df30ad5af7d760509f0d41b1f82fedbe9981423c2bec52fbc8ffa9122aa
+  metadata.gz: 050d2f984527212f1a0426fd830c0b0ae1dfff51ea3e75fda1a5596cc702175996f70c3bbf1ca9acf6b21ea2099863ee5dfa705654db8ad338053ce384aeb635
+  data.tar.gz: 7efcedd94cb09d06f9d846d6d43931ded9eb243dd7625f5a6ab74a41682082ca2d2b4c00feb27a1c282006ab04e44b70086d7024554ac4fe7e73cae273369f93

data/README.md

@@ -226,7 +226,7 @@ Rails.application.config.to_prepare do
 end
 
 class Profile < ApplicationRecord
-  has_one :account, class_name: 'Aikotoba::Account'
+  has_one :account, class_name: 'Aikotoba::Account', as: :authenticate_target
 end
 
 current_account.profile #=> Profile instance

data/app/models/aikotoba/account/confirmation_token.rb

@@ -10,7 +10,7 @@ module Aikotoba
     scope :active, ->(now: Time.current) { where("expired_at >= ?", now) }
 
     after_initialize do |record|
-      token = Account::Value::Token.new(extipry: Aikotoba.confirmation_token_expiry)
+      token = Account::Token.new(extipry: Aikotoba.confirmation_token_expiry)
       record.token ||= token.value
       record.expired_at ||= token.expired_at
     end

data/app/models/aikotoba/account/password/argon2.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "argon2"
+
+module Aikotoba
+  class Account::Password::Argon2
+    def initialize(password:)
+      @password = password
+    end
+
+    def verify_password?(digest)
+      Argon2::Password.verify_password(@password, digest)
+    rescue Argon2::ArgonHashFail # NOTE: If an invalid digest is passed, consider it a mismatch.
+      false
+    end
+
+    def generate_hash
+      # NOTE: Adjusted to be OWASAP's recommended value by default.
+      # > Use Argon2id with a minimum configuration of 15 MiB of memory, an iteration count of 2, and 1 degree of parallelism.
+      # > https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#introduction
+      argon = Argon2::Password.new(t_cost: 2, m_cost: 14, p_cost: 1)
+      argon.create(@password)
+    end
+  end
+end

data/app/models/aikotoba/account/password.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Aikotoba
+  class Account::Password
+    LENGTH_RENGE = Aikotoba.password_length_range
+
+    def initialize(
+      value:,
+      pepper: Aikotoba.password_pepper,
+      algorithm_class: Argon2
+    )
+      @value = value
+      @pepper = pepper
+      @algorithm = algorithm_class.new(password: password_with_pepper(@value))
+    end
+
+    attr_reader :value
+
+    def match?(digest:)
+      @algorithm.verify_password?(digest)
+    end
+
+    def digest
+      return "" if value.blank?
+      @algorithm.generate_hash
+    end
+
+    private
+
+    def password_with_pepper(password)
+      "#{password}-#{@pepper}"
+    end
+  end
+end

data/app/models/aikotoba/account/recovery_token.rb

@@ -10,7 +10,7 @@ module Aikotoba
     scope :active, ->(now: Time.current) { where("expired_at >= ?", now) }
 
     after_initialize do |record|
-      token = Account::Value::Token.new(extipry: Aikotoba.recovery_token_expiry)
+      token = Account::Token.new(extipry: Aikotoba.recovery_token_expiry)
       record.token ||= token.value
       record.expired_at ||= token.expired_at
     end

data/app/models/aikotoba/account/service/authentication.rb

@@ -6,12 +6,17 @@ module Aikotoba
       new(email: email, password: password).call!
     end
 
-    def initialize(email:, password:)
-      @account_class = Account
-      @lock_service = Account::Service::Lock
-      @lockable = @account_class.lockable?
+    def initialize(email:, password:,
+      account_class: Account,
+      lock_service: Account::Service::Lock,
+      lockable: Account.lockable?,
+      prevent_timing_atack: Aikotoba.prevent_timing_atack)
+      @account_class = account_class
+      @lock_service = lock_service
+      @lockable = lockable
       @email = email
       @password = password
+      @aikotoba_prevent_timing_atack = prevent_timing_atack
     end
 
     def call!
@@ -29,16 +34,12 @@ module Aikotoba
 
     # NOTE: Verify passwords even when accounts are not found to prevent timing attacks.
     def prevent_timing_atack
-      return true unless aikotoba_prevent_timing_atack
+      return true unless @aikotoba_prevent_timing_atack
       account = @account_class.build_by(attributes: {email: @email, password: @password})
       account.password_match?(@password)
       true
     end
 
-    def aikotoba_prevent_timing_atack
-      Aikotoba.prevent_timing_atack
-    end
-
     def success_callback(account)
       account.authentication_success!
     end

data/app/models/aikotoba/account/service/registration.rb

@@ -6,10 +6,10 @@ module Aikotoba
       new.call!(account: account)
     end
 
-    def initialize
-      @account_class = Account
-      @confirm_service = Account::Service::Confirmation
-      @confirmable = @account_class.confirmable?
+    def initialize(account_class: Account, confirm_service: Account::Service::Confirmation, confirmable: Account.confirmable?)
+      @account_class = account_class
+      @confirm_service = confirm_service
+      @confirmable = confirmable
     end
 
     def call!(account:)

data/app/models/aikotoba/account/{value/token.rb → token.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Aikotoba
-  class Account::Value::Token
+  class Account::Token
     def initialize(extipry:)
       @value = build_token
       @expired_at = extipry.since

data/app/models/aikotoba/account/unlock_token.rb

@@ -10,7 +10,7 @@ module Aikotoba
     scope :active, ->(now: Time.current) { where("expired_at >= ?", now) }
 
     after_initialize do |record|
-      token = Account::Value::Token.new(extipry: Aikotoba.unlock_token_expiry)
+      token = Account::Token.new(extipry: Aikotoba.unlock_token_expiry)
       record.token ||= token.value
       record.expired_at ||= token.expired_at
     end

data/app/models/aikotoba/account.rb

@@ -13,7 +13,7 @@ module Aikotoba
     attribute :max_failed_attempts, :integer, default: -> { Aikotoba.max_failed_attempts }
 
     validates :email, presence: true, uniqueness: true, format: EMAIL_REGEXP, length: {maximum: EMAIL_MAXIMUM_LENGTH}
-    validates :password, presence: true, length: {in: Value::Password::LENGTH_RENGE}, on: [:create, :recover]
+    validates :password, presence: true, length: {in: Password::LENGTH_RENGE}, on: [:create, :recover]
     validates :password_digest, presence: true
     validates :confirmed, inclusion: [true, false]
     validates :failed_attempts, presence: true, numericality: {only_integer: true, greater_than_or_equal_to: 0}
@@ -30,7 +30,7 @@ module Aikotoba
     attr_reader :password
 
     def password=(value)
-      new_password = Value::Password.new(value: value)
+      new_password = Password.new(value: value)
       @password = new_password.value
       assign_attributes(password_digest: new_password.digest)
     end
@@ -53,7 +53,7 @@ module Aikotoba
       end
 
       def password_match?(password)
-        Value::Password.new(value: password).match?(digest: password_digest)
+        Password.new(value: password).match?(digest: password_digest)
       end
 
       def authentication_failed!

data/lib/aikotoba/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Aikotoba
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aikotoba
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Madogiwa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -61,15 +61,16 @@ files:
 - app/mailers/aikotoba/application_mailer.rb
 - app/models/aikotoba/account.rb
 - app/models/aikotoba/account/confirmation_token.rb
+- app/models/aikotoba/account/password.rb
+- app/models/aikotoba/account/password/argon2.rb
 - app/models/aikotoba/account/recovery_token.rb
 - app/models/aikotoba/account/service/authentication.rb
 - app/models/aikotoba/account/service/confirmation.rb
 - app/models/aikotoba/account/service/lock.rb
 - app/models/aikotoba/account/service/recovery.rb
 - app/models/aikotoba/account/service/registration.rb
+- app/models/aikotoba/account/token.rb
 - app/models/aikotoba/account/unlock_token.rb
-- app/models/aikotoba/account/value/password.rb
-- app/models/aikotoba/account/value/token.rb
 - app/models/concerns/aikotoba/enabled_feature_checkable.rb
 - app/models/concerns/aikotoba/token_encryptable.rb
 - app/views/aikotoba/account_mailer/confirm.html.erb
@@ -120,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Aikotoba is a Rails engine that makes it easy to implement simple email and

data/app/models/aikotoba/account/value/password.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require "argon2"
-
-module Aikotoba
-  class Account::Value::Password
-    LENGTH_RENGE = Aikotoba.password_length_range
-
-    def initialize(
-      value:,
-      pepper: Aikotoba.password_pepper
-    )
-      @value = value
-      @pepper = pepper
-    end
-
-    attr_reader :value
-
-    def match?(digest:)
-      verify_password?(password_with_pepper(value), digest)
-    end
-
-    def digest
-      return "" if value.blank?
-      generate_hash(password_with_pepper(value))
-    end
-
-    private
-
-    def verify_password?(password, digest)
-      Argon2::Password.verify_password(password, digest)
-    rescue Argon2::ArgonHashFail # NOTE: If an invalid digest is passed, consider it a mismatch.
-      false
-    end
-
-    def password_with_pepper(password)
-      "#{password}-#{@pepper}"
-    end
-
-    def generate_hash(password)
-      # NOTE: Adjusted to be OWASAP's recommended value by default.
-      # > Use Argon2id with a minimum configuration of 15 MiB of memory, an iteration count of 2, and 1 degree of parallelism.
-      # > https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#introduction
-      argon = Argon2::Password.new(t_cost: 2, m_cost: 14, p_cost: 1)
-      argon.create(password)
-    end
-  end
-end