porky_lib 0.9.5 → 0.10.0
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 +4 -4
- data/.circleci/config.yml +1 -3
- data/.rubocop.yml +1 -1
- data/Gemfile +1 -1
- data/Gemfile.lock +27 -26
- data/README.md +33 -6
- data/lib/porky_lib/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 568cf3209e11d99fee524612407bafd881f4d9e89e3386a72d5289f53e662e68
|
|
4
|
+
data.tar.gz: 7c81973288046c5b7e604b50f4d25af8a3ce8412090b1cc9bf81e651b95c5cdd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: fe5165454793c9fbd9a74b0a4f9adf8cae0a65b8e8ae1bd190c45c5b770cd6535da21ffdb9f52e71f2a6f59ba3f4a21049cf523ed60329ed75f642bfc8102936
|
|
7
|
+
data.tar.gz: 46f45d303ce3f1d3991ec6c3de254218e4c311843ec5d11a6aac9a05b03cb40d0a8bb9a78ff353d77985aceb2f1f51d4752edc3b501132f773436725570873c5
|
data/.circleci/config.yml
CHANGED
data/.rubocop.yml
CHANGED
data/Gemfile
CHANGED
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
porky_lib (0.
|
|
4
|
+
porky_lib (0.10.0)
|
|
5
5
|
aws-sdk-kms
|
|
6
6
|
aws-sdk-s3
|
|
7
7
|
msgpack
|
|
@@ -13,16 +13,16 @@ GEM
|
|
|
13
13
|
specs:
|
|
14
14
|
ast (2.4.0)
|
|
15
15
|
aws-eventstream (1.0.3)
|
|
16
|
-
aws-partitions (1.
|
|
17
|
-
aws-sdk-core (3.
|
|
16
|
+
aws-partitions (1.272.0)
|
|
17
|
+
aws-sdk-core (3.90.0)
|
|
18
18
|
aws-eventstream (~> 1.0, >= 1.0.2)
|
|
19
19
|
aws-partitions (~> 1, >= 1.239.0)
|
|
20
20
|
aws-sigv4 (~> 1.1)
|
|
21
21
|
jmespath (~> 1.0)
|
|
22
|
-
aws-sdk-kms (1.
|
|
22
|
+
aws-sdk-kms (1.29.0)
|
|
23
23
|
aws-sdk-core (~> 3, >= 3.71.0)
|
|
24
24
|
aws-sigv4 (~> 1.1)
|
|
25
|
-
aws-sdk-s3 (1.60.
|
|
25
|
+
aws-sdk-s3 (1.60.2)
|
|
26
26
|
aws-sdk-core (~> 3, >= 3.83.0)
|
|
27
27
|
aws-sdk-kms (~> 1)
|
|
28
28
|
aws-sigv4 (~> 1.1)
|
|
@@ -31,8 +31,8 @@ GEM
|
|
|
31
31
|
bundler-audit (0.6.1)
|
|
32
32
|
bundler (>= 1.2.0, < 3)
|
|
33
33
|
thor (~> 0.18)
|
|
34
|
-
byebug (11.
|
|
35
|
-
codacy-coverage (2.1
|
|
34
|
+
byebug (11.1.1)
|
|
35
|
+
codacy-coverage (2.2.1)
|
|
36
36
|
simplecov
|
|
37
37
|
codecov (0.1.16)
|
|
38
38
|
json
|
|
@@ -40,13 +40,13 @@ GEM
|
|
|
40
40
|
url
|
|
41
41
|
diff-lcs (1.3)
|
|
42
42
|
docile (1.3.2)
|
|
43
|
-
ffi (1.
|
|
43
|
+
ffi (1.12.2)
|
|
44
44
|
jaro_winkler (1.5.4)
|
|
45
45
|
jmespath (1.4.0)
|
|
46
|
-
json (2.
|
|
47
|
-
msgpack (1.3.
|
|
46
|
+
json (2.3.0)
|
|
47
|
+
msgpack (1.3.3)
|
|
48
48
|
parallel (1.19.1)
|
|
49
|
-
parser (2.
|
|
49
|
+
parser (2.7.0.2)
|
|
50
50
|
ast (~> 2.4.0)
|
|
51
51
|
rainbow (3.0.0)
|
|
52
52
|
rake (13.0.1)
|
|
@@ -54,44 +54,45 @@ GEM
|
|
|
54
54
|
ffi
|
|
55
55
|
rbnacl-libsodium (1.0.16)
|
|
56
56
|
rbnacl (>= 3.0.1)
|
|
57
|
+
rexml (3.2.4)
|
|
57
58
|
rspec (3.9.0)
|
|
58
59
|
rspec-core (~> 3.9.0)
|
|
59
60
|
rspec-expectations (~> 3.9.0)
|
|
60
61
|
rspec-mocks (~> 3.9.0)
|
|
61
62
|
rspec-collection_matchers (1.2.0)
|
|
62
63
|
rspec-expectations (>= 2.99.0.beta1)
|
|
63
|
-
rspec-core (3.9.
|
|
64
|
-
rspec-support (~> 3.9.
|
|
64
|
+
rspec-core (3.9.1)
|
|
65
|
+
rspec-support (~> 3.9.1)
|
|
65
66
|
rspec-expectations (3.9.0)
|
|
66
67
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
67
68
|
rspec-support (~> 3.9.0)
|
|
68
|
-
rspec-mocks (3.9.
|
|
69
|
+
rspec-mocks (3.9.1)
|
|
69
70
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
70
71
|
rspec-support (~> 3.9.0)
|
|
71
|
-
rspec-support (3.9.
|
|
72
|
+
rspec-support (3.9.2)
|
|
72
73
|
rspec_junit_formatter (0.4.1)
|
|
73
74
|
rspec-core (>= 2, < 4, != 2.12.0)
|
|
74
|
-
rubocop (0.
|
|
75
|
+
rubocop (0.80.0)
|
|
75
76
|
jaro_winkler (~> 1.5.1)
|
|
76
77
|
parallel (~> 1.10)
|
|
77
|
-
parser (>= 2.
|
|
78
|
+
parser (>= 2.7.0.1)
|
|
78
79
|
rainbow (>= 2.2.2, < 4.0)
|
|
80
|
+
rexml
|
|
79
81
|
ruby-progressbar (~> 1.7)
|
|
80
82
|
unicode-display_width (>= 1.4.0, < 1.7)
|
|
81
|
-
rubocop-performance (1.5.
|
|
83
|
+
rubocop-performance (1.5.2)
|
|
82
84
|
rubocop (>= 0.71.0)
|
|
83
|
-
rubocop-rspec (1.
|
|
85
|
+
rubocop-rspec (1.38.1)
|
|
84
86
|
rubocop (>= 0.68.1)
|
|
85
87
|
rubocop_runner (2.2.0)
|
|
86
88
|
ruby-progressbar (1.10.1)
|
|
87
|
-
simplecov (0.
|
|
89
|
+
simplecov (0.18.2)
|
|
88
90
|
docile (~> 1.1)
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
simplecov-html (0.10.2)
|
|
91
|
+
simplecov-html (~> 0.11)
|
|
92
|
+
simplecov-html (0.12.0)
|
|
92
93
|
thor (0.20.3)
|
|
93
94
|
timecop (0.9.1)
|
|
94
|
-
unicode-display_width (1.6.
|
|
95
|
+
unicode-display_width (1.6.1)
|
|
95
96
|
url (0.3.2)
|
|
96
97
|
|
|
97
98
|
PLATFORMS
|
|
@@ -122,7 +123,7 @@ DEPENDENCIES
|
|
|
122
123
|
timecop
|
|
123
124
|
|
|
124
125
|
RUBY VERSION
|
|
125
|
-
ruby 2.
|
|
126
|
+
ruby 2.7.0p0
|
|
126
127
|
|
|
127
128
|
BUNDLED WITH
|
|
128
|
-
2.
|
|
129
|
+
2.1.4
|
data/README.md
CHANGED
|
@@ -20,7 +20,7 @@ And then execute:
|
|
|
20
20
|
Or install it yourself as:
|
|
21
21
|
|
|
22
22
|
$ gem install porky_lib
|
|
23
|
-
|
|
23
|
+
|
|
24
24
|
Inside of your Ruby program do:
|
|
25
25
|
|
|
26
26
|
```ruby
|
|
@@ -86,7 +86,7 @@ To encrypt data with a known plaintext key:
|
|
|
86
86
|
# plaintext_key is the encryption key to use
|
|
87
87
|
# encryption_info is the structure returned that contains:
|
|
88
88
|
# ciphertext: plaintext encrypted under plaintext_key
|
|
89
|
-
# nonce: The generated nonce
|
|
89
|
+
# nonce: The generated nonce
|
|
90
90
|
encryption_info = PorkyLib::Symmetric.instance.encrypt_with_key(plaintext, plaintext_key)
|
|
91
91
|
```
|
|
92
92
|
|
|
@@ -104,7 +104,7 @@ To decrypt data with a known plaintext key:
|
|
|
104
104
|
```ruby
|
|
105
105
|
# Where ciphertext is the encrypted data to be decrypted
|
|
106
106
|
# plaintext_key is the decryption key to use
|
|
107
|
-
# nonce is the nonce to use
|
|
107
|
+
# nonce is the nonce to use
|
|
108
108
|
# decryption_info is the structured returned that contains:
|
|
109
109
|
# plaintext: ciphertext decrypted under plaintext_key
|
|
110
110
|
decryption_info = PorkyLib::Symmetric.instance.decrypt_with_key(ciphertext, plaintext_key, nonce)
|
|
@@ -137,7 +137,7 @@ plaintext_key.replace(PorkyLib::Symmetric.instance.secure_delete_plaintext_key(p
|
|
|
137
137
|
To verify whether an alias exists or not:
|
|
138
138
|
```ruby
|
|
139
139
|
# Where key_alias is the alias name to verify
|
|
140
|
-
alias_exists = PorkyLib::Symmetric.instance.cmk_alias_exists?(key_alias)
|
|
140
|
+
alias_exists = PorkyLib::Symmetric.instance.cmk_alias_exists?(key_alias)
|
|
141
141
|
```
|
|
142
142
|
|
|
143
143
|
### To Read From AWS S3
|
|
@@ -235,7 +235,7 @@ Rake task name: `file:write`
|
|
|
235
235
|
|
|
236
236
|
Environment variables:
|
|
237
237
|
* Required
|
|
238
|
-
* `FILE_PATH` - Absolute or relative file path
|
|
238
|
+
* `FILE_PATH` - Absolute or relative file path
|
|
239
239
|
* `CMK_KEY_ID` - Alias of the CMK key
|
|
240
240
|
* `AWS_S3_BUCKET` - AWS S3 bucket name
|
|
241
241
|
* `AWS_REGION` - AWS region name
|
|
@@ -246,7 +246,7 @@ Environment variables:
|
|
|
246
246
|
* `AWS_S3_MAX_FILE_SIZE` - Max file size (defaults to `1MB`)
|
|
247
247
|
* `AWS_S3_STORAGE_CLASS` - One of STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE (defaults to `STANDARD`)
|
|
248
248
|
* `AWS_S3_KEEP_FILE_NAME` - Saves the file in AWS S3 with the original file name (defaults to `true`)
|
|
249
|
-
|
|
249
|
+
|
|
250
250
|
### Read file
|
|
251
251
|
|
|
252
252
|
Rake task name: `file:read`
|
|
@@ -269,6 +269,33 @@ Development on this project should occur on separate feature branches and pull r
|
|
|
269
269
|
pull request, the pull request comment template should be filled out as much as possible to ensure a quick review and increase
|
|
270
270
|
the likelihood of the pull request being accepted.
|
|
271
271
|
|
|
272
|
+
### Ruby
|
|
273
|
+
|
|
274
|
+
This application requires:
|
|
275
|
+
|
|
276
|
+
* Ruby version: 2.7.0
|
|
277
|
+
|
|
278
|
+
If you do not have Ruby installed, it is recommended you use ruby-install and chruby to manage Ruby versions.
|
|
279
|
+
|
|
280
|
+
```bash
|
|
281
|
+
brew install ruby-install chruby
|
|
282
|
+
ruby-install ruby 2.7.0
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
Add the following lines to ~/.bash_profile:
|
|
286
|
+
|
|
287
|
+
```bash
|
|
288
|
+
source /usr/local/opt/chruby/share/chruby/chruby.sh
|
|
289
|
+
source /usr/local/opt/chruby/share/chruby/auto.sh
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
Set Ruby version to 2.7.0:
|
|
293
|
+
|
|
294
|
+
```bash
|
|
295
|
+
source ~/.bash_profile
|
|
296
|
+
chruby 2.7.0
|
|
297
|
+
```
|
|
298
|
+
|
|
272
299
|
### Running Tests
|
|
273
300
|
|
|
274
301
|
```ruby
|
data/lib/porky_lib/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: porky_lib
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.10.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Greg Fletcher
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2020-02-20 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: aws-sdk-kms
|
|
@@ -424,7 +424,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
424
424
|
- !ruby/object:Gem::Version
|
|
425
425
|
version: '0'
|
|
426
426
|
requirements: []
|
|
427
|
-
rubygems_version: 3.
|
|
427
|
+
rubygems_version: 3.1.2
|
|
428
428
|
signing_key:
|
|
429
429
|
specification_version: 4
|
|
430
430
|
summary: A library for cryptographic services using AWS KMS and RbNaCl
|