Skip to content

Support rotation for encryption and secret key base #945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zetter-rpf merged 3 commits into from
Jul 31, 2026
Merged

Support rotation for encryption and secret key base #945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d60a01f
Keep invitations working when secret key base changes
zetter-rpf Jul 31, 2026
92fd5fb
Remove unused deterministic encryption key
zetter-rpf Jul 31, 2026
c90d4fe
Support rotating of active record encryption keys
zetter-rpf Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ PROFILE_API_KEY=test # This has to match the value set in Profile (https://githu

# Run bin/rails db:encryption:init to generate values for these if you need to encrypt securely locally.
ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY=primary-key
ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY=deterministic-key
ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT=derivation-salt

EDITOR_ENCRYPTION_KEY=a1b2c3d4e5f67890123456789abcdef0123456789abcdef0123456789abcdef0
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ jobs:
REDIS_URL: redis://127.0.0.1:6379/1
HOSTNAME: 127.0.0.1
ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY: primary-key
ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY: deterministic-key
ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT: derivation-salt
EDITOR_ENCRYPTION_KEY: a1b2c3d4e5f67890123456789abcdef0123456789abcdef0123456789abcdef0
SALESFORCE_CONNECT_HOST: 127.0.0.1
Expand Down
11 changes: 9 additions & 2 deletions config/application.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,10 @@ class Application < Rails::Application

config.generators.system_tests = nil

config.active_record.encryption.primary_key = ENV.fetch('ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY')
config.active_record.encryption.deterministic_key = ENV.fetch('ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY')
config.active_record.encryption.primary_key = [
ENV.fetch('PREVIOUS_ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY', nil),
ENV.fetch('ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY')
].compact
Comment thread
zetter-rpf marked this conversation as resolved.
config.active_record.encryption.key_derivation_salt = ENV.fetch('ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT')

config.x.subscriptions.pardot_form_handler_url = ENV.fetch('PARDOT_SUBSCRIPTION_URL', '')
Expand All @@ -80,5 +82,10 @@ class Application < Rails::Application
appenders.add(io: $stdout, formatter: :json, application: "editor-api@#{ENV['HEROKU_SLUG_COMMIT'] || 'unknown'}")
end
end

config.before_initialize do |app|
previous_secret_key_base = ENV.fetch('PREVIOUS_SECRET_KEY_BASE', nil)
app.message_verifiers.rotate(secret_key_base: previous_secret_key_base) if previous_secret_key_base.present?
end
end
end
Loading