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

Adding multiple upstream support to doc generation #1123

Merged
merged 44 commits into from
Nov 18, 2021
Merged

Adding multiple upstream support to doc generation #1123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
73363d7
currently there is a bug where pytest doesn't work but the individual…
Martyrshot Oct 18, 2021
832a4cb
Fix an issue where run_tests tried to run tests from upstream. Fix by…
Martyrshot Oct 19, 2021
2c0fd78
No longer checking spdx on files copied from upstream
Martyrshot Oct 19, 2021
acfcd55
pqclean's aarch64 kyber implementation is now being pulled from. Stil…
Martyrshot Oct 31, 2021
b4e3cce
Merge branch 'open-quantum-safe:main' into main
Martyrshot Oct 31, 2021
af487fe
pqclean kyber fragment was left behind. It's now added
Martyrshot Oct 31, 2021
e1c43c4
Merge branch 'main' of github.com:Martyrshot/liboqs into main
Martyrshot Oct 31, 2021
45b8c0f
Added compiler checking for gcc. Must be at least 9.4.0. Need to trac…
Martyrshot Oct 31, 2021
57c5787
Need to figure out how to handle commen dependencies from multiple up…
Martyrshot Oct 31, 2021
e31535f
Cleaned up copy_from_upstream.py a bit
Martyrshot Nov 1, 2021
780033f
Added pqclean's aarch64 optimized kyber implementation to liboqs
Martyrshot Nov 1, 2021
7dfb795
Added pqclean's aarch64 optimized kyber implementation to liboqs
Martyrshot Nov 1, 2021
50268fb
Fixed an isssue where 'empty' conditionals were added to kem_scheme.c…
Martyrshot Nov 2, 2021
462c53b
reverting sabre to version prior to updated copy_from_upstream script
Martyrshot Nov 2, 2021
7637dc1
Merge branch 'open-quantum-safe:main' into main
Martyrshot Nov 9, 2021
848b347
stripping asimd flag for ARM64_V8 as it isn't needed and will cause e…
Martyrshot Nov 9, 2021
145973a
Fixed an issue where empty conditionals would appear when no required…
Martyrshot Nov 9, 2021
4709a71
Updated kyber docs
Martyrshot Nov 10, 2021
d772d8e
Updated kyber docs with better formatting
Martyrshot Nov 10, 2021
00cfdff
Adding updated kyber documentation
Martyrshot Nov 10, 2021
0cabbaf
Reverting documentation that was erroniously updated while updating k…
Martyrshot Nov 10, 2021
d8da8c5
Reverted ntruprime too far back by mistake
Martyrshot Nov 10, 2021
93cf74a
Updated kyber doc's yml no-secret-dependent-branching-checked-by-valg…
Martyrshot Nov 10, 2021
55a92f2
Updated kyber markdown so that no-secret-dependent-branching-checked-…
Martyrshot Nov 10, 2021
8a5f523
Merge branch 'open-quantum-safe:main' into main
Martyrshot Nov 15, 2021
0889de0
Fixed some whitespace issues
Martyrshot Nov 16, 2021
e803f85
Merge branch 'main' of github.com:Martyrshot/liboqs
Martyrshot Nov 16, 2021
598dad6
Added automated updating of legacy yaml format, and added some yaml f…
Martyrshot Nov 16, 2021
aa4beb1
Added nicer formatting warning message
Martyrshot Nov 16, 2021
98832f5
Fixed a bug where optimized upstreams would use the primary upstream'…
Martyrshot Nov 16, 2021
36590a6
Updated kyber yaml from hand edited to script generated
Martyrshot Nov 16, 2021
a562991
Removed a debugging print that was left in by mistake
Martyrshot Nov 16, 2021
a608488
Fixed an indenting issue in templates
Martyrshot Nov 16, 2021
7629c08
Fixed a whitespace issue in kyber_scheme.c files
Martyrshot Nov 16, 2021
8bdd952
Fixed some style issues using astyle
Martyrshot Nov 16, 2021
894afb9
Fixed a bug with copy_from_upstream.py's verify function where it wou…
Martyrshot Nov 17, 2021
5769698
Added reporting for implementations that are in upstream but aren't y…
Martyrshot Nov 17, 2021
6af2f4e
Added support to ignore implementations from upstream in copy_from_up…
Martyrshot Nov 17, 2021
3c73716
Fixed a bug with ignoring implementations in default upstream
Martyrshot Nov 17, 2021
6d6f32d
Adding updated ymls and md files for docs
Martyrshot Nov 17, 2021
a948899
Fixed some whitespace style issues with kyber.c files.
Martyrshot Nov 17, 2021
350f7a4
copy_from_upstream.py now also calls update_docs_from_yaml.py
Martyrshot Nov 17, 2021
0e9174e
Fixed a formatting issue on key_scheme.c template that caused style i…
Martyrshot Nov 17, 2021
e7da166
fixed an issue where arch specific implementations were never added w…
Martyrshot Nov 17, 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
22 changes: 12 additions & 10 deletions docs/algorithms/kem/bike.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@
- **Principal submitters**: Nicolas Aragon, Paulo Barreto, Slim Bettaieb, Loic Bidoux, Olivier Blazy, Jean-Christophe Deneuville, Phillipe Gaborit, Santosh Gosh, Shay Gueron, Tim Güneysu, Carlos Aguilar Melchor, Rafael Misoczki, Edoardo Persichetti, Nicolas Sendrier, Jean-Pierre Tillich, Valentin Vasseur, Gilles Zémor.
- **Authors' website**: http://bikesuite.org/
- **Specification version**: 4.1.
- **Implementation source**: https://github.com/awslabs/bike-kem, which takes it from:
- **Primary Source**<a name="primary-source"></a>:
- **Source**: https://github.com/awslabs/bike-kem
- **Implementation license (SPDX-Identifier)**: Apache-2.0
, which takes it from:
- https://bikesuite.org/files/v4.1/Reference_Implementation.2020.10.20.2.zip
- **Implementation license (SPDX-Identifier)**: Apache-2.0.

