Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freeletics/creds
Encrypted & plain text credentials for multiple environments
https://github.com/freeletics/creds
credentials rails ruby ruby-gem
Last synced: 3 months ago
JSON representation
Encrypted & plain text credentials for multiple environments
- Host: GitHub
- URL: https://github.com/freeletics/creds
- Owner: freeletics
- License: mit
- Created: 2018-03-30T10:43:38.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-17T02:35:18.000Z (almost 2 years ago)
- Last Synced: 2024-09-27T16:21:33.550Z (4 months ago)
- Topics: credentials, rails, ruby, ruby-gem
- Language: Ruby
- Homepage:
- Size: 35.2 KB
- Stars: 37
- Watchers: 12
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Creds
Manage encrypted credentials (added in Rails 5.2.0) with multiple environments.
## Installation
Available as a gem [`creds`](https://rubygems.org/gems/creds)
## Usage
Using Rails command, generate new encrypted file by
```
bin/rails encrypted:edit config/credentials/production.yml.enc --key config/credentials/production.key
```
add some content in opened editor (note there is no environment root key, ie no `production`):
```yaml
aws_access_key_id: my-access-key-id
```
If `config/credentials/production.key` doesn't exist yet, run `bin/rails generate master_key` and adjust naming to match desired one.
Content of file can be displayed by
```
bin/rails encrypted:show config/credentials/production.yml.enc --key config/credentials/production.key
```
Add to `config/environments/production.rb` (or any other env)
```ruby
config.creds = Creds.new("config/credentials/production.yml.enc")
```
If wants to use key from custom path - by default it checks `RAILS_MASTER_KEY` env key and `config/master.key` file:
```ruby
config.creds = Creds.new("config/credentials/production.yml.enc", key_path: "config/credentials/production.key")
```
In the code:
```ruby
Rails.configuration.creds.aws_access_key_id
```
To ease working in development/test environments with the same API, add `config/credentials/plain.yml` with key/value pairs
nested under environment name, like:
```yml
development:
aws_access_key_id: "aws-key-id"
```
Then add to `config/environments/development.rb`
```ruby
config.creds = Creds.new("config/credentials/plain.yml", env: "development")
```
### Rails 6.0
In Rails 6.0 it is possible to edit files by `rails credentials:edit --environment production` which will look for
`config/credentials/production.yml.enc` encrypted by `ENV["RAILS_MASTER_KEY"]` or `config/credentials/production.key`
### Additions
* To raise error in case of missing key you can add bang to the name, like `Rails.configuration.creds.database_url!`
* To list all defined key/value pairs call `config`, like `Rails.configuration.creds.config`
* Plain text file can embed Ruby (`<%= %>`), but not encrypted one
* If `secret_key_base` is specified in credentials file, it will be assigned to `Rails.configuration.secret_key_base`, as it is required by Rails
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
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).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/freeletics/creds
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).