Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

do full upstream doc generation [skip ci] #1066

Merged
merged 3 commits into from
Sep 14, 2021
Merged

do full upstream doc generation [skip ci] #1066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f943d7
do full upstream doc generation [skip ci]
baentsch Aug 4, 2021
559567f
corrected upstream information; all generate scripts run
baentsch Sep 14, 2021
43d64ac
sort required_flags [skip ci]
baentsch Sep 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/algorithms/kem/kyber.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage?‡ |
|:------------------------:|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:----------------------|
| ref | All | All | None | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | AVX2,POPCNT,BMI2 | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | AVX2,BMI2,POPCNT | True | True | False |

Are implementations chosen based on runtime CPU feature detection? **Yes**.

Expand All @@ -36,7 +36,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
| Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? |
|:------------------------:|:----------------------------|:--------------------------------|:--------------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
| ref | All | All | None | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | SSE2,POPCNT,BMI2,SSSE3,AVX2,AES | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | AES,AVX2,BMI2,POPCNT,SSE2,SSSE3 | True | True | False |

Are implementations chosen based on runtime CPU feature detection? **Yes**.

Expand All @@ -45,7 +45,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
| Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? |
|:------------------------:|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
| ref | All | All | None | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | AVX2,POPCNT,BMI2 | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | AVX2,BMI2,POPCNT | True | True | False |

Are implementations chosen based on runtime CPU feature detection? **Yes**.

Expand All @@ -54,7 +54,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
| Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? |
|:------------------------:|:----------------------------|:--------------------------------|:--------------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
| ref | All | All | None | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | SSE2,POPCNT,BMI2,SSSE3,AVX2,AES | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | AES,AVX2,BMI2,POPCNT,SSE2,SSSE3 | True | True | False |

Are implementations chosen based on runtime CPU feature detection? **Yes**.

Expand All @@ -63,7 +63,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
| Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? |
|:------------------------:|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
| ref | All | All | None | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | AVX2,POPCNT,BMI2 | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | AVX2,BMI2,POPCNT | True | True | False |

Are implementations chosen based on runtime CPU feature detection? **Yes**.

Expand All @@ -72,7 +72,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
| Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? |
|:------------------------:|:----------------------------|:--------------------------------|:--------------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
| ref | All | All | None | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | SSE2,POPCNT,BMI2,SSSE3,AVX2,AES | True | True | False |
| avx2 | x86\_64 | Linux,Darwin | AES,AVX2,BMI2,POPCNT,SSE2,SSSE3 | True | True | False |

Are implementations chosen based on runtime CPU feature detection? **Yes**.

Expand Down
30 changes: 15 additions & 15 deletions docs/algorithms/kem/kyber.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ parameter-sets:
- Darwin
required_flags:
- avx2
- popcnt
- bmi2
- popcnt
common-crypto:
- SHA3: liboqs
no-secret-dependent-branching-claimed: true
Expand Down Expand Up @@ -75,12 +75,12 @@ parameter-sets:
- Linux
- Darwin
required_flags:
- sse2
- popcnt
- aes
- avx2
- bmi2
- popcnt
- sse2
- ssse3
- avx2
- aes
common-crypto:
- AES: pqcrystals-kyber_common_aes
- SHA3: liboqs
Expand Down Expand Up @@ -111,8 +111,8 @@ parameter-sets:
- Darwin
required_flags:
- avx2
- popcnt
- bmi2
- popcnt
common-crypto:
- SHA3: liboqs
no-secret-dependent-branching-claimed: true
Expand Down Expand Up @@ -142,12 +142,12 @@ parameter-sets:
- Linux
- Darwin
required_flags:
- sse2
- popcnt
- aes
- avx2
- bmi2
- popcnt
- sse2
- ssse3
- avx2
- aes
common-crypto:
- AES: pqcrystals-kyber_common_aes
- SHA3: liboqs
Expand Down Expand Up @@ -178,8 +178,8 @@ parameter-sets:
- Darwin
required_flags:
- avx2
- popcnt
- bmi2
- popcnt
common-crypto:
- SHA3: liboqs
no-secret-dependent-branching-claimed: true
Expand Down Expand Up @@ -209,12 +209,12 @@ parameter-sets:
- Linux
- Darwin
required_flags:
- sse2
- popcnt
- aes
- avx2
- bmi2
- popcnt
- sse2
- ssse3
- avx2
- aes
common-crypto:
- AES: pqcrystals-kyber_common_aes
- SHA3: liboqs
Expand Down
6 changes: 3 additions & 3 deletions docs/algorithms/sig/dilithium.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
| Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? |
|:------------------------:|:----------------------------|:--------------------------------|:---------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
| ref | All | All | None | True | True | False |
| avx2 | x86\_64 | Darwin,Linux | SSE2,POPCNT,SSSE3,AVX2,AES | True | True | False |
| avx2 | x86\_64 | Darwin,Linux | AES,AVX2,POPCNT,SSE2,SSSE3 | True | True | False |

Are implementations chosen based on runtime CPU feature detection? **Yes**.

Expand All @@ -63,7 +63,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
| Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? |
|:------------------------:|:----------------------------|:--------------------------------|:---------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
| ref | All | All | None | True | True | False |
| avx2 | x86\_64 | Darwin,Linux | SSE2,POPCNT,SSSE3,AVX2,AES | True | True | False |
| avx2 | x86\_64 | Darwin,Linux | AES,AVX2,POPCNT,SSE2,SSSE3 | True | True | False |

Are implementations chosen based on runtime CPU feature detection? **Yes**.

Expand All @@ -72,7 +72,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
| Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? |
|:------------------------:|:----------------------------|:--------------------------------|:---------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
| ref | All | All | None | True | True | False |
| avx2 | x86\_64 | Darwin,Linux | SSE2,POPCNT,SSSE3,AVX2,AES | True | True | False |
| avx2 | x86\_64 | Darwin,Linux | AES,AVX2,POPCNT,SSE2,SSSE3 | True | True | False |

Are implementations chosen based on runtime CPU feature detection? **Yes**.

Expand Down
18 changes: 9 additions & 9 deletions docs/algorithms/sig/dilithium.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,11 @@ parameter-sets:
- Darwin
- Linux
required_flags:
- sse2
- aes
- avx2
- popcnt
- sse2
- ssse3
- avx2
- aes
common-crypto:
- AES: pqcrystals
- SHA3: liboqs
Expand Down Expand Up @@ -168,11 +168,11 @@ parameter-sets:
- Darwin
- Linux
required_flags:
- sse2
- aes
- avx2
- popcnt
- sse2
- ssse3
- avx2
- aes
common-crypto:
- AES: pqcrystals
- SHA3: liboqs
Expand Down Expand Up @@ -202,11 +202,11 @@ parameter-sets:
- Darwin
- Linux
required_flags:
- sse2
- aes
- avx2
- popcnt
- sse2
- ssse3
- avx2
- aes
common-crypto:
- AES: pqcrystals
- SHA3: liboqs
Expand Down
2 changes: 1 addition & 1 deletion docs/algorithms/sig/sphincs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- **Auxiliary submitters**: Jean-Philippe Aumasson, Daniel J. Bernstein,, Christoph Dobraunig, Maria Eichlseder, Scott Fluhrer, Stefan-Lukas Gazdag, Panos Kampanakis, Stefan Kölbl, Tanja Lange, Martin M. Lauridsen, Florian Mendel, Ruben Niederhagen, Christian Rechberger, Joost Rijneveld, Peter Schwabe.
- **Authors' website**: https://sphincs.org/
- **Specification version**: NIST Round 3 submission.
- **Implementation source**: https://github.com/PQClean/PQClean/commit/6c1ea921ee4a06a6b50c742ca540bb9b5e51aee2, which takes it from:
- **Implementation source**: https://github.com/PQClean/PQClean/commit/6c1ea921ee4a06a6b50c742ca540bb9b5e51aee2 with copy_from_upstream patches, which takes it from:
- https://github.com/sphincs/sphincsplus
- **Implementation license (SPDX-Identifier)**: CC0-1.0.

Expand Down
1 change: 1 addition & 0 deletions docs/algorithms/sig/sphincs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ nist-round: 3
spec-version: NIST Round 3 submission
spdx-license-identifier: CC0-1.0
upstream: https://github.com/PQClean/PQClean/commit/6c1ea921ee4a06a6b50c742ca540bb9b5e51aee2
with copy_from_upstream patches
upstream-ancestors:
- https://github.com/sphincs/sphincsplus
parameter-sets:
Expand Down
3 changes: 2 additions & 1 deletion scripts/copy_from_upstream/copy_from_upstream.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
from pathlib import Path
import sys
import json
import update_upstream_alg_docs

# kats of all algs
kats = {}
Expand Down Expand Up @@ -512,7 +513,7 @@ def copy_from_upstream():
if not keepdata:
shutil.rmtree('repos')

print("Remember to update the docs by running update_pqclean_alg_docs.py")
update_upstream_alg_docs.do_it(os.environ['LIBOQS_DIR'])


def verify_from_upstream():
Expand Down
Loading