Movatterモバイル変換

Encryption for R Data

{rmonocypher} provides a simple, high-level interfacefor easily encrypting R objects using a strong, modern cryptographictechnique.

A typical use-case this package addresses:

I want to easily encrypt and save data to a public location (e.g. shared drive, cloud drive, etc) which only I can decrypt.

What’s in the box

• decrypt()/encrypt() read/write encrypted Robjects to file
• argon2() derives encryption keys from passwords
• rbyte() generates secure random bytes using youroperating system’s CSPRNG.

Technicalbona fides

• Cryptographic primitives are provided by the includedmonocypher library(v4.0.2)
• Encryption method isXChaCha20-Poly1305which combines ChaCha20 stream cipher (extended nonce variant) withPoly1305 message authentication.
• Encryption process follows RFC 8439‘AuthenticatedEncryption with Additional Data (AEAD)’
• Key derivation usesArgon2 password-based keyderviation.
• Cryptographically secure pseudo-random number generation (CSPRNG) isprovided by the operating system are used to generate any requiredrandom bytes.

Installation

You can install the latest development version fromGitHubwith:

# install.package('remotes')remotes::install_github('coolbutuseless/rmonocypher')

Read/write data to anencrypted file

Encrypt any R object and save to file.

encrypt(mydata,dst ="SharedDrive/mydata.dat",key ="mykey")

Then decrypt the object using the same key.

decrypt(src ="SharedDrive/mydata.dat",key ="mykey")

For more details on how passwords are used to derive encryption keys,and for other ways of supplying and generating keys see the Vignette:EncryptionKeys.

Vignettes

• EncryptionKeys
  • Generating encryption keys from passwords withargon2()
  • Using random bytes as the encryption key
  • Using hexadecimal string as the encryption key
• TechnicalNotes
  • Background on the encryptiong techniques used
• UsingAdditional Data
  • Advanced technique which is not needed for regular use of thispackage.
  • Details on usingadditional data
  • Worked example