open-quantum-safe / liboqs / 25798125987
82%

DEFAULT BRANCH: main
Ran
Jobs 3
Files 2878
Run time 5min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 82.276% (+0.006%) from 82.27%
25798125987

push

github

web-flow 
Create a table of algorithm support levels (#2413)

* Document per-algorithm support levels

Adds three top-level fields to every algorithm YAML datasheet —
`upstream-maintenance`, `upstream-statement-url`, and `oqs-support-tier`
— and extends the generators to render them into the README support
table, a new top-level ALGORITHMS.md, and a Support section on each
per-algorithm page.

ALGORITHMS.md hosts the authoritative upstream-maintenance vocabulary
and OQS support-tier definitions inline, with three generated summary
tables (one per algorithm category) spliced between
`OQS_TEMPLATE_FRAGMENT_ALGORITHMS_*` markers. Everything else in
ALGORITHMS.md is hand-maintained and can be edited directly.

Initial tier assignments: Tier 1 ML-KEM; Tier 2 FrodoKEM, HQC, ML-DSA,
LMS, XMSS; Tier 3 all remaining families. ML-KEM and ML-DSA start with
`upstream-maintenance: Actively maintained`; Classic McEliece starts
with `No active maintenance` citing PQClean's wind-down; every other
family starts at `TBD` pending outreach.

A new `docs-sync` CI workflow regenerates the docs from the YAMLs on
every PR touching the algorithm sources and fails if the generated
content drifts. Introduces `tests/test_alg_support_generators.py`
covering the new columns, vocabulary glossary, and per-family row shape.

Fixes #2045.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>

* Regenerate algorithm support tables and per-algorithm pages

Runs scripts/update_docs_from_yaml.py against the support-level YAML
fields and fragment-marker infrastructure added in the previous commit.
This populates the algorithm-support table in README.md, the three
per-category summary tables in ALGORITHMS.md, and a Support section on
every per-algorithm markdown page.

Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca>

* Limit scope of GitHub token in workflow

Co-authored-by: Copilot Autofix powered by AI <62310815+github-a... (continued)

207990 of 252797 relevant lines covered (82.28%)

8206659.7 hits per line

Coverage Regressions

Lines Coverage ∆ File
3
96.44
 -0.27% src/sig/falcon/pqclean_falcon-1024_aarch64/keygen.c
3
96.23
 -0.26% src/sig/falcon/pqclean_falcon-1024_avx2/keygen.c
2
61.99
 -0.45% src/sig/ml_dsa/mldsa-native_ml-dsa-87_x86_64/mldsa/src/sign.c
1
98.36
 -1.64% src/kem/classic_mceliece/pqclean_mceliece460896_clean/encrypt.c
1
95.92
 -2.04% src/kem/classic_mceliece/pqclean_mceliece460896f_avx2/encrypt.c
1
97.3
 -1.35% src/kem/classic_mceliece/pqclean_mceliece8192128_clean/pk_gen.c
1
95.53
 -0.09% src/sig/falcon/pqclean_falcon-512_avx2/keygen.c
1
33.33
 -4.17% src/sig/ml_dsa/mldsa-native_ml-dsa-87_x86_64/mldsa/src/rounding.h
Jobs
ID Job ID Ran Files Coverage
1 x64-generic - 25798125987.1 1259
85.37
 GitHub Action Run
2 arm64-distbuild - 25798125987.2 1789
60.29
 GitHub Action Run
3 x64-distbuild - 25798125987.3 2347
56.51
 GitHub Action Run
Source Files on build 25798125987