aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/development/test-vectors.rst3
-rw-r--r--docs/faq.rst18
-rw-r--r--docs/index.rst4
-rw-r--r--docs/spelling_wordlist.txt1
4 files changed, 26 insertions, 0 deletions
diff --git a/docs/development/test-vectors.rst b/docs/development/test-vectors.rst
index f47f08de..1aa71106 100644
--- a/docs/development/test-vectors.rst
+++ b/docs/development/test-vectors.rst
@@ -15,6 +15,7 @@ Asymmetric Ciphers
* RSA PKCS1 from the RSA FTP site (ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-1/
and ftp://ftp.rsa.com/pub/rsalabs/tmp/).
+* OpenSSL PEM serialization vectors from the `OpenSSL test suite`_ and `GnuTLS test suite`_.
Hashes
~~~~~~
@@ -100,3 +101,5 @@ header format (substituting the correct information):
.. _`Whirlpool website`: http://www.larc.usp.br/~pbarreto/WhirlpoolPage.html
.. _`Specification repository`: https://github.com/fernet/spec
.. _`errata`: http://www.rfc-editor.org/errata_search.php?rfc=6238
+.. _`OpenSSL test suite`: http://git.openssl.org/gitweb/?p=openssl.git;a=blob;f=test/testrsa.pem;h=aad21067a8f7cb93a52a511eb9162fd83be39135;hb=66e8211c0b1347970096e04b18aa52567c325200
+.. _`GnuTLS test suite`: https://gitorious.org/gnutls/gnutls/commit/f16ef39ef0303b02d7fa590a37820440c466ce8d
diff --git a/docs/faq.rst b/docs/faq.rst
new file mode 100644
index 00000000..cbbb74ad
--- /dev/null
+++ b/docs/faq.rst
@@ -0,0 +1,18 @@
+Frequently Asked Questions
+==========================
+
+How does ``cryptography`` compare to NaCl (Networking and Cryptography Library)?
+--------------------------------------------------------------------------------
+
+While ``cryptography`` and `NaCl`_ both share the goal of making cryptography
+easier, and safer, to use for developers, ``cryptography`` is designed to be a
+general purpose library, interoperable with existing systems, while NaCl
+features a collection of hand selected algorithms.
+
+``cryptography``'s :ref:`recipes <cryptography-layout>` layer has similar goals
+to NaCl.
+
+If you prefer NaCl's design, we highly recommend `PyNaCl`_.
+
+.. _`NaCl`: http://nacl.cr.yp.to/
+.. _`PyNaCl`: https://pynacl.readthedocs.org
diff --git a/docs/index.rst b/docs/index.rst
index c8ef41b6..176405b5 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -33,6 +33,9 @@ existing libraries:
* Poor introspectability, and thus poor testability.
* Extremely error prone APIs, and bad defaults.
+
+.. _cryptography-layout:
+
Layout
------
@@ -60,6 +63,7 @@ The recipes layer
fernet
random-numbers
exceptions
+ faq
glossary
The hazardous materials layer
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
index 14b0b773..9bc84e50 100644
--- a/docs/spelling_wordlist.txt
+++ b/docs/spelling_wordlist.txt
@@ -18,6 +18,7 @@ fernet
Fernet
hazmat
indistinguishability
+interoperable
introspectability
invariants
iOS