diff options
author | Donald Stufft <donald@stufft.io> | 2013-08-07 13:01:25 -0700 |
---|---|---|
committer | Donald Stufft <donald@stufft.io> | 2013-08-07 13:01:25 -0700 |
commit | 8a7b25670e77e887dff47ab683e49c16e161e80e (patch) | |
tree | 17b2d72104aee87f0eb7d5d6c3bd9d37f7353a9a /docs/architecture.rst | |
parent | 39ffd9095a2735665e2bf1c62799849c7ac5a1bc (diff) | |
parent | 9e3c250f66a6cd381972338bcf257f347580481e (diff) | |
download | cryptography-8a7b25670e77e887dff47ab683e49c16e161e80e.tar.gz cryptography-8a7b25670e77e887dff47ab683e49c16e161e80e.tar.bz2 cryptography-8a7b25670e77e887dff47ab683e49c16e161e80e.zip |
Merge pull request #11 from alex/more-docs
More docs
Diffstat (limited to 'docs/architecture.rst')
-rw-r--r-- | docs/architecture.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst new file mode 100644 index 00000000..7b394950 --- /dev/null +++ b/docs/architecture.rst @@ -0,0 +1,18 @@ +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``. This is implemented on top of + ``cryptography.c``. +* ``cryptography``: This package contains higher level recipes, for example + "encrypt and then MAC". This is implemented on top of + ``cryptography.primitives``. |