Difference between revisions of "PyCryptoPlus"
Jump to navigation
Jump to search
m (→Ciphers) |
|||
(31 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
Back to [[SAGE & cryptology]] |
Back to [[SAGE & cryptology]] |
||
== Info == |
== Info == |
||
+ | === Author & Download === |
||
+ | This is a development done by Christophe Oosterlynck under my supervision during his thesis work & internship at NXP. |
||
+ | |||
+ | The code is available [http://repo.or.cz/w/python-cryptoplus.git on repo.or.cz] and [https://github.com/doegox/python-cryptoplus on github], which may be easier if you wan to submit pull requests. |
||
+ | |||
=== Differences with pycrypto === |
=== Differences with pycrypto === |
||
{|border="1" |
{|border="1" |
||
Line 65: | Line 70: | ||
|- |
|- |
||
| ANSI X.923 || Py || |
| ANSI X.923 || Py || |
||
+ | |- style="background-color:#dddddd;" |
||
+ | ! align="left" colspan="8"|One-way Functions |
||
+ | |- |
||
+ | | MD5 || Py || C |
||
+ | |- |
||
+ | | SHA Family || Py (SHA1 & SHA2 family)|| C (SHA-1 & 256) |
||
+ | |- |
||
+ | | Whirlpool || Py || |
||
+ | |- |
||
+ | | RipeMD || Py || Py |
||
+ | |- |
||
+ | | RadioGatun || Py || |
||
+ | |- |
||
+ | | HMAC || Py || Py |
||
+ | |- |
||
+ | | PBKDF2 || Py || |
||
|} |
|} |
||
Line 77: | Line 98: | ||
*** CMAC is usable for blocksizes of 8 and 16 bytes |
*** CMAC is usable for blocksizes of 8 and 16 bytes |
||
** OFB,CFB and CTR can be accessed as a stream cipher (you get the encrypted message immediately, you don't have to wait until a complete block of plaintext has been provided to the cipher) |
** OFB,CFB and CTR can be accessed as a stream cipher (you get the encrypted message immediately, you don't have to wait until a complete block of plaintext has been provided to the cipher) |
||
+ | ** new Hash functions: extended SHA family, Whirpool, RadioGatùn, PBKDF2 |
||
* test functions are available via doctests and extensive tests that loop through dictionary of test vectors |
* test functions are available via doctests and extensive tests that loop through dictionary of test vectors |
||
** new pycrypto version will have it's own test bench for ciphers, this is not implemented yet |
** new pycrypto version will have it's own test bench for ciphers, this is not implemented yet |
||
Line 84: | Line 106: | ||
|-style="background-color:#dddddd;" |
|-style="background-color:#dddddd;" |
||
! align="left" colspan="2"| root of CryptoPlus package |
! align="left" colspan="2"| root of CryptoPlus package |
||
− | |- |
||
− | |src/Hash.py |
||
− | |make all Crypto.Hash modules available under CryptoPlus.Hash |
||
|- |
|- |
||
|src/Protocol.py |
|src/Protocol.py |
||
Line 95: | Line 114: | ||
|- |
|- |
||
|src/__init__.py |
|src/__init__.py |
||
− | |make the following modules available under the CryptoPlus package: |
+ | |make the following modules available under the CryptoPlus package: |
+ | *always: "Cipher","PublicKey","Util","Protocol","Hash","testvectors" |
||
+ | *if pycrypto > 2.0.1: "SelfTest", "Random" |
||
|- |
|- |
||
|src/testvectors.py |
|src/testvectors.py |
||
Line 117: | Line 138: | ||
| |
| |
||
*wraps Crypto.Cipher.AES |
*wraps Crypto.Cipher.AES |
||
− | *doctests for: ECB, CBC, CFB, OFB, CTR, XTS, CMAC |
+ | *doctests for: ECB, CBC, CFB, OFB, CTR, XTS, CMAC |
|- |
|- |
||
|src/Cipher/ARC2.py |
|src/Cipher/ARC2.py |
||
Line 137: | Line 158: | ||
| |
| |
||
*wraps Crypto.Cipher.DES |
*wraps Crypto.Cipher.DES |
||
− | *doctests for: ECB |
+ | *doctests for: ECB |
|- |
|- |
||
|src/Cipher/DES3.py |
|src/Cipher/DES3.py |
||
| |
| |
||
*wraps Crypto.Cipher.DES3 |
*wraps Crypto.Cipher.DES3 |
||
− | *doctests for: CBC, CMAC TDES-EDE3, CMAC TDES-EDE2 |
+ | *doctests for: CBC, CMAC TDES-EDE3, CMAC TDES-EDE2 |
|- |
|- |
||
|src/Cipher/IDEA.py |
|src/Cipher/IDEA.py |
||
Line 184: | Line 205: | ||
| |
| |
||
* wraps pyserpent.py |
* wraps pyserpent.py |
||
− | * doctests for ECB, CBC |
+ | * doctests for ECB, CBC |
|- |
|- |
||
|src/Cipher/python_Twofish.py |
|src/Cipher/python_Twofish.py |
||
| |
| |
||
* wraps pytwofish.py |
* wraps pytwofish.py |
||
− | * doctests for ECB |
+ | * doctests for ECB |
|- |
|- |
||
|src/Cipher/python_PRESENT.py |
|src/Cipher/python_PRESENT.py |
||
Line 224: | Line 245: | ||
* based on documentation here: http://www.crypto.ruhr-uni-bochum.de/en_publications.html |
* based on documentation here: http://www.crypto.ruhr-uni-bochum.de/en_publications.html |
||
|-style="background-color:#dddddd;" |
|-style="background-color:#dddddd;" |
||
− | ! align="left" colspan="2"| |
+ | ! align="left" colspan="2"| CryptoPlus.Hash subpackage |
+ | |- |
||
+ | |src/Hash/__init__.py |
||
+ | |specify all the ciphers in the CryptoPlus.Hash package (new implementations and imports from pycrypto |
||
+ | |- |
||
+ | |src/Hash/python_*.py |
||
+ | | |
||
+ | * wrappers for the pure python (py*.py) implementations of hash functions |
||
+ | * provide "new()" function and some doctests |
||
+ | |- |
||
+ | |src/Hash/py*.py |
||
+ | | |
||
+ | *pure python implementations of hash functions |
||
+ | *pyradiogatun.py is own code, the rest is gathered from other sources |
||
+ | |-style="background-color:#dddddd;" |
||
+ | ! align="left" colspan="2"| CryptoPlus.Random subpackage (only used if pycrypto version > 2.0.1) |
||
|- |
|- |
||
|src/Util/__init__.py |
|src/Util/__init__.py |
||
| |
| |
||
− | *import modules from original Crypto. |
+ | *import modules from original Crypto.Random: _UserFriendlyRNG, atfork, random |
+ | |- |
||
+ | |src/Util/Fortuna.py |
||
+ | | |
||
+ | *imports Crypto.Random.Fortuna.* |
||
+ | |- |
||
+ | |src/Util/OSRNG.py |
||
+ | | |
||
+ | *imports Crypto.Random.OSRNG.* |
||
+ | |-style="background-color:#dddddd;" |
||
+ | ! align="left" colspan="2"| CryptoPlus.Util subpackage |
||
+ | |- |
||
+ | |src/Util/__init__.py |
||
+ | | |
||
+ | *import modules from original Crypto.Util: number, randpool, RFC1751, python_compat |
||
*make new modules available: padding, util |
*make new modules available: padding, util |
||
+ | |- |
||
+ | |src/Util/number.py<br>src/Util/randpool.py<br>src/Util/RFC1751.py |
||
+ | | |
||
+ | *wrappers for the respective Crypto.Util modules |
||
+ | |- |
||
+ | |src/Util/python_compat.py |
||
+ | | |
||
+ | *wrapper for Crypto.Util.python_compat if pycrypto > 2.0.1 |
||
|- |
|- |
||
|src/Util/padding.py |
|src/Util/padding.py |
||
| |
| |
||
*own code for (un)padding raw strings |
*own code for (un)padding raw strings |
||
+ | *doctest for every padding function |
||
− | *testbench that will pad/unpad a string with all available methods and check for errors between original and unpadded string |
||
|- |
|- |
||
|src/Util/util.py |
|src/Util/util.py |
||
Line 243: | Line 301: | ||
|- |
|- |
||
|test/test.py |
|test/test.py |
||
− | |runs extensive test with verified test vectors for: CBC, CFB, OFB and CTR with AES, DES,TDES2/3, Serpent128/192/256, CMAC-AES128/192/256, CMAC-TDES2/3, XTS-AES, PRESENT (80 and 128 bit key) |
+ | |runs extensive test with verified test vectors for: CBC, CFB, OFB and CTR with AES, DES,TDES2/3, Serpent128/192/256, CMAC-AES128/192/256, CMAC-TDES2/3, XTS-AES, PRESENT (80 and 128 bit key), Twofish (128/192/256bits keys) |
|- |
|- |
||
|test/test_doctests.py |
|test/test_doctests.py |
||
|script to run all doctest available in every cipher wrapper (pure python and pycrypto wrapper) |
|script to run all doctest available in every cipher wrapper (pure python and pycrypto wrapper) |
||
|} |
|} |
||
− | * verified = test vectors are support by an online source. A link is available in the doctest. |
||
==TODO== |
==TODO== |
||
− | *add chaining modes: <del>CMAC</del>, CTR mod? |
||
− | *<del>further importing of pycrypto</del> |
||
− | *<del>make test vectors available as variables</del> |
||
− | *add tests: |
||
− | **<del>CBC for serpent, twofish, blowfish</del> |
||
− | **XTS <del>is only tested by comparing deciphered ciphertext, not by checking ciphertext</del>: XTS-AES doctest done |
||
*check other implementation of Blowfish |
*check other implementation of Blowfish |
||
− | *<del>final() method of chains</del> |
||
− | **<del>add a cipher.final() method? pycrypto doesn't have it, but it doesn't really conflict with the pycrypto API. It will just extend it</del> |
||
− | **<del>final() method should use padding. Choose padding function at initialization of the cipher => again: extending the API</del> |
||
− | * XTS |
||
− | ** make other blocksizes available besides 16 bytes? |
||
− | * CMAC |
||
− | ** make other blocksizes available besides 8 and 16 bytes? |
||
− | ** <del>supply XTS keys by splitting 1 big key or by supplying two keys?</del> |
||
− | * <del>add rijndael instead of only AES</del> |
||
− | * <del>add docstring to every "new" function of every module, explaining what should be passed as arguments (probably the same for every function)<br>Move doctests there so they are easily viewable</del> |
||
− | * check GF2 in XTS + can it be replaced by Sage's implementation of GF2 ( -> [http://modular.math.washington.edu/sage/doc/tut/node55.html]? ) ? |
||
− | **<del> decision: stays the way it is. When Sage's GF2 would be used, then CryptoPlus wouldn't work without sage.</del> |
||
− | **GF2 not necessary anymore in XTS |
||
* use unittest for test functions |
* use unittest for test functions |
||
* check development of pycrypto: |
* check development of pycrypto: |
||
** Util.Counter & Util._counter |
** Util.Counter & Util._counter |
||
** SelfTest: usable to perform the test for python algo's in CryptoPlus if testvectors are in right format? |
** SelfTest: usable to perform the test for python algo's in CryptoPlus if testvectors are in right format? |
||
− | |||
− | == Tests available == |
||
− | * Doctests |
||
− | ** Blowfish: ECB, CBC, CFB, OFB |
||
− | ** all chain modes in AES |
||
− | * Extensive external test (via tester.py) |
||
− | ** DES,TDES2,TDES3: ECB |
||
− | ** Serpent 128/192/256: ECB |
||
− | ** CMAC: AES128/192/256 |
||
− | ** XTS: AES128/256 and plaintext multiples and non-multiples of 16 bytes |
||
==Licenses== |
==Licenses== |
||
+ | http://opensource.org/ |
||
+ | === Used by others === |
||
*used from [http://psionicist.online.fr/code/pytruecrypt/ python truecrypt implementation]<br>all original code is under MIT license (much freedom according to [http://blog.bjrn.se/2008/02/truecrypt-explained-truecrypt-5-update.html]) |
*used from [http://psionicist.online.fr/code/pytruecrypt/ python truecrypt implementation]<br>all original code is under MIT license (much freedom according to [http://blog.bjrn.se/2008/02/truecrypt-explained-truecrypt-5-update.html]) |
||
**pyTwofish (untouched)<br>python truecrypt author isn't the original author = > extra copyright notice that should be left in place |
**pyTwofish (untouched)<br>python truecrypt author isn't the original author = > extra copyright notice that should be left in place |
||
Line 297: | Line 327: | ||
*blockciphers CBC, ECB, CTR from [http://www.nightsong.com/phr/crypto/blockcipher.tgz] (modified)<br>keep copyright notice in place? |
*blockciphers CBC, ECB, CTR from [http://www.nightsong.com/phr/crypto/blockcipher.tgz] (modified)<br>keep copyright notice in place? |
||
*CMAC: [http://github.com/jlhutch/jac/tree/master/omac.py omac.py]<br> GPL but not really used it, just used as a starting point |
*CMAC: [http://github.com/jlhutch/jac/tree/master/omac.py omac.py]<br> GPL but not really used it, just used as a starting point |
||
+ | === Used in CryptoPlus === |
||
+ | *pypresent.py |
||
+ | ** MIT license |
||
+ | ==Cipher module== |
||
− | == Various info == |
||
− | |||
− | === Python === |
||
− | *absolute relative imports: links with some info |
||
− | ** http://bugs.python.org/issue1510172 |
||
− | ** http://www.python.org/dev/peps/pep-0366/ |
||
− | ** http://www.python.org/dev/peps/pep-0328/ |
||
− | ** http://groups.google.com/group/comp.lang.python/msg/e35b1746b425b4c1 |
||
− | * collect all doctests |
||
− | ** http://docs.python.org/lib/doctest-unittest-api.html |
||
− | * making a package |
||
− | ** http://docs.python.org/dist/ |
||
− | |||
− | ==== Setup Script ==== |
||
− | ===== distutils vs setuptools ===== |
||
− | Dependencies checking on install: some info [http://blog.doughellmann.com/2007/11/requiring-packages-with-distutils.html here]. |
||
− | :It seems that the 'requires' keyword in distutils has only a purpose of documentation, but 'install_requires' in setuptools really takes care of dependencies: availability of dependencies will be checked. If a package is not available, it will be checked for on [http://pypi.python.org/pypi pypi] and installed automatically. |
||
− | ===== distutils ===== |
||
− | * setup.py |
||
− | ** creating a distribution tar.gz: "python setup.py sdist" |
||
− | ** installing the source distribution (sdist):<br>- untar .tar.gz: "cd dist && tar zxfv CryptoPlus-1.0.tar.gz -C ~/"<br>- "cd ~/CryptoPlus-1.0 && python setup.py install" |
||
− | ** "egg way":<br>$ python setup.py bdist_egg<br>$ sudo easy_install dist/CryptoPlus-1.0-py2.5.egg |
||
− | |||
− | ===== setuptools ===== |
||
− | * http://pypi.python.org/pypi/setuptools/ |
||
− | * manual: http://peak.telecommunity.com/DevCenter/setuptools |
||
− | * it isn't installed by default on debian |
||
− | ** apt-get install python-setuptools |
||
− | ** sage-python has setuptools by default |
||
===Test Vectors=== |
===Test Vectors=== |
||
Line 359: | Line 364: | ||
**http://en.wikipedia.org/wiki/IEEE_P1619 = [http://grouper.ieee.org/groups/1619/email/pdf00086.pdf XTS-AES] |
**http://en.wikipedia.org/wiki/IEEE_P1619 = [http://grouper.ieee.org/groups/1619/email/pdf00086.pdf XTS-AES] |
||
**XTS-AES: [http://grouper.ieee.org/groups/1619/email/pdf00086.pdf IEEE P1619TM/D16: Standard for Cryptographic Protection of Data on Block-Oriented Storage Devices] |
**XTS-AES: [http://grouper.ieee.org/groups/1619/email/pdf00086.pdf IEEE P1619TM/D16: Standard for Cryptographic Protection of Data on Block-Oriented Storage Devices] |
||
+ | ** Comments: [http://csrc.nist.gov/groups/ST/toolkit/BCM/documents/comments/XTS/XTS_comments-Liskov_Minematsu.pdf] |
||
+ | ***"It should be mentioned explicitly in the description that when enciphering many blocks, successive T values can and should be computed from prior ones via multiplication by alpha (providing that i remains fixed). This optimization, which is one of the best features of XEX, should be explicitly recommended in the standard." |
||
*CMAC = OMAC1: |
*CMAC = OMAC1: |
||
** AES-CMAC: http://tools.ietf.org/html/rfc4493#page-2 |
** AES-CMAC: http://tools.ietf.org/html/rfc4493#page-2 |
||
Line 384: | Line 391: | ||
**http://people.csail.mit.edu/rivest/Rivest-rc5.pdf |
**http://people.csail.mit.edu/rivest/Rivest-rc5.pdf |
||
**ftp://ftp.nordu.net/rfc/rfc2040.txt |
**ftp://ftp.nordu.net/rfc/rfc2040.txt |
||
+ | |||
+ | == Hash Module == |
||
+ | === Current Situation === |
||
+ | *MD5 |
||
+ | **http://www.rfc-editor.org/rfc/rfc1321.txt |
||
+ | **good implementation in [http://codespeak.net/svn/pypy/dist/pypy/lib/md5.py pypy] (Python License) |
||
+ | *SHA family |
||
+ | **[http://csrc.nist.gov/publications/fips/fips180-2/fips180-2withchangenotice.pdf FIPS 180-2] |
||
+ | **SHA1: http://www.rfc-editor.org/rfc/rfc3174.txt |
||
+ | **SHA-1 available in [http://codespeak.net/svn/pypy/dist/pypy/lib/sha.py pypy] (Python License) |
||
+ | ***can be modified for other SHA's |
||
+ | ***uses standard python hash api |
||
+ | **SHA-256 implementation: https://vcs.slash-me.net/snippets/sha256/sha256.py |
||
+ | ***short code but less readable than the one from pypy |
||
+ | **SHA-224, 256, 384, and 512 at http://reikon.us/sha2/ |
||
+ | ***less readable than pypy implementation (pypy is using same structure for md5 and sha1) |
||
+ | ***uses same API as standard python hashing modules |
||
+ | ***MIT License |
||
+ | *Whirlpool |
||
+ | **[http://paginas.terra.com.br/informatica/paulobarreto/WhirlpoolPage.html Homepage] |
||
+ | **available here: [http://www.bjrn.se/code/whirlpoolpy.txt python truecrypt implementation] |
||
+ | *RipeMD |
||
+ | **http://homes.esat.kuleuven.be/~bosselae/ripemd160.html |
||
+ | **RipeMD-160 available as pure python implementation in current pycrypto development<br>=>RipeMD and python_RipeMD will point to the same pycrypto ripemd implementation |
||
+ | **modify to add RipeMD-128? |
||
+ | *RadioGatun |
||
+ | **http://radiogatun.noekeon.org/ |
||
+ | ***reference C-code |
||
+ | ***testvectors |
||
+ | *HMAC |
||
+ | **available in python and pypy as pure python<br>-> same implementation used in pycrypto: no need to copy it again in cryptoplus? |
||
+ | *PBKDF2 |
||
+ | **implementation from new pycrypto developer: http://www.dlitz.net/software/python-pbkdf2/ |
||
+ | **standard + testvectors: [http://www.ietf.org/rfc/rfc3962.txt RFC 3962] |
||
+ | |||
+ | == Stream Ciphers == |
||
+ | *SNOW2 / SNOW3G |
||
+ | **http://www.it.lth.se/cryptology/snow/ |
||
+ | **Snow 3G |
||
+ | ***www.gsmworld.com/using/algorithms/docs/snow_3g_spec.pdf |
||
+ | ***"The main difference in SNOW 3G is the addition of a second S-box giving higher resistance against possible future advances in algebraic cryptanalysis"[http://www.ecrypt.eu.org/documents/D.SPA.21-1.1.pdf] |
||
+ | **LFSR, FSM, S-Box |
||
+ | *Grain |
||
+ | **http://www.ecrypt.eu.org/stream/grainpf.html |
||
+ | **LFSR, NFSR, output function |
||
+ | *Trivium |
||
+ | **http://www.ecrypt.eu.org/stream/triviumpf.html |
||
+ | *LFSR |
||
+ | *(self)Shrinking Generator |
||
+ | *ARC4 |
||
+ | **http://en.wikipedia.org/wiki/RC4 |
||
+ | *XOR |
||
+ | |||
+ | == Various info == |
||
+ | |||
+ | === [[Python]] === |
Latest revision as of 22:46, 21 March 2014
Back to SAGE & cryptology
Info
Author & Download
This is a development done by Christophe Oosterlynck under my supervision during his thesis work & internship at NXP.
The code is available on repo.or.cz and on github, which may be easier if you wan to submit pull requests.
Differences with pycrypto
CryptoPlus | PyCrypto | ||||||
Block Ciphers | |||||||
---|---|---|---|---|---|---|---|
Block cipher algorithms | |||||||
Serpent | Py | ||||||
Blowfish | Py | C | |||||
Twofish | Py | ||||||
Idea | C | ||||||
DES | Py | C | |||||
3DES | Py | C | |||||
AES | Py | C | |||||
Rijndael | Py | ||||||
Present | Py | ||||||
Modes of operation | |||||||
CMAC | Py | ||||||
XCBC | |||||||
CBC-MAC | |||||||
CCM | |||||||
GCM | |||||||
ECB | Py | C | |||||
CBC | Py | C | |||||
CTR | Py | C | |||||
LRW | |||||||
XTS | Py | ||||||
MDC-2 | |||||||
Paddings | |||||||
bit padding | Py | ||||||
zeros | Py | ||||||
PKCS7 | Py | ||||||
PKCS12 | Py | ||||||
ISO 10126 | Py | ||||||
ANSI X.923 | Py | ||||||
One-way Functions | |||||||
MD5 | Py | C | |||||
SHA Family | Py (SHA1 & SHA2 family) | C (SHA-1 & 256) | |||||
Whirlpool | Py | ||||||
RipeMD | Py | Py | |||||
RadioGatun | Py | ||||||
HMAC | Py | Py | |||||
PBKDF2 | Py |
- ciphers from pycrypto are being used with the python chaining modes and not the original pycrypto ones
=> plaintext can be supplied in arbitrary sizes instead of multiples of the blocksize like in pycrypto: the new chaining modes keep a cache to encrypt/decrypt data once the cachesize holds at least a blocksize of data - new possibilities:
- Rijndael, Serpent, Twofish
- Rijndael is limited to blocksizes of 128, 192 and 256 bits
- CMAC, XTS, CTR
- XTS is usable for ciphers with blocksizes of 16 bytes => XTS-AES, Serpent, Twofish
- XTS encrypts the given input at once while all other chain modes encrypt only when a block plaintext is available in the cache
- CMAC is usable for blocksizes of 8 and 16 bytes
- OFB,CFB and CTR can be accessed as a stream cipher (you get the encrypted message immediately, you don't have to wait until a complete block of plaintext has been provided to the cipher)
- new Hash functions: extended SHA family, Whirpool, RadioGatùn, PBKDF2
- Rijndael, Serpent, Twofish
- test functions are available via doctests and extensive tests that loop through dictionary of test vectors
- new pycrypto version will have it's own test bench for ciphers, this is not implemented yet
source structure
root of CryptoPlus package | |
---|---|
src/Protocol.py | make all Crypto.Protocol modules available under CryptoPlus.Protocol |
src/PublicKey.py | make all Crypto.PublicKey modules available under CryptoPlus.PublicKey |
src/__init__.py | make the following modules available under the CryptoPlus package:
|
src/testvectors.py |
|
CryptoPlus.Cipher subpackage | |
src/Cipher/__init__.py | specify all the ciphers in the CryptoPlus.Cipher package + import of the streamcipher ARC4 and XOR |
src/Cipher/blockcipher.py |
|
Wrappers for pycrypto | |
src/Cipher/AES.py |
|
src/Cipher/ARC2.py |
|
src/Cipher/Blowfish.py |
|
src/Cipher/CAST.py |
|
src/Cipher/DES.py |
|
src/Cipher/DES3.py |
|
src/Cipher/IDEA.py |
|
src/Cipher/RC5.py |
|
Wrappers for pure python implementations | |
src/Cipher/python_AES.py |
|
src/Cipher/python_Blowfish.py |
|
src/Cipher/python_DES.py |
|
src/Cipher/python_DES3.py |
|
src/Cipher/python_Rijndael.py |
|
src/Cipher/python_Serpent.py |
|
src/Cipher/python_Twofish.py |
|
src/Cipher/python_PRESENT.py |
|
Pure python implementations for blockciphers | |
src/Cipher/pyDes.py |
|
src/Cipher/pyblowfish.py |
|
src/Cipher/pyserpent.py |
|
src/Cipher/pytwofish.py |
|
src/Cipher/rijndael.py |
|
src/Cipher/pypresent.py |
|
CryptoPlus.Hash subpackage | |
src/Hash/__init__.py | specify all the ciphers in the CryptoPlus.Hash package (new implementations and imports from pycrypto |
src/Hash/python_*.py |
|
src/Hash/py*.py |
|
CryptoPlus.Random subpackage (only used if pycrypto version > 2.0.1) | |
src/Util/__init__.py |
|
src/Util/Fortuna.py |
|
src/Util/OSRNG.py |
|
CryptoPlus.Util subpackage | |
src/Util/__init__.py |
|
src/Util/number.py src/Util/randpool.py src/Util/RFC1751.py |
|
src/Util/python_compat.py |
|
src/Util/padding.py |
|
src/Util/util.py |
|
Test scripts | |
test/test.py | runs extensive test with verified test vectors for: CBC, CFB, OFB and CTR with AES, DES,TDES2/3, Serpent128/192/256, CMAC-AES128/192/256, CMAC-TDES2/3, XTS-AES, PRESENT (80 and 128 bit key), Twofish (128/192/256bits keys) |
test/test_doctests.py | script to run all doctest available in every cipher wrapper (pure python and pycrypto wrapper) |
TODO
- check other implementation of Blowfish
- use unittest for test functions
- check development of pycrypto:
- Util.Counter & Util._counter
- SelfTest: usable to perform the test for python algo's in CryptoPlus if testvectors are in right format?
Licenses
Used by others
- used from python truecrypt implementation
all original code is under MIT license (much freedom according to [1])- pyTwofish (untouched)
python truecrypt author isn't the original author = > extra copyright notice that should be left in place - pyserpent (untouched)
python truecrypt author isn't the original author = > extra copyright notice that should be left in place - XTS (modified)
python truecrypt author is the original author => only MIT License - GF2n.py(untouched)
python truecrypt author is the original author => only MIT License
- pyTwofish (untouched)
- pyblowfish (untouched)
gpl or artistic license
To not affect the rest of the distribution we've to redistribute it only under Artistic license terms - rijndael.py (untouched)
using tls lite (public domain) implementation which uses code from Bram Cohen (public domain) - pyDes (untouched)
public domain according to its homepage - blockciphers CBC, ECB, CTR from [2] (modified)
keep copyright notice in place? - CMAC: omac.py
GPL but not really used it, just used as a starting point
Used in CryptoPlus
- pypresent.py
- MIT license
Cipher module
Test Vectors
- Collection of test vectors for a broad group of ciphers
- AES, DES, 3DES: http://csrc.nist.gov/groups/STM/cavp/standards.html
- AES in CBC, CTR, OFB, CFB: html version of pdf
- CMAC test vectors in Special Publication 800-38B are faulty, use the corrected ones from here
- Rijndael: http://fp.gladman.plus.com/cryptography_technology/rijndael/
- zip file contains a full set of round values for each of the 25 block and key length combinations from 128, 160, 192, 224 and 256 bits for one input block and one key value
- DES (enkel ECB): http://www.skepticfiles.org/faq/testdes.htm
- Blowfish: http://www.schneier.com/code/vectors.txt
- Serpent: http://www.cs.technion.ac.il/~biham/Reports/Serpent/
- Twofish: http://www.schneier.com/code/ecb_ival.txt
- AES, DES: http://svn.python.org/projects/external/openssl-0.9.8a/test/evptests.txt
- CMAC
- AES & TDES: http://www.nuee.nagoya-u.ac.jp/labs/tiwata/omac/omac.html
- AES, TDES2 & TDES3: http://csrc.nist.gov/groups/STM/cavp/documents/mac/cmactestvectors.zip
- fax folder contains usefull stuff: generation and verification tests with results
generation test: generate a correct mac
verification test: verify if provided mac for plaintext is correct
- fax folder contains usefull stuff: generation and verification tests with results
- XTS-AES: IEEE P1619TM/D16: Standard for Cryptographic Protection of Data on Block-Oriented Storage Devices
- ARC2: http://www.ietf.org/rfc/rfc2268.txt
- will be available in pycrypto >2.0.1
- CAST: http://www.rfc-editor.org/rfc/rfc2144.txt
Chaining Modes
- Wikipedia
- NIST
- XTS:
- https://siswg.net/index.php?option=com_content&task=view&id=38&Itemid=73
- http://blog.bjrn.se/2008/02/truecrypt-explained-truecrypt-5-update.html
- http://en.wikipedia.org/wiki/IEEE_P1619 = XTS-AES
- XTS-AES: IEEE P1619TM/D16: Standard for Cryptographic Protection of Data on Block-Oriented Storage Devices
- Comments: [3]
- "It should be mentioned explicitly in the description that when enciphering many blocks, successive T values can and should be computed from prior ones via multiplication by alpha (providing that i remains fixed). This optimization, which is one of the best features of XEX, should be explicitly recommended in the standard."
- CMAC = OMAC1:
- AES-CMAC: http://tools.ietf.org/html/rfc4493#page-2
- NIST:
Recommendation for Block Cipher Modes of Operation: The CMAC Mode for Authentication:SP 800-38B.pdf
Updated CMAC Examples - OMAC.py: http://github.com/jlhutch/jac/tree/master/omac.py
- OMAC page: http://www.nuee.nagoya-u.ac.jp/labs/tiwata/omac/omac.html
Ciphers
- Serpent
- http://www.cl.cam.ac.uk/~rja14/serpent.html
- python implementation used
at the momentin earlier versions: http://psionicist.online.fr/code/ - alternative python implementation (used in current version): http://www.cl.cam.ac.uk/~fms27/serpent/
- more info on this python implementation: http://www.cl.cam.ac.uk/~fms27/serpent/serpent-abstract.html
- Present
- Article: PRESENT: An Ultra-Lightweight Block Cipher
- Test Vector generator + ANSI-C implementation of present: [4]
- own implementation
- ARC2
- http://www.ietf.org/rfc/rfc2268.txt: publication + testvectors
- current pycrypto implementation fails all testvectors because of not correctly handling the "effective keylength". Fixed in upcoming release (+2.0.1) bugreportbugfix
- CAST
- RC5
Hash Module
Current Situation
- MD5
- http://www.rfc-editor.org/rfc/rfc1321.txt
- good implementation in pypy (Python License)
- SHA family
- FIPS 180-2
- SHA1: http://www.rfc-editor.org/rfc/rfc3174.txt
- SHA-1 available in pypy (Python License)
- can be modified for other SHA's
- uses standard python hash api
- SHA-256 implementation: https://vcs.slash-me.net/snippets/sha256/sha256.py
- short code but less readable than the one from pypy
- SHA-224, 256, 384, and 512 at http://reikon.us/sha2/
- less readable than pypy implementation (pypy is using same structure for md5 and sha1)
- uses same API as standard python hashing modules
- MIT License
- Whirlpool
- Homepage
- available here: python truecrypt implementation
- RipeMD
- http://homes.esat.kuleuven.be/~bosselae/ripemd160.html
- RipeMD-160 available as pure python implementation in current pycrypto development
=>RipeMD and python_RipeMD will point to the same pycrypto ripemd implementation - modify to add RipeMD-128?
- RadioGatun
- http://radiogatun.noekeon.org/
- reference C-code
- testvectors
- http://radiogatun.noekeon.org/
- HMAC
- available in python and pypy as pure python
-> same implementation used in pycrypto: no need to copy it again in cryptoplus?
- available in python and pypy as pure python
- PBKDF2
- implementation from new pycrypto developer: http://www.dlitz.net/software/python-pbkdf2/
- standard + testvectors: RFC 3962
Stream Ciphers
- SNOW2 / SNOW3G
- http://www.it.lth.se/cryptology/snow/
- Snow 3G
- www.gsmworld.com/using/algorithms/docs/snow_3g_spec.pdf
- "The main difference in SNOW 3G is the addition of a second S-box giving higher resistance against possible future advances in algebraic cryptanalysis"[5]
- LFSR, FSM, S-Box
- Grain
- http://www.ecrypt.eu.org/stream/grainpf.html
- LFSR, NFSR, output function
- Trivium
- LFSR
- (self)Shrinking Generator
- ARC4
- XOR