# PBKDF Component

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

## Syntax

```text
nsoftware.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-component) and [Salt](#salt-property-pbkdf-component) and call [CreateKey](#createkey-method-pbkdf-component). Before calling [CreateKey](#createkey-method-pbkdf-component) additional properties such as [Algorithm](#algorithm-property-pbkdf-component), [KeyLength](#keylength-property-pbkdf-component), and [Iterations](#iterations-property-pbkdf-component) may be set. The component supports a variety of algorithms including HMAC-SHA1, HMAC-SHA256, HMAC-MD5, and more.

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

After calling [CreateKey](#createkey-method-pbkdf-component) the derived key will be held in [Key](#key-property-pbkdf-component).

**Code Example:**

```text
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 component with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Algorithm](#algorithm-property-pbkdf-component) | The underlying pseudorandom function. |
| [Iterations](#iterations-property-pbkdf-component) | The number of iterations to perform. |
| [Key](#key-property-pbkdf-component) | The derived key. |
| [KeyLength](#keylength-property-pbkdf-component) | The desired length in bits of the derived key. |
| [Password](#password-property-pbkdf-component) | The password from which a derived key is generated. |
| [Salt](#salt-property-pbkdf-component) | The cryptographic salt. |
| [UseHex](#usehex-property-pbkdf-component) | Whether the key is hex encoded. |
| [Version](#version-property-pbkdf-component) | The PBKDF version. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-pbkdf-component) | Sets or retrieves a configuration setting. |
| [CreateKey](#createkey-method-pbkdf-component) | Creates a key. |
| [Reset](#reset-method-pbkdf-component) | Resets the component. |

## Event List

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

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

## Config Settings

*The following is a list of config settings for the component 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. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Algorithm Property ([PBKDF](#pbkdf-component) Component)

The underlying pseudorandom function.

## Syntax

```text
public PBKDFAlgorithms Algorithm { get; set; }
enum PBKDFAlgorithms {
  pbHMACSHA1,
  pbHMACSHA224,
  pbHMACSHA256,
  pbHMACSHA384,
  pbHMACSHA512,
  pbHMACMD5,
  pbHMACRIPEMD160,
  pbSHA1,
  pbMD5,
  pbMD2
}
```

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

# Iterations Property ([PBKDF](#pbkdf-component) Component)

The number of iterations to perform.

## Syntax

```text
public int Iterations { get; set; }
```

## 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](#pbkdf-component) Component)

The derived key.

## Syntax

```text
public string Key { get; }
public byte[] KeyB { get; }
```

## Default Value

""

## Remarks

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

This property is read-only.

# KeyLength Property ([PBKDF](#pbkdf-component) Component)

The desired length in bits of the derived key.

## Syntax

```text
public int KeyLength { get; set; }
```

## Default Value

1024

## Remarks

This property specifies the length in bits of the [Key](#key-property-pbkdf-component).

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

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

# Password Property ([PBKDF](#pbkdf-component) Component)

The password from which a derived key is generated.

## Syntax

```text
public string Password { get; set; }
public byte[] PasswordB { get; set; }
```

## Default Value

""

## Remarks

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

# Salt Property ([PBKDF](#pbkdf-component) Component)

The cryptographic salt.

## Syntax

```text
public string Salt { get; set; }
public byte[] SaltB { get; set; }
```

## 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](#pbkdf-component) Component)

Whether the key is hex encoded.

## Syntax

```text
public bool UseHex { get; set; }
```

## Default Value

False

## Remarks

This setting specifies whether the created [Key](#key-property-pbkdf-component) is hex encoded when calling [CreateKey](#createkey-method-pbkdf-component). The default value is False.

# Version Property ([PBKDF](#pbkdf-component) Component)

The PBKDF version.

## Syntax

```text
public PBKDFVersions Version { get; set; }
enum PBKDFVersions {
  vPBKDF1,
  vPBKDF2
}
```

## 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](#pbkdf-component) Component)

Sets or retrieves a configuration setting.

## Syntax

```text
public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
```

## Remarks

Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-pbkdf-component) for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# CreateKey Method ([PBKDF](#pbkdf-component) Component)

Creates a key.

## Syntax

```text
public void CreateKey();

Async Version
public async Task CreateKey();
public async Task CreateKey(CancellationToken cancellationToken);
```

## 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-component) (required)
- [Salt](#salt-property-pbkdf-component) (required)
- [Algorithm](#algorithm-property-pbkdf-component)
- [Iterations](#iterations-property-pbkdf-component)
- [KeyLength](#keylength-property-pbkdf-component)
- [Version](#version-property-pbkdf-component)

 This method populates the [Key](#key-property-pbkdf-component) 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](#pbkdf-component) Component)

Resets the component.

## Syntax

```text
public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);
```

## Remarks

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

# Error Event ([PBKDF](#pbkdf-component) Component)

Fired when information is available about errors during data delivery.

## Syntax

```text
public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, PBKDFErrorEventArgs e);

public class PBKDFErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
```

## Remarks

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

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](#trappable-errors-pbkdf-component) section.

# Config Settings ([PBKDF](#pbkdf-component) Component)

 The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-pbkdf-component) 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-component). 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.

**GUIAvailable**: 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 component 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](#GUIAvailable) to *false* will ensure that the component 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 component 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*.

**UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *true*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*.

Setting this configuration setting to *true* tells the component 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.

NOTE: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

# Trappable Errors ([PBKDF](#pbkdf-component) Component)

### PBKDF Errors

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