docs: add XML documentation for PKCS#12 store API (Batch 12a-2)#685
Open
KonradSop wants to merge 1 commit into
Open
docs: add XML documentation for PKCS#12 store API (Batch 12a-2)#685KonradSop wants to merge 1 commit into
KonradSop wants to merge 1 commit into
Conversation
Document the in-memory PKCS#12 keystore surface (RFC 7292): Pkcs12Store, Pkcs12Entry and Pkcs12StoreBuilder. Adds class-level summaries and per-method <summary>, <param>, <returns>, and <exception> tags for Load, Save, alias management and builder configuration. Converts legacy block comment on GetCertificate to XML. 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.
Description
Adds XML documentation to the PKCS#12 keystore API (RFC 7292) under
crypto/src/pkcs:Pkcs12Store— class summary citing RFC 7292; documentsLoadandSavewith MAC/passwordexception contracts; documents alias lookup, certificate chain, entry management (
SetCertificateEntry,SetKeyEntry,SetFriendlyName,DeleteEntry) and theIgnoreUselessPasswordPropertyconstant.Pkcs12Entry— class summary for the bag-attribute base type; documents the indexer,BagAttributeKeys,HasFriendlyName,SetFriendlyName, andTryGetAttribute.Pkcs12StoreBuilder— class summary; documentsBuildand all configuration methods(
SetCertAlgorithm,SetKeyAlgorithm, PBES2 PRF variants,SetUseDerEncoding,SetReverseCertificates,SetOverwriteFriendlyName,SetEnableOracleTrustedKeyUsage).Key Accomplishments
documents the full public surface of the in-memory store.
<exception>only where guards in the method body throw(
ArgumentNullException,ArgumentException,IOExceptiononLoad).Verification
dotnet build crypto/src/BouncyCastle.Crypto.csproj -c Release— 0 errors, no new warnings.Checklist before requesting a review
See also Contributing Guidelines.