Skip to content

Commit 55bd62a

Browse files
committed
add simple readme for test vector handlers
1 parent 9cb44f2 commit 55bd62a

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

test_vector_handlers/README.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
#######################################
2+
aws-encryption-sdk test vector handlers
3+
#######################################
4+
5+
There modules provide handlers to be used to process existing, or generate new,
6+
test vectors based on test vector manifests.
7+
8+
***************
9+
Getting Started
10+
***************
11+
12+
Required Prerequisites
13+
======================
14+
15+
* Python 2.7 or 3.4+
16+
* aws-encryption-sdk
17+
18+
Use
19+
===
20+
21+
In addition to direct use of the library, some CLI tools are provided to simplify
22+
processing of common test manifest types.
23+
24+
Full Message Encrypt
25+
--------------------
26+
27+
Used to process an AWS Encryption SDK Full Message Encrypt manifest and produce
28+
a Full Message Decrypt manifest along with all corresponding plaintexts and ciphertexts.
29+
30+
.. code::
31+
32+
usage: awses-full-message-encrypt [-h] --output OUTPUT --input INPUT [--human]
33+
34+
Build ciphertexts and decrypt manifest from keys and encrypt manifests
35+
36+
optional arguments:
37+
-h, --help show this help message and exit
38+
--output OUTPUT Directory in which to store results
39+
--input INPUT Existing full message encrypt manifest
40+
--human Output human-readable JSON
41+
42+
43+
Full Message Decrypt
44+
--------------------
45+
46+
Used to process an AWS Encryption SDK Full Message Decrypt manifest to
47+
decrypt and verify all referenced ciphertexts.
48+
49+
.. code::
50+
51+
usage: awses-full-message-decrypt [-h] --input INPUT
52+
53+
Decrypt ciphertexts generated by awses-full-message-encrypt
54+
55+
optional arguments:
56+
-h, --help show this help message and exit
57+
--input INPUT Existing full message decrypt manifest

0 commit comments

Comments
 (0)