Skip to content

Remove opinions from Rfc2898DeriveBytes docs #12694

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
bartonjs merged 2 commits into from
Jun 2, 2026
Merged

Remove opinions from Rfc2898DeriveBytes docs #12694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
120dfc2
Remove opinions from Rfc2898DeriveBytes docs
bartonjs Jun 1, 2026
148fbcf
Also update the VB sample
bartonjs Jun 2, 2026
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
2 changes: 1 addition & 1 deletion snippets/csharp/System.Security.Cryptography/Rfc2898DeriveBytes/Overview/rfc28981.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public static void Main(string[] passwordargs)
//data1 can be a string or contents of a file.
string data1 = "Some test data";
//<SNIPPET3>
//The default iteration count is 1000 so the two methods use the same iteration count.
//The legacy default iteration count is 1000 so the two methods use the same iteration count.
Comment thread
bartonjs marked this conversation as resolved.
int myIterations = 1000;
//</SNIPPET6>
//<SNIPPET2>
Expand Down
2 changes: 1 addition & 1 deletion snippets/visualbasic/System.Security.Cryptography/Rfc2898DeriveBytes/Overview/rfc28981.vb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
'<SNIPPET1>
Imports System.IO
Imports System.Text
Expand Down Expand Up @@ -28,7 +28,7 @@
'data1 can be a string or contents of a file.
Dim data1 As String = "Some test data"
'<SNIPPET3>
'The default iteration count is 1000 so the two methods use the same iteration count.
'The legacy default iteration count is 1000 so the two methods use the same iteration count.
Dim myIterations As Integer = 1000
'</SNIPPET6>
'<SNIPPET2>
Expand Down
12 changes: 3 additions & 9 deletions xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ For more information about PBKDF2, see [RFC 2898](https://www.rfc-editor.org/inf
<format type="text/markdown"><![CDATA[

## Remarks
The salt size must be 8 bytes or larger and the iteration count must be greater than zero. The minimum recommended number of iterations is 1000.
The salt size must be 8 bytes or larger and the iteration count must be greater than zero.

RFC 2898 includes methods for creating a key and initialization vector (IV) from a password and salt. You can use PBKDF2, a password-based key derivation function, to derive keys using a pseudo-random function that allows keys of virtually unlimited length to be generated. The <xref:System.Security.Cryptography.Rfc2898DeriveBytes> class can be used to produce a derived key from a base key and other parameters. In a password-based key derivation function, the base key is a password and the other parameters are a salt value and an iteration count.

Expand Down Expand Up @@ -398,7 +398,7 @@ For more information about PBKDF2, see [RFC 2898](https://www.rfc-editor.org/inf
<format type="text/markdown"><![CDATA[

## Remarks
The salt size must be 8 bytes or larger and the iteration count must be greater than zero. The minimum recommended number of iterations is 1000.
The salt size must be 8 bytes or larger and the iteration count must be greater than zero.

RFC 2898 includes methods for creating a key and initialization vector (IV) from a password and salt. You can use PBKDF2, a password-based key derivation function, to derive keys using a pseudo-random function that allows keys of virtually unlimited length to be generated. The <xref:System.Security.Cryptography.Rfc2898DeriveBytes> class can be used to produce a derived key from a base key and other parameters. In a password-based key derivation function, the base key is a password and the other parameters are a salt value and an iteration count.

Expand Down Expand Up @@ -482,7 +482,7 @@ For more information about PBKDF2, see [RFC 2898](https://www.rfc-editor.org/inf
<format type="text/markdown"><![CDATA[

## Remarks
The salt size must be 8 bytes or larger and the iteration count must be greater than zero. The minimum recommended number of iterations is 1000.
The salt size must be 8 bytes or larger and the iteration count must be greater than zero.

RFC 2898 includes methods for creating a key and initialization vector (IV) from a password and salt. You can use PBKDF2, a password-based key derivation function, to derive keys using a pseudo-random function that allows keys of virtually unlimited length to be generated. The <xref:System.Security.Cryptography.Rfc2898DeriveBytes> class can be used to produce a derived key from a base key and other parameters. In a password-based key derivation function, the base key is a password and the other parameters are a salt value and an iteration count.

Expand Down Expand Up @@ -965,12 +965,6 @@ For more information about PBKDF2, see [RFC 2898](https://www.rfc-editor.org/inf
<value>The number of iterations for the operation.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
Iteration count is the number of times an operation is performed. For this method, the count should be greater than zero. The minimum recommended number of iterations is 1000.



## Examples
The following example shows how to use the <xref:System.Security.Cryptography.Rfc2898DeriveBytes.IterationCount> property to display the number of iterations used in the generation of the key. This code example is part of a larger example provided for the <xref:System.Security.Cryptography.Rfc2898DeriveBytes> class.

Expand Down
Loading