ropensci / cyphr

:shipit: Humane encryption

Home Page:https://docs.ropensci.org/cyphr

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Comments about the intro vignette

maelle opened this issue · comments

🐨

  • " for that see the excellent vignettes in the openssl and sodium packages." add links to them. Oh I see "In the sodium package there is a vignette (vignette("crypto101"))"... if they have no pkgdown website state that one can find the vignettes after having installed the packages with command blablabla.
  • " many people (especially on Linux and macOS) have a keypair already. " do they have to know they have one? How can they check they have one? Later you say "Chances are, you have an openssl keypair in your .ssh/ directory." is this only not on Windows?
  • so the way the cyphr function know which kind of encryption to use is by recognizing the type of key?
  • say at the beginning of the vignette that and when you will explain how to save keys.
  • you could even give roles to Alice and Bob for a change, like "an epidemiologist" and "a statistician" and say what file they want to exchange.
  • technically how would they send the encrypted string? Save it as RData and then attach it to an email? might be good to give an example.
  • I was a bit puzzled that after explaining how to encrypt a string, you say you're going to speak about other objects... before coming back to strings.
  • "If you save this to disk with saveRDS it will be readable by everyone. " -> "If you save this to disk with saveRDS it will be readable by everyone before you erase it. "?
  • "moderately nasty call rewriting. " explain why it is nasty (and why it is moderately nasty)
  • maybe end the vignette with a short conclusion about where to find more information on some topics + where to get help for this package?