Merge GH #359 Add botan cli encryption tool

3 files changed, 216 insertions, 0 deletions

diff --git a/src/scripts/ci/travis/build.sh b/src/scripts/ci/travis/build.sh
index 71d33d1bb..36517738b 100755
--- a/src/scripts/ci/travis/build.sh
+++ b/src/scripts/ci/travis/build.sh
@@ -6,6 +6,7 @@ MAKE_PREFIX=()
 TEST_PREFIX=()
 TEST_EXE=./botan-test
 TEST_FLAGS=()
+CLI_EXE=./botan
 CFG_FLAGS=(--prefix=/tmp/botan-installation --cc=$CC --os=$TRAVIS_OS_NAME)
 
 CC_BIN=$CXX
@@ -179,6 +180,12 @@ else
     time "${TEST_CMD[@]}"
 fi
 
+if [ "$BUILD_MODE" = "static" ] || [ "$BUILD_MODE" = "shared" ]
+then
+    echo "Running cli tests ..."
+    ./src/scripts/cli_tests.py "$CLI_EXE"
+fi
+
 # Run Python tests (need shared libs)
 if [ "$BUILD_MODE" = "shared" ] || [ "$BUILD_MODE" = "coverage" ];
 then
diff --git a/src/scripts/cli_tests.py b/src/scripts/cli_tests.py
new file mode 100755
index 000000000..757de654d
--- /dev/null
+++ b/src/scripts/cli_tests.py
@@ -0,0 +1,159 @@
+#!/usr/bin/env python3
+
+import binascii
+from collections import OrderedDict
+import unittest
+import argparse
+import re
+import subprocess
+import sys
+
+import vecparser
+
+cli_binary = ""
+
+SUPPORTED_ALGORITHMS = [
+    'AES-128/CFB',
+    'AES-192/CFB',
+    'AES-256/CFB',
+    'AES-128/GCM',
+    'AES-192/GCM',
+    'AES-256/GCM',
+    'AES-128/OCB',
+    'AES-128/XTS',
+    'AES-256/XTS'
+]
+
+def append_ordered(base, additional_elements):
+    for key in additional_elements:
+        value = additional_elements[key]
+        base[key] = value
+
+class TestSequence(unittest.TestCase):
+    pass
+
+def create_test(data):
+    def do_test_expected(self):
+        iv = data['Nonce']
+        key = data['Key']
+        ad = data['AD'] if 'AD' in data else ""
+        plaintext = data['In'].lower()
+        ciphertext = data['Out'].lower()
+        algorithm = data['Algorithm']
+        direction = data['Direction']
+
+        # CFB
+        if algorithm == "AES-128/CFB":
+            mode = "aes-128-cfb"
+        elif algorithm == "AES-192/CFB":
+            mode = "aes-192-cfb"
+        elif algorithm == "AES-256/CFB":
+            mode = "aes-256-cfb"
+        # GCM
+        elif algorithm == "AES-128/GCM":
+            mode = "aes-128-gcm"
+        elif algorithm == "AES-192/GCM":
+            mode = "aes-192-gcm"
+        elif algorithm == "AES-256/GCM":
+            mode = "aes-256-gcm"
+        # OCB
+        elif algorithm == "AES-128/OCB":
+            mode = "aes-128-ocb"
+        # XTS
+        elif algorithm == "AES-128/XTS":
+            mode = "aes-128-xts"
+        elif algorithm == "AES-256/XTS":
+            mode = "aes-256-xts"
+        else: raise Exception("Unknown algorithm: '" + algorithm + "'")
+
+        cmd = [
+            cli_binary,
+            "encryption",
+            "--mode=%s" % mode,
+            "--iv=%s" % iv,
+            "--ad=%s" % ad,
+            "--key=%s" % key]
+        if direction == "decrypt":
+            cmd += ['--decrypt']
+        # out_raw = subprocess.check_output(cmd)
+
+        if direction == "decrypt":
+            invalue = ciphertext
+        else:
+            invalue = plaintext
+
+        #print(cmd)
+
+        p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
+        out_raw = p.communicate(input=binascii.unhexlify(invalue))[0]
+        out = binascii.hexlify(out_raw).decode("UTF-8").lower()
+
+        # Renamings
+        if direction == "decrypt":
+            expected = plaintext
+        else:
+            expected = ciphertext
+        actual = out
+        self.assertEqual(expected, actual)
+    return do_test_expected
+
+def get_testdata(document):
+    out = OrderedDict()
+    for algorithm in document:
+        if algorithm in SUPPORTED_ALGORITHMS:
+            testcase_number = 0
+            for testcase in document[algorithm]:
+                testcase_number += 1
+                for direction in ['encrypt', 'decrypt']:
+                    testname = "{} no {:0>3} ({})".format(
+                        algorithm.lower(), testcase_number, direction)
+                    testname = re.sub("[^-a-z0-9-]", "_", testname)
+                    testname = re.sub("_+", "_", testname)
+                    testname = testname.strip("_")
+                    out[testname] = {}
+                    for key in testcase:
+                        value = testcase[key]
+                        out[testname][key] = value
+                    out[testname]['Algorithm'] = algorithm
+                    out[testname]['Direction'] = direction
+    return out
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(description="")
+    parser.add_argument('cli_binary',
+                        help='path to the botan cli binary')
+    parser.add_argument('unittest_args', nargs="*")
+    args = parser.parse_args()
+
+    cli_binary = args.cli_binary
+
+    vecfile_cfb = vecparser.VecDocument("src/tests/data/modes/cfb.vec")
+    vecfile_gcm = vecparser.VecDocument("src/tests/data/aead/gcm.vec")
+    vecfile_ocb = vecparser.VecDocument("src/tests/data/aead/ocb.vec")
+    vecfile_xts = vecparser.VecDocument("src/tests/data/modes/xts.vec")
+    #data = vecfile.get_data()
+    #for algo in data:
+    #    print(algo)
+    #    i = 0
+    #    for testcase in data[algo]:
+    #        i += 1
+    #        print(str(i) + ":", testcase)
+
+    testdata = OrderedDict()
+    append_ordered(testdata, get_testdata(vecfile_cfb.get_data()))
+    append_ordered(testdata, get_testdata(vecfile_gcm.get_data()))
+    append_ordered(testdata, get_testdata(vecfile_ocb.get_data()))
+    append_ordered(testdata, get_testdata(vecfile_xts.get_data()))
+
+    #for testname in testdata:
+    #    print(testname)
+    #    for key in testdata[testname]:
+    #        print("    " + key + ": " + testdata[testname][key])
+    for testname in testdata:
+        test_method = create_test(testdata[testname])
+        test_method.__name__ = 'test_%s' % testname
+        setattr(TestSequence, test_method.__name__, test_method)
+
+    # Hand over sys.argv[0] and unittest_args to the testing framework
+    sys.argv[1:] = args.unittest_args
+    unittest.main()
diff --git a/src/scripts/vecparser.py b/src/scripts/vecparser.py
new file mode 100644
index 000000000..707a58920
--- /dev/null
+++ b/src/scripts/vecparser.py
@@ -0,0 +1,50 @@
+from collections import OrderedDict
+import re
+
+class VecDocument:
+    def __init__(self, filepath):
+        self.data = OrderedDict()
+        last_testcase_number = 1
+        current_testcase_number = 1
+        current_group_name = ""
+        last_group_name = ""
+        current_testcase = {}
+
+        PATTERN_GROUPHEADER = "^\[(.+)\]$"
+        PATTERN_KEYVALUE = "^\s*([a-zA-Z]+)\s*=(.*)$"
+
+        with open(filepath, 'r') as f:
+            # Append one empty line to simplify parsing
+            lines = f.read().splitlines() + ["\n"]
+
+            for line in lines:
+                line = line.strip()
+                if line.startswith("#"):
+                    pass # Skip
+                elif line == "":
+                    current_testcase_number += 1
+                elif re.match(PATTERN_GROUPHEADER, line):
+                    match = re.match(PATTERN_GROUPHEADER, line)
+                    current_group_name = match.group(1)
+                elif re.match(PATTERN_KEYVALUE, line):
+                    match = re.match(PATTERN_KEYVALUE, line)
+                    key = match.group(1)
+                    value = match.group(2).strip()
+                    current_testcase[key] = value
+
+                if current_testcase_number != last_testcase_number:
+                    if not current_group_name in self.data:
+                        self.data[current_group_name] = []
+                    if len(current_testcase) != 0:
+                        self.data[current_group_name].append(current_testcase)
+                    current_testcase = {}
+                    last_testcase_number = current_testcase_number
+
+                if current_group_name != last_group_name:
+                    last_group_name = current_group_name
+                    # Reset testcase number
+                    last_testcase_number = 1
+                    current_testcase_number = 1
+
+    def get_data(self):
+        return self.data