README.md in rbnacl-3.0.0 vs README.md in rbnacl-3.0.1
- old
+ new
@@ -76,10 +76,20 @@
of NaCl based upon the reference C code. Please see the libsodium project
for information regarding installation:
https://github.com/jedisct1/libsodium
+For FreeBSD users, libsodium is available both via pkgng and ports. To install
+a binary package:
+
+ pkg install libsodium
+
+To install from ports on FreeBSD, use your favorite ports front end (e.g.
+portmaster or portupgrade), or use make as follows:
+
+ cd /usr/ports/security/libsodium; make install clean
+
For OS X users, libsodium is available via homebrew and can be installed with:
brew install libsodium
### RbNaCl gem
@@ -105,10 +115,11 @@
## Documentation
RbNaCl's documentation can be found [in the Wiki][wiki]. The following features
are supported:
+* [SimpleBox]: easy-to-use public-key or secret-key encryption "on Rails"
* [Secret-key Encryption][secretkey]: authenticated symmetric encryption using a
single key shared among parties
* [Public-key Encryption][publickey]: securely send messages to a given public
key which can only be decrypted by a secret key
* [Digital Signatures][signatures]: sign messages with a private key which can
@@ -122,10 +133,11 @@
information.
[RDoc documentation][rdoc] is also available.
[wiki]: https://github.com/cryptosphere/rbnacl/wiki
+[simplebox]: https://github.com/cryptosphere/rbnacl/wiki/SimpleBox
[secretkey]: https://github.com/cryptosphere/rbnacl/wiki/Secret-Key-Encryption
[publickey]: https://github.com/cryptosphere/rbnacl/wiki/Public-Key-Encryption
[signatures]: https://github.com/cryptosphere/rbnacl/wiki/Digital-Signatures
[macs]: https://github.com/cryptosphere/rbnacl/wiki/Authenticators
[hashes]: https://github.com/cryptosphere/rbnacl/wiki/Hash-Functions
@@ -139,48 +151,22 @@
straightforward it should be considered experimental until audited
by professional cryptographers.
That said, it's probably still a million times better than OpenSSL...
-## Using Signed Gems
-
-The RbNaCl gem is signed by Tony Arcieri's certificate, which identifies
-as `bascule@gmail.com`. You can obtain the official certificate with:
-
-```
-curl https://raw.github.com/cryptosphere/rbnacl/master/bascule.cert > /tmp/bascule.cert
-gem cert -a /tmp/bascule.cert
-```
-
-You can verify the authenticity of bascule.cert by its SHA256 hash:
-
-```
-$ shasum -a 256 bascule.cert
-6e8b7e53d347ca6c6d214efef2b923aadecdd7650565f0eb1d8d0419723ae20c bascule.cert
-```
-
-If you get a different number than `6e8b7e53...`, this is not the cert you are
-looking for!
-
-If you'd like to install the gem in high security mode, run:
-
-```
-gem install rbnacl-1.0.0.gem -P HighSecurity
-```
-
## Reporting Security Problems
If you have discovered a bug in RbNaCl of a sensitive nature, i.e.
one which can compromise the security of RbNaCl users, you can
report it securely by sending a GPG encrypted message. Please use
the following key:
-https://raw.github.com/cryptosphere/rbnacl/master/rbnacl.gpg
+https://raw.github.com/cryptosphere/rbnacl/master/bascule.gpg
The key fingerprint is (or should be):
-`190E 42D6 8327 A515 BFDF AAE0 B210 269D BB2D 8787`
+`25C1 198A C8A1 8212 7D24 E665 666B AFA9 D77E E055`
## Learn More
While NaCl has designed to be easier-than-usual to use for a crypto
library, cryptography is an incredibly difficult subject and it's
@@ -205,9 +191,13 @@
## Important Questions
### Is it "Military Grade™"?
Only if your military understands twisted Edwards curves
+
+### Is it "Bank Grade™"?
+
+No, that means 3DES, which this library doesn't support, sorry
### Does it have a lock with a checkmark?
Sure, here you go: