railties/lib/rails/commands/encrypted/encrypted_command.rb
# frozen_string_literal: true
require "pathname"
require "active_support"
require "rails/command/helpers/editor"
module Rails
module Command
class EncryptedCommand < Rails::Command::Base # :nodoc:
include Helpers::Editor
class_option :key, aliases: "-k", type: :string,
default: "config/master.key", desc: "The Rails.root relative path to the encryption key"
desc "edit", "Open the decrypted file in `$VISUAL` or `$EDITOR` for editing"
def edit(*)
load_environment_config!
ensure_encryption_key_has_been_added
ensure_encrypted_configuration_has_been_added
change_encrypted_configuration_in_system_editor
end
desc "show", "Show the decrypted contents of the file"
def show(*)
load_environment_config!
say encrypted_configuration.read.presence || missing_encrypted_configuration_message
end
private
def content_path
@content_path ||= args[0]
end
def key_path
options[:key]
end
def encrypted_configuration
@encrypted_configuration ||= Rails.application.encrypted(content_path, key_path: key_path)
end
def ensure_encryption_key_has_been_added
return if encrypted_configuration.key?
encryption_key_file_generator.add_key_file(key_path)
encryption_key_file_generator.ignore_key_file(key_path)
end
def ensure_encrypted_configuration_has_been_added
encrypted_file_generator.add_encrypted_file_silently(content_path, key_path)
end
def change_encrypted_configuration_in_system_editor
using_system_editor do
encrypted_configuration.change { |tmp_path| system_editor(tmp_path) }
say "File encrypted and saved."
warn_if_encrypted_configuration_is_invalid
end
rescue ActiveSupport::EncryptedFile::MissingKeyError => error
say error.message
rescue ActiveSupport::MessageEncryptor::InvalidMessage
say "Couldn't decrypt #{content_path}. Perhaps you passed the wrong key?"
end
def warn_if_encrypted_configuration_is_invalid
encrypted_configuration.validate!
rescue ActiveSupport::EncryptedConfiguration::InvalidContentError => error
say "WARNING: #{error.message}", :red
say ""
say "Your application will not be able to load '#{content_path}' until the error has been fixed.", :red
end
def encryption_key_file_generator
require "rails/generators"
require "rails/generators/rails/encryption_key_file/encryption_key_file_generator"
Rails::Generators::EncryptionKeyFileGenerator.new
end
def encrypted_file_generator
require "rails/generators"
require "rails/generators/rails/encrypted_file/encrypted_file_generator"
Rails::Generators::EncryptedFileGenerator.new
end
def missing_encrypted_configuration_message
if !encrypted_configuration.key?
"Missing '#{key_path}' to decrypt data. See `#{executable(:help)}`"
else
"File '#{content_path}' does not exist. Use `#{executable(:edit)} #{content_path}` to change that."
end
end
end
end
end