From bf0f375b6f5114871c5aa69ebd262307515beb09 Mon Sep 17 00:00:00 2001 From: Philippe Teuwen Date: Sat, 22 Mar 2014 19:47:15 +0100 Subject: [PATCH] Improve English --- LICENSE | 26 +++++++++++++------------- README | 54 +++++++++++++++++++++++++++--------------------------- 2 files changed, 40 insertions(+), 40 deletions(-) diff --git a/LICENSE b/LICENSE index c643561..45434b7 100644 --- a/LICENSE +++ b/LICENSE @@ -1,16 +1,4 @@ -Used implementations of others are distributed under their respective license - available in the source: - Ciphers: - pyblowfish.py, pyDes.py, pyserpent.py, pytwofish.py, rijndael.py - - - pyblowfish.py is being redistributed under the Artistic License - - Hash functions: - pypbkdf2.py, pywhirlpool.py - using pypy license: pysha.py, pysha224.py, pysha256.py, pysha384.py, - pysha512.py, pymd5.py - -All the rest is licensed under the MIT License: +CryptoPlus original code is distributed under the MIT License: # ============================================================================= # Copyright (c) 2008 Christophe Oosterlynck (christophe.oosterlynck_AT_gmail.com) @@ -35,3 +23,15 @@ All the rest is licensed under the MIT License: # THE SOFTWARE. # ============================================================================= +Third party implementations are distributed under their respective license +as specified in their source file(s): + + Ciphers: + pyblowfish.py, pyDes.py, pyserpent.py, pytwofish.py, rijndael.py + - pyblowfish.py is being redistributed under the Artistic License + + Hash functions: + pypbkdf2.py, pywhirlpool.py + using pypy license: pysha.py, pysha224.py, pysha256.py, pysha384.py, + pysha512.py, pymd5.py + diff --git a/README b/README index 5b07c34..7cce1b7 100644 --- a/README +++ b/README @@ -1,5 +1,5 @@ -CRYPTOPLUS -=========== +PYCRYPTOPLUS +============= TABLE OF CONTENTS ================== @@ -12,36 +12,36 @@ TABLE OF CONTENTS 1. WHAT IS CRYPTOPLUS ====================== -CryptoPlus is an extions to the Crypto module (www.pycrypto.org) for -python. CryptoPlus makes the ciphers included in pycrypto and some new -onse available in pure python code. Some new chain modes are also added -in pure python, while the ones allready available in pycrypto are also -avaible in pure python in this package. Making these available in pure -python has the advantage of easier understandable code and thus making -it easier to adjust the code to your needs. -All other functions of pycrypto are available via the interface +PyCryptoPlus is an extension to the Python Crypto module (www.pycrypto.org). +PyCryptoPlus provides same ciphers as included in pycrypto but also new ones, +all being written 100% in Python. Some additional chaining modes have been +added, also in pure Python, while the ones already available in pycrypto are +provided in pure python in this package. +The reasoning is that Python code has the advantage to be more readable and +so easier to be adapted to your needs or experiments. +All other functions of pycrypto are still available via the interface of CryptoPlus. The new cipher implementations can be accessed via CryptoPlus.Cipher.python_* while the original ones from pycrypto are -still available under their original name via CryptoPlus.Cipher.*. When -using the original Ciphers, the original pycrypto (C) code is used but -the chains will still be made by my new python code. +still available under their original name via CryptoPlus.Cipher.*. +When using the original ciphers, the original pycrypto code written in C is +used but the chaining modes being used are the new ones in Python. New functions: Ciphers: Rijndael Serpent Twofish - Chain Modes: + Chaining Modes: XTS CMAC -Note: for all the cipher algorithms, code has been reused from -others. Appropriate copyright notices are in the source code. +Note: for the cipher algorithms, code has been reused from third parties. +Corresponding copyright notices are available in their source code. 2. INSTALLING ============== -necessary packages before installing: +required packages before installing: - python-setuptools - python-pkg-resources @@ -53,19 +53,19 @@ python setup.py install Same API from PyCrypto can be used. See: http://www.dlitz.net/software/pycrypto/doc/ -Biggest changes are the addition of some chain modes and -block ciphers. There are lot of examples provided in the -docstrings. Have a look at them by looking in the source code -'../CryptoPlus/Cipher/*.py' or via an interactive python session by using -'CryptoPlus.Cipher.python_AES.new?'. Once you constructed a cipher object -with 'cipher = CryptoPlus.Cipher.python_AES.new(...)' you can get more -info about encrypting and decrypting by reading the apprioprate docstring -('cipher.encrypt?','cipher.decrypt?'). +Biggest changes are the addition of some chain modes and block ciphers. +A lot of examples are provided as docstrings. +Have a look at them in '../CryptoPlus/Cipher/*.py' or via an interactive +python session by using 'CryptoPlus.Cipher.python_AES.new?'. +Once a cipher object is constructed with +'cipher = CryptoPlus.Cipher.python_AES.new(...)' +you can get more info about encrypting and decrypting by reading +the apprioprate docstring ('cipher.encrypt?','cipher.decrypt?'). Some test functions are provided in the docstrings and in the 'test' -folder. Run all the doctest in the new Cipher function by using +folder. Run all the doctests in the new Cipher function by using the '../test/test_doctest.py' script. '../test/test.py' provides -some test function for the testvectors avaible from the module via +some test function for the testvectors available from the module via 'CryptoPlus.Cipher.testvectors'. Have a look at the test.py sourcecode to have an idea of how to use those test vectors. -- 2.11.4.GIT