PasswordDeriveBytes Class

Derives a key from a password using an extension of the PBKDF1 algorithm.

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

<ComVisibleAttribute(True)> _
Public Class PasswordDeriveBytes
	Inherits DeriveBytes
Dim instance As PasswordDeriveBytes

/** @attribute ComVisibleAttribute(true) */ 
public class PasswordDeriveBytes extends DeriveBytes
public class PasswordDeriveBytes extends DeriveBytes

This class uses an extension of the PBKDF1 algorithm defined in the PKCS#5 v2.0 standard to derive bytes suitable for use as key material from a password. The standard is documented in IETF RRC 2898.

Security noteSecurity Note

Never hard-code a password within your source code. Hard coded passwords can be retrieved from an assembly using the MSIL Disassembler (Ildasm.exe) tool, a hex editor, or by simply opening up the assembly in a text editor like notepad.exe.

The following code example creates a key from a password using the PasswordDeriveBytes class.

Imports System
Imports System.Security.Cryptography
Imports System.Text

Module PasswordDerivedBytesExample

    Sub Main(ByVal args() As String)

        ' Get a password from the user.
        Console.WriteLine("Enter a password to produce a key:")

        '* Security Note: Never hard-code a password within your
        '* source code.  Hard-coded passwords can be retrieved 
        '* from a compiled assembly.
        Dim pwd As Byte() = Encoding.Unicode.GetBytes(Console.ReadLine())

        Dim salt As Byte() = createRandomSalt(7)

        ' Create a TripleDESCryptoServiceProvider object.
        Dim tdes As New TripleDESCryptoServiceProvider()

            Console.WriteLine("Creating a key with PasswordDeriveBytes...")

            ' Create a PasswordDeriveBytes object and then create 
            ' a TripleDES key from the password and salt.
            Dim pdb As New PasswordDeriveBytes(pwd, salt)

            ' Create the key and add it to the Key property.
            tdes.Key = pdb.CryptDeriveKey("TripleDES", "SHA1", 192, tdes.IV)

            Console.WriteLine("Operation complete.")
        Catch e As Exception
            ' Clear the buffers

            ' Clear the key.
        End Try


    End Sub

    '* Helper methods:
    '* createRandomSalt: Generates a random salt value of the 
    '*                   specified length.  
    '* clearBytes: Clear the bytes in a buffer so they can't 
    '*             later be read from memory.
    Function createRandomSalt(ByVal Length As Integer) As Byte()
        ' Create a buffer
        Dim randBytes() As Byte

        If Length >= 1 Then
            randBytes = New Byte(Length) {}
            randBytes = New Byte(0) {}
        End If

        ' Create a new RNGCryptoServiceProvider.
        Dim rand As New RNGCryptoServiceProvider()

        ' Fill the buffer with random bytes.

        ' return the bytes.
        Return randBytes

    End Function

    Sub clearBytes(ByVal Buffer() As Byte)
        ' Check arguments.
        If Buffer Is Nothing Then
            Throw New ArgumentException("Buffer")
        End If

        ' Set each byte in the buffer to 0.
        Dim x As Integer
        For x = 0 To Buffer.Length - 1
            Buffer(x) = 0
        Next x

    End Sub
End Module


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0