aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat
diff options
context:
space:
mode:
authorAlex Stapleton <alexs@prol.etari.at>2014-03-18 15:29:00 +0000
committerAlex Stapleton <alexs@prol.etari.at>2014-03-18 15:31:46 +0000
commitc5fffd3b33ace832697e2086411dc4e4f1ab03d0 (patch)
treee0c2671f4af2d5acacb28c99506ae31d43d98078 /docs/hazmat
parent38c42635490d24d7ee88041b52002156c6f5a676 (diff)
downloadcryptography-c5fffd3b33ace832697e2086411dc4e4f1ab03d0.tar.gz
cryptography-c5fffd3b33ace832697e2086411dc4e4f1ab03d0.tar.bz2
cryptography-c5fffd3b33ace832697e2086411dc4e4f1ab03d0.zip
Standardise on sentence case for titles
Diffstat (limited to 'docs/hazmat')
-rw-r--r--docs/hazmat/backends/commoncrypto.rst2
-rw-r--r--docs/hazmat/backends/index.rst4
-rw-r--r--docs/hazmat/backends/interfaces.rst2
-rw-r--r--docs/hazmat/backends/openssl.rst6
-rw-r--r--docs/hazmat/bindings/commoncrypto.rst2
-rw-r--r--docs/hazmat/bindings/index.rst2
-rw-r--r--docs/hazmat/bindings/openssl.rst2
-rw-r--r--docs/hazmat/primitives/asymmetric/index.rst2
-rw-r--r--docs/hazmat/primitives/asymmetric/padding.rst3
-rw-r--r--docs/hazmat/primitives/cryptographic-hashes.rst4
-rw-r--r--docs/hazmat/primitives/hmac.rst2
-rw-r--r--docs/hazmat/primitives/interfaces.rst10
-rw-r--r--docs/hazmat/primitives/key-derivation-functions.rst2
-rw-r--r--docs/hazmat/primitives/symmetric-encryption.rst6
-rw-r--r--docs/hazmat/primitives/twofactor.rst4
15 files changed, 26 insertions, 27 deletions
diff --git a/docs/hazmat/backends/commoncrypto.rst b/docs/hazmat/backends/commoncrypto.rst
index d31391d7..77d6612c 100644
--- a/docs/hazmat/backends/commoncrypto.rst
+++ b/docs/hazmat/backends/commoncrypto.rst
@@ -1,6 +1,6 @@
.. hazmat::
-CommonCrypto Backend
+CommonCrypto backend
====================
The `CommonCrypto`_ C library provided by Apple on OS X and iOS. The CommonCrypto
diff --git a/docs/hazmat/backends/index.rst b/docs/hazmat/backends/index.rst
index 983a44e9..aec7a1e0 100644
--- a/docs/hazmat/backends/index.rst
+++ b/docs/hazmat/backends/index.rst
@@ -3,7 +3,7 @@
Backends
========
-Getting a Backend
+Getting a backend
-----------------
.. currentmodule:: cryptography.hazmat.backends
@@ -24,7 +24,7 @@ the libraries we use in those backends changes.
:class:`~interfaces.CipherBackend`, :class:`~interfaces.HashBackend`, and
:class:`~interfaces.HMACBackend`.
-Individual Backends
+Individual backends
-------------------
.. toctree::
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst
index c3ea164a..c38f818f 100644
--- a/docs/hazmat/backends/interfaces.rst
+++ b/docs/hazmat/backends/interfaces.rst
@@ -1,6 +1,6 @@
.. hazmat::
-Backend Interfaces
+Backend interfaces
==================
.. currentmodule:: cryptography.hazmat.backends.interfaces
diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst
index 547fe769..fdfadf0b 100644
--- a/docs/hazmat/backends/openssl.rst
+++ b/docs/hazmat/backends/openssl.rst
@@ -1,6 +1,6 @@
.. hazmat::
-OpenSSL Backend
+OpenSSL backend
===============
The `OpenSSL`_ C library. Cryptography supports version ``0.9.8e`` (present in
@@ -34,7 +34,7 @@ Red Hat Enterprise Linux 5) and greater. Earlier versions may work but are
This will activate the default OpenSSL CSPRNG.
-OS Random Engine
+OS random engine
----------------
OpenSSL uses a user-space CSPRNG that is seeded from system random (
@@ -58,7 +58,7 @@ When importing only the binding it is added to the engine list but
**not activated**.
-OS Random Sources
+OS random sources
-----------------
On OS X and FreeBSD ``/dev/urandom`` is an alias for ``/dev/random`` and
diff --git a/docs/hazmat/bindings/commoncrypto.rst b/docs/hazmat/bindings/commoncrypto.rst
index e5a673b3..9484cfa1 100644
--- a/docs/hazmat/bindings/commoncrypto.rst
+++ b/docs/hazmat/bindings/commoncrypto.rst
@@ -1,6 +1,6 @@
.. hazmat::
-CommonCrypto Binding
+CommonCrypto binding
====================
.. currentmodule:: cryptography.hazmat.bindings.commoncrypto.binding
diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/bindings/index.rst
index caab8d6a..ccd36e3e 100644
--- a/docs/hazmat/bindings/index.rst
+++ b/docs/hazmat/bindings/index.rst
@@ -13,7 +13,7 @@ Using these functions directly is likely to require you to be careful in
managing memory allocation, locking and other resources.
-Individual Bindings
+Individual bindings
-------------------
.. toctree::
diff --git a/docs/hazmat/bindings/openssl.rst b/docs/hazmat/bindings/openssl.rst
index 9fce8f77..a6d1c484 100644
--- a/docs/hazmat/bindings/openssl.rst
+++ b/docs/hazmat/bindings/openssl.rst
@@ -1,6 +1,6 @@
.. hazmat::
-OpenSSL Binding
+OpenSSL binding
===============
.. currentmodule:: cryptography.hazmat.bindings.openssl.binding
diff --git a/docs/hazmat/primitives/asymmetric/index.rst b/docs/hazmat/primitives/asymmetric/index.rst
index 10319fad..7ec1c5f2 100644
--- a/docs/hazmat/primitives/asymmetric/index.rst
+++ b/docs/hazmat/primitives/asymmetric/index.rst
@@ -1,6 +1,6 @@
.. hazmat::
-Asymmetric Algorithms
+Asymmetric algorithms
=====================
.. toctree::
diff --git a/docs/hazmat/primitives/asymmetric/padding.rst b/docs/hazmat/primitives/asymmetric/padding.rst
index ab676b02..2a5de3c7 100644
--- a/docs/hazmat/primitives/asymmetric/padding.rst
+++ b/docs/hazmat/primitives/asymmetric/padding.rst
@@ -28,8 +28,7 @@ Padding
PKCS1 v1.5 (also known as simply PKCS1) is a simple padding scheme
developed for use with RSA keys. It is defined in :rfc:`3447`.
-
-Mask Generation Functions
+Mask generation functions
~~~~~~~~~~~~~~~~~~~~~~~~~
.. class:: MGF1(algorithm, salt_length)
diff --git a/docs/hazmat/primitives/cryptographic-hashes.rst b/docs/hazmat/primitives/cryptographic-hashes.rst
index b7eee2f5..c318feeb 100644
--- a/docs/hazmat/primitives/cryptographic-hashes.rst
+++ b/docs/hazmat/primitives/cryptographic-hashes.rst
@@ -1,6 +1,6 @@
.. hazmat::
-Message Digests
+Message digests
===============
.. currentmodule:: cryptography.hazmat.primitives.hashes
@@ -90,7 +90,7 @@ SHA-1
SHA-1 is a cryptographic hash function standardized by NIST. It produces an
160-bit message digest.
-SHA-2 Family
+SHA-2 family
~~~~~~~~~~~~
.. class:: SHA224()
diff --git a/docs/hazmat/primitives/hmac.rst b/docs/hazmat/primitives/hmac.rst
index ce4e8803..5d511bc4 100644
--- a/docs/hazmat/primitives/hmac.rst
+++ b/docs/hazmat/primitives/hmac.rst
@@ -1,6 +1,6 @@
.. hazmat::
-Hash-based Message Authentication Codes
+Hash-based message authentication codes
=======================================
.. currentmodule:: cryptography.hazmat.primitives.hmac
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst
index cefd81ac..9a1f3307 100644
--- a/docs/hazmat/primitives/interfaces.rst
+++ b/docs/hazmat/primitives/interfaces.rst
@@ -12,7 +12,7 @@ to document argument and return types.
.. _`Abstract Base Classes`: http://docs.python.org/3.2/library/abc.html
-Symmetric Ciphers
+Symmetric ciphers
~~~~~~~~~~~~~~~~~
.. currentmodule:: cryptography.hazmat.primitives.interfaces
@@ -47,7 +47,7 @@ Symmetric Ciphers
The number of bits in a block.
-Cipher Modes
+Cipher modes
------------
Interfaces used by the symmetric cipher modes described in
@@ -103,7 +103,7 @@ Interfaces used by the symmetric cipher modes described in
Exact requirements of the nonce are described by the documentation of
individual modes.
-Asymmetric Interfaces
+Asymmetric interfaces
~~~~~~~~~~~~~~~~~~~~~
.. class:: RSAPrivateKey
@@ -377,7 +377,7 @@ Asymmetric Interfaces
.. attribute:: name
-Hash Algorithms
+Hash algorithms
~~~~~~~~~~~~~~~
.. class:: HashAlgorithm
@@ -402,7 +402,7 @@ Hash Algorithms
The internal block size of the hash algorithm in bytes.
-Key Derivation Functions
+Key derivation functions
~~~~~~~~~~~~~~~~~~~~~~~~
.. class:: KeyDerivationFunction
diff --git a/docs/hazmat/primitives/key-derivation-functions.rst b/docs/hazmat/primitives/key-derivation-functions.rst
index 174b68d2..6196d951 100644
--- a/docs/hazmat/primitives/key-derivation-functions.rst
+++ b/docs/hazmat/primitives/key-derivation-functions.rst
@@ -1,6 +1,6 @@
.. hazmat::
-Key Derivation Functions
+Key derivation functions
========================
.. currentmodule:: cryptography.hazmat.primitives.kdf
diff --git a/docs/hazmat/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst
index 71a1064e..f7e8d5b7 100644
--- a/docs/hazmat/primitives/symmetric-encryption.rst
+++ b/docs/hazmat/primitives/symmetric-encryption.rst
@@ -1,7 +1,7 @@
.. hazmat:: /fernet
-Symmetric Encryption
+Symmetric encryption
====================
.. currentmodule:: cryptography.hazmat.primitives.ciphers
@@ -130,7 +130,7 @@ Algorithms
:param bytes key: The secret key, This must be kept secret. 40 to 128 bits
in length in increments of 8 bits.
-Weak Ciphers
+Weak ciphers
------------
.. warning::
@@ -372,7 +372,7 @@ Modes
a secret message!
-Insecure Modes
+Insecure modes
--------------
.. warning::
diff --git a/docs/hazmat/primitives/twofactor.rst b/docs/hazmat/primitives/twofactor.rst
index 124d0ef5..e9f5c7ff 100644
--- a/docs/hazmat/primitives/twofactor.rst
+++ b/docs/hazmat/primitives/twofactor.rst
@@ -1,6 +1,6 @@
.. hazmat::
-Two-factor Authentication
+Two-factor authentication
=========================
.. currentmodule:: cryptography.hazmat.primitives.twofactor
@@ -79,7 +79,7 @@ locks out the account for a period of time after a number of failed attempts.
The number of allowed attempts should be as low as possible while still
ensuring that usability is not significantly impacted.
-Re-synchronization of the Counter
+Re-synchronization of the counter
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The server's counter value should only be incremented on a successful HOTP