docs: add XML documentation for CMS recipient types (Batch 14a) - #698
Open
KonradSop wants to merge 2 commits into
Open
docs: add XML documentation for CMS recipient types (Batch 14a)#698KonradSop wants to merge 2 commits into
KonradSop wants to merge 2 commits 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 the CMS recipient-information API used to identify
recipients and recover encrypted CMS content:
RecipientInformation— base-class workflow, recipient identifier,key-encryption algorithm, complete-content convenience method, and content
stream method.
RecipientId— recipient matching by issuer/serial number, subject keyidentifier, or KEK key identifier; documents equality semantics.
summaries and
GetContentStreamcontracts, including required key material,returned stream, and implementation-backed exceptions.
A separate preceding commit performs whitespace-only normalization in
RecipientId.csandKEKRecipientInformation.cs, as required by therepository contribution rules.
Key Accomplishments
recipient and provide the appropriate private, shared, or password-based key.
the actual key-recovery implementations.
signature changes.
at most 120 characters.
Verification
dotnet build crypto/src/BouncyCastle.Crypto.csproj -c Release— 0 errors.
RecipientIddescriptionomission was corrected before commit.
Checklist before requesting a review
See also Contributing Guidelines.