Need help with encryptedRmd?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

dirkschumacher
134 Stars 3 Forks Other 73 Commits 6 Opened issues

Description

🔑 Password protected markdown html reports in R using libsodium

Services available

!
?

Need anything else?

Contributors list

# 176,895
Lisp
R
linear-...
Shell
62 commits

lifecycle CRAN
status R build
status <!-- badges: end -->

Password protected html markdown documents

Self-encrypt html markdown reports using libsodium. The package lets you password protect markdown html documents and share them with others securely. The code needed to decrypt the file is bundled into the exported html file, which makes the resulting file fully self contained.

Use at your own risk. Feedback and bug reports very welcome!

Installation

install.packages("encryptedRmd")
remotes::install_github("dirkschumacher/encryptedRmd")

Functions

Encrypt html files

library(encryptedRmd)
encrypt_html_file("devel/example/test.html", output_path = "docs/test.encrypted.html")
#> The key to your file is: f5c8c13752cf4e8cc59b59e9f96279ceb6836fc8ce957e55e232724dd80c318f
#> Your file has been encrypted and saved at docs/test.encrypted.html

You can take a look at the exported file here and use the key printed above to decrypt it.

Encrypted
rmarkdown
html format

---
title: "test"
output: encryptedRmd::encrypted_html_document
---

See here for an example. After knitting, the document is encrypted with a random key and the file is stored in the same directory together with the key.

Inspiration

Inspired and based on the work by @derhuerst on self encrypting html pages.

License

MIT

Development

In

devel/r-encrypted-html-template
the code to generate the javascript file is contained. In order to update the template, you have to run the following:
  • In
    devel/r-encrypted-html-template
    run
    npm run build
    . This creates a new version of the template and copies it to
    devel/html-template.js
    . It also creates a file called
    JSLICENSES.txt
    that contains all licenses of used node packages.
  • In
    devel
    run
    combine.R
    . This generates the file report template and copies it to
    inst/html-template.html
    . This template is then used within the R package to generate encrypted html files.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.