From d4caf38e964cd50e0cf66a2bebe051397b0cc600 Mon Sep 17 00:00:00 2001 From: Domenico Cacace Date: Sat, 15 May 2021 12:43:24 +0200 Subject: [PATCH] Unify the three levels Merge the files from the three distinct versions (128, 189 and 256) into a single project with a parameter to choose the security level via CMake (tbd) --- hqc-128/src/LICENSE => LICENSE | 0 {hqc-128/doc => doc}/biblio.bib | 0 {hqc-128/doc => doc}/main_page.txt | 0 hqc-128/doxygen.conf => doxygen.conf | 0 hqc-128/Makefile | 71 - hqc-128/src/api.h | 23 - hqc-128/src/gf2x.c | 167 -- hqc-128/src/gf2x.h | 14 - hqc-128/src/kem.c | 169 --- hqc-128/src/parameters.h | 99 -- hqc-128/src/reed_solomon.c | 451 ------ hqc-192/Makefile | 71 - hqc-192/doc/biblio.bib | 57 - hqc-192/doc/main_page.txt | 91 -- hqc-192/doxygen.conf | 1924 ------------------------ hqc-192/lib/fips202/fips202.c | 807 ---------- hqc-192/lib/fips202/fips202.h | 90 -- hqc-192/lib/hash/hash.c | 13 - hqc-192/lib/hash/hash.h | 14 - hqc-192/lib/rng/rng.c | 222 --- hqc-192/lib/rng/rng.h | 55 - hqc-192/src/LICENSE | 1 - hqc-192/src/api.h | 23 - hqc-192/src/code.c | 58 - hqc-192/src/code.h | 16 - hqc-192/src/fft.c | 331 ---- hqc-192/src/fft.h | 16 - hqc-192/src/gf.c | 116 -- hqc-192/src/gf.h | 38 - hqc-192/src/gf2x.h | 14 - hqc-192/src/hqc.c | 174 --- hqc-192/src/hqc.h | 15 - hqc-192/src/kem.c | 169 --- hqc-192/src/main_hqc.c | 40 - hqc-192/src/main_kat.c | 221 --- hqc-192/src/parameters.h | 99 -- hqc-192/src/parsing.c | 120 -- hqc-192/src/parsing.h | 20 - hqc-192/src/reed_muller.c | 254 ---- hqc-192/src/reed_muller.h | 16 - hqc-192/src/reed_solomon.c | 451 ------ hqc-192/src/reed_solomon.h | 18 - hqc-192/src/vector.c | 278 ---- hqc-192/src/vector.h | 24 - hqc-256/Makefile | 71 - hqc-256/doc/biblio.bib | 57 - hqc-256/doc/main_page.txt | 91 -- hqc-256/doxygen.conf | 1924 ------------------------ hqc-256/lib/fips202/fips202.c | 807 ---------- hqc-256/lib/fips202/fips202.h | 90 -- hqc-256/lib/hash/hash.c | 13 - hqc-256/lib/hash/hash.h | 14 - hqc-256/lib/rng/rng.c | 222 --- hqc-256/lib/rng/rng.h | 55 - hqc-256/src/LICENSE | 1 - hqc-256/src/code.c | 58 - hqc-256/src/code.h | 16 - hqc-256/src/fft.c | 331 ---- hqc-256/src/fft.h | 16 - hqc-256/src/gf.c | 116 -- hqc-256/src/gf.h | 38 - hqc-256/src/gf2x.c | 167 -- hqc-256/src/hqc.c | 174 --- hqc-256/src/hqc.h | 15 - hqc-256/src/main_hqc.c | 40 - hqc-256/src/main_kat.c | 221 --- hqc-256/src/parsing.c | 120 -- hqc-256/src/parsing.h | 20 - hqc-256/src/reed_muller.c | 254 ---- hqc-256/src/reed_muller.h | 16 - hqc-256/src/reed_solomon.h | 18 - hqc-256/src/vector.c | 278 ---- hqc-256/src/vector.h | 24 - {hqc-128/lib => lib}/fips202/fips202.c | 0 {hqc-128/lib => lib}/fips202/fips202.h | 0 {hqc-128/lib => lib}/hash/hash.c | 0 {hqc-128/lib => lib}/hash/hash.h | 0 {hqc-128/lib => lib}/rng/rng.c | 0 {hqc-128/lib => lib}/rng/rng.h | 0 {hqc-256/src => src}/api.h | 23 +- {hqc-128/src => src}/code.c | 0 {hqc-128/src => src}/code.h | 0 {hqc-128/src => src}/fft.c | 0 {hqc-128/src => src}/fft.h | 0 {hqc-128/src => src}/gf.c | 0 {hqc-128/src => src}/gf.h | 0 {hqc-192/src => src}/gf2x.c | 2 +- {hqc-256/src => src}/gf2x.h | 2 +- {hqc-128/src => src}/hqc.c | 2 +- {hqc-128/src => src}/hqc.h | 0 {hqc-256/src => src}/kem.c | 6 +- {hqc-128/src => src}/main_hqc.c | 0 {hqc-128/src => src}/main_kat.c | 0 {hqc-256/src => src}/parameters.h | 92 ++ {hqc-128/src => src}/parsing.c | 2 +- {hqc-128/src => src}/parsing.h | 0 {hqc-128/src => src}/reed_muller.c | 0 {hqc-128/src => src}/reed_muller.h | 0 {hqc-256/src => src}/reed_solomon.c | 11 + {hqc-128/src => src}/reed_solomon.h | 0 {hqc-128/src => src}/vector.c | 2 +- {hqc-128/src => src}/vector.h | 2 +- 102 files changed, 134 insertions(+), 12127 deletions(-) rename hqc-128/src/LICENSE => LICENSE (100%) rename {hqc-128/doc => doc}/biblio.bib (100%) rename {hqc-128/doc => doc}/main_page.txt (100%) rename hqc-128/doxygen.conf => doxygen.conf (100%) delete mode 100644 hqc-128/Makefile delete mode 100644 hqc-128/src/api.h delete mode 100644 hqc-128/src/gf2x.c delete mode 100644 hqc-128/src/gf2x.h delete mode 100644 hqc-128/src/kem.c delete mode 100644 hqc-128/src/parameters.h delete mode 100644 hqc-128/src/reed_solomon.c delete mode 100644 hqc-192/Makefile delete mode 100644 hqc-192/doc/biblio.bib delete mode 100644 hqc-192/doc/main_page.txt delete mode 100644 hqc-192/doxygen.conf delete mode 100644 hqc-192/lib/fips202/fips202.c delete mode 100644 hqc-192/lib/fips202/fips202.h delete mode 100644 hqc-192/lib/hash/hash.c delete mode 100644 hqc-192/lib/hash/hash.h delete mode 100644 hqc-192/lib/rng/rng.c delete mode 100644 hqc-192/lib/rng/rng.h delete mode 100644 hqc-192/src/LICENSE delete mode 100644 hqc-192/src/api.h delete mode 100644 hqc-192/src/code.c delete mode 100644 hqc-192/src/code.h delete mode 100644 hqc-192/src/fft.c delete mode 100644 hqc-192/src/fft.h delete mode 100644 hqc-192/src/gf.c delete mode 100644 hqc-192/src/gf.h delete mode 100644 hqc-192/src/gf2x.h delete mode 100644 hqc-192/src/hqc.c delete mode 100644 hqc-192/src/hqc.h delete mode 100644 hqc-192/src/kem.c delete mode 100644 hqc-192/src/main_hqc.c delete mode 100644 hqc-192/src/main_kat.c delete mode 100644 hqc-192/src/parameters.h delete mode 100644 hqc-192/src/parsing.c delete mode 100644 hqc-192/src/parsing.h delete mode 100644 hqc-192/src/reed_muller.c delete mode 100644 hqc-192/src/reed_muller.h delete mode 100644 hqc-192/src/reed_solomon.c delete mode 100644 hqc-192/src/reed_solomon.h delete mode 100644 hqc-192/src/vector.c delete mode 100644 hqc-192/src/vector.h delete mode 100644 hqc-256/Makefile delete mode 100644 hqc-256/doc/biblio.bib delete mode 100644 hqc-256/doc/main_page.txt delete mode 100644 hqc-256/doxygen.conf delete mode 100644 hqc-256/lib/fips202/fips202.c delete mode 100644 hqc-256/lib/fips202/fips202.h delete mode 100644 hqc-256/lib/hash/hash.c delete mode 100644 hqc-256/lib/hash/hash.h delete mode 100644 hqc-256/lib/rng/rng.c delete mode 100644 hqc-256/lib/rng/rng.h delete mode 100644 hqc-256/src/LICENSE delete mode 100644 hqc-256/src/code.c delete mode 100644 hqc-256/src/code.h delete mode 100644 hqc-256/src/fft.c delete mode 100644 hqc-256/src/fft.h delete mode 100644 hqc-256/src/gf.c delete mode 100644 hqc-256/src/gf.h delete mode 100644 hqc-256/src/gf2x.c delete mode 100644 hqc-256/src/hqc.c delete mode 100644 hqc-256/src/hqc.h delete mode 100644 hqc-256/src/main_hqc.c delete mode 100644 hqc-256/src/main_kat.c delete mode 100644 hqc-256/src/parsing.c delete mode 100644 hqc-256/src/parsing.h delete mode 100644 hqc-256/src/reed_muller.c delete mode 100644 hqc-256/src/reed_muller.h delete mode 100644 hqc-256/src/reed_solomon.h delete mode 100644 hqc-256/src/vector.c delete mode 100644 hqc-256/src/vector.h rename {hqc-128/lib => lib}/fips202/fips202.c (100%) rename {hqc-128/lib => lib}/fips202/fips202.h (100%) rename {hqc-128/lib => lib}/hash/hash.c (100%) rename {hqc-128/lib => lib}/hash/hash.h (100%) rename {hqc-128/lib => lib}/rng/rng.c (100%) rename {hqc-128/lib => lib}/rng/rng.h (100%) rename {hqc-256/src => src}/api.h (55%) rename {hqc-128/src => src}/code.c (100%) rename {hqc-128/src => src}/code.h (100%) rename {hqc-128/src => src}/fft.c (100%) rename {hqc-128/src => src}/fft.h (100%) rename {hqc-128/src => src}/gf.c (100%) rename {hqc-128/src => src}/gf.h (100%) rename {hqc-192/src => src}/gf2x.c (99%) rename {hqc-256/src => src}/gf2x.h (89%) rename {hqc-128/src => src}/hqc.c (99%) rename {hqc-128/src => src}/hqc.h (100%) rename {hqc-256/src => src}/kem.c (98%) rename {hqc-128/src => src}/main_hqc.c (100%) rename {hqc-128/src => src}/main_kat.c (100%) rename {hqc-256/src => src}/parameters.h (60%) rename {hqc-128/src => src}/parsing.c (99%) rename {hqc-128/src => src}/parsing.h (100%) rename {hqc-128/src => src}/reed_muller.c (100%) rename {hqc-128/src => src}/reed_muller.h (100%) rename {hqc-256/src => src}/reed_solomon.c (72%) rename {hqc-128/src => src}/reed_solomon.h (100%) rename {hqc-128/src => src}/vector.c (99%) rename {hqc-128/src => src}/vector.h (96%) diff --git a/hqc-128/src/LICENSE b/LICENSE similarity index 100% rename from hqc-128/src/LICENSE rename to LICENSE diff --git a/hqc-128/doc/biblio.bib b/doc/biblio.bib similarity index 100% rename from hqc-128/doc/biblio.bib rename to doc/biblio.bib diff --git a/hqc-128/doc/main_page.txt b/doc/main_page.txt similarity index 100% rename from hqc-128/doc/main_page.txt rename to doc/main_page.txt diff --git a/hqc-128/doxygen.conf b/doxygen.conf similarity index 100% rename from hqc-128/doxygen.conf rename to doxygen.conf diff --git a/hqc-128/Makefile b/hqc-128/Makefile deleted file mode 100644 index f2d7aff..0000000 --- a/hqc-128/Makefile +++ /dev/null @@ -1,71 +0,0 @@ - -CC:=gcc - -CFLAGS:=-O3 -std=c99 -funroll-all-loops -flto -pedantic -Wall -Wextra - -RNG_FLAGS:=$(CFLAGS) -Wno-unused-but-set-variable -Wno-unused-parameter -Wno-sign-compare - -HASH_SRC:=lib/hash/hash.c -HASH_INCLUDE:=-I lib/hash -lcrypto - -SHA3_SRC:=lib/fips202/fips202.c -SHA3_INCLUDE:=-I lib/fips202 - -RNG_SRC:=lib/rng/rng.c -RNG_INCLUDE:=-I lib/rng - -SRC:=src/ -INCLUDE:=-I src -LIB:=$(HASH_INCLUDE) $(SHA3_INCLUDE) $(RNG_INCLUDE) - -MAIN_HQC:=src/main_hqc.c -MAIN_KAT:=src/main_kat.c - -HQC_OBJS:=vector.o reed_muller.o reed_solomon.o fft.o gf.o gf2x.o code.o parsing.o hqc.o kem.o -HQC_OBJS_VERBOSE:=vector.o reed_muller.o reed_solomon-verbose.o fft.o gf.o gf2x.o code-verbose.o parsing.o hqc-verbose.o kem-verbose.o -LIB_OBJS:= hash.o rng.o fips202.o - -BIN:=bin -BUILD:=bin/build - -folders: - @echo -e "\n### Creating folders\n" - mkdir -p $(BUILD) - -hash.o: folders - @echo -e "\n### Compiling $@ (wrapper around openssl SHA512 implementation)\n" - $(CC) $(CFLAGS) -c $(HASH_SRC) $(HASH_INCLUDE) -o $(BUILD)/$@ - -fips202.o: folders - @echo -e "\n### Compiling fips202\n" - $(CC) $(CFLAGS) -c $(SHA3_SRC) $(SHA3_INCLUDE) -o $(BUILD)/$@ - -rng.o: folders - @echo -e "\n### Compiling NIST rng.o\n" - $(CC) $(RNG_FLAGS) -c $(RNG_SRC) $(RNG_INCLUDE) -o $(BUILD)/$@ - -%.o: $(SRC)/%.c | folders - @echo -e "\n### Compiling $@\n" - $(CC) $(CFLAGS) -c $< $(INCLUDE) $(LIB) -o $(BUILD)/$@ - -%-verbose.o: $(SRC)/%.c | folders - @echo -e "\n### Compiling $@ (verbose mode)\n" - $(CC) $(CFLAGS) -c $< $(INCLUDE) $(LIB) -D VERBOSE -o $(BUILD)/$@ - -hqc-128: $(HQC_OBJS) $(LIB_OBJS) | folders - @echo -e "\n### Compiling hqc-128\n" - $(CC) $(CFLAGS) $(MAIN_HQC) $(addprefix $(BUILD)/, $^) $(INCLUDE) $(LIB) -o $(BIN)/$@ - -hqc-128-kat: $(HQC_OBJS) $(LIB_OBJS) | folders - @echo -e "\n### Compiling hqc-128 KAT\n" - $(CC) $(CFLAGS) $(MAIN_KAT) $(addprefix $(BUILD)/, $^) $(INCLUDE) $(LIB) -o $(BIN)/$@ - -hqc-128-verbose: $(HQC_OBJS_VERBOSE) $(LIB_OBJS) | folders - @echo -e "\n### Compiling hqc-128 (verbose mode)\n" - $(CC) $(CFLAGS) $(MAIN_HQC) $(addprefix $(BUILD)/, $^) $(INCLUDE) $(LIB) -D VERBOSE -o $(BIN)/$@ - - -clean: - rm -f PQCkemKAT_* - rm -f vgcore.* - rm -rf ./bin diff --git a/hqc-128/src/api.h b/hqc-128/src/api.h deleted file mode 100644 index ca0f294..0000000 --- a/hqc-128/src/api.h +++ /dev/null @@ -1,23 +0,0 @@ -/** - * @file api.h - * @brief NIST KEM API used by the HQC_KEM IND-CCA2 scheme - */ - -#ifndef API_H -#define API_H - -#define CRYPTO_ALGNAME "HQC-128" - -#define CRYPTO_SECRETKEYBYTES 2289 -#define CRYPTO_PUBLICKEYBYTES 2249 -#define CRYPTO_BYTES 64 -#define CRYPTO_CIPHERTEXTBYTES 4481 - -// As a technicality, the public key is appended to the secret key in order to respect the NIST API. -// Without this constraint, CRYPTO_SECRETKEYBYTES would be defined as 32 - -int crypto_kem_keypair(unsigned char* pk, unsigned char* sk); -int crypto_kem_enc(unsigned char* ct, unsigned char* ss, const unsigned char* pk); -int crypto_kem_dec(unsigned char* ss, const unsigned char* ct, const unsigned char* sk); - -#endif diff --git a/hqc-128/src/gf2x.c b/hqc-128/src/gf2x.c deleted file mode 100644 index 0a1fcce..0000000 --- a/hqc-128/src/gf2x.c +++ /dev/null @@ -1,167 +0,0 @@ -/** - * \file gf2x.c - * \brief Implementation of multiplication of two polynomials - */ - -#include "gf2x.h" -#include "rng.h" -#include "parameters.h" -#include -#include - -#define TABLE 16 -#define WORD 64 - -static inline void swap(uint16_t * tab, uint16_t elt1, uint16_t elt2); -static inline void reduce(uint64_t *o, uint64_t *a); -static inline void fast_convolution_mult(uint64_t *o, const uint32_t *a1, const uint64_t *a2, const uint16_t weight, AES_XOF_struct *ctx); - -/** - * @brief swap two elements in a table - * - * This function exchanges tab[elt1] with tab[elt2] - * - * @param[in] tab Pointer to the table - * @param[in] elt1 Index of the first element - * @param[in] elt2 Index of the second element - */ -static inline void swap(uint16_t * tab, uint16_t elt1, uint16_t elt2) { - uint16_t tmp = tab[elt1]; - - tab[elt1] = tab[elt2]; - tab[elt2] = tmp; -} - - - -/** - * @brief Compute o(x) = a(x) mod \f$ X^n - 1\f$ - * - * This function computes the modular reduction of the polynomial a(x) - * - * @param[in] a Pointer to the polynomial a(x) - * @param[out] o Pointer to the result - */ -static inline void reduce(uint64_t *o, uint64_t *a) { - uint64_t r; - uint64_t carry = 0; - static const int32_t dec64 = PARAM_N & 0x3f; - static const int32_t i64 = PARAM_N >> 6; - static const int32_t d0 = WORD - dec64; - int32_t i; - - for (i = 0 ; i < i64 + 1 ; i++) { - r = a[i + i64] >> dec64; - carry = a[i + i64 + 1] << d0; - r ^= carry; - o[i] = a[i] ^ r; - } - - o[i - 1] &= RED_MASK; -} - - - -/** - * @brief computes product of the polynomial a1(x) with the sparse polynomial a2 - * - * o(x) = a1(x)a2(x) - * - * @param[out] o Pointer to the result - * @param[in] a1 Pointer to the sparse polynomial a2 (list of degrees of the monomials which appear in a2) - * @param[in] a2 Pointer to the polynomial a1(x) - * @param[in] weight Hamming wifht of the sparse polynomial a2 - * @param[in] ctx Pointer to a seed expander used to randomize the multiplication process - */ -static inline void fast_convolution_mult(uint64_t *o, const uint32_t *a1, const uint64_t *a2, const uint16_t weight, AES_XOF_struct *ctx) { -//static inline int32_t fast_convolution_mult(const uint64_t *A, const uint32_t *vB, uint64_t *C, const uint16_t w, AES_XOF_struct *ctx) - uint64_t carry; - int32_t dec, s; - uint64_t table[TABLE * (VEC_N_SIZE_64 + 1)]; - uint16_t permuted_table[TABLE]; - uint16_t permutation_table[TABLE]; - uint16_t permuted_sparse_vect[PARAM_OMEGA_E]; - uint16_t permutation_sparse_vect[PARAM_OMEGA_E]; - - for (int32_t i = 0 ; i < TABLE ; i++) { - permuted_table[i] = i; - } - - seedexpander(ctx, (uint8_t *) permutation_table, TABLE << 1); - - for (int32_t i = 0 ; i < TABLE - 1 ; i++) { - swap(permuted_table + i, 0, permutation_table[i] % (TABLE - i)); - } - - for (int32_t j = 0 ; j < VEC_N_SIZE_64 << 1 ; j++) { - o[j] = 0UL; - } - - uint64_t *pt = table + (permuted_table[0] * (VEC_N_SIZE_64 + 1)); - - for (int32_t j = 0 ; j < VEC_N_SIZE_64 ; j++) { - pt[j] = a2[j]; - } - - pt[VEC_N_SIZE_64] = 0x0UL; - - for (uint32_t i = 1 ; i < TABLE ; i++) { - carry = 0x0UL; - int32_t idx = permuted_table[i] * (VEC_N_SIZE_64 + 1); - uint64_t *pt = table + idx; - for (int32_t j = 0 ; j < VEC_N_SIZE_64 ; j++) { - pt[j] = (a2[j] << i) ^ carry; - carry = (a2[j] >> ((WORD - i))); - } - - pt[VEC_N_SIZE_64] = carry; - } - - for (int32_t i = 0 ; i < weight ; i++) { - permuted_sparse_vect[i] = i; - } - - seedexpander(ctx, (uint8_t *) permutation_sparse_vect, weight << 1); - - for (int32_t i = 0 ; i < weight - 1 ; i++) { - swap(permuted_sparse_vect + i, 0, permutation_sparse_vect[i] % (weight - i)); - } - - for (int32_t i = 0 ; i < weight ; i++) { - carry = 0x0UL; - dec = a1[permuted_sparse_vect[i]] & 0xf; - s = a1[permuted_sparse_vect[i]] >> 4; - uint16_t *res_16 = (uint16_t *) o; - res_16 += s; - uint64_t *pt = table + (permuted_table[dec] * (VEC_N_SIZE_64 + 1)); - - for (int32_t j = 0 ; j < VEC_N_SIZE_64 + 1 ; j++) { - uint64_t tmp = (uint64_t) res_16[0] | ((uint64_t) (res_16[1])) << 16 | - (uint64_t) (res_16[2]) << 32 | ((uint64_t) (res_16[3])) << 48; - tmp ^= pt[j]; - uint64_t *res_64 = (uint64_t *) res_16; - res_64[0] = tmp; - res_16 += 4; - } - } -} - - - -/** - * @brief Multiply two polynomials modulo \f$ X^n - 1\f$. - * - * This functions multiplies a sparse polynomial a1 (of Hamming weight equal to weight) - * and a dense polynomial a2. The multiplication is done modulo \f$ X^n - 1\f$. - * - * @param[out] o Pointer to the result - * @param[in] a1 Pointer to the sparse polynomial - * @param[in] a2 Pointer to the dense polynomial - * @param[in] weight Integer that is the weigt of the sparse polynomial - * @param[in] ctx Pointer to the randomness context - */ -void vect_mul(uint64_t *o, const uint32_t *a1, const uint64_t *a2, const uint16_t weight, AES_XOF_struct *ctx) { - uint64_t tmp[VEC_N_SIZE_64 << 1]; - fast_convolution_mult(tmp, a1, a2, weight, ctx); - reduce(o, tmp); -} diff --git a/hqc-128/src/gf2x.h b/hqc-128/src/gf2x.h deleted file mode 100644 index 9264d0e..0000000 --- a/hqc-128/src/gf2x.h +++ /dev/null @@ -1,14 +0,0 @@ -#ifndef GF2X_H -#define GF2X_H - -/** - * @file gf2x.h - * @brief Header file for gf2x.c - */ - -#include "rng.h" -#include - -void vect_mul(uint64_t *o, const uint32_t *v1, const uint64_t *v2, const uint16_t weight, AES_XOF_struct *ctx); - -#endif diff --git a/hqc-128/src/kem.c b/hqc-128/src/kem.c deleted file mode 100644 index a8f09a9..0000000 --- a/hqc-128/src/kem.c +++ /dev/null @@ -1,169 +0,0 @@ -/** - * @file kem.c - * @brief Implementation of api.h - */ - -#include "api.h" -#include "hqc.h" -#include "rng.h" -#include "parameters.h" -#include "parsing.h" -#include "hash.h" -#include "fips202.h" -#include "vector.h" -#include -#include -#ifdef VERBOSE -#include -#endif - - -/** - * @brief Keygen of the HQC_KEM IND_CAA2 scheme - * - * The public key is composed of the syndrome s as well as the seed used to generate the vector h. - * - * The secret key is composed of the seed used to generate vectors x and y. - * As a technicality, the public key is appended to the secret key in order to respect NIST API. - * - * @param[out] pk String containing the public key - * @param[out] sk String containing the secret key - * @returns 0 if keygen is successful - */ -int crypto_kem_keypair(unsigned char *pk, unsigned char *sk) { - #ifdef VERBOSE - printf("\n\n\n\n### KEYGEN ###"); - #endif - - hqc_pke_keygen(pk, sk); - return 0; -} - - - -/** - * @brief Encapsulation of the HQC_KEM IND_CAA2 scheme - * - * @param[out] ct String containing the ciphertext - * @param[out] ss String containing the shared secret - * @param[in] pk String containing the public key - * @returns 0 if encapsulation is successful - */ -int crypto_kem_enc(unsigned char *ct, unsigned char *ss, const unsigned char *pk) { - #ifdef VERBOSE - printf("\n\n\n\n### ENCAPS ###"); - #endif - - uint8_t theta[SHA512_BYTES] = {0}; - uint64_t m[VEC_K_SIZE_64] = {0}; - uint64_t u[VEC_N_SIZE_64] = {0}; - uint64_t v[VEC_N1N2_SIZE_64] = {0}; - unsigned char d[SHA512_BYTES] = {0}; - unsigned char mc[VEC_K_SIZE_BYTES + VEC_N_SIZE_BYTES + VEC_N1N2_SIZE_BYTES] = {0}; - - // Computing m - vect_set_random_from_randombytes(m); - - // Computing theta - sha3_512(theta, (uint8_t*) m, VEC_K_SIZE_BYTES); - - // Encrypting m - hqc_pke_encrypt(u, v, m, theta, pk); - - // Computing d - sha512(d, (unsigned char *) m, VEC_K_SIZE_BYTES); - - // Computing shared secret - memcpy(mc, m, VEC_K_SIZE_BYTES); - memcpy(mc + VEC_K_SIZE_BYTES, u, VEC_N_SIZE_BYTES); - memcpy(mc + VEC_K_SIZE_BYTES + VEC_N_SIZE_BYTES, v, VEC_N1N2_SIZE_BYTES); - sha512(ss, mc, VEC_K_SIZE_BYTES + VEC_N_SIZE_BYTES + VEC_N1N2_SIZE_BYTES); - - // Computing ciphertext - hqc_ciphertext_to_string(ct, u, v, d); - - #ifdef VERBOSE - printf("\n\npk: "); for(int i = 0 ; i < PUBLIC_KEY_BYTES ; ++i) printf("%02x", pk[i]); - printf("\n\nm: "); vect_print(m, VEC_K_SIZE_BYTES); - printf("\n\ntheta: "); for(int i = 0 ; i < SHA512_BYTES ; ++i) printf("%02x", theta[i]); - printf("\n\nd: "); for(int i = 0 ; i < SHA512_BYTES ; ++i) printf("%02x", d[i]); - printf("\n\nciphertext: "); for(int i = 0 ; i < CIPHERTEXT_BYTES ; ++i) printf("%02x", ct[i]); - printf("\n\nsecret 1: "); for(int i = 0 ; i < SHARED_SECRET_BYTES ; ++i) printf("%02x", ss[i]); - #endif - - return 0; -} - - - -/** - * @brief Decapsulation of the HQC_KEM IND_CAA2 scheme - * - * @param[out] ss String containing the shared secret - * @param[in] ct String containing the cipĥertext - * @param[in] sk String containing the secret key - * @returns 0 if decapsulation is successful, -1 otherwise - */ -int crypto_kem_dec(unsigned char *ss, const unsigned char *ct, const unsigned char *sk) { - #ifdef VERBOSE - printf("\n\n\n\n### DECAPS ###"); - #endif - - int8_t result = -1; - uint64_t u[VEC_N_SIZE_64] = {0}; - uint64_t v[VEC_N1N2_SIZE_64] = {0}; - unsigned char d[SHA512_BYTES] = {0}; - unsigned char pk[PUBLIC_KEY_BYTES] = {0}; - uint64_t m[VEC_K_SIZE_64] = {0}; - uint8_t theta[SHA512_BYTES] = {0}; - uint64_t u2[VEC_N_SIZE_64] = {0}; - uint64_t v2[VEC_N1N2_SIZE_64] = {0}; - unsigned char d2[SHA512_BYTES] = {0}; - unsigned char mc[VEC_K_SIZE_BYTES + VEC_N_SIZE_BYTES + VEC_N1N2_SIZE_BYTES] = {0}; - - // Retrieving u, v and d from ciphertext - hqc_ciphertext_from_string(u, v , d, ct); - - // Retrieving pk from sk - memcpy(pk, sk + SEED_BYTES, PUBLIC_KEY_BYTES); - - // Decryting - hqc_pke_decrypt(m, u, v, sk); - - // Computing theta - sha3_512(theta, (uint8_t*) m, VEC_K_SIZE_BYTES); - - // Encrypting m' - hqc_pke_encrypt(u2, v2, m, theta, pk); - - // Computing d' - sha512(d2, (unsigned char *) m, VEC_K_SIZE_BYTES); - - // Computing shared secret - memcpy(mc, m, VEC_K_SIZE_BYTES); - memcpy(mc + VEC_K_SIZE_BYTES, u, VEC_N_SIZE_BYTES); - memcpy(mc + VEC_K_SIZE_BYTES + VEC_N_SIZE_BYTES, v, VEC_N1N2_SIZE_BYTES); - sha512(ss, mc, VEC_K_SIZE_BYTES + VEC_N_SIZE_BYTES + VEC_N1N2_SIZE_BYTES); - - // Abort if c != c' or d != d' - result = (vect_compare(u, u2, VEC_N_SIZE_BYTES) == 0 && vect_compare(v, v2, VEC_N1N2_SIZE_BYTES) == 0 && memcmp(d, d2, SHA512_BYTES) == 0); - for (size_t i = 0 ; i < SHARED_SECRET_BYTES ; i++) { - ss[i] = result * ss[i]; - } - result--; - - #ifdef VERBOSE - printf("\n\npk: "); for(int i = 0 ; i < PUBLIC_KEY_BYTES ; ++i) printf("%02x", pk[i]); - printf("\n\nsk: "); for(int i = 0 ; i < SECRET_KEY_BYTES ; ++i) printf("%02x", sk[i]); - printf("\n\nciphertext: "); for(int i = 0 ; i < CIPHERTEXT_BYTES ; ++i) printf("%02x", ct[i]); - printf("\n\nm: "); vect_print(m, VEC_K_SIZE_BYTES); - printf("\n\ntheta: "); for(int i = 0 ; i < SHA512_BYTES ; ++i) printf("%02x", theta[i]); - printf("\n\n\n# Checking Ciphertext- Begin #"); - printf("\n\nu2: "); vect_print(u2, VEC_N_SIZE_BYTES); - printf("\n\nv2: "); vect_print(v2, VEC_N1N2_SIZE_BYTES); - printf("\n\nd2: "); for(int i = 0 ; i < SHA512_BYTES ; ++i) printf("%02x", d2[i]); - printf("\n\n# Checking Ciphertext - End #\n"); - #endif - - return result; -} diff --git a/hqc-128/src/parameters.h b/hqc-128/src/parameters.h deleted file mode 100644 index b2bf06d..0000000 --- a/hqc-128/src/parameters.h +++ /dev/null @@ -1,99 +0,0 @@ -#ifndef HQC_PARAMETERS_H -#define HQC_PARAMETERS_H - -/** - * @file parameters.h - * @brief Parameters of the HQC_KEM IND-CCA2 scheme - */ - -#include "api.h" - -#define CEIL_DIVIDE(a, b) (((a)/(b)) + ((a) % (b) == 0 ? 0 : 1)) /*!< Divide a by b and ceil the result*/ -#define BITMASK(a, size) ((1UL << (a % size)) - 1) /*!< Create a mask*/ - - -/* - #define PARAM_N Define the parameter n of the scheme - #define PARAM_N1 Define the parameter n1 of the scheme (length of Reed-Solomon code) - #define PARAM_N2 Define the parameter n2 of the scheme (length of Duplicated Reed-Muller code) - #define PARAM_N1N2 Define the length in bits of the Concatenated code - #define PARAM_OMEGA Define the parameter omega of the scheme - #define PARAM_OMEGA_E Define the parameter omega_e of the scheme - #define PARAM_OMEGA_R Define the parameter omega_r of the scheme - #define PARAM_SECURITY Define the security level corresponding to the chosen parameters - #define PARAM_DFR_EXP Define the decryption failure rate corresponding to the chosen parameters - - #define SECRET_KEY_BYTES Define the size of the secret key in bytes - #define PUBLIC_KEY_BYTES Define the size of the public key in bytes - #define SHARED_SECRET_BYTES Define the size of the shared secret in bytes - #define CIPHERTEXT_BYTES Define the size of the ciphertext in bytes - - #define UTILS_REJECTION_THRESHOLD Define the rejection threshold used to generate given weight vectors (see vector_set_random_fixed_weight function) - #define VEC_N_SIZE_BYTES Define the size of the array used to store a PARAM_N sized vector in bytes - #define VEC_K_SIZE_BYTES Define the size of the array used to store a PARAM_K sized vector in bytes - #define VEC_N1Y_SIZE_BYTES Define the size of the array used to store a PARAM_N1 sized vector in bytes - #define VEC_N1N2_SIZE_BYTES Define the size of the array used to store a PARAM_N1N2 sized vector in bytes - - #define VEC_N_SIZE_64 Define the size of the array used to store a PARAM_N sized vector in 64 bits - #define VEC_K_SIZE_64 Define the size of the array used to store a PARAM_K sized vector in 64 bits - #define VEC_N1_SIZE_64 Define the size of the array used to store a PARAM_N1 sized vector in 64 bits - #define VEC_N1N2_SIZE_64 Define the size of the array used to store a PARAM_N1N2 sized vector in 64 bits - - #define PARAM_DELTA Define the parameter delta of the scheme (correcting capacity of the Reed-Solomon code) - #define PARAM_M Define a positive integer - #define PARAM_GF_POLY Generator polynomial of galois field GF(2^PARAM_M), represented in hexadecimial form - #define PARAM_GF_MUL_ORDER Define the size of the multiplicative group of GF(2^PARAM_M), i.e 2^PARAM_M -1 - #define PARAM_K Define the size of the information bits of the Reed-Solomon code - #define PARAM_G Define the size of the generator polynomial of Reed-Solomon code - #define PARAM_FFT The additive FFT takes a 2^PARAM_FFT polynomial as input - We use the FFT to compute the roots of sigma, whose degree if PARAM_DELTA=24 - The smallest power of 2 greater than 24+1 is 32=2^5 - #define RS_POLY_COEFS Coefficients of the generator polynomial of the Reed-Solomon code - - #define RED_MASK A mask fot the higher bits of a vector - #define SHA512_BYTES Define the size of SHA512 output in bytes - #define SEED_BYTES Define the size of the seed in bytes - #define SEEDEXPANDER_MAX_LENGTH Define the seed expander max length -*/ - -#define PARAM_N 17669 -#define PARAM_N1 46 -#define PARAM_N2 384 -#define PARAM_N1N2 17664 -#define PARAM_OMEGA 66 -#define PARAM_OMEGA_E 75 -#define PARAM_OMEGA_R 75 -#define PARAM_SECURITY 128 -#define PARAM_DFR_EXP 128 - -#define SECRET_KEY_BYTES CRYPTO_SECRETKEYBYTES -#define PUBLIC_KEY_BYTES CRYPTO_PUBLICKEYBYTES -#define SHARED_SECRET_BYTES CRYPTO_BYTES -#define CIPHERTEXT_BYTES CRYPTO_CIPHERTEXTBYTES - -#define UTILS_REJECTION_THRESHOLD 16767881 -#define VEC_N_SIZE_BYTES CEIL_DIVIDE(PARAM_N, 8) -#define VEC_K_SIZE_BYTES PARAM_K -#define VEC_N1_SIZE_BYTES PARAM_N1 -#define VEC_N1N2_SIZE_BYTES CEIL_DIVIDE(PARAM_N1N2, 8) - -#define VEC_N_SIZE_64 CEIL_DIVIDE(PARAM_N, 64) -#define VEC_K_SIZE_64 CEIL_DIVIDE(PARAM_K, 8) -#define VEC_N1_SIZE_64 CEIL_DIVIDE(PARAM_N1, 8) -#define VEC_N1N2_SIZE_64 CEIL_DIVIDE(PARAM_N1N2, 64) - -#define PARAM_DELTA 15 -#define PARAM_M 8 -#define PARAM_GF_POLY 0x11D -#define PARAM_GF_MUL_ORDER 255 -#define PARAM_K 16 -#define PARAM_G 31 -#define PARAM_FFT 4 -#define RS_POLY_COEFS 89,69,153,116,176,117,111,75,73,233,242,233,65,210,21,139,103,173,67,118,105,210,174,110,74,69,228,82,255,181,1 - -#define RED_MASK BITMASK(PARAM_N, 64) -#define SHA512_BYTES 64 -#define SEED_BYTES 40 -#define SEEDEXPANDER_MAX_LENGTH 4294967295 - -#endif diff --git a/hqc-128/src/reed_solomon.c b/hqc-128/src/reed_solomon.c deleted file mode 100644 index 247830c..0000000 --- a/hqc-128/src/reed_solomon.c +++ /dev/null @@ -1,451 +0,0 @@ -/** - * @file reed_solomon.c - * Constant time implementation of Reed-Solomon codes - */ - -#include "fft.h" -#include "gf.h" -#include "reed_solomon.h" -#include "parameters.h" -#include -#include -#include -#ifdef VERBOSE -#include -#include -#endif - -static uint16_t mod(uint16_t i, uint16_t modulus); -static void compute_syndromes(uint16_t* syndromes, uint8_t* cdw); -static size_t compute_elp(uint16_t *sigma, const uint16_t *syndromes); -static void compute_roots(uint8_t* error, uint16_t* sigma); -static void compute_z_poly(uint16_t* z, const uint16_t* sigma, const uint8_t degree, const uint16_t* syndromes); -static void compute_error_values(uint16_t* error_values, const uint16_t* z, const uint8_t* error); -static void correct_errors(uint8_t* cdw, const uint16_t* error_values); - -static const uint16_t alpha_ij_pow [30][45] = {{2, 4, 8, 16, 32, 64, 128, 29, 58, 116, 232, 205, 135, 19, 38, 76, 152, 45, 90, 180, 117, 234, 201, 143, 3, 6, 12, 24, 48, 96, 192, 157, 39, 78, 156, 37, 74, 148, 53, 106, 212, 181, 119, 238, 193},{4, 16, 64, 29, 116, 205, 19, 76, 45, 180, 234, 143, 6, 24, 96, 157, 78, 37, 148, 106, 181, 238, 159, 70, 5, 20, 80, 93, 105, 185, 222, 95, 97, 153, 94, 101, 137, 30, 120, 253, 211, 107, 177, 254, 223},{8, 64, 58, 205, 38, 45, 117, 143, 12, 96, 39, 37, 53, 181, 193, 70, 10, 80, 186, 185, 161, 97, 47, 101, 15, 120, 231, 107, 127, 223, 182, 217, 134, 68, 26, 208, 206, 62, 237, 59, 197, 102, 23, 184, 169},{16, 29, 205, 76, 180, 143, 24, 157, 37, 106, 238, 70, 20, 93, 185, 95, 153, 101, 30, 253, 107, 254, 91, 217, 17, 13, 208, 129, 248, 59, 151, 133, 184, 79, 132, 168, 82, 73, 228, 230, 198, 252, 123, 227, 150},{32, 116, 38, 180, 3, 96, 156, 106, 193, 5, 160, 185, 190, 94, 15, 253, 214, 223, 226, 17, 26, 103, 124, 59, 51, 46, 169, 132, 77, 85, 114, 230, 145, 215, 255, 150, 55, 174, 100, 28, 167, 89, 239, 172, 36},{64, 205, 45, 143, 96, 37, 181, 70, 80, 185, 97, 101, 120, 107, 223, 217, 68, 208, 62, 59, 102, 184, 33, 168, 85, 228, 191, 252, 241, 150, 110, 130, 7, 221, 89, 195, 138, 61, 251, 44, 207, 173, 8, 58, 38},{128, 19, 117, 24, 156, 181, 140, 93, 161, 94, 60, 107, 163, 67, 26, 129, 147, 102, 109, 132, 41, 57, 209, 252, 255, 98, 87, 200, 224, 89, 155, 18, 245, 11, 233, 173, 16, 232, 45, 3, 157, 53, 159, 40, 185},{29, 76, 143, 157, 106, 70, 93, 95, 101, 253, 254, 217, 13, 129, 59, 133, 79, 168, 73, 230, 252, 227, 149, 130, 28, 81, 195, 18, 247, 44, 27, 2, 58, 152, 3, 39, 212, 140, 186, 190, 202, 231, 225, 175, 26},{58, 45, 12, 37, 193, 80, 161, 101, 231, 223, 134, 208, 237, 102, 169, 168, 146, 191, 179, 150, 87, 7, 166, 195, 36, 251, 125, 173, 64, 38, 143, 39, 181, 10, 185, 47, 120, 127, 217, 26, 62, 197, 184, 21, 85},{116, 180, 96, 106, 5, 185, 94, 253, 223, 17, 103, 59, 46, 132, 85, 230, 215, 150, 174, 28, 89, 172, 244, 44, 108, 32, 38, 3, 156, 193, 160, 190, 15, 214, 226, 26, 124, 51, 169, 77, 114, 145, 255, 55, 100},{232, 234, 39, 238, 160, 97, 60, 254, 134, 103, 118, 184, 84, 57, 145, 227, 220, 7, 162, 172, 245, 176, 71, 58, 180, 192, 181, 40, 95, 15, 177, 175, 208, 147, 46, 21, 73, 99, 241, 55, 200, 166, 43, 122, 44},{205, 143, 37, 70, 185, 101, 107, 217, 208, 59, 184, 168, 228, 252, 150, 130, 221, 195, 61, 44, 173, 58, 117, 39, 193, 186, 47, 231, 182, 26, 237, 23, 21, 146, 145, 219, 87, 56, 242, 36, 139, 54, 64, 45, 96},{135, 6, 53, 20, 190, 120, 163, 13, 237, 46, 84, 228, 229, 98, 100, 81, 69, 251, 131, 32, 45, 192, 238, 186, 94, 187, 217, 189, 236, 169, 82, 209, 241, 220, 28, 242, 72, 22, 173, 116, 201, 37, 140, 222, 15},{19, 24, 181, 93, 94, 107, 67, 129, 102, 132, 57, 252, 98, 200, 89, 18, 11, 173, 232, 3, 53, 40, 194, 231, 226, 189, 197, 158, 170, 145, 75, 25, 166, 69, 235, 54, 29, 234, 37, 5, 95, 120, 91, 52, 59},{38, 96, 193, 185, 15, 223, 26, 59, 169, 85, 145, 150, 100, 89, 36, 44, 1, 38, 96, 193, 185, 15, 223, 26, 59, 169, 85, 145, 150, 100, 89, 36, 44, 1, 38, 96, 193, 185, 15, 223, 26, 59, 169, 85, 145},{76, 157, 70, 95, 253, 217, 129, 133, 168, 230, 227, 130, 81, 18, 44, 2, 152, 39, 140, 190, 231, 175, 31, 23, 77, 209, 219, 25, 162, 36, 88, 4, 45, 78, 5, 97, 211, 67, 62, 46, 154, 191, 171, 50, 89},{152, 78, 10, 153, 214, 68, 147, 79, 146, 215, 220, 221, 69, 11, 1, 152, 78, 10, 153, 214, 68, 147, 79, 146, 215, 220, 221, 69, 11, 1, 152, 78, 10, 153, 214, 68, 147, 79, 146, 215, 220, 221, 69, 11, 1},{45, 37, 80, 101, 223, 208, 102, 168, 191, 150, 7, 195, 251, 173, 38, 39, 10, 47, 127, 26, 197, 21, 115, 219, 100, 242, 245, 54, 205, 96, 70, 97, 107, 68, 59, 33, 228, 241, 130, 89, 61, 207, 58, 12, 193},{90, 148, 186, 30, 226, 62, 109, 73, 179, 174, 162, 61, 131, 232, 96, 140, 153, 127, 52, 51, 168, 99, 98, 56, 172, 22, 8, 234, 212, 185, 240, 67, 237, 79, 114, 241, 25, 121, 245, 108, 19, 39, 20, 188, 223},{180, 106, 185, 253, 17, 59, 132, 230, 150, 28, 172, 44, 32, 3, 193, 190, 214, 26, 51, 77, 145, 55, 167, 36, 233, 116, 96, 5, 94, 223, 103, 46, 85, 215, 174, 89, 244, 108, 38, 156, 160, 15, 226, 124, 169},{117, 181, 161, 107, 26, 102, 41, 252, 87, 89, 245, 173, 45, 53, 185, 231, 68, 197, 168, 145, 110, 166, 61, 54, 38, 37, 186, 120, 134, 59, 21, 191, 196, 221, 36, 207, 205, 39, 80, 15, 217, 237, 33, 115, 150},{234, 238, 97, 254, 103, 184, 57, 227, 7, 172, 176, 58, 192, 40, 15, 175, 147, 21, 99, 55, 166, 122, 216, 45, 106, 222, 107, 52, 133, 85, 123, 50, 195, 11, 32, 12, 140, 188, 182, 124, 158, 115, 49, 224, 36},{201, 159, 47, 91, 124, 33, 209, 149, 166, 244, 71, 117, 238, 194, 223, 31, 79, 115, 98, 167, 61, 216, 90, 181, 190, 254, 206, 218, 213, 150, 224, 72, 54, 152, 106, 161, 177, 189, 184, 114, 171, 56, 18, 131, 38},{143, 70, 101, 217, 59, 168, 252, 130, 195, 44, 58, 39, 186, 231, 26, 23, 146, 219, 56, 36, 54, 45, 181, 97, 223, 62, 33, 191, 110, 89, 251, 8, 12, 10, 15, 134, 197, 41, 179, 100, 86, 125, 205, 37, 185},{3, 5, 15, 17, 51, 85, 255, 28, 36, 108, 180, 193, 94, 226, 59, 77, 215, 100, 172, 233, 38, 106, 190, 223, 124, 132, 145, 174, 239, 44, 116, 156, 185, 214, 103, 169, 230, 55, 89, 235, 32, 96, 160, 253, 26},{6, 20, 120, 13, 46, 228, 98, 81, 251, 32, 192, 186, 187, 189, 169, 209, 220, 242, 22, 116, 37, 222, 254, 62, 132, 63, 130, 43, 250, 38, 212, 194, 182, 147, 77, 179, 141, 9, 54, 180, 159, 101, 67, 151, 85},{12, 80, 231, 208, 169, 191, 87, 195, 125, 38, 181, 47, 217, 197, 85, 219, 221, 245, 8, 96, 186, 107, 206, 33, 145, 130, 86, 207, 45, 193, 101, 134, 102, 146, 150, 166, 251, 64, 39, 185, 127, 62, 21, 252, 100},{24, 93, 107, 129, 132, 252, 200, 18, 173, 3, 40, 231, 189, 158, 145, 25, 69, 54, 234, 5, 120, 52, 218, 191, 174, 43, 207, 90, 35, 15, 136, 92, 115, 220, 239, 125, 76, 238, 101, 17, 133, 228, 149, 121, 44},{48, 105, 127, 248, 77, 241, 224, 247, 64, 156, 95, 182, 236, 170, 150, 162, 11, 205, 212, 94, 134, 133, 213, 110, 239, 250, 45, 35, 30, 26, 218, 99, 130, 69, 108, 143, 40, 211, 206, 132, 229, 7, 144, 2, 96},{96, 185, 223, 59, 85, 150, 89, 44, 38, 193, 15, 26, 169, 145, 100, 36, 1, 96, 185, 223, 59, 85, 150, 89, 44, 38, 193, 15, 26, 169, 145, 100, 36, 1, 96, 185, 223, 59, 85, 150, 89, 44, 38, 193, 15}}; - -/** - * Returns i modulo the given modulus. - * i must be less than 2*modulus. - * Therefore, the return value is either i or i-modulus. - * @returns i mod (modulus) - * @param[in] i The integer whose modulo is taken - * @param[in] modulus The modulus - */ -static uint16_t mod(uint16_t i, uint16_t modulus) { - uint16_t tmp = i - modulus; - - // mask = 0xffff if(i < PARAM_GF_MUL_ORDER) - int16_t mask = -(tmp >> 15); - - return tmp + (mask & modulus); -} - - - -/** - * @brief Computes the generator polynomial of the primitive Reed-Solomon code with given parameters. - * - * Code length is 2^m-1.
- * PARAM_DELTA is the targeted correction capacity of the code - * and receives the real correction capacity (which is at least equal to the target).
- * exp and log are arrays giving antilog and log of GF(2^m) elements. - * - * @param[out] poly Array of size (2*PARAM_DELTA + 1) receiving the coefficients of the generator polynomial - */ -void compute_generator_poly(uint16_t* poly) { - poly[0] = 1; - int tmp_degree = 0; - - for (uint16_t i = 1 ; i < (2 * PARAM_DELTA + 1) ; ++i) { - - for(size_t j = tmp_degree ; j ; --j) { - poly[j] = exp[mod(log[poly[j]] + i, PARAM_GF_MUL_ORDER)] ^ poly[j - 1]; - } - - poly[0] = exp[mod(log[poly[0]] + i, PARAM_GF_MUL_ORDER)]; - poly[++tmp_degree] = 1; - - } - - printf("\n"); - for (int i = 0 ; i < (PARAM_G) ; ++i) { - printf("%d, ", poly[i]); - } - printf("\n"); -} - - - -/** - * @brief Encodes a message message of PARAM_K bits to a Reed-Solomon codeword codeword of PARAM_N1 bytes - * - * Following @cite lin1983error (Chapter 4 - Cyclic Codes), - * We perform a systematic encoding using a linear (PARAM_N1 - PARAM_K)-stage shift register - * with feedback connections based on the generator polynomial PARAM_RS_POLY of the Reed-Solomon code. - * - * @param[out] cdw Array of size VEC_N1_SIZE_64 receiving the encoded message - * @param[in] msg Array of size VEC_K_SIZE_64 storing the message - */ -void reed_solomon_encode(uint64_t* cdw, const uint64_t* msg) { - uint8_t gate_value = 0; - - uint16_t tmp[PARAM_G] = {0}; - uint16_t PARAM_RS_POLY [] = {RS_POLY_COEFS}; - - uint8_t msg_bytes[PARAM_K] = {0}; - uint8_t cdw_bytes[PARAM_N1] = {0}; - - memcpy(msg_bytes, msg, PARAM_K); - - for (int i = PARAM_K-1 ; i >= 0 ; --i) { - gate_value = msg_bytes[i] ^ cdw_bytes[PARAM_N1 - PARAM_K - 1]; - - for (size_t j = 0 ; j < PARAM_G ; ++j) { - tmp[j] = gf_mul(gate_value, PARAM_RS_POLY[j]); - } - - for(size_t k = PARAM_N1 - PARAM_K - 1 ; k ; --k) { - cdw_bytes[k] = cdw_bytes[k - 1] ^ tmp[k]; - } - - cdw_bytes[0] = tmp[0]; - } - - memcpy(cdw_bytes + PARAM_N1 - PARAM_K, msg_bytes, PARAM_K); - memcpy(cdw, cdw_bytes, PARAM_N1); -} - - - -/** - * @brief Computes 2 * PARAM_DELTA syndromes - * - * @param[out] syndromes Array of size 2 * PARAM_DELTA receiving the computed syndromes - * @param[in] cdw Array of size PARAM_N1 storing the received vector - */ -void compute_syndromes(uint16_t* syndromes, uint8_t* cdw) { - for (size_t i = 0 ; i < 2 * PARAM_DELTA ; ++i) { - for (size_t j = 1 ; j < PARAM_N1 ; ++j) { - syndromes[i] ^= gf_mul(cdw[j], alpha_ij_pow[i][j-1]); - } - syndromes[i] ^= cdw[0]; - } -} - - - -/** - * @brief Computes the error locator polynomial (ELP) sigma - * - * This is a constant time implementation of Berlekamp's simplified algorithm (see @cite lin1983error (Chapter 6 - BCH Codes).
- * We use the letter p for rho which is initialized at -1.
- * The array X_sigma_p represents the polynomial X^(mu-rho)*sigma_p(X).
- * Instead of maintaining a list of sigmas, we update in place both sigma and X_sigma_p.
- * sigma_copy serves as a temporary save of sigma in case X_sigma_p needs to be updated.
- * We can properly correct only if the degree of sigma does not exceed PARAM_DELTA. - * This means only the first PARAM_DELTA + 1 coefficients of sigma are of value - * and we only need to save its first PARAM_DELTA - 1 coefficients. - * - * @returns the degree of the ELP sigma - * @param[out] sigma Array of size (at least) PARAM_DELTA receiving the ELP - * @param[in] syndromes Array of size (at least) 2*PARAM_DELTA storing the syndromes - */ -static size_t compute_elp(uint16_t *sigma, const uint16_t *syndromes) { - sigma[0] = 1; - size_t deg_sigma = 0; - size_t deg_sigma_p = 0; - uint16_t sigma_copy[PARAM_DELTA + 1] = {0}; - size_t deg_sigma_copy = 0; - uint16_t X_sigma_p[PARAM_DELTA + 1] = {0,1}; - int32_t pp = -1; // 2*rho - uint16_t d_p = 1; - uint16_t d = syndromes[0]; - - for (size_t mu = 0 ; (mu < (2 * PARAM_DELTA)) ; ++mu) { - // Save sigma in case we need it to update X_sigma_p - memcpy(sigma_copy, sigma, 2 * (PARAM_DELTA)); - deg_sigma_copy = deg_sigma; - - uint16_t dd = gf_mul(d, gf_inverse(d_p)); - - for (size_t i = 1 ; (i <= mu + 1) && (i <= PARAM_DELTA) ; ++i) { - sigma[i] ^= gf_mul(dd, X_sigma_p[i]); - } - - size_t deg_X = mu - pp; - size_t deg_X_sigma_p = deg_X + deg_sigma_p; - - // mask1 = 0xffff if(d != 0) and 0 otherwise - int16_t mask1 = -((uint16_t) - d >> 15); - - // mask2 = 0xffff if(deg_X_sigma_p > deg_sigma) and 0 otherwise - int16_t mask2 = -((uint16_t) (deg_sigma - deg_X_sigma_p) >> 15); - - // mask12 = 0xffff if the deg_sigma increased and 0 otherwise - int16_t mask12 = mask1 & mask2; - deg_sigma = (mask12 & deg_X_sigma_p) ^ (~mask12 & deg_sigma); - - if (mu == (2 * PARAM_DELTA - 1)) { - break; - } - - pp = (mask12 & mu) ^ (~mask12 & pp); - d_p = (mask12 & d) ^ (~mask12 & d_p); - for (size_t i = PARAM_DELTA ; i ; --i) { - X_sigma_p[i] = (mask12 & sigma_copy[i - 1]) ^ (~mask12 & X_sigma_p[i - 1]); - } - - deg_sigma_p = (mask12 & deg_sigma_copy) ^ (~mask12 & deg_sigma_p); - d = syndromes[mu + 1]; - - for (size_t i = 1 ; (i <= mu+1) && (i <= PARAM_DELTA) ; ++i) { - d ^= gf_mul(sigma[i], syndromes[mu + 1 - i]); - } - } - - return deg_sigma; -} - - - -/** - * @brief Computes the error polynomial error from the error locator polynomial sigma - * - * See function fft for more details. - * - * @param[out] error Array of 2^PARAM_M elements receiving the error polynomial - * @param[out] error_compact Array of PARAM_DELTA + PARAM_N1 elements receiving a compact representation of the vector error - * @param[in] sigma Array of 2^PARAM_FFT elements storing the error locator polynomial - */ -static void compute_roots(uint8_t* error, uint16_t* sigma) { - uint16_t w[1 << PARAM_M] = {0}; - - fft(w, sigma, PARAM_DELTA + 1); - fft_retrieve_error_poly(error, w); -} - - - -/** - * @brief Computes the polynomial z(x) - * - * See @cite lin1983error (Chapter 6 - BCH Codes) for more details. - * - * @param[out] z Array of PARAM_DELTA + 1 elements receiving the polynomial z(x) - * @param[in] sigma Array of 2^PARAM_FFT elements storing the error locator polynomial - * @param[in] degree Integer that is the degree of polynomial sigma - * @param[in] syndromes Array of 2 * PARAM_DELTA storing the syndromes - */ -static void compute_z_poly(uint16_t* z, const uint16_t* sigma, const uint8_t degree, const uint16_t* syndromes) { - z[0] = 1; - - for (size_t i = 1 ; i < PARAM_DELTA + 1 ; ++i) { - int16_t mask2 = -((uint16_t) (i - degree - 1) >> 15); - z[i] = ((uint16_t)mask2) & sigma[i]; - } - - z[1] ^= syndromes[0]; - - for (size_t i = 2 ; i <= PARAM_DELTA ; ++i) { - int16_t mask2 = -((uint16_t) (i - degree - 1) >> 15); - z[i] ^= ((uint16_t)mask2 & syndromes[i-1]); - - for (size_t j = 1 ; j < i ; ++j) { - z[i] ^= ((uint16_t)mask2) & gf_mul(sigma[j], syndromes[i - j - 1]); - } - } -} - - - -/** - * @brief Computes the error values - * - * See @cite lin1983error (Chapter 6 - BCH Codes) for more details. - * - * @param[out] error_values Array of PARAM_DELTA elements receiving the error values - * @param[in] z Array of PARAM_DELTA + 1 elements storing the polynomial z(x) - * @param[in] z_degree Integer that is the degree of polynomial z(x) - * @param[in] error_compact Array of PARAM_DELTA + PARAM_N1 storing compact representation of the error - */ -static void compute_error_values(uint16_t* error_values, const uint16_t* z, const uint8_t* error) { - uint16_t beta_j[PARAM_DELTA] = {0}; - uint16_t e_j[PARAM_DELTA] = {0}; - - uint16_t delta_counter = 0; - uint16_t delta_real_value; - - // Compute the beta_{j_i} page 31 of the documentation - for (size_t i = 0 ; i < PARAM_N1 ; i++) { - uint16_t found = 0; - int16_t valuemask = ((int16_t) -(error[i] != 0)) >> 15; - for (size_t j = 0 ; j < PARAM_DELTA ; j++) { - int16_t indexmask = ((int16_t) -(j == delta_counter)) >> 15; - beta_j[j] += indexmask & valuemask & exp[i]; - found += indexmask & valuemask & 1; - } - delta_counter += found; - } - delta_real_value = delta_counter; - - // Compute the e_{j_i} page 31 of the documentation - for (size_t i = 0 ; i < PARAM_DELTA ; ++i) { - uint16_t tmp1 = 1; - uint16_t tmp2 = 1; - uint16_t inverse = gf_inverse(beta_j[i]); - uint16_t inverse_power_j = 1; - - for (size_t j = 1 ; j <= PARAM_DELTA ; ++j) { - inverse_power_j = gf_mul(inverse_power_j, inverse); - tmp1 ^= gf_mul(inverse_power_j , z[j]); - } - for (size_t k = 1 ; k < PARAM_DELTA ; ++k) { - tmp2 = gf_mul(tmp2, (1 ^ gf_mul(inverse, beta_j[(i+k) % PARAM_DELTA]))); - } - int16_t mask = ((int16_t) -(i>15; - e_j[i] = mask & gf_mul(tmp1,gf_inverse(tmp2)); - } - - // Place the delta e_{j_i} values at the right coordinates of the output vector - delta_counter = 0; - for (size_t i = 0 ; i < PARAM_N1 ; ++i) { - uint16_t found = 0; - int16_t valuemask = ((int16_t) -(error[i] !=0)) >> 15; - for (size_t j = 0 ; j < PARAM_DELTA ; j++) { - int16_t indexmask = ((int16_t) -(j == delta_counter)) >> 15; - error_values[i] += indexmask & valuemask & e_j[j]; - found += indexmask & valuemask & 1; - } - delta_counter += found; - } -} - - - -/** - * @brief Correct the errors - * - * @param[out] cdw Array of PARAM_N1 elements receiving the corrected vector - * @param[in] error Array of the error vector - * @param[in] error_values Array of PARAM_DELTA elements storing the error values - */ -static void correct_errors(uint8_t* cdw, const uint16_t* error_values) { - for (size_t i = 0 ; i < PARAM_N1 ; ++i) { - cdw[i] ^= error_values[i]; - } -} - - - -/** - * @brief Decodes the received word - * - * This function relies on six steps: - *
    - *
  1. The first step, is the computation of the 2*PARAM_DELTA syndromes. - *
  2. The second step is the computation of the error-locator polynomial sigma. - *
  3. The third step, done by additive FFT, is finding the error-locator numbers by calculating the roots of the polynomial sigma and takings their inverses. - *
  4. The fourth step, is the polynomial z(x). - *
  5. The fifth step, is the computation of the error values. - *
  6. The sixth step is the correction of the errors in the received polynomial. - *
- * For a more complete picture on Reed-Solomon decoding, see Shu. Lin and Daniel J. Costello in Error Control Coding: Fundamentals and Applications @cite lin1983error - * - * @param[out] msg Array of size VEC_K_SIZE_64 receiving the decoded message - * @param[in] cdw Array of size VEC_N1_SIZE_64 storing the received word - */ -void reed_solomon_decode(uint64_t* msg, uint64_t* cdw) { - uint8_t cdw_bytes[PARAM_N1] = {0}; - uint16_t syndromes[2 * PARAM_DELTA] = {0}; - uint16_t sigma[1 << PARAM_FFT] = {0}; - uint8_t error[1 << PARAM_M] = {0}; - uint16_t z[PARAM_N1] = {0}; - uint16_t error_values[PARAM_N1] = {0}; - - // Copy the vector in an array of bytes - memcpy(cdw_bytes, cdw, PARAM_N1); - - // Calculate the 2*PARAM_DELTA syndromes - compute_syndromes(syndromes, cdw_bytes); - - // Compute the error locator polynomial sigma - // Sigma's degree is at most PARAM_DELTA but the FFT requires the extra room - size_t deg = compute_elp(sigma, syndromes); - - // Compute the error polynomial error - compute_roots(error, sigma); - - // Compute the polynomial z(x) - compute_z_poly(z, sigma, deg, syndromes); - - // Compute the error values - compute_error_values(error_values, z, error); - - // Correct the errors - correct_errors(cdw_bytes, error_values); - - // Retrieve the message from the decoded codeword - memcpy(msg, cdw_bytes + (PARAM_G - 1) , PARAM_K); - -#ifdef VERBOSE - printf("\n\nThe syndromes: "); - for (size_t i = 0 ; i < 2*PARAM_DELTA ; ++i) { - printf("%u ", syndromes[i]); - } - printf("\n\nThe error locator polynomial: sigma(x) = "); - bool first_coeff = true; - if (sigma[0]) { - printf("%u", sigma[0]); - first_coeff = false; - } - for (size_t i = 1 ; i < (1 << PARAM_FFT) ; ++i) { - if (sigma[i] == 0) - continue; - if (!first_coeff) - printf(" + "); - first_coeff = false; - if(sigma[i] != 1) - printf("%u ", sigma[i]); - if (i == 1) - printf("x"); - else - printf("x^%zu", i); - } - if (first_coeff) - printf("0"); - - printf("\n\nThe polynomial: z(x) = "); - bool first_coeff_1 = true; - if (z[0]) { - printf("%u", z[0]); - first_coeff_1 = false; - } - for (size_t i = 1 ; i < (PARAM_DELTA + 1) ; ++i) { - if (z[i] == 0) - continue; - if (!first_coeff_1) - printf(" + "); - first_coeff_1 = false; - if(z[i] != 1) - printf("%u ", z[i]); - if (i == 1) - printf("x"); - else - printf("x^%zu", i); - } - if (first_coeff_1) - printf("0"); - - printf("\n\nThe pairs of (error locator numbers, error values): "); - size_t j = 0; - for (size_t i = 0 ; i < PARAM_N1 ; ++i) { - if(error[i]){ - printf("(%zu, %d) ", i, error_values[j]); - j++; - } - } - printf("\n"); -#endif -} diff --git a/hqc-192/Makefile b/hqc-192/Makefile deleted file mode 100644 index bc5ac73..0000000 --- a/hqc-192/Makefile +++ /dev/null @@ -1,71 +0,0 @@ - -CC:=gcc - -CFLAGS:=-O3 -std=c99 -funroll-all-loops -flto -pedantic -Wall -Wextra - -RNG_FLAGS:=$(CFLAGS) -Wno-unused-but-set-variable -Wno-unused-parameter -Wno-sign-compare - -HASH_SRC:=lib/hash/hash.c -HASH_INCLUDE:=-I lib/hash -lcrypto - -SHA3_SRC:=lib/fips202/fips202.c -SHA3_INCLUDE:=-I lib/fips202 - -RNG_SRC:=lib/rng/rng.c -RNG_INCLUDE:=-I lib/rng - -SRC:=src/ -INCLUDE:=-I src -LIB:=$(HASH_INCLUDE) $(SHA3_INCLUDE) $(RNG_INCLUDE) - -MAIN_HQC:=src/main_hqc.c -MAIN_KAT:=src/main_kat.c - -HQC_OBJS:=vector.o reed_muller.o reed_solomon.o fft.o gf.o gf2x.o code.o parsing.o hqc.o kem.o -HQC_OBJS_VERBOSE:=vector.o reed_muller.o reed_solomon-verbose.o fft.o gf.o gf2x.o code-verbose.o parsing.o hqc-verbose.o kem-verbose.o -LIB_OBJS:= hash.o rng.o fips202.o - -BIN:=bin -BUILD:=bin/build - -folders: - @echo -e "\n### Creating folders\n" - mkdir -p $(BUILD) - -hash.o: folders - @echo -e "\n### Compiling $@ (wrapper around openssl SHA512 implementation)\n" - $(CC) $(CFLAGS) -c $(HASH_SRC) $(HASH_INCLUDE) -o $(BUILD)/$@ - -fips202.o: folders - @echo -e "\n### Compiling fips202\n" - $(CC) $(CFLAGS) -c $(SHA3_SRC) $(SHA3_INCLUDE) -o $(BUILD)/$@ - -rng.o: folders - @echo -e "\n### Compiling NIST rng.o\n" - $(CC) $(RNG_FLAGS) -c $(RNG_SRC) $(RNG_INCLUDE) -o $(BUILD)/$@ - -%.o: $(SRC)/%.c | folders - @echo -e "\n### Compiling $@\n" - $(CC) $(CFLAGS) -c $< $(INCLUDE) $(LIB) -o $(BUILD)/$@ - -%-verbose.o: $(SRC)/%.c | folders - @echo -e "\n### Compiling $@ (verbose mode)\n" - $(CC) $(CFLAGS) -c $< $(INCLUDE) $(LIB) -D VERBOSE -o $(BUILD)/$@ - -hqc-192: $(HQC_OBJS) $(LIB_OBJS) | folders - @echo -e "\n### Compiling hqc-192\n" - $(CC) $(CFLAGS) $(MAIN_HQC) $(addprefix $(BUILD)/, $^) $(INCLUDE) $(LIB) -o $(BIN)/$@ - -hqc-192-kat: $(HQC_OBJS) $(LIB_OBJS) | folders - @echo -e "\n### Compiling hqc-192 KAT\n" - $(CC) $(CFLAGS) $(MAIN_KAT) $(addprefix $(BUILD)/, $^) $(INCLUDE) $(LIB) -o $(BIN)/$@ - -hqc-192-verbose: $(HQC_OBJS_VERBOSE) $(LIB_OBJS) | folders - @echo -e "\n### Compiling hqc-192 (verbose mode)\n" - $(CC) $(CFLAGS) $(MAIN_HQC) $(addprefix $(BUILD)/, $^) $(INCLUDE) $(LIB) -D VERBOSE -o $(BIN)/$@ - - -clean: - rm -f PQCkemKAT_* - rm -f vgcore.* - rm -rf ./bin diff --git a/hqc-192/doc/biblio.bib b/hqc-192/doc/biblio.bib deleted file mode 100644 index 9aff260..0000000 --- a/hqc-192/doc/biblio.bib +++ /dev/null @@ -1,57 +0,0 @@ -@book{macwilliams1977theory, - title={The theory of error-correcting codes}, - author={MacWilliams, Florence Jessie and Sloane, Neil James Alexander}, - volume={16}, - year={1977}, - publisher={Elsevier} -} - -@article{lin1983error, - title={Error Control Coding: Fundamentals and Applications}, - author={Lin, Shu and Costello, Daniel}, - year={1983}, - publisher={Prentice Hall} -} - -@misc{cryptoeprint:2016:1194, - author = {Carlos Aguilar and Olivier Blazy and Jean-Christophe Deneuville and Philippe Gaborit and Gilles Zémor}, - title = {Efficient Encryption from Random Quasi-Cyclic Codes}, - howpublished = {Cryptology ePrint Archive, Report 2016/1194}, - year = {2016}, - note = {\url{http://eprint.iacr.org/2016/1194}}, -} - -@misc{cryptoeprint:2017:604, - author = {Dennis Hofheinz and Kathrin Hövelmanns and Eike Kiltz}, - title = {A Modular Analysis of the Fujisaki-Okamoto Transformation}, - howpublished = {Cryptology ePrint Archive, Report 2017/604}, - year = {2017}, - note = {\url{http://eprint.iacr.org/2017/604}}, -} - -@article{gao2010additive, - title={Additive fast Fourier transforms over finite fields}, - author={Gao, Shuhong and Mateer, Todd}, - journal={IEEE Transactions on Information Theory}, - volume={56}, - number={12}, - pages={6265--6272}, - year={2010}, - publisher={IEEE} -} - -@inproceedings{bernstein2013mcbits, - title={McBits: fast constant-time code-based cryptography}, - author={Bernstein, Daniel J and Chou, Tung and Schwabe, Peter}, - booktitle={International Workshop on Cryptographic Hardware and Embedded Systems}, - pages={250--272}, - year={2013}, - organization={Springer} -} - -@article{aragon2020hqc, - title={HQC-RMRS, an instantiation of the HQC encryption framework with a more efficient auxiliary error-correcting code}, - author={Aragon, Nicolas and Gaborit, Philippe and Z{\'e}mor, Gilles}, - journal={arXiv preprint arXiv:2005.10741}, - year={2020} -} \ No newline at end of file diff --git a/hqc-192/doc/main_page.txt b/hqc-192/doc/main_page.txt deleted file mode 100644 index 5872305..0000000 --- a/hqc-192/doc/main_page.txt +++ /dev/null @@ -1,91 +0,0 @@ -/*! \mainpage HQC: a Public-Key Encryption scheme - * - * 1. SUBMISSION OVERVIEW - * ---------------------- - * - * In order to fully understand this submission, one should note that HQC is a public-key encryption scheme submitted as a KEM for which NIST "standard conversion techniques" should be applied (see NIST FAQ#13). In addition, the aforementionned KEM is obtained by applying a conversion technique to a PKE. In order to avoid any confusion, we may refer to: - * - * - HQC_PKE IND-CPA: HQC PKE IND-CPA scheme given in the Supporting Documentation. - * - HQC_KEM IND-CCA2: HQC KEM IND-CCA2 scheme obtained by applying the transformation from \cite cryptoeprint:2017:604 to the HQC PKE IND-CPA scheme. It is the implementation provided. - * - HQC_PKE IND-CCA2: HQC PKE IND-CCA2 scheme obtained by applying NIST "standard conversion techniques" to the HQC KEM IND-CCA2 scheme. It is the scheme submitted.
- * - * - * Three parameters sets denoted respectively HQC-128, HQC-192 and HQC-256 are provided as explained in the supporting documentation. Each parameter set folder is organized as follows: - * - * - bin/: Files generated during compilation - * - doc/: Technical documentation of the scheme - * - lib/: Third party libraries used - * - src/: Source code of the scheme - * - doxygen.conf: Documentation configuration file - * - Makefile: Makefile - * - *
- * - * 2. INSTALLATION INSTRUCTIONS - * ---------------------------- - * - *

2.1 Requirements

- * - * The following softwares and libraries are required: make, gcc, and openssl. - * - *

2.2 Compilation Step

- * - * Let X denotes -128, -192 or -256 depending on the parameter set considered. HQC can be compiled in three differents ways: - * - Execute make hqcX to compile a working example of the scheme. Run bin/hqcX to execute all the steps of the scheme and display theirs respective performances. - * - Execute make hqcX-kat to compile the NIST KAT generator. Run bin/hqcX-kat to generate KAT files. - * - Execute make hqcX-verbose to compile a working example of the scheme in verbose mode. Run bin/hqcX-verbose to generate intermediate values. - * - * During compilation, the following files are created inside the bin/build folder: - * - hash.o: A wrapper around openssl SHA512 implementation - * - fips202.o: Hash function SHA3-512 - * - rng.o: NIST rng - * - parsing.o: Functions to parse public key, secret key and ciphertext of the scheme. - * - gf2x.o: Function to multiply polynomials. - * - vector.o: Functions to manipulate vectors. - * - reed_solomon.o: Functions to encode and decode messages using Reed-Solomon codes \cite lin1983error (either in normal mode or verbose mode). - * - reed_muller.o: Functions to encode and decode messages using Reed-Muller codes \cite macwilliams1977theory. - * - fft.o: Functions for the additive Fast Fourier Transform \cite gao2010additive \cite bernstein2013mcbits. - * - gf.o: Functions for Galois field manipulation. - * - code.o: Functions to encode and decode messages using concatenated codes (either in normal mode or verbose mode). - * - hqc.o: The HQC PKE IND-CPA scheme (either in normal mode or verbose mode). - * - kem.o: The HQC KEM IND-CCA2 scheme (either in normal mode or verbose mode). - * - *
- * - * 3. DOCUMENTATION - * ---------------- - * - *

3.1 Requirements

- * - * The following softwares are required: doxygen and bibtex. - * - *

3.2 Generation Step

- * - * - Run doxygen doxygen.conf to generate the code documentation - * - Browse doc/html/index.html to read the documentation - * - *
- * - * 4. ADDITIONAL INFORMATIONS - * -------------------------- - * - *

4.1 Implementation overview

- * - * The HQC_KEM IND-CCA2 scheme is defined in the api.h and parameters.h files and implemented in kem.c. - * The latter is based on the HQC_PKE IND-CPA scheme that is defined in hqc.h and implemented in hqc.c. - * The HQC_PKE IND-CPA scheme uses Concatenated codes (see code.h and code.c) which is the combination of Reed-Solomon codes \cite lin1983error (see reed_solomon.h and reed_solomon.c) - * and Reed-Muller codes \cite macwilliams1977theory (see reed_muller.h and reed_muller.c). - * Roots computation for Reed-Solomon codes is done by additive Fast Fourier Transform \cite gao2010additive \cite bernstein2013mcbits (see fft.h and fft.c). - * Files gf.h and gf.c provide the implementation of the underlying Galois field. - * The files gf2x.c and gf2x.h provide the function performing the multiplication of two polynomials. - * As public key, secret key and ciphertext can be manipulated either with their mathematical representations or as bit strings, the files parsing.h and parsing.c provide functions to switch between these two representations. - * Finally, the files hash.h, fips202.h, rng.h, hash.c, fips202.c and rng.c (inside the lib/ folder) contain respectively a wrapper around OpenSSL SHA512 implementation, SHA3-512 implementation and the NIST random functions. - * - *

4.2 Public key, secret key, ciphertext and shared secret

- * - * The public key, secret key and ciphertext are respectively composed of (h, s), (x, y) and (u, v, d). - * The shared secret is the output of the hash of m, u and v using SHA512. - * In order to shorten the keys, the public key is stored as (seed1, s) and the secret key is stored as (seed2). - * To this end, the seed expander provided by the NIST was used along with 40 bytes long seeds. - * - */ diff --git a/hqc-192/doxygen.conf b/hqc-192/doxygen.conf deleted file mode 100644 index 1304cec..0000000 --- a/hqc-192/doxygen.conf +++ /dev/null @@ -1,1924 +0,0 @@ -# Doxyfile 1.8.13 -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. -# The default value is: UTF-8. -DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. -PROJECT_NAME = "HQC: a Public-Key Encryption scheme" -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. -PROJECT_NUMBER = -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. -PROJECT_LOGO = -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. -OUTPUT_DIRECTORY = ./doc -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. -CREATE_SUBDIRS = NO -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. -ALLOW_UNICODE_NAMES = NO -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. -OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. -BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. -REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. -ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. -INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. -FULL_PATH_NAMES = YES -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. -STRIP_FROM_PATH = -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. -STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. -SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. -JAVADOC_AUTOBRIEF = YES -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit @brief command for a brief description.) -# The default value is: NO. -QT_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. -MULTILINE_CPP_IS_BRIEF = NO -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. -INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. -SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. -TAB_SIZE = 2 -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. -ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. -TCL_SUBST = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. -OPTIMIZE_OUTPUT_FOR_C = YES -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. -OPTIMIZE_OUTPUT_JAVA = NO -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. -OPTIMIZE_FOR_FORTRAN = NO -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. -OPTIMIZE_OUTPUT_VHDL = NO -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. -EXTENSION_MAPPING = -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. -MARKDOWN_SUPPORT = YES -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up -# to that level are automatically included in the table of contents, even if -# they do not have an id attribute. -# Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 0. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. -TOC_INCLUDE_HEADINGS = 0 -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. -AUTOLINK_SUPPORT = YES -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. -BUILTIN_STL_SUPPORT = NO -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. -CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. -SIP_SUPPORT = NO -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. -IDL_PROPERTY_SUPPORT = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. -DISTRIBUTE_GROUP_DOC = NO -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. -GROUP_NESTED_COMPOUNDS = NO -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. -SUBGROUPING = YES -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. -INLINE_GROUPED_CLASSES = NO -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. -INLINE_SIMPLE_STRUCTS = NO -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. -TYPEDEF_HIDES_STRUCT = NO -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. -LOOKUP_CACHE_SIZE = 0 -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. -EXTRACT_ALL = NO -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. -EXTRACT_PRIVATE = NO -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. -EXTRACT_PACKAGE = NO -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. -EXTRACT_STATIC = YES -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. -EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. -EXTRACT_LOCAL_METHODS = NO -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. -EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. -HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. -HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO, these declarations will be -# included in the documentation. -# The default value is: NO. -HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. -HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. -INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. -CASE_SENSE_NAMES = YES -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. -HIDE_SCOPE_NAMES = NO -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. -HIDE_COMPOUND_REFERENCE= NO -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. -SHOW_INCLUDE_FILES = YES -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. -SHOW_GROUPED_MEMB_INC = NO -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. -FORCE_LOCAL_INCLUDES = NO -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. -INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. -SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. -SORT_BRIEF_DOCS = NO -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. -SORT_MEMBERS_CTORS_1ST = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. -SORT_GROUP_NAMES = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. -SORT_BY_SCOPE_NAME = NO -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. -STRICT_PROTO_MATCHING = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. -GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. -GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. -GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. -GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. -ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. -MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. -SHOW_USED_FILES = YES -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. -SHOW_FILES = YES -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. -SHOW_NAMESPACES = YES -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. -FILE_VERSION_FILTER = -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. -LAYOUT_FILE = -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. -CITE_BIB_FILES = doc/biblio.bib -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. -QUIET = NO -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. -WARNINGS = YES -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. -WARN_IF_UNDOCUMENTED = YES -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. -WARN_IF_DOC_ERROR = YES -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. -# The default value is: NO. -WARN_NO_PARAMDOC = NO -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. -# The default value is: NO. -WARN_AS_ERROR = NO -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. -WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). -WARN_LOGFILE = -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. -INPUT = -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. -# The default value is: UTF-8. -INPUT_ENCODING = UTF-8 -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, -# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.pyw \ - *.f90 \ - *.f95 \ - *.f03 \ - *.f08 \ - *.f \ - *.for \ - *.tcl \ - *.txt - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. -RECURSIVE = YES -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. -EXCLUDE = -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. -EXCLUDE_SYMLINKS = NO -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = */lib/* -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* -EXCLUDE_SYMBOLS = -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). -EXAMPLE_PATH = -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. -EXAMPLE_PATTERNS = * -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. -EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). -IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. -INPUT_FILTER = -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. -FILTER_PATTERNS = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. -FILTER_SOURCE_FILES = NO -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. -FILTER_SOURCE_PATTERNS = -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. -SOURCE_BROWSER = NO -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. -INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. -STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. -REFERENCED_BY_RELATION = NO -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. -REFERENCES_RELATION = NO -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. -REFERENCES_LINK_SOURCE = YES -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. -SOURCE_TOOLTIPS = YES -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. -USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. -VERBATIM_HEADERS = YES -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. -ALPHABETICAL_INDEX = YES -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. -COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. -IGNORE_PREFIX = -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. -GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_STYLESHEET = -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE_HUE = 220 -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE_SAT = 100 -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE_GAMMA = 80 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_TIMESTAMP = NO -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_DYNAMIC_SECTIONS = NO -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_INDEX_NUM_ENTRIES = 100 -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_DOCSET = NO -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. -DOCSET_FEEDNAME = "Doxygen generated docs" -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. -DOCSET_BUNDLE_ID = org.doxygen.Project -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. -DOCSET_PUBLISHER_ID = org.doxygen.Publisher -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. -DOCSET_PUBLISHER_NAME = Publisher -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_HTMLHELP = NO -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_FILE = -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -HHC_LOCATION = -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the master .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -GENERATE_CHI = NO -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_INDEX_ENCODING = -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -TOC_EXPAND = NO -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_QHP = NO -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. -QCH_FILE = -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. -QHP_NAMESPACE = org.doxygen.Project -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. -QHP_VIRTUAL_FOLDER = doc -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_NAME = -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). -# This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_ATTRS = -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. -QHP_SECT_FILTER_ATTRS = -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. -QHG_LOCATION = -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_ECLIPSEHELP = NO -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. -ECLIPSE_DOC_ID = org.doxygen.Project -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. -DISABLE_INDEX = NO -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_TREEVIEW = NO -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. -ENUM_VALUES_PER_LINE = 4 -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. -TREEVIEW_WIDTH = 250 -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. -EXT_LINKS_IN_WINDOW = NO -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. -FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. -FORMULA_TRANSPARENT = YES -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. -USE_MATHJAX = YES -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_FORMAT = HTML-CSS -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. -# This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_EXTENSIONS = -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_CODEFILE = -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /