Correct and modernize the wolfProvider manual against current wolfProvider sources - #280
Draft
aidangarske wants to merge 2 commits into
Draft
Correct and modernize the wolfProvider manual against current wolfProvider sources#280aidangarske wants to merge 2 commits into
aidangarske wants to merge 2 commits into
Conversation
aidangarske
commented
Aug 29, 2026
Member
- Rewrites stale content across all wolfProvider manual chapters to match current wolfProvider master.
- OpenSSL support corrected to all 3.x releases (was pinned to 3.0.0/3.5.0); build examples use the latest 3.x tag.
- Build chapter: adds the current build-wolfprovider.sh/configure flags (replace-default, seed-src, debug-silent), corrects defines (WP_HAVE_SEED_SRC, WP_HAVE_KBKDF, WP_HAVE_SSHKDF), fixes broken shell in the recipes, adds the Windows Visual Studio 2022 section, removes the obsolete Windows CE section.
- Portability: documents Linux, macOS, Windows, Android, and Apple platform support; FIPS scoped correctly (incl. Android FIPS Ready).
- Loading: adds a Replace-Default Mode section; corrects the provider aliases (default/fips -> libwolfprov), the registered property (provider=wolfprov), the static-provider load path (OSSL_PROVIDER_add_builtin), and removes the misleading self-test example.
- Logging: corrects every enum to WP_LOG_LEVEL_* / WP_LOG_COMP_*, adds DEBUG/TRACE, fixes the default mask, documents the compile-time filters, and makes the examples compile.
- Design: corrects the entry points, source-file table, the four provider params, the capability set, and the teardown behavior.
- PQC chapter: documents ML-KEM/ML-DSA/LMS; notes validated FIPS/FIPS-Ready reject PQC/LMS; pins a patched OpenSSL 3.6.x in build commands.
- Adds a first-pass Japanese translation of the updates (second commit) - machine-translated, needs native-speaker review.
- SLH-DSA content, the pqc_openssl_example, and the libacvp workflow are documented ahead of wolfProvider PR #455 (not yet merged).
- Testing: manual build (pandoc/xelatex/mkdocs) not run locally - needs the repo's CI/Docker build (make pdf html, make test) before merge.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.