IPWorks Encrypt 2020 iOS Edition

Questions / Feedback?

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

IPWorksEncryptPBKDF
IPWorksEncryptPBKDFSwift

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 CreateKey. Before calling CreateKey additional properties such as Algorithm, KeyLength, 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 CreateKey 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.

- algorithmThe underlying pseudorandom function.
- iterationsThe number of iterations to perform.
- keyThe derived key.
- keyLengthThe desired length in bits of the derived key.
- passwordThe master password from which a derived key is generated.
- saltThe cryptographic salt.
- useHexWhether the key is hex encoded.
- versionThe 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.

- configSets or retrieves a configuration setting.
- createKeyCreates a derived key.
- resetResets 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.

- onErrorInformation 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.

AllowEmptyPasswordWhether an empty password can be used.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2020 iOS Edition - Version 20.0 [Build 8155]