Skip to content

wolfCrypt JNI/JCE manual: sync content with current wolfcrypt-jni, fix table rendering - #276

Open
cconlon wants to merge 1 commit into
wolfSSL:masterfrom
cconlon:wcJNIUpdateAug5
Open

wolfCrypt JNI/JCE manual: sync content with current wolfcrypt-jni, fix table rendering#276
cconlon wants to merge 1 commit into
wolfSSL:masterfrom
cconlon:wcJNIUpdateAug5

Conversation

@cconlon

@cconlon cconlon commented Aug 5, 2026

Copy link
Copy Markdown
Member

This PR updates the wolfCrypt JNI/JCE manual (English) to match the current state of wolfcrypt-jni, and fixes a table rendering issue in the HTML output.

  • Ch 2 (Requirements): native wolfSSL configure options required for ML-KEM, ML-DSA, SLH-DSA, XMSS, and LMS, with verify-only and minimal-build notes
  • Ch 3 (Compilation): Maven version bump, new Java 9+ module (JPMS)/jlink section
  • Ch 4 (Installation): Java 9+ install paths (jre/lib/ext removal), ServiceLoader discovery, custom native library loading (wolfssl.skipLibraryLoad)
  • Ch 5 (Package Design): refreshed directory layout
  • Ch 6 (Algorithms): ML-DSA, SLH-DSA (all 12 sets + HASH-SLH-DSA), XMSS/LMS (verify-only), ML-KEM incl. the JDK 21+ javax.crypto.KEM service, new KeyPairGenerator/KeyFactory/SecretKeyFactory entries, RFC 9935 interop notes
  • Ch 8 (Usage): System/Security property tables, SecureRandom.getInstanceStrong() setup, filtered Sun providers for hardened/FIPS JREs
  • Ch 9 (KeyStore): WKS PBKDF2 details, WKS Security properties, KEK caching, programmatic conversion via WolfCryptUtil.convertKeyStoreToWKS()
  • Copyright year bump in mkdocs.yml

Rendering fix: Inline code in HTML tables (e.g. --enable-slhdsa in the Ch 2 configure-option table) wrapped mid-token. New opt-in common/table-code.css keeps code spans on one line (display: inline-block is required for Safari/WebKit, which otherwise breaks nowrap spans during column sizing).

@cconlon cconlon self-assigned this Aug 5, 2026
Copilot AI lite review requested due to automatic review settings August 5, 2026 17:27

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the wolfCrypt JNI/JCE English manual to reflect the current wolfcrypt-jni feature set (notably post-quantum algorithms, JPMS/jlink usage, and WKS KeyStore details) and adds an opt-in CSS tweak to prevent inline-code wrapping inside HTML tables.

Changes:

  • Expanded algorithm and configuration documentation (ML-KEM/ML-DSA/SLH-DSA/XMSS/LMS, native wolfSSL configure options, and new usage notes).
  • Added Java 9+ guidance (JPMS module info, jlink, updated installation paths, ServiceLoader discovery, and custom native library loading).
  • Improved HTML rendering for inline code in tables via common/table-code.css and mkdocs configuration.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
wolfCrypt-JNI/src/chapter02.md Documents additional native wolfSSL feature/configure requirements for PQ/hash-based algorithms.
wolfCrypt-JNI/src/chapter03.md Updates Maven dependency version and adds JPMS/jlink guidance for Java 9+.
wolfCrypt-JNI/src/chapter04.md Updates installation guidance for Java 9+ and documents ServiceLoader + custom native library loading property.
wolfCrypt-JNI/src/chapter05.md Refreshes package/directory layout documentation.
wolfCrypt-JNI/src/chapter06.md Expands supported algorithms/services list and adds ML-KEM notes + native-feature requirements section.
wolfCrypt-JNI/src/chapter08.md Adds System/Security properties tables and hardened-environment provider guidance.
wolfCrypt-JNI/src/chapter09.md Significantly expands WKS design, properties, KEK caching, and conversion guidance.
wolfCrypt-JNI/mkdocs.yml Bumps copyright year and opts into the new table-code CSS.
common/table-code.css Adds CSS to keep inline-code tokens unbroken inside tables (HTML rendering fix).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread wolfCrypt-JNI/src/chapter09.md Outdated
Comment thread wolfCrypt-JNI/src/chapter09.md Outdated
Comment thread wolfCrypt-JNI/src/chapter09.md Outdated
@cconlon cconlon assigned rlm2002 and unassigned cconlon Aug 5, 2026
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.

3 participants