From 8c9dcb38167938068fe7b662dc403dd03a8a7ef8 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 3 Nov 2013 13:10:57 -0800 Subject: Began writing a glossary --- docs/glossary.rst | 29 +++++++++++++++++++++++++++++ docs/index.rst | 1 + 2 files changed, 30 insertions(+) create mode 100644 docs/glossary.rst (limited to 'docs') diff --git a/docs/glossary.rst b/docs/glossary.rst new file mode 100644 index 00000000..b80b4b2b --- /dev/null +++ b/docs/glossary.rst @@ -0,0 +1,29 @@ +Glossary +======== + +.. glossary:: + + plaintext + User-readable data you care about. + + ciphertext + The encoded data, it's not user readable. Potential attackers are able + to see this. + + encryption + The process of converting plaintext to ciphertext. + + decryption + The process of converting ciphertext to plaintext. + + key + Secret data is encoded with a function using this key. Sometimes + multiple keys are used. + + symmetric cryptography + Cryptographic operations where encryption and decryption use the same + key. + + asymmetric cryptography + Cryptographic operations where encryption and decryption use different + keys. There are seperate encryption and decryption keys. diff --git a/docs/index.rst b/docs/index.rst index eb30b5dd..1b88e24e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,6 +32,7 @@ Contents architecture exceptions + glossary contributing security community -- cgit v1.2.3 From a0516bf23ceb6c02dbc56aa8c39b8df0cf01119e Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 3 Nov 2013 13:20:41 -0800 Subject: Get real scary --- docs/glossary.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/glossary.rst b/docs/glossary.rst index b80b4b2b..e4fc8283 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -18,7 +18,8 @@ Glossary key Secret data is encoded with a function using this key. Sometimes - multiple keys are used. + multiple keys are used. These **must** be kept secret, if a key is + exposed to an attacker, any data encrypted with it will be exposed. symmetric cryptography Cryptographic operations where encryption and decryption use the same -- cgit v1.2.3 From 5151d8dc047b1e97f6262b0495471aaa8e41db71 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 3 Nov 2013 14:58:37 -0800 Subject: Document the way we strive to interact with otehrs --- docs/community.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs') diff --git a/docs/community.rst b/docs/community.rst index 552318da..bf1cd1c7 100644 --- a/docs/community.rst +++ b/docs/community.rst @@ -9,7 +9,12 @@ You can find ``cryptography`` all over the web: * `Documentation`_ * IRC: ``#cryptography-dev`` on ``irc.freenode.net`` +Wherever we interact, we strive to follow the `Python Community Code of +Conduct`_. + + .. _`Mailing list`: https://mail.python.org/mailman/listinfo/cryptography-dev .. _`Source code`: https://github.com/pyca/cryptography .. _`Issue tracker`: https://github.com/pyca/cryptography/issues .. _`Documentation`: https://cryptography.io/ +.. _`Python Community Code of Conduct`: http://www.python.org/psf/codeofconduct/ -- cgit v1.2.3 From 58ecc8d434078e21deaa2a18312b06d876956b56 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 3 Nov 2013 21:21:00 -0800 Subject: Refer to the RFC in the HMAC docs --- docs/hazmat/primitives/hmac.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/hazmat/primitives/hmac.rst b/docs/hazmat/primitives/hmac.rst index 301d72d5..bd1a4934 100644 --- a/docs/hazmat/primitives/hmac.rst +++ b/docs/hazmat/primitives/hmac.rst @@ -23,6 +23,8 @@ message. equal in length to the ``digest_size`` of the hash function chosen. You must keep the ``key`` secret. + This is an implementation of :rfc:`2104`. + .. doctest:: >>> from cryptography.hazmat.primitives import hashes, hmac -- cgit v1.2.3 From f986fe062be59a34707db7b15eda130ce16366db Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 4 Nov 2013 09:50:21 -0800 Subject: This is now the default theme on RTD --- docs/conf.py | 3 --- 1 file changed, 3 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 8e0fc7be..7f4c24b3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -253,6 +253,3 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/': None} - -# Enable the new ReadTheDocs theme -RTD_NEW_THEME = True -- cgit v1.2.3 From 61570d03318c9daa7f8c2700fb0bc869119fd685 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 4 Nov 2013 10:30:28 -0800 Subject: pep8 fix --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 7f4c24b3..69be32e9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -252,4 +252,3 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/': None} - -- cgit v1.2.3