attr_secure 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +56 -0
- data/Rakefile +1 -0
- data/attr_secure.gemspec +26 -0
- data/lib/attr_secure/version.rb +3 -0
- data/lib/attr_secure.rb +42 -0
- metadata +108 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 2cd8f5acfdc9902f2a13e5974faf7522cebdad64
|
4
|
+
data.tar.gz: ce4a7c6bfd2b256563b96f5698351c87a865d2c4
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: acf21c767ec0b05f0a3d60b1677642ec44a75ed63d6d87734618a7c5e81a625ba3ec92459eb61964be7417462bf1a1bbfac006c445a278e9b4e41a0107983d50
|
7
|
+
data.tar.gz: fae4add1cbd63720f7b296c5e399bed19349917d7e67a152a17e2c365b7464184f5d2ac78034ce269eef169fe6cd8fcd67539b80709fb4ef650e2d2a996bd690
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Neil Middleton
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,56 @@
|
|
1
|
+
# attr_secure
|
2
|
+
|
3
|
+
Securely stores ActiveRecord attributes for a given model/attribute and a predefined secret.
|
4
|
+
|
5
|
+
```
|
6
|
+
class Report < ActiveRecord::Base
|
7
|
+
attr_secure :secret_value
|
8
|
+
end
|
9
|
+
|
10
|
+
r = Report.new
|
11
|
+
r.secret_value = "ThisIsATest"
|
12
|
+
r.save
|
13
|
+
=> #<Report id: 116, secret_value: "EKq88AMFeRLqEx5knUcoJ4LOnrv52d7hfAFgEKMoDKzqNei4m7k...">
|
14
|
+
|
15
|
+
r = Report.find(116)
|
16
|
+
r.secret_value
|
17
|
+
=> "ThisIsATest"
|
18
|
+
```
|
19
|
+
|
20
|
+
## Installation
|
21
|
+
|
22
|
+
Add this line to your application's Gemfile:
|
23
|
+
|
24
|
+
gem 'attr_secure'
|
25
|
+
|
26
|
+
And then execute:
|
27
|
+
|
28
|
+
$ bundle
|
29
|
+
|
30
|
+
Or install it yourself as:
|
31
|
+
|
32
|
+
$ gem install attr_secure
|
33
|
+
|
34
|
+
## Usage
|
35
|
+
|
36
|
+
To make an model attribute secure, first create a key:
|
37
|
+
|
38
|
+
dd if=/dev/urandom bs=32 count=1 2>/dev/null | openssl base64
|
39
|
+
|
40
|
+
and add it to your environment as `ATTR_SECURE_SECRET`.
|
41
|
+
Then mark an attribute as secure:
|
42
|
+
|
43
|
+
attr_secure :my_attribute
|
44
|
+
|
45
|
+
and read and write as normal (see above example)
|
46
|
+
|
47
|
+
Note: You will want to set your table columns for encrypted values to :text or
|
48
|
+
similar. Encrypted values are long.
|
49
|
+
|
50
|
+
## Contributing
|
51
|
+
|
52
|
+
1. Fork it
|
53
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
54
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
55
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
56
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/attr_secure.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'attr_secure/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "attr_secure"
|
8
|
+
spec.version = AttrSecure::VERSION
|
9
|
+
spec.authors = ["Neil Middleton"]
|
10
|
+
spec.email = ["neil@neilmiddleton.com"]
|
11
|
+
spec.description = %q{Securely stores activerecord model attributes}
|
12
|
+
spec.summary = %q{Securely stores activerecord model attributes}
|
13
|
+
spec.homepage = "http://www.neilmiddleton.com"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
22
|
+
spec.add_development_dependency "rake"
|
23
|
+
|
24
|
+
spec.add_dependency 'fernet'
|
25
|
+
spec.add_dependency 'activesupport', ' ~> 3.2.0'
|
26
|
+
end
|
data/lib/attr_secure.rb
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
require "attr_secure/version"
|
2
|
+
require 'fernet'
|
3
|
+
|
4
|
+
Fernet::Configuration.run do |config|
|
5
|
+
config.enforce_ttl = false
|
6
|
+
end
|
7
|
+
|
8
|
+
module AttrSecure
|
9
|
+
extend ActiveSupport::Concern
|
10
|
+
|
11
|
+
def env!(key)
|
12
|
+
ENV[key] || raise("Missing ENV(#{key})")
|
13
|
+
end
|
14
|
+
|
15
|
+
def encrypt(value)
|
16
|
+
Fernet.generate(env!('ATTR_SECURE_SECRET')) do |generator|
|
17
|
+
generator.data = { value: value }
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
def decrypt(value)
|
22
|
+
return nil if value.nil?
|
23
|
+
verifier = Fernet.verifier(env!('ATTR_SECURE_SECRET'), value)
|
24
|
+
verifier.data["value"] if verifier.valid?
|
25
|
+
end
|
26
|
+
|
27
|
+
module ClassMethods
|
28
|
+
|
29
|
+
def attr_secure(attribute)
|
30
|
+
define_method("#{attribute}=") do |value|
|
31
|
+
write_attribute(attribute, encrypt(value.to_sym))
|
32
|
+
end
|
33
|
+
|
34
|
+
define_method("#{attribute}") do
|
35
|
+
decrypt read_attribute(attribute.to_sym)
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
ActiveRecord::Base.send(:include, AttrSecure)
|
metadata
ADDED
@@ -0,0 +1,108 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: attr_secure
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Neil Middleton
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2013-05-30 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ~>
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.3'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ~>
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.3'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
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
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: fernet
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: activesupport
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ~>
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 3.2.0
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ~>
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: 3.2.0
|
69
|
+
description: Securely stores activerecord model attributes
|
70
|
+
email:
|
71
|
+
- neil@neilmiddleton.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- .gitignore
|
77
|
+
- Gemfile
|
78
|
+
- LICENSE.txt
|
79
|
+
- README.md
|
80
|
+
- Rakefile
|
81
|
+
- attr_secure.gemspec
|
82
|
+
- lib/attr_secure.rb
|
83
|
+
- lib/attr_secure/version.rb
|
84
|
+
homepage: http://www.neilmiddleton.com
|
85
|
+
licenses:
|
86
|
+
- MIT
|
87
|
+
metadata: {}
|
88
|
+
post_install_message:
|
89
|
+
rdoc_options: []
|
90
|
+
require_paths:
|
91
|
+
- lib
|
92
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - '>='
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
98
|
+
requirements:
|
99
|
+
- - '>='
|
100
|
+
- !ruby/object:Gem::Version
|
101
|
+
version: '0'
|
102
|
+
requirements: []
|
103
|
+
rubyforge_project:
|
104
|
+
rubygems_version: 2.0.0
|
105
|
+
signing_key:
|
106
|
+
specification_version: 4
|
107
|
+
summary: Securely stores activerecord model attributes
|
108
|
+
test_files: []
|