gy_zip: Zip and encrypt external files using goldeneye

In ku-awdc/goldeneye: Sharing Secrets Safely

Zip and encrypt external files using goldeneye

Description

Zip and encrypt external files using goldeneye

Usage

gy_zip(
  input_files,
  file = stop("file must be specified (.rfg file extension is recommended)"),
  compression_level = 5,
  users = character(0),
  local_user = TRUE,
  comment = "",
  funs = gy_key_funs("identity")
)

gy_unzip(
  file = stop("file must be specified (.rfg file extension is recommended)"),
  directory = getwd(),
  unzip = TRUE,
  overwrite = FALSE,
  run_custom = TRUE
)

Arguments

input_files	one or more files to add to the zip archive
file	the filename to which the encrypted object will be saved
compression_level	compression level to use on a scale of 1-9 (passed to zip)
users	a character vector of (other) users within your current user group for whom the encrypted file will be decryptable. Alternatively, this can be a vector of paths/urls to public keys, or a mixture of the two.
local_user	should the current user also be able to decrypt thw file?
comment	an optional comment that will be sent (unencrypted) along with the file
funs	optional additional encryption steps: this must be the output of a call to gy_key_funs
directory	the directory to which the decrypted/unzipped files will be saved
unzip	should the decrypted files also be unzipped?
overwrite	should the file be overwritten, if it exists?
run_custom	should any custom decryption functions be run automatically?

ku-awdc/goldeneye documentation built on Jan. 30, 2024, 12:35 a.m.