Dev1linux

.github/workflows/test-ref.yml

@@ -0,0 +1,29 @@
+name: Tests for Dilithium ref implementation
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        level: [2, 3, 5]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run make
+        run: |
+          make -C ref clean
+          make -C ref nistkat
+      - name: Copy req file
+        run: |
+          cp Dilithium_KAT/Dilithium${{ matrix.level }}/PQCsignKAT_Dilithium${{ matrix.level }}.req ref/
+      - name: Run PQCgenKAT_sign
+        run: |
+          cd ref
+          chmod +x ./nistkat/PQCgenKAT_sign${{ matrix.level }}
+          ./nistkat/PQCgenKAT_sign${{ matrix.level }}
+      - name: Verify KAT output
+        run: |
+          diff ref/PQCsignKAT_Dilithium${{ matrix.level }}.rsp Dilithium_KAT/Dilithium${{ matrix.level }}/PQCsignKAT_Dilithium${{ matrix.level }}.rsp

.gitignore

@@ -1,9 +1,3 @@
-PQCsignKAT_Dilithium2.req
-PQCsignKAT_Dilithium2.rsp
-PQCsignKAT_Dilithium3.req
-PQCsignKAT_Dilithium3.rsp
-PQCsignKAT_Dilithium5.req
-PQCsignKAT_Dilithium5.rsp
 tvecs2
 tvecs3
-tvecs5
+tvecs5

CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.html).
+
+### Summary
+This version introduces modifications to the `ref` implementation for performance analysis and benchmarking purposes. The core cryptographic logic of the original Dilithium algorithm remains unchanged. All modifications are confined to the `ref` directory and supplementary testing scripts.
+
+### Added
+- **Performance Benchmarking Framework:**
+  - Introduced a `timing_info_t` struct in `ref/sign.h` to capture execution time for key generation, signing, and verification steps.
+  - Integrated `clock_gettime` with `CLOCK_MONOTONIC` in `ref/sign.c` to precisely measure the duration of `crypto_sign_keypair`, `crypto_sign_signature`, and `crypto_sign_verify`. This required adding `#include <time.h>` and defining `_POSIX_C_SOURCE`.
+  - Added `print_timing_info()` function to display aggregated timing results.
+- **Automated Testing Support:**
+  - Added `run_test` function prototype in `ref/sign.h` to facilitate running tests multiple times for stable performance metrics.
+- **Sample Input File:**
+  - Added `ref/test/input.txt` to provide a consistent sample input for testing and debugging.
+
+### Changed
+- **Disabled Debug Outputs:**
+  - The extensive `printf` statements previously used for tracing the algorithm's flow in `ref/sign.c` have been disabled to allow for clean performance measurement. The original version with these outputs is preserved in `sign.c.old` for reference.
+  - The temporary debug feature in `ref/test/test_dilithium.c` that wrote detailed outputs to `output.txt` has also been disabled. The test now only reads from `input.txt`.
+- **Code Formatting:**
+  - Applied consistent code formatting (e.g., spacing, newlines) across multiple files in the `ref` directory to improve readability.
+- **Makefile Adjustments:**
+  - Modified `ref/Makefile` to disable the compilation of `test_vectors` targets, streamlining the build process for performance testing.
+
+### Removed
+- (No features removed from the core implementation)
+
+### Acknowledgements
+This project is a fork of the official [pq-crystals/dilithium](https://github.com/pq-crystals/dilithium) repository. The modifications, available at [quannguyen247/dilithium-dev](https://github.com/quannguyen247/dilithium-dev), are focused on performance analysis and benchmarking. The core cryptographic logic of the original public domain implementation of CRYSTALS-Dilithium remains unchanged.

LICENSE

@@ -1,5 +1,5 @@
 Public Domain (https://creativecommons.org/share-your-work/public-domain/cc0/);
-or Apache 2.0 License (https://www.apache.org/licenses/LICENSE-2.0.html).
+or Apache 2.0 License (https://www.apache.org/licenses/LICENSE-2.0.html) or GPL 2.0 License (http://www.gnu.org/licenses/gpl-2.0.html).
 
 For Keccak and the random number generator 
 we are using public-domain code from sources 

README.md

@@ -1,3 +1,18 @@
+# Custom Dilithium Implementation for PQC Research & Benchmarking
+
+This repository is a fork of the official [Dilithium](https://github.com/pq-crystals/dilithium) implementation, customized by **quannguyen247** for the purpose of experimenting with, modifying, and benchmarking Post-Quantum Cryptography (PQC) algorithms.
+
+## Purpose
+The primary goal of this fork is to provide a flexible framework for research and detailed performance analysis. Key objectives include:
+- **Algorithmic Experimentation:** Facilitating modifications to core components such as hash functions and matrix operations to study their impact on security and efficiency.
+- **Comparative Analysis:** Enabling side-by-side performance comparisons of different implementation strategies and optimizations.
+- **Performance Metrics:** Precise execution time measurement for key generation, signing, and verification.
+
+## Key Modifications
+Significant changes have been made to the `ref` implementation to support these goals. For a detailed list of all modifications, please refer to the [CHANGELOG.md](CHANGELOG.md) file.
+
+---
+
 # Dilithium
 
 [![Build Status](https://travis-ci.org/pq-crystals/dilithium.svg?branch=master)](https://travis-ci.org/pq-crystals/dilithium) [![Coverage Status](https://coveralls.io/repos/github/pq-crystals/dilithium/badge.svg?branch=master)](https://coveralls.io/github/pq-crystals/dilithium?branch=master)

ref/.gitignore

@@ -1,2 +1,12 @@
 *.so
 *.o
+test/test_vectors*
+test/test_dilithium*
+test/test_speed*
+test/test_mul
+test/output.txt
+nistkat/*.req
+nistkat/*.rsp
+nistkat/PQCgenKAT_sign2
+nistkat/PQCgenKAT_sign3
+nistkat/PQCgenKAT_sign5

ref/Makefile

@@ -1,6 +1,7 @@
-CC ?= /usr/bin/cc
+CC = gcc
 CFLAGS += -Wall -Wextra -Wpedantic -Wmissing-prototypes -Wredundant-decls \
-  -Wshadow -Wvla -Wpointer-arith -O3 -fomit-frame-pointer
+  -Wshadow -Wvla -Wpointer-arith -O3 -fomit-frame-pointer \
+  -z noexecstack
 NISTFLAGS += -Wno-unused-result -O3 -fomit-frame-pointer
 SOURCES = sign.c packing.c polyvec.c poly.c ntt.c reduce.c rounding.c
 HEADERS = config.h params.h api.h sign.h packing.h polyvec.h poly.h ntt.h \
@@ -14,9 +15,9 @@ all: \
   test/test_dilithium2 \
   test/test_dilithium3 \
   test/test_dilithium5 \
-  test/test_vectors2 \
-  test/test_vectors3 \
-  test/test_vectors5
+  #test/test_vectors2 \
+  #test/test_vectors3 \
+  #test/test_vectors5
 
 nistkat: \
   nistkat/PQCgenKAT_sign2 \
@@ -136,4 +137,4 @@ clean:
 	rm -f test/test_mul
 	rm -f nistkat/PQCgenKAT_sign2
 	rm -f nistkat/PQCgenKAT_sign3
-	rm -f nistkat/PQCgenKAT_sign5
+	rm -f nistkat/PQCgenKAT_sign5