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

Jump to bottom

Update sig_stfl Doxygen documentation #2059

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Update sig_stfl Doxygen documentation #2059

wants to merge 14 commits into from

Conversation

pablogf-uma
Copy link

@pablogf-uma pablogf-uma commented Jan 29, 2025 •
edited
Loading

Adds sig_stfl.h to the Doxyfile and includes Doxygen comments to the sig_stfl.h file.

Fixes #2016

New to this community. Please provide feedback and suggestions as you see fit. Thanks!

  • 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.)
  • Does this PR change the list of algorithms available -- either adding, removing, or renaming? Does this PR otherwise change an API? (If so, PRs in fully supported downstream projects dependent on these, i.e., oqs-provider will also need to be ready for review and merge by the time this is merged.)

@dstebila
Copy link
Member

Thanks for the contribution! The documentation generation runs locally for me. I'll let the CI run and then we can tag it ready for review. We will need you to update the PR with a "DCO sign-off"; you can see the instructions for this here: https://github.com/open-quantum-safe/liboqs/pull/2059/checks?check_run_id=36344707717

@pablogf-uma pablogf-uma force-pushed the add-sig-stfl-doc branch 2 times, most recently from b13d39a to 997d79b Compare January 30, 2025 08:27
dependabot bot and others added 2 commits January 30, 2025 09:44
@dependabot @pablogf-uma
Bump jinja2 in /scripts/copy_from_upstream in the pip group (open-qua…
b532543 
…ntum-safe#2036)

Bumps the pip group in /scripts/copy_from_upstream with 1 update: [jinja2](https://github.com/pallets/jinja).

Updates `jinja2` from 3.1.4 to 3.1.5
- [Release notes](https://github.com/pallets/jinja/releases)
- [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst)
- [Commits](pallets/jinja@3.1.4...3.1.5)

---
updated-dependencies:
- dependency-name: jinja2
  dependency-type: direct:production
  dependency-group: pip
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: Pablo Gutiérrez <pablogf@MSI.>
Signed-off-by: Pablo Gutiérrez <[email protected]>
@ueno @pablogf-uma
Avoid unresolved symbols from libcrypto when compiled with OQS_DLOPEN…
9136dd7 
…_OPENSSL (open-quantum-safe#2043)

* Do not assume OpenSSL memory functions when libcrypto is dlopened

Otherwise, when the OQS_DLOPEN_OPENSSL is defined but OpenSSL is
used only partially, e.g., with OQS_USE_SHA3_OPENSSL=ON, there will be
some unresolved symbols in the final artifact:

```
$ cmake -GNinja -DBUILD_SHARED_LIBS=ON -DOQS_USE_AES_OPENSSL=ON -DOQS_USE_AES_INSTRUCTIONS=OFF -DOQS_DIST_BUILD=ON -DOQS_USE_SHA3_OPENSSL=ON -DOQS_DLOPEN_OPENSSL=ON -DCMAKE_BUILD_TYPE=Debug -LAH ..
$ ninja
$ nm -g lib/liboqs.so.0.12.1-dev | grep '^[[:space:]]*U '
                 U __assert_fail@GLIBC_2.2.5
                 U CRYPTO_free
                 U CRYPTO_malloc
                 U dlopen@GLIBC_2.34
                 U dlsym@GLIBC_2.34
```

Signed-off-by: Daiki Ueno <[email protected]>

* Wrap OpenSSL memory functions with OSSL_FUNC

This enables those OpenSSL memory functions can be either resolved at
build time or at run-time through dlopen. Note that we use CRYPTO_*
functions instead of OPENSSL_* as the latter are defined as a macro
and cannot be dynamically resolved.

Signed-off-by: Daiki Ueno <[email protected]>

---------

Signed-off-by: Daiki Ueno <[email protected]>
Signed-off-by: Pablo Gutiérrez <pablogf@MSI.>
Signed-off-by: Pablo Gutiérrez <[email protected]>
pablogf-uma and others added 9 commits January 30, 2025 10:04
@pablogf-uma
Added sig_stfl.h path to .Doxyfile INPUT setting
6cc9ef1 
Signed-off-by: Pablo Gutiérrez <[email protected]>
@pablogf-uma
added sig_stfl path to .Doxyfile INPUT setting
27e3cff 
Signed-off-by: Pablo Gutiérrez <[email protected]>
@SWilson4 @pablogf-uma
Update to public Ubuntu 24.04 ARM runner [full tests] (open-quantum-s…
d504307 
…afe#2050)

Signed-off-by: Spencer Wilson <[email protected]>
Signed-off-by: Pablo Gutiérrez <[email protected]>
@pablogf-uma
Added Doxygen comments of algorithm identifiers until XMSSMT
d1698a3 
Signed-off-by: Pablo Gutiérrez <[email protected]>
@pablogf-uma
commit
e14998d 
Signed-off-by: Pablo Gutiérrez <[email protected]>
@stevenireeves @praveksharma @pablogf-uma
NVIDIA: Adding cuPQC as a backend for ML-KEM. (open-quantum-safe#2044)
6bb2603 
* Adding cuPQC as a backend for ML-KEM.

Signed-off-by: Steven Reeves <[email protected]>

* Fixing transposition error that left out OQS_USE_CUPQC in CMake system.

Signed-off-by: Steven Reeves <[email protected]>

* Add CMake dependent options for cupqc. Fixed formatting in kem_ml_kem_####.c and kem/family/kem_scheme.c

Signed-off-by: Steven Reeves <[email protected]>

* Move cupqc_ml-kem source files to correctly named dir

Signed-off-by: Pravek Sharma <[email protected]>

* Stop piggybacking on pqcrystals-kyber-standard and move cupqc_ml-kem metadata to separate upstream repo

Signed-off-by: Pravek Sharma <[email protected]>

* Update licensing information

Signed-off-by: Pravek Sharma <[email protected]>

* Update PLATFORMS.md

Signed-off-by: Pravek Sharma <[email protected]>

* Fix kem_family cmakelists template

Signed-off-by: Pravek Sharma <[email protected]>

* Run copy_from_upsream.py and pull updated upstream

Signed-off-by: Pravek Sharma <[email protected]>

* Add cupqc build test to basic.yml

Signed-off-by: Pravek Sharma <[email protected]>

* Move cupqc build test from basic.yml to linux.yml

Signed-off-by: Pravek Sharma <[email protected]>

* Fix error in linux.yml

Signed-off-by: Pravek Sharma <[email protected]>

* fixup! Fix error in linux.yml

Signed-off-by: Pravek Sharma <[email protected]>

* Redo cupqc build check

Signed-off-by: Pravek Sharma <[email protected]>

* Supply default CUDA arch to cupqc-buildcheck configuration stage

Signed-off-by: Pravek Sharma <[email protected]>

* Specify CUDAXX in cupqc-buildcheck

Signed-off-by: Pravek Sharma <[email protected]>

* Make cuPQC_DIR explicit in cupqc-buildcheck

Signed-off-by: Pravek Sharma <[email protected]>

---------

Signed-off-by: Steven Reeves <[email protected]>
Signed-off-by: Pravek Sharma <[email protected]>
Co-authored-by: Pravek Sharma <[email protected]>
Signed-off-by: Pablo Gutiérrez <pablogf@MSI.>
Signed-off-by: Pablo Gutiérrez <[email protected]>
@pablogf-uma
added all algorithm identifiers Doxyfile comments for sig_stfl
1128006 
Signed-off-by: Pablo Gutiérrez <[email protected]>
@pablogf-uma
added additional Doxygen comments to sig_stfl.h
6e569f2 
Signed-off-by: Pablo Gutiérrez <[email protected]>
@pablogf-uma
fixed formatting
2b1ca4d 
Signed-off-by: Pablo Gutiérrez <[email protected]>
@pablogf-uma
fixed return types errors
0f1a981 
Signed-off-by: Pablo Gutiérrez <[email protected]>
@pablogf-uma
Copy link
Author

@dstebila I believe I fixed the "DCO sign-off" issue, sorry about that. Let me know if you need anything else from me.

@pablogf-uma pablogf-uma requested a review from dstebila January 30, 2025 14:50
@dstebila dstebila marked this pull request as ready for review January 30, 2025 16:12
@dstebila dstebila requested a review from baentsch as a code owner January 30, 2025 16:12
@dstebila
Copy link
Member

Thanks Pablo! Looks good to me. Once we get a second review we can merge it in.

@baentsch
Copy link
Member

Hmm -- just wanted to merge -- but this doesn't look like a clean re-base @pablogf-uma : Could you please check this? The PR should not contain references to commits already merged: The commit log/history would be very "dirty".

@dstebila
Copy link
Member

Hmm -- just wanted to merge -- but this doesn't look like a clean re-base @pablogf-uma : Could you please check this? The PR should not contain references to commits already merged: The commit log/history would be very "dirty".

It'll be a squash-and-merge, so doesn't that mean that this commit won't show the actual history, only the effective diff? And from the code review, the effective diff is clean.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@baentsch baentsch baentsch approved these changes

@SWilson4 SWilson4 SWilson4 approved these changes

@dstebila dstebila dstebila approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update Doxygen documentation
6 participants
@pablogf-uma @dstebila @baentsch @SWilson4 @ueno @stevenireeves