## Parameter set summary

Expand All @@ -18,21 +20,21 @@

## BIKE-L1 implementation characteristics

| 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?‡ |
|:------------------------:|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:----------------------|
| master | little endian | All | None | True | True | False |
| master | x86\_64 | Linux,Darwin | AVX2,AVX512,PCLMUL,SSE2 | True | True | False |
| Implementation source | 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?‡ |
|:---------------------------------:|:-------------------------|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:----------------------|
| [Primary Source](#primary-source) | master | little endian | All | None | True | True | False |
| [Primary Source](#primary-source) | master | x86\_64 | Linux,Darwin | AVX2,AVX512,PCLMUL,SSE2 | True | True | False |

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

‡For an explanation of what this denotes, consult the [Explanation of Terms](#explanation-of-terms) section at the end of this file.

## BIKE-L3 implementation characteristics

| 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? |
|:------------------------:|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
| master | little endian | All | None | True | True | False |
| master | x86\_64 | Linux,Darwin | AVX2,AVX512,PCLMUL,SSE2 | True | True | False |
| Implementation source | 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? |
|:---------------------------------:|:-------------------------|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------|
| [Primary Source](#primary-source) | master | little endian | All | None | True | True | False |
| [Primary Source](#primary-source) | master | x86\_64 | Linux,Darwin | AVX2,AVX512,PCLMUL,SSE2 | True | True | False |

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

Expand Down
17 changes: 11 additions & 6 deletions docs/algorithms/kem/bike.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ crypto-assumption: QC-MDPC (Quasi-Cyclic Moderate Density Parity-Check)
website: http://bikesuite.org/
nist-round: 3
spec-version: 4.1
spdx-license-identifier: Apache-2.0
upstream: https://github.com/awslabs/bike-kem
primary-upstream:
source: https://github.com/awslabs/bike-kem
spdx-license-identifier: Apache-2.0
upstream-ancestors:
- https://bikesuite.org/files/v4.1/Reference_Implementation.2020.10.20.2.zip
parameter-sets:
Expand All @@ -36,15 +37,17 @@ parameter-sets:
length-shared-secret: 32
implementations-switch-on-runtime-cpu-features: true
implementations:
- upstream-id: master
- upstream: primary-upstream
upstream-id: master
supported-platforms:
- architecture: little endian
operating_systems:
- All
no-secret-dependent-branching-claimed: true
no-secret-dependent-branching-checked-by-valgrind: true
large-stack-usage: false
- upstream-id: master
- upstream: primary-upstream
upstream-id: master
supported-platforms:
- architecture: x86_64
operating_systems:
Expand All @@ -69,15 +72,17 @@ parameter-sets:
length-shared-secret: 32
implementations-switch-on-runtime-cpu-features: true
implementations:
- upstream-id: master
- upstream: primary-upstream
upstream-id: master
supported-platforms:
- architecture: little endian
operating_systems:
- All
no-secret-dependent-branching-claimed: true
no-secret-dependent-branching-checked-by-valgrind: true
large-stack-usage: false
- upstream-id: master
- upstream: primary-upstream
upstream-id: master
supported-platforms:
- architecture: x86_64
operating_systems:
Expand Down
Loading