devise_encryptable_aes 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0d9a32775fffbb8f09338f8c710b7fd4a35016d0bb6a54c62c54601873dc4ef
-  data.tar.gz: 7389a7a3d98e9e4a7ed346a6d04743ba887d382765eeb0e682e4e31ff62d0a5e
+  metadata.gz: 1c9e5f608fcfe59dff0a29a1f5ce2bbb04c744b1ff9d382182e9e7457ce8a1c5
+  data.tar.gz: 39ae7fd53d95e91f6dbceb465d20212a381d719dfb94f937e6961e2d87edd5fb
 SHA512:
-  metadata.gz: 783ca4cae910bae57248e20a5ed5007c59335c1486e5b7a2a9ca4145e450987c21e11990eed015a18c26bfc188a67cd7fd1343a03df5fc42c7d4bbbe68c48f28
-  data.tar.gz: f554575575ed449fa7dbffca2c82e0cafc41b9158d3743907961f1e1c41250ddd26b7711fab5f8605c4a30736d3ee69f6fa199db76a4b9286213a570a3aaca7b
+  metadata.gz: 85d2cd0742d4d6f679d170f8ca8f1f96737cdb6f6b32eabf841cabfa2041a0e683bdb42110c60f87e551dcf417756ef907695f70ebebbf7d5110c73ed30156fc
+  data.tar.gz: 93ae280af08f5bf95554c7efa870a241fae8ea2496506481a2a0a77f67295f193f8bd2c48cc91d00a176de3ca4108464effbb7b6fb79e680c2bf3f7a08346720

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'
+```
+
+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)
+```

metadata

@@ -1,21 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: devise_encryptable_aes
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 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: 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: 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-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: []
 files:
+- README.md
 - lib/devise/encryptable/encryptors/aes256.rb
 - lib/devise_encryptable_aes.rb
 homepage: https://github.com/tatdat97dhbkhn/devise_encryptable_aes