rails_key_rotator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d1778feace35c94d339199b459de6c749f82539e63cbe46a934684ec17cbb9e
+  data.tar.gz: 05dac7f4d49bdf29c7689ecb5c4b17a8907471d5d5139a9fa80c5f80137fbca6
+SHA512:
+  metadata.gz: b283c99e15d1bc2804ec2486971c78765b1e2eab9c68c31510baf95c53fac9e8dded8c1f380c201ad4964077428a694459556999d2516d7efafdfea55aecf02a
+  data.tar.gz: 9aea496df02a242c867dce7d3fe3b8237872f3d732dbbc9392eb12a0985e62296f9fa9418a2f3c3726bad156a41af6493ddcdf5e3ab4126d1db0209fe35c5dd1

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+require:
+  - standard
+inherit_gem:
+  standard: config/base.yml
+
+Gemspec/DependencyVersion:
+  Enabled: true
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: true
+Gemspec/DevelopmentDependencies:
+  Enabled: true
+Gemspec/DuplicatedAssignment:
+  Enabled: true
+Gemspec/OrderedDependencies:
+  Enabled: true
+Gemspec/RequireMFA:
+  Enabled: true
+Gemspec/RequiredRubyVersion:
+  Enabled: true
+Gemspec/RubyVersionGlobalsUsage:
+  Enabled: true

data/Appraisals

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+appraise "active_support_60" do
+  gem "activesupport", "~> 6.0.0", require: "active_support"
+end
+
+appraise "active_support_61" do
+  gem "activesupport", "~> 6.1.0", require: "active_support"
+end
+
+appraise "active_support_70" do
+  gem "activesupport", "~> 7.0.0", require: "active_support"
+end
+
+appraise "active_support_71" do
+  gem "activesupport", "~> 7.1.0", require: "active_support"
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Dockerfile

@@ -0,0 +1,15 @@
+FROM ruby:3.2
+
+RUN apt-get update && apt-get install -y \
+  vim
+
+ENV APP_HOME /app
+
+ENV BUNDLE_GEMFILE=$APP_HOME/Gemfile \
+    BUNDLE_JOBS=8
+
+ARG BUNDLER_VERSION=2.4.20
+RUN gem update --system && \
+    gem install bundler:$BUNDLER_VERSION
+
+WORKDIR $APP_HOME

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# RailsKeyRotator
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rails_key_rotator
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rails_key_rotator
+
+## Usage
+
+> _*⚠️ !!! WARNING !!! ⚠️*_
+> _*⚠️ DON'T FORGET TO HANDOUT THE NEW KEY TO YOUR COLLEAGUES! ⚠️*_
+
+1. First create a new key w/ `dip rails runner "puts ActiveSupport::EncryptedConfiguration.generate_key"` and deploy this in `RAILS_MASTER_KEY_NEW` on the targeted infrastructure.
+
+2. While waiting on deploying this variable, create a new encrypted file:
+
+   ```shell
+   # Copy the output current credentials
+   dip credentials show -e development
+   # Backup current credentials
+   mv -i config/credentials/development.yml.enc config/credentials/development.yml.enc.bak-$(date "+%Y-%m-%d-%H%M")
+   # Backup current key
+   mv -i config/credentials/development.key config/credentials/development.key.bak-$(date "+%Y-%m-%d-%H%M")
+   # Save the new key into file
+   echo d92599b046b58ab2d4158212e6d27162 > config/credentials/development.key
+   # Create new credentials file w/
+   dip credentials -e development
+   # Verify content
+   dip credentials show -e development
+   ```
+
+3. Commit to Github and deploy new encrypted file.
+
+4. After a while when everything is back in sync replace `RAILS_MASTER_KEY` w/ the new key and delete `RAILS_MASTER_KEY_NEW`
+
+### Process
+
+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:
+
+1. Check if we can decrypt the current credentials file with the new key
+
+2. If we can, we will change `RAILS_MASTER_KEY` to equal `RAILS_MASTER_KEY_NEW`
+
+3. If not, we will fallback to the old key, thus leave `RAILS_MASTER_KEY` alone
+
+See: https://www.reddit.com/r/rails/comments/x4sujc/deploying_a_rotated_credentials_key_without/
+
+
+## Development
+
+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.
+
+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 the created tag, 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/[USERNAME]/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/[USERNAME]/rails_key_rotator/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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/[USERNAME]/rails_key_rotator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/dip.yml

