8000 Update RijndaelManaged.xml (#2051) · shdvr/dotnet-api-docs@e06be80 · GitHub
[go: up one dir, main page]
Skip to content

Commit e06be80

Browse files
MSDN-WhiteKnightRon Petrusha
MSDN-WhiteKnight
authored and
Ron Petrusha
committed
Update RijndaelManaged.xml (dotnet#2051)
* Update RijndaelManaged.xml - Added missing property details - Added information about .NET Core and .NET Framework differences * Update RijndaelManaged.xml * Update xml/System.Security.Cryptography/RijndaelManaged.xml Co-Authored-By: MSDN-WhiteKnight <35516665+MSDN-WhiteKnight@users.noreply.github.com> * Update xml/System.Security.Cryptography/RijndaelManaged.xml Co-Authored-By: MSDN-WhiteKnight <35516665+MSDN-WhiteKnight@users.noreply.github.com> * Update xml/System.Security.Cryptography/RijndaelManaged.xml Co-Authored-By: MSDN-WhiteKnight <35516665+MSDN-WhiteKnight@users.noreply.github.com> * Update xml/System.Security.Cryptography/RijndaelManaged.xml Co-Authored-By: MSDN-WhiteKnight <35516665+MSDN-WhiteKnight@users.noreply.github.com> * Update xml/System.Security.Cryptography/RijndaelManaged.xml Co-Authored-By: MSDN-WhiteKnight <35516665+MSDN-WhiteKnight@users.noreply.github.com> * Update xml/System.Security.Cryptography/RijndaelManaged.xml Co-Authored-By: MSDN-WhiteKnight <35516665+MSDN-WhiteKnight@users.noreply.github.com>
1 parent 3226ef8 commit e06be80

File tree

1 file changed

+53
-25
lines changed

1 file changed

+53
-25
lines changed

‎xml/System.Security.Cryptography/RijndaelManaged.xml

Lines changed: 53 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="RijndaelManaged" FullName="System.Security.Cryptography.RijndaelManaged">
1+
<Type Name="RijndaelManaged" FullName="System.Security.Cryptography.RijndaelManaged">
22
<TypeSignature Language="C#" Value="public sealed class RijndaelManaged : System.Security.Cryptography.Rijndael" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RijndaelManaged extends System.Security.Cryptography.Rijndael" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.RijndaelManaged" />
@@ -39,8 +39,8 @@
3939
<remarks>
4040
<format type="text/markdown"><![CDATA[
4141
42-
## Remarks
43-
This algorithm supports key lengths of 128, 192, or 256 bits; defaulting to 256 bits. This algorithm supports block sizes of 128, 192, or 256 bits; defaulting to 128 bits (<xref:System.Security.Cryptography.Aes>-compatible).
42+
## Remarks
43+
This algorithm supports key lengths of 128, 192, or 256 bits; defaulting to 256 bits. In .NET Framework, this algorithm supports block sizes of 128, 192, or 256 bits; defaulting to 128 bits (<xref:System.Security.Cryptography.Aes>-compatible). In .NET Core, it is the same as AES and supports only a 128-bit block size.
4444
4545
The <xref:System.Security.Cryptography.Rijndael> algorithm is the predecessor of <xref:System.Security.Cryptography.Aes>. You should use the <xref:System.Security.Cryptography.Aes> class instead of <xref:System.Security.Cryptography.RijndaelManaged>. For more information, see the entry [The Differences Between Rijndael and AES](https://go.microsoft.com/fwlink/?LinkId=200932) in the .NET Security blog.
4646
@@ -125,9 +125,13 @@
125125
<ReturnType>System.Int32</ReturnType>
126126
</ReturnValue>
127127
<Docs>
128-
<summary>To be added.</summary>
129-
<value>To be added.</value>
130-
<remarks>To be added.</remarks>
128+
<summary>Gets or sets the block size, in bits, of the cryptographic operation.</summary>
129+
<value>The block size, in bits, of the cryptographic operation. The default is 128 bits.</value>
130+
<remarks><format type="text/markdown"><![CDATA[
131+
132+
## Remarks
133+
In .NET Framework, the valid block size values for Rijndael are 128, 192 and 256 bits. In .NET Core, the block size for Rijndael can only be 128 bits. See the <xref:System.Security.Cryptography.SymmetricAlgorithm.BlockSize?displayProperty=nameWithType> for more information about block size.
134+
]]></format></remarks>
131135
</Docs>
132136
</Member>
133137
<MemberGroup MemberName="CreateDecryptor">
@@ -483,9 +487,13 @@
483487
<ReturnType>System.Byte[]</ReturnType>
484488
</ReturnValue>
485489
<Docs>
486-
<summary>To be added.</summary>
487-
<value>To be added.</value>
488-
<remarks>To be added.</remarks>
490+
<summary>Gets or sets the initialization vector (IV) to use for the symmetric algorithm.</summary>
491+
<value>The initialization vector (IV) to use for the symmetric algorithm. </value>
492+
<remarks><format type="text/markdown"><![CDATA[
493+
494+
## Remarks
495+
See the <xref:System.Security.Cryptography.SymmetricAlgorithm.IV?displayProperty=nameWithType> for more information about initialization vectors.
496+
]]></format></remarks>
489497
</Docs>
490498
</Member>
491499
<Member MemberName="Key">
@@ -512,9 +520,13 @@
512520
<ReturnType>System.Byte[]</ReturnType>
513521
</ReturnValue>
514522
<Docs>
515-
<summary>To be added.</summary>
516-
<value>To be added.</value>
517-
<remarks>To be added.</remarks>
523+
<summary>Gets or sets the secret key used for the symmetric algorithm.</summary>
524+
<value>The secret key used for the symmetric algorithm.</value>
525+
<remarks><format type="text/markdown"><![CDATA[
526+
527+
## Remarks
528+
See the <xref:System.Security.Cryptography.SymmetricAlgorithm.Key?displayProperty=nameWithType> for more information about the secret key.
529+
]]></format></remarks>
518530
</Docs>
519531
</Member>
520532
<Member MemberName="KeySize">
@@ -541,9 +553,13 @@
541553
<ReturnType>System.Int32</ReturnType>
542554
</ReturnValue>
543555
<Docs>
544-
<summary>To be added.</summary>
545-
<value>To be added.</value>
546-
<remarks>To be added.</remarks>
556+
<summary>Gets or sets the size, in bits, of the secret key used for the symmetric algorithm.</summary>
557+
<value>The size, in bits, of the secret key used for the symmetric algorithm. The default is 256 bits.</value>
558+
<remarks><format type="text/markdown"><![CDATA[
559+
560+
## Remarks
561+
The valid key sizes for Rijndael are 128, 192 and 256 bits.
562+
]]></format></remarks>
547563
</Docs>
548564
</Member>
549565
<Member MemberName="LegalKeySizes">
@@ -570,9 +586,13 @@
570586
<ReturnType>System.Security.Cryptography.KeySizes[]</ReturnType>
571587
</ReturnValue>
572588
<Docs>
573-
<summary>To be added.</summary>
574-
<value>To be added.</value>
575-
<remarks>To be added.</remarks>
589+
<summary>Gets the key sizes, in bits, that are supported by the symmetric algorithm.</summary>
590+
<value>The key sizes, in bits, that are supported by the symmetric algorithm.</value>
591+
<remarks><format type="text/markdown"><![CDATA[
592+
593+
## Remarks
594+
The valid key sizes for Rijndael are 128, 192 and 256 bits.
595+
]]></format></remarks>
576596
</Docs>
577597
</Member>
578598
<Member MemberName="Mode">
@@ -599,9 +619,13 @@
599619
<ReturnType>System.Security.Cryptography.CipherMode</ReturnType>
600620
</ReturnValue>
601621
<Docs>
602-
<summary>To be added.</summary>
603-
<value>To be added.</value>
604-
<remarks>To be added.</remarks>
622+
<summary>Gets or sets the mode for operation of the symmetric algorithm.</summary>
623+
<value>The mode for operation of the symmetric algorithm. The default is <see cref="F:System.Security.Cryptography.CipherMode.CBC" /></value>
624+
<remarks><format type="text/markdown"><![CDATA[
625+
626+
## Remarks
627+
See the <xref:System.Security.Cryptography.CipherMode> enumeration for a description of specific modes.
628+
]]></format></remarks>
605629
</Docs>
606630
</Member>
607631
<Member MemberName="Padding">
@@ -628,10 +652,14 @@
628652
<ReturnType>System.Security.Cryptography.PaddingMode</ReturnType>
629653
</ReturnValue>
630654
<Docs>
631-
<summary>To be added.</summary>
632-
<value>To be added.</value>
633-
<remarks>To be added.</remarks>
655+
<summary>Gets or sets the padding mode used in the symmetric algorithm.</summary>
656+
<value>The padding mode used in the symmetric algorithm. The default is <see cref="F:System.Security.Cryptography.PaddingMode.PKCS7" />.</value>
657+
<remarks><format type="text/markdown"><![CDATA[
658+
659+
## Remarks
660+
See the <xref:System.Security.Cryptography.SymmetricAlgorithm.Padding?displayProperty=nameWithType> property for more information about padding.
661+
]]></format></remarks>
634662
</Docs>
635663
</Member>
636664
</Members>
637-
</Type>
665+
</Type>

0 commit comments

Comments
 (0)
0