PBKDF Class
Properties Methods Events Configuration Settings Errors
The PBKDF class supports using PBKDF1 and PBKDF2 to derive a key using a variety of algorithms.
Syntax
class ipworksencrypt.PBKDF
Remarks
The PBKDF component implements PBKDF2(Password-Based Key Derivation Function 2) and PBKDF1 described in RFC 2898.
The simplest way to use the component is to simply specify the password and salt and call create_key. Before calling create_key additional properties such as algorithm, key_length, and iterations may be set. The component supports a variety of algorithms including HMAC-SHA1, HMAC-SHA256, HMAC-MD5, and more.
The version property controls whether PBKDF1 or PBKDF2 (default) is used, although it is recommended to use PBKDF2.
After calling create_key the derived key will be held in key.
Code Example:
Pbkdf pbkdf = new Pbkdf(); pbkdf.Password = "password"; pbkdf.Salt = "0123456789ABCDEF"; pbkdf.KeyLength = 4096; pbkdf.CreateKey(); //Now do something with pbkdf.Key
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
algorithm | The underlying pseudorandom function. |
iterations | The number of iterations to perform. |
key | The derived key. |
key_length | The desired length in bits of the derived key. |
password | The master password from which a derived key is generated. |
salt | The cryptographic salt. |
use_hex | Whether the key is hex encoded. |
version | The PBKDF version. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
config | Sets or retrieves a configuration setting. |
create_key | Creates a derived key. |
reset | Resets the class. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
on_error | Information about errors during data delivery. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
AllowEmptyPassword | Whether an empty password can be used. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |