-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Document Pkcs8PrivateKeyInfo #2932
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good, @bartonjs. I've left a few comments and suggestions.
<param name="algorithmId">The Object Identifier (OID) identifying the asymmetric algorithm this key is for.</param> | ||
<param name="algorithmParameters">The BER-encoded algorithm parameters associated with this key, or <see langword="null"/> to omit algorithm parameters when encoding.</param> | ||
<param name="privateKey">The algorithm-specific encoded private key.</param> | ||
<param name="skipCopy"><see langword="true"/> to store <paramref name="algorithmParameters"/> and <paramref name="privateKey"/> without making a defensive copy; otherwise, <see langword="false"/>. The default is <see langword="false"/>.</param> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The parameter name is shown in line 38 (and the original line 44) as skipCopies
. Because of the disparity, the parameter description doesn't appear in the build.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whoops, copied and pasted from the only plural one :)
When `pbeParameters` indicates an algorithm that uses PBKDF2 (Password-Based Key Derivation Function 2), the password is converted to bytes via the UTF-8 encoding. | ||
|
||
]]></format> | ||
<altmember cref="Overload:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.TryEncrypt"/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The <altmember> element should go after <remarks>, not before.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixing syntax errors via suggestions
Co-Authored-By: Ron Petrusha <[email protected]>
I think that successfully took all of the edits. |
Thanks for the additional changes, @bartonjs. I'll merge your PR now. |
cc: @carlossanlop