Skip to content

Add missing, and update existing, documentation on the RSA classes #3660

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.

Sign up for GitHub

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 4 commits into from
Dec 12, 2019
Merged

Add missing, and update existing, documentation on the RSA classes #3660

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dc3b693
Add missing, and update existing, documentation on the RSA classes
bartonjs Dec 11, 2019
82873bf
Fix some bad crefs/xrefs
bartonjs Dec 11, 2019
9355b8c
Merge branch 'master' into rsa
bartonjs Dec 12, 2019
d76337e
Fix more bad crefs/xrefs.
bartonjs Dec 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix some bad crefs/xrefs
  • Loading branch information
@bartonjs
bartonjs committed Dec 11, 2019
commit 82873bf1d1fc385a2c35c823372e50a3d6f5ca6f
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography/RSA.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2419,7 +2419,7 @@ An error occurred creating the signature.</exception>
<format type="text/markdown"><![CDATA[

## Remarks
The default implementation of this method is to copy `hash` and `signature` to new arrays and call <xref:M:System.Security.Cryptography.RSA.VerifyHash(System.Byte[],System.Byte[],System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.RSASignaturePadding)>.
The default implementation of this method is to copy `hash` and `signature` to new arrays and call <xref:System.Security.Cryptography.RSA.VerifyHash(System.Byte[],System.Byte[],System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.RSASignaturePadding)>.
Derived types should override this method to avoid the intermediate array creation.

]]></format>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Security.Cryptography/RSACng.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
## Remarks

This constructor does not generate a new public/private keypair immediately.
This constructor sets the <xref:System.Security.Cryptography.RSACng.KeySize> property to 2048 and when a key is needed one is generated using the property value.
This constructor sets the <xref:System.Security.Cryptography.AsymmetricAlgorithm.KeySize> property to 2048 and when a key is needed one is generated using the property value.
If a key is loaded via the <xref:System.Security.Cryptography.RSACng.ImportParameters%2A> method, or other key import method, the key size from this constructor has no meaning.

]]></format>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Security.Cryptography/RSAOpenSsl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,8 +574,8 @@ This instance represents only a public key.
-or-

An error occurred creating the signature.</exception>
<altmember cref="M:System.Security.Cryptography.RSAOpenSsl.TrySignHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.RSASignaturePadding,System.Int32@)" />
<altmember cref="M:System.Security.Cryptography.RSAOpenSsl.SignData(System.Byte[],System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.RSASignaturePadding)" />
<altmember cref="M:System.Security.Cryptography.RSA.TrySignHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.RSASignaturePadding,System.Int32@)" />
<altmember cref="M:System.Security.Cryptography.RSA.SignData(System.Byte[],System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.RSASignaturePadding)" />
</Docs>
</Member>
<Member MemberName="VerifyHash">
Expand Down