Class: ActiveSupport::EncryptedFile

Inherits:
Object
  • Object
show all
Defined in:
lib/active_support/encrypted_file.rb

Direct Known Subclasses

EncryptedConfiguration

Defined Under Namespace

Classes: InvalidKeyLengthError, MissingContentError, MissingKeyError

Constant Summary collapse

CIPHER =
"aes-128-gcm"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(content_path:, key_path:, env_key:, raise_if_missing_key:) ⇒ EncryptedFile

Returns a new instance of EncryptedFile.


42
43
44
45
46
# File 'lib/active_support/encrypted_file.rb', line 42

def initialize(content_path:, key_path:, env_key:, raise_if_missing_key:)
  @content_path = Pathname.new(content_path).yield_self { |path| path.symlink? ? path.realpath : path }
  @key_path = Pathname.new(key_path)
  @env_key, @raise_if_missing_key = env_key, raise_if_missing_key
end

Instance Attribute Details

#content_pathObject (readonly)

Returns the value of attribute content_path


40
41
42
# File 'lib/active_support/encrypted_file.rb', line 40

def content_path
  @content_path
end

#env_keyObject (readonly)

Returns the value of attribute env_key


40
41
42
# File 'lib/active_support/encrypted_file.rb', line 40

def env_key
  @env_key
end

#key_pathObject (readonly)

Returns the value of attribute key_path


40
41
42
# File 'lib/active_support/encrypted_file.rb', line 40

def key_path
  @key_path
end

#raise_if_missing_keyObject (readonly)

Returns the value of attribute raise_if_missing_key


40
41
42
# File 'lib/active_support/encrypted_file.rb', line 40

def raise_if_missing_key
  @raise_if_missing_key
end

Class Method Details

.expected_key_lengthObject

:nodoc:


35
36
37
# File 'lib/active_support/encrypted_file.rb', line 35

def self.expected_key_length # :nodoc:
  @expected_key_length ||= generate_key.length
end

.generate_keyObject


31
32
33
# File 'lib/active_support/encrypted_file.rb', line 31

def self.generate_key
  SecureRandom.hex(ActiveSupport::MessageEncryptor.key_len(CIPHER))
end

Instance Method Details

#change(&block) ⇒ Object


65
66
67
# File 'lib/active_support/encrypted_file.rb', line 65

def change(&block)
  writing read, &block
end

#keyObject


48
49
50
# File 'lib/active_support/encrypted_file.rb', line 48

def key
  read_env_key || read_key_file || handle_missing_key
end

#readObject


52
53
54
55
56
57
58
# File 'lib/active_support/encrypted_file.rb', line 52

def read
  if !key.nil? && content_path.exist?
    decrypt content_path.binread
  else
    raise MissingContentError, content_path
  end
end

#write(contents) ⇒ Object


60
61
62
63
# File 'lib/active_support/encrypted_file.rb', line 60

def write(contents)
  IO.binwrite "#{content_path}.tmp", encrypt(contents)
  FileUtils.mv "#{content_path}.tmp", content_path
end