Skip to content

Commit 28c94ef

Browse files
authored
Update README.md to round-2
Update readme to reflect the version of this code.
1 parent ed004de commit 28c94ef

File tree

1 file changed

+3
-27
lines changed

1 file changed

+3
-27
lines changed

README.md

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
# MAYO-M4
22
Arm Cortex-M4 implementation of [MAYO](https://pqmayo.org/).
3-
4-
This repository includes the Arm Cortex-M4 implementations as described in the paper **Nibbling MAYO: Optimized Implementations for AVX2 and Cortex-M4** available [here](https://eprint.iacr.org/2023/1683.pdf).
5-
6-
It consists of two variants:
7-
1. A slower version compatible with the round-1 specification of MAYO using bitsliced representation. This version is contained in the [main branch](https://github.com/PQCMayo/MAYO-M4/tree/main) of this repository.
8-
2. A faster version that changes representation of keys and PRNG output to nibble-sliced representation compatible with the [nibbling-mayo branch](https://github.com/PQCMayo/MAYO-C/tree/nibbling-mayo) of the reference implementation. This version is contained in the [nibbling-mayo branch](https://github.com/PQCMayo/MAYO-M4/tree/nibbling-mayo) of this repository.
3+
The code in this repository implements the Round-2 version of the MAYO specification.
4+
It is based on the nibble-sliced implementation as described in the paper **Nibbling MAYO: Optimized Implementations for AVX2 and Cortex-M4** available [here](https://eprint.iacr.org/2023/1683.pdf), but with adapted parameters.
95

106
This repository is based on [pqm4](https://github.com/mupq/pqm4) and you will find the usual `test.py`, `testvectors.py`, and `benchmarks.py` scripts.
117
Please follow the installation steps in pqm4.
@@ -16,7 +12,7 @@ git clone --recurse-submodules https://github.com/PQCMayo/MAYO-M4.git
1612
cd MAYO-M4
1713
```
1814

19-
## Running tests and benchmarks for round-1 MAYO
15+
## Running tests and benchmarks
2016
```
2117
# run tests using qemu
2218
./test.py -p mps2-an386 mayo1 mayo2 mayo3
@@ -32,23 +28,3 @@ cd MAYO-M4
3228
# print benchmarks
3329
./convert_benchmarks.py md
3430
```
35-
36-
## Running tests and benchmarks for nibble-sliced MAYO
37-
```
38-
# switch to nibbling-mayo branch including dependencies
39-
git checkout nibbling-mayo --recurse-submodules
40-
41-
# run tests using qemu
42-
./test.py -p mps2-an386 mayo1 mayo2 mayo3
43-
# run testvectors using qemu
44-
./testvectors.py -p mps2-an386 mayo1 mayo2 mayo3
45-
46-
# run tests on the board
47-
./test.py -p nucleo-l4r5zi -u /dev/ttyACM0 mayo1 mayo2 mayo3
48-
# run testvectors on the board
49-
./testvectors.py -p nucleo-l4r5zi -u /dev/ttyACM0 mayo1 mayo2 mayo3
50-
# run benchmarks on the board
51-
./benchmarks.py -p nucleo-l4r5zi -u /dev/ttyACM0 mayo1 mayo2 mayo3 -i 10
52-
# print benchmarks
53-
./convert_benchmarks.py md
54-
```

0 commit comments

Comments
 (0)