Skip to content

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

Merged
merged 2 commits into from
Aug 7, 2019
Merged

Conversation

bartonjs
Copy link
Member

@bartonjs bartonjs commented Aug 6, 2019

@carlossanlop carlossanlop added 🏁 Release: .NET Core 3.0 :checkered_flag: Release: .NET Core 3.0 new-content Indicates PRs that contain new articles waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews labels Aug 6, 2019
@carlossanlop carlossanlop added this to the August 2019 milestone Aug 6, 2019
Copy link

@rpetrusha rpetrusha left a 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>

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.

Copy link
Member Author

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"/>

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.

Copy link
Member Author

@bartonjs bartonjs left a 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

@bartonjs
Copy link
Member Author

bartonjs commented Aug 7, 2019

I think that successfully took all of the edits.

@mairaw mairaw added the changes-addressed Indicates PRs that had all comments addressed and are awaiting for new review label Aug 7, 2019
@rpetrusha
Copy link

Thanks for the additional changes, @bartonjs. I'll merge your PR now.

@rpetrusha rpetrusha merged commit b2c4fb9 into dotnet:master Aug 7, 2019
@mairaw mairaw removed waiting-on-reviews Indicates PRs that cannot be merged because of the lack of reviews changes-addressed Indicates PRs that had all comments addressed and are awaiting for new review labels Aug 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏁 Release: .NET Core 3.0 :checkered_flag: Release: .NET Core 3.0 new-content Indicates PRs that contain new articles
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants