Document Pkcs12Info #2914
Document Pkcs12Info #2914
Conversation
| <exception cref="T:System.Security.Cryptography.CryptographicException">The hash algorithm option specified by the PKCS#12 PFX contents could not be identified or is not supported by this platform.</exception> | ||
| </Docs> | ||
| </Member> | ||
| <Member MemberName="VerifyMac"> |
There was a problem hiding this comment.
@mairaw or @rpetrusha : This file doesn't have a MethodGroup entry for this overloaded member (and I feel like I've seen other new API in that state). I don't know if that means a) we're not bothering with them, b) there's an error in the ingestor which results in it not producing them c) there's an error in the validator that makes it not report them as missing d) other e) some multiple combination of a-d.
There was a problem hiding this comment.
You mean the MemberGroup element to add summary, remarks, etc. that apply to all overloads?
If so, the reflection tool doesn't add them automatically and we're not required to document them.
When we want to avoid repeating the same text, we manually add them.
If I misunderstood, please let me know.
There was a problem hiding this comment.
It seems, though, that the <summary> element of a member group is ignored if there aren't some <AssemblyInfo> elements present.
|
Made some small changes. Please take a look. |
mairaw
added
🏁 Release: .NET Core 3.0
|
Changes look good to me. As does the explanation about the MemberGroup element. |
There was a problem hiding this comment.
This looks really good, @bartonjs. I've left some minor suggestions and added a <MemberGroup> section that you can add a <remarks> section to (hopefully I didn't create some badly formatted XML). A number of links are broken in the build, though I can't see any reason why. I've suggested adding a space between the closing quotation mark and the end tag in crefs in the event that that fixes the problem, though I rather doubt that it will.
|
Ah, being removed from the text for a couple hours I see I wrote "Pkcs12" too many times... it's "S.S.C.Pkcs.Pkcs12Info", not "S.S.C.Pkcs12.Pkcs12Info". I'll remove the extraneous 12s |
Co-Authored-By: Ron Petrusha <[email protected]>
| Therefore, there is no guarantee that a password which results in a `true` return from this method will succeed on a call to <xref:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.Decrypt%2A>. | ||
| In the PKCS#12 specification, a distinction is made between a `null` password and an "empty" password, and that difference is reflected in the return value of this method. | ||
| If the `null` string returns `true`, then <xref:System.String.Empty> returns `false`, and vice versa. |
There was a problem hiding this comment.
| If the `null` string returns `true`, then <xref:System.String.Empty> returns `false`, and vice versa. | |
| If the `null` string returns `true`, then <xref:System.String.Empty?displayProperty=nameWithType> returns `false`, and vice versa. |
| ## Remarks | ||
| It's not possible to distingush the error due to the password being incorrect from the error due to the contents having been altered. |
There was a problem hiding this comment.
Since these two paragraphs now appear in the member group, they can be removed from here.
| ## Remarks | ||
| It's not possible to distinguish the error due to the password being incorrect from the error due to the contents having been altered. |
There was a problem hiding this comment.
Since these two paragraphs now appear in the member group, they can be removed from here.
cc: @carlossanlop