# Struct ipworksencrypt::PBKDF

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

## Syntax

```text
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](#password-property-pbkdf-struct) and [salt](#salt-property-pbkdf-struct) and call [create_key](#create_key-method-pbkdf-struct). Before calling [create_key](#create_key-method-pbkdf-struct) additional properties such as [algorithm](#algorithm-property-pbkdf-struct), [key_length](#key_length-property-pbkdf-struct), and [iterations](#iterations-property-pbkdf-struct) may be set. The component supports a variety of algorithms including HMAC-SHA1, HMAC-SHA256, HMAC-MD5, and more.

The [version](#version-property-pbkdf-struct) property controls whether PBKDF1 or PBKDF2 (default) is used, although it is recommended to use PBKDF2.

After calling [create_key](#create_key-method-pbkdf-struct) the derived key will be held in [key](#key-property-pbkdf-struct).

**Code Example:**

```text
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.*

|  |  |
| --- | --- |
| [algorithm](#algorithm-property-pbkdf-struct) | The underlying pseudorandom function. |
| [iterations](#iterations-property-pbkdf-struct) | The number of iterations to perform. |
| [key](#key-property-pbkdf-struct) | The derived key. |
| [key_length](#key_length-property-pbkdf-struct) | The desired length in bits of the derived key. |
| [password](#password-property-pbkdf-struct) | The password from which a derived key is generated. |
| [salt](#salt-property-pbkdf-struct) | The cryptographic salt. |
| [use_hex](#use_hex-property-pbkdf-struct) | Whether the key is hex encoded. |
| [version](#version-property-pbkdf-struct) | The PBKDF version. |

## Method List

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

|  |  |
| --- | --- |
| [config](#config-method-pbkdf-struct) | Sets or retrieves a configuration setting. |
| [create_key](#create_key-method-pbkdf-struct) | Creates a key. |
| [reset](#reset-method-pbkdf-struct) | Resets the struct. |

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

|  |  |
| --- | --- |
| [on_error](#on_error-event-pbkdf-struct) | Fired when information is available about errors during data delivery. |

## Config Settings

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

|  |  |
| --- | --- |
| [AllowEmptyPassword](#AllowEmptyPassword) | Whether an empty password can be used. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# algorithm property ([PBKDF](#struct-ipworksencryptpbkdf) Struct)

The underlying pseudorandom function.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // HMACSHA11   // HMACSHA2242   // HMACSHA2563   // HMACSHA3844   // HMACSHA5125   // HMACMD56   // HMACRIPEMD1607   // SHA18   // MD59   // MD2
```

## 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 [key_length](#key_length-property-pbkdf-struct) value is 160 bits for SHA1, and 128 bits for MD2 and MD5.

## Data Type

i32

# iterations property ([PBKDF](#struct-ipworksencryptpbkdf) Struct)

The number of iterations to perform.

## Syntax

*Rust Syntax*

```text
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-ipworksencryptpbkdf) Struct)

The derived key.

## Syntax

*Rust Syntax*

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

## Default Value

""

## Remarks

This property holds the derived key. After calling [create_key](#create_key-method-pbkdf-struct) this property will be populated.

This property is read-only.

## Data Type

Vec

# key_length property ([PBKDF](#struct-ipworksencryptpbkdf) Struct)

The desired length in bits of the derived key.

## Syntax

*Rust Syntax*

```text
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](#key-property-pbkdf-struct).

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

Note: When [version](#version-property-pbkdf-struct) is set to PBKDF1 certain restrictions apply. When [algorithm](#algorithm-property-pbkdf-struct) is set to MD5 the maximum length is 128. When [algorithm](#algorithm-property-pbkdf-struct) is set to SHA1 the maximum value is 160.

## Data Type

i32

# password property ([PBKDF](#struct-ipworksencryptpbkdf) Struct)

The password from which a derived key is generated.

## Syntax

*Rust Syntax*

```text
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-ipworksencryptpbkdf) Struct)

The cryptographic salt.

## Syntax

*Rust Syntax*

```text
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-ipworksencryptpbkdf) Struct)

Whether the key is hex encoded.

## Syntax

*Rust Syntax*

```text
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](#key-property-pbkdf-struct) is hex encoded when calling [create_key](#create_key-method-pbkdf-struct). The default value is False.

## Data Type

bool

# version property ([PBKDF](#struct-ipworksencryptpbkdf) Struct)

The PBKDF version.

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // PBKDF11   // 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-ipworksencryptpbkdf) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
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](#config-settings-pbkdf-struct) 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](#config-settings-pbkdf-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# create_key method ([PBKDF](#struct-ipworksencryptpbkdf) Struct)

Creates a key.

## Syntax

*Rust Syntax*

```text
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](#password-property-pbkdf-struct) (required)
- [salt](#salt-property-pbkdf-struct) (required)
- [algorithm](#algorithm-property-pbkdf-struct)
- [iterations](#iterations-property-pbkdf-struct)
- [key_length](#key_length-property-pbkdf-struct)
- [version](#version-property-pbkdf-struct)

 This method populates the [key](#key-property-pbkdf-struct) property with the created (derived) key.

**Code Example:**

```text
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-ipworksencryptpbkdf) Struct)

Resets the struct.

## Syntax

*Rust Syntax*

```text
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-ipworksencryptpbkdf) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// 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](#trappable-errors-pbkdf-struct) section.

# Config Settings ([PBKDF](#struct-ipworksencryptpbkdf) 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](#config-method-pbkdf-struct) 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](#password-property-pbkdf-struct). An empty string or empty byte array can be used, like in the example below.

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

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct 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.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([PBKDF](#struct-ipworksencryptpbkdf) Struct)

### PBKDF Errors

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