diff options
author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-08-07 12:59:04 -0700 |
---|---|---|
committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-08-07 12:59:04 -0700 |
commit | 1abfac7909df31a5eabe29e9dfd23db55d867834 (patch) | |
tree | e4c69c26b832cbf62fb3acd7c70cdfa2d7aefa06 /docs/architecture.rst | |
parent | 39ffd9095a2735665e2bf1c62799849c7ac5a1bc (diff) | |
download | cryptography-1abfac7909df31a5eabe29e9dfd23db55d867834.tar.gz cryptography-1abfac7909df31a5eabe29e9dfd23db55d867834.tar.bz2 cryptography-1abfac7909df31a5eabe29e9dfd23db55d867834.zip |
Start to document the architecture.
Diffstat (limited to 'docs/architecture.rst')
-rw-r--r-- | docs/architecture.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst new file mode 100644 index 00000000..80e2c28a --- /dev/null +++ b/docs/architecture.rst @@ -0,0 +1,16 @@ +Architecture +============ + +.. warning:: + + Because ``cryptography`` is so young, much of this document is + aspirational, rather than documentation. + +``cryptography`` has three different layers: + +* ``cryptography.c``: This package contains bindings to low level cryptographic + libraries. Our initial target will be OpenSSL. +* ``cryptography.primitives``: This packages contains low level algorithms, + things like ``AES`` or ``SHA1``. +* ``cryptography``: This package contains higher level recipes, for example + "encrypt and then MAC". |