Package {agecrypt}

agecrypt: File Encryption with the age Format

Description

A dependency-free implementation of the age v1 file encryption format, backed by a vendored copy of the C implementation agec. Encrypts to one or more X25519 recipients or with a passphrase, with optional ASCII armor. SSH-key recipients and plugins are not supported.

Author(s)

Maintainer: Pedro Baltazar pedrobtz@gmail.com [copyright holder]

Authors:

• Pedro Baltazar pedrobtz@gmail.com [copyright holder]

Other contributors:

• agec authors (Authors of the vendored 'agec' C implementation, https://git.sr.ht/~min/agec) [contributor, copyright holder]

See Also

Useful links:

• https://github.com/pedrobtz/agecrypt

• Report bugs at https://github.com/pedrobtz/agecrypt/issues

Encrypt and decrypt files

Description

File-to-file encryption. Large files are streamed in constant memory in C (they are not loaded into an R vector).

Usage

age_encrypt_file(
  input,
  output = NULL,
  recipients,
  armor = FALSE,
  overwrite = FALSE
)

age_decrypt_file(input, output = NULL, identities, overwrite = FALSE)

Arguments

Value

The output path, invisibly.

Examples

id <- age_keygen()
rec <- age_pubkey(id)
f <- tempfile(fileext = ".txt")
writeLines("hello", f)
enc <- age_encrypt_file(f, recipients = rec)
dec <- age_decrypt_file(enc, output = tempfile(), identities = id)
readLines(dec)

Parse or load age identities

Description

Parse or load age identities

Usage

age_identity(x)

Arguments

Value

An age_identity object.

Examples

id <- age_keygen()
# round-trip through a key file
f <- tempfile()
age_keygen(f)
id2 <- age_identity(f)

Explicitly scrub an identity's secret key material

Description

Zeroes and frees the secret bytes immediately rather than waiting for garbage collection. The identity becomes unusable afterwards.

Usage

age_identity_free(identity)

Arguments

Value

invisible(NULL).

Examples

id <- age_keygen()
age_identity_free(id)

Generate a new age identity

Description

Creates a fresh X25519 identity (key pair). The secret key is generated in C and never returned to R; to persist it, pass path so it is written directly to a key file in the standard age format.

Usage

age_keygen(path = NULL, overwrite = FALSE)

Arguments

Value

An age_identity object. Its print method shows only the public key; the secret is never printed.

Examples

id <- age_keygen()
id
age_pubkey(id)

Encrypt and decrypt with a passphrase

Description

Passphrase-based (scrypt) encryption, a separate mode from the recipient-based age_encrypt_raw() family. A file encrypted this way is decrypted with the matching ⁠age_decrypt_*_passphrase()⁠ function and the same passphrase — no key pair is involved.

Usage

age_encrypt_raw_passphrase(x, passphrase = NULL, armor = FALSE, log_n = 18)

age_decrypt_raw_passphrase(x, passphrase = NULL)

age_encrypt_file_passphrase(
  input,
  output = NULL,
  passphrase = NULL,
  armor = FALSE,
  overwrite = FALSE,
  log_n = 18
)

age_decrypt_file_passphrase(
  input,
  output = NULL,
  passphrase = NULL,
  overwrite = FALSE
)

Arguments

Value

The raw functions return a raw vector; the file functions return the output path invisibly.

Examples

ct <- age_encrypt_raw_passphrase(
  charToRaw("secret"),
  passphrase = "hunter2",
  log_n = 8
)
rawToChar(age_decrypt_raw_passphrase(ct, passphrase = "hunter2"))

Derive public recipient strings from identities

Description

Derive public recipient strings from identities

Usage

age_pubkey(identities)

Arguments

Value

A character vector of "age1..." recipient strings, one per identity.

Examples

id <- age_keygen()
age_pubkey(id)

Encrypt and decrypt raw vectors

Description

The core buffer transforms: no file I/O, nothing written to disk. All other verbs (⁠_file⁠, ⁠_text⁠) build on these.

Usage

age_encrypt_raw(x, recipients, armor = FALSE)

age_decrypt_raw(x, identities)

Arguments

Value

A raw vector: ciphertext for age_encrypt_raw(), plaintext for age_decrypt_raw().

Examples

id <- age_keygen()
rec <- age_pubkey(id)
ct <- age_encrypt_raw(charToRaw("hello"), recipients = rec)
rawToChar(age_decrypt_raw(ct, identities = id))

Encrypt and decrypt a single string

Description

Convenience wrappers over age_encrypt_raw() / age_decrypt_raw() for one string, ASCII-armored by default so the result is copy-pasteable. Encoding is forced to UTF-8 on the way in and marked on the way out.

Usage

age_encrypt_text(x, recipients, armor = TRUE)

age_decrypt_text(x, identities)

Arguments

Value

age_encrypt_text() returns a length-1 character string; age_decrypt_text() returns a length-1 UTF-8 string. age_decrypt_text() signals age_error_decrypt if the plaintext is not valid UTF-8 text (for binary payloads, use age_decrypt_raw()).

Examples

id <- age_keygen()
rec <- age_pubkey(id)
ct <- age_encrypt_text("db_password_123", recipients = rec)
age_decrypt_text(ct, identities = id)