devise_encryptable_aes 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84f8fef8ce7fd3ef5539d997cc6c21551a9b9d01cc5acd606ea20d2641ab37d7
-  data.tar.gz: ed56e0faa102cce47afb928a0359df772fa63e762472096e8b2cdc44267f4823
+  metadata.gz: 1c9e5f608fcfe59dff0a29a1f5ce2bbb04c744b1ff9d382182e9e7457ce8a1c5
+  data.tar.gz: 39ae7fd53d95e91f6dbceb465d20212a381d719dfb94f937e6961e2d87edd5fb
 SHA512:
-  metadata.gz: f1477b1b5ab0dbb1b5616211e18d5c03482ab2a829bdabfc04cddf7f1d53a3f05784ea6cd88172be2b6b1fea66e8dec4faa1546a97cc2d5d0bf193690e1b812a
-  data.tar.gz: a9f458c109d64d7b5fe9635226a7114d5b1b527f92e80e5cc1ac382e88346eb31def8c424b25943eced58dead2b16e10ca05d6ca0ff50dca0d36b038c1a8e44d
+  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)
+```

data/lib/devise/encryptable/encryptors/aes256.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'aes'
+require 'devise/encryptable/encryptors/base'
+
+module Devise
+  module Encryptable
+    module Encryptors
+      class Aes256 < Base
+        class << self
+          def digest(password, _stretches, salt, pepper)
+            ::AES.encrypt(password, pepper, { iv: salt }) if password
+          rescue StandardError
+            nil
+          end
+
+          def salt(_stretches)
+            ::AES.iv(:base_64)
+          end
+
+          def decrypt(encrypted_password, pepper)
+            ::AES.decrypt(encrypted_password, pepper)
+          end
+
+          def compare(encrypted_password, password, pepper)
+            return false if encrypted_password.blank?
+
+            decrypt(encrypted_password, pepper) == password
+          end
+        end
+      end
+    end
+  end
+end

data/lib/devise_encryptable_aes.rb

@@ -1,7 +1,3 @@
 # frozen_string_literal: true
 
-class DeviseEncryptableAes
-  def self.hi
-    puts "Hello world!"
-  end
-end
+require 'devise/encryptable/encryptors/aes256'

metadata

@@ -1,23 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: devise_encryptable_aes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  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: []
-description: A simple hello world gem
+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://rubygems.org/gems/devise_encryptable_aes
+homepage: https://github.com/tatdat97dhbkhn/devise_encryptable_aes
 licenses:
 - MIT
 metadata: {}
@@ -39,5 +83,5 @@ requirements: []
 rubygems_version: 3.4.9
 signing_key: 
 specification_version: 4
-summary: Devise encryptable aes!
+summary: Add AES encryption support for Devise
 test_files: []