Skip to content

feat(linux): Add Post Quantum Cryptography documentation#702

Open
ti-kamlesh wants to merge 1 commit into
TexasInstruments:masterfrom
ti-kamlesh:pqc-fork
Open

feat(linux): Add Post Quantum Cryptography documentation#702
ti-kamlesh wants to merge 1 commit into
TexasInstruments:masterfrom
ti-kamlesh:pqc-fork

Conversation

@ti-kamlesh
Copy link
Copy Markdown
Contributor

Add PQC documentation page covering NIST-standardized algorithms (ML-KEM, ML-DSA, SLH-DSA) supported via OpenSSL 3.5.x out of the box.

Enable the page for all devices with OpenSSL 3.5.x support:

  • AM62AX, AM62DX, AM62LX, AM62PX, AM62X
  • AM64X
  • J721E, J721S2, J722S, J7200, J742S2, J784S4

@ti-kamlesh
Copy link
Copy Markdown
Contributor Author

@StaticRocket on vale checks, acronym expansion is per paragraph. If i expand per paragraph it becomes hard to read.

"The RedHat.Definitions rule resets per paragraph — it doesn't remember a definition from one paragraph to the
next. So no matter where I write "Key Encapsulation Mechanism (KEM)", it will flag "KEM" again in every other paragraph. This means inline expansions
alone can't fix this.

There are three real options:

  1. Add to accept.txt (minimal: KEM, DSA, SLH, GCM, SHAKE) — cleanest fix
  2. Disable the rule in .vale.ini with RedHat.Definitions = NO
  3. Wrap the whole doc with .. vale off / .. vale on RST comments"

Let me know your suggestion

@StaticRocket
Copy link
Copy Markdown
Member

@ti-kamlesh

The RedHat.Definitions rule resets per paragraph

That's not right. Where did you get that information?

The reason you are getting warnings is because compound acronyms need both parts explained separately. That, and the explanation must precede the first use. The following is the correct way to do this:

Module Lattice (ML) Digital Signature Algorithm (DSA) or ML-DSA, based on CRYSTALS-Dilithium

- **FIPS 204**: ML-DSA (Module Lattice Digital Signature Algorithm), based on CRYSTALS-Dilithium
- **FIPS 205**: SLH-DSA (Stateless Hash-based Digital Signature Algorithm), based on SPHINCS+

The AM62L SDK includes **OpenSSL 3.5.x**, which provides native support for
Copy link
Copy Markdown
Contributor

@manorit2001 manorit2001 May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this part of all the SDKs? If not then we should keep this page only AM62L specific at the moment ( AM62L TOC only ) or otherwise if supported for all then we can remove AM62L mention from here ig.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

openssl version is central for all devices, removed the am62l specific part

@github-actions
Copy link
Copy Markdown

New warnings found with rstcheck:

source/linux/Foundational_Components/System_Security/Post_Quantum_Cryptography.rst:31: (WARNING/2) Title overline too short.
source/linux/Foundational_Components/System_Security/Post_Quantum_Cryptography.rst:31: (WARNING/2) Title overline too short.
source/linux/Foundational_Components/System_Security/Post_Quantum_Cryptography.rst:182: (WARNING/2) Title overline too short.
source/linux/Foundational_Components/System_Security/Post_Quantum_Cryptography.rst:182: (WARNING/2) Title overline too short.

Add PQC documentation page covering NIST-standardized algorithms
(ML-KEM, ML-DSA, SLH-DSA) supported via OpenSSL 3.5.x out of the box.

Enable the page for all devices with OpenSSL 3.5.x support:
- AM62AX, AM62DX, AM62LX, AM62PX, AM62X
- AM64X
- J721E, J721S2, J722S, J7200, J742S2, J784S4

Signed-off-by: Kamlesh Gurudasani <kamlesh@ti.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.