active_record-type-encrypted_string 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/MIT-LICENSE +20 -0
- data/README.md +93 -0
- data/Rakefile +27 -0
- data/lib/active_record/type/encrypted_string.rb +44 -0
- data/lib/active_record/type/encrypted_string/railtie.rb +8 -0
- data/lib/active_record/type/encrypted_string/version.rb +7 -0
- data/lib/tasks/active_record/type/encrypted_string_tasks.rake +4 -0
- metadata +78 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 3cf426153442301ca3ffe61f87330a81afe9ddbc2c4175ed402fc93e31d6e5cc
|
4
|
+
data.tar.gz: 2c9cfdb0aac34be111258c1f92e72c282dcfb60d01a8f853bff86dd6044c9837
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d89b577e3dd2f84846a3bc4dfebba6a561588ae7be531c2a07b49a60455d4e8e0a84e8e6c32f73ed205b3f6be9f18e4252e0e926febf68bc559d934bfb3f26c5
|
7
|
+
data.tar.gz: 4d8d815c73d4bf82f35663bbf3877cee0c5033997a5483531f43c9419fd4c89030c6cd5418a8d72f5db38bfc0e7243238ac764204ca6ab5e067a44d9f9504fa7
|
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright 2019 Kohei Yamamoto
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,93 @@
|
|
1
|
+
# ActiveRecord::Type::EncryptedString
|
2
|
+
|
3
|
+
[![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)
|
4
|
+
|
5
|
+
> Provides encrypted string attributes to Active Record models
|
6
|
+
|
7
|
+
ActiveRecord::Type::EncryptedString is a subtype of ActiveRecord::Type::String. This gem enables Active Record to encrypt/decrypt string attributes seamlessly.
|
8
|
+
|
9
|
+
## Usage
|
10
|
+
|
11
|
+
You can try this gem as follows:
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'bundler/inline'
|
15
|
+
|
16
|
+
gemfile do
|
17
|
+
source 'https://rubygems.org'
|
18
|
+
gem 'rails'
|
19
|
+
gem 'active_record-type-encrypted_string'
|
20
|
+
gem 'sqlite3'
|
21
|
+
end
|
22
|
+
|
23
|
+
require 'active_record'
|
24
|
+
|
25
|
+
ActiveRecord::Base.establish_connection(
|
26
|
+
adapter: 'sqlite3',
|
27
|
+
database: ':memory:',
|
28
|
+
)
|
29
|
+
|
30
|
+
ActiveRecord::Schema.define do
|
31
|
+
create_table :users do |t|
|
32
|
+
t.string :token
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
# Define an string attribute
|
37
|
+
class User < ActiveRecord::Base
|
38
|
+
attribute :token, :encrypted_string
|
39
|
+
end
|
40
|
+
|
41
|
+
# Settings for encryption
|
42
|
+
ENV['ENCRYPTED_STRING_PASSWORD'] = 'password'
|
43
|
+
ENV['ENCRYPTED_STRING_SALT'] = SecureRandom.random_bytes
|
44
|
+
|
45
|
+
# "token" is saved as encrypted string value
|
46
|
+
token = 'token'
|
47
|
+
user = User.create(token: token)
|
48
|
+
ActiveRecord::Base.connection.select_value('SELECT token FROM users') #=> "eVZzbUlXME1xSlZ5ZWZPQnIvY..."
|
49
|
+
|
50
|
+
# Get the encrypted value as a decrypted value transparently
|
51
|
+
user.token #=> "token"
|
52
|
+
```
|
53
|
+
|
54
|
+
## Installation
|
55
|
+
|
56
|
+
Add this line to your application's Gemfile:
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
gem 'active_record-type-encrypted_string'
|
60
|
+
```
|
61
|
+
|
62
|
+
And then execute:
|
63
|
+
|
64
|
+
```bash
|
65
|
+
$ bundle
|
66
|
+
```
|
67
|
+
|
68
|
+
Or install it yourself as:
|
69
|
+
|
70
|
+
```bash
|
71
|
+
$ gem install active_record-type-encrypted_string
|
72
|
+
```
|
73
|
+
|
74
|
+
## Configuration
|
75
|
+
|
76
|
+
The password and the salt for encryption can be configured through environment variables or class attributes. Environment variables take precedence over class attributes.
|
77
|
+
|
78
|
+
```ruby
|
79
|
+
ENV['ENCRYPTED_STRING_PASSWORD'] = 'password'
|
80
|
+
ENV['ENCRYPTED_STRING_SALT'] = 'salt'
|
81
|
+
|
82
|
+
|
83
|
+
ActiveRecord::Type::EncryptedString.encryption_password = 'password'
|
84
|
+
ActiveRecord::Type::EncryptedString.encryption_salt = 'salt'
|
85
|
+
```
|
86
|
+
|
87
|
+
## Contributing
|
88
|
+
|
89
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/kymmt90/active_record-type-encrypted_string.
|
90
|
+
|
91
|
+
## License
|
92
|
+
|
93
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
begin
|
2
|
+
require 'bundler/setup'
|
3
|
+
rescue LoadError
|
4
|
+
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
5
|
+
end
|
6
|
+
|
7
|
+
require 'rdoc/task'
|
8
|
+
|
9
|
+
RDoc::Task.new(:rdoc) do |rdoc|
|
10
|
+
rdoc.rdoc_dir = 'rdoc'
|
11
|
+
rdoc.title = 'ActiveRecord::Type::EncryptedString'
|
12
|
+
rdoc.options << '--line-numbers'
|
13
|
+
rdoc.rdoc_files.include('README.md')
|
14
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
15
|
+
end
|
16
|
+
|
17
|
+
require 'bundler/gem_tasks'
|
18
|
+
|
19
|
+
require 'rake/testtask'
|
20
|
+
|
21
|
+
Rake::TestTask.new(:test) do |t|
|
22
|
+
t.libs << 'test'
|
23
|
+
t.pattern = 'test/**/*_test.rb'
|
24
|
+
t.verbose = false
|
25
|
+
end
|
26
|
+
|
27
|
+
task default: :test
|
@@ -0,0 +1,44 @@
|
|
1
|
+
require 'active_record/type'
|
2
|
+
require 'active_record/type/encrypted_string/railtie'
|
3
|
+
require 'active_support/configurable'
|
4
|
+
|
5
|
+
module ActiveRecord
|
6
|
+
module Type
|
7
|
+
module EncryptedString
|
8
|
+
include ActiveSupport::Configurable
|
9
|
+
|
10
|
+
config_accessor :encryption_password, :encryption_salt, instance_accessor: false
|
11
|
+
|
12
|
+
class Type < ::ActiveRecord::Type::String
|
13
|
+
def cast(value)
|
14
|
+
value ? message_encryptor.encrypt_and_sign(value) : super
|
15
|
+
end
|
16
|
+
|
17
|
+
def deserialize(value)
|
18
|
+
value ? message_encryptor.decrypt_and_verify(value) : super
|
19
|
+
end
|
20
|
+
|
21
|
+
private
|
22
|
+
|
23
|
+
def message_encryptor
|
24
|
+
@message_encryptor ||=
|
25
|
+
begin
|
26
|
+
key_len = ActiveSupport::MessageEncryptor.key_len
|
27
|
+
key = ActiveSupport::KeyGenerator.new(password).generate_key(salt, key_len)
|
28
|
+
ActiveSupport::MessageEncryptor.new(key)
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
def password
|
33
|
+
ENV.fetch('ENCRYPTED_STRING_PASSWORD') { ActiveRecord::Type::EncryptedString.encryption_password }
|
34
|
+
end
|
35
|
+
|
36
|
+
def salt
|
37
|
+
ENV.fetch('ENCRYPTED_STRING_SALT') { ActiveRecord::Type::EncryptedString.encryption_salt }
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
ActiveRecord::Type.register :encrypted_string, ActiveRecord::Type::EncryptedString::Type
|
metadata
ADDED
@@ -0,0 +1,78 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: active_record-type-encrypted_string
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Kohei Yamamoto
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-05-23 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rails
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '5.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '5.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: sqlite3
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
description: Provides encrypted string attributes to Active Record models
|
42
|
+
email:
|
43
|
+
- kymmt90@gmail.com
|
44
|
+
executables: []
|
45
|
+
extensions: []
|
46
|
+
extra_rdoc_files: []
|
47
|
+
files:
|
48
|
+
- MIT-LICENSE
|
49
|
+
- README.md
|
50
|
+
- Rakefile
|
51
|
+
- lib/active_record/type/encrypted_string.rb
|
52
|
+
- lib/active_record/type/encrypted_string/railtie.rb
|
53
|
+
- lib/active_record/type/encrypted_string/version.rb
|
54
|
+
- lib/tasks/active_record/type/encrypted_string_tasks.rake
|
55
|
+
homepage: https://github.com/kymmt90/active_record-type-encrypted_string
|
56
|
+
licenses:
|
57
|
+
- MIT
|
58
|
+
metadata: {}
|
59
|
+
post_install_message:
|
60
|
+
rdoc_options: []
|
61
|
+
require_paths:
|
62
|
+
- lib
|
63
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - ">="
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: '0'
|
68
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
69
|
+
requirements:
|
70
|
+
- - ">="
|
71
|
+
- !ruby/object:Gem::Version
|
72
|
+
version: '0'
|
73
|
+
requirements: []
|
74
|
+
rubygems_version: 3.0.3
|
75
|
+
signing_key:
|
76
|
+
specification_version: 4
|
77
|
+
summary: ActiveRecord::Type::EncryptedString
|
78
|
+
test_files: []
|