1#!/usr/bin/env python
2# coding=utf-8
3# Copyright (c) 2020, Google Inc.
4#
5# Permission to use, copy, modify, and/or distribute this software for any
6# purpose with or without fee is hereby granted, provided that the above
7# copyright notice and this permission notice appear in all copies.
8#
9# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
12# SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
14# OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
15# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16
17"""This script translates JSON test vectors to BoringSSL's "FileTest" format.
18
19Usage: translate_test_vectors.py TEST_VECTORS_JSON_FILE
20
21The TEST_VECTORS_JSON_FILE is expected to come from the HPKE reference
22implementation at https://github.com/cisco/go-hpke. The output file is
23hardcoded as "hpke_test_vectors.txt".
24"""
25
26import collections
27import json
28import sys
29
30HPKE_MODE_BASE = 0
31HPKE_MODE_PSK = 1
32HPKE_DHKEM_X25519_SHA256 = 0x0020
33HPKE_AEAD_EXPORT_ONLY = 0xffff
34
35
36def read_test_vectors_and_generate_code(json_file_in_path, test_file_out_path):
37  """Translates JSON test vectors into BoringSSL's FileTest language.
38
39    Args:
40      json_file_in_path: Path to the JSON test vectors file.
41      test_file_out_path: Path to output file.
42  """
43
44  # Load the JSON file into |test_vecs|.
45  with open(json_file_in_path) as file_in:
46    test_vecs = json.load(file_in)
47
48  lines = []
49  for test in test_vecs:
50    # Filter out test cases that we don't use.
51    if (test["mode"] not in [HPKE_MODE_BASE, HPKE_MODE_PSK] or
52        test["kem_id"] != HPKE_DHKEM_X25519_SHA256 or
53        test["aead_id"] == HPKE_AEAD_EXPORT_ONLY):
54      continue
55
56    keys = ["mode", "kdf_id", "aead_id", "info", "skRm", "skEm", "pkRm", "pkEm"]
57
58    if test["mode"] == HPKE_MODE_PSK:
59      keys.append("psk")
60      keys.append("psk_id")
61
62    for key in keys:
63      lines.append("{} = {}".format(key, str(test[key])))
64
65    for i, enc in enumerate(test["encryptions"]):
66      lines.append("# encryptions[{}]".format(i))
67      for key in ("aad", "ciphertext", "plaintext"):
68        lines.append("{} = {}".format(key, str(enc[key])))
69
70    for i, exp in enumerate(test["exports"]):
71      lines.append("# exports[{}]".format(i))
72      for key in ("exporter_context", "L", "exported_value"):
73        lines.append("{} = {}".format(key, str(exp[key])))
74
75    lines.append("")
76
77  with open(test_file_out_path, "w") as file_out:
78    file_out.write("\n".join(lines))
79
80
81def main(argv):
82  if len(argv) != 2:
83    print(__doc__)
84    sys.exit(1)
85
86  read_test_vectors_and_generate_code(argv[1], "hpke_test_vectors.txt")
87
88
89if __name__ == "__main__":
90  main(sys.argv)
91