ML-KEM initial doc update#26217

Closed

vdukhovni wants to merge 6 commits intoopenssl:feature/ml-kemfrom

vdukhovni:ml-kem-initial-doc-update

vdukhovni commented Dec 19, 2024 •

edited by kroeckx

Loading

This has the soon to be merged #26172 as merge base.
Only the documentation changes are part of this PR, which can be reviewed as convenient, but should only merged after rebasing post the merge of #26172.

Note, this also contains non-ML-KEM-specific changes to the documentation of encapsulate and decapsulate, that make it clear that the length pointers of the output buffers are not optional and MUST be initialised correctly to signal the available space.

Checklist

documentation is added or updated

github-actions bot added the severity: fips change label

vdukhovni mentioned this pull request

EVP_PKEY_decapsulate and EVP_PKEY_encapsulate docs inconsistent with extant providers #26209

Open

vdukhovni force-pushed the ml-kem-initial-doc-update branch 6 times, most recently from 6b6a0c0 to 1d03524 Compare

December 20, 2024 03:19

github-actions bot removed the severity: fips change label

openssl-machine force-pushed the feature/ml-kem branch from a9f54a4 to f21fe9b Compare

December 20, 2024 08:50

Viktor Dukhovni added 2 commits

December 20, 2024 20:40


          Initial batch of ML-KEM doc updates.

878e5c2

With the soon-to-be-merged ML-KEM openssl#26172 as the merge base.


          Remaining batch of ML-KEM-related doc updates

0ce9d7f

vdukhovni force-pushed the ml-kem-initial-doc-update branch from 1d03524 to 0ce9d7f Compare

December 20, 2024 09:41

mattcaswell requested changes

View reviewed changes

doc/HOWTO/keys.txt Outdated Show resolved Hide resolved

doc/man1/openssl-genpkey.pod.in Outdated Show resolved Hide resolved

doc/man3/EVP_PKEY_fromdata.pod Outdated Show resolved Hide resolved

doc/man3/EVP_PKEY_set1_encoded_public_key.pod Outdated Show resolved Hide resolved

doc/man3/SSL_CONF_cmd.pod Show resolved Hide resolved

doc/man7/OSSL_PROVIDER-default.pod Outdated Show resolved Hide resolved


          fixup! Remaining batch of ML-KEM-related doc updates

206d857

Matt Caswell review

mattcaswell requested changes

View reviewed changes

doc/man3/EVP_PKEY_fromdata.pod Outdated Show resolved Hide resolved

vdukhovni force-pushed the ml-kem-initial-doc-update branch 2 times, most recently from 8bcef61 to 084705f Compare

December 24, 2024 01:21


          fixup! fixup! Remaining batch of ML-KEM-related doc updates

4ed9874

Matt Caswell review

vdukhovni force-pushed the ml-kem-initial-doc-update branch from 084705f to 4ed9874 Compare

December 24, 2024 02:25

vdukhovni requested a review from mattcaswell

December 24, 2024 02:36

mattcaswell approved these changes

View reviewed changes

vdukhovni requested review from nhorman and t8m

December 26, 2024 18:32

vdukhovni mentioned this pull request

ML-KEM hybrids for TLS #26220

Closed


          fixup! fixup! fixup! Remaining batch of ML-KEM-related doc updates

51d0fb2

vdukhovni force-pushed the ml-kem-initial-doc-update branch from fab743c to 51d0fb2 Compare

December 27, 2024 05:36

t-j-h reviewed

View reviewed changes

doc/man3/EVP_PKEY_decapsulate.pod Outdated Show resolved Hide resolved

t-j-h reviewed

View reviewed changes

doc/man3/EVP_PKEY_CTX_ctrl.pod Outdated Show resolved Hide resolved

t-j-h reviewed

View reviewed changes

doc/man3/EVP_PKEY_set1_encoded_public_key.pod Outdated Show resolved Hide resolved

vdukhovni pushed a commit to vdukhovni/openssl that referenced this pull request


          Initial batch of ML-KEM doc updates.

c78a6ae

With the soon-to-be-merged ML-KEM openssl#26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

vdukhovni pushed a commit to vdukhovni/openssl that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

f9108fd

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

vdukhovni pushed a commit to vdukhovni/openssl that referenced this pull request


          Initial batch of ML-KEM doc updates.

d81f66b

With the soon-to-be-merged ML-KEM openssl#26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

vdukhovni pushed a commit to vdukhovni/openssl that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

97eb693

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

vdukhovni pushed a commit to vdukhovni/openssl that referenced this pull request


          Initial batch of ML-KEM doc updates.

37dedf7

With the soon-to-be-merged ML-KEM openssl#26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

vdukhovni pushed a commit to vdukhovni/openssl that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

9222c19

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

openssl-machine pushed a commit that referenced this pull request


          Initial batch of ML-KEM doc updates.

ae812c3

With the soon-to-be-merged ML-KEM #26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

8e21684

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Initial batch of ML-KEM doc updates.

e2afd15

With the soon-to-be-merged ML-KEM #26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

346ceb8

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Initial batch of ML-KEM doc updates.

40d394b

With the soon-to-be-merged ML-KEM #26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

9bfa189

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Initial batch of ML-KEM doc updates.

dcb54fe

With the soon-to-be-merged ML-KEM #26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Initial batch of ML-KEM doc updates.

9eea747

With the soon-to-be-merged ML-KEM #26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

9a19a8c

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Initial batch of ML-KEM doc updates.

484deb0

With the soon-to-be-merged ML-KEM #26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

af907f2

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Initial batch of ML-KEM doc updates.

71d2861

With the soon-to-be-merged ML-KEM #26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

5db03a2

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

vdukhovni pushed a commit to vdukhovni/openssl that referenced this pull request


          Initial batch of ML-KEM doc updates.

0b4b70e

With the soon-to-be-merged ML-KEM openssl#26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

vdukhovni pushed a commit to vdukhovni/openssl that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

d97062f

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

openssl-machine pushed a commit that referenced this pull request


          Initial batch of ML-KEM doc updates.

7772dbb

With the soon-to-be-merged ML-KEM #26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

openssl-machine pushed a commit that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

e04a604

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from #26217)

definability pushed a commit to definability/openssl that referenced this pull request


          Initial batch of ML-KEM doc updates.

449c30b

With the soon-to-be-merged ML-KEM openssl#26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

definability pushed a commit to definability/openssl that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

741367d

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

quarckster pushed a commit to quarckster/openssl-fork that referenced this pull request


          Initial batch of ML-KEM doc updates.

85e6908

With the soon-to-be-merged ML-KEM openssl#26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

quarckster pushed a commit to quarckster/openssl-fork that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

e33c064

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

DDvO pushed a commit to siemens/openssl that referenced this pull request


          Initial batch of ML-KEM doc updates.

fbb4c0a

With the soon-to-be-merged ML-KEM openssl#26172 as the merge base.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

DDvO pushed a commit to siemens/openssl that referenced this pull request


          Remaining batch of ML-KEM-related doc updates

7dee180

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tim Hudson <tjh@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from openssl#26217)

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

Labels

approval: ready to merge tests: exempted triaged: bug triaged: documentation