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

class ipworksencrypt.PBKDF

Remarks

The PBKDF component implements PBKDF2 and PBKDF1 (Password-Based Key Derivation Function 1 & 2) as 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.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

algorithm Property

The underlying pseudorandom function.

Syntax

def get_algorithm() -> int: ...
def set_algorithm(value: int) -> None: ...

algorithm = property(get_algorithm, set_algorithm)

Default Value

0

Remarks

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

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

iterations Property

The number of iterations to perform.

Syntax

def get_iterations() -> int: ...
def set_iterations(value: int) -> None: ...

iterations = property(get_iterations, set_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

The derived key.

Syntax

def get_key() -> bytes: ...

key = property(get_key, None)

Default Value

""

Remarks

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

This property is read-only.

key_length Property

The desired length in bits of the derived key.

Syntax

def get_key_length() -> int: ...
def set_key_length(value: int) -> None: ...

key_length = property(get_key_length, set_key_length)

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

The password from which a derived key is generated.

Syntax

def get_password() -> bytes: ...
def set_password(value: bytes) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

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

salt Property

The cryptographic salt.

Syntax

def get_salt() -> bytes: ...
def set_salt(value: bytes) -> None: ...

salt = property(get_salt, set_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.

use_hex Property

Whether the key is hex encoded.

Syntax

def get_use_hex() -> bool: ...
def set_use_hex(value: bool) -> None: ...

use_hex = property(get_use_hex, set_use_hex)

Default Value

FALSE

Remarks

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

version Property

The PBKDF version.

Syntax

def get_version() -> int: ...
def set_version(value: int) -> None: ...

version = property(get_version, set_version)

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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

create_key Method

Creates a key.

Syntax

def create_key() -> None: ...

Remarks

This method creates a key using a version of the Password-Based Key Derivation Function (PBKDF).

The following properties are applicable when calling this method:

• password (required)
• salt (required)
• algorithm
• iterations
• key_length
• version

This method populates the key property with the created (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

Resets the class.

Syntax

def reset() -> None: ...

Remarks

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

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class PBKDFErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class PBKDF:
@property
def on_error() -> Callable[[PBKDFErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[PBKDFErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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

PBKDF Config Settings

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

Base Config Settings

PBKDF Errors

PBKDF Errors