IPWorks Encrypt 2022 Java Edition
Version 22.0 [Build 8369]

PBKDF Class

Properties   Methods   Events   Config Settings   Errors  

The PBKDF class supports using PBKDF1 and PBKDF2 to derive a key using a variety of algorithms.

Syntax

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

ErrorInformation about errors during data delivery.

Config Settings


The following is a list of config 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.
GUIAvailableTells the class whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseDaemonThreadsWhether threads created by the class are daemon threads.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Algorithm Property (PBKDF Class)

The underlying pseudorandom function.

Syntax


public int getAlgorithm();


public void setAlgorithm(int algorithm);


Enumerated values:
  public final static int pbHMACSHA1 = 0;
  public final static int pbHMACSHA224 = 1;
  public final static int pbHMACSHA256 = 2;
  public final static int pbHMACSHA384 = 3;
  public final static int pbHMACSHA512 = 4;
  public final static int pbHMACMD5 = 5;
  public final static int pbHMACRIPEMD160 = 6;
  public final static int pbSHA1 = 7;
  public final static int pbMD5 = 8;
  public final static int pbMD2 = 9;

Default Value

0

Remarks

This property specifies the algorithm used for the pseudo random function. Possible values are:

0 (pbHMACSHA1 - default) HMAC-SHA1, The default value and most commonly used.
1 (pbHMACSHA224) HMAC-SHA224
2 (pbHMACSHA256) HMAC-SHA256
3 (pbHMACSHA384) HMAC-SHA284
4 (pbHMACSHA512) HMAC-SHA512
5 (pbHMACMD5) HMAC-MD5
6 (pbHMACRIPEMD160) HMAC-RIPEMD160
7 (pbSHA1) SHA1, Only used with PBKDF1.
8 (pbMD5) MD5, Only used with PBKDF1.
9 (pbMD2) MD2, Only used with PBKDF1.

Note: When using PBDKF1 the maximum KeyLength value is 160 bits for SHA1, and 128 bits for MD2 and MD5.

Iterations Property (PBKDF Class)

The number of iterations to perform.

Syntax


public int getIterations();


public void setIterations(int iterations);

Default Value

10000

Remarks

This property specifies the number of iterations to perform when deriving the key. Larger values require more time to derive a key, however they also make password cracking more difficult by increasing the amount of time required to derive each key.

The recommended minimum number of iterations is 1000, and larger values such as 10,000 are common. The default value is 10000.

Key Property (PBKDF Class)

The derived key.

Syntax


public byte[] getKey();


Default Value

""

Remarks

This property holds the derived key. After calling CreateKey this property will be populated.

This property is read-only.

KeyLength Property (PBKDF Class)

The desired length in bits of the derived key.

Syntax


public int getKeyLength();


public void setKeyLength(int keyLength);

Default Value

1024

Remarks

This property specifies the length in bits of the Key.

The provided value must be divisible by 8. The default value is 1024.

Note: When Version is set to PBKDF1 certain restrictions apply. When Algorithm is set to MD5 the maximum length is 128. When Algorithm is set to SHA1 the maximum value is 160.

Password Property (PBKDF Class)

The master password from which a derived key is generated.

Syntax


public byte[] getPassword();


public void setPassword(byte[] password);

Default Value

""

Remarks

This property specifies the password from which the derived key is created.

Salt Property (PBKDF Class)

The cryptographic salt.

Syntax


public byte[] getSalt();


public void setSalt(byte[] salt);

Default Value

""

Remarks

This property specifies the salt used during key creation.

It is recommended to provide a salt value of at least 64 bits in length. A common length is 128 bits. It is also recommended that the salt value be randomly chosen.

UseHex Property (PBKDF Class)

Whether the key is hex encoded.

Syntax


public boolean isUseHex();


public void setUseHex(boolean useHex);

Default Value

False

Remarks

This setting specifies whether the created Key is hex encoded when calling CreateKey. The default value is False.

Version Property (PBKDF Class)

The PBKDF version.

Syntax


public int getVersion();


public void setVersion(int version);


Enumerated values:
  public final static int vPBKDF1 = 0;
  public final static int vPBKDF2 = 1;

Default Value

1

Remarks

This property specifies the PBKDF version to be used. It is recommended to use PBKDF2 for new applications. PBKDF1 is included only for compatibility with existing applications and is not recommended.

Possible values are:

  • 0 (vPBKDF1)
  • 1 (vPBKDF2 - default)

Config Method (Pbkdf Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateKey Method (Pbkdf Class)

Creates a derived key.

Syntax

public void createKey();

Remarks

This method creates a derived key based.

The following properties are applicable when calling this method:

This method populates the Key property with the derived key.

Code Example: Pbkdf pbkdf = new Pbkdf(); pbkdf.Password = "password"; pbkdf.Salt = "0123456789ABCDEF"; pbkdf.KeyLength = 4096; pbkdf.CreateKey(); //Now do something with pbkdf.Key

Reset Method (Pbkdf Class)

Resets the class.

Syntax

public void reset();

Remarks

When called, the class will reset all of its properties to their default values.

Error Event (Pbkdf Class)

Information about errors during data delivery.

Syntax

public class DefaultPbkdfEventListener implements PbkdfEventListener {
  ...
  public void error(PbkdfErrorEvent e) {}
  ...
}

public class PbkdfErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Config Settings (Pbkdf Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

PBKDF Config Settings

AllowEmptyPassword:   Whether an empty password can be used.

This setting specifies whether or not you can pass an empty password to Password. An empty string or empty byte array can be used, like in the example below. Pbkdf pw = new Pbkdf(); pw.Config("EncodeKey=true"); pw.Config("AllowEmptyPassword=true"); //pw.PasswordB = new byte[0]; pw.Password = ""; pw.Salt = "saltsalt"; pw.Iterations = 100; pw.KeyLength = 160; pw.Version = PbkdfVersions.vPBKDF2; pw.Algorithm = PbkdfAlgorithms.pbHMACSHA1; pw.CreateKey(); The default value is False.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Tells the class whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
UseDaemonThreads:   Whether threads created by the class are daemon threads.

If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to true tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (Pbkdf Class)

PBKDF Errors

116   Password must be set.
117   An error occurred during hash calculation.
118   An invalid algorithm was specified.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Encrypt 2022 Java Edition - Version 22.0 [Build 8369]