mirror of
https://github.com/saymrwulf/cryptography.git
synced 2026-05-14 20:37:55 +00:00
Standardise on sentence case for titles
This commit is contained in:
Alex Stapleton
parent
38c4263549
commit
c5fffd3b33
25 changed files with 46 additions and 47 deletions
|
|
@ -1,4 +1,4 @@
|
|||
API Stability
|
||||
API stability
|
||||
=============
|
||||
|
||||
From its first release, ``cryptography`` will have a strong API stability
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
CAST5 Vector Creation
|
||||
CAST5 vector creation
|
||||
=====================
|
||||
|
||||
This page documents the code that was used to generate the CAST5 CBC, CFB, OFB,
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
IDEA Vector Creation
|
||||
IDEA vector creation
|
||||
=====================
|
||||
|
||||
This page documents the code that was used to generate the IDEA CBC, CFB, and
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Getting Started
|
||||
Getting started
|
||||
===============
|
||||
|
||||
Working on ``cryptography`` requires the installation of a small number of
|
||||
|
|
@ -14,7 +14,7 @@ dependencies, install ``cryptography`` in ``editable`` mode. For example:
|
|||
|
||||
You are now ready to run the tests and build the documentation.
|
||||
|
||||
Running Tests
|
||||
Running tests
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
``cryptography`` unit tests are found in the ``tests/`` directory and are
|
||||
|
|
@ -49,7 +49,7 @@ You may not have all the required Python versions installed, in which case you
|
|||
will see one or more ``InterpreterNotFound`` errors.
|
||||
|
||||
|
||||
Explicit Backend Selection
|
||||
Explicit backend selection
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
While testing you may want to run tests against a subset of the backends that
|
||||
|
|
@ -63,7 +63,7 @@ delimited list of backend names.
|
|||
$ tox -- --backend=openssl
|
||||
$ py.test --backend=openssl,commoncrypto
|
||||
|
||||
Building Documentation
|
||||
Building documentation
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``cryptography`` documentation is stored in the ``docs/`` directory. It is
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Reviewing/Merging Patches
|
||||
Reviewing/merging patches
|
||||
=========================
|
||||
|
||||
Everyone is encouraged to review open pull requests. When reviewing a patch try
|
||||
|
|
@ -32,7 +32,7 @@ These are small things that are not caught by the automated style checkers.
|
|||
* Does a variable need a better name?
|
||||
* Should this be a keyword argument?
|
||||
|
||||
Merge Requirements
|
||||
Merge requirements
|
||||
------------------
|
||||
|
||||
Because cryptography is so complex, and the implications of getting it wrong so
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Submitting Patches
|
||||
Submitting patches
|
||||
==================
|
||||
|
||||
* Always make a new branch for your work.
|
||||
|
|
@ -29,7 +29,7 @@ Additionally, every Python code file must contain
|
|||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
|
||||
API Considerations
|
||||
API considerations
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Most projects' APIs are designed with a philosophy of "make easy things easy,
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Test Vectors
|
||||
Test vectors
|
||||
============
|
||||
|
||||
Testing the correctness of the primitives implemented in each ``cryptography``
|
||||
|
|
@ -10,7 +10,7 @@ vector file as input to verify consistency between implemented backends.
|
|||
Sources
|
||||
-------
|
||||
|
||||
Asymmetric Ciphers
|
||||
Asymmetric ciphers
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* RSA PKCS #1 from the RSA FTP site (ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-1/
|
||||
|
|
@ -43,7 +43,7 @@ HMAC
|
|||
* HMAC-RIPEMD160 from :rfc:`2286`.
|
||||
* HMAC-SHA2 (224, 256, 384, 512) from :rfc:`4231`.
|
||||
|
||||
Key Derivation Functions
|
||||
Key derivation functions
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* HKDF (SHA1, SHA256) from :rfc:`5869`.
|
||||
|
|
@ -55,7 +55,7 @@ Recipes
|
|||
|
||||
* Fernet from its `specification repository`_.
|
||||
|
||||
Symmetric Ciphers
|
||||
Symmetric ciphers
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
* AES (CBC, CFB, ECB, GCM, OFB) from `NIST CAVP`_.
|
||||
|
|
@ -72,14 +72,14 @@ Symmetric Ciphers
|
|||
* IDEA (CBC, CFB, OFB) generated by this project.
|
||||
See: :doc:`/development/custom-vectors/idea`
|
||||
|
||||
Two Factor Authentication
|
||||
Two factor authentication
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* HOTP from :rfc:`4226`
|
||||
* TOTP from :rfc:`6238` (Note that an `errata`_ for the test vectors in RFC
|
||||
6238 exists)
|
||||
|
||||
Creating Test Vectors
|
||||
Creating test vectors
|
||||
---------------------
|
||||
|
||||
When official vectors are unavailable ``cryptography`` may choose to build
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Doing a Release
|
||||
Doing a release
|
||||
===============
|
||||
|
||||
Doing a release of ``cryptography`` is a two part process.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Frequently Asked Questions
|
||||
Frequently asked questions
|
||||
==========================
|
||||
|
||||
How does ``cryptography`` compare to NaCl (Networking and Cryptography Library)?
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Fernet (Symmetric encryption)
|
||||
Fernet (symmetric encryption)
|
||||
=============================
|
||||
|
||||
.. currentmodule:: cryptography.fernet
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.. hazmat::
|
||||
|
||||
CommonCrypto Backend
|
||||
CommonCrypto backend
|
||||
====================
|
||||
|
||||
The `CommonCrypto`_ C library provided by Apple on OS X and iOS. The CommonCrypto
|
||||
|
|
|
|||
|
|
@ -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::
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.. hazmat::
|
||||
|
||||
Backend Interfaces
|
||||
Backend interfaces
|
||||
==================
|
||||
|
||||
.. currentmodule:: cryptography.hazmat.backends.interfaces
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.. hazmat::
|
||||
|
||||
CommonCrypto Binding
|
||||
CommonCrypto binding
|
||||
====================
|
||||
|
||||
.. currentmodule:: cryptography.hazmat.bindings.commoncrypto.binding
|
||||
|
|
|
|||
|
|
@ -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::
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.. hazmat::
|
||||
|
||||
OpenSSL Binding
|
||||
OpenSSL binding
|
||||
===============
|
||||
|
||||
.. currentmodule:: cryptography.hazmat.bindings.openssl.binding
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.. hazmat::
|
||||
|
||||
Asymmetric Algorithms
|
||||
Asymmetric algorithms
|
||||
=====================
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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()
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.. hazmat::
|
||||
|
||||
Hash-based Message Authentication Codes
|
||||
Hash-based message authentication codes
|
||||
=======================================
|
||||
|
||||
.. currentmodule:: cryptography.hazmat.primitives.hmac
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
.. hazmat::
|
||||
|
||||
Key Derivation Functions
|
||||
Key derivation functions
|
||||
========================
|
||||
|
||||
.. currentmodule:: cryptography.hazmat.primitives.kdf
|
||||
|
|
|
|||
|
|
@ -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::
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Reference in a new issue