[fisim/crypto] Add instruction skip simulator

Add a script to load the pentest framework, connect to OpenOCD, and connect to GDB.
Generate a trace file of a called function.
Use the trace file to insert instruction skips in order to simulate fault attacks and test countermeasures.

Signed-off-by: Siemen Dhooghe <[email protected]>

Author: siemen11

sw/device/tests/penetrationtests/BUILD

@@ -2,7 +2,7 @@
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
 
-load(":pentest.bzl", "pentest_cryptolib_fi_asym", "pentest_cryptolib_fi_sym", "pentest_cryptolib_sca_asym", "pentest_cryptolib_sca_sym", "pentest_fi", "pentest_fi_ibex", "pentest_fi_otbn", "pentest_sca")
+load(":pentest.bzl", "pentest_cryptolib_fi_asym", "pentest_cryptolib_fi_gdb_asym", "pentest_cryptolib_fi_gdb_sym", "pentest_cryptolib_fi_sym", "pentest_cryptolib_sca_asym", "pentest_cryptolib_sca_sym", "pentest_fi", "pentest_fi_ibex", "pentest_fi_otbn", "pentest_sca")
 load("@ot_python_deps//:requirements.bzl", "requirement")
 
 package(default_visibility = ["//visibility:public"])
@@ -287,6 +287,17 @@ pentest_cryptolib_fi_asym(
     test_vectors = CRYPTOLIB_FI_ASYM_TESTVECTOR_TARGETS,
 )
 
+pentest_cryptolib_fi_gdb_sym(
+    name = "fi_sym_cryptolib_python_gdb_test",
+    tags = [
+        "manual",
+        "skip_in_ci",
+    ],
+    test_args = "",
+    test_harness = "//sw/host/penetrationtests/python/fi:fi_sym_cryptolib_python_gdb_test",
+    test_vectors = [],
+)
+
 pentest_cryptolib_fi_asym(
     name = "fi_asym_cryptolib_python_test",
     tags = [],
@@ -295,6 +306,17 @@ pentest_cryptolib_fi_asym(
     test_vectors = [],
 )
 
+pentest_cryptolib_fi_gdb_asym(
+    name = "fi_asym_cryptolib_python_gdb_test",
+    tags = [
+        "manual",
+        "skip_in_ci",
+    ],
+    test_args = "",
+    test_harness = "//sw/host/penetrationtests/python/fi:fi_asym_cryptolib_python_gdb_test",
+    test_vectors = [],
+)
+
 CRYPTOLIB_SCA_SYM_TESTVECTOR_TARGETS = [
     "//sw/host/penetrationtests/testvectors/data:sca_sym_cryptolib",
 ]

sw/device/tests/penetrationtests/doc/README.md

@@ -76,6 +76,25 @@ cd $REPO_TOP
 ./bazelisk.sh run //sw/device/tests/penetrationtests:fi_ibex_python_test_fpga_cw340_sival_rom_ext
 ```
 
+## GDB Testing (FiSim)
+
+The crypto library is tested on a debug enabled CW340 FPGA by tracing several relevant cryptographic calls and apply instruction skips or other fault models to their execution. In order to use this testing, the CW340 FPGA has to be adapted. We provide a picture on its setup as reference:
+
+![CW340 debug setup](fi_sim_cw340_setup.png)
+
+In order to run a GDB test, find the "gdb_test" targets in the BUILD file in //sw/device/tests/penetrationtests. For example,
+```console
+./bazelisk.sh run //sw/device/tests/penetrationtests:fi_sym_cryptolib_python_gdb_test_fpga_cw340_rom_ext
+
+./bazelisk.sh run //sw/device/tests/penetrationtests:fi_asym_cryptolib_python_gdb_test_fpga_cw340_rom_ext
+```
+
+These tests specifically run in the rom_ext environment since this is a ROM version in the RMA lifecycle which enables debug. The test then builds and runs openocd in the background which opens the default port 3333 to GDB. The files in //sw/host/penetrationtests/python/util contain classes in order to communicate with the FPGA, OpenOCD, and GDB.
+
+The testing is performed on the flashed pentest framework in this directory which provides the interface to the crypto library in //sw/device/lib/crypto. The targeted functions are found parsing the dis file. The parser is also found in //sw/host/penetrationtests/python/util.
+
+All test outputs are saved in the bazel-testlogs/sw/device/tests/penetrationtests folder in opentitan. Take note that the output to the terminal is piped to the campaign file in that directory, please consult this file for the test output. This is done since each subtest can take 2-12h.
+
 ## Versioning
 
 In `//sw/device/tests/penetrationtests/firmware/lib/pentest_lib.h`, a value PENTEST_VERSION is found with the current version of the pentest framework.

sw/device/tests/penetrationtests/pentest.bzl

@@ -24,6 +24,10 @@ PENTEST_EXEC_ENVS = {
     "//hw/top_earlgrey:fpga_cw340_rom_ext": "fpga_cw340",
 } | EARLGREY_SILICON_OWNER_ROM_EXT_ENVS
 
+GDB_EXEC_ENVS = {
+    "//hw/top_earlgrey:fpga_cw340_rom_ext": "fpga_cw340",
+}
+
 FIRMWARE_DEPS_FI = [
     "//sw/device/tests/penetrationtests/firmware/fi:alert_fi",
     "//sw/device/tests/penetrationtests/firmware/fi:crypto_fi",
@@ -388,6 +392,50 @@ def pentest_cryptolib_fi_sym(name, test_vectors, test_args, test_harness, tags):
         deps = FIRMWARE_DEPS_CRYPTOLIB_FI_SYM,
     )
 
+def pentest_cryptolib_fi_gdb_sym(name, test_vectors, test_args, test_harness, tags):
+    """A macro for defining a CryptoTest test case.
+
+    Args:
+        name: the name of the test.
+        test_vectors: the test vectors to use.
+        test_args: additional arguments to pass to the test.
+        test_harness: the test harness to use.
+        tags: indicate the tags for CI.
+    """
+    opentitan_test(
+        name = name,
+        srcs = ["//sw/device/tests/penetrationtests/firmware:firmware_cryptolib_fi_sym.c"],
+        fpga = fpga_params(
+            timeout = "long",
+            data = test_vectors,
+            tags = tags,
+            test_cmd = """
+                --bootstrap={firmware}
+            """ + test_args,
+            test_harness = test_harness,
+        ),
+        fpga_cw340 = fpga_params(
+            timeout = "long",
+            tags = tags,
+            data = test_vectors,
+            test_cmd = """
+                --bootstrap={firmware}
+            """ + test_args,
+            test_harness = test_harness,
+        ),
+        exec_env = GDB_EXEC_ENVS,
+        silicon = silicon_params(
+            timeout = "eternal",
+            tags = tags,
+            data = test_vectors,
+            test_cmd = """
+                --bootstrap={firmware}
+            """ + test_args,
+            test_harness = test_harness,
+        ),
+        deps = FIRMWARE_DEPS_CRYPTOLIB_FI_SYM,
+    )
+
 def pentest_cryptolib_fi_asym(name, test_vectors, test_args, test_harness, tags):
     """A macro for defining a CryptoTest test case.
 
@@ -432,6 +480,50 @@ def pentest_cryptolib_fi_asym(name, test_vectors, test_args, test_harness, tags)
         deps = FIRMWARE_DEPS_CRYPTOLIB_FI_ASYM,
     )
 
+def pentest_cryptolib_fi_gdb_asym(name, test_vectors, test_args, test_harness, tags):
+    """A macro for defining a CryptoTest test case.
+
+    Args:
+        name: the name of the test.
+        test_vectors: the test vectors to use.
+        test_args: additional arguments to pass to the test.
+        test_harness: the test harness to use.
+        tags: indicate the tags for CI.
+    """
+    opentitan_test(
+        name = name,
+        srcs = ["//sw/device/tests/penetrationtests/firmware:firmware_cryptolib_fi_asym.c"],
+        fpga = fpga_params(
+            timeout = "long",
+            data = test_vectors,
+            tags = tags,
+            test_cmd = """
+                --bootstrap={firmware}
+            """ + test_args,
+            test_harness = test_harness,
+        ),
+        fpga_cw340 = fpga_params(
+            timeout = "long",
+            tags = tags,
+            data = test_vectors,
+            test_cmd = """
+                --bootstrap={firmware}
+            """ + test_args,
+            test_harness = test_harness,
+        ),
+        exec_env = GDB_EXEC_ENVS,
+        silicon = silicon_params(
+            timeout = "eternal",
+            tags = tags,
+            data = test_vectors,
+            test_cmd = """
+                --bootstrap={firmware}
+            """ + test_args,
+            test_harness = test_harness,
+        ),
+        deps = FIRMWARE_DEPS_CRYPTOLIB_FI_ASYM,
+    )
+
 def pentest_cryptolib_sca_sym(name, test_vectors, test_args, test_harness, tags):
     """A macro for defining a CryptoTest test case.
 

sw/host/penetrationtests/python/fi/BUILD

@@ -150,6 +150,28 @@ py_binary(
     ],
 )
 