@@ -0,0 +1,64 @@
+# Required minimum dip version
+version: '7.5'
+
+environment:
+  RAILS_ENV: development
+
+compose:
+  files:
+    - docker-compose.yml
+    - docker-compose.override.yml # platform specific overrides
+
+interaction:
+  sh:
+    description: Open a Bash shell within a Rails container (with dependencies up)
+    command: /bin/bash
+    service: rails_key_rotator
+
+  bash:
+    description: Run an arbitrary script within a container (or open a shell without deps)
+    command: /bin/bash
+    service: rails_key_rotator
+
+  bundle:
+    description: Run Bundler commands
+    command: bundle
+    service: rails_key_rotator
+
+  rake:
+    description: Run Rake commands
+    command: bundle exec rake
+    service: rails_key_rotator
+
+  guard:
+    description: Run red-green-red refactor loop using guard
+    environment:
+      RAILS_ENV: test
+    command: bundle exec guard
+    service: rails_key_rotator
+
+  rspec:
+    description: Run Rails tests
+    environment:
+      RAILS_ENV: test
+    command: bundle exec rspec
+    service: rails_key_rotator
+
+provision:
+  # Dip requires .env to do anything
+  - touch .env
+
+  # Remove old containers and volumes.
+  - dip compose down --volumes --remove-orphans
+  - docker volume create rails_key_rotator-history
+  - dip compose build
+
+  # Install gems
+  - dip bundle install
+
+  # Setup configuration files if they do not (yet) exist
+  # use `|| true` to fix error when /bin/cp is used (which returns 1 when file exists)
+  - cp -n docker-compose.override.yml.example docker-compose.override.yml || true
+  - cp -n .env.local.example .env.local || true
+  - cp -n .env.example .env || true
+

data/docker-compose.yml

@@ -0,0 +1,21 @@
+version: '3.8'
+
+services:
+  rails_key_rotator:
+    container_name: rails_key_rotator
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - .:/app
+      - bundle:/usr/local/bundle
+      - history:/usr/local/hist
+    environment:
+      HISTFILE: /usr/local/hist/.bash_history
+      IRB_HISTFILE: /usr/local/hist/.irb_history
+
+volumes:
+  bundle:
+  history:
+    external: true
+    name: rails_key_rotator-history

data/gemfiles/active_support_60.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 6.0.0", require: "active_support"
+
+gemspec path: "../"

data/gemfiles/active_support_61.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 6.1.0", require: "active_support"
+
+gemspec path: "../"

data/gemfiles/active_support_70.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 7.0.0", require: "active_support"
+
+gemspec path: "../"

data/gemfiles/active_support_71.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 7.1.0", require: "active_support"
+
+gemspec path: "../"

data/lib/rails_key_rotator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsKeyRotator
+  VERSION = "0.1.1"
+end

data/lib/rails_key_rotator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "rails_key_rotator/version"
+require "tempfile"
+require "active_support"
+require "active_support/encrypted_configuration"
+
+module RailsKeyRotator
+  class Error < StandardError; end
+  # Your code goes here...
+  class << self
+    def call
+      return if ENV["RAILS_MASTER_KEY"].blank?
+
+      if ENV.fetch("RAILS_MASTER_KEY_NEW", false)
+        if can_read_credentials!
+          ENV["RAILS_MASTER_KEY"] = ENV.fetch("RAILS_MASTER_KEY_NEW")
+          say "NEW key"
+        else
+          say "OLD key"
+        end
+      end
+    end
+
+    private
+
+    def can_read_credentials!
+      ActiveSupport::EncryptedConfiguration.new(
+        config_path: credential_path,
+        env_key: "RAILS_MASTER_KEY_NEW",
+        key_path: "",
+        raise_if_missing_key: true
+      ).read
+    rescue ActiveSupport::MessageEncryptor::InvalidMessage
+      false
+    end
+
+    def credential_path
+      Rails.root.join("config/credentials/#{env}.yml.enc")
+    end
+
+    def say(message)
+      warn "\e[41;37;1m\n\n\tKeyRotator: Using #{message} for #{env} env\n\e[0m"
+    end
+
+    def env
+      defined?(Rails) ? Rails.env : (ENV["RAILS_ENV"] || "test")
+    end
+  end
+end

data/rails_key_rotator.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/rails_key_rotator/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rails_key_rotator"
+  spec.version = RailsKeyRotator::VERSION
+  spec.authors = ["Leon Berenschot"]
+  spec.email = ["leon@wendbaar.nl"]
+
+  spec.summary = "Rotate your RAILS_MASTER_KEY with ease"
+  # spec.description = "TODO: Write a longer description or delete this line."
+  spec.homepage = "https://wendbaar.nl"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/LeipeLeon/rails_key_rotator"
+  spec.metadata["changelog_uri"] = "https://github.com/LeipeLeon/rails_key_rotator/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", ">= 6.0", "< 7.2"
+end

data/sig/rails_key_rotator.rbs

@@ -0,0 +1,4 @@
+module RailsKeyRotator
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: rails_key_rotator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Leon Berenschot
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+description: 
+email:
+- leon@wendbaar.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Appraisals
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dip.yml
+- docker-compose.yml
+- gemfiles/active_support_60.gemfile
+- gemfiles/active_support_61.gemfile
+- gemfiles/active_support_70.gemfile
+- gemfiles/active_support_71.gemfile
+- lib/rails_key_rotator.rb
+- lib/rails_key_rotator/version.rb
+- rails_key_rotator.gemspec
+- sig/rails_key_rotator.rbs
+homepage: https://wendbaar.nl
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://wendbaar.nl
+  source_code_uri: https://github.com/LeipeLeon/rails_key_rotator
+  changelog_uri: https://github.com/LeipeLeon/rails_key_rotator/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Rotate your RAILS_MASTER_KEY with ease
+test_files: []