Class: ActiveSupport::EncryptedFile

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

Direct Known Subclasses

EncryptedConfiguration

Defined Under Namespace

Classes: 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.



32
33
34
35
36
 
# File 'activesupport/lib/active_support/encrypted_file.rb', line 32

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_path ⇒ Object (readonly)

Returns the value of attribute content_path



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

def content_path
  @content_path
end

#env_key ⇒ Object (readonly)

Returns the value of attribute env_key



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

def env_key
  @env_key
end

#key_path ⇒ Object (readonly)

Returns the value of attribute key_path



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

def key_path
  @key_path
end

#raise_if_missing_key ⇒ Object (readonly)

Returns the value of attribute raise_if_missing_key



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

def raise_if_missing_key
  @raise_if_missing_key
end

Class Method Details

.generate_key ⇒ Object 



25
26
27
 
# File 'activesupport/lib/active_support/encrypted_file.rb', line 25

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

Instance Method Details

#change(&block) ⇒ Object 



55
56
57
 
# File 'activesupport/lib/active_support/encrypted_file.rb', line 55

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

#key ⇒ Object 



38
39
40
 
# File 'activesupport/lib/active_support/encrypted_file.rb', line 38

def key
  read_env_key || read_key_file || handle_missing_key
end

#read ⇒ Object 



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

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

#write(contents) ⇒ Object 



50
51
52
53
 
# File 'activesupport/lib/active_support/encrypted_file.rb', line 50

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