This documentation is archived and is not being maintained.

Rfc2898DeriveBytes.IterationCount Property

Gets or sets the number of iterations for the operation.

Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)

public int IterationCount { get; set; }

Property Value

Type: System.Int32
The number of iterations for the operation.

ExceptionCondition
ArgumentOutOfRangeException

The number of iterations is less than 1.

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.

The following example shows how to use the 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 Rfc2898DeriveBytes class.


//The default iteration count is 1000 so the two methods use the same iteration count.
int myIterations = 1000;
try
{
    Rfc2898DeriveBytes k1 = new Rfc2898DeriveBytes(pwd1, salt1, myIterations);
    Rfc2898DeriveBytes k2 = new Rfc2898DeriveBytes(pwd1, salt1);
    // Encrypt the data.
    TripleDES encAlg = TripleDES.Create();
    encAlg.Key = k1.GetBytes(16);
    MemoryStream encryptionStream = new MemoryStream();
    CryptoStream encrypt = new CryptoStream(encryptionStream, encAlg.CreateEncryptor(), CryptoStreamMode.Write);
    byte[] utfD1 = new System.Text.UTF8Encoding(false).GetBytes(data1);

    encrypt.Write(utfD1, 0, utfD1.Length);
    encrypt.FlushFinalBlock();
    encrypt.Close();
    byte[] edata1 = encryptionStream.ToArray();
    k1.Reset();

    // Try to decrypt, thus showing it can be round-tripped.
    TripleDES decAlg = TripleDES.Create();
    decAlg.Key = k2.GetBytes(16);
    decAlg.IV = encAlg.IV;
    MemoryStream decryptionStreamBacking = new MemoryStream();
    CryptoStream decrypt = new CryptoStream(decryptionStreamBacking, decAlg.CreateDecryptor(), CryptoStreamMode.Write);
    decrypt.Write(edata1, 0, edata1.Length);
    decrypt.Flush();
    decrypt.Close();
    k2.Reset();
    string data2 = new UTF8Encoding(false).GetString(decryptionStreamBacking.ToArray());

    if (!data1.Equals(data2))
    {
        Console.WriteLine("Error: The two values are not equal.");
    }
    else
    {
        Console.WriteLine("The two values are equal.");
        Console.WriteLine("k1 iterations: {0}", k1.IterationCount);
        Console.WriteLine("k2 iterations: {0}", k2.IterationCount);
    }


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: