класс ActiveSupport::EncryptedFile

Родитель:: Object

Константы

CIPHER

Атрибуты

content_path [R]

env_key [R]

key_path [R]

raise_if_missing_key [R]

Общедоступные методы класса

generate_key () Показать исходный код

# File activesupport/lib/active_support/encrypted_file.rb, line 31
def self.generate_key
  SecureRandom.hex(ActiveSupport::MessageEncryptor.key_len(CIPHER))
end

new (content_path:, key_path:, env_key:, raise_if_missing_key:) Показать исходный код

# File activesupport/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

Общедоступные методы экземпляра

change (&block) Показать исходный код

# File activesupport/lib/active_support/encrypted_file.rb, line 83
def change(&block)
  writing read, &block
end

key () Показать исходный код

# File activesupport/lib/active_support/encrypted_file.rb, line 52
def key
  read_env_key || read_key_file || handle_missing_key
end

Возвращает ключ шифрования, сначала проверяя переменную окружения, указанную в env_key, а затем файл ключа, указанный в key_path. Если raise_if_missing_key имеет значение true, вызывает исключение MissingKeyError, если переменная окружения не задана и файл ключа не существует.

key? () Показать исходный код

# File activesupport/lib/active_support/encrypted_file.rb, line 58
def key?
  read_env_key || read_key_file
end

Возвращает truthy, если key имеет значение truthy. В противном случае возвращает falsy. В отличие от key, не вызывает исключение MissingKeyError, если raise_if_missing_key имеет значение true.

read () Показать исходный код

# File activesupport/lib/active_support/encrypted_file.rb, line 70
def read
  if !key.nil? && content_path.exist?
    decrypt content_path.binread.strip
  else
    raise MissingContentError, content_path
  end
end

Читает файл и возвращает расшифрованное содержимое.

Вызывает исключения:

MissingKeyError, если ключ отсутствует и raise_if_missing_key имеет значение true.
MissingContentError, если зашифрованный файл не существует или если ключ отсутствует.
ActiveSupport::MessageEncryptor::InvalidMessage, если содержимое невозможно расшифровать или проверить.

write (contents) Показать исходный код

# File activesupport/lib/active_support/encrypted_file.rb, line 78
def write(contents)
  IO.binwrite "#{content_path}.tmp", encrypt(contents)
  FileUtils.mv "#{content_path}.tmp", content_path
end