rails_key_rotator 0.2.0 → 0.2.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 +4 -4
- data/README.md +18 -11
- data/lib/rails_key_rotator/railtie.rb +1 -1
- data/lib/rails_key_rotator/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 29eb6c4fb0ee94eb94483058e009c91b40bc017ff13da75d90f60249c51df5c7
|
|
4
|
+
data.tar.gz: cb203507ac300b69adac536d0aee9685c42a09c78b0b3a9d391bfbc4a0ba77c2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 87a8d7106191f090426e9d9d6a7d997fa5b972c1a840c76fef0250adab92e56a309bc0a9ca1a127e7ceeecf9195e10a57006adee2748e0d5e9e30e14315162cf
|
|
7
|
+
data.tar.gz: 74cb11e1eb92733a54fa3e2051ade59b108578b1b41e02e7e8105297cec4fd96978bbec962214a6b4e8606f358630f333028c7fb0bc1c226b18413811ff84007
|
data/README.md
CHANGED
|
@@ -12,22 +12,22 @@ If bundler is not being used to manage dependencies, install the gem by executin
|
|
|
12
12
|
|
|
13
13
|
## Usage
|
|
14
14
|
|
|
15
|
-
>
|
|
16
|
-
>
|
|
15
|
+
> **Warning**
|
|
16
|
+
> **DON'T FORGET TO HANDOUT THE NEW KEY TO YOUR COLLEAGUES!**
|
|
17
17
|
|
|
18
|
-
1.
|
|
18
|
+
1. Run the rake taks
|
|
19
19
|
|
|
20
20
|
bundle rake key_rotator:rotate
|
|
21
21
|
|
|
22
22
|
This will backup current key / credentials, create a new key and saves encrypts the credentails w/ this new key
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
2. Deploying this variable as an env `RAILS_MASTER_KEY_NEW`
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
3. Commit and deploy new encrypted file.
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
4. After a while when everything is back in sync replace `RAILS_MASTER_KEY` w/ the new key and delete `RAILS_MASTER_KEY_NEW`
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
## Process
|
|
31
31
|
|
|
32
32
|
When we've defined `RAILS_MASTER_KEY_NEW` it means we are rotating the encryption key for our credentials. What we want to do then is:
|
|
33
33
|
|
|
@@ -42,13 +42,20 @@ See: https://www.reddit.com/r/rails/comments/x4sujc/deploying_a_rotated_credenti
|
|
|
42
42
|
|
|
43
43
|
## Development
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
This project uses docker and [dip](https://github.com/bibendi/dip), a.k.a. the _Docker Interaction Program._
|
|
46
46
|
|
|
47
|
-
To
|
|
47
|
+
To use it:
|
|
48
|
+
```shell
|
|
49
|
+
gem install dip
|
|
50
|
+
dip provision
|
|
51
|
+
dip guard # run specs
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
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 `dip bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
|
48
55
|
|
|
49
56
|
## Contributing
|
|
50
57
|
|
|
51
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/
|
|
58
|
+
Bug reports and pull requests are welcome on GitHub at <https://github.com/LeipeLeon/rails_key_rotator>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/LeipeLeon/rails_key_rotator/blob/master/CODE_OF_CONDUCT.md).
|
|
52
59
|
|
|
53
60
|
## License
|
|
54
61
|
|
|
@@ -56,4 +63,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
|
|
|
56
63
|
|
|
57
64
|
## Code of Conduct
|
|
58
65
|
|
|
59
|
-
Everyone interacting in the RailsKeyRotator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/
|
|
66
|
+
Everyone interacting in the RailsKeyRotator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/LeipeLeon/rails_key_rotator/blob/master/CODE_OF_CONDUCT.md).
|