aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-19 12:12:28 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-19 12:12:28 -0600
commitd669cd38121cde079a92aabee36ca4c3a44fbf87 (patch)
tree81faced805df4ed09b7cbca0a41aaef62460cc39 /docs
parent602d4005b856eb638e59aa1d2a3359e144bb0196 (diff)
parent4577c6b9f09a121710ff0320212083291db19c64 (diff)
downloadcryptography-d669cd38121cde079a92aabee36ca4c3a44fbf87.tar.gz
cryptography-d669cd38121cde079a92aabee36ca4c3a44fbf87.tar.bz2
cryptography-d669cd38121cde079a92aabee36ca4c3a44fbf87.zip
Merge branch 'master' into common-crypto-backend
* master: (24 commits) Expose the innards of DH and DSA More bindings for asymmetric stuff Tell cffi these opaque types are pointers. rename variable to be less confusing and terrible Document when the common crypto bindings were added Expose a name needed for ECDHE -- the NIDs are always available Expose the nids for the various eliptical curve things. I don't understand what these mean. Specify the epub theme to fix the epub build on RTD. Added forgotten decl reversed Allow these to not be defined because lololol fedora/centos add conditional ERR_remove_thread_state. PyOpenSSL uses this Don't require sphinx spelling to be installed, for readthedocs benefit This is also a requirement oops Start binding some stuff for ECDHE in pyOpenSSL. check if openssl is installed via homebrew on osx. install if not Verify the tag len for GCM remove comment that's no longer needed Make just one call to ffi.cdef for most of the definitions ...
Diffstat (limited to 'docs')
-rw-r--r--docs/changelog.rst5
-rw-r--r--docs/conf.py11
-rw-r--r--docs/hazmat/bindings/commoncrypto.rst2
-rw-r--r--docs/hazmat/primitives/symmetric-encryption.rst5
4 files changed, 21 insertions, 2 deletions
diff --git a/docs/changelog.rst b/docs/changelog.rst
index 41db635e..289992f4 100644
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -1,9 +1,12 @@
Changelog
=========
+
0.2 - 2014-XX-XX
~~~~~~~~~~~~~~~~
-* In development.
+**In development**
+
+* Added initial CommonCrypto bindings.
0.1 - 2014-01-08
~~~~~~~~~~~~~~~~
diff --git a/docs/conf.py b/docs/conf.py
index a42dcb22..3486fb38 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -19,6 +19,11 @@ try:
except ImportError:
sphinx_rtd_theme = None
+try:
+ from sphinxcontrib import spelling
+except ImportError:
+ spelling = None
+
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -38,9 +43,11 @@ extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
'cryptography-docs',
- 'sphinxcontrib.spelling',
]
+if spelling is not None:
+ extensions.append('sphinxcontrib.spelling')
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -263,3 +270,5 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
+
+epub_theme = 'epub'
diff --git a/docs/hazmat/bindings/commoncrypto.rst b/docs/hazmat/bindings/commoncrypto.rst
index 25535e02..c4f614c2 100644
--- a/docs/hazmat/bindings/commoncrypto.rst
+++ b/docs/hazmat/bindings/commoncrypto.rst
@@ -5,6 +5,8 @@ CommonCrypto Binding
.. currentmodule:: cryptography.hazmat.bindings.commoncrypto.binding
+.. versionadded:: 0.2
+
These are `CFFI`_ bindings to the `CommonCrypto`_ C library. It is available on
Mac OS X.
diff --git a/docs/hazmat/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst
index 83165690..7d954046 100644
--- a/docs/hazmat/primitives/symmetric-encryption.rst
+++ b/docs/hazmat/primitives/symmetric-encryption.rst
@@ -324,6 +324,11 @@ Modes
return (iv, ciphertext, encryptor.tag)
def decrypt(key, associated_data, iv, ciphertext, tag):
+ if len(tag) != 16:
+ raise ValueError(
+ "tag must be 16 bytes -- truncation not supported"
+ )
+
# Construct a Cipher object, with the key, iv, and additionally the
# GCM tag used for authenticating the message.
decryptor = Cipher(