Make package more "sub-package" friendly and bumped version.

Author: ricmoo

README.md

@@ -79,25 +79,26 @@ A handful of test cases are provided for both the hash algorithm and the ScryptF
 
 ```python
 # python tests/run-tests-hash.py
-Version: 1.2.0
+Version: 1.3.1
 Test 1: pass
 Test 2: pass
 Test 3: pass
 Test 4: pass
 Test 5: pass
 
 # python tests/run-tests-file.py 
-Test Encrypt/Decrypt: text_length=3 result=pass
-Test Encrypt/Decrypt: text_length=16 result=pass
-Test Encrypt/Decrypt: text_length=127 result=pass
-Test Encrypt/Decrypt: text_length=128 result=pass
-Test Encrypt/Decrypt: text_length=129 result=pass
-Test Encrypt/Decrypt: text_length=1500 result=pass
+Version: 1.3.1
+Test Encrypt/Decrypt: text_length=3 result=pass valid=True
+Test Encrypt/Decrypt: text_length=16 result=pass valid=True
+Test Encrypt/Decrypt: text_length=127 result=pass valid=True
+Test Encrypt/Decrypt: text_length=128 result=pass valid=True
+Test Encrypt/Decrypt: text_length=129 result=pass valid=True
+Test Encrypt/Decrypt: text_length=1500 result=pass valid=True
 Created /tmp/test-10.scrypt and /tmp/test-10.txt. Check with tarsnap.
 Created /tmp/test-100.scrypt and /tmp/test-100.txt. Check with tarsnap.
 Created /tmp/test-1000.scrypt and /tmp/test-1000.txt. Check with tarsnap.
 Test Verify: filename=tests/test1.scrypt result=pass
-Test Decrypt: dec('tests/test1.scrypt') == 'tests/test1.txt' result=pass valid=True
+Test Decrypt: dec('tests/test1.scrypt') == 'tests/test1.txt' result=pass valid=None
 Test Decrypt: dec('tests/test1.scrypt') == 'tests/test1.txt' result=pass valid=True
 Test Decrypt: dec('tests/test1.scrypt') == 'tests/test1.txt' result=pass valid=True
 Test Verify: filename=tests/test2.scrypt result=pass
@@ -106,6 +107,10 @@ Test Decrypt: dec('tests/test2.scrypt') == 'tests/test2.txt' result=pass valid=N
 Test Decrypt: dec('tests/test2.scrypt') == 'tests/test2.txt' result=pass valid=True
 ```
 
+Notice that `valid` is sometimes None. The value of `valid` can take on one of three values:
+* **None** - File has not been entirely read, so the checksum cannot be verified
+* **True** - The end-of-file checksum is valid
+* **False** - The end-of-file checksum is invalid (some bytes in the file are corrupt)
 
 FAQ
 ---

pyscrypt/__init__.py

@@ -32,9 +32,9 @@
 # This implementation is VERY slow; It is meant only for reference and
 # for situations where C wrappers are not permitted or difficult to install.
 
-from pyscrypt.file import InvalidScryptFileFormat, ScryptFile
-from pyscrypt.hash import hash
+from .file import InvalidScryptFileFormat, ScryptFile
+from .hash import hash
 
-VERSION = [1, 3, 0]
+VERSION = [1, 3, 1]
 
 __all__ = ['hash', 'InvalidScryptFileFormat', 'ScryptFile']

pyscrypt/aesctr.py

@@ -36,7 +36,7 @@ class AES(object):
     # Round constant words
     rcon = [ 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x1b, 0x36, 0x6c, 0xd8, 0xab, 0x4d, 0x9a, 0x2f, 0x5e, 0xbc, 0x63, 0xc6, 0x97, 0x35, 0x6a, 0xd4, 0xb3, 0x7d, 0xfa, 0xef, 0xc5, 0x91 ]
 
