1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/aes.R
\name{aes_cbc}
\alias{aes_cbc}
\alias{aes_ctr_encrypt}
\alias{aes_ctr_decrypt}
\alias{aes_cbc_encrypt}
\alias{aes_cbc_decrypt}
\alias{aes_gcm_encrypt}
\alias{aes_gcm_decrypt}
\alias{aes_keygen}
\title{Symmetric AES encryption}
\usage{
aes_ctr_encrypt(data, key, iv = rand_bytes(16))
aes_ctr_decrypt(data, key, iv = attr(data, "iv"))
aes_cbc_encrypt(data, key, iv = rand_bytes(16))
aes_cbc_decrypt(data, key, iv = attr(data, "iv"))
aes_gcm_encrypt(data, key, iv = rand_bytes(12))
aes_gcm_decrypt(data, key, iv = attr(data, "iv"))
aes_keygen(length = 16)
}
\arguments{
\item{data}{raw vector or path to file with data to encrypt or decrypt}
\item{key}{raw vector of length 16, 24 or 32, e.g. the hash of a shared secret}
\item{iv}{raw vector of length 16 (aes block size) or NULL. The initialization vector
is not secret but should be random}
\item{length}{how many bytes to generate. Usually 16 (128-bit) or 12 (92-bit) for \code{aes_gcm}}
}
\description{
Low-level symmetric encryption/decryption using the AES block cipher in CBC mode.
The key is a raw vector, for example a hash of some secret. When no shared
secret is available, a random key can be used which is exchanged via an
asymmetric protocol such as RSA. See \code{\link[=rsa_encrypt]{rsa_encrypt()}} for a worked example
or \code{\link[=encrypt_envelope]{encrypt_envelope()}} for a high-level wrapper combining AES and RSA.
}
\examples{
# aes-256 requires 32 byte key
passphrase <- charToRaw("This is super secret")
key <- sha256(passphrase)
# symmetric encryption uses same key for decryption
x <- serialize(iris, NULL)
y <- aes_cbc_encrypt(x, key = key)
x2 <- aes_cbc_decrypt(y, key = key)
stopifnot(identical(x, x2))
}
|