Sha256: 8ecea6f3f4bfc905bca6369e44881c90b2864a7853c58b9d1e2fb85bb2cdeb4e

Contents?: true

Size: 1.66 KB

Versions: 40

Compression:

Stored size: 1.66 KB

Contents

# frozen_string_literal: true

require "pathname"
require "rails/generators/base"
require "active_support/encrypted_file"

module Rails
  module Generators
    class EncryptionKeyFileGenerator < Base # :nodoc:
      def add_key_file(key_path)
        key_path = Pathname.new(key_path)

        unless key_path.exist?
          key = ActiveSupport::EncryptedFile.generate_key

          log "Adding #{key_path} to store the encryption key: #{key}"
          log ""
          log "Save this in a password manager your team can access."
          log ""
          log "If you lose the key, no one, including you, can access anything encrypted with it."

          log ""
          add_key_file_silently(key_path, key)
          log ""
        end
      end

      def add_key_file_silently(key_path, key = nil)
        create_file key_path, key || ActiveSupport::EncryptedFile.generate_key, perm: 0600
      end

      def ignore_key_file(key_path, ignore: key_ignore(key_path))
        if File.exist?(".gitignore")
          unless File.read(".gitignore").include?(ignore)
            log "Ignoring #{key_path} so it won't end up in Git history:"
            log ""
            append_to_file ".gitignore", ignore
            log ""
          end
        else
          log "IMPORTANT: Don't commit #{key_path}. Add this to your ignore file:"
          log ignore, :on_green
          log ""
        end
      end

      def ignore_key_file_silently(key_path, ignore: key_ignore(key_path))
        append_to_file ".gitignore", ignore if File.exist?(".gitignore")
      end

      private
        def key_ignore(key_path)
          [ "", "/#{key_path}", "" ].join("\n")
        end
    end
  end
end

Version data entries

40 entries across 40 versions & 5 rubygems

Version Path
railties-8.0.2 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/railties-7.1.3.4/lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-8.0.1 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-8.0.0.1 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-7.2.2.1 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-7.1.5.1 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-8.0.0 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-7.2.2 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-7.1.5 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-8.0.0.rc2 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-7.2.1.2 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-7.1.4.2 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-8.0.0.rc1 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-7.2.1.1 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-7.1.4.1 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
railties-8.0.0.beta1 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
omg-railties-8.0.0.alpha9 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
omg-railties-8.0.0.alpha8 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
omg-railties-8.0.0.alpha7 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb
omg-railties-8.0.0.alpha4 lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb