Skip to content

Commit

Permalink
Merge pull request #25 from itzmeanjan/bump-sha3-to-latest
Browse files Browse the repository at this point in the history 
Bump `sha3` to latest commit
  • Loading branch information
@itzmeanjan
itzmeanjan authored Jan 22, 2024
2 parents a5577f4 + f303be1 commit a7d5520
Show file tree
Hide file tree
Showing 6 changed files with 124 additions and 50 deletions.
7 changes: 1 addition & 6 deletions .github/workflows/test_ci.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,7 @@ jobs:
os: [ubuntu-latest, macos-latest]

steps:
- uses: actions/checkout@v3
# From https://github.com/marketplace/actions/actions-setup-cmake
- name: Setup CMake
uses: jwlawson/[email protected]
with:
cmake-version: 'latest'
- uses: actions/checkout@v4
- name: Setup Google-Test
run: |
pushd ~
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[submodule "sha3"]
path = sha3
url = https://github.com/itzmeanjan/sha3.git
[submodule "gtest-parallel"]
path = gtest-parallel
url = https://github.com/google/gtest-parallel.git
16 changes: 10 additions & 6 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ TEST_LINK_FLAGS = -lgtest -lgtest_main
TEST_BINARY = $(BUILD_DIR)/test.out
ASAN_TEST_BINARY = $(ASAN_BUILD_DIR)/test.out
UBSAN_TEST_BINARY = $(UBSAN_BUILD_DIR)/test.out
GTEST_PARALLEL = ./gtest-parallel/gtest-parallel

BENCHMARK_DIR = benchmarks
BENCHMARK_SOURCES := $(wildcard $(BENCHMARK_DIR)/*.cpp)
Expand All @@ -49,6 +50,9 @@ $(BUILD_DIR):
$(SHA3_INC_DIR):
git submodule update --init

$(GTEST_PARALLEL): $(SHA3_INC_DIR)
git submodule update --init

$(BUILD_DIR)/%.o: $(TEST_DIR)/%.cpp $(BUILD_DIR) $(SHA3_INC_DIR)
$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(I_FLAGS) $(DEP_IFLAGS) -c $< -o $@

Expand All @@ -67,14 +71,14 @@ $(ASAN_TEST_BINARY): $(ASAN_TEST_OBJECTS)
$(UBSAN_TEST_BINARY): $(UBSAN_TEST_OBJECTS)
$(CXX) $(UBSAN_FLAGS) $^ $(TEST_LINK_FLAGS) -o $@

test: $(TEST_BINARY)
./$< --gtest_shuffle --gtest_random_seed=0
test: $(TEST_BINARY) $(GTEST_PARALLEL)
$(GTEST_PARALLEL) $< --print_test_times

asan_test: $(ASAN_TEST_BINARY)
./$< --gtest_shuffle --gtest_random_seed=0
asan_test: $(ASAN_TEST_BINARY) $(GTEST_PARALLEL)
$(GTEST_PARALLEL) $< --print_test_times

ubsan_test: $(UBSAN_TEST_BINARY)
./$< --gtest_shuffle --gtest_random_seed=0
ubsan_test: $(UBSAN_TEST_BINARY) $(GTEST_PARALLEL)
$(GTEST_PARALLEL) $< --print_test_times

$(BUILD_DIR)/%.o: $(BENCHMARK_DIR)/%.cpp $(BUILD_DIR) $(SHA3_INC_DIR)
$(CXX) $(CXX_FLAGS) $(WARN_FLAGS) $(OPT_FLAGS) $(I_FLAGS) $(DEP_IFLAGS) -c $< -o $@
Expand Down
145 changes: 108 additions & 37 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,41 +72,21 @@ make ubsan_test -j # Run tests with UndefinedBehaviourSanitizer enabled
```

```bash
Note: Randomizing tests' orders with a seed of 75840 .
[==========] Running 13 tests from 1 test suite.
[----------] Global test environment set-up.
[----------] 13 tests from Dilithium
[ RUN ] Dilithium.HashingToABall
[ OK ] Dilithium.HashingToABall (0 ms)
[ RUN ] Dilithium.Dilithium5KeygenSignVerifyFlow
[ OK ] Dilithium.Dilithium5KeygenSignVerifyFlow (55 ms)
[ RUN ] Dilithium.HintBitPolynomialEncodingDecoding
[ OK ] Dilithium.HintBitPolynomialEncodingDecoding (0 ms)
[ RUN ] Dilithium.Dilithium3KeygenSignVerifyFlow
[ OK ] Dilithium.Dilithium3KeygenSignVerifyFlow (34 ms)
[ RUN ] Dilithium.MakingAndUsingOfHintBits
[ OK ] Dilithium.MakingAndUsingOfHintBits (10 ms)
[ RUN ] Dilithium.Dilithium2KnownAnswerTests
[ OK ] Dilithium.Dilithium2KnownAnswerTests (57 ms)
[ RUN ] Dilithium.NumberTheoreticTransform
[ OK ] Dilithium.NumberTheoreticTransform (0 ms)
[ RUN ] Dilithium.Dilithium3KnownAnswerTests
[ OK ] Dilithium.Dilithium3KnownAnswerTests (81 ms)
[ RUN ] Dilithium.Dilithium2KeygenSignVerifyFlow
[ OK ] Dilithium.Dilithium2KeygenSignVerifyFlow (23 ms)
[ RUN ] Dilithium.Power2Round
[ OK ] Dilithium.Power2Round (2 ms)
[ RUN ] Dilithium.Dilithium5KnownAnswerTests
[ OK ] Dilithium.Dilithium5KnownAnswerTests (122 ms)
[ RUN ] Dilithium.ArithmeticOverZq
[ OK ] Dilithium.ArithmeticOverZq (356 ms)
[ RUN ] Dilithium.PolynomialEncodingDecoding
[ OK ] Dilithium.PolynomialEncodingDecoding (0 ms)
[----------] 13 tests from Dilithium (743 ms total)
[----------] Global test environment tear-down
[==========] 13 tests from 1 test suite ran. (743 ms total)
[ PASSED ] 13 tests.
[13/13] Dilithium.ArithmeticOverZq (365 ms)
PASSED TESTS (13/13):
1 ms: build/test.out Dilithium.HintBitPolynomialEncodingDecoding
1 ms: build/test.out Dilithium.PolynomialEncodingDecoding
1 ms: build/test.out Dilithium.HashingToABall
1 ms: build/test.out Dilithium.NumberTheoreticTransform
6 ms: build/test.out Dilithium.Power2Round
16 ms: build/test.out Dilithium.MakingAndUsingOfHintBits
54 ms: build/test.out Dilithium.Dilithium3KeygenSignVerifyFlow
54 ms: build/test.out Dilithium.Dilithium2KeygenSignVerifyFlow
92 ms: build/test.out Dilithium.Dilithium3KnownAnswerTests
93 ms: build/test.out Dilithium.Dilithium5KeygenSignVerifyFlow
112 ms: build/test.out Dilithium.Dilithium2KnownAnswerTests
149 ms: build/test.out Dilithium.Dilithium5KnownAnswerTests
365 ms: build/test.out Dilithium.ArithmeticOverZq
```

## Benchmarking
Expand All @@ -133,7 +113,14 @@ make perf -j # If you have built google-benchmark library with libPFM supp
> [!NOTE]
> `make perf` - was issued when collecting following benchmarks. Notice, *cycles* column, denoting cost of executing Dilithium signature scheme routines in terms of CPU cycles. Follow [this](https://github.com/google/benchmark/blob/main/docs/perf_counters.md) for more details.
### On 12th Gen Intel(R) Core(TM) i7-1260P **[ Compiled with GCC-13.2.0 ]**
### On 12th Gen Intel(R) Core(TM) i7-1260P

Compiled with **gcc version 13.2.0 (Ubuntu 13.2.0-4ubuntu3)**.

```bash
$ uname -srm
Linux 6.5.0-14-generic x86_64
```

```bash
2023-12-24T13:05:17+04:00
Expand Down Expand Up @@ -204,7 +191,14 @@ dilithium5_verify/32_min 167 us 167 us 32 778.381
dilithium5_verify/32_max 182 us 182 us 32 782.668k 6.00273k/s
```

### On ARM Cortex-A72 i.e. Raspberry Pi 4B ( compiled with GCC-13.2.0 )
### On ARM Cortex-A72 i.e. Raspberry Pi 4B

Compiled with **gcc version 13.2.0 (Ubuntu 13.2.0-4ubuntu3)**.

```bash
$ uname -srm
Linux 6.5.0-1008-raspi aarch64
```

```bash
2023-12-24T15:13:38+05:30
Expand Down Expand Up @@ -274,6 +268,83 @@ dilithium2_sign/32_min 782 us 782 us 32 1.40548
dilithium2_sign/32_max 9114 us 9111 us 32 16.3662M 1.27835k/s
```

### On Apple M1 Max

Compiled with **Apple clang version 15.0.0 (clang-1500.1.0.2.5)**.

```bash
$ uname -srm
Darwin 23.2.0 arm64
```

```bash
2024-01-22T19:57:30+04:00
Running ./build/bench.out
Run on (10 X 24 MHz CPU s)
CPU Caches:
L1 Data 64 KiB
L1 Instruction 128 KiB
L2 Unified 4096 KiB (x10)
Load Average: 1.61, 1.96, 2.34
---------------------------------------------------------------------------------------
Benchmark Time CPU Iterations items_per_second
---------------------------------------------------------------------------------------
dilithium5_verify/32_mean 182 us 182 us 32 5.48988k/s
dilithium5_verify/32_median 182 us 182 us 32 5.49471k/s
dilithium5_verify/32_stddev 0.790 us 0.792 us 32 23.356/s
dilithium5_verify/32_cv 0.43 % 0.43 % 32 0.43%
dilithium5_verify/32_min 182 us 182 us 32 5.36387k/s
dilithium5_verify/32_max 187 us 186 us 32 5.5007k/s
dilithium3_keygen_mean 103 us 102 us 32 9.75627k/s
dilithium3_keygen_median 103 us 103 us 32 9.75592k/s
dilithium3_keygen_stddev 0.113 us 0.113 us 32 10.7959/s
dilithium3_keygen_cv 0.11 % 0.11 % 32 0.11%
dilithium3_keygen_min 102 us 102 us 32 9.72649k/s
dilithium3_keygen_max 103 us 103 us 32 9.77192k/s
dilithium2_sign/32_mean 389 us 388 us 32 3.60304k/s
dilithium2_sign/32_median 308 us 308 us 32 3.28064k/s
dilithium2_sign/32_stddev 224 us 224 us 32 2.13469k/s
dilithium2_sign/32_cv 57.71 % 57.71 % 32 59.25%
dilithium2_sign/32_min 125 us 125 us 32 1.10009k/s
dilithium2_sign/32_max 910 us 909 us 32 7.99269k/s
dilithium3_verify/32_mean 113 us 112 us 32 8.89718k/s
dilithium3_verify/32_median 113 us 112 us 32 8.8974k/s
dilithium3_verify/32_stddev 0.062 us 0.044 us 32 3.48072/s
dilithium3_verify/32_cv 0.06 % 0.04 % 32 0.04%
dilithium3_verify/32_min 112 us 112 us 32 8.89127k/s
dilithium3_verify/32_max 113 us 112 us 32 8.90303k/s
dilithium2_verify/32_mean 69.5 us 69.4 us 32 14.4038k/s
dilithium2_verify/32_median 69.5 us 69.4 us 32 14.4049k/s
dilithium2_verify/32_stddev 0.055 us 0.026 us 32 5.49004/s
dilithium2_verify/32_cv 0.08 % 0.04 % 32 0.04%
dilithium2_verify/32_min 69.4 us 69.4 us 32 14.3902k/s
dilithium2_verify/32_max 69.7 us 69.5 us 32 14.4125k/s
dilithium2_keygen_mean 60.7 us 60.6 us 32 16.4974k/s
dilithium2_keygen_median 60.7 us 60.6 us 32 16.5101k/s
dilithium2_keygen_stddev 0.489 us 0.482 us 32 130.751/s
dilithium2_keygen_cv 0.81 % 0.80 % 32 0.79%
dilithium2_keygen_min 59.8 us 59.8 us 32 16.1638k/s
dilithium2_keygen_max 61.9 us 61.9 us 32 16.7339k/s
dilithium5_sign/32_mean 786 us 785 us 32 1.79488k/s
dilithium5_sign/32_median 574 us 573 us 32 1.74461k/s
dilithium5_sign/32_stddev 560 us 559 us 32 943.588/s
dilithium5_sign/32_cv 71.24 % 71.24 % 32 52.57%
dilithium5_sign/32_min 287 us 287 us 32 368.016/s
dilithium5_sign/32_max 2721 us 2717 us 32 3.48385k/s
dilithium3_sign/32_mean 498 us 497 us 32 3.06659k/s
dilithium3_sign/32_median 393 us 392 us 32 2.5494k/s
dilithium3_sign/32_stddev 366 us 365 us 32 1.76289k/s
dilithium3_sign/32_cv 73.44 % 73.44 % 32 57.49%
dilithium3_sign/32_min 190 us 189 us 32 621.66/s
dilithium3_sign/32_max 1611 us 1609 us 32 5.27815k/s
dilithium5_keygen_mean 168 us 167 us 32 5.97094k/s
dilithium5_keygen_median 168 us 168 us 32 5.96961k/s
dilithium5_keygen_stddev 0.495 us 0.469 us 32 16.7342/s
dilithium5_keygen_cv 0.30 % 0.28 % 32 0.28%
dilithium5_keygen_min 167 us 166 us 32 5.94183k/s
dilithium5_keygen_max 169 us 168 us 32 6.01249k/s
```

## Usage

Dilithium is a header-only C++ library which is fairly easy-to-use. Let's see how to get started using it.
Expand Down
1 change: 1 addition & 0 deletions gtest-parallel
Submodule gtest-parallel added at 96f4f9
2 changes: 1 addition & 1 deletion sha3
Submodule sha3 updated 11 files
+225 −0 .clang-format
+9 −9 .github/workflows/test_ci.yml
+3 −0 .gitmodules
+44 −11 Makefile
+630 −186 README.md
+12 −0 benchmarks/bench_common.hpp
+13 −25 benchmarks/bench_hashing.cpp
+5 −6 benchmarks/bench_keccak.cpp
+7 −13 benchmarks/bench_xof.cpp
+1 −0 gtest-parallel
+488 −35 include/keccak.hpp

0 comments on commit a7d5520

Please sign in to comment.