Skip to content

Commit 5eaa26a

Browse files
authored
Merge pull request dotnet#2085 from GuardRex/guardrex/RSACng-RSAOpenSsl-updates
Add notes to use platform agnostic RSA.Create
2 parents 338b7dc + 7a73363 commit 5eaa26a

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

xml/System.Security.Cryptography/RSACng.xml

+3
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@
3333
- The key used by <xref:System.Security.Cryptography.RSACng> is managed by a separate <xref:System.Security.Cryptography.CngKey> object. In contrast, <xref:System.Security.Cryptography.RSACryptoServiceProvider> has a key that is directly tied to the operations of the type itself.
3434
3535
- <xref:System.Security.Cryptography.RSACng> performs such operations as signing and verifying signatures by using properties of the <xref:System.Security.Cryptography.RSACng> object, just as <xref:System.Security.Cryptography.ECDsaCng> uses its object properties to control signing and verification operations.
36+
37+
> [!NOTE]
38+
> The <xref:System.Security.Cryptography.RSACng> class is an implementation of the RSA algorithm using the Windows CNG libraries and isn't available on operating systems other than Windows. For applications which aren't doing Windows interop, you're encouraged to use <xref:System.Security.Cryptography.RSA.Create%2A?displayProperty=fullName> instead of referencing this type directly.
3639
3740
]]></format>
3841
</remarks>

xml/System.Security.Cryptography/RSAOpenSsl.xml

+9-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,15 @@
1313
<Interfaces />
1414
<Docs>
1515
<summary>To be added.</summary>
16-
<remarks>To be added.</remarks>
16+
<remarks>
17+
<format type="text/markdown"><![CDATA[
18+
19+
## Remarks
20+
> [!NOTE]
21+
> The <xref:System.Security.Cryptography.RSAOpenSsl> class is an implementation of the RSA algorithm using OpenSSL. It isn't available on Windows and is only available on other operating systems when OpenSSL is installed. For applications which aren't doing OpenSSL-specific interop, you're encouraged to use <xref:System.Security.Cryptography.RSA.Create%2A?displayProperty=fullName> instead of referencing this type directly.
22+
23+
]]></format>
24+
</remarks>
1725
</Docs>
1826
<Members>
1927
<Member MemberName=".ctor">

0 commit comments

Comments
 (0)