-    # S-box and Inverse S-box
+    # S-box
     S = [ 0x63, 0x7c, 0x77, 0x7b, 0xf2, 0x6b, 0x6f, 0xc5, 0x30, 0x01, 0x67, 0x2b, 0xfe, 0xd7, 0xab, 0x76, 0xca, 0x82, 0xc9, 0x7d, 0xfa, 0x59, 0x47, 0xf0, 0xad, 0xd4, 0xa2, 0xaf, 0x9c, 0xa4, 0x72, 0xc0, 0xb7, 0xfd, 0x93, 0x26, 0x36, 0x3f, 0xf7, 0xcc, 0x34, 0xa5, 0xe5, 0xf1, 0x71, 0xd8, 0x31, 0x15, 0x04, 0xc7, 0x23, 0xc3, 0x18, 0x96, 0x05, 0x9a, 0x07, 0x12, 0x80, 0xe2, 0xeb, 0x27, 0xb2, 0x75, 0x09, 0x83, 0x2c, 0x1a, 0x1b, 0x6e, 0x5a, 0xa0, 0x52, 0x3b, 0xd6, 0xb3, 0x29, 0xe3, 0x2f, 0x84, 0x53, 0xd1, 0x00, 0xed, 0x20, 0xfc, 0xb1, 0x5b, 0x6a, 0xcb, 0xbe, 0x39, 0x4a, 0x4c, 0x58, 0xcf, 0xd0, 0xef, 0xaa, 0xfb, 0x43, 0x4d, 0x33, 0x85, 0x45, 0xf9, 0x02, 0x7f, 0x50, 0x3c, 0x9f, 0xa8, 0x51, 0xa3, 0x40, 0x8f, 0x92, 0x9d, 0x38, 0xf5, 0xbc, 0xb6, 0xda, 0x21, 0x10, 0xff, 0xf3, 0xd2, 0xcd, 0x0c, 0x13, 0xec, 0x5f, 0x97, 0x44, 0x17, 0xc4, 0xa7, 0x7e, 0x3d, 0x64, 0x5d, 0x19, 0x73, 0x60, 0x81, 0x4f, 0xdc, 0x22, 0x2a, 0x90, 0x88, 0x46, 0xee, 0xb8, 0x14, 0xde, 0x5e, 0x0b, 0xdb, 0xe0, 0x32, 0x3a, 0x0a, 0x49, 0x06, 0x24, 0x5c, 0xc2, 0xd3, 0xac, 0x62, 0x91, 0x95, 0xe4, 0x79, 0xe7, 0xc8, 0x37, 0x6d, 0x8d, 0xd5, 0x4e, 0xa9, 0x6c, 0x56, 0xf4, 0xea, 0x65, 0x7a, 0xae, 0x08, 0xba, 0x78, 0x25, 0x2e, 0x1c, 0xa6, 0xb4, 0xc6, 0xe8, 0xdd, 0x74, 0x1f, 0x4b, 0xbd, 0x8b, 0x8a, 0x70, 0x3e, 0xb5, 0x66, 0x48, 0x03, 0xf6, 0x0e, 0x61, 0x35, 0x57, 0xb9, 0x86, 0xc1, 0x1d, 0x9e, 0xe1, 0xf8, 0x98, 0x11, 0x69, 0xd9, 0x8e, 0x94, 0x9b, 0x1e, 0x87, 0xe9, 0xce, 0x55, 0x28, 0xdf, 0x8c, 0xa1, 0x89, 0x0d, 0xbf, 0xe6, 0x42, 0x68, 0x41, 0x99, 0x2d, 0x0f, 0xb0, 0x54, 0xbb, 0x16 ]
 
     # Transformations (could just use T1 and shift to generate the others)

pyscrypt/file.py

@@ -51,8 +51,8 @@
 import os
 import struct
 
-from pyscrypt.hash import hash
-from pyscrypt import aesctr
+from .hash import hash
+from . import aesctr
 
 
 MODE_READ  = 'r'

pyscrypt/hash.py

@@ -24,8 +24,8 @@
 import hashlib
 import hmac
 
-from pyscrypt.pbkdf2 import pbkdf2
-from pyscrypt.util import array_overwrite, block_xor
+from .pbkdf2 import pbkdf2
+from .util import array_overwrite, block_xor
 
 def integerify(B, Bi, r):
     '''"A bijective function from ({0, 1} ** k) to {0, ..., (2 ** k) - 1".'''

pyscrypt/pbkdf2.py

@@ -23,7 +23,7 @@
 
 import struct
 
-from pyscrypt.util import block_xor
+from .util import block_xor
 
 def pbkdf2(password, salt, count, key_length, prf):
     '''Returns the result of the Password-Based Key Derivation Function 2.

setup.py

@@ -8,7 +8,7 @@
 reference and details.'''
 
 setup(name = 'pyscrypt',
-      version = '1.3.0',
+      version = '1.3.1',
       description = 'Pure-Python Implementation of the scrypt password-based key derivation function and scrypt file format library',
       long_description = LONG_DESCRIPTION,
       author = 'Richard Moore',