devise_encryptable_aes 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0d9a32775fffbb8f09338f8c710b7fd4a35016d0bb6a54c62c54601873dc4ef
-  data.tar.gz: 7389a7a3d98e9e4a7ed346a6d04743ba887d382765eeb0e682e4e31ff62d0a5e
+  metadata.gz: 73707f8eb057dc56901d15fdd6c83bc4552437944d2e87a5f71b5cd28c84bda7
+  data.tar.gz: 67e40e826e4d3c29abb3d264fafe799e8e0e6e83190daf388189fe2da10ec0fe
 SHA512:
-  metadata.gz: 783ca4cae910bae57248e20a5ed5007c59335c1486e5b7a2a9ca4145e450987c21e11990eed015a18c26bfc188a67cd7fd1343a03df5fc42c7d4bbbe68c48f28
-  data.tar.gz: f554575575ed449fa7dbffca2c82e0cafc41b9158d3743907961f1e1c41250ddd26b7711fab5f8605c4a30736d3ee69f6fa199db76a4b9286213a570a3aaca7b
+  metadata.gz: 38f3731638b1a122a66335a7d965ba7a46cb7e56fe5fc9d10992eded4088fef7748f2a0e8dfc8e6ac4057ec147069d42bfdcda1cfc9064917f63b87b9a1b8882
+  data.tar.gz: 93ae3764e0409037c68961016ff850919f92452275436021ec568bdfb25dbd66c00762f8e7c8d57137557f10d9fe6e83d40150bc747310540613d64a8d9ce6a2

data/README.md

@@ -0,0 +1,63 @@
+# Devise Encryptable AES
+
+Add AES encryption support for Devise
+
+## Table of Contents
+
+- [Getting started](#getting-started)
+- [Configuration](#configuration)
+- [Usage](#usage)
+
+## Getting started
+
+Add the following line to your Gemfile:
+
+```ruby
+gem 'devise', '~> 4.9'
+gem 'devise_encryptable_aes', '~> 0.2.0'
+```
+
+Then run `bundle install`
+
+## Configuration
+
+Add the `encryptable` module to your model:
+
+```ruby
+class User < ActiveRecord::Base
+  devise :database_authenticatable, :encryptable
+end
+```
+
+And add the `password_salt` field to the database through a migration:
+
+```ruby
+class DeviseCreateUsers < ActiveRecord::Migration
+  def change
+    add_column :users, :password_salt, :string
+  end
+end
+```
+
+Enable the AES encryptor in <tt>config/initializers/devise.rb</tt>
+
+```ruby
+# Uncomment the generated pepper
+config.pepper = "long random string"
+# Enable the AES encryptor
+config.encryptor = :aes256
+```
+
+## Usage
+
+Compare password
+
+```ruby
+::Devise::Encryptable::Encryptors::Aes256.compare(encrypted_password, password, Devise.pepper)
+```
+
+Decrypt password
+
+```ruby
+::Devise::Encryptable::Encryptors::Aes256.decrypt(encrypted_password, Devise.pepper)
+```

data/lib/{devise/encryptable/encryptors → devise_encryptable_aes}/aes256.rb

@@ -6,6 +6,7 @@ require 'devise/encryptable/encryptors/base'
 module Devise
   module Encryptable
     module Encryptors
+      # Add AES encryption support for Devise
       class Aes256 < Base
         class << self
           def digest(password, _stretches, salt, pepper)

data/lib/devise_encryptable_aes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DeviseEncryptableAes
+  VERSION = '0.0.4'
+end

data/lib/devise_encryptable_aes.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'devise/encryptable/encryptors/aes256'
+require 'devise_encryptable_aes/aes256'

metadata

@@ -1,23 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: devise_encryptable_aes
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Pham Tat Dat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
-dependencies: []
+date: 2023-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
+- !ruby/object:Gem::Dependency
+  name: devise-encryptable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: ''
 email: tatdat97dhbkhn@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
-- lib/devise/encryptable/encryptors/aes256.rb
+- README.md
 - lib/devise_encryptable_aes.rb
+- lib/devise_encryptable_aes/aes256.rb
+- lib/devise_encryptable_aes/version.rb
 homepage: https://github.com/tatdat97dhbkhn/devise_encryptable_aes
 licenses:
 - MIT