active_record-type-encrypted_string 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3cf426153442301ca3ffe61f87330a81afe9ddbc2c4175ed402fc93e31d6e5cc
+  data.tar.gz: 2c9cfdb0aac34be111258c1f92e72c282dcfb60d01a8f853bff86dd6044c9837
+SHA512:
+  metadata.gz: d89b577e3dd2f84846a3bc4dfebba6a561588ae7be531c2a07b49a60455d4e8e0a84e8e6c32f73ed205b3f6be9f18e4252e0e926febf68bc559d934bfb3f26c5
+  data.tar.gz: 4d8d815c73d4bf82f35663bbf3877cee0c5033997a5483531f43c9419fd4c89030c6cd5418a8d72f5db38bfc0e7243238ac764204ca6ab5e067a44d9f9504fa7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Kohei Yamamoto
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# ActiveRecord::Type::EncryptedString
+
+[![Build Status](https://travis-ci.org/kymmt90/active_record-type-encrypted_string.svg?branch=master)](https://travis-ci.org/kymmt90/active_record-type-encrypted_string)
+
+> Provides encrypted string attributes to Active Record models
+
+ActiveRecord::Type::EncryptedString is a subtype of ActiveRecord::Type::String. This gem enables Active Record to encrypt/decrypt string attributes seamlessly.
+
+## Usage
+
+You can try this gem as follows:
+
+```ruby
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'rails'
+  gem 'active_record-type-encrypted_string'
+  gem 'sqlite3'
+end
+
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:',
+)
+
+ActiveRecord::Schema.define do
+  create_table :users do |t|
+    t.string :token
+  end
+end
+
+# Define an string attribute
+class User < ActiveRecord::Base
+  attribute :token, :encrypted_string
+end
+
+# Settings for encryption
+ENV['ENCRYPTED_STRING_PASSWORD'] = 'password'
+ENV['ENCRYPTED_STRING_SALT'] = SecureRandom.random_bytes
+
+# "token" is saved as encrypted string value
+token = 'token'
+user = User.create(token: token)
+ActiveRecord::Base.connection.select_value('SELECT token FROM users') #=> "eVZzbUlXME1xSlZ5ZWZPQnIvY..."
+
+# Get the encrypted value as a decrypted value transparently
+user.token #=> "token"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record-type-encrypted_string'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install active_record-type-encrypted_string
+```
+
+## Configuration
+
+The password and the salt for encryption can be configured through environment variables or class attributes. Environment variables take precedence over class attributes.
+
+```ruby
+ENV['ENCRYPTED_STRING_PASSWORD'] = 'password'
+ENV['ENCRYPTED_STRING_SALT'] = 'salt'
+
+
+ActiveRecord::Type::EncryptedString.encryption_password = 'password'
+ActiveRecord::Type::EncryptedString.encryption_salt = 'salt'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kymmt90/active_record-type-encrypted_string.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecord::Type::EncryptedString'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/active_record/type/encrypted_string.rb

@@ -0,0 +1,44 @@
+require 'active_record/type'
+require 'active_record/type/encrypted_string/railtie'
+require 'active_support/configurable'
+
+module ActiveRecord
+  module Type
+    module EncryptedString
+      include ActiveSupport::Configurable
+
+      config_accessor :encryption_password, :encryption_salt, instance_accessor: false
+
+      class Type < ::ActiveRecord::Type::String
+        def cast(value)
+          value ? message_encryptor.encrypt_and_sign(value) : super
+        end
+
+        def deserialize(value)
+          value ? message_encryptor.decrypt_and_verify(value) : super
+        end
+
+        private
+
+        def message_encryptor
+          @message_encryptor ||=
+            begin
+              key_len = ActiveSupport::MessageEncryptor.key_len
+              key = ActiveSupport::KeyGenerator.new(password).generate_key(salt, key_len)
+              ActiveSupport::MessageEncryptor.new(key)
+            end
+        end
+
+        def password
+          ENV.fetch('ENCRYPTED_STRING_PASSWORD') { ActiveRecord::Type::EncryptedString.encryption_password }
+        end
+
+        def salt
+          ENV.fetch('ENCRYPTED_STRING_SALT') { ActiveRecord::Type::EncryptedString.encryption_salt }
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Type.register :encrypted_string, ActiveRecord::Type::EncryptedString::Type

data/lib/active_record/type/encrypted_string/railtie.rb

@@ -0,0 +1,8 @@
+module ActiveRecord
+  module Type
+    module EncryptedString
+      class Railtie < ::Rails::Railtie
+      end
+    end
+  end
+end

data/lib/active_record/type/encrypted_string/version.rb

@@ -0,0 +1,7 @@
+module ActiveRecord
+  module Type
+    module EncryptedString
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/tasks/active_record/type/encrypted_string_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :active_record_type_encrypted_string do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: active_record-type-encrypted_string
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kohei Yamamoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides encrypted string attributes to Active Record models
+email:
+- kymmt90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/active_record/type/encrypted_string.rb
+- lib/active_record/type/encrypted_string/railtie.rb
+- lib/active_record/type/encrypted_string/version.rb
+- lib/tasks/active_record/type/encrypted_string_tasks.rake
+homepage: https://github.com/kymmt90/active_record-type-encrypted_string
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: ActiveRecord::Type::EncryptedString
+test_files: []