+py_binary(
+    name = "fi_sym_cryptolib_python_gdb_test",
+    testonly = True,
+    srcs = ["gdb_testing/fi_sym_cryptolib_python_gdb_test.py"],
+    data = [
+        "//sw/host/opentitantool",
+        "//third_party/openocd:openocd_bin",
+        "//util/openocd/board:cw340_ftdi.cfg",
+        "//util/openocd/target:lowrisc-earlgrey.cfg",
+        "@lowrisc_rv32imcb_toolchain//:bin/riscv32-unknown-elf-gdb",
+    ],
+    deps = [
+        "//sw/host/penetrationtests/python/fi:fi_sym_cryptolib_commands",
+        "//sw/host/penetrationtests/python/util:common_library",
+        "//sw/host/penetrationtests/python/util:dis_parser",
+        "//sw/host/penetrationtests/python/util:gdb_controller",
+        "//sw/host/penetrationtests/python/util:targets",
+        "@rules_python//python/runfiles",
+        requirement("pycryptodome"),
+    ],
+)
+
 py_binary(
     name = "fi_asym_cryptolib_python_test",
     testonly = True,
@@ -168,6 +190,28 @@ py_binary(
     ],
 )
 
+py_binary(
+    name = "fi_asym_cryptolib_python_gdb_test",
+    testonly = True,
+    srcs = ["gdb_testing/fi_asym_cryptolib_python_gdb_test.py"],
+    data = [
+        "//sw/host/opentitantool",
+        "//third_party/openocd:openocd_bin",
+        "//util/openocd/board:cw340_ftdi.cfg",
+        "//util/openocd/target:lowrisc-earlgrey.cfg",
+        "@lowrisc_rv32imcb_toolchain//:bin/riscv32-unknown-elf-gdb",
+    ],
+    deps = [
+        "//sw/host/penetrationtests/python/fi:fi_asym_cryptolib_commands",
+        "//sw/host/penetrationtests/python/util:common_library",
+        "//sw/host/penetrationtests/python/util:dis_parser",
+        "//sw/host/penetrationtests/python/util:gdb_controller",
+        "//sw/host/penetrationtests/python/util:targets",
+        "@rules_python//python/runfiles",
+        requirement("pycryptodome"),
+    ],
+)
+
 py_library(
     name = "fi_ibex_functions",
     srcs = ["host_scripts/fi_ibex_functions.py"],