docs: add XML documentation for SLH-DSA parameters (Batch 8)#678
Open
KonradSop wants to merge 1 commit intobcgit:masterfrom
Open
docs: add XML documentation for SLH-DSA parameters (Batch 8)#678KonradSop wants to merge 1 commit intobcgit:masterfrom
KonradSop wants to merge 1 commit intobcgit:masterfrom
Conversation
Document the public/private/key-generation parameter classes and parameter selectors for SLH-DSA, the stateless hash-based signature scheme standardised in FIPS 205. Adds class-level summaries citing FIPS 205 and per-method <summary>, <param>, <returns>, and <exception> tags for the public API surface (parameter constants, FromEncoding entry points, GetEncoded / GetPublicKey / GetPublicKeyEncoded helpers, and the two SlhDsaKeyGenerationParameters constructors). No behavioural changes.
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.
Adds XML documentation to the SLH-DSA parameter classes under
crypto/src/crypto/parameters— the stateless hash-based signature scheme standardised by NIST in FIPS 205. Closes the post-quantum trio that PR #673 began (ML-KEM / ML-DSA), giving each of the three FIPS PQC primitives a consistent documentation surface.SlhDsaParameters— class summary citing FIPS 205 and explaining the pure / HashSLH-DSA split (FIPS 205 §10.2). Per-instance summaries identify each of the 24 parameter constants by NIST security category, fast/small variant and hash family. Public members (IsPreHash,Name,ParameterSet,ToString) documented with their semantic role.SlhDsaParameterSet— class summary describing the FIPS 205 tree-shape parameters. Per-constant summaries record the WOTS+, hypertree and FORS shape (n,h,d,k,a).SlhDsaKeyParameters— abstract base; class summary plusParametersaccessor doc.SlhDsaPublicKeyParameters— class summary explaining the(seed, root)tuple.FromEncodingdocuments the2 * nlength contract and theArgumentNullException/ArgumentExceptionit raises.GetEncodeddocumented.SlhDsaPrivateKeyParameters— class summary explaining the(SK.seed, SK.prf, PK.seed, PK.root)tuple.FromEncodingdocuments the4 * nlength contract.GetEncoded,GetPublicKey,GetPublicKeyEncodeddocumented.SlhDsaKeyGenerationParameters— class summary covering theSecureRandom+ parameter-set pairing and noting whystrength = 0. Both constructors document their exception contracts.Key Accomplishments
<exception>tags only added where the method body actually throws —ArgumentNullException/ArgumentExceptionon theFromEncodingand OID-lookup paths.Verification
dotnet build crypto/src/BouncyCastle.Crypto.csproj -c Release— succeeded onnet6.0,netstandard2.0,net461with no new warnings.Checklist before requesting a review
See also Contributing Guidelines.