aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.rst
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2013-12-22 00:04:40 -0800
committerPaul Kehrer <paul.l.kehrer@gmail.com>2013-12-22 00:04:40 -0800
commitc09f6aa5f14d8d544b3441e442b43427c2e0d93f (patch)
tree5548f2175e92e6e02c8699b206ea8cdd92f58bbd /docs/contributing.rst
parent5972431f9919033ad320cfc834419fca13d93d6d (diff)
parent6955ea32cdfbc8719c5f4ae9c55c989787553a97 (diff)
downloadcryptography-c09f6aa5f14d8d544b3441e442b43427c2e0d93f.tar.gz
cryptography-c09f6aa5f14d8d544b3441e442b43427c2e0d93f.tar.bz2
cryptography-c09f6aa5f14d8d544b3441e442b43427c2e0d93f.zip
Merge pull request #329 from alex/reccomend-versioning
Recommend that recipes include a version
Diffstat (limited to 'docs/contributing.rst')
-rw-r--r--docs/contributing.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index b1702df8..744f2098 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -76,6 +76,10 @@ whether the signature was valid.
if not is_valid:
raise InvalidSignature
+Every recipe should include a version or algorithmic marker of some sort in its
+output in order to allow transparent upgrading of the algorithms in use, as
+the algorithms or parameters needed to achieve a given security margin evolve.
+
APIs at the :doc:`/hazmat/primitives/index` layer should always take an
explicit backend, APIs at the recipes layer should automatically use the
:func:`~cryptography.hazmat.backends.default_backend`, but optionally allow