encrypt_string: Encrypt a string

In talegari/safer: Encrypt and Decrypt Strings, R Objects and Files

Encrypt a string

Description

encrypt_string encrypts a string as a string or a raw vector and decrypt_string decrypts the encrypted string or a raw vector (encrypted using encrypt_string)

Usage

encrypt_string(string, key = "pass", pkey = NULL, ascii = TRUE,
  url = FALSE)

Arguments

string	A string(character vector of length 1) without embedded NULL to be encrypted or a raw vector.
key	For symmetric encryption, 'pkey' should be NULL (default) and 'key' can be either a string (Default is 'pass') or a raw object. For asymmetric encryption, both 'key' (private key of the encrypter) and 'pkey' (public key of the decrypter) should be raw objects.
pkey	See 'key'
ascii	(flag) When TRUE (default), the output is a string after base64 encoding. Else, the output is a raw vector.
url	(flag, default: FALSE) Whether the encoded string has to be url friendly.

Value

An encrypted string or a raw vector.

Examples

# symmetric case:
temp <- encrypt_string("hello, how are you", key = "secret")
all(
  is.character(temp)
  , decrypt_string(temp, "secret") == "hello, how are you"
  , class(try(decrypt_string(temp, "nopass"), silent = TRUE)) == "try-error"
  )

# string encoded as raw
res <- encrypt_string("tatvamasi", ascii = FALSE)
res

isTRUE(identical(decrypt_string(res), "tatvamasi"))

# asymmetric case:
alice <- keypair()
bob   <- keypair()
temp  <- encrypt_string("hello asymmetric", alice$private_key, bob$public_key)
temp2 <- decrypt_string(temp, bob$private_key, alice$public_key)
identical("hello asymmetric", temp2)

talegari/safer documentation built on Feb. 9, 2023, 3:43 p.m.