# Struct ipworksssl::LDAP

The Lightweight Directory Access Protocol (LDAP) Struct is used to search, manage, and maintain internet directory servers.

## Syntax

```text
ipworksssl::LDAP
```

## Remarks

The LDAP Struct supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the [on_ssl_server_authentication](#on_ssl_server_authentication-event-ldap-struct) event allows you to check the server identity and other security attributes. The [on_ssl_status](#on_ssl_status-event-ldap-struct) event provides information about the SSL handshake. Additional SSL-related settings are also supported through the [config](#config-method-ldap-struct) method.

The LDAP Struct implements a standard LDAP client as specified in RFC 1777, 2251, and other LDAP RFCs. Support for both LDAP v2 and v3 is provided.

The first step in using the struct is specifying the [server_name](#server_name-property-ldap-struct), a [dn](#dn-property-ldap-struct) (distinguished name) to bind as, and optionally a [password](#password-property-ldap-struct). Then you can call one or more of the struct methods to act upon the server. Server responses normally are received through the [on_result](#on_result-event-ldap-struct) event. The only exceptions are search requests that result in one or more [on_search_result](#on_search_result-event-ldap-struct) events, followed by a final [on_search_complete](#on_search_complete-event-ldap-struct) event.

Attributes are set and returned through the attributes properties. Other command arguments are specified through other properties. These are specified in detail in each method.

Search filters are to be specified as string arguments to the [search](#search-method-ldap-struct) method. The format must be a standard LDAP search string as specified in RFC 1558. Other search attributes are set in properties, such as [search_scope](#search_scope-property-ldap-struct), [search_time_limit](#search_time_limit-property-ldap-struct), [search_size_limit](#search_size_limit-property-ldap-struct), [search_return_values](#search_return_values-property-ldap-struct), and [search_deref_aliases](#search_deref_aliases-property-ldap-struct).

The struct operates synchronously by default (waits for a response before returning control to the caller); however, the struct also may operate asynchronously (return control immediately), by setting [timeout](#timeout-property-ldap-struct) to 0. Please refer to the [timeout](#timeout-property-ldap-struct) property for more information.

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksSSL. Due to this, the LDAP struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of LDAP 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.*

|  |  |
| --- | --- |
| [accept_data](#accept_data-property-ldap-struct) | This property indicates whether data reception is currently enabled. |
| [attr_count](#attr_count-property-ldap-struct) | The number of records in the Attr arrays. |
| [attr_type](#attr_type-property-ldap-struct) | This property contains the attribute type for the current entry. |
| [attr_mod_op](#attr_mod_op-property-ldap-struct) | This property contains an operation to apply to attributes during a Lightweight Directory Access Protocol (LDAP) modify operation. |
| [attr_value](#attr_value-property-ldap-struct) | This property contains the attribute value for the current entry. |
| [auth_mechanism](#auth_mechanism-property-ldap-struct) | This property is the authentication mechanism to be used when connecting to the Lightweight Directory Access Protocol (LDAP) server. |
| [connected](#connected-property-ldap-struct) | This property shows whether the struct is connected. |
| [delete_old_rdn](#delete_old_rdn-property-ldap-struct) | This property controls whether the old RDN (Relative Distinguished Name) should be deleted. |
| [dn](#dn-property-ldap-struct) | This property includes the distinguished name used as the base for Lightweight Directory Access Protocol (LDAP) operations. |
| [firewall_auto_detect](#firewall_auto_detect-property-ldap-struct) | Whether to automatically detect and use firewall system settings, if available. |
| [firewall_type](#firewall_type-property-ldap-struct) | The type of firewall to connect through. |
| [firewall_host](#firewall_host-property-ldap-struct) | The name or IP address of the firewall (optional). |
| [firewall_password](#firewall_password-property-ldap-struct) | A password if authentication is to be used when connecting through the firewall. |
| [firewall_port](#firewall_port-property-ldap-struct) | The Transmission Control Protocol (TCP) port for the firewall Host . |
| [firewall_user](#firewall_user-property-ldap-struct) | A username if authentication is to be used when connecting through a firewall. |
| [idle](#idle-property-ldap-struct) | The current status of the struct. |
| [ldap_version](#ldap_version-property-ldap-struct) | The version of the Lightweight Directory Access Protocol (LDAP) used. |
| [local_host](#local_host-property-ldap-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [message_id](#message_id-property-ldap-struct) | This property includes the message identifier for the next Lightweight Directory Access Protocol (LDAP) request. |
| [page_size](#page_size-property-ldap-struct) | This property includes the maximum number of results per page for the Search method. |
| [password](#password-property-ldap-struct) | This property includes the password used to authenticate to the Lightweight Directory Access Protocol (LDAP) server. |
| [reference_count](#reference_count-property-ldap-struct) | The number of records in the Reference arrays. |
| [reference_url](#reference_url-property-ldap-struct) | The url of the LDAP reference. |
| [result_code](#result_code-property-ldap-struct) | This property includes the result code returned in the last server response. |
| [result_description](#result_description-property-ldap-struct) | This property includes the descriptive text returned in the last server response (if any). |
| [result_dn](#result_dn-property-ldap-struct) | This property includes the distinguished name returned in the last server response (if any). |
| [search_deref_aliases](#search_deref_aliases-property-ldap-struct) | This property controls alias dereferencing during searching. |
| [search_return_values](#search_return_values-property-ldap-struct) | This property controls whether the search operation returns values of attributes or only types. |
| [search_scope](#search_scope-property-ldap-struct) | This property controls the scope of Lightweight Directory Access Protocol (LDAP) search operations. |
| [search_size_limit](#search_size_limit-property-ldap-struct) | This property includes the maximum number of entries that can be returned by the next search operation. |
| [search_time_limit](#search_time_limit-property-ldap-struct) | This property includes a time limit for the next search operation (in seconds). |
| [server_name](#server_name-property-ldap-struct) | This property includes the name or address of the Lightweight Directory Access Protocol (LDAP) server. |
| [server_port](#server_port-property-ldap-struct) | This property includes the server port for the Lightweight Directory Access Protocol (LDAP) connection (the default is 389). |
| [sort_attributes](#sort_attributes-property-ldap-struct) | This property includes a string of attribute names to sort on with optional relative matching rules. |
| [ssl_accept_server_cert_effective_date](#ssl_accept_server_cert_effective_date-property-ldap-struct) | The date on which this certificate becomes valid. |
| [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property-ldap-struct) | The date on which the certificate expires. |
| [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property-ldap-struct) | A comma-delimited list of extended key usage identifiers. |
| [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property-ldap-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property-ldap-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property-ldap-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property-ldap-struct) | The issuer of the certificate. |
| [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-ldap-struct) | The private key of the certificate (if available). |
| [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-ldap-struct) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property-ldap-struct) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property-ldap-struct) | The public key of the certificate. |
| [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property-ldap-struct) | The textual description of the certificate's public key algorithm. |
| [ssl_accept_server_cert_public_key_length](#ssl_accept_server_cert_public_key_length-property-ldap-struct) | The length of the certificate's public key (in bits). |
| [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property-ldap-struct) | The serial number of the certificate encoded as a string. |
| [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property-ldap-struct) | The text description of the certificate's signature algorithm. |
| [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-ldap-struct) | The name of the certificate store for the client certificate. |
| [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-ldap-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-ldap-struct) | The type of certificate store for this certificate. |
| [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property-ldap-struct) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property-ldap-struct) | The MD5 hash of the certificate. |
| [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property-ldap-struct) | The SHA-1 hash of the certificate. |
| [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property-ldap-struct) | The SHA-256 hash of the certificate. |
| [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property-ldap-struct) | The text description of UsageFlags . |
| [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-ldap-struct) | The flags that show intended use for the certificate. |
| [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property-ldap-struct) | The certificate's version number. |
| [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-ldap-struct) | The subject of the certificate used for client authentication. |
| [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-ldap-struct) | The certificate (PEM/Base64 encoded). |
| [ssl_cert_effective_date](#ssl_cert_effective_date-property-ldap-struct) | The date on which this certificate becomes valid. |
| [ssl_cert_expiration_date](#ssl_cert_expiration_date-property-ldap-struct) | The date on which the certificate expires. |
| [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property-ldap-struct) | A comma-delimited list of extended key usage identifiers. |
| [ssl_cert_fingerprint](#ssl_cert_fingerprint-property-ldap-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property-ldap-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property-ldap-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_cert_issuer](#ssl_cert_issuer-property-ldap-struct) | The issuer of the certificate. |
| [ssl_cert_private_key](#ssl_cert_private_key-property-ldap-struct) | The private key of the certificate (if available). |
| [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-ldap-struct) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_cert_private_key_container](#ssl_cert_private_key_container-property-ldap-struct) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_cert_public_key](#ssl_cert_public_key-property-ldap-struct) | The public key of the certificate. |
| [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property-ldap-struct) | The textual description of the certificate's public key algorithm. |
| [ssl_cert_public_key_length](#ssl_cert_public_key_length-property-ldap-struct) | The length of the certificate's public key (in bits). |
| [ssl_cert_serial_number](#ssl_cert_serial_number-property-ldap-struct) | The serial number of the certificate encoded as a string. |
| [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property-ldap-struct) | The text description of the certificate's signature algorithm. |
| [ssl_cert_store](#ssl_cert_store-property-ldap-struct) | The name of the certificate store for the client certificate. |
| [ssl_cert_store_password](#ssl_cert_store_password-property-ldap-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_cert_store_type](#ssl_cert_store_type-property-ldap-struct) | The type of certificate store for this certificate. |
| [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property-ldap-struct) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property-ldap-struct) | The MD5 hash of the certificate. |
| [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property-ldap-struct) | The SHA-1 hash of the certificate. |
| [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property-ldap-struct) | The SHA-256 hash of the certificate. |
| [ssl_cert_usage](#ssl_cert_usage-property-ldap-struct) | The text description of UsageFlags . |
| [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-ldap-struct) | The flags that show intended use for the certificate. |
| [ssl_cert_version](#ssl_cert_version-property-ldap-struct) | The certificate's version number. |
| [ssl_cert_subject](#ssl_cert_subject-property-ldap-struct) | The subject of the certificate used for client authentication. |
| [ssl_cert_encoded](#ssl_cert_encoded-property-ldap-struct) | The certificate (PEM/Base64 encoded). |
| [ssl_provider](#ssl_provider-property-ldap-struct) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [ssl_server_cert_effective_date](#ssl_server_cert_effective_date-property-ldap-struct) | The date on which this certificate becomes valid. |
| [ssl_server_cert_expiration_date](#ssl_server_cert_expiration_date-property-ldap-struct) | The date on which the certificate expires. |
| [ssl_server_cert_extended_key_usage](#ssl_server_cert_extended_key_usage-property-ldap-struct) | A comma-delimited list of extended key usage identifiers. |
| [ssl_server_cert_fingerprint](#ssl_server_cert_fingerprint-property-ldap-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_server_cert_fingerprint_sha1](#ssl_server_cert_fingerprint_sha1-property-ldap-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_server_cert_fingerprint_sha256](#ssl_server_cert_fingerprint_sha256-property-ldap-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_server_cert_issuer](#ssl_server_cert_issuer-property-ldap-struct) | The issuer of the certificate. |
| [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-ldap-struct) | The private key of the certificate (if available). |
| [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-ldap-struct) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_server_cert_private_key_container](#ssl_server_cert_private_key_container-property-ldap-struct) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_server_cert_public_key](#ssl_server_cert_public_key-property-ldap-struct) | The public key of the certificate. |
| [ssl_server_cert_public_key_algorithm](#ssl_server_cert_public_key_algorithm-property-ldap-struct) | The textual description of the certificate's public key algorithm. |
| [ssl_server_cert_public_key_length](#ssl_server_cert_public_key_length-property-ldap-struct) | The length of the certificate's public key (in bits). |
| [ssl_server_cert_serial_number](#ssl_server_cert_serial_number-property-ldap-struct) | The serial number of the certificate encoded as a string. |
| [ssl_server_cert_signature_algorithm](#ssl_server_cert_signature_algorithm-property-ldap-struct) | The text description of the certificate's signature algorithm. |
| [ssl_server_cert_store](#ssl_server_cert_store-property-ldap-struct) | The name of the certificate store for the client certificate. |
| [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-ldap-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-ldap-struct) | The type of certificate store for this certificate. |
| [ssl_server_cert_subject_alt_names](#ssl_server_cert_subject_alt_names-property-ldap-struct) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_server_cert_thumbprint_md5](#ssl_server_cert_thumbprint_md5-property-ldap-struct) | The MD5 hash of the certificate. |
| [ssl_server_cert_thumbprint_sha1](#ssl_server_cert_thumbprint_sha1-property-ldap-struct) | The SHA-1 hash of the certificate. |
| [ssl_server_cert_thumbprint_sha256](#ssl_server_cert_thumbprint_sha256-property-ldap-struct) | The SHA-256 hash of the certificate. |
| [ssl_server_cert_usage](#ssl_server_cert_usage-property-ldap-struct) | The text description of UsageFlags . |
| [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-ldap-struct) | The flags that show intended use for the certificate. |
| [ssl_server_cert_version](#ssl_server_cert_version-property-ldap-struct) | The certificate's version number. |
| [ssl_server_cert_subject](#ssl_server_cert_subject-property-ldap-struct) | The subject of the certificate used for client authentication. |
| [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-ldap-struct) | The certificate (PEM/Base64 encoded). |
| [ssl_start_mode](#ssl_start_mode-property-ldap-struct) | This property determines how the struct starts the Secure Sockets Layer (SSL) negotiation. |
| [timeout](#timeout-property-ldap-struct) | This property includes the timeout for the struct. |

## Method List

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

|  |  |
| --- | --- |
| [abandon](#abandon-method-ldap-struct) | This method asks the server to abandon a request. |
| [add](#add-method-ldap-struct) | This method adds an entry specified by DN to the directory server using the type and value attributes defined in the Attributes properties. |
| [attr](#attr-method-ldap-struct) | This method returns the value of the specified Lightweight Directory Access Protocol (LDAP) attribute. |
| [bind](#bind-method-ldap-struct) | This method connects and binds to the directory server. |
| [change_password](#change_password-method-ldap-struct) | This method changes the password for the specified user. |
| [compare](#compare-method-ldap-struct) | This method compares attributes and values with those of the entry specified by DN . |
| [config](#config-method-ldap-struct) | Sets or retrieves a configuration setting. |
| [connect](#connect-method-ldap-struct) | This method connects to the directory server without performing any action. |
| [delete](#delete-method-ldap-struct) | Deletes an entry specified by DN from the directory server. |
| [do_events](#do_events-method-ldap-struct) | This method processes events from the internal message queue. |
| [extended_request](#extended_request-method-ldap-struct) | This method performs a Lightweight Directory Access Protocol (LDAP) V3 extended operation. |
| [interrupt](#interrupt-method-ldap-struct) | This method interrupts the current method. |
| [list_computers](#list_computers-method-ldap-struct) | This method lists all computers in the directory. |
| [list_group_members](#list_group_members-method-ldap-struct) | This method lists all members of a group. |
| [list_groups](#list_groups-method-ldap-struct) | This method list all groups in the directory. |
| [list_user_groups](#list_user_groups-method-ldap-struct) | This method lists all groups a user is a part of. |
| [modify](#modify-method-ldap-struct) | This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN . |
| [modify_rdn](#modify_rdn-method-ldap-struct) | This method performs a Lightweight Directory Access Protocol (LDAP) modify RDN operation on an entry specified by DN . |
| [move_to_dn](#move_to_dn-method-ldap-struct) | This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN by changing its superior. |
| [pause_data](#pause_data-method-ldap-struct) | This method pauses data reception. |
| [process_data](#process_data-method-ldap-struct) | This method re-enables data reception after a call to PauseData . |
| [reset](#reset-method-ldap-struct) | This method will reset the struct. |
| [search](#search-method-ldap-struct) | This method searches the directory server using the base object specified in DN and the search filter SearchFilter . |
| [unbind](#unbind-method-ldap-struct) | This method unbinds from the directory server. |

## 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_computer_list](#on_computer_list-event-ldap-struct) | This event is fired for each computer entry returned. |
| [on_connected](#on_connected-event-ldap-struct) | Fired immediately after a connection completes (or fails). |
| [on_connection_status](#on_connection_status-event-ldap-struct) | Fired to indicate changes in the connection state. |
| [on_disconnected](#on_disconnected-event-ldap-struct) | Fired when a connection is closed. |
| [on_error](#on_error-event-ldap-struct) | Fired when information is available about errors during data delivery. |
| [on_extended_response](#on_extended_response-event-ldap-struct) | This event is fired for Lightweight Directory Access Protocol (LDAP) V3 extended responses. |
| [on_group_list](#on_group_list-event-ldap-struct) | This event is fired for each group entry returned. |
| [on_pi_trail](#on_pi_trail-event-ldap-struct) | This event provides detailed information about the interaction with the server. |
| [on_result](#on_result-event-ldap-struct) | This event is fired for every server response, except for search responses. |
| [on_search_complete](#on_search_complete-event-ldap-struct) | This event is fired upon completion of a search operation. |
| [on_search_page](#on_search_page-event-ldap-struct) | This event is fired for every page returned from a search operation. |
| [on_search_result](#on_search_result-event-ldap-struct) | This event is fired for every entry returned from a search operation. |
| [on_search_result_reference](#on_search_result_reference-event-ldap-struct) | This event is fired for every result reference returned from a search operation. |
| [on_ssl_server_authentication](#on_ssl_server_authentication-event-ldap-struct) | Fired after the server presents its certificate to the client. |
| [on_ssl_status](#on_ssl_status-event-ldap-struct) | Fired when secure connection progress messages are available. |
| [on_user_list](#on_user_list-event-ldap-struct) | This event is fired once for each user entry returned. |

## Config Settings

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

|  |  |
| --- | --- |
| [DomainController](#DomainController) | Returns the name of the domain controller. |
| [FriendlyGUID](#FriendlyGUID) | Whether to return GUID attribute values in a human readable format. |
| [FriendlySID](#FriendlySID) | Whether to return SID attribute values in a human readable format. |
| [RequestControls](#RequestControls) | Controls to include in the request. |
| [ResponseControls](#ResponseControls) | Controls present in the response. |
| [SingleResultMode](#SingleResultMode) | Determines how ResultDN behaves. |
| [UseDefaultDC](#UseDefaultDC) | Whether to connect to the default Domain Controller when calling Bind. |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. |
| [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the struct whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the struct binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. |
| [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. |
| [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. |
| [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. |
| [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [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. |

# accept_data property ([LDAP](#struct-ipworkssslldap) Struct)

This property indicates whether data reception is currently enabled.

## Syntax

*Rust Syntax*

```text
fn accept_data(&self ) -> Result<bool, IPWorksSSLError>
```

## Default Value

true

## Remarks

This property indicates whether data reception is currently enabled. When *false*, data reception is disabled. Use the [pause_data](#pause_data-method-ldap-struct) and [process_data](#process_data-method-ldap-struct) methods to pause and resume data reception.

This property is read-only.

## Data Type

bool

# attr_count property ([LDAP](#struct-ipworkssslldap) Struct)

The number of records in the Attr arrays.

## Syntax

*Rust Syntax*

```text
fn attr_count(&self ) -> Result<i32, IPWorksSSLError> fn set_attr_count(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [attr_mod_op](#attr_mod_op-property-ldap-struct)
- [attr_type](#attr_type-property-ldap-struct)
- [attr_value](#attr_value-property-ldap-struct)

The array indices start at *0* and end at *attr_count - 1*.

## Data Type

i32

# attr_type property ([LDAP](#struct-ipworkssslldap) Struct)

This property contains the attribute type for the current entry.

## Syntax

*Rust Syntax*

```text
fn attr_type(&self , AttrIndex : i32) -> Result<String, IPWorksSSLError> fn set_attr_type(&self, AttrIndex : i32, value : &str) ->  Option<IPWorksSSLError>
fn set_attr_type_ref(&self, AttrIndex : i32, value : &String) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

This property contains the attribute type for the current entry.

If the value of [attr_attribute_type](#LDAP_p_AttrAttributeType) is an empty string, then the [attr_value](#attr_value-property-ldap-struct) that contains the corresponding value is part of a set of values, and the attribute type for the set is specified in the previous attribute of the properties with a nonempty [attr_attribute_type](#LDAP_p_AttrAttributeType).

The *AttrIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttrCount](#attr_count-property-ldap-struct) property.

## Data Type

String

# attr_mod_op property ([LDAP](#struct-ipworkssslldap) Struct)

This property contains an operation to apply to attributes during a Lightweight Directory Access Protocol (LDAP) modify operation.

## Syntax

*Rust Syntax*

```text
fn attr_mod_op(&self , AttrIndex : i32) -> Result<i32, IPWorksSSLError> fn set_attr_mod_op(&self, AttrIndex : i32, value : i32) ->  Option<IPWorksSSLError>
```

## Possible Values

```text
0   // Add1   // Delete2   // Replace
```

## Default Value

0

## Remarks

This property contains an operation to apply to attributes during a Lightweight Directory Access Protocol (LDAP) modify operation.

Possible values include the following:

|  |  |
| --- | --- |
| amoAdd (0) | amoAdd will add the specified value to the given attribute, creating the attribute if it does not already exist. |
| amoDelete (1) | amoDelete will delete the specified value from the given attribute. If all or none of the values are specified for the value, the entire attribute will be deleted; otherwise, only the specific value(s) listed will be removed. |
| amoReplace (2) | amoReplace will replace all existing values of the given attribute with the new values specified. |

The *AttrIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttrCount](#attr_count-property-ldap-struct) property.

## Data Type

i32

# attr_value property ([LDAP](#struct-ipworkssslldap) Struct)

This property contains the attribute value for the current entry.

## Syntax

*Rust Syntax*

```text
fn attr_value(&self , AttrIndex : i32) -> Result<Vec<u8>, IPWorksSSLError> fn set_attr_value(&self, AttrIndex : i32, value : Vec<u8>) ->  Option<IPWorksSSLError>
fn set_attr_value_ref(&self, AttrIndex : i32, value : &[u8]) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

This property contains the attribute value for the current entry.

If the value is part of a set of values, the [attr_attribute_type](#LDAP_p_AttrAttributeType) that contains the corresponding attribute type is an empty string, and the attribute type for the set is specified in the previous attribute of the properties with a nonempty [attr_attribute_type](#LDAP_p_AttrAttributeType).

The *AttrIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [AttrCount](#attr_count-property-ldap-struct) property.

## Data Type

Vec

# auth_mechanism property ([LDAP](#struct-ipworkssslldap) Struct)

This property is the authentication mechanism to be used when connecting to the Lightweight Directory Access Protocol (LDAP) server.

## Syntax

*Rust Syntax*

```text
fn auth_mechanism(&self ) -> Result<i32, IPWorksSSLError> fn set_auth_mechanism(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Possible Values

```text
0   // Simple1   // DigestMD52   // Negotiate6   // Kerberos7   // SASLExternal
```

## Default Value

0

## Remarks

This property specifies the authentication mechanism used. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (lamSimple - default) | Plaintext authentication |
| 1 (lamDigestMD5) | DIGEST-MD5 authentication |
| 2 (lamNegotiate) | NTLM/Negotiate authentication |
| 6 (lamKerberos) | Kerberos authentication |
| 7 (lamSASLExternal) | SASL EXTERNAL authentication |

## Data Type

i32

# connected property ([LDAP](#struct-ipworkssslldap) Struct)

This property shows whether the struct is connected.

## Syntax

*Rust Syntax*

```text
fn connected(&self ) -> Result<bool, IPWorksSSLError>
```

## Default Value

false

## Remarks

This property is used to determine whether or not the struct is connected to the remote host. Use the [bind](#bind-method-ldap-struct) and [unbind](#unbind-method-ldap-struct) methods to manage the connection.

This property is read-only.

## Data Type

bool

# delete_old_rdn property ([LDAP](#struct-ipworkssslldap) Struct)

This property controls whether the old RDN (Relative Distinguished Name) should be deleted.

## Syntax

*Rust Syntax*

```text
fn delete_old_rdn(&self ) -> Result<bool, IPWorksSSLError> fn set_delete_old_rdn(&self, value : bool) ->  Option<IPWorksSSLError>
```

## Default Value

true

## Remarks

This property controls whether the old RDN should be deleted. It is used when [modify_rdn](#modify_rdn-method-ldap-struct) is called. The default value is True, which instructs the server to delete the old RDN.

## Data Type

bool

# dn property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes the distinguished name used as the base for Lightweight Directory Access Protocol (LDAP) operations.

## Syntax

*Rust Syntax*

```text
fn dn(&self ) -> Result<String, IPWorksSSLError> fn set_dn(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_dn_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

This also includes the base object during LDAP searches.

The distinguished name is provided in string format, as specified by RFC 1779. **Example. Setting DN:**

```text
LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server"

LDAPControl.DN = "Domain\Username"
```

## Data Type

String

# firewall_auto_detect property ([LDAP](#struct-ipworkssslldap) Struct)

Whether to automatically detect and use firewall system settings, if available.

## Syntax

*Rust Syntax*

```text
fn firewall_auto_detect(&self ) -> Result<bool, IPWorksSSLError> fn set_firewall_auto_detect(&self, value : bool) ->  Option<IPWorksSSLError>
```

## Default Value

false

## Remarks

Whether to automatically detect and use firewall system settings, if available.

## Data Type

bool

# firewall_type property ([LDAP](#struct-ipworkssslldap) Struct)

The type of firewall to connect through.

## Syntax

*Rust Syntax*

```text
fn firewall_type(&self ) -> Result<i32, IPWorksSSLError> fn set_firewall_type(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Possible Values

```text
0   // None1   // Tunnel2   // SOCKS43   // SOCKS510   // SOCKS4A
```

## Default Value

0

## Remarks

The type of firewall to connect through. The applicable values are as follows:

|  |  |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [firewall_port](#firewall_port-property-ldap-struct) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property-ldap-struct) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property-ldap-struct) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property-ldap-struct) is set to 1080. |

## Data Type

i32

# firewall_host property ([LDAP](#struct-ipworkssslldap) Struct)

The name or IP address of the firewall (optional).

## Syntax

*Rust Syntax*

```text
fn firewall_host(&self ) -> Result<String, IPWorksSSLError> fn set_firewall_host(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_firewall_host_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property-ldap-struct) is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

## Data Type

String

# firewall_password property ([LDAP](#struct-ipworkssslldap) Struct)

A password if authentication is to be used when connecting through the firewall.

## Syntax

*Rust Syntax*

```text
fn firewall_password(&self ) -> Result<String, IPWorksSSLError> fn set_firewall_password(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_firewall_password_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property-ldap-struct) is specified, the [firewall_user](#firewall_user-property-ldap-struct) and [firewall_password](#firewall_password-property-ldap-struct) properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

## Data Type

String

# firewall_port property ([LDAP](#struct-ipworkssslldap) Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

## Syntax

*Rust Syntax*

```text
fn firewall_port(&self ) -> Result<i32, IPWorksSSLError> fn set_firewall_port(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Default Value

0

## Remarks

The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property-ldap-struct). See the description of the [firewall_host](#firewall_host-property-ldap-struct) property for details.

NOTE: This property is set automatically when [firewall_firewall_type](#LDAP_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_firewall_type](#LDAP_p_FirewallFirewallType) property for details.

## Data Type

i32

# firewall_user property ([LDAP](#struct-ipworkssslldap) Struct)

A username if authentication is to be used when connecting through a firewall.

## Syntax

*Rust Syntax*

```text
fn firewall_user(&self ) -> Result<String, IPWorksSSLError> fn set_firewall_user(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_firewall_user_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property-ldap-struct) is specified, this property and the [firewall_password](#firewall_password-property-ldap-struct) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error.

## Data Type

String

# idle property ([LDAP](#struct-ipworkssslldap) Struct)

The current status of the struct.

## Syntax

*Rust Syntax*

```text
fn idle(&self ) -> Result<bool, IPWorksSSLError>
```

## Default Value

true

## Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

## Data Type

bool

# ldap_version property ([LDAP](#struct-ipworkssslldap) Struct)

The version of the Lightweight Directory Access Protocol (LDAP) used.

## Syntax

*Rust Syntax*

```text
fn ldap_version(&self ) -> Result<i32, IPWorksSSLError> fn set_ldap_version(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Default Value

3

## Remarks

This property contains the version of LDAP used. The default value is 3 (for LDAPv3).

## Data Type

i32

# local_host property ([LDAP](#struct-ipworkssslldap) Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

## Syntax

*Rust Syntax*

```text
fn local_host(&self ) -> Result<String, IPWorksSSLError> fn set_local_host(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

## Data Type

String

# message_id property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes the message identifier for the next Lightweight Directory Access Protocol (LDAP) request.

## Syntax

*Rust Syntax*

```text
fn message_id(&self ) -> Result<i32, IPWorksSSLError> fn set_message_id(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Default Value

1

## Remarks

This property contains the message identifier for the next LDAP request. If a custom value is needed, this property must be set before calling any other methods. The struct increments this property automatically after each request.

## Data Type

i32

# page_size property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes the maximum number of results per page for the Search method.

## Syntax

*Rust Syntax*

```text
fn page_size(&self ) -> Result<i32, IPWorksSSLError> fn set_page_size(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Default Value

0

## Remarks

This property contains the maximum number of results per page for the [search](#search-method-ldap-struct) method. The default value is 0 (no paging). If set to a value greater than zero, results will be paged, that is, returned in blocks of maximum page_size results.

For each page sent by the server, a [on_search_page](#on_search_page-event-ldap-struct) event will fire. You may decide to cancel or continue displaying results from within this event.

NOTE: Lightweight Directory Access Protocol (LDAP) paging functionality is described by LDAP extension RFCs and may or may not be implemented by the LDAP server being accessed.

## Data Type

i32

# password property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes the password used to authenticate to the Lightweight Directory Access Protocol (LDAP) server.

## Syntax

*Rust Syntax*

```text
fn password(&self ) -> Result<String, IPWorksSSLError> fn set_password(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_password_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

This property contains the password used to authenticate to the LDAP server. Leave this value empty if no password is required.

## Data Type

String

# reference_count property ([LDAP](#struct-ipworkssslldap) Struct)

The number of records in the Reference arrays.

## Syntax

*Rust Syntax*

```text
fn reference_count(&self ) -> Result<i32, IPWorksSSLError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [reference_url](#reference_url-property-ldap-struct)

The array indices start at *0* and end at *reference_count - 1*.

This property is read-only.

## Data Type

i32

# reference_url property ([LDAP](#struct-ipworkssslldap) Struct)

The url of the LDAP reference.

## Syntax

*Rust Syntax*

```text
fn reference_url(&self , ReferenceIndex : i32) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

The url of the LDAP reference. If inside a [on_search_result](#on_search_result-event-ldap-struct) or [on_search_result_reference](#on_search_result_reference-event-ldap-struct) event, it represents a URL to contact to continue the search. If inside the [on_result](#on_result-event-ldap-struct) event or [on_search_complete](#on_search_complete-event-ldap-struct) event it represents the URL to contact in order to complete the requested operation.

The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#reference_count-property-ldap-struct) property.

This property is read-only.

## Data Type

String

# result_code property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes the result code returned in the last server response.

## Syntax

*Rust Syntax*

```text
fn result_code(&self ) -> Result<i32, IPWorksSSLError>
```

## Default Value

0

## Remarks

This property contains the result code returned in the last server response. This is identical to the corresponding parameter provided by the last [on_result](#on_result-event-ldap-struct), [on_search_result](#on_search_result-event-ldap-struct), or [on_search_complete](#on_search_complete-event-ldap-struct) event.

Possible result codes are as follows:

|  |  |
| --- | --- |
| 0 | success |
| 1 | operationsError |
| 2 | protocolError |
| 3 | timeLimitExceeded |
| 4 | sizeLimitExceeded |
| 5 | compareFalse |
| 6 | compareTrue |
| 7 | authMethodNotSupported |
| 8 | strongAuthRequired |
| 9 | reserved |
| 10 | referral |
| 11 | adminLimitExceeded |
| 12 | unavailableCriticalExtension |
| 13 | confidentialityRequired |
| 14 | saslBindInProgress |
| 16 | noSuchAttribute |
| 17 | undefinedAttributeType |
| 18 | inappropriateMatching |
| 19 | constraintViolation |
| 20 | attributeOrValueExists |
| 21 | invalidAttributeSyntax |
| 32 | noSuchObject |
| 33 | aliasProblem |
| 34 | invalidDNSyntax |
| 35 | reserved for undefined isLeaf |
| 36 | aliasDereferencingProblem |
| 48 | inappropriateAuthentication |
| 49 | invalidCredentials |
| 50 | insufficientAccessRights |
| 51 | busy |
| 52 | unavailable |
| 53 | unwillingToPerform |
| 54 | loopDetect |
| 64 | namingViolation |
| 65 | objectClassViolation |
| 66 | notAllowedOnNonLeaf |
| 67 | notAllowedOnRDN |
| 68 | entryAlreadyExists |
| 69 | objectClassModsProhibited |
| 70 | reserved for CLDAP |
| 71 | affectsMultipleDSAs |

All the result codes with the exception of success, compareFalse and compareTrue are to be treated as meaning the operation could not be completed in its entirety. Result codes from 16 to 21 indicate an AttributeProblem; codes 32, 33, 34, and 36 indicate a NameProblem; codes 48, 49, and 50 indicate a SecurityProblem; codes 51 to 54 indicate a ServiceProblem; and codes 64 to 69 and 71 indicate an UpdateProblem.

This property is read-only.

## Data Type

i32

# result_description property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes the descriptive text returned in the last server response (if any).

## Syntax

*Rust Syntax*

```text
fn result_description(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

This property contains the descriptive text returned in the last server response (if any). This is identical to the corresponding parameter provided by the last [on_result](#on_result-event-ldap-struct), [on_search_result](#on_search_result-event-ldap-struct), or [on_search_complete](#on_search_complete-event-ldap-struct) event.

This property is read-only.

## Data Type

String

# result_dn property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes the distinguished name returned in the last server response (if any).

## Syntax

*Rust Syntax*

```text
fn result_dn(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

This property contains the distinguished name returned in the last server response (if any). This is identical to the corresponding parameter provided by the last [on_result](#on_result-event-ldap-struct) or [on_search_complete](#on_search_complete-event-ldap-struct) event.

This property is read-only.

## Data Type

String

# search_deref_aliases property ([LDAP](#struct-ipworkssslldap) Struct)

This property controls alias dereferencing during searching.

## Syntax

*Rust Syntax*

```text
fn search_deref_aliases(&self ) -> Result<i32, IPWorksSSLError> fn set_search_deref_aliases(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Possible Values

```text
0   // Never1   // InSearching2   // FindingBaseObject3   // Always
```

## Default Value

0

## Remarks

This property controls the alias dereferencing during searching. The possible values are as follows:

|  |  |
| --- | --- |
| sdaNever (0) | Do not dereference aliases in searching or in locating the base object of the search. |
| sdaInSearching (1) | Dereference aliases in subordinates of the base object in searching, but not in locating the base object of the search. |
| sdaFindingBaseObject (2) | Dereference aliases in locating the base object of the search, but not when searching subordinates of the base object. |
| sdaAlways (3) | Dereference aliases both in searching and in locating the base object of the search. |

The default is to never dereference aliases.

## Data Type

i32

# search_return_values property ([LDAP](#struct-ipworkssslldap) Struct)

This property controls whether the search operation returns values of attributes or only types.

## Syntax

*Rust Syntax*

```text
fn search_return_values(&self ) -> Result<bool, IPWorksSSLError> fn set_search_return_values(&self, value : bool) ->  Option<IPWorksSSLError>
```

## Default Value

true

## Remarks

This property controls whether the search operation returns values of attributes or only types. If only attributes are needed, disabling the property to return values will enhance performance.

## Data Type

bool

# search_scope property ([LDAP](#struct-ipworkssslldap) Struct)

This property controls the scope of Lightweight Directory Access Protocol (LDAP) search operations.

## Syntax

*Rust Syntax*

```text
fn search_scope(&self ) -> Result<i32, IPWorksSSLError> fn set_search_scope(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Possible Values

```text
0   // BaseObject1   // SingleLevel2   // WholeSubtree
```

## Default Value

2

## Remarks

This property controls the scope of LDAP search operations. Possible values are as follows:

|  |  |
| --- | --- |
| ssBaseObject (0) | Search only the base object. |
| ssSingleLevel (1) | Search only one level, including objects directly below the base object, but not the base object. |
| ssWholeSubtree (2) | Search the whole subtree, including the base object. |

 The default is to search the whole subtree.

## Data Type

i32

# search_size_limit property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes the maximum number of entries that can be returned by the next search operation.

## Syntax

*Rust Syntax*

```text
fn search_size_limit(&self ) -> Result<i32, IPWorksSSLError> fn set_search_size_limit(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Default Value

0

## Remarks

This property contains the maximum number of entries that can be returned by the next search operation. This limit is provided as a hint to the directory server. A value of 0 means that no size limits are in effect for the search.

## Data Type

i32

# search_time_limit property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes a time limit for the next search operation (in seconds).

## Syntax

*Rust Syntax*

```text
fn search_time_limit(&self ) -> Result<i32, IPWorksSSLError> fn set_search_time_limit(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Default Value

0

## Remarks

This property contains a time limit for the next search operation (in seconds). This limit is provided as a hint to the directory server. A value of 0 means that no time limits are in effect for the search.

## Data Type

i32

# server_name property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes the name or address of the Lightweight Directory Access Protocol (LDAP) server.

## Syntax

*Rust Syntax*

```text
fn server_name(&self ) -> Result<String, IPWorksSSLError> fn set_server_name(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_server_name_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the directory server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

## Data Type

String

# server_port property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes the server port for the Lightweight Directory Access Protocol (LDAP) connection (the default is 389).

## Syntax

*Rust Syntax*

```text
fn server_port(&self ) -> Result<i32, IPWorksSSLError> fn set_server_port(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Default Value

389

## Remarks

This property contains the server port for the LDAP connection (the default is 389).

For the implicit Secure Sockets Layer (SSL), use port 636 (please refer to the [ssl_start_mode](#ssl_start_mode-property-ldap-struct) property for more information).

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

## Data Type

i32

# sort_attributes property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes a string of attribute names to sort on with optional relative matching rules.

## Syntax

*Rust Syntax*

```text
fn sort_attributes(&self ) -> Result<String, IPWorksSSLError> fn set_sort_attributes(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_sort_attributes_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

This property contains a string of attribute names to sort on with optional relative matching rules. When set before a [search](#search-method-ldap-struct), entries returned by the server will be sorted according to sort_attributes. The format consists of one or more attribute names separated by spaces. Each attribute may be followed by an optional matching rule.

If matching rules are defined, they should be separated from the attribute names with a "/".

Normally, the values are returned in ascending order. If descending (reverse) order of sorting is desired, the attribute type must be preceded with a "-".

Following are examples:

```text
LDAPControl.SortAttributes = "loginTime"

LDAPControl.SortAttributes = "name/caseIgnoreSubstringsMatch age/numericStringSubstringsMatch"

LDAPControl.SortAttributes = "cn age/1.3.6.1.4.1.1466.115.121.1.27"

LDAPControl.SortAttributes = "-cn age/1.3.6.1.4.1.1466.115.121.1.27"
```

 **Example 1. Matching Rules for Equality Filters:**

|  |  |
| --- | --- |
| 1.3.6.1.4.1.1466.115.121.1.38 | objectIdentifierMatch |
| 1.3.6.1.4.1.1466.115.121.1.12 | distinguishedNameMatch |
| 1.3.6.1.4.1.1466.115.121.1.15 | caseIgnoreMatch |
| 1.3.6.1.4.1.1466.115.121.1.36 | numericStringMatch |
| 1.3.6.1.4.1.1466.115.121.1.41 | caseIgnoreListMatch |
| 1.3.6.1.4.1.1466.115.121.1.27 | integerMatch |
| 1.3.6.1.4.1.1466.115.121.1.6 | bitStringMatch |
| 1.3.6.1.4.1.1466.115.121.1.50 | telephoneNumberMatch |
| 1.3.6.1.4.1.1466.115.121.1.43 | presentationAddressMatch |
| 1.3.6.1.4.1.1466.115.121.1.34 | uniqueMemberMatch |
| 1.3.6.1.4.1.1466.115.121.1.42 | protocolInformationMatch |
| 1.3.6.1.4.1.1466.115.121.1.24 | generalizedTimeMatch |
| 1.3.6.1.4.1.1466.115.121.1.26 | caseExactIA5Match |
| 1.3.6.1.4.1.1466.115.121.1.26 | caseIgnoreIA5Match |

 **Example 2. Matching Rules for Inequality Filters:**

|  |  |
| --- | --- |
| 1.3.6.1.4.1.1466.115.121.1.24 | generalizedTimeOrderingMatch |
| 1.3.6.1.4.1.1466.115.121.1.15 | caseIgnoreOrderingMatch |

 **Example 3. Matching Rules for Substring Filters:**

|  |  |
| --- | --- |
| 1.3.6.1.4.1.1466.115.121.1.58 | caseIgnoreSubstringsMatch |
| 1.3.6.1.4.1.1466.115.121.1.58 | telephoneNumberSubstringsMatch |
| 1.3.6.1.4.1.1466.115.121.1.58 | numericStringSubstringsMatch |

 **Example 4. Matching Rules for Subschema Attributes:**

|  |  |
| --- | --- |
| 1.3.6.1.4.1.1466.115.121.1.27 | integerFirstComponentMatch |
| 1.3.6.1.4.1.1466.115.121.1.38 | objectIdentifierFirstComponentMatch |

## Data Type

String

# ssl_accept_server_cert_effective_date property ([LDAP](#struct-ipworkssslldap) Struct)

The date on which this certificate becomes valid.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_expiration_date property ([LDAP](#struct-ipworkssslldap) Struct)

The date on which the certificate expires.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_extended_key_usage property ([LDAP](#struct-ipworkssslldap) Struct)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_fingerprint property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_fingerprint_sha1 property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_fingerprint_sha256 property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_issuer property ([LDAP](#struct-ipworkssslldap) Struct)

The issuer of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_issuer(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_private_key property ([LDAP](#struct-ipworkssslldap) Struct)

The private key of the certificate (if available).

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_private_key(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

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

NOTE: The [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-ldap-struct) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-ldap-struct) returns an empty string.

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_private_key_available property ([LDAP](#struct-ipworkssslldap) Struct)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, IPWorksSSLError>
```

## Default Value

false

## Remarks

Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-ldap-struct) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-ldap-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

bool

# ssl_accept_server_cert_private_key_container property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-ldap-struct) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_public_key property ([LDAP](#struct-ipworkssslldap) Struct)

The public key of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_public_key(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_public_key_algorithm property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_public_key_length property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, IPWorksSSLError>
```

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

i32

# ssl_accept_server_cert_serial_number property ([LDAP](#struct-ipworkssslldap) Struct)

The serial number of the certificate encoded as a string.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_signature_algorithm property ([LDAP](#struct-ipworkssslldap) Struct)

The text description of the certificate's signature algorithm.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_store property ([LDAP](#struct-ipworkssslldap) Struct)

The name of the certificate store for the client certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksSSLError> fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksSSLError>
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksSSLError>
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-ldap-struct) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-ldap-struct). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-ldap-struct).

[ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-ldap-struct) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-ldap-struct) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-ldap-struct) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-ldap-struct) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-ldap-struct) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-ldap-struct) 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

Vec

# ssl_accept_server_cert_store_password property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_store_password(&self ) -> Result<String, IPWorksSSLError> fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

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

# ssl_accept_server_cert_store_type property ([LDAP](#struct-ipworkssslldap) Struct)

The type of certificate store for this certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, IPWorksSSLError> fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

 The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct 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 [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-ldap-struct), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-ldap-struct), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-ldap-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#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 [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-ldap-struct) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-ldap-struct) 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

i32

# ssl_accept_server_cert_subject_alt_names property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_thumbprint_md5 property ([LDAP](#struct-ipworkssslldap) Struct)

The MD5 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_thumbprint_sha1 property ([LDAP](#struct-ipworkssslldap) Struct)

The SHA-1 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_thumbprint_sha256 property ([LDAP](#struct-ipworkssslldap) Struct)

The SHA-256 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_usage property ([LDAP](#struct-ipworkssslldap) Struct)

The text description of UsageFlags .

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_usage(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-ldap-struct).

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

# ssl_accept_server_cert_usage_flags property ([LDAP](#struct-ipworkssslldap) Struct)

The flags that show intended use for the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, IPWorksSSLError>
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-ldap-struct) 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 [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property-ldap-struct) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-ldap-struct).

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

This property is read-only.

## Data Type

i32

# ssl_accept_server_cert_version property ([LDAP](#struct-ipworkssslldap) Struct)

The certificate's version number.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_version(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_accept_server_cert_subject property ([LDAP](#struct-ipworkssslldap) Struct)

The subject of the certificate used for client authentication.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_subject(&self ) -> Result<String, IPWorksSSLError> fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

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

# ssl_accept_server_cert_encoded property ([LDAP](#struct-ipworkssslldap) Struct)

The certificate (PEM/Base64 encoded).

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksSSLError> fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksSSLError>
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-ldap-struct) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-ldap-struct) properties also may be used to specify a certificate.

When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-ldap-struct) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-ldap-struct) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-ldap-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-ldap-struct) is set to an empty string.

## Data Type

Vec

# ssl_cert_effective_date property ([LDAP](#struct-ipworkssslldap) Struct)

The date on which this certificate becomes valid.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_expiration_date property ([LDAP](#struct-ipworkssslldap) Struct)

The date on which the certificate expires.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_extended_key_usage property ([LDAP](#struct-ipworkssslldap) Struct)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_fingerprint property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_fingerprint_sha1 property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_fingerprint_sha256 property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_issuer property ([LDAP](#struct-ipworkssslldap) Struct)

The issuer of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_issuer(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_private_key property ([LDAP](#struct-ipworkssslldap) Struct)

The private key of the certificate (if available).

## Syntax

*Rust Syntax*

```text
fn ssl_cert_private_key(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

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

NOTE: The [ssl_cert_private_key](#ssl_cert_private_key-property-ldap-struct) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property-ldap-struct) returns an empty string.

This property is read-only.

## Data Type

String

# ssl_cert_private_key_available property ([LDAP](#struct-ipworkssslldap) Struct)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksSSLError>
```

## Default Value

false

## Remarks

Whether a [ssl_cert_private_key](#ssl_cert_private_key-property-ldap-struct) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-ldap-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

bool

# ssl_cert_private_key_container property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

The name of the [ssl_cert_private_key](#ssl_cert_private_key-property-ldap-struct) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# ssl_cert_public_key property ([LDAP](#struct-ipworkssslldap) Struct)

The public key of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_public_key(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_public_key_algorithm property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_public_key_length property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksSSLError>
```

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

i32

# ssl_cert_serial_number property ([LDAP](#struct-ipworkssslldap) Struct)

The serial number of the certificate encoded as a string.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_signature_algorithm property ([LDAP](#struct-ipworkssslldap) Struct)

The text description of the certificate's signature algorithm.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_store property ([LDAP](#struct-ipworkssslldap) Struct)

The name of the certificate store for the client certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksSSLError> fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksSSLError>
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksSSLError>
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [ssl_cert_store_type](#ssl_cert_store_type-property-ldap-struct) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property-ldap-struct). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property-ldap-struct).

[ssl_cert_store](#ssl_cert_store-property-ldap-struct) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property-ldap-struct) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property-ldap-struct) has a value, and [ssl_cert_subject](#ssl_cert_subject-property-ldap-struct) or [ssl_cert_encoded](#ssl_cert_encoded-property-ldap-struct) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property-ldap-struct) 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

Vec

# ssl_cert_store_password property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_store_password(&self ) -> Result<String, IPWorksSSLError> fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

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

# ssl_cert_store_type property ([LDAP](#struct-ipworkssslldap) Struct)

The type of certificate store for this certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksSSLError> fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

 The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct 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 [ssl_cert_store_type](#ssl_cert_store_type-property-ldap-struct), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property-ldap-struct), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property-ldap-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#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 [ssl_cert_store](#ssl_cert_store-property-ldap-struct) and set [ssl_cert_store_password](#ssl_cert_store_password-property-ldap-struct) 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

i32

# ssl_cert_subject_alt_names property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_thumbprint_md5 property ([LDAP](#struct-ipworkssslldap) Struct)

The MD5 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_thumbprint_sha1 property ([LDAP](#struct-ipworkssslldap) Struct)

The SHA-1 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_thumbprint_sha256 property ([LDAP](#struct-ipworkssslldap) Struct)

The SHA-256 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_usage property ([LDAP](#struct-ipworkssslldap) Struct)

The text description of UsageFlags .

## Syntax

*Rust Syntax*

```text
fn ssl_cert_usage(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-ldap-struct).

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

# ssl_cert_usage_flags property ([LDAP](#struct-ipworkssslldap) Struct)

The flags that show intended use for the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksSSLError>
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-ldap-struct) 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 [ssl_cert_usage](#ssl_cert_usage-property-ldap-struct) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-ldap-struct).

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

This property is read-only.

## Data Type

i32

# ssl_cert_version property ([LDAP](#struct-ipworkssslldap) Struct)

The certificate's version number.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_version(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_cert_subject property ([LDAP](#struct-ipworkssslldap) Struct)

The subject of the certificate used for client authentication.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_subject(&self ) -> Result<String, IPWorksSSLError> fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksSSLError>
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksSSLError>
```

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

# ssl_cert_encoded property ([LDAP](#struct-ipworkssslldap) Struct)

The certificate (PEM/Base64 encoded).

## Syntax

*Rust Syntax*

```text
fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksSSLError> fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksSSLError>
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksSSLError>
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_cert_store](#ssl_cert_store-property-ldap-struct) and [ssl_cert_subject](#ssl_cert_subject-property-ldap-struct) properties also may be used to specify a certificate.

When [ssl_cert_encoded](#ssl_cert_encoded-property-ldap-struct) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property-ldap-struct) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property-ldap-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property-ldap-struct) is set to an empty string.

## Data Type

Vec

# ssl_provider property ([LDAP](#struct-ipworkssslldap) Struct)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

## Syntax

*Rust Syntax*

```text
fn ssl_provider(&self ) -> Result<i32, IPWorksSSLError> fn set_ssl_provider(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Possible Values

```text
0   // Automatic1   // Platform2   // Internal
```

## Default Value

0

## Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

|  |  |
| --- | --- |
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |

 **Additional Notes**

In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

## Data Type

i32

# ssl_server_cert_effective_date property ([LDAP](#struct-ipworkssslldap) Struct)

The date on which this certificate becomes valid.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_effective_date(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_expiration_date property ([LDAP](#struct-ipworkssslldap) Struct)

The date on which the certificate expires.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_expiration_date(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_extended_key_usage property ([LDAP](#struct-ipworkssslldap) Struct)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_fingerprint property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_fingerprint(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_fingerprint_sha1 property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_fingerprint_sha256 property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_issuer property ([LDAP](#struct-ipworkssslldap) Struct)

The issuer of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_issuer(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_private_key property ([LDAP](#struct-ipworkssslldap) Struct)

The private key of the certificate (if available).

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_private_key(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

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

NOTE: The [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-ldap-struct) may be available but not exportable. In this case, [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-ldap-struct) returns an empty string.

This property is read-only.

## Data Type

String

# ssl_server_cert_private_key_available property ([LDAP](#struct-ipworkssslldap) Struct)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_private_key_available(&self ) -> Result<bool, IPWorksSSLError>
```

## Default Value

false

## Remarks

Whether a [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-ldap-struct) is available for the selected certificate. If [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-ldap-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

bool

# ssl_server_cert_private_key_container property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_private_key_container(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

The name of the [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-ldap-struct) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# ssl_server_cert_public_key property ([LDAP](#struct-ipworkssslldap) Struct)

The public key of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_public_key(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_public_key_algorithm property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_public_key_length property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_public_key_length(&self ) -> Result<i32, IPWorksSSLError>
```

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

i32

# ssl_server_cert_serial_number property ([LDAP](#struct-ipworkssslldap) Struct)

The serial number of the certificate encoded as a string.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_serial_number(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_signature_algorithm property ([LDAP](#struct-ipworkssslldap) Struct)

The text description of the certificate's signature algorithm.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_store property ([LDAP](#struct-ipworkssslldap) Struct)

The name of the certificate store for the client certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksSSLError>
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-ldap-struct) property denotes the type of the certificate store specified by [ssl_server_cert_store](#ssl_server_cert_store-property-ldap-struct). If the store is password-protected, specify the password in [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-ldap-struct).

[ssl_server_cert_store](#ssl_server_cert_store-property-ldap-struct) is used in conjunction with the [ssl_server_cert_subject](#ssl_server_cert_subject-property-ldap-struct) property to specify client certificates. If [ssl_server_cert_store](#ssl_server_cert_store-property-ldap-struct) has a value, and [ssl_server_cert_subject](#ssl_server_cert_subject-property-ldap-struct) or [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-ldap-struct) is set, a search for a certificate is initiated. Please see the [ssl_server_cert_subject](#ssl_server_cert_subject-property-ldap-struct) 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).

This property is read-only.

## Data Type

Vec

# ssl_server_cert_store_password property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_store_password(&self ) -> Result<String, IPWorksSSLError>
```

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

This property is read-only.

## Data Type

String

# ssl_server_cert_store_type property ([LDAP](#struct-ipworkssslldap) Struct)

The type of certificate store for this certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_store_type(&self ) -> Result<i32, IPWorksSSLError>
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

 The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct 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 [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-ldap-struct), the full path of the PKCS#11 DLL as the [ssl_server_cert_store](#ssl_server_cert_store-property-ldap-struct), and the PIN as the [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-ldap-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#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 [ssl_server_cert_store](#ssl_server_cert_store-property-ldap-struct) and set [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-ldap-struct) 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. |

This property is read-only.

## Data Type

i32

# ssl_server_cert_subject_alt_names property ([LDAP](#struct-ipworkssslldap) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_thumbprint_md5 property ([LDAP](#struct-ipworkssslldap) Struct)

The MD5 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_thumbprint_sha1 property ([LDAP](#struct-ipworkssslldap) Struct)

The SHA-1 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_thumbprint_sha256 property ([LDAP](#struct-ipworkssslldap) Struct)

The SHA-256 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_usage property ([LDAP](#struct-ipworkssslldap) Struct)

The text description of UsageFlags .

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_usage(&self ) -> Result<String, IPWorksSSLError>
```

## Default Value

""

## Remarks

The text description of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-ldap-struct).

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

# ssl_server_cert_usage_flags property ([LDAP](#struct-ipworkssslldap) Struct)

The flags that show intended use for the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_usage_flags(&self ) -> Result<i32, IPWorksSSLError>
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-ldap-struct) 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 [ssl_server_cert_usage](#ssl_server_cert_usage-property-ldap-struct) property for a text representation of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-ldap-struct).

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

This property is read-only.

## Data Type

i32

# ssl_server_cert_version property ([LDAP](#struct-ipworkssslldap) Struct)

The certificate's version number.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_version(&self ) -> Result<String, IPWorksSSLError>
```

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

# ssl_server_cert_subject property ([LDAP](#struct-ipworkssslldap) Struct)

The subject of the certificate used for client authentication.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_subject(&self ) -> Result<String, IPWorksSSLError>
```

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

This property is read-only.

## Data Type

String

# ssl_server_cert_encoded property ([LDAP](#struct-ipworkssslldap) Struct)

The certificate (PEM/Base64 encoded).

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksSSLError>
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_server_cert_store](#ssl_server_cert_store-property-ldap-struct) and [ssl_server_cert_subject](#ssl_server_cert_subject-property-ldap-struct) properties also may be used to specify a certificate.

When [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-ldap-struct) is set, a search is initiated in the current [ssl_server_cert_store](#ssl_server_cert_store-property-ldap-struct) for the private key of the certificate. If the key is found, [ssl_server_cert_subject](#ssl_server_cert_subject-property-ldap-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_server_cert_subject](#ssl_server_cert_subject-property-ldap-struct) is set to an empty string.

This property is read-only.

## Data Type

Vec

# ssl_start_mode property ([LDAP](#struct-ipworkssslldap) Struct)

This property determines how the struct starts the Secure Sockets Layer (SSL) negotiation.

## Syntax

*Rust Syntax*

```text
fn ssl_start_mode(&self ) -> Result<i32, IPWorksSSLError> fn set_ssl_start_mode(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Possible Values

```text
0   // Automatic1   // Implicit2   // Explicit
```

## Default Value

0

## Remarks

The ssl_start_mode property may have one of the following values:

|  |  |
| --- | --- |
| 0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the struct will behave the same as if ssl_start_mode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). |
| 1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. |
| 2 (sslExplicit) | The struct will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. |

## Data Type

i32

# timeout property ([LDAP](#struct-ipworkssslldap) Struct)

This property includes the timeout for the struct.

## Syntax

*Rust Syntax*

```text
fn timeout(&self ) -> Result<i32, IPWorksSSLError> fn set_timeout(&self, value : i32) ->  Option<IPWorksSSLError>
```

## Default Value

60

## Remarks

If the timeout property is set to 0, all operations return immediately, potentially failing with a *WOULDBLOCK* error if data cannot be sent immediately.

If timeout is set to a positive value, data is sent in a blocking manner and the struct will wait for the operation to complete before returning control. The struct will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of timeout seconds.

The struct will use [do_events](#do_events-method-ldap-struct) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

## Data Type

i32

# abandon method ([LDAP](#struct-ipworkssslldap) Struct)

This method asks the server to abandon a request.

## Syntax

*Rust Syntax*

```text
fn abandon(&self, message_id : i32) -> Result<(), IPWorksSSLError>
```

## Remarks

This method asks the server to abandon the request specified by *message_id*. The result of the operation is returned through the [on_result](#on_result-event-ldap-struct) event.

# add method ([LDAP](#struct-ipworkssslldap) Struct)

This method adds an entry specified by DN to the directory server using the type and value attributes defined in the Attributes properties.

## Syntax

*Rust Syntax*

```text
fn add(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method adds the entry specified by [dn](#dn-property-ldap-struct) to the directory. All entries are required to have an objectClass attribute.

To add a new entry, first [bind](#bind-method-ldap-struct) with credentials that will allow you to perform the new addition. To add attributes instead of entries, use the [modify](#modify-method-ldap-struct) method instead. When specifying multivalued attributes, specify the attribute type only in the first occurrence of that attribute type in the attributes properties. Additional instances of the same attribute type should specify an attribute type of an empty string.

The result of the operation is returned through the [on_result](#on_result-event-ldap-struct) event.

**Example. Add a New Entry (including the multivalued objectClass attribute):**

```text
LDAPControl.DN = "uid=NewUser,ou=Employees,dc=server"
LDAPControl.AttributeCount = 7
LDAPControl.AttributeType(0) = "objectClass"
LDAPControl.AttributeValue(0) = "top"
LDAPControl.AttributeType(1) = ""
LDAPControl.AttributeValue(1) = "person"
LDAPControl.AttributeType(2) = ""
LDAPControl.AttributeValue(2) = "organizationalPerson"
LDAPControl.AttributeType(3) = ""
LDAPControl.AttributeValue(3) = "inetOrgPerson"
LDAPControl.AttributeType(4) = "sn"
LDAPControl.AttributeValue(4) = "UserName"
LDAPControl.AttributeType(5) = "cn"
LDAPControl.AttributeValue(5) = "New S. UserName"
LDAPControl.AttributeType(6) = "uid"
LDAPControl.AttributeValue(6) = "NewUser"
LDAPControl.Add()
```

# attr method ([LDAP](#struct-ipworkssslldap) Struct)

This method returns the value of the specified Lightweight Directory Access Protocol (LDAP) attribute.

## Syntax

*Rust Syntax*

```text
fn attr(&self, attr_type : &str) ->  Result<String, IPWorksSSLError>
```

## Remarks

This method returns the value of the specified LDAP attribute. If the attribute does not exist, an empty string is returned.

Please refer to the attributes properties for more information.

# bind method ([LDAP](#struct-ipworkssslldap) Struct)

This method connects and binds to the directory server.

## Syntax

*Rust Syntax*

```text
fn bind(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method connects and binds to the directory server. If the [password](#password-property-ldap-struct) property has a value, it is used for authentication. If not, the bind is performed anonymously. Binding is often required on some directory servers, like Active Directory. The result of the operation is returned through the [on_result](#on_result-event-ldap-struct) event.

**Example. Binding:**

```text
LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server"
LDAPControl.Password = "mypassword"
LDAPControl.Bind()

LDAPControl.DN = "Domain/Username"
LDAPControl.Password = "mypassword"
LDAPControl.Bind()
```

# change_password method ([LDAP](#struct-ipworkssslldap) Struct)

This method changes the password for the specified user.

## Syntax

*Rust Syntax*

```text
fn change_password(&self, user : &str, old_password : &str, new_password : &str) -> Result<(), IPWorksSSLError>
```

## Remarks

This method changes the password for the specified user.

The *user* parameter is the name of the user for which the password will be changed. *old_password* specifies the current password and *new_password* specifies the new password.

NOTE: This operation can be performed only over the Secure Sockets Layer (SSL) port. Set [server_port](#server_port-property-ldap-struct) to the SSL port of the server (typically 636) before calling this method.

NOTE: If the user is an administrator, the old password is not required.

# compare method ([LDAP](#struct-ipworkssslldap) Struct)

This method compares attributes and values with those of the entry specified by DN .

## Syntax

*Rust Syntax*

```text
fn compare(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method compares attribute types and values specified via the attributes properties, with the values in the directory for the entry specified by [dn](#dn-property-ldap-struct). The result of the operation is returned through the [on_result](#on_result-event-ldap-struct) event.

# config method ([LDAP](#struct-ipworkssslldap) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, IPWorksSSLError>
```

## Remarks

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

# connect method ([LDAP](#struct-ipworkssslldap) Struct)

This method connects to the directory server without performing any action.

## Syntax

*Rust Syntax*

```text
fn connect(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method establishes a connection with the directory server specified by [server_name](#server_name-property-ldap-struct). In most cases, it is recommended to use the [bind](#bind-method-ldap-struct) method, which will both establish a connection and bind to the directory server.

This method may be useful in cases in which it is desirable to establish a connection without performing any operation (e.g., when testing connectivity).

# delete method ([LDAP](#struct-ipworkssslldap) Struct)

Deletes an entry specified by DN from the directory server.

## Syntax

*Rust Syntax*

```text
fn delete(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method deletes the entry specified by [dn](#dn-property-ldap-struct) from the directory. The result of the operation is returned through the [on_result](#on_result-event-ldap-struct) event.

# do_events method ([LDAP](#struct-ipworkssslldap) Struct)

This method processes events from the internal message queue.

## Syntax

*Rust Syntax*

```text
fn do_events(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

# extended_request method ([LDAP](#struct-ipworkssslldap) Struct)

This method performs a Lightweight Directory Access Protocol (LDAP) V3 extended operation.

## Syntax

*Rust Syntax*

```text
fn extended_request(&self, request_name : &str, request_value : &[u8]) -> Result<(), IPWorksSSLError>
```

## Remarks

This method performs an LDAP V3 extended operation. *request_name* must contain the object identifier of the operation, and *request_value* may contain an optional value.

# interrupt method ([LDAP](#struct-ipworkssslldap) Struct)

This method interrupts the current method.

## Syntax

*Rust Syntax*

```text
fn interrupt(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

# list_computers method ([LDAP](#struct-ipworkssslldap) Struct)

This method lists all computers in the directory.

## Syntax

*Rust Syntax*

```text
fn list_computers(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method lists all computers in the directory. The [on_computer_list](#on_computer_list-event-ldap-struct) event will be fired once for each computer returned.

# list_group_members method ([LDAP](#struct-ipworkssslldap) Struct)

This method lists all members of a group.

## Syntax

*Rust Syntax*

```text
fn list_group_members(&self, group : &str) -> Result<(), IPWorksSSLError>
```

## Remarks

This method lists all members of the specified *group*. The [on_user_list](#on_user_list-event-ldap-struct) event will be fired once for each member returned.

# list_groups method ([LDAP](#struct-ipworkssslldap) Struct)

This method list all groups in the directory.

## Syntax

*Rust Syntax*

```text
fn list_groups(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method lists all groups in the directory. The [on_group_list](#on_group_list-event-ldap-struct) event will be fired once for each group returned.

# list_user_groups method ([LDAP](#struct-ipworkssslldap) Struct)

This method lists all groups a user is a part of.

## Syntax

*Rust Syntax*

```text
fn list_user_groups(&self, user : &str) -> Result<(), IPWorksSSLError>
```

## Remarks

This method lists all groups that the user specified by *user* is a part of. The [on_group_list](#on_group_list-event-ldap-struct) event will fire once for each group the user is a part of.

# modify method ([LDAP](#struct-ipworkssslldap) Struct)

This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN .

## Syntax

*Rust Syntax*

```text
fn modify(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method performs an LDAP *modify* operation on the entry specified by [dn](#dn-property-ldap-struct). The attributes to modify should be set via the attributes properties. When specifying multivalued attributes, specify the attribute type only in the first occurrence of that attribute type in the attributes properties. Additional instances of the same attribute type should specify an attribute type of an empty string.

The modification can be a replacement, an addition, or a deletion, depending on the **ModOp** field of the attribute;. The result of the operation is returned through the [on_result](#on_result-event-ldap-struct) event.

**Example. Modify an Entry (Replace an Attribute Value):**

```text
LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server"
LDAPControl.AttributeCount = 2
LDAPControl.AttributeType(0) = "url"
LDAPControl.AttributeValue(0) = "www.url1.net"
LDAPControl.AttributeModOp(0) = amoReplace
LDAPControl.AttributeType(0) = ""
LDAPControl.AttributeValue(0) = "www.url2.net"
LDAPControl.AttributeModOp(0) = amoReplace
LDAPControl.Modify()
```

# modify_rdn method ([LDAP](#struct-ipworkssslldap) Struct)

This method performs a Lightweight Directory Access Protocol (LDAP) modify RDN operation on an entry specified by DN .

## Syntax

*Rust Syntax*

```text
fn modify_rdn(&self, new_rdn : &str) -> Result<(), IPWorksSSLError>
```

## Remarks

This method performs an LDAP *modify RDN* operation on the entry specified by [dn](#dn-property-ldap-struct).

*new_rdn* is the new RDN for the entry specified by [dn](#dn-property-ldap-struct)

The result of the operation is returned through the [on_result](#on_result-event-ldap-struct) event.

# move_to_dn method ([LDAP](#struct-ipworkssslldap) Struct)

This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN by changing its superior.

## Syntax

*Rust Syntax*

```text
fn move_to_dn(&self, new_superior : &str) -> Result<(), IPWorksSSLError>
```

## Remarks

This method performs an LDAP *modify* operation on the entry specified by [dn](#dn-property-ldap-struct) by changing its superior.

NOTE: None of the entry's attributes will change. [delete_old_rdn](#delete_old_rdn-property-ldap-struct) property will be set to True to delete the old entry. The result of the operation is returned through the [on_result](#on_result-event-ldap-struct) event.

# pause_data method ([LDAP](#struct-ipworkssslldap) Struct)

This method pauses data reception.

## Syntax

*Rust Syntax*

```text
fn pause_data(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method pauses data reception when called. While data reception is paused, incoming data will not be processed and events will not fire. Call [process_data](#process_data-method-ldap-struct) to re-enable data reception.

# process_data method ([LDAP](#struct-ipworkssslldap) Struct)

This method re-enables data reception after a call to PauseData .

## Syntax

*Rust Syntax*

```text
fn process_data(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method re-enables data reception after a previous call to [pause_data](#pause_data-method-ldap-struct). Call this method to re-enable data reception and allow on_ip_packet to fire.

NOTE: This method is used only after previously calling [pause_data](#pause_data-method-ldap-struct). It does not need to be called to process data by default.

# reset method ([LDAP](#struct-ipworkssslldap) Struct)

This method will reset the struct.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method will reset the struct's properties to their default values.

# search method ([LDAP](#struct-ipworkssslldap) Struct)

This method searches the directory server using the base object specified in DN and the search filter SearchFilter .

## Syntax

*Rust Syntax*

```text
fn search(&self, search_filter : &str) -> Result<(), IPWorksSSLError>
```

## Remarks

This method searches the directory server using the base object specified in the [dn](#dn-property-ldap-struct) and the search filter specified in the *search_filter* parameter. Additional search parameters are specified through the [search_scope](#search_scope-property-ldap-struct), [search_deref_aliases](#search_deref_aliases-property-ldap-struct), [search_size_limit](#search_size_limit-property-ldap-struct), [search_time_limit](#search_time_limit-property-ldap-struct), and [search_return_values](#search_return_values-property-ldap-struct) properties.

If attributes are specified before starting a search, the server will return only those results that contain a value for the specified attributes.

Results are returned through zero or more [on_search_result](#on_search_result-event-ldap-struct) events, after which a [on_search_complete](#on_search_complete-event-ldap-struct) event is fired.

**Example 1. Searching for a User:**

```text
LDAPControl.DN = "ou=Employees,dc=server"
LDAPControl.Search("uid=TThompson")
```

A Directory-Specific Entries (DSE) search will search for the attributes of the server. **Example 2. DSE Search:**

```text
LDAPControl.DN = ""
LDAPControl.SearchScope = 0
LDAPControl.Search("objectClass=*")
```

*search_filter* is a string representation of the Lightweight Directory Access Protocol (LDAP) search filter used for the search.

The format of the search filter is specified by RFC 1558 and is identical to the format used by most LDAP applications.

The following are examples of search filters, as provided in the RFC:

**Example 3. Search Filters:**

```text
     (cn=Babs Jensen)
     (!(cn=Tim Howes))
     (&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))
     (o=univ*of*mich*)
```

The complete specification is given by the following BNF:

```text
     <filter> ::= "(" <filtercomp> ")"
     <filtercomp> ::= <and> | <or> | <not> | <item>
     <and> ::= "&" <filterlist>
     <or> ::= "|" <filterlist>
     <not> ::= "!" <filter>
     <filterlist> ::= <filter> | <filter> <filterlist>
     <item> ::= <simple> | <present> | <substring>
     <simple> ::= <attr> <filtertype> <value>
     <filtertype> ::= <equal> | <approx> | <greater> | <less>
     <equal> ::= "="
     <approx> ::= "~="
     <greater> ::= ">="
     <less> ::= "<="
     <present> ::= <attr> "=*"
     <substring> ::= <attr> "=" <initial> <any> <final>
     <initial> ::= NULL | <value>
     <any> ::= "*" <starval>
     <starval> ::= NULL | <value> "*" <starval>
     <final> ::= NULL | <value>
```

<attr> is a string representing an attribute type as defined in RFC 1777. <value> is a string representing an attribute value, or part of one, and has the form defined in RFC 1779. If a <value> must contain one of the characters '*' or '(' or ')', these should be escaped by preceding them with the backslash '\' character.

# unbind method ([LDAP](#struct-ipworkssslldap) Struct)

This method unbinds from the directory server.

## Syntax

*Rust Syntax*

```text
fn unbind(&self) -> Result<(), IPWorksSSLError>
```

## Remarks

This method unbinds from the directory server and breaks the connection.

# on_computer_list event ([LDAP](#struct-ipworkssslldap) Struct)

This event is fired for each computer entry returned.

## Syntax

*Rust Syntax*

```text
// LDAPComputerListEventArgs carries the LDAP ComputerList event's parameters.
pub struct LDAPComputerListEventArgs {
  fn name(&self) -> &String
  fn operating_system(&self) -> &String
  fn last_logon(&self) -> &String
  fn logon_count(&self) -> i32
  fn dn(&self) -> &String
}

// LDAPComputerListEvent defines the signature of the LDAP ComputerList event's handler function.
pub trait LDAPComputerListEvent {
  fn on_computer_list(&self, sender : LDAP, e : &mut LDAPComputerListEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_computer_list(&self) -> &'a dyn LDAPComputerListEvent;
  pub fn set_on_computer_list(&mut self, value : &'a dyn LDAPComputerListEvent);
  ...
}
```

## Remarks

This event is fired once for each computer returned when the [list_computers](#list_computers-method-ldap-struct) method is called.

# on_connected event ([LDAP](#struct-ipworkssslldap) Struct)

Fired immediately after a connection completes (or fails).

## Syntax

*Rust Syntax*

```text
// LDAPConnectedEventArgs carries the LDAP Connected event's parameters.
pub struct LDAPConnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// LDAPConnectedEvent defines the signature of the LDAP Connected event's handler function.
pub trait LDAPConnectedEvent {
  fn on_connected(&self, sender : LDAP, e : &mut LDAPConnectedEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_connected(&self) -> &'a dyn LDAPConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn LDAPConnectedEvent);
  ...
}
```

## Remarks

If the connection is made normally, *status_code* is 0 and *description* is "OK".

If the connection fails, *status_code* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *description* contains a description of this code. The value of *status_code* is equal to the value of the error.

Please refer to the [Error Codes](#trappable-errors-ldap-struct) section for more information.

# on_connection_status event ([LDAP](#struct-ipworkssslldap) Struct)

Fired to indicate changes in the connection state.

## Syntax

*Rust Syntax*

```text
// LDAPConnectionStatusEventArgs carries the LDAP ConnectionStatus event's parameters.
pub struct LDAPConnectionStatusEventArgs {
  fn connection_event(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// LDAPConnectionStatusEvent defines the signature of the LDAP ConnectionStatus event's handler function.
pub trait LDAPConnectionStatusEvent {
  fn on_connection_status(&self, sender : LDAP, e : &mut LDAPConnectionStatusEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_connection_status(&self) -> &'a dyn LDAPConnectionStatusEvent;
  pub fn set_on_connection_status(&mut self, value : &'a dyn LDAPConnectionStatusEvent);
  ...
}
```

## Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The *connection_event* parameter indicates the type of connection event. Values may include the following:

|  |  |
| --- | --- |
|  | Firewall connection complete. |
|  | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). |
|  | Remote host connection complete. |
|  | Remote host disconnected. |
|  | SSL or S/Shell connection broken. |
|  | Firewall host disconnected. |

 *status_code* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *description* contains a description of this code. The value of *status_code* is equal to the value of the error.

# on_disconnected event ([LDAP](#struct-ipworkssslldap) Struct)

Fired when a connection is closed.

## Syntax

*Rust Syntax*

```text
// LDAPDisconnectedEventArgs carries the LDAP Disconnected event's parameters.
pub struct LDAPDisconnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// LDAPDisconnectedEvent defines the signature of the LDAP Disconnected event's handler function.
pub trait LDAPDisconnectedEvent {
  fn on_disconnected(&self, sender : LDAP, e : &mut LDAPDisconnectedEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_disconnected(&self) -> &'a dyn LDAPDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn LDAPDisconnectedEvent);
  ...
}
```

## Remarks

If the connection is broken normally, *status_code* is 0 and *description* is "OK".

If the connection is broken for any other reason, *status_code* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *description* contains a description of this code. The value of *status_code* is equal to the value of the TCP/IP error.

Please refer to the [Error Codes](#trappable-errors-ldap-struct) section for more information.

# on_error event ([LDAP](#struct-ipworkssslldap) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

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

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

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

## 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-ldap-struct) section.

# on_extended_response event ([LDAP](#struct-ipworkssslldap) Struct)

This event is fired for Lightweight Directory Access Protocol (LDAP) V3 extended responses.

## Syntax

*Rust Syntax*

```text
// LDAPExtendedResponseEventArgs carries the LDAP ExtendedResponse event's parameters.
pub struct LDAPExtendedResponseEventArgs {
  fn message_id(&self) -> i32
  fn dn(&self) -> &String
  fn result_code(&self) -> i32
  fn result_description(&self) -> &String
  fn response_name(&self) -> &String
  fn response_value(&self) -> &[u8]
}

// LDAPExtendedResponseEvent defines the signature of the LDAP ExtendedResponse event's handler function.
pub trait LDAPExtendedResponseEvent {
  fn on_extended_response(&self, sender : LDAP, e : &mut LDAPExtendedResponseEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_extended_response(&self) -> &'a dyn LDAPExtendedResponseEvent;
  pub fn set_on_extended_response(&mut self, value : &'a dyn LDAPExtendedResponseEvent);
  ...
}
```

## Remarks

The first four parameters are the same as the parameters of the [on_result](#on_result-event-ldap-struct) event. *response_name* and *response_value* are related to the corresponding parameters of the call to [extended_request](#extended_request-method-ldap-struct).

# on_group_list event ([LDAP](#struct-ipworkssslldap) Struct)

This event is fired for each group entry returned.

## Syntax

*Rust Syntax*

```text
// LDAPGroupListEventArgs carries the LDAP GroupList event's parameters.
pub struct LDAPGroupListEventArgs {
  fn name(&self) -> &String
  fn description(&self) -> &String
  fn dn(&self) -> &String
}

// LDAPGroupListEvent defines the signature of the LDAP GroupList event's handler function.
pub trait LDAPGroupListEvent {
  fn on_group_list(&self, sender : LDAP, e : &mut LDAPGroupListEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_group_list(&self) -> &'a dyn LDAPGroupListEvent;
  pub fn set_on_group_list(&mut self, value : &'a dyn LDAPGroupListEvent);
  ...
}
```

## Remarks

This event is fired once for each group entry returned when either of the [list_groups](#list_groups-method-ldap-struct) or [list_user_groups](#list_user_groups-method-ldap-struct) methods are called.

# on_pi_trail event ([LDAP](#struct-ipworkssslldap) Struct)

This event provides detailed information about the interaction with the server.

## Syntax

*Rust Syntax*

```text
// LDAPPITrailEventArgs carries the LDAP PITrail event's parameters.
pub struct LDAPPITrailEventArgs {
  fn direction(&self) -> i32
  fn description(&self) -> &String
  fn message(&self) -> &String
}

// LDAPPITrailEvent defines the signature of the LDAP PITrail event's handler function.
pub trait LDAPPITrailEvent {
  fn on_pi_trail(&self, sender : LDAP, e : &mut LDAPPITrailEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_pi_trail(&self) -> &'a dyn LDAPPITrailEvent;
  pub fn set_on_pi_trail(&mut self, value : &'a dyn LDAPPITrailEvent);
  ...
}
```

## Remarks

The on_pi_trail event provides detailed information about all communication with the server. This is useful for debugging purposes.

*direction* specifies the origin of the data. Possible values are as follows:

- 0 - Client
- 1 - Server

*description* is a short description of the current packet. This is human readable and useful for informational logging.

*message* contains a hex-encoded version of the raw message. This represents the exact value sent over the wire.

# on_result event ([LDAP](#struct-ipworkssslldap) Struct)

This event is fired for every server response, except for search responses.

## Syntax

*Rust Syntax*

```text
// LDAPResultEventArgs carries the LDAP Result event's parameters.
pub struct LDAPResultEventArgs {
  fn message_id(&self) -> i32
  fn dn(&self) -> &String
  fn result_code(&self) -> i32
  fn result_description(&self) -> &String
}

// LDAPResultEvent defines the signature of the LDAP Result event's handler function.
pub trait LDAPResultEvent {
  fn on_result(&self, sender : LDAP, e : &mut LDAPResultEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_result(&self) -> &'a dyn LDAPResultEvent;
  pub fn set_on_result(&mut self, value : &'a dyn LDAPResultEvent);
  ...
}
```

## Remarks

The *message_id* parameter identifies the corresponding request. *result_code* and *result_description* show whether or not the operation was successful (on a successful operation, the *result_code* is 0). For a full list of possible result codes, see the [result_code](#result_code-property-ldap-struct) property.

# on_search_complete event ([LDAP](#struct-ipworkssslldap) Struct)

This event is fired upon completion of a search operation.

## Syntax

*Rust Syntax*

```text
// LDAPSearchCompleteEventArgs carries the LDAP SearchComplete event's parameters.
pub struct LDAPSearchCompleteEventArgs {
  fn message_id(&self) -> i32
  fn dn(&self) -> &String
  fn result_code(&self) -> i32
  fn result_description(&self) -> &String
}

// LDAPSearchCompleteEvent defines the signature of the LDAP SearchComplete event's handler function.
pub trait LDAPSearchCompleteEvent {
  fn on_search_complete(&self, sender : LDAP, e : &mut LDAPSearchCompleteEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_search_complete(&self) -> &'a dyn LDAPSearchCompleteEvent;
  pub fn set_on_search_complete(&mut self, value : &'a dyn LDAPSearchCompleteEvent);
  ...
}
```

## Remarks

The *message_id* parameter identifies the corresponding request. *result_code* and *result_description* show whether the operation was successful (on a successful operation, the *result_code* is 0).

# on_search_page event ([LDAP](#struct-ipworkssslldap) Struct)

This event is fired for every page returned from a search operation.

## Syntax

*Rust Syntax*

```text
// LDAPSearchPageEventArgs carries the LDAP SearchPage event's parameters.
pub struct LDAPSearchPageEventArgs {
  fn message_id(&self) -> i32
  fn dn(&self) -> &String
  fn result_code(&self) -> i32
  fn result_description(&self) -> &String
  fn cancel_search(&self) -> bool
  fn set_cancel_search(&self, value : bool)
}

// LDAPSearchPageEvent defines the signature of the LDAP SearchPage event's handler function.
pub trait LDAPSearchPageEvent {
  fn on_search_page(&self, sender : LDAP, e : &mut LDAPSearchPageEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_search_page(&self) -> &'a dyn LDAPSearchPageEvent;
  pub fn set_on_search_page(&mut self, value : &'a dyn LDAPSearchPageEvent);
  ...
}
```

## Remarks

This event is fired so the client can decide whether or not to continue with the [search](#search-method-ldap-struct) operation. The signature is very similar to the [on_search_complete](#on_search_complete-event-ldap-struct) event, with the addition of a *cancel_search* parameter. If the search should be canceled (no more pages), the *cancel_search* parameter should be set to True.

# on_search_result event ([LDAP](#struct-ipworkssslldap) Struct)

This event is fired for every entry returned from a search operation.

## Syntax

*Rust Syntax*

```text
// LDAPSearchResultEventArgs carries the LDAP SearchResult event's parameters.
pub struct LDAPSearchResultEventArgs {
  fn message_id(&self) -> i32
  fn dn(&self) -> &String
}

// LDAPSearchResultEvent defines the signature of the LDAP SearchResult event's handler function.
pub trait LDAPSearchResultEvent {
  fn on_search_result(&self, sender : LDAP, e : &mut LDAPSearchResultEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_search_result(&self) -> &'a dyn LDAPSearchResultEvent;
  pub fn set_on_search_result(&mut self, value : &'a dyn LDAPSearchResultEvent);
  ...
}
```

## Remarks

*message_id* identifies the corresponding search request. *dn* contains the distinguished name of the entry. The attribute type and value provided in the attributes properties show the list of retrieved attributes for the entry.

Every search operation results in a sequence of 0 or more on_search_result events and a sequence of 0 or more [on_search_result_reference](#on_search_result_reference-event-ldap-struct) events, which are followed by a [on_search_complete](#on_search_complete-event-ldap-struct) event.

# on_search_result_reference event ([LDAP](#struct-ipworkssslldap) Struct)

This event is fired for every result reference returned from a search operation.

## Syntax

*Rust Syntax*

```text
// LDAPSearchResultReferenceEventArgs carries the LDAP SearchResultReference event's parameters.
pub struct LDAPSearchResultReferenceEventArgs {
  fn message_id(&self) -> i32
  fn ldap_url(&self) -> &String
}

// LDAPSearchResultReferenceEvent defines the signature of the LDAP SearchResultReference event's handler function.
pub trait LDAPSearchResultReferenceEvent {
  fn on_search_result_reference(&self, sender : LDAP, e : &mut LDAPSearchResultReferenceEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_search_result_reference(&self) -> &'a dyn LDAPSearchResultReferenceEvent;
  pub fn set_on_search_result_reference(&mut self, value : &'a dyn LDAPSearchResultReferenceEvent);
  ...
}
```

## Remarks

*message_id* identifies the corresponding search request. *ldap_url* contains a URL reference to a server that can be used for continuing the search operation.

Every search operation results in a sequence of 0 or more [on_search_result](#on_search_result-event-ldap-struct) events and a sequence of 0 or more on_search_result_reference events, which are followed by a [on_search_complete](#on_search_complete-event-ldap-struct) event.

# on_ssl_server_authentication event ([LDAP](#struct-ipworkssslldap) Struct)

Fired after the server presents its certificate to the client.

## Syntax

*Rust Syntax*

```text
// LDAPSSLServerAuthenticationEventArgs carries the LDAP SSLServerAuthentication event's parameters.
pub struct LDAPSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// LDAPSSLServerAuthenticationEvent defines the signature of the LDAP SSLServerAuthentication event's handler function.
pub trait LDAPSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : LDAP, e : &mut LDAPSSLServerAuthenticationEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn LDAPSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn LDAPSSLServerAuthenticationEvent);
  ...
}
```

## Remarks

During this event, the client can decide whether or not to continue with the connection process. The *accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

 When *accept* is False, *status* shows why the verification failed (otherwise, *status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *accept* parameter to True.

# on_ssl_status event ([LDAP](#struct-ipworkssslldap) Struct)

Fired when secure connection progress messages are available.

## Syntax

*Rust Syntax*

```text
// LDAPSSLStatusEventArgs carries the LDAP SSLStatus event's parameters.
pub struct LDAPSSLStatusEventArgs {
  fn message(&self) -> &String
}

// LDAPSSLStatusEvent defines the signature of the LDAP SSLStatus event's handler function.
pub trait LDAPSSLStatusEvent {
  fn on_ssl_status(&self, sender : LDAP, e : &mut LDAPSSLStatusEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn LDAPSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn LDAPSSLStatusEvent);
  ...
}
```

## Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

# on_user_list event ([LDAP](#struct-ipworkssslldap) Struct)

This event is fired once for each user entry returned.

## Syntax

*Rust Syntax*

```text
// LDAPUserListEventArgs carries the LDAP UserList event's parameters.
pub struct LDAPUserListEventArgs {
  fn name(&self) -> &String
  fn description(&self) -> &String
  fn last_logon(&self) -> &String
  fn member_of(&self) -> &String
  fn dn(&self) -> &String
}

// LDAPUserListEvent defines the signature of the LDAP UserList event's handler function.
pub trait LDAPUserListEvent {
  fn on_user_list(&self, sender : LDAP, e : &mut LDAPUserListEventArgs);
}

impl <'a> LDAP<'a> {
  pub fn on_user_list(&self) -> &'a dyn LDAPUserListEvent;
  pub fn set_on_user_list(&mut self, value : &'a dyn LDAPUserListEvent);
  ...
}
```

## Remarks

This event is fired once for each user entry returned when the [list_group_members](#list_group_members-method-ldap-struct) method is called.

# Config Settings ([LDAP](#struct-ipworkssslldap) 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-ldap-struct) method.

### LDAP Config Settings

**DomainController**: Returns the name of the domain controller.This configuration setting may be queried to return the name of the default domain controller in Active Directory domains.

NOTE: This functionality is available only in Windows.

NOTE: This functionality is not available in Java.

**FriendlyGUID**: Whether to return GUID attribute values in a human readable format.When inspecting object attributes, this configuration setting determines whether GUID attributes, such as "objectGUID" are returned as binary objects or converted into a human readable string, such as "708d9374-d64a-49b2-97ea-489ddc717703". When set to True, a friendly string value is returned. When set to False (default), a binary object is returned.

**FriendlySID**: Whether to return SID attribute values in a human readable format.When inspecting object attributes, this configuration setting determines whether SID attributes, such as "objectSid" are returned as binary objects or converted into a human readable string, such as "S-1-5-21-4272240814-246508344-1325542772-12464". When set to True, a friendly string value is returned. When set to False (default), a binary object is returned.

**RequestControls**: Controls to include in the request.This configuration setting may be used to specify LDAP controls in the request. The expected format is a space-separated sequence of OIDs and hex-encoded values. For instance, a single control with a value of 04 may be sent as follows:

```text
ldap.Config("RequestControls=1.2.826.0.1.3344810.2.3 04");
```

 To send a control without a value, specify only the OID. For instance:

```text
ldap.Config("RequestControls=1.3.6.1.4.1.42.2.27.8.5.1");
```

**ResponseControls**: Controls present in the response.This configuration setting holds the LDAP controls returned in the response (if any). The format is a space-separated sequence of OIDs and hex-encoded values. For instance:

```text
Log(ldap.Config("ResponseControls"));
```

 The output may look something like this: *1.2.826.0.1.3344810.2.3 04*

**SingleResultMode**: Determines how ResultDN behaves.When set to True, [result_dn](#result_dn-property-ldap-struct) will return only the next result when queried. If no more results are found, querying [result_dn](#result_dn-property-ldap-struct) will return an empty string. This is useful in environments in which events cannot be used, such as ASP. For instance:

```text
	LDAP1.DN = Request("basedn")
	LDAP1.Config ("SingleResultMode=true")
	LDAP1.Search Request("query")
	Dim Result, i

	Response.Write "<hr><pre>"
	Do
		Result = LDAP1.ResultDN
		if (Result <> "") then
			Response.Write Result + "<br>"
			'The attributes of each entry are in the AttrType and AttrValue property arrays
			For i = 0 To LDAP1.AttrCount - 1
				Response.Write LDAP1.AttrType(i) + ": " + LDAP1.AttrValue(i) + "<br>"
			Next
		End If
	Loop While Result <> ""
	Response.Write "</pre>"
```

**UseDefaultDC**: Whether to connect to the default Domain Controller when calling Bind.If this configuration setting is set to True, [server_name](#server_name-property-ldap-struct) does not need to be set before calling [bind](#bind-method-ldap-struct) in Active Directory domains. When True, the struct will query the system for the default domain controller and attempt to establish a connection with that server.

NOTE: This functionality is available only in Windows.

NOTE: This functionality is not available in Java.

### TCPClient Config Settings

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use [timeout](#timeout-property-ldap-struct) for establishing a connection and transmitting/receiving data.

**EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and remote_host resolves to more than one address, the struct will try the remaining addresses in turn if the connection to the first one fails, and only fails with an error once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent.

NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved.

This setting must be set before the connection is established. The default value for this setting is False.

**FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the struct will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout.

NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the [connected](#connected-property-ldap-struct) operation as a whole.

**FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property-ldap-struct) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface.

If the struct is connected, the [local_host](#local_host-property-ldap-struct) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

**LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an eol string.

If an eol string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the on_data_in event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no eol is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the on_data_in event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [ssl_provider](#ssl_provider-property-ldap-struct) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [on_ssl_status](#on_ssl_status-event-ldap-struct) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [ssl_provider](#ssl_provider-property-ldap-struct) is set to *Platform*.

**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

 -----BEGIN CERTIFICATE-----

 ... (CA certificate in base64 encoding) ...

 -----END CERTIFICATE-----

 Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the struct will reuse the context if and only if the following criteria are met:

- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the struct is the same.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [ssl_provider](#ssl_provider-property-ldap-struct) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the struct fails with an error.

When set to 0 (default), the CRL check will not be performed by the struct. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the struct fails with an error.

When set to 0 (default), the struct will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [on_ssl_status](#on_ssl_status-event-ldap-struct) event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when ssl_authenticate_clients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the struct will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when [ssl_provider](#ssl_provider-property-ldap-struct) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [ssl_provider](#ssl_provider-property-ldap-struct) is set to *Platform* include the following:

- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF

 Example values when [ssl_provider](#ssl_provider-property-ldap-struct) is set to *Internal*include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [ssl_provider](#ssl_provider-property-ldap-struct) is set to *Internal* include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

By default when TLS 1.3 is enabled, the struct will first try to use the platform TLS 1.3 implementation when the [ssl_provider](#ssl_provider-property-ldap-struct) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, [ssl_provider](#ssl_provider-property-ldap-struct) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to *1* (Platform provider), please be aware of the following notes:

- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the struct when the [ssl_provider](#ssl_provider-property-ldap-struct) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [ssl_provider](#ssl_provider-property-ldap-struct) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [ssl_provider](#ssl_provider-property-ldap-struct) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-ldap-struct) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-ldap-struct) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-ldap-struct) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the struct will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the struct will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [ssl_provider](#ssl_provider-property-ldap-struct) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

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

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----
```

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [ssl_provider](#ssl_provider-property-ldap-struct) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the struct will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the struct fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [ssl_provider](#ssl_provider-property-ldap-struct) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported:

- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)

 The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property-ldap-struct) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### 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 ([LDAP](#struct-ipworkssslldap) Struct)

### LDAP Errors

|  |  |
| --- | --- |
| 118 | Firewall error. Error message contains detailed description. |
| 301 | Index out of range. |
| 331 | Bad attribute index. |
| 334 | Busy executing current method. |
| 335 | Error in search filter. |
| 336 | Protocol error. |

The class may also return one of the following error codes, which are inherited from other classes.

### SSLClient Errors

|  |  |
| --- | --- |
| 100 | You cannot change the remote_port at this time. A connection is in progress. |
| 101 | You cannot change the remote_host (Server) at this time. A connection is in progress. |
| 102 | The remote_host address is invalid (0.0.0.0). |
| 104 | Already connected. If you want to reconnect, close the current connection first. |
| 106 | You cannot change the local_port at this time. A connection is in progress. |
| 107 | You cannot change the [local_host](#local_host-property-ldap-struct) at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | remote_port cannot be zero. Please specify a valid service port number. |
| 117 | You cannot change the UseConnection option while the struct is active. |
| 135 | Operation would block. |
| 201 | Timeout. |
| 211 | Action impossible in control's present state. |
| 212 | Action impossible while not connected. |
| 213 | Action impossible while listening. |
| 301 | Timeout. |
| 302 | Could not open file. |
| 434 | Unable to convert string to selected CodePage. |
| 1105 | Already connecting. If you want to reconnect, close the current connection first. |
| 1117 | You need to connect first. |
| 1119 | You cannot change the LocalHost at this time. A connection is in progress. |
| 1120 | Connection dropped by remote host. |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |