Struct ipworksencrypt::PBKDF

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEncrypt. Due to this, the PBKDF struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of PBKDF when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

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

algorithm property (PBKDF Struct)

The underlying pseudorandom function.

Syntax

fn algorithm(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_algorithm(&self, value : i32) ->  Option<IPWorksEncryptError> 

Possible Values

0   // HMACSHA1
1   // HMACSHA224
2   // HMACSHA256
3   // HMACSHA384
4   // HMACSHA512
5   // HMACMD5
6   // HMACRIPEMD160
7   // SHA1
8   // MD5
9   // MD2

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.

Data Type

i32

iterations property (PBKDF Struct)

The number of iterations to perform.

Syntax

fn iterations(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_iterations(&self, value : i32) ->  Option<IPWorksEncryptError> 

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.

Data Type

i32

key property (PBKDF Struct)

The derived key.

Syntax

fn key(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

Vec

key_length property (PBKDF Struct)

The desired length in bits of the derived key.

Syntax

fn key_length(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_key_length(&self, value : i32) ->  Option<IPWorksEncryptError> 

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.

Data Type

i32

password property (PBKDF Struct)

The password from which a derived key is generated.

Syntax

fn password(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_password(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_password_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

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

Data Type

Vec

salt property (PBKDF Struct)

The cryptographic salt.

Syntax

fn salt(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_salt(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_salt_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

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.

Data Type

Vec

use_hex property (PBKDF Struct)

Whether the key is hex encoded.

Syntax

fn use_hex(&self ) -> Result<bool, IPWorksEncryptError> 
fn set_use_hex(&self, value : bool) ->  Option<IPWorksEncryptError> 

Default Value

false

Remarks

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

Data Type

bool

version property (PBKDF Struct)

The PBKDF version.

Syntax

fn version(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_version(&self, value : i32) ->  Option<IPWorksEncryptError> 

Possible Values

0   // PBKDF1
1   // PBKDF2

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)

Data Type

i32

config method (PBKDF Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksEncryptError>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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 (PBKDF Struct)

Creates a key.

Syntax

fn create_key(&self) -> Result<(), IPWorksEncryptError>

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 (PBKDF Struct)

Resets the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksEncryptError>

Remarks

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

on_error event (PBKDF Struct)

Fired when information is available about errors during data delivery.

Syntax

// PBKDFErrorEventArgs carries the PBKDF Error event's parameters.
pub struct PBKDFErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// PBKDFErrorEvent defines the signature of the PBKDF Error event's handler function.
pub trait PBKDFErrorEvent {
  fn on_error(&self, sender : PBKDF, e : &mut PBKDFErrorEventArgs);
}

impl <'a> PBKDF<'a> {
  pub fn on_error(&self) -> &'a dyn PBKDFErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn PBKDFErrorEvent);
  ...
}

Remarks

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

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

Config Settings (PBKDF Struct)

The struct 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 struct, access to these internal properties is provided through the config method.

PBKDF Config Settings

Base Config Settings

Trappable Errors (PBKDF Struct)

PBKDF Errors