docs: add XML documentation for CMS SignedData stream parser (Batch 15g) - #706
Open
KonradSop wants to merge 1 commit into
Open
docs: add XML documentation for CMS SignedData stream parser (Batch 15g)#706KonradSop wants to merge 1 commit into
KonradSop wants to merge 1 commit into
Conversation
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.
Description
Adds XML documentation to
CmsSignedDataParser— the streaming read-side counterpart toCmsSignedData(Batch 12a-3, #686) and the parser-side pair toCmsSignedDataStreamGenerator(Batch 13a, #687):
and the requirement to drain encapsulated content before calling
GetSignerInfos.<remarks>— stream lifecycle (parser does not close the input stream; dispose the parser orclose manually), no internal buffering, and a C# example covering drain → certificates → verify.
CmsTypedStream);<exception>tags on the core(CmsTypedStream, Stream)constructor.Version,DigestOids,GetSignerInfos, certificate/CRL/revocation stores,SignedContentType,GetSignedContent, and staticReplaceSigners/ReplaceCertificatesAndCrls.CmsSignedData,CmsSignedDataStreamGenerator,SignerInformation,SignerInformationStore,CmsTypedStream.Drain.Legacy
/**block comments converted to XML.Key Accomplishments
verify CMS SignedData from a stream without loading the entire message into memory.
GetSignerInfosordering and digest finalizationare documented with
<see cref>links rather than leaving callers to infer from source.<exception>only where the code throws).CmsSignedData(docs: add XML documentation for CMS SignedData generator (Batch 12a-3) #686),CmsSignedDataStreamGenerator(docs: add XML documentation for CMS SignedData stream generator (Batch 13a) #687), and signer types (docs: add XML documentation for CMS signer types (Batch 14b) #699).Verification
dotnet build crypto/src/BouncyCastle.Crypto.csproj -c Release— 0 errors, no new warnings.///lines are at most 120 characters.Checklist before requesting a review
See also Contributing Guidelines.