Skip to content

Commit 5e9efa6

Browse files
committed
[pentest] Update pentest framework documentation
This commit updates the pentest framework doc to include: - The general setup and interactions with ot-sca - The automatic testing framework Signed-off-by: Pascal Nasahl <[email protected]>
1 parent 290ac12 commit 5e9efa6

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

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

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
# Penetration Testing Framework
22

3-
The penetration testing framework is based on the [Cryptotest](../crypto/cryptotest/README.md) framework.
43
The purpose of this framework is to perform side-channel analysis (SCA) and fault injection (FI) attacks on the FPGA as well as on the chip.
54

5+
![Full hardware setup](pentest_setup.png)
6+
7+
As shown in the block diagram, the pentest framework runs on the target and receives configuration commands by the SCA and FI [ot-sca](https://github.com/lowRISC/ot-sca) framework.
8+
9+
## Usage
10+
11+
To run the penetration tests either on the FPGA or the chip, please follow the instructions in the [ot-sca](https://github.com/lowRISC/ot-sca) repository.
12+
13+
### Building Images
14+
615
To build the penetration testing framework for the ChipWhisperer CW310 FPGA board, run:
716
```console
817
cd $REPO_TOP
9-
./bazelisk.sh build //sw/device/tests/penetrationtests/firmware:firmware_fpga_cw310_test_rom
18+
./bazelisk.sh build //sw/device/tests/penetrationtests/firmware:firmware_fi
1019
```
1120

1221
Due to code size memory limitations, the firmware for the chip is split into a SCA, general FI, and OTBN FI binary. To build these binaries, run:
@@ -27,4 +36,14 @@ cd $REPO_TOP
2736

2837
The binaries are located in `bazel-bin/sw/device/tests/penetrationtests/firmware/`.
2938

30-
To run the penetration tests either on the FPGA or the chip, please follow the instructions in the [ot-sca](https://github.com/lowRISC/ot-sca) repository.
39+
## Automated Testing
40+
41+
To automatically test whether the pentest framework works, an automatic testing framework is provided.
42+
This framework compares the responses of the pentest frameworks with reference testvectors.
43+
44+
Use the following command to automatically test the Ibex FI tests on the CW310 FPGA board:
45+
46+
```console
47+
cd $REPO_TOP
48+
./bazelisk.sh run //sw/device/tests/penetrationtests:fi_ibex_fpga_cw310_sival_rom_ext
49+
```
Loading

0 commit comments

Comments
 (0)