merge scripts and add eol check (#27)

potsrevennil · web-flow · commit 4d271a9f8a9a · 2024-04-15T17:44:52.000+08:00
* move scripts to scripts/

Signed-off-by: Thing-han, Lim &lt;15379156+potsrevennil@users.noreply.github.com&gt;

* add checks for eol

Signed-off-by: Thing-han, Lim &lt;15379156+potsrevennil@users.noreply.github.com&gt;

* move dev-support/README to scripts/ and update direnv section

Signed-off-by: Thing-han, Lim &lt;15379156+potsrevennil@users.noreply.github.com&gt;

* append eol to all files

Signed-off-by: Thing-han, Lim &lt;15379156+potsrevennil@users.noreply.github.com&gt;

* update ci lint job

Signed-off-by: Thing-han, Lim &lt;15379156+potsrevennil@users.noreply.github.com&gt;

* update ci devshell

Signed-off-by: Thing-han, Lim &lt;15379156+potsrevennil@users.noreply.github.com&gt;

* update devshell path

Signed-off-by: Thing-han, Lim &lt;15379156+potsrevennil@users.noreply.github.com&gt;

* update scripts readme for direnv installation

Signed-off-by: Thing-han, Lim &lt;15379156+potsrevennil@users.noreply.github.com&gt;

---------

Signed-off-by: Thing-han, Lim &lt;15379156+potsrevennil@users.noreply.github.com&gt;
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -13,4 +13,4 @@
 
 * [ ] Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)?  (If so, a version bump will be required from *x.y.z* to *x.(y+1).0*.)
 
-<!-- Once your pull request is ready for review and passing continuous integration tests, please convert from a draft PR to a normal PR, and request a review from one of the OQS core team members. -->
+<!-- Once your pull request is ready for review and passing continuous integration tests, please convert from a draft PR to a normal PR, and request a review from one of the OQS core team members. -->
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -17,16 +17,10 @@ jobs:
         script: |
           astyle --version
           arm-none-eabi-gcc --version
-    - name: Astyle
+    - name: Lint
       shell: nix develop .#ci -c bash -e {0}
       run: |
-          err=$(astyle $(git ls-files "*.c" "*.h") --options=.astylerc --dry-run --formatted | awk '{print $2}')
-          if [[ ${#err} != 0 ]]; then
-            echo "$err" | while IFS= read -r file; do
-              echo "::error file={"$file"},title={checking}::Formatted $file"
-            done
-            exit 1
-          fi
+          lint
     - name: Build targets
       shell: nix develop .#ci -c bash -e {0}
       run: |
diff --git a/.github/workflows/scorecard.yaml b/.github/workflows/scorecard.yaml
@@ -58,4 +58,4 @@ jobs:
       - name: "Upload SARIF results to code scanning"
         uses: github/codeql-action/upload-sarif@592977e6ae857384aa79bb31e7a1d62d63449ec5 # v2.16.3
         with:
-          sarif_file: results.sarif
+          sarif_file: results.sarif
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -3,4 +3,4 @@
 
 # Code of Conduct
 
-Please see [open issue](https://github.com/pq-code-package/tsc/issues/9)
+Please see [open issue](https://github.com/pq-code-package/tsc/issues/9)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,4 +3,4 @@
 
 # Contributing
 
-to be completed
+to be completed
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -3,4 +3,4 @@
 
 # Governance
 
-to be documented
+to be documented
diff --git a/Makefile b/Makefile
@@ -35,4 +35,4 @@ clean:
 	$(Q)rm -rf bin/
 	$(Q)rm -rf obj/
 
-distclean: libclean clean
+distclean: libclean clean
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ All the develop and build dependencies are specified in [flake.nix](flake.nix).
 
 - If your're not using nix, please ensure you have installed the same version as specified in [flake.nix](flake.nix).
 
-For further details, please refer to [DevSupport](dev-support/)
+For further details, please refer to [scripts/README.md](scripts/README.md)
 
 ## Running tests and benchmarks
 
diff --git a/SECURITY.md b/SECURITY.md
@@ -3,4 +3,4 @@
 
 # Security
 
-Please see [open issue](https://github.com/pq-code-package/tsc/issues/8)
+Please see [open issue](https://github.com/pq-code-package/tsc/issues/8)
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -3,4 +3,4 @@
 
 # Support
 
-To be written.
+To be written.
diff --git a/dev-support/bin/log b/dev-support/bin/log
diff --git a/dev-support/bin/style b/dev-support/bin/style
diff --git a/fips202/LICENSE b/fips202/LICENSE
@@ -4,4 +4,4 @@ crypto_hash/keccakc512/simple/ from http://bench.cr.yp.to/supercop.html
 by Ronny Van Keer
 and the public domain "TweetFips202" implementation
 from https://twitter.com/tweetfips202
-by Gilles Van Assche, Daniel J. Bernstein, and Peter Schwabe
+by Gilles Van Assche, Daniel J. Bernstein, and Peter Schwabe
diff --git a/flake.nix b/flake.nix
@@ -20,6 +20,8 @@
         let
           core = with pkgs; [
             # formatter & linters
+            nixpkgs-fmt
+            shfmt
             astyle # 3.4.10
 
             # build dependencies
@@ -33,28 +35,23 @@
               direnv
               nix-direnv
 
-              # formatter & linters
-              nixpkgs-fmt
-              shfmt
-
               # debug dependencies
               openocd # 0.12.0
               python311Packages.pyserial # 3.5
             ];
 
             shellHook = ''
-              export PATH=$PWD/dev-support/bin:$PWD/scripts/ci:$PATH
+              export PATH=$PWD/scripts:$PWD/scripts/ci:$PATH
             '';
           };
 
           devShells.ci = with pkgs; mkShellNoCC {
             packages = core;
 
             shellHook = ''
-              export PATH=$PWD/dev-support/bin:$PWD/scripts/ci:$PATH
+              export PATH=$PWD/scripts/ci:$PATH
             '';
           };
-
         };
       flake = {
         # The usual flake attributes can be defined here, including system-
@@ -63,4 +60,4 @@
 
       };
     };
-}
+}
diff --git a/hal/devices.data b/hal/devices.data
@@ -1,3 +1,3 @@
 # SPDX-License-Identifier: Apache-2.0
 stm32f407vg stm32f4 ROM=1024K RAM=128K
-stm32f4 END ROM_OFF=0x08000000 RAM_OFF=0x20000000 CPU=cortex-m4 FPU=hard-fpv4-sp-d16
+stm32f4 END ROM_OFF=0x08000000 RAM_OFF=0x20000000 CPU=cortex-m4 FPU=hard-fpv4-sp-d16
diff --git a/mk/config.mk b/mk/config.mk
@@ -27,4 +27,4 @@ NTESTS ?= 1
 
 KEM_SCHEMES=mlkem512 mlkem768 mlkem1024
 # mlkem k
-KEM_PARAMS=2 3 4
+KEM_PARAMS=2 3 4
diff --git a/mk/schemes.mk b/mk/schemes.mk
@@ -56,4 +56,4 @@ $(foreach scheme,$(KEM_SCHEMES), \
 	$(eval $(call scheme-obj,$(scheme))))
 
 $(foreach scheme,$(KEM_SCHEMES), \
-	$(eval $(call scheme-test-obj,$(scheme))))
+	$(eval $(call scheme-test-obj,$(scheme))))
diff --git a/mlkem/api.h b/mlkem/api.h
@@ -64,4 +64,4 @@ int pqcrystals_mlkem1024_ref_enc_derand(uint8_t *ct, uint8_t *ss, const uint8_t
 int pqcrystals_mlkem1024_ref_enc(uint8_t *ct, uint8_t *ss, const uint8_t *pk);
 int pqcrystals_mlkem1024_ref_dec(uint8_t *ss, const uint8_t *ct, const uint8_t *sk);
 
-#endif
+#endif
diff --git a/mlkem/cbd.c b/mlkem/cbd.c
@@ -125,4 +125,4 @@ void poly_cbd_eta2(poly *r, const uint8_t buf[MLKEM_ETA2 * MLKEM_N / 4], int add
     #else
 #error "This implementation requires eta2 = 2"
     #endif
-}
+}
diff --git a/mlkem/cbd.h b/mlkem/cbd.h
@@ -12,4 +12,4 @@ void poly_cbd_eta1(poly *r, const uint8_t buf[MLKEM_ETA1 * MLKEM_N / 4], int add
 #define poly_cbd_eta2 MLKEM_NAMESPACE(poly_cbd_eta2)
 void poly_cbd_eta2(poly *r, const uint8_t buf[MLKEM_ETA2 * MLKEM_N / 4], int add);
 
-#endif
+#endif
diff --git a/mlkem/indcpa.h b/mlkem/indcpa.h
@@ -31,4 +31,4 @@ void indcpa_dec(uint8_t m[MLKEM_INDCPA_MSGBYTES],
                 const uint8_t c[MLKEM_INDCPA_BYTES],
                 const uint8_t sk[MLKEM_INDCPA_SECRETKEYBYTES]);
 
-#endif
+#endif
diff --git a/mlkem/kem.c b/mlkem/kem.c
@@ -159,4 +159,4 @@ int crypto_kem_dec(uint8_t *ss,
     cmov(ss, kr, MLKEM_SYMBYTES, (uint8_t) (1 - fail));
 
     return 0;
-}
+}
diff --git a/mlkem/kem.h b/mlkem/kem.h
@@ -33,4 +33,4 @@ int crypto_kem_enc(uint8_t *ct, uint8_t *ss, const uint8_t *pk);
 #define crypto_kem_dec MLKEM_NAMESPACE(dec)
 int crypto_kem_dec(uint8_t *ss, const uint8_t *ct, const uint8_t *sk);
 
-#endif
+#endif
diff --git a/mlkem/matacc.h b/mlkem/matacc.h
@@ -7,4 +7,4 @@
 #define matacc MLKEM_NAMESPACE(matacc)
 void matacc(poly *r, const polyvec *b, unsigned char i, const unsigned char *seed, int transposed);
 
-#endif
+#endif
diff --git a/mlkem/ntt.c b/mlkem/ntt.c
@@ -176,4 +176,4 @@ void basemul_acc(int16_t r[2], const int16_t a[2], const int16_t b[2], int16_t z
     r[0]  += fqmul(a0, b0);
     r[1]  += fqmul(a0, b1);
     r[1]  += fqmul(a1, b0);
-}
+}
diff --git a/mlkem/params.h b/mlkem/params.h
@@ -52,4 +52,4 @@
 #define MLKEM_SECRETKEYBYTES  (MLKEM_INDCPA_SECRETKEYBYTES + MLKEM_INDCPA_PUBLICKEYBYTES + 2*MLKEM_SYMBYTES)
 #define MLKEM_CIPHERTEXTBYTES (MLKEM_INDCPA_BYTES)
 
-#endif
+#endif
diff --git a/mlkem/poly.c b/mlkem/poly.c
@@ -628,4 +628,4 @@ void poly_sub(poly *r, const poly *a, const poly *b) {
     for (i = 0; i < MLKEM_N; i++) {
         r->coeffs[i] = a->coeffs[i] - b->coeffs[i];
     }
-}
+}
diff --git a/mlkem/polyvec.c b/mlkem/polyvec.c
@@ -244,4 +244,4 @@ void polyvec_add(polyvec *r, const polyvec *a, const polyvec *b) {
     for (i = 0; i < MLKEM_K; i++) {
         poly_add(&r->vec[i], &a->vec[i], &b->vec[i]);
     }
-}
+}
diff --git a/mlkem/polyvec.h b/mlkem/polyvec.h
@@ -34,4 +34,4 @@ void polyvec_reduce(polyvec *r);
 #define polyvec_add MLKEM_NAMESPACE(polyvec_add)
 void polyvec_add(polyvec *r, const polyvec *a, const polyvec *b);
 
-#endif
+#endif
diff --git a/mlkem/reduce.c b/mlkem/reduce.c
@@ -39,4 +39,4 @@ int16_t barrett_reduce(int16_t a) {
     t  = ((int32_t)v * a + (1 << 25)) >> 26;
     t *= MLKEM_Q;
     return a - t;
-}
+}
diff --git a/mlkem/reduce.h b/mlkem/reduce.h
@@ -14,4 +14,4 @@ int16_t montgomery_reduce(int32_t a);
 #define barrett_reduce MLKEM_NAMESPACE(barrett_reduce)
 int16_t barrett_reduce(int16_t a);
 
-#endif
+#endif
diff --git a/mlkem/symmetric-shake.c b/mlkem/symmetric-shake.c
@@ -68,4 +68,4 @@ void mlkem_shake256_rkprf(uint8_t out[MLKEM_SSBYTES], const uint8_t key[MLKEM_SY
     shake256_inc_absorb(&s, input, MLKEM_CIPHERTEXTBYTES);
     shake256_inc_finalize(&s);
     shake256_inc_squeeze(out, MLKEM_SSBYTES, &s);
-}
+}
diff --git a/mlkem/symmetric.h b/mlkem/symmetric.h
@@ -31,4 +31,4 @@ void mlkem_shake256_rkprf(uint8_t out[MLKEM_SSBYTES], const uint8_t key[MLKEM_SY
 #define prf(OUT, OUTBYTES, KEY, NONCE) mlkem_shake256_prf(OUT, OUTBYTES, KEY, NONCE)
 #define rkprf(OUT, KEY, INPUT) mlkem_shake256_rkprf(OUT, KEY, INPUT)
 
-#endif /* SYMMETRIC_H */
+#endif /* SYMMETRIC_H */
diff --git a/mlkem/verify.h b/mlkem/verify.h
@@ -13,4 +13,4 @@ int verify(const uint8_t *a, const uint8_t *b, size_t len);
 #define cmov MLKEM_NAMESPACE(cmov)
 void cmov(uint8_t *r, const uint8_t *x, size_t len, uint8_t b);
 
-#endif
+#endif
diff --git a/scripts/README.md b/scripts/README.md
@@ -16,17 +16,22 @@ experimental-features = nix-command flakes
 
 ### [direnv](https://direnv.net/)
 
+`direnv` is required to install before used, for installation guide please refer to https://direnv.net/docs/installation.html
+
 Enabling `direnv` would greatly enhance the development experience. Once enabled, all dependencies will be installed, and the shell will be augmented according to the specifications in [flake.nix](../flake.nix) whenever you enter the project directory from your shell. The initial setup might take a bit longer when entering the project directory for the first time.
 
-`direnv` can be enabled or disabled using `direnv allow` and `direnv deny` respectively. If you're new to `direnv`, it is also recommended to [integrate it with your shell](https://direnv.net/docs/hook.html) first.
+If you're new to `direnv`,  you must hook it into your shell first (e.x. append `eval "$(direnv hook bash)"` in `~/.bashrc` for `bash`), for other shells please refer to [hook direnv into your shell](https://direnv.net/docs/hook.html).
+After integrating `direnv` with your shell, it can be enabled or disabled using `direnv allow` and `direnv deny` respectively.
 
 ### Formatter and Linter
-- `nixpkgs-fmt` and `deadnix` for `Nix`
-- `shfmt` and `shellcheck` for shell script
+- `nixpkgs-fmt` for `Nix`
+- `shfmt` and for shell script
 - `astyle` for .c, .h files
 
-### Tools
+### Scripts
 
 When used together with direnv, the tools should be automatically discoverable by the shell.
 
-- [style](bin/style): Formatting, linting and spell checking all files
+- [format](format): Format all files
+- [lint](ci/lint): Lint all files
+- [test](ci/tests): Used for running func/speed/stack/nistkat tests
diff --git a/scripts/ci/lint b/scripts/ci/lint
diff --git a/scripts/ci/tests b/scripts/ci/tests
diff --git a/scripts/format b/scripts/format

Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,4 @@`
`13`	`13`
`14`	`14`	`* [ ] Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)? (If so, a version bump will be required from x.y.z to x.(y+1).0.)`
`15`	`15`
`16`		`-<!-- Once your pull request is ready for review and passing continuous integration tests, please convert from a draft PR to a normal PR, and request a review from one of the OQS core team members. -->`
	`16`	`+<!-- Once your pull request is ready for review and passing continuous integration tests, please convert from a draft PR to a normal PR, and request a review from one of the OQS core team members. -->`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@`
`3`	`3`
`4`	`4`	`# Code of Conduct`
`5`	`5`
`6`		`-Please see [open issue](https://github.com/pq-code-package/tsc/issues/9)`
	`6`	`+Please see [open issue](https://github.com/pq-code-package/tsc/issues/9)`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@`
`3`	`3`
`4`	`4`	`# Contributing`
`5`	`5`
`6`		`-to be completed`
	`6`	`+to be completed`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@`
`3`	`3`
`4`	`4`	`# Governance`
`5`	`5`
`6`		`-to be documented`
	`6`	`+to be documented`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@`
`3`	`3`
`4`	`4`	`# Security`
`5`	`5`
`6`		`-Please see [open issue](https://github.com/pq-code-package/tsc/issues/8)`
	`6`	`+Please see [open issue](https://github.com/pq-code-package/tsc/issues/8)`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@`
`3`	`3`
`4`	`4`	`# Support`
`5`	`5`
`6`		`-To be written.`
	`6`	`+To be written.`