Merge pull request #82 from mattsb42-aws/vectors

Cleanup test vector handlers module and prepare for release

Author: mattsb42-aws

.travis.yml

@@ -94,5 +94,116 @@ matrix:
       env: TOXENV=black-check
     - python: 3.6
       env: TOXENV=isort-check
+    ########################
+    # Test Vector Handlers #
+    ########################
+    # CPython 2.7
+    - python: 2.7
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py27-awses_1.3.0
+    - python: 2.7
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py27-awses_1.3.max
+    - python: 2.7
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py27-awses_latest
+    # CPython 3.4
+    - python: 3.4
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py34-awses_1.3.0
+    - python: 3.4
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py34-awses_1.3.max
+    - python: 3.4
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py34-awses_latest
+    # CPython 3.5
+    - python: 3.5
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py35-awses_1.3.0
+    - python: 3.5
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py35-awses_1.3.max
+    - python: 3.5
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py35-awses_latest
+    # CPython 3.6
+    - python: 3.6
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py36-awses_1.3.0
+    - python: 3.6
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py36-awses_1.3.max
+    - python: 3.6
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py36-awses_latest
+    # CPython 3.7
+    - python: 3.7
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py37-awses_1.3.0
+      dist: xenial
+      sudo: true
+    - python: 3.7
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py37-awses_1.3.max
+      dist: xenial
+      sudo: true
+    - python: 3.7
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=py37-awses_latest
+      dist: xenial
+      sudo: true
+    # Linters
+    - python: 3.6
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=bandit
+    - python: 3.6
+      env:
+        TEST_VECTOR_HANDLERS=1
+        TOXENV=readme
+    # Pending buildout of docs
+    #- python: 3.6
+    #  env:
+    #    TEST_VECTOR_HANDLERS=1
+    #    TOXENV=docs
+    #- python: 3.6
+    #  env:
+    #    TEST_VECTOR_HANDLERS=1
+    #    TOXENV=doc8
+    # Pending linting cleanup
+    #- python: 3.6
+    #  env:
+    #    TEST_VECTOR_HANDLERS=1
+    #    TOXENV=flake8
+    #- python: 3.6
+    #  env:
+    #    TEST_VECTOR_HANDLERS=1
+    #    TOXENV=pylint
+    #- python: 3.6
+    #  env:
+    #    TEST_VECTOR_HANDLERS=1
+    #    TOXENV=flake8-tests
+    #- python: 3.6
+    #  env:
+    #    TEST_VECTOR_HANDLERS=1
+    #    TOXENV=pylint-tests
 install: pip install tox
-script: tox
+script:
+  - if [[ -n $TEST_VECTOR_HANDLERS ]]; then cd test_vector_handlers; fi
+  - tox

test_vector_generator/README.rst

@@ -0,0 +1,57 @@
+#######################################
+aws-encryption-sdk test vector handlers
+#######################################
+
+There modules provide handlers to be used to process existing, or generate new,
+test vectors based on test vector manifests.
+
+***************
+Getting Started
+***************
+
+Required Prerequisites
+======================
+
+* Python 2.7 or 3.4+
+* aws-encryption-sdk
+
+Use
+===
+
+In addition to direct use of the library, some CLI tools are provided to simplify
+processing of common test manifest types.
+
+Full Message Encrypt
+--------------------
+
+Used to process an AWS Encryption SDK Full Message Encrypt manifest and produce
+a Full Message Decrypt manifest along with all corresponding plaintexts and ciphertexts.
+
+.. code::
+
+    usage: awses-full-message-encrypt [-h] --output OUTPUT --input INPUT [--human]
+
+    Build ciphertexts and decrypt manifest from keys and encrypt manifests
+
+    optional arguments:
+      -h, --help       show this help message and exit
+      --output OUTPUT  Directory in which to store results
+      --input INPUT    Existing full message encrypt manifest
+      --human          Output human-readable JSON
+
+
+Full Message Decrypt
+--------------------
+
+Used to process an AWS Encryption SDK Full Message Decrypt manifest to
+decrypt and verify all referenced ciphertexts.
+
+.. code::
+
+    usage: awses-full-message-decrypt [-h] --input INPUT
+
+    Decrypt ciphertexts generated by awses-full-message-encrypt
+
+    optional arguments:
+      -h, --help     show this help message and exit
+      --input INPUT  Existing full message decrypt manifest

test_vector_generator/MANIFEST.in renamed to test_vector_handlers/MANIFEST.in

@@ -1,2 +1,3 @@
 attrs >= 17.4.0
+aws-encryption-sdk
 six

test_vector_handlers/README.rst

@@ -10,4 +10,4 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
-__version__ = "0.0.0"
+__version__ = "1.0.0"

test_vector_generator/requirements.txt renamed to test_vector_handlers/requirements.txt

@@ -28,7 +28,9 @@ def cli(args=None):
     # type: (Optional[Iterable[str]]) -> None
     """CLI entry point for processing AWS Encryption SDK Decrypt Message manifests."""
     parser = argparse.ArgumentParser(description="Decrypt ciphertexts generated by awses-full-message-encrypt")
-    parser.add_argument("--input", type=argparse.FileType("r"), help="Existing full message decrypt manifest")
+    parser.add_argument(
+        "--input", required=True, type=argparse.FileType("r"), help="Existing full message decrypt manifest"
+    )
 
     parsed = parser.parse_args(args)