This topic has not yet been rated - Rate this topic

PasswordDeriveBytes.CryptDeriveKey Method

.NET Framework 4.5

Derives a cryptographic key from the PasswordDeriveBytes object.

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

public byte[] CryptDeriveKey(
	string algname,
	string alghashname,
	int keySize,
	byte[] rgbIV
)

Parameters

algname: Type: System.String
The algorithm name for which to derive the key.

alghashname: Type: System.String
The hash algorithm name to use to derive the key.

keySize: Type: System.Int32
The size of the key, in bits, to derive.

rgbIV: Type: System.Byte[]
The initialization vector (IV) to use to derive the key.

Return Value

Type: System.Byte[]
The derived key.

Exceptions

Exception	Condition
CryptographicException	The keySize parameter is incorrect. -or- The cryptographic service provider (CSP) cannot be acquired. -or- The algname parameter is not a valid algorithm name. -or- The alghashname parameter is not a valid hash algorithm name.

Exception

Condition

CryptographicException

The keySize parameter is incorrect.

-or-

The cryptographic service provider (CSP) cannot be acquired.

-or-

The algname parameter is not a valid algorithm name.

-or-

The alghashname parameter is not a valid hash algorithm name.

Remarks

This function is a wrapper for the Crypto API function CryptDeriveKey(), and is intended to offer interoperability with applications using the Crypto API.

If the keySize parameter is set to 0 bits, the default key size for the specified algorithm is used.

Examples

This code example is part of a larger example provided for the PasswordDeriveBytes class.

C++


            // Create the key and set it to the Key property 
            // of the TripleDESCryptoServiceProvider object.
            tdes.Key = pdb.CryptDeriveKey("TripleDES", "SHA1", 192, tdes.IV);

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

PasswordDeriveBytes Class

System.Security.Cryptography Namespace

Other Resources

Cryptographic Services

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)