teak-attr_encrypted 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 946f20d10762389b3e45e9dc1bc8a97b405fd4ebd376e5641140eac73e7520db
4
+ data.tar.gz: 4d1adfb3dd243927cf93f2f931a4ecfd3a6ffecdc9247b581edb2e181294f12f
5
+ SHA512:
6
+ metadata.gz: 620c2c14b556ed109dc9fcb37745d0d6610d1d39b67cd0630db73f3b8fd502934252b4cf3d79d9ea49dc0e5c35f44916a62654c62264ad7768837af46d06979f
7
+ data.tar.gz: e908448ec8afe32cac403e23361d6e0b8fc79301605e7ef0100ceb209a1c30362ad6a224f0e3b85a5faf6a3768bf7e6da28de7904e578cd0b2cc6c5e0974798c
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,6 @@
1
+ ---
2
+ language: ruby
3
+ cache: bundler
4
+ rvm:
5
+ - 2.7.4
6
+ before_install: gem install bundler -v 2.1.4
data/CHANGELOG.md ADDED
@@ -0,0 +1,3 @@
1
+ ## 0.1.0
2
+
3
+ Initial release.
data/Gemfile ADDED
@@ -0,0 +1,9 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in teak-attr_encrypted.gemspec
4
+ gemspec
5
+
6
+ gem "rake", "~> 12.0"
7
+ gem "rspec", "~> 3.0"
8
+ gem 'simplecov', '~> 0.22.0'
9
+ gem "aws-sdk-kms", "~> 1.72"
data/Gemfile.lock ADDED
@@ -0,0 +1,58 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ teak-attr_encrypted (0.1.0)
5
+ msgpack (~> 1.7)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ aws-eventstream (1.2.0)
11
+ aws-partitions (1.844.0)
12
+ aws-sdk-core (3.186.0)
13
+ aws-eventstream (~> 1, >= 1.0.2)
14
+ aws-partitions (~> 1, >= 1.651.0)
15
+ aws-sigv4 (~> 1.5)
16
+ jmespath (~> 1, >= 1.6.1)
17
+ aws-sdk-kms (1.72.0)
18
+ aws-sdk-core (~> 3, >= 3.184.0)
19
+ aws-sigv4 (~> 1.1)
20
+ aws-sigv4 (1.6.1)
21
+ aws-eventstream (~> 1, >= 1.0.2)
22
+ diff-lcs (1.5.0)
23
+ docile (1.4.0)
24
+ jmespath (1.6.2)
25
+ msgpack (1.7.2)
26
+ rake (12.3.3)
27
+ rspec (3.12.0)
28
+ rspec-core (~> 3.12.0)
29
+ rspec-expectations (~> 3.12.0)
30
+ rspec-mocks (~> 3.12.0)
31
+ rspec-core (3.12.2)
32
+ rspec-support (~> 3.12.0)
33
+ rspec-expectations (3.12.3)
34
+ diff-lcs (>= 1.2.0, < 2.0)
35
+ rspec-support (~> 3.12.0)
36
+ rspec-mocks (3.12.6)
37
+ diff-lcs (>= 1.2.0, < 2.0)
38
+ rspec-support (~> 3.12.0)
39
+ rspec-support (3.12.1)
40
+ simplecov (0.22.0)
41
+ docile (~> 1.1)
42
+ simplecov-html (~> 0.11)
43
+ simplecov_json_formatter (~> 0.1)
44
+ simplecov-html (0.12.3)
45
+ simplecov_json_formatter (0.1.4)
46
+
47
+ PLATFORMS
48
+ ruby
49
+
50
+ DEPENDENCIES
51
+ aws-sdk-kms (~> 1.72)
52
+ rake (~> 12.0)
53
+ rspec (~> 3.0)
54
+ simplecov (~> 0.22.0)
55
+ teak-attr_encrypted!
56
+
57
+ BUNDLED WITH
58
+ 2.1.4
data/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/NOTICE ADDED
@@ -0,0 +1,2 @@
1
+ teak-attr_encrypted
2
+ Copyright 2023 Teak.io, Inc.
data/README.md ADDED
@@ -0,0 +1,66 @@
1
+ # Teak::AttrEncrypted
2
+
3
+ teak-attr_encrypted provides a DSL to transparently encrypt and decrypt attributes on any class, with the primary usecase intended to be with ORM models.
4
+
5
+ Quickstart:
6
+
7
+ ```ruby
8
+ require 'openssl'
9
+ require 'teak/attr_encrypted/kek_provider/aes'
10
+ # NOTE: The AES provider is only intended for dev and local use. Its security for
11
+ # production usage has not been considered or evaluated.
12
+ # TODO: Use the same master key on every run ;)
13
+ master_key = OpenSSL::Cipher.new('aes-256-gcm').encrypt.random_key
14
+ Teak::AttrEncrypted.default_kek_provider = Teak::AttrEncrypted::KEKProvider::AES.new(master_key)
15
+
16
+ class MyEncryptedClass
17
+ include Teak::AttrEncrypted
18
+
19
+ attr_encrypted :sooper_secret
20
+
21
+ private
22
+
23
+ # By default attr_encrypted will read and write ciphertext from
24
+ # "#{attribute_name}_enc". This can be customized with the
25
+ # `ciphertext_attr_name:` keyword argument
26
+ attr_accessor :sooper_secret_enc
27
+ end
28
+
29
+ instance = MyEncryptedClass.new
30
+ # Sets instance.sooper_secret_enc to a ciphertext blob
31
+ instance.sooper_secret = 'keep it safe'
32
+ # Decrypts sooper_secret_enc to its original value
33
+ puts instance.sooper_secret
34
+ ```
35
+
36
+ ## Installation
37
+
38
+ Add this line to your application's Gemfile:
39
+
40
+ ```ruby
41
+ gem 'teak-attr_encrypted'
42
+ ```
43
+
44
+ And then execute:
45
+
46
+ $ bundle install
47
+
48
+ Or install it yourself as:
49
+
50
+ $ gem install teak-attr_encrypted
51
+
52
+ ## Usage
53
+
54
+ In production the `Teak::AttrEncrypted.default_kek_provider` should be set to an instance of `Teak::AttrEncrypted::KEKProvider::AwsKMS`. The AwsKMS provider will use the given [AWS KMS](https://aws.amazon.com/kms/) key to generate and decrypt data keys for locally applied envelope encryption.
55
+
56
+ It's highly recommended that you provide a `context:` parameter when using `attr_encrypted`. This may be a symbol, which will attempt to invoke the named method on the object, a proc, which will be evaluated in the context of the object, or another value which will be used as is. The context parameter will be used as [additional authenticated data](https://docs.aws.amazon.com/crypto/latest/userguide/cryptography-concepts.html#term-aad) and must match on both encryption (write) and decryption (read) operations.
57
+
58
+ ## Development
59
+
60
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
61
+
62
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
63
+
64
+ ## Contributing
65
+
66
+ Bug reports and pull requests are welcome on GitHub at https://github.com/GoCarrot/teak-attr_encrypted.
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "teak/attr_encrypted"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,48 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'teak/attr_encrypted/encryptor'
4
+
5
+ module Teak
6
+ module AttrEncrypted
7
+ module DSL
8
+ def self.included(base)
9
+ base.extend ClassMethods
10
+ end
11
+
12
+ module ClassMethods
13
+ def attr_encrypted(attr_name, ciphertext_attr_name: nil, kek_provider: nil, context: nil)
14
+ real_field = ciphertext_attr_name || "#{attr_name}_enc"
15
+ real_field_assign = "#{real_field}="
16
+ encryptor = Teak::AttrEncrypted::Encryptor.new(kek_provider || Teak::AttrEncrypted.default_kek_provider)
17
+
18
+ context_callable =
19
+ if context.is_a?(Symbol)
20
+ proc { send(context) }
21
+ elsif context.is_a?(Proc)
22
+ context
23
+ else
24
+ proc { context }
25
+ end
26
+
27
+ define_method "#{attr_name}=" do |value|
28
+ if value.nil? || value.empty?
29
+ send(real_field_assign, value)
30
+ return value
31
+ end
32
+
33
+ send(real_field_assign, encryptor.encrypt(value, instance_exec(&context_callable)))
34
+ end
35
+
36
+ define_method attr_name do
37
+ envelope = send(real_field)
38
+ if envelope.nil? || envelope.empty?
39
+ envelope
40
+ else
41
+ encryptor.decrypt(send(real_field), instance_exec(&context_callable))
42
+ end
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,64 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'openssl'
4
+ require 'msgpack'
5
+ require 'base64'
6
+
7
+ module Teak
8
+ module AttrEncrypted
9
+ class Encryptor
10
+ CIPHER = 'aes-256-gcm'
11
+
12
+ CURRENT_VERSION = '1'
13
+
14
+ IV = 'v'
15
+ TAG = 't'
16
+ KEY = 'k'
17
+ PACKET = 'p'
18
+ KEK_ID = 'i'
19
+
20
+ def initialize(kek_provider)
21
+ @kek_provider = kek_provider
22
+ end
23
+
24
+ def encrypt(plaintext, encryption_context)
25
+ key_info = @kek_provider.request_data_key(encryption_context)
26
+
27
+ cipher = OpenSSL::Cipher.new(CIPHER).encrypt
28
+ cipher.key = key_info.plaintext
29
+ iv = cipher.random_iv
30
+ cipher.auth_data = ''
31
+
32
+ encrypted = cipher.update(plaintext) + cipher.final
33
+ "#{CURRENT_VERSION}#{Base64.strict_encode64(
34
+ MessagePack.pack({
35
+ KEK_ID => @kek_provider.id,
36
+ IV => iv,
37
+ TAG => cipher.auth_tag,
38
+ KEY => key_info.ciphertext_blob,
39
+ PACKET => encrypted
40
+ })
41
+ )}"
42
+ end
43
+
44
+ def decrypt(envelope, encryption_context)
45
+ version = envelope[0]
46
+ case version
47
+ when '1'
48
+ structure = MessagePack.unpack(Base64.strict_decode64(envelope[1..-1]))
49
+ key_info = @kek_provider.decrypt_data_key(structure[KEY], encryption_context)
50
+
51
+ cipher = OpenSSL::Cipher.new(CIPHER).decrypt
52
+ cipher.key = key_info.plaintext
53
+ cipher.iv = structure[IV]
54
+ cipher.auth_tag = structure[TAG]
55
+ cipher.auth_data = ''
56
+
57
+ cipher.update(structure[PACKET]) + cipher.final
58
+ else
59
+ raise Teak::AttrEncrypted::Error.new("Unrecognized envelope version #{version}")
60
+ end
61
+ end
62
+ end
63
+ end
64
+ end
@@ -0,0 +1,58 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'teak/attr_encrypted/kek_provider/base'
4
+
5
+ require 'openssl'
6
+ require 'msgpack'
7
+
8
+ module Teak
9
+ module AttrEncrypted
10
+ module KEKProvider
11
+ class AES < Base
12
+ Decrypted = Struct.new(:plaintext)
13
+ KeyInfo = Struct.new(:plaintext, :ciphertext_blob)
14
+
15
+ CIPHER = 'aes-256-gcm'
16
+
17
+ def initialize(key)
18
+ super(OpenSSL::Digest::SHA256.hexdigest(key))
19
+ @key = key
20
+ end
21
+
22
+ def request_data_key(encryption_context)
23
+ data_key = OpenSSL::Cipher.new(CIPHER).encrypt.random_key
24
+ cipher = OpenSSL::Cipher.new(CIPHER).encrypt
25
+ cipher.key = @key
26
+ iv = cipher.random_iv
27
+ cipher.auth_data =
28
+ if encryption_context
29
+ MessagePack.pack(encryption_context)
30
+ else
31
+ ''
32
+ end
33
+ ciphertext = cipher.update(data_key) + cipher.final
34
+ ciphertext_blob = MessagePack.pack({iv: iv, tag: cipher.auth_tag, key: ciphertext})
35
+
36
+ KeyInfo.new(data_key, ciphertext_blob)
37
+ end
38
+
39
+ def decrypt_data_key(ciphertext_blob, encryption_context)
40
+ data = MessagePack.unpack(ciphertext_blob)
41
+ cipher = OpenSSL::Cipher.new(CIPHER).decrypt
42
+ cipher.key = @key
43
+ cipher.iv = data['iv']
44
+ cipher.auth_tag = data['tag']
45
+ cipher.auth_data =
46
+ if encryption_context
47
+ MessagePack.pack(encryption_context)
48
+ else
49
+ ''
50
+ end
51
+
52
+ data_key = cipher.update(data['key']) + cipher.final
53
+ Decrypted.new(data_key)
54
+ end
55
+ end
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,43 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'teak/attr_encrypted/kek_provider/base'
4
+
5
+ require 'aws-sdk-kms'
6
+
7
+ module Teak
8
+ module AttrEncrypted
9
+ module KEKProvider
10
+ class AwsKMS < Base
11
+ KEY_SPEC = 'AES_256'
12
+
13
+ def initialize(key_id, client: nil)
14
+ @key_id = key_id
15
+ @kms_client = client || Aws::KMS::Client.new
16
+
17
+ super(@kms_client.describe_key(key_id: key_id).key_metadata.arn)
18
+ end
19
+
20
+ def request_data_key(encryption_context)
21
+ parameters = {
22
+ key_id: @key_id,
23
+ key_spec: KEY_SPEC
24
+ }
25
+ if encryption_context
26
+ parameters[:encryption_context] = encryption_context
27
+ end
28
+ @kms_client.generate_data_key(parameters)
29
+ end
30
+
31
+ def decrypt_data_key(key, encryption_context)
32
+ parameters = {
33
+ ciphertext_blob: key
34
+ }
35
+ if encryption_context
36
+ parameters[:encryption_context] = encryption_context
37
+ end
38
+ @kms_client.decrypt(parameters)
39
+ end
40
+ end
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Teak
4
+ module AttrEncrypted
5
+ module KEKProvider
6
+ class Base
7
+ attr_reader :id
8
+
9
+ def initialize(id)
10
+ @id = id
11
+ end
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,5 @@
1
+ module Teak
2
+ module AttrEncrypted
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'teak/attr_encrypted/version'
4
+ require 'teak/attr_encrypted/dsl'
5
+
6
+ module Teak
7
+ module AttrEncrypted
8
+ def self.included(base)
9
+ base.include DSL
10
+ end
11
+
12
+ def self.default_kek_provider
13
+ if @default_kek_provider
14
+ @default_kek_provider
15
+ else
16
+ raise Error.new('No key encryption key provider provided!')
17
+ end
18
+ end
19
+
20
+ def self.default_kek_provider=(provider)
21
+ @default_kek_provider = provider
22
+ end
23
+
24
+ class Error < StandardError; end
25
+ # Your code goes here...
26
+ end
27
+ end
@@ -0,0 +1,31 @@
1
+ require_relative 'lib/teak/attr_encrypted/version'
2
+
3
+ Gem::Specification.new do |spec|
4
+ spec.name = "teak-attr_encrypted"
5
+ spec.version = Teak::AttrEncrypted::VERSION
6
+ spec.authors = ["Alex Scarborough"]
7
+ spec.email = ["alex@teak.io"]
8
+
9
+ spec.summary = %q{Encrypts attributes on models using a key encryption key and envelopes.}
10
+ spec.homepage = "https://github.com/GoCarrot/teak-attr_encrypted"
11
+ spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
12
+
13
+ spec.license = "Apache-2.0"
14
+
15
+ spec.metadata["rubygems_mfa_required"] = "true"
16
+
17
+ spec.metadata["homepage_uri"] = spec.homepage
18
+ spec.metadata["source_code_uri"] = spec.homepage
19
+ spec.metadata["changelog_uri"] = "https://github.com/GoCarrot/teak-attr_encrypted/blob/main/CHANGELOG.md"
20
+
21
+ # Specify which files should be added to the gem when it is released.
22
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
23
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
24
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
25
+ end
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_dependency "msgpack", "~> 1.7"
31
+ end
metadata ADDED
@@ -0,0 +1,81 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: teak-attr_encrypted
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Alex Scarborough
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2023-11-03 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: msgpack
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.7'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.7'
27
+ description:
28
+ email:
29
+ - alex@teak.io
30
+ executables: []
31
+ extensions: []
32
+ extra_rdoc_files: []
33
+ files:
34
+ - ".gitignore"
35
+ - ".rspec"
36
+ - ".travis.yml"
37
+ - CHANGELOG.md
38
+ - Gemfile
39
+ - Gemfile.lock
40
+ - LICENSE
41
+ - NOTICE
42
+ - README.md
43
+ - Rakefile
44
+ - bin/console
45
+ - bin/setup
46
+ - lib/teak/attr_encrypted.rb
47
+ - lib/teak/attr_encrypted/dsl.rb
48
+ - lib/teak/attr_encrypted/encryptor.rb
49
+ - lib/teak/attr_encrypted/kek_provider/aes.rb
50
+ - lib/teak/attr_encrypted/kek_provider/aws_kms.rb
51
+ - lib/teak/attr_encrypted/kek_provider/base.rb
52
+ - lib/teak/attr_encrypted/version.rb
53
+ - teak-attr_encrypted.gemspec
54
+ homepage: https://github.com/GoCarrot/teak-attr_encrypted
55
+ licenses:
56
+ - Apache-2.0
57
+ metadata:
58
+ rubygems_mfa_required: 'true'
59
+ homepage_uri: https://github.com/GoCarrot/teak-attr_encrypted
60
+ source_code_uri: https://github.com/GoCarrot/teak-attr_encrypted
61
+ changelog_uri: https://github.com/GoCarrot/teak-attr_encrypted/blob/main/CHANGELOG.md
62
+ post_install_message:
63
+ rdoc_options: []
64
+ require_paths:
65
+ - lib
66
+ required_ruby_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: 2.5.0
71
+ required_rubygems_version: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ requirements: []
77
+ rubygems_version: 3.1.6
78
+ signing_key:
79
+ specification_version: 4
80
+ summary: Encrypts attributes on models using a key encryption key and envelopes.
81
+ test_files: []