diff options
| -rw-r--r-- | docs/hazmat/primitives/asymmetric/dsa.rst | 10 | ||||
| -rw-r--r-- | docs/hazmat/primitives/mac/cmac.rst | 6 | ||||
| -rw-r--r-- | docs/hazmat/primitives/mac/hmac.rst | 4 | ||||
| -rw-r--r-- | docs/hazmat/primitives/symmetric-encryption.rst | 4 | ||||
| -rw-r--r-- | docs/installation.rst | 18 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 1 |
6 files changed, 33 insertions, 10 deletions
diff --git a/docs/hazmat/primitives/asymmetric/dsa.rst b/docs/hazmat/primitives/asymmetric/dsa.rst index f7abaf0f..cc46029c 100644 --- a/docs/hazmat/primitives/asymmetric/dsa.rst +++ b/docs/hazmat/primitives/asymmetric/dsa.rst @@ -38,11 +38,11 @@ DSA Generate a new ``DSAParameters`` instance using ``backend``. :param int key_size: The length of the modulus in bits. It should be - either "1024, 2048 or 3072". For keys generated in 2014 this should - be `at least 2048`_ (See page 41). - Note that some applications (such as SSH) have not yet gained support - for larger key sizes specified in FIPS 186-3 and are still restricted - to only the 1024-bit keys specified in FIPS 186-2. + either 1024, 2048 or 3072. For keys generated in 2014 this should + be `at least 2048`_ (See page 41). Note that some applications + (such as SSH) have not yet gained support for larger key sizes + specified in FIPS 186-3 and are still restricted to only the + 1024-bit keys specified in FIPS 186-2. :return: A new instance of ``DSAParameters`` diff --git a/docs/hazmat/primitives/mac/cmac.rst b/docs/hazmat/primitives/mac/cmac.rst index a6b048b5..1fde1398 100644 --- a/docs/hazmat/primitives/mac/cmac.rst +++ b/docs/hazmat/primitives/mac/cmac.rst @@ -38,9 +38,9 @@ A subset of CMAC with the AES-128 algorithm is described in :rfc:`4493`. :class:`~cryptography.exceptions.UnsupportedAlgorithm` exception will be raised. - If the `algorithm`` isn't a - :class:`~cryptography.primitives.interfaces.BlockCipherAlgorithm` provider, - ``TypeError`` will be raised. + If ``algorithm`` isn't a + :class:`~cryptography.hazmat.primitives.interfaces.BlockCipherAlgorithm` + provider then ``TypeError`` will be raised. To check that a given signature is correct use the :meth:`verify` method. You will receive an exception if the signature is wrong: diff --git a/docs/hazmat/primitives/mac/hmac.rst b/docs/hazmat/primitives/mac/hmac.rst index 11b10735..e20a4034 100644 --- a/docs/hazmat/primitives/mac/hmac.rst +++ b/docs/hazmat/primitives/mac/hmac.rst @@ -38,6 +38,10 @@ of a message. :class:`~cryptography.exceptions.UnsupportedAlgorithm` exception will be raised. + If ``algorithm`` isn't a + :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` provider + then ``TypeError`` will be raised. + To check that a given signature is correct use the :meth:`verify` method. You will receive an exception if the signature is wrong: diff --git a/docs/hazmat/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst index c98b3814..78bf6637 100644 --- a/docs/hazmat/primitives/symmetric-encryption.rst +++ b/docs/hazmat/primitives/symmetric-encryption.rst @@ -134,8 +134,8 @@ Algorithms .. versionadded:: 0.4 - SEED is a block cipher developed by the Korea Information Security Agency ( - KISA). It is defined in :rfc:`4269` and is used broadly throughout South + SEED is a block cipher developed by the Korea Information Security Agency + (KISA). It is defined in :rfc:`4269` and is used broadly throughout South Korean industry, but rarely found elsewhere. :param bytes key: The secret key. This must be kept secret. ``128`` bits in diff --git a/docs/installation.rst b/docs/installation.rst index 3ebbecfd..865e4cb6 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -73,6 +73,7 @@ You should now be able to build and install cryptography with the usual $ pip install cryptography + Using your own OpenSSL on Linux ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -122,6 +123,23 @@ or `MacPorts`_: $ sudo port install openssl $ env ARCHFLAGS="-arch x86_64" LDFLAGS="-L/opt/local/lib" CFLAGS="-I/opt/local/include" pip install cryptography +Building cryptography with conda +-------------------------------- + +Because of a `bug in conda`_, attempting to install cryptography out of the box +will result in an error. This can be resolved by setting the +``DYLD_LIBRARY_PATH`` environment variable: + +.. code-block:: console + + $ env DYLD_LIBRARY_PATH="$HOME/anaconda/lib" pip install cryptography + +You will need to set this variable every time you start Python. For more +information, consult `Greg Wilson's blog post`_ on the subject. + + .. _`Homebrew`: http://brew.sh .. _`MacPorts`: http://www.macports.org .. _`pre-compiled binaries`: https://www.openssl.org/related/binaries.html +.. _`bug in conda`: https://github.com/conda/conda-recipes/issues/110 +.. _`Greg Wilson's blog post`: http://software-carpentry.org/blog/2014/04/mr-biczo-was-right.html diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index aae52ae7..b5896158 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -8,6 +8,7 @@ Changelog ciphertext committer committers +conda crypto cryptographic cryptographically |