Skip to content

Commit d88edb1

Browse files
authored
CNG classes don't work on non-windows platforms (#7323)
1 parent d886e14 commit d88edb1

File tree

7 files changed

+25
-4
lines changed

7 files changed

+25
-4
lines changed

xml/System.Security.Cryptography/CngAlgorithm.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,11 @@
5353
5454
Several Cryptography Next Generation (CNG) classes (such as <xref:System.Security.Cryptography.CngKey>) accept <xref:System.Security.Cryptography.CngAlgorithm> objects through an `algorithm` parameter. When the class receives the <xref:System.Security.Cryptography.CngAlgorithm> object, it retrieves the embedded algorithm name by calling the object's <xref:System.Security.Cryptography.CngAlgorithm.Algorithm%2A> property.
5555
56-
Therefore, <xref:System.Security.Cryptography.CngAlgorithm> serves as an enumeration of well-known algorithms. It lets you specify a well-known algorithm by using a strongly typed value instead of a string.
57-
56+
Therefore, <xref:System.Security.Cryptography.CngAlgorithm> serves as an enumeration of well-known algorithms. It lets you specify a well-known algorithm by using a strongly typed value instead of a string.
57+
58+
> [!NOTE]
59+
> CNG classes don't work on non-Windows platforms.
60+
5861
]]></format>
5962
</remarks>
6063
</Docs>

xml/System.Security.Cryptography/CngAlgorithmGroup.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@
5454
Several Cryptography Next Generation (CNG) classes (such as <xref:System.Security.Cryptography.CngKey>) return <xref:System.Security.Cryptography.CngAlgorithmGroup> objects. Classes that receive <xref:System.Security.Cryptography.CngAlgorithm> objects can retrieve the embedded algorithm group name by calling the object's <xref:System.Security.Cryptography.CngKey.AlgorithmGroup%2A> property.
5555
5656
Therefore, <xref:System.Security.Cryptography.CngAlgorithmGroup> serves as an enumeration of well-known algorithm groups. It lets you specify an algorithm group name by using a strongly typed value instead of a string.
57+
58+
> [!NOTE]
59+
> CNG classes don't work on non-Windows platforms.
5760
5861
]]></format>
5962
</remarks>

xml/System.Security.Cryptography/CngKey.xml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@
3939
4040
## Remarks
4141
This class wraps NCrypt keys, not BCrypt keys. NCrypt is a subset of CNG that provides key storage functionality. BCrypt is a subset that provides base cryptographic services such as random number generation, hash functions, signatures, and encryption keys.
42-
42+
43+
> [!NOTE]
44+
> CNG classes don't work on non-Windows platforms.
45+
4346
]]></format>
4447
</remarks>
4548
</Docs>

xml/System.Security.Cryptography/CngKeyBlobFormat.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@
5454
Several CNG classes (such as <xref:System.Security.Cryptography.CngKey>) accept <xref:System.Security.Cryptography.CngKeyBlobFormat> objects through a `format` parameter. When the class receives the <xref:System.Security.Cryptography.CngKeyBlobFormat> object, it retrieves the embedded name of the key BLOB format by calling the object's <xref:System.Security.Cryptography.CngKeyBlobFormat.Format%2A> property.
5555
5656
Therefore, <xref:System.Security.Cryptography.CngKeyBlobFormat> serves as an enumeration of well-known key BLOB formats. It lets you identify a well-known key BLOB format by using a strongly typed value instead of a string.
57+
58+
> [!NOTE]
59+
> CNG classes don't work on non-Windows platforms.
5760
5861
]]></format>
5962
</remarks>

xml/System.Security.Cryptography/CngKeyCreationParameters.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@
4141
You can also add non-standard properties to a key by using the <xref:System.Security.Cryptography.CngKeyCreationParameters.Parameters%2A> property.
4242
4343
If you need to add properties after a key is created, use the <xref:System.Security.Cryptography.CngKey.SetProperty%2A> method.
44+
45+
> [!NOTE]
46+
> CNG classes don't work on non-Windows platforms.
4447
4548
]]></format>
4649
</remarks>

xml/System.Security.Cryptography/CngProvider.xml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@
5454
Several CNG classes (such as <xref:System.Security.Cryptography.CngKey>) accept <xref:System.Security.Cryptography.CngProvider> objects through a `provider` parameter. When the class receives the <xref:System.Security.Cryptography.CngProvider> object, it retrieves the embedded provider name by calling the object's <xref:System.Security.Cryptography.CngProvider.Provider%2A> property.
5555
5656
Therefore, <xref:System.Security.Cryptography.CngProvider> serves as an enumeration of well-known providers. It lets you identify a provider by using a strongly typed value instead of a string.
57+
58+
> [!NOTE]
59+
> CNG classes don't work on non-Windows platforms.
5760
5861
]]></format>
5962
</remarks>

xml/System.Security.Cryptography/CngUIPolicy.xml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@
3535
3636
## Remarks
3737
This class enables you to create a UI policy for displaying prompts about key operations such as smart card PIN prompts. It also enables you to enforce user interaction to access a key, even if the key is stored in a software key storage provider (KSP) instead of in a smart card. CNG displays these configuration parameters for the UI when you access a protected key.
38-
38+
39+
> [!NOTE]
40+
> CNG classes don't work on non-Windows platforms.
41+
3942
]]></format>
4043
</remarks>
4144
</Docs>

0 commit comments

Comments
 (0)