# NTLM Component

The NTLM component provides a simple API to create the required tokens for NTLM authentication.

## Syntax

```text
TipaNTLM
```

## Remarks

This component provides a simple API to create the required tokens for NTLM authentication.

The NTLM authentication process is a challenge-response scheme which consists of three messages. These three messages are the negotiation, challenge, and authentication. This component implements only the client side of NTLM and will create the negotiation and authentication tokens. The component does not transmit any data, it simply prepares the tokens for use in other transport protocols such as HTTP. The following steps describe how the component is used.

**Create the Negotiate Token**

To begin first set [User](#user-property-ntlm-component) and [Password](#password-property-ntlm-component). The user value may contain domain information in the format "DOMAIN\User" or "user@domain". Next call [CreateNegotiateToken](#createnegotiatetoken-method-ntlm-component) to populate [NegotiateToken](#negotiatetoken-property-ntlm-component). This token may then be transmitted separately. For instance in HTTP this would be sent in a request within the Authorization header:

```text
HTTPHeader = "Authorization: NTLM " + NegotiateToken
```

**Create the Auth Token**

After sending the negotiate token over the chosen transport protocol, the server will respond with a challenge token. Set [ChallengeToken](#challengetoken-property-ntlm-component) to the token received from the server. For instance, in HTTP the server will respond with the challenge token in the WWW-Authenticate header:

```text
WWW-Authenticate: NTLM <ChallengeToken>
```

 After setting [User](#user-property-ntlm-component), [Password](#password-property-ntlm-component), and [ChallengeToken](#challengetoken-property-ntlm-component) call [CreateAuthToken](#createauthtoken-method-ntlm-component). This will populate [AuthToken](#authtoken-property-ntlm-component) with the created token. This token may then be transmitted separately. For instance in HTTP this would be sent in the request within the Authorization header:

```text
HTTPHeader = "Authorization: NTLM " + AuthToken
```

NOTE: If the server requires EPA (Extended Protection for Authentication), then SSLServerCert must be set to the server's public certificate before calling [CreateAuthToken](#createauthtoken-method-ntlm-component).

## Property List

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

|  |  |
| --- | --- |
| [AuthToken](#authtoken-property-ntlm-component) | The authentication token. |
| [ChallengeToken](#challengetoken-property-ntlm-component) | The challenge token. |
| [NegotiateToken](#negotiatetoken-property-ntlm-component) | The negotiate token. |
| [NTLMVersion](#ntlmversion-property-ntlm-component) | The NTLM version. |
| [Password](#password-property-ntlm-component) | The user's password. |
| [SSLServerCertEffectiveDate](#sslservercerteffectivedate-property-ntlm-component) | The date on which this certificate becomes valid. |
| [SSLServerCertExpirationDate](#sslservercertexpirationdate-property-ntlm-component) | The date on which the certificate expires. |
| [SSLServerCertExtendedKeyUsage](#sslservercertextendedkeyusage-property-ntlm-component) | A comma-delimited list of extended key usage identifiers. |
| [SSLServerCertFingerprint](#sslservercertfingerprint-property-ntlm-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLServerCertFingerprintSHA1](#sslservercertfingerprintsha1-property-ntlm-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLServerCertFingerprintSHA256](#sslservercertfingerprintsha256-property-ntlm-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLServerCertIssuer](#sslservercertissuer-property-ntlm-component) | The issuer of the certificate. |
| [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ntlm-component) | The private key of the certificate (if available). |
| [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-ntlm-component) | Whether a PrivateKey is available for the selected certificate. |
| [SSLServerCertPrivateKeyContainer](#sslservercertprivatekeycontainer-property-ntlm-component) | The name of the PrivateKey container for the certificate (if available). |
| [SSLServerCertPublicKey](#sslservercertpublickey-property-ntlm-component) | The public key of the certificate. |
| [SSLServerCertPublicKeyAlgorithm](#sslservercertpublickeyalgorithm-property-ntlm-component) | The textual description of the certificate's public key algorithm. |
| [SSLServerCertPublicKeyLength](#sslservercertpublickeylength-property-ntlm-component) | The length of the certificate's public key (in bits). |
| [SSLServerCertSerialNumber](#sslservercertserialnumber-property-ntlm-component) | The serial number of the certificate encoded as a string. |
| [SSLServerCertSignatureAlgorithm](#sslservercertsignaturealgorithm-property-ntlm-component) | The text description of the certificate's signature algorithm. |
| [SSLServerCertStore](#sslservercertstore-property-ntlm-component) | The name of the certificate store for the client certificate. |
| [SSLServerCertStorePassword](#sslservercertstorepassword-property-ntlm-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLServerCertStoreType](#sslservercertstoretype-property-ntlm-component) | The type of certificate store for this certificate. |
| [SSLServerCertSubjectAltNames](#sslservercertsubjectaltnames-property-ntlm-component) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLServerCertThumbprintMD5](#sslservercertthumbprintmd5-property-ntlm-component) | The MD5 hash of the certificate. |
| [SSLServerCertThumbprintSHA1](#sslservercertthumbprintsha1-property-ntlm-component) | The SHA-1 hash of the certificate. |
| [SSLServerCertThumbprintSHA256](#sslservercertthumbprintsha256-property-ntlm-component) | The SHA-256 hash of the certificate. |
| [SSLServerCertUsage](#sslservercertusage-property-ntlm-component) | The text description of UsageFlags . |
| [SSLServerCertUsageFlags](#sslservercertusageflags-property-ntlm-component) | The flags that show intended use for the certificate. |
| [SSLServerCertVersion](#sslservercertversion-property-ntlm-component) | The certificate's version number. |
| [SSLServerCertSubject](#sslservercertsubject-property-ntlm-component) | The subject of the certificate used for client authentication. |
| [SSLServerCertEncoded](#sslservercertencoded-property-ntlm-component) | The certificate (PEM/Base64 encoded). |
| [User](#user-property-ntlm-component) | The user. |

## 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-ntlm-component) | Sets or retrieves a configuration setting. |
| [CreateAuthToken](#createauthtoken-method-ntlm-component) | Creates the authentication token. |
| [CreateNegotiateToken](#createnegotiatetoken-method-ntlm-component) | Creates the negotiate token. |
| [Reset](#reset-method-ntlm-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-ntlm-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.*

|  |  |
| --- | --- |
| [DecodeToken](#DecodeToken) | Whether to Base64 encode the token. |
| [EncodeToken](#EncodeToken) | Whether to Base64 encode the token. |
| [UsePlatformNTLMAPI](#UsePlatformNTLMAPI) | Whether to use the platform NTLM API. |
| [Workstation](#Workstation) | The workstation name. |
| [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. |
| [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. |

# AuthToken Property ([NTLM](#ntlm-component) Component)

The authentication token.

## Syntax

*C++ Builder Syntax*

```text
__property String AuthToken = { read=FAuthToken };
__property DynamicArray<Byte> AuthTokenB = { read=FAuthTokenB };
```

## Default Value

""

## Remarks

This property holds the created authentication token. This property is populated after calling [CreateAuthToken](#createauthtoken-method-ntlm-component).

Note: By default this value is Base64 encoded. Set [EncodeToken](#EncodeToken) to False before calling [CreateAuthToken](#createauthtoken-method-ntlm-component) to obtain the raw value.

This property is read-only.

## Data Type

Byte Array

# ChallengeToken Property ([NTLM](#ntlm-component) Component)

The challenge token.

## Syntax

*C++ Builder Syntax*

```text
__property String ChallengeToken = { read=FChallengeToken, write=FSetChallengeToken };
__property DynamicArray<Byte> ChallengeTokenB = { read=FChallengeTokenB, write=FSetChallengeTokenB };
```

## Default Value

""

## Remarks

This property specifies the challenge token. This must be set to the challenge token received from the server before calling [CreateAuthToken](#createauthtoken-method-ntlm-component).

Note: By default the component expects the token to be Base64 encoded. To provide a raw value to this property first set [DecodeToken](#DecodeToken) to False.

## Data Type

Byte Array

# NegotiateToken Property ([NTLM](#ntlm-component) Component)

The negotiate token.

## Syntax

*C++ Builder Syntax*

```text
__property String NegotiateToken = { read=FNegotiateToken };
__property DynamicArray<Byte> NegotiateTokenB = { read=FNegotiateTokenB };
```

## Default Value

""

## Remarks

This property is populated after calling [CreateNegotiateToken](#createnegotiatetoken-method-ntlm-component). By default the value is Base64 encoded. To obtain the raw value set [EncodeToken](#EncodeToken) to False before calling [CreateNegotiateToken](#createnegotiatetoken-method-ntlm-component).

This property is read-only.

## Data Type

Byte Array

# NTLMVersion Property ([NTLM](#ntlm-component) Component)

The NTLM version.

## Syntax

*C++ Builder Syntax*

```text
__property TipaNTLMNTLMVersions NTLMVersion = { read=FNTLMVersion, write=FSetNTLMVersion };
enum TipaNTLMNTLMVersions {
  ntNTLMv1=1,
  ntNTLMv2=2
};
```

## Default Value

ntNTLMv1

## Remarks

This property specifies the NTLM version to use. Possible values are:

- 1 (ntNTLMv1 - default)
- 2 (ntNTLMv2)

Note: If the server requires EPA (Extended Protection for Authentication) this property must be set to 2 (ntNTLMv2).

## Data Type

Integer

# Password Property ([NTLM](#ntlm-component) Component)

The user's password.

## Syntax

*C++ Builder Syntax*

```text
__property String Password = { read=FPassword, write=FSetPassword };
```

## Default Value

""

## Remarks

This property specifies the user's password.

## Data Type

String

# SSLServerCertEffectiveDate Property ([NTLM](#ntlm-component) Component)

The date on which this certificate becomes valid.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertEffectiveDate = { read=FSSLServerCertEffectiveDate };
```

## Default Value

""

## Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

## Data Type

String

# SSLServerCertExpirationDate Property ([NTLM](#ntlm-component) Component)

The date on which the certificate expires.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertExpirationDate = { read=FSSLServerCertExpirationDate };
```

## Default Value

""

## Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

## Data Type

String

# SSLServerCertExtendedKeyUsage Property ([NTLM](#ntlm-component) Component)

A comma-delimited list of extended key usage identifiers.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertExtendedKeyUsage = { read=FSSLServerCertExtendedKeyUsage };
```

## Default Value

""

## Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

## Data Type

String

# SSLServerCertFingerprint Property ([NTLM](#ntlm-component) Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertFingerprint = { read=FSSLServerCertFingerprint };
```

## Default Value

""

## Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

This property is read-only.

## Data Type

String

# SSLServerCertFingerprintSHA1 Property ([NTLM](#ntlm-component) Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertFingerprintSHA1 = { read=FSSLServerCertFingerprintSHA1 };
```

## Default Value

""

## Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

This property is read-only.

## Data Type

String

# SSLServerCertFingerprintSHA256 Property ([NTLM](#ntlm-component) Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertFingerprintSHA256 = { read=FSSLServerCertFingerprintSHA256 };
```

## Default Value

""

## Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

This property is read-only.

## Data Type

String

# SSLServerCertIssuer Property ([NTLM](#ntlm-component) Component)

The issuer of the certificate.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertIssuer = { read=FSSLServerCertIssuer };
```

## Default Value

""

## Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

## Data Type

String

# SSLServerCertPrivateKey Property ([NTLM](#ntlm-component) Component)

The private key of the certificate (if available).

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertPrivateKey = { read=FSSLServerCertPrivateKey };
```

## Default Value

""

## Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ntlm-component) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ntlm-component) returns an empty string.

This property is read-only.

## Data Type

String

# SSLServerCertPrivateKeyAvailable Property ([NTLM](#ntlm-component) Component)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*C++ Builder Syntax*

```text
__property bool SSLServerCertPrivateKeyAvailable = { read=FSSLServerCertPrivateKeyAvailable };
```

## Default Value

false

## Remarks

Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ntlm-component) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-ntlm-component) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

Boolean

# SSLServerCertPrivateKeyContainer Property ([NTLM](#ntlm-component) Component)

The name of the PrivateKey container for the certificate (if available).

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertPrivateKeyContainer = { read=FSSLServerCertPrivateKeyContainer };
```

## Default Value

""

## Remarks

The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ntlm-component) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# SSLServerCertPublicKey Property ([NTLM](#ntlm-component) Component)

The public key of the certificate.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertPublicKey = { read=FSSLServerCertPublicKey };
```

## Default Value

""

## Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

## Data Type

String

# SSLServerCertPublicKeyAlgorithm Property ([NTLM](#ntlm-component) Component)

The textual description of the certificate's public key algorithm.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertPublicKeyAlgorithm = { read=FSSLServerCertPublicKeyAlgorithm };
```

## Default Value

""

## Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

## Data Type

String

# SSLServerCertPublicKeyLength Property ([NTLM](#ntlm-component) Component)

The length of the certificate's public key (in bits).

## Syntax

*C++ Builder Syntax*

```text
__property int SSLServerCertPublicKeyLength = { read=FSSLServerCertPublicKeyLength };
```

## Default Value

0

## Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

## Data Type

Integer

# SSLServerCertSerialNumber Property ([NTLM](#ntlm-component) Component)

The serial number of the certificate encoded as a string.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertSerialNumber = { read=FSSLServerCertSerialNumber };
```

## Default Value

""

## Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

## Data Type

String

# SSLServerCertSignatureAlgorithm Property ([NTLM](#ntlm-component) Component)

The text description of the certificate's signature algorithm.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertSignatureAlgorithm = { read=FSSLServerCertSignatureAlgorithm };
```

## Default Value

""

## Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

## Data Type

String

# SSLServerCertStore Property ([NTLM](#ntlm-component) Component)

The name of the certificate store for the client certificate.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertStore = { read=FSSLServerCertStore, write=FSetSSLServerCertStore };
__property DynamicArray<Byte> SSLServerCertStoreB = { read=FSSLServerCertStoreB, write=FSetSSLServerCertStoreB };
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [SSLServerCertStoreType](#sslservercertstoretype-property-ntlm-component) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-ntlm-component). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-ntlm-component).

[SSLServerCertStore](#sslservercertstore-property-ntlm-component) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-ntlm-component) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-ntlm-component) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-ntlm-component) or [SSLServerCertEncoded](#sslservercertencoded-property-ntlm-component) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-ntlm-component) property for details.

 Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

## Data Type

Byte Array

# SSLServerCertStorePassword Property ([NTLM](#ntlm-component) Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertStorePassword = { read=FSSLServerCertStorePassword, write=FSetSSLServerCertStorePassword };
```

## Default Value

""

## Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

## Data Type

String

# SSLServerCertStoreType Property ([NTLM](#ntlm-component) Component)

The type of certificate store for this certificate.

## Syntax

*C++ Builder Syntax*

```text
__property TipaNTLMSSLServerCertStoreTypes SSLServerCertStoreType = { read=FSSLServerCertStoreType, write=FSetSSLServerCertStoreType };
enum TipaNTLMSSLServerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};
```

## Default Value

cstUser

## Remarks

The type of certificate store for this certificate.

 The component supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the component will automatically determine the type. This property can take one of the following values:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLServerCertStoreType](#sslservercertstoretype-property-ntlm-component), the full path of the PKCS#11 DLL as the [SSLServerCertStore](#sslservercertstore-property-ntlm-component), and the PIN as the [SSLServerCertStorePassword](#sslservercertstorepassword-property-ntlm-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) component by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLServerCertStore](#sslservercertstore-property-ntlm-component) and set [SSLServerCertStorePassword](#sslservercertstorepassword-property-ntlm-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

Integer

# SSLServerCertSubjectAltNames Property ([NTLM](#ntlm-component) Component)

Comma-separated lists of alternative subject names for the certificate.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertSubjectAltNames = { read=FSSLServerCertSubjectAltNames };
```

## Default Value

""

## Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

## Data Type

String

# SSLServerCertThumbprintMD5 Property ([NTLM](#ntlm-component) Component)

The MD5 hash of the certificate.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertThumbprintMD5 = { read=FSSLServerCertThumbprintMD5 };
```

## Default Value

""

## Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

## Data Type

String

# SSLServerCertThumbprintSHA1 Property ([NTLM](#ntlm-component) Component)

The SHA-1 hash of the certificate.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertThumbprintSHA1 = { read=FSSLServerCertThumbprintSHA1 };
```

## Default Value

""

## Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

## Data Type

String

# SSLServerCertThumbprintSHA256 Property ([NTLM](#ntlm-component) Component)

The SHA-256 hash of the certificate.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertThumbprintSHA256 = { read=FSSLServerCertThumbprintSHA256 };
```

## Default Value

""

## Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

## Data Type

String

# SSLServerCertUsage Property ([NTLM](#ntlm-component) Component)

The text description of UsageFlags .

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertUsage = { read=FSSLServerCertUsage };
```

## Default Value

""

## Remarks

The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ntlm-component).

This value will be one or more of the following strings and will be separated by commas:

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

## Data Type

String

# SSLServerCertUsageFlags Property ([NTLM](#ntlm-component) Component)

The flags that show intended use for the certificate.

## Syntax

*C++ Builder Syntax*

```text
__property int SSLServerCertUsageFlags = { read=FSSLServerCertUsageFlags };
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ntlm-component) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SSLServerCertUsage](#sslservercertusage-property-ntlm-component) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ntlm-component).

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

## Data Type

Integer

# SSLServerCertVersion Property ([NTLM](#ntlm-component) Component)

The certificate's version number.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertVersion = { read=FSSLServerCertVersion };
```

## Default Value

""

## Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

## Data Type

String

# SSLServerCertSubject Property ([NTLM](#ntlm-component) Component)

The subject of the certificate used for client authentication.

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertSubject = { read=FSSLServerCertSubject, write=FSetSSLServerCertSubject };
```

## Default Value

""

## Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

If a field value contains a comma, it must be quoted.

## Data Type

String

# SSLServerCertEncoded Property ([NTLM](#ntlm-component) Component)

The certificate (PEM/Base64 encoded).

## Syntax

*C++ Builder Syntax*

```text
__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded, write=FSetSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB, write=FSetSSLServerCertEncodedB };
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-ntlm-component) and [SSLServerCertSubject](#sslservercertsubject-property-ntlm-component) properties also may be used to specify a certificate.

When [SSLServerCertEncoded](#sslservercertencoded-property-ntlm-component) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-ntlm-component) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-ntlm-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-ntlm-component) is set to an empty string.

This property is not available at design time.

## Data Type

Byte Array

# User Property ([NTLM](#ntlm-component) Component)

The user.

## Syntax

*C++ Builder Syntax*

```text
__property String User = { read=FUser, write=FSetUser };
```

## Default Value

""

## Remarks

This property specifies the name and realm/domain of the user. The value specified must be in one of the following formats:

- user
- domain/user

## Data Type

String

# Config Method ([NTLM](#ntlm-component) Component)

Sets or retrieves a configuration setting.

## Syntax

*C++ Builder Syntax*

```text
String __fastcall Config(String ConfigurationString);
```

## Remarks

Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-ntlm-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-ntlm-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# CreateAuthToken Method ([NTLM](#ntlm-component) Component)

Creates the authentication token.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall CreateAuthToken();
```

## Remarks

This method creates the authentication token. After calling this method the [AuthToken](#authtoken-property-ntlm-component) property will be populated. The following properties are applicable when calling this method:

- [User](#user-property-ntlm-component) (required)
- [Password](#password-property-ntlm-component) (required)
- [ChallengeToken](#challengetoken-property-ntlm-component) (required)
- SSLServerCert
- [NTLMVersion](#ntlmversion-property-ntlm-component)

Note: SSLServerCert must be set to the server's public certificate if the server requires EPA (Extended Protection for Authentication).

# CreateNegotiateToken Method ([NTLM](#ntlm-component) Component)

Creates the negotiate token.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall CreateNegotiateToken();
```

## Remarks

This method creates the negotiate token. After calling this method the [NegotiateToken](#negotiatetoken-property-ntlm-component) property is populated. The following properties are applicable when calling this method:

- [User](#user-property-ntlm-component) (required)
- [Password](#password-property-ntlm-component) (required)
- [NTLMVersion](#ntlmversion-property-ntlm-component)

# Reset Method ([NTLM](#ntlm-component) Component)

Resets the component.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall Reset();
```

## Remarks

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

# Error Event ([NTLM](#ntlm-component) Component)

Fired when information is available about errors during data delivery.

## Syntax

*C++ Builder Syntax*

```text
typedef struct {
  int ErrorCode;
  String Description;
} TipaNTLMErrorEventParams;
typedef void __fastcall (__closure *TipaNTLMErrorEvent)(System::TObject* Sender, TipaNTLMErrorEventParams *e);
__property TipaNTLMErrorEvent OnError = { read=FOnError, write=FOnError };
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises 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-ntlm-component) section.

# Config Settings ([NTLM](#ntlm-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-ntlm-component) method.

### NTLM Config Settings

**DecodeToken**: Whether to Base64 encode the token.This setting specifies whether to Base64 decode the [ChallengeToken](#challengetoken-property-ntlm-component). The default value is True.

**EncodeToken**: Whether to Base64 encode the token.This setting specifies whether [AuthToken](#authtoken-property-ntlm-component) and rpChallengeToken are Base64 encoded after calling [CreateAuthToken](#createauthtoken-method-ntlm-component) and rmCreateNegotiateToken;. The default value is True.

**UsePlatformNTLMAPI**: Whether to use the platform NTLM API.This setting specifies whether to use the platform NTLM API. The default value is False.

**Workstation**: The workstation name.This setting optionally specifies the workstation name of the client. By default this value is empty and the component will automatically determine the correct value.

Note: This setting is not applicable when [UsePlatformNTLMAPI](#UsePlatformNTLMAPI) is True. The platform NTLM API will always use the current workstation's name.

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

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

 This setting is set to *false* by default on all platforms.

# Trappable Errors ([NTLM](#ntlm-component) Component)

### NTLM Errors

|  |  |
| --- | --- |
| 101 | Component is busy. |
| 102 | Username and password must be specified. |
| 103 | ChallengeToken must be specified. |