# LDAP Class The Lightweight Directory Access Protocol (LDAP) Class is used to search, manage, and maintain internet directory servers. ## Syntax ```text class ipworksauth.LDAP ``` ## Remarks The LDAP Class 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) event allows you to check the server identity and other security attributes. The [on_ssl_status](#on_ssl_status-event) event provides information about the SSL handshake. Additional SSL-related settings are also supported through the [config](#config-method) method. The LDAP Class 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 class is specifying the [server_name](#server_name-property), a [dn](#dn-property) (distinguished name) to bind as, and optionally a [password](#password-property). Then you can call one or more of the class methods to act upon the server. Server responses normally are received through the [on_result](#on_result-event) event. The only exceptions are search requests that result in one or more [on_search_result](#on_search_result-event) events, followed by a final [on_search_complete](#on_search_complete-event) 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) 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), [search_time_limit](#search_time_limit-property), [search_size_limit](#search_size_limit-property), [search_return_values](#search_return_values-property), and [search_deref_aliases](#search_deref_aliases-property). The class operates synchronously by default (waits for a response before returning control to the caller); however, the class also may operate asynchronously (return control immediately), by setting [timeout](#timeout-property) to 0. Please refer to the [timeout](#timeout-property) property for more information. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [accept_data](#accept_data-property) | This property indicates whether data reception is currently enabled. | | [attr_count](#attr_count-property) | The number of records in the Attr arrays. | | [attr_mod_op](#attr_mod_op-property) | This property contains an operation to apply to attributes during a Lightweight Directory Access Protocol (LDAP) modify operation. | | [attr_type](#attr_type-property) | This property contains the attribute type for the current entry. | | [attr_value](#attr_value-property) | This property contains the attribute value for the current entry. | | [auth_mechanism](#auth_mechanism-property) | This property is the authentication mechanism to be used when connecting to the Lightweight Directory Access Protocol (LDAP) server. | | [connected](#connected-property) | This property shows whether the class is connected. | | [delete_old_rdn](#delete_old_rdn-property) | This property controls whether the old RDN (Relative Distinguished Name) should be deleted. | | [dn](#dn-property) | This property includes the distinguished name used as the base for Lightweight Directory Access Protocol (LDAP) operations. | | [firewall_auto_detect](#firewall_auto_detect-property) | Whether to automatically detect and use firewall system settings, if available. | | [firewall_host](#firewall_host-property) | The name or IP address of the firewall (optional). | | [firewall_password](#firewall_password-property) | A password if authentication is to be used when connecting through the firewall. | | [firewall_port](#firewall_port-property) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [firewall_type](#firewall_type-property) | The type of firewall to connect through. | | [firewall_user](#firewall_user-property) | A username if authentication is to be used when connecting through a firewall. | | [idle](#idle-property) | The current status of the class. | | [ldap_version](#ldap_version-property) | The version of the Lightweight Directory Access Protocol (LDAP) used. | | [local_host](#local_host-property) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [message_id](#message_id-property) | This property includes the message identifier for the next Lightweight Directory Access Protocol (LDAP) request. | | [page_size](#page_size-property) | This property includes the maximum number of results per page for the Search method. | | [password](#password-property) | This property includes the password used to authenticate to the Lightweight Directory Access Protocol (LDAP) server. | | [reference_count](#reference_count-property) | The number of records in the Reference arrays. | | [reference_url](#reference_url-property) | The url of the LDAP reference. | | [result_code](#result_code-property) | This property includes the result code returned in the last server response. | | [result_description](#result_description-property) | This property includes the descriptive text returned in the last server response (if any). | | [result_dn](#result_dn-property) | This property includes the distinguished name returned in the last server response (if any). | | [search_deref_aliases](#search_deref_aliases-property) | This property controls alias dereferencing during searching. | | [search_return_values](#search_return_values-property) | This property controls whether the search operation returns values of attributes or only types. | | [search_scope](#search_scope-property) | This property controls the scope of Lightweight Directory Access Protocol (LDAP) search operations. | | [search_size_limit](#search_size_limit-property) | This property includes the maximum number of entries that can be returned by the next search operation. | | [search_time_limit](#search_time_limit-property) | This property includes a time limit for the next search operation (in seconds). | | [server_name](#server_name-property) | This property includes the name or address of the Lightweight Directory Access Protocol (LDAP) server. | | [server_port](#server_port-property) | This property includes the server port for the Lightweight Directory Access Protocol (LDAP) connection (the default is 389). | | [sort_attributes](#sort_attributes-property) | 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) | The date on which this certificate becomes valid. | | [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property) | The issuer of the certificate. | | [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property) | The public key of the certificate. | | [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property) | 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) | The length of the certificate's public key (in bits). | | [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property) | 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) | The type of certificate store for this certificate. | | [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property) | The text description of UsageFlags . | | [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property) | The certificate's version number. | | [ssl_cert_effective_date](#ssl_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_cert_encoded](#ssl_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_cert_expiration_date](#ssl_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_cert_fingerprint](#ssl_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_cert_issuer](#ssl_cert_issuer-property) | The issuer of the certificate. | | [ssl_cert_private_key](#ssl_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_cert_private_key_container](#ssl_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_cert_public_key](#ssl_cert_public_key-property) | The public key of the certificate. | | [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_cert_public_key_length](#ssl_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_cert_serial_number](#ssl_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_cert_store](#ssl_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_cert_store_password](#ssl_cert_store_password-property) | 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) | The type of certificate store for this certificate. | | [ssl_cert_subject](#ssl_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_cert_usage](#ssl_cert_usage-property) | The text description of UsageFlags . | | [ssl_cert_usage_flags](#ssl_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_cert_version](#ssl_cert_version-property) | The certificate's version number. | | [ssl_enabled](#ssl_enabled-property) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. | | [ssl_provider](#ssl_provider-property) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [ssl_server_cert_effective_date](#ssl_server_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_server_cert_expiration_date](#ssl_server_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_server_cert_extended_key_usage](#ssl_server_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_server_cert_fingerprint](#ssl_server_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha1](#ssl_server_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha256](#ssl_server_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_server_cert_issuer](#ssl_server_cert_issuer-property) | The issuer of the certificate. | | [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_server_cert_private_key_container](#ssl_server_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_server_cert_public_key](#ssl_server_cert_public_key-property) | The public key of the certificate. | | [ssl_server_cert_public_key_algorithm](#ssl_server_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_server_cert_public_key_length](#ssl_server_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_server_cert_serial_number](#ssl_server_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_server_cert_signature_algorithm](#ssl_server_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_server_cert_store](#ssl_server_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_server_cert_store_password](#ssl_server_cert_store_password-property) | 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) | The type of certificate store for this certificate. | | [ssl_server_cert_subject](#ssl_server_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_server_cert_subject_alt_names](#ssl_server_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_server_cert_thumbprint_md5](#ssl_server_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_server_cert_thumbprint_sha1](#ssl_server_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_server_cert_thumbprint_sha256](#ssl_server_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_server_cert_usage](#ssl_server_cert_usage-property) | The text description of UsageFlags . | | [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_server_cert_version](#ssl_server_cert_version-property) | The certificate's version number. | | [ssl_start_mode](#ssl_start_mode-property) | This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. | | [timeout](#timeout-property) | This property includes the timeout for the class. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [abandon](#abandon-method) | This method asks the server to abandon a request. | | [add](#add-method) | 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) | This method returns the value of the specified Lightweight Directory Access Protocol (LDAP) attribute. | | [bind](#bind-method) | This method connects and binds to the directory server. | | [change_password](#change_password-method) | This method changes the password for the specified user. | | [compare](#compare-method) | This method compares attributes and values with those of the entry specified by DN . | | [config](#config-method) | Sets or retrieves a configuration setting. | | [connect](#connect-method) | This method connects to the directory server without performing any action. | | [delete](#delete-method) | Deletes an entry specified by DN from the directory server. | | [do_events](#do_events-method) | This method processes events from the internal message queue. | | [extended_request](#extended_request-method) | This method performs a Lightweight Directory Access Protocol (LDAP) V3 extended operation. | | [interrupt](#interrupt-method) | This method interrupts the current method. | | [list_computers](#list_computers-method) | This method lists all computers in the directory. | | [list_group_members](#list_group_members-method) | This method lists all members of a group. | | [list_groups](#list_groups-method) | This method list all groups in the directory. | | [list_user_groups](#list_user_groups-method) | This method lists all groups a user is a part of. | | [modify](#modify-method) | This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN . | | [modify_rdn](#modify_rdn-method) | 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) | 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) | This method pauses data reception. | | [process_data](#process_data-method) | This method re-enables data reception after a call to PauseData . | | [reset](#reset-method) | This method will reset the class. | | [search](#search-method) | This method searches the directory server using the base object specified in DN and the search filter SearchFilter . | | [unbind](#unbind-method) | This method unbinds from the directory server. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_computer_list](#on_computer_list-event) | This event is fired for each computer entry returned. | | [on_connected](#on_connected-event) | Fired immediately after a connection completes (or fails). | | [on_connection_status](#on_connection_status-event) | Fired to indicate changes in the connection state. | | [on_disconnected](#on_disconnected-event) | Fired when a connection is closed. | | [on_error](#on_error-event) | Fired when information is available about errors during data delivery. | | [on_extended_response](#on_extended_response-event) | This event is fired for Lightweight Directory Access Protocol (LDAP) V3 extended responses. | | [on_group_list](#on_group_list-event) | This event is fired for each group entry returned. | | [on_pi_trail](#on_pi_trail-event) | This event provides detailed information about the interaction with the server. | | [on_result](#on_result-event) | This event is fired for every server response, except for search responses. | | [on_search_complete](#on_search_complete-event) | This event is fired upon completion of a search operation. | | [on_search_page](#on_search_page-event) | This event is fired for every page returned from a search operation. | | [on_search_result](#on_search_result-event) | This event is fired for every entry returned from a search operation. | | [on_search_result_reference](#on_search_result_reference-event) | This event is fired for every result reference returned from a search operation. | | [on_ssl_server_authentication](#on_ssl_server_authentication-event) | Fired after the server presents its certificate to the client. | | [on_ssl_status](#on_ssl_status-event) | Fired when secure connection progress messages are available. | | [on_user_list](#on_user_list-event) | This event is fired once for each user entry returned. | ## Config Settings *The following is a list of config settings for the class 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 class 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 class 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. | | [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. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # accept_data property This property indicates whether data reception is currently enabled. ## Syntax ```text def get_accept_data() -> bool: ... accept_data = property(get_accept_data, None) ``` ## 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) and [process_data](#process_data-method) methods to pause and resume data reception. This property is read-only. # attr_count property The number of records in the Attr arrays. ## Syntax ```text def get_attr_count() -> int: ... def set_attr_count(value: int) -> None: ... attr_count = property(get_attr_count, set_attr_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [attr_mod_op](#attr_mod_op-property) - [attr_type](#attr_type-property) - [attr_value](#attr_value-property) The array indices start at *0* and end at *attr_count - 1*. # attr_mod_op property This property contains an operation to apply to attributes during a Lightweight Directory Access Protocol (LDAP) modify operation. ## Syntax ```text def get_attr_mod_op(attr_index: int) -> int: ... def set_attr_mod_op(attr_index: int, value: int) -> None: ... ``` ## 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 *attr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attr_count](#attr_count-property) property. # attr_type property This property contains the attribute type for the current entry. ## Syntax ```text def get_attr_type(attr_index: int) -> str: ... def set_attr_type(attr_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks This property contains the attribute type for the current entry. If the value of [attribute_type](#LDAP_p_AttrAttributeType) is an empty string, then the [attr_value](#attr_value-property) 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 [attribute_type](#LDAP_p_AttrAttributeType). The *attr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attr_count](#attr_count-property) property. # attr_value property This property contains the attribute value for the current entry. ## Syntax ```text def get_attr_value(attr_index: int) -> bytes: ... def set_attr_value(attr_index: int, value: bytes) -> None: ... ``` ## Default Value "" ## Remarks This property contains the attribute value for the current entry. If the value is part of a set of values, the [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 [attribute_type](#LDAP_p_AttrAttributeType). The *attr_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attr_count](#attr_count-property) property. # auth_mechanism property This property is the authentication mechanism to be used when connecting to the Lightweight Directory Access Protocol (LDAP) server. ## Syntax ```text def get_auth_mechanism() -> int: ... def set_auth_mechanism(value: int) -> None: ... auth_mechanism = property(get_auth_mechanism, set_auth_mechanism) ``` ## 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 | # connected property This property shows whether the class is connected. ## Syntax ```text def get_connected() -> bool: ... connected = property(get_connected, None) ``` ## Default Value FALSE ## Remarks This property is used to determine whether or not the class is connected to the remote host. Use the [bind](#bind-method) and [unbind](#unbind-method) methods to manage the connection. This property is read-only. # delete_old_rdn property This property controls whether the old RDN (Relative Distinguished Name) should be deleted. ## Syntax ```text def get_delete_old_rdn() -> bool: ... def set_delete_old_rdn(value: bool) -> None: ... delete_old_rdn = property(get_delete_old_rdn, set_delete_old_rdn) ``` ## Default Value TRUE ## Remarks This property controls whether the old RDN should be deleted. It is used when [modify_rdn](#modify_rdn-method) is called. The default value is True, which instructs the server to delete the old RDN. # dn property This property includes the distinguished name used as the base for Lightweight Directory Access Protocol (LDAP) operations. ## Syntax ```text def get_dn() -> str: ... def set_dn(value: str) -> None: ... dn = property(get_dn, set_dn) ``` ## 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" ``` # firewall_auto_detect property Whether to automatically detect and use firewall system settings, if available. ## Syntax ```text def get_firewall_auto_detect() -> bool: ... def set_firewall_auto_detect(value: bool) -> None: ... firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect) ``` ## Default Value FALSE ## Remarks Whether to automatically detect and use firewall system settings, if available. # firewall_host property The name or IP address of the firewall (optional). ## Syntax ```text def get_firewall_host() -> str: ... def set_firewall_host(value: str) -> None: ... firewall_host = property(get_firewall_host, set_firewall_host) ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property) 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 class fails with an error. # firewall_password property A password if authentication is to be used when connecting through the firewall. ## Syntax ```text def get_firewall_password() -> str: ... def set_firewall_password(value: str) -> None: ... firewall_password = property(get_firewall_password, set_firewall_password) ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property) is specified, the [firewall_user](#firewall_user-property) and [firewall_password](#firewall_password-property) properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. # firewall_port property The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax ```text def get_firewall_port() -> int: ... def set_firewall_port(value: int) -> None: ... firewall_port = property(get_firewall_port, set_firewall_port) ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property). See the description of the [firewall_host](#firewall_host-property) property for details. NOTE: This property is set automatically when [firewall_type](#LDAP_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_type](#LDAP_p_FirewallFirewallType) property for details. # firewall_type property The type of firewall to connect through. ## Syntax ```text def get_firewall_type() -> int: ... def set_firewall_type(value: int) -> None: ... firewall_type = property(get_firewall_type, set_firewall_type) ``` ## 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) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property) is set to 1080. | # firewall_user property A username if authentication is to be used when connecting through a firewall. ## Syntax ```text def get_firewall_user() -> str: ... def set_firewall_user(value: str) -> None: ... firewall_user = property(get_firewall_user, set_firewall_user) ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property) is specified, this property and the [firewall_password](#firewall_password-property) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the class fails with an error. # idle property The current status of the class. ## Syntax ```text def get_idle() -> bool: ... idle = property(get_idle, None) ``` ## 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. # ldap_version property The version of the Lightweight Directory Access Protocol (LDAP) used. ## Syntax ```text def get_ldap_version() -> int: ... def set_ldap_version(value: int) -> None: ... ldap_version = property(get_ldap_version, set_ldap_version) ``` ## Default Value 3 ## Remarks This property contains the version of LDAP used. The default value is 3 (for LDAPv3). # local_host property The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text def get_local_host() -> str: ... def set_local_host(value: str) -> None: ... local_host = property(get_local_host, set_local_host) ``` ## 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 class initiate connections (or accept in the case of server classes) 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 class 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. # message_id property This property includes the message identifier for the next Lightweight Directory Access Protocol (LDAP) request. ## Syntax ```text def get_message_id() -> int: ... def set_message_id(value: int) -> None: ... message_id = property(get_message_id, set_message_id) ``` ## 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 class increments this property automatically after each request. # page_size property This property includes the maximum number of results per page for the Search method. ## Syntax ```text def get_page_size() -> int: ... def set_page_size(value: int) -> None: ... page_size = property(get_page_size, set_page_size) ``` ## Default Value 0 ## Remarks This property contains the maximum number of results per page for the [search](#search-method) 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) 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. # password property This property includes the password used to authenticate to the Lightweight Directory Access Protocol (LDAP) server. ## Syntax ```text def get_password() -> str: ... def set_password(value: str) -> None: ... password = property(get_password, set_password) ``` ## Default Value "" ## Remarks This property contains the password used to authenticate to the LDAP server. Leave this value empty if no password is required. # reference_count property The number of records in the Reference arrays. ## Syntax ```text def get_reference_count() -> int: ... reference_count = property(get_reference_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [reference_url](#reference_url-property) The array indices start at *0* and end at *reference_count - 1*. This property is read-only. # reference_url property The url of the LDAP reference. ## Syntax ```text def get_reference_url(reference_index: int) -> str: ... ``` ## Default Value "" ## Remarks The url of the LDAP reference. If inside a [on_search_result](#on_search_result-event) or [on_search_result_reference](#on_search_result_reference-event) event, it represents a URL to contact to continue the search. If inside the [on_result](#on_result-event) event or [on_search_complete](#on_search_complete-event) event it represents the URL to contact in order to complete the requested operation. The *reference_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [reference_count](#reference_count-property) property. This property is read-only. # result_code property This property includes the result code returned in the last server response. ## Syntax ```text def get_result_code() -> int: ... result_code = property(get_result_code, None) ``` ## 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), [on_search_result](#on_search_result-event), or [on_search_complete](#on_search_complete-event) 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. # result_description property This property includes the descriptive text returned in the last server response (if any). ## Syntax ```text def get_result_description() -> str: ... result_description = property(get_result_description, None) ``` ## 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), [on_search_result](#on_search_result-event), or [on_search_complete](#on_search_complete-event) event. This property is read-only. # result_dn property This property includes the distinguished name returned in the last server response (if any). ## Syntax ```text def get_result_dn() -> str: ... result_dn = property(get_result_dn, None) ``` ## 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) or [on_search_complete](#on_search_complete-event) event. This property is read-only. # search_deref_aliases property This property controls alias dereferencing during searching. ## Syntax ```text def get_search_deref_aliases() -> int: ... def set_search_deref_aliases(value: int) -> None: ... search_deref_aliases = property(get_search_deref_aliases, set_search_deref_aliases) ``` ## 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. # search_return_values property This property controls whether the search operation returns values of attributes or only types. ## Syntax ```text def get_search_return_values() -> bool: ... def set_search_return_values(value: bool) -> None: ... search_return_values = property(get_search_return_values, set_search_return_values) ``` ## 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. # search_scope property This property controls the scope of Lightweight Directory Access Protocol (LDAP) search operations. ## Syntax ```text def get_search_scope() -> int: ... def set_search_scope(value: int) -> None: ... search_scope = property(get_search_scope, set_search_scope) ``` ## 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. # search_size_limit property This property includes the maximum number of entries that can be returned by the next search operation. ## Syntax ```text def get_search_size_limit() -> int: ... def set_search_size_limit(value: int) -> None: ... search_size_limit = property(get_search_size_limit, set_search_size_limit) ``` ## 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. # search_time_limit property This property includes a time limit for the next search operation (in seconds). ## Syntax ```text def get_search_time_limit() -> int: ... def set_search_time_limit(value: int) -> None: ... search_time_limit = property(get_search_time_limit, set_search_time_limit) ``` ## 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. # server_name property This property includes the name or address of the Lightweight Directory Access Protocol (LDAP) server. ## Syntax ```text def get_server_name() -> str: ... def set_server_name(value: str) -> None: ... server_name = property(get_server_name, set_server_name) ``` ## 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. # server_port property This property includes the server port for the Lightweight Directory Access Protocol (LDAP) connection (the default is 389). ## Syntax ```text def get_server_port() -> int: ... def set_server_port(value: int) -> None: ... server_port = property(get_server_port, set_server_port) ``` ## 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) 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. # sort_attributes property This property includes a string of attribute names to sort on with optional relative matching rules. ## Syntax ```text def get_sort_attributes() -> str: ... def set_sort_attributes(value: str) -> None: ... sort_attributes = property(get_sort_attributes, set_sort_attributes) ``` ## 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), 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 | # ssl_accept_server_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_accept_server_cert_effective_date() -> str: ... ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None) ``` ## 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. # ssl_accept_server_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ... ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded) ``` ## 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) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) properties also may be used to specify a certificate. When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is set to an empty string. # ssl_accept_server_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_accept_server_cert_expiration_date() -> str: ... ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None) ``` ## 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. # ssl_accept_server_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_accept_server_cert_extended_key_usage() -> str: ... ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None) ``` ## 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. # ssl_accept_server_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint() -> str: ... ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None) ``` ## 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. # ssl_accept_server_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ... ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None) ``` ## 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. # ssl_accept_server_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ... ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None) ``` ## 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. # ssl_accept_server_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_issuer() -> str: ... ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None) ``` ## 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. # ssl_accept_server_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_accept_server_cert_private_key() -> str: ... ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None) ``` ## 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) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) returns an empty string. This property is read-only. # ssl_accept_server_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_accept_server_cert_private_key_available() -> bool: ... ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_accept_server_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_accept_server_cert_private_key_container() -> str: ... ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_accept_server_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_public_key() -> str: ... ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # ssl_accept_server_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_accept_server_cert_public_key_algorithm() -> str: ... ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None) ``` ## 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. # ssl_accept_server_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_accept_server_cert_public_key_length() -> int: ... ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None) ``` ## 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. # ssl_accept_server_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_accept_server_cert_serial_number() -> str: ... ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None) ``` ## 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. # ssl_accept_server_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_accept_server_cert_signature_algorithm() -> str: ... ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None) ``` ## 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. # ssl_accept_server_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_accept_server_cert_store() -> bytes: ... def set_ssl_accept_server_cert_store(value: bytes) -> None: ... ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store) ``` ## 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) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property). [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) 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). # ssl_accept_server_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_ssl_accept_server_cert_store_password() -> str: ... def set_ssl_accept_server_cert_store_password(value: str) -> None: ... ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password) ``` ## 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. # ssl_accept_server_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_accept_server_cert_store_type() -> int: ... def set_ssl_accept_server_cert_store_type(value: int) -> None: ... ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type) ``` ## 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 class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class 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), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class 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) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property) 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. | # ssl_accept_server_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_accept_server_cert_subject() -> str: ... def set_ssl_accept_server_cert_subject(value: str) -> None: ... ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject) ``` ## 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. # ssl_accept_server_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_accept_server_cert_subject_alt_names() -> str: ... ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_accept_server_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_md5() -> str: ... ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None) ``` ## 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. # ssl_accept_server_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ... ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None) ``` ## 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. # ssl_accept_server_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ... ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None) ``` ## 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. # ssl_accept_server_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_accept_server_cert_usage() -> str: ... ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property). 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. # ssl_accept_server_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_accept_server_cert_usage_flags() -> int: ... ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None) ``` ## 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) 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) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_accept_server_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_accept_server_cert_version() -> str: ... ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # ssl_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_cert_effective_date() -> str: ... ssl_cert_effective_date = property(get_ssl_cert_effective_date, None) ``` ## 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. # ssl_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ... ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded) ``` ## 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) and [ssl_cert_subject](#ssl_cert_subject-property) properties also may be used to specify a certificate. When [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property) is set to an empty string. # ssl_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_cert_expiration_date() -> str: ... ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None) ``` ## 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. # ssl_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_cert_extended_key_usage() -> str: ... ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None) ``` ## 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. # ssl_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint() -> str: ... ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None) ``` ## 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. # ssl_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint_sha1() -> str: ... ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None) ``` ## 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. # ssl_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint_sha256() -> str: ... ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None) ``` ## 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. # ssl_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_cert_issuer() -> str: ... ssl_cert_issuer = property(get_ssl_cert_issuer, None) ``` ## 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. # ssl_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_cert_private_key() -> str: ... ssl_cert_private_key = property(get_ssl_cert_private_key, None) ``` ## 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) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property) returns an empty string. This property is read-only. # ssl_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_cert_private_key_available() -> bool: ... ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_cert_private_key](#ssl_cert_private_key-property) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_cert_private_key_container() -> str: ... ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_cert_private_key](#ssl_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_cert_public_key() -> str: ... ssl_cert_public_key = property(get_ssl_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # ssl_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_cert_public_key_algorithm() -> str: ... ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None) ``` ## 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. # ssl_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_cert_public_key_length() -> int: ... ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None) ``` ## 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. # ssl_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_cert_serial_number() -> str: ... ssl_cert_serial_number = property(get_ssl_cert_serial_number, None) ``` ## 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. # ssl_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_cert_signature_algorithm() -> str: ... ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None) ``` ## 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. # ssl_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ... ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_cert_store_type](#ssl_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property). [ssl_cert_store](#ssl_cert_store-property) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property) has a value, and [ssl_cert_subject](#ssl_cert_subject-property) or [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property) 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). # ssl_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ... ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password) ``` ## 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. # ssl_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ... ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type) ``` ## 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 class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class 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), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class 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) and set [ssl_cert_store_password](#ssl_cert_store_password-property) 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. | # ssl_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ... ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject) ``` ## 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. # ssl_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_cert_subject_alt_names() -> str: ... ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_md5() -> str: ... ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None) ``` ## 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. # ssl_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_sha1() -> str: ... ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None) ``` ## 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. # ssl_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_sha256() -> str: ... ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None) ``` ## 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. # ssl_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_cert_usage() -> str: ... ssl_cert_usage = property(get_ssl_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property). 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. # ssl_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_cert_usage_flags() -> int: ... ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None) ``` ## 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) 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) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_cert_version() -> str: ... ssl_cert_version = property(get_ssl_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # ssl_enabled property This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. ## Syntax ```text def get_ssl_enabled() -> bool: ... def set_ssl_enabled(value: bool) -> None: ... ssl_enabled = property(get_ssl_enabled, set_ssl_enabled) ``` ## Default Value FALSE ## Remarks This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled. TLS/SSL may also be enabled by setting [ssl_start_mode](#ssl_start_mode-property). Setting [ssl_start_mode](#ssl_start_mode-property) will automatically update this property value. # ssl_provider property The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text def get_ssl_provider() -> int: ... def set_ssl_provider(value: int) -> None: ... ssl_provider = property(get_ssl_provider, set_ssl_provider) ``` ## 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 class 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 class will select a provider depending on the current platform. When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # ssl_server_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_server_cert_effective_date() -> str: ... ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None) ``` ## 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. # ssl_server_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_server_cert_encoded() -> bytes: ... ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None) ``` ## 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) and [ssl_server_cert_subject](#ssl_server_cert_subject-property) properties also may be used to specify a certificate. When [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) is set, a search is initiated in the current [ssl_server_cert_store](#ssl_server_cert_store-property) for the private key of the certificate. If the key is found, [ssl_server_cert_subject](#ssl_server_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_server_cert_subject](#ssl_server_cert_subject-property) is set to an empty string. This property is read-only. # ssl_server_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_server_cert_expiration_date() -> str: ... ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None) ``` ## 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. # ssl_server_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_server_cert_extended_key_usage() -> str: ... ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None) ``` ## 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. # ssl_server_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint() -> str: ... ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None) ``` ## 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. # ssl_server_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint_sha1() -> str: ... ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None) ``` ## 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. # ssl_server_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint_sha256() -> str: ... ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None) ``` ## 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. # ssl_server_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_server_cert_issuer() -> str: ... ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None) ``` ## 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. # ssl_server_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_server_cert_private_key() -> str: ... ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None) ``` ## 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) may be available but not exportable. In this case, [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) returns an empty string. This property is read-only. # ssl_server_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_server_cert_private_key_available() -> bool: ... ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) is available for the selected certificate. If [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_server_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_server_cert_private_key_container() -> str: ... ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_server_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_server_cert_public_key() -> str: ... ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # ssl_server_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_server_cert_public_key_algorithm() -> str: ... ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None) ``` ## 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. # ssl_server_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_server_cert_public_key_length() -> int: ... ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None) ``` ## 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. # ssl_server_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_server_cert_serial_number() -> str: ... ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None) ``` ## 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. # ssl_server_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_server_cert_signature_algorithm() -> str: ... ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None) ``` ## 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. # ssl_server_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_server_cert_store() -> bytes: ... ssl_server_cert_store = property(get_ssl_server_cert_store, None) ``` ## 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) property denotes the type of the certificate store specified by [ssl_server_cert_store](#ssl_server_cert_store-property). If the store is password-protected, specify the password in [ssl_server_cert_store_password](#ssl_server_cert_store_password-property). [ssl_server_cert_store](#ssl_server_cert_store-property) is used in conjunction with the [ssl_server_cert_subject](#ssl_server_cert_subject-property) property to specify client certificates. If [ssl_server_cert_store](#ssl_server_cert_store-property) has a value, and [ssl_server_cert_subject](#ssl_server_cert_subject-property) or [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_server_cert_subject](#ssl_server_cert_subject-property) 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. # ssl_server_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_ssl_server_cert_store_password() -> str: ... ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None) ``` ## 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. # ssl_server_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_server_cert_store_type() -> int: ... ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None) ``` ## 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 class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class 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), the full path of the PKCS#11 DLL as the [ssl_server_cert_store](#ssl_server_cert_store-property), and the PIN as the [ssl_server_cert_store_password](#ssl_server_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class 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) and set [ssl_server_cert_store_password](#ssl_server_cert_store_password-property) 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. # ssl_server_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_server_cert_subject() -> str: ... ssl_server_cert_subject = property(get_ssl_server_cert_subject, None) ``` ## 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. # ssl_server_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_server_cert_subject_alt_names() -> str: ... ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_server_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_md5() -> str: ... ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None) ``` ## 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. # ssl_server_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_sha1() -> str: ... ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None) ``` ## 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. # ssl_server_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_sha256() -> str: ... ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None) ``` ## 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. # ssl_server_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_server_cert_usage() -> str: ... ssl_server_cert_usage = property(get_ssl_server_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property). 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. # ssl_server_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_server_cert_usage_flags() -> int: ... ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None) ``` ## 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) 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) property for a text representation of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_server_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_server_cert_version() -> str: ... ssl_server_cert_version = property(get_ssl_server_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # ssl_start_mode property This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. ## Syntax ```text def get_ssl_start_mode() -> int: ... def set_ssl_start_mode(value: int) -> None: ... ssl_start_mode = property(get_ssl_start_mode, set_ssl_start_mode) ``` ## Possible Values ```text 0 # Automatic1 # Implicit2 # Explicit3 # None ``` ## Default Value 3 ## 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 class 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 class will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. | | 3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. | # timeout property This property includes the timeout for the class. ## Syntax ```text def get_timeout() -> int: ... def set_timeout(value: int) -> None: ... timeout = property(get_timeout, set_timeout) ``` ## 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 class will wait for the operation to complete before returning control. The class will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of timeout seconds. The class will use [do_events](#do_events-method) 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 class 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. # abandon method This method asks the server to abandon a request. ## Syntax ```text def abandon(message_id: int) -> None: ... ``` ## 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) event. # add method This method adds an entry specified by DN to the directory server using the type and value attributes defined in the Attributes properties. ## Syntax ```text def add() -> None: ... ``` ## Remarks This method adds the entry specified by [dn](#dn-property) to the directory. All entries are required to have an objectClass attribute. To add a new entry, first [bind](#bind-method) with credentials that will allow you to perform the new addition. To add attributes instead of entries, use the [modify](#modify-method) 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) 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 This method returns the value of the specified Lightweight Directory Access Protocol (LDAP) attribute. ## Syntax ```text def attr(attr_type: str) -> str: ... ``` ## 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 This method connects and binds to the directory server. ## Syntax ```text def bind() -> None: ... ``` ## Remarks This method connects and binds to the directory server. If the [password](#password-property) 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) 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 This method changes the password for the specified user. ## Syntax ```text def change_password(user: str, old_password: str, new_password: str) -> None: ... ``` ## 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) 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 This method compares attributes and values with those of the entry specified by DN . ## Syntax ```text def compare() -> None: ... ``` ## 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). The result of the operation is returned through the [on_result](#on_result-event) event. # config method Sets or retrieves a configuration setting. ## Syntax ```text def config(configuration_string: str) -> str: ... ``` ## Remarks config is a generic method available in every class. It is used to set and retrieve [configuration settings](#ldap-config-settings) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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](#ldap-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # connect method This method connects to the directory server without performing any action. ## Syntax ```text def connect() -> None: ... ``` ## Remarks This method establishes a connection with the directory server specified by [server_name](#server_name-property). In most cases, it is recommended to use the [bind](#bind-method) 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 Deletes an entry specified by DN from the directory server. ## Syntax ```text def delete() -> None: ... ``` ## Remarks This method deletes the entry specified by [dn](#dn-property) from the directory. The result of the operation is returned through the [on_result](#on_result-event) event. # do_events method This method processes events from the internal message queue. ## Syntax ```text def do_events() -> None: ... ``` ## Remarks When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns. # extended_request method This method performs a Lightweight Directory Access Protocol (LDAP) V3 extended operation. ## Syntax ```text def extended_request(request_name: str, request_value: bytes) -> None: ... ``` ## 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 This method interrupts the current method. ## Syntax ```text def interrupt() -> None: ... ``` ## Remarks If there is no method in progress, interrupt simply returns, doing nothing. # list_computers method This method lists all computers in the directory. ## Syntax ```text def list_computers() -> None: ... ``` ## Remarks This method lists all computers in the directory. The [on_computer_list](#on_computer_list-event) event will be fired once for each computer returned. # list_group_members method This method lists all members of a group. ## Syntax ```text def list_group_members(group: str) -> None: ... ``` ## Remarks This method lists all members of the specified *group*. The [on_user_list](#on_user_list-event) event will be fired once for each member returned. # list_groups method This method list all groups in the directory. ## Syntax ```text def list_groups() -> None: ... ``` ## Remarks This method lists all groups in the directory. The [on_group_list](#on_group_list-event) event will be fired once for each group returned. # list_user_groups method This method lists all groups a user is a part of. ## Syntax ```text def list_user_groups(user: str) -> None: ... ``` ## Remarks This method lists all groups that the user specified by *user* is a part of. The [on_group_list](#on_group_list-event) event will fire once for each group the user is a part of. # modify method This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN . ## Syntax ```text def modify() -> None: ... ``` ## Remarks This method performs an LDAP *modify* operation on the entry specified by [dn](#dn-property). 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) 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 This method performs a Lightweight Directory Access Protocol (LDAP) modify RDN operation on an entry specified by DN . ## Syntax ```text def modify_rdn(new_rdn: str) -> None: ... ``` ## Remarks This method performs an LDAP *modify RDN* operation on the entry specified by [dn](#dn-property). *new_rdn* is the new RDN for the entry specified by [dn](#dn-property) The result of the operation is returned through the [on_result](#on_result-event) event. # move_to_dn method This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN by changing its superior. ## Syntax ```text def move_to_dn(new_superior: str) -> None: ... ``` ## Remarks This method performs an LDAP *modify* operation on the entry specified by [dn](#dn-property) by changing its superior. NOTE: None of the entry's attributes will change. [delete_old_rdn](#delete_old_rdn-property) 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) event. # pause_data method This method pauses data reception. ## Syntax ```text def pause_data() -> None: ... ``` ## 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) to re-enable data reception. # process_data method This method re-enables data reception after a call to PauseData . ## Syntax ```text def process_data() -> None: ... ``` ## Remarks This method re-enables data reception after a previous call to [pause_data](#pause_data-method). 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). It does not need to be called to process data by default. # reset method This method will reset the class. ## Syntax ```text def reset() -> None: ... ``` ## Remarks This method will reset the class's properties to their default values. # search method This method searches the directory server using the base object specified in DN and the search filter SearchFilter . ## Syntax ```text def search(search_filter: str) -> None: ... ``` ## Remarks This method searches the directory server using the base object specified in the [dn](#dn-property) and the search filter specified in the *search_filter* parameter. Additional search parameters are specified through the [search_scope](#search_scope-property), [search_deref_aliases](#search_deref_aliases-property), [search_size_limit](#search_size_limit-property), [search_time_limit](#search_time_limit-property), and [search_return_values](#search_return_values-property) 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) events, after which a [on_search_complete](#on_search_complete-event) 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 ::= "(" ")" ::= | | | ::= "&" ::= "|" ::= "!" ::= | ::= | | ::= ::= | | | ::= "=" ::= "~=" ::= ">=" ::= "<=" ::= "=*" ::= "=" ::= NULL | ::= "*" ::= NULL | "*" ::= NULL | ``` is a string representing an attribute type as defined in RFC 1777. is a string representing an attribute value, or part of one, and has the form defined in RFC 1779. If a must contain one of the characters '*' or '(' or ')', these should be escaped by preceding them with the backslash '\' character. # unbind method This method unbinds from the directory server. ## Syntax ```text def unbind() -> None: ... ``` ## Remarks This method unbinds from the directory server and breaks the connection. # on_computer_list event This event is fired for each computer entry returned. ## Syntax ```text class LDAPComputerListEventParams(object): @property def name() -> str: ... @property def operating_system() -> str: ... @property def last_logon() -> str: ... @property def logon_count() -> int: ... @property def dn() -> str: ... # In class LDAP: @property def on_computer_list() -> Callable[[LDAPComputerListEventParams], None]: ... @on_computer_list.setter def on_computer_list(event_hook: Callable[[LDAPComputerListEventParams], None]) -> None: ... ``` ## Remarks This event is fired once for each computer returned when the [list_computers](#list_computers-method) method is called. # on_connected event Fired immediately after a connection completes (or fails). ## Syntax ```text class LDAPConnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class LDAP: @property def on_connected() -> Callable[[LDAPConnectedEventParams], None]: ... @on_connected.setter def on_connected(event_hook: Callable[[LDAPConnectedEventParams], None]) -> None: ... ``` ## 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](#ldap-errors) section for more information. # on_connection_status event Fired to indicate changes in the connection state. ## Syntax ```text class LDAPConnectionStatusEventParams(object): @property def connection_event() -> str: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class LDAP: @property def on_connection_status() -> Callable[[LDAPConnectionStatusEventParams], None]: ... @on_connection_status.setter def on_connection_status(event_hook: Callable[[LDAPConnectionStatusEventParams], None]) -> None: ... ``` ## 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 Fired when a connection is closed. ## Syntax ```text class LDAPDisconnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class LDAP: @property def on_disconnected() -> Callable[[LDAPDisconnectedEventParams], None]: ... @on_disconnected.setter def on_disconnected(event_hook: Callable[[LDAPDisconnectedEventParams], None]) -> None: ... ``` ## 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](#ldap-errors) section for more information. # on_error event Fired when information is available about errors during data delivery. ## Syntax ```text class LDAPErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class LDAP: @property def on_error() -> Callable[[LDAPErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[LDAPErrorEventParams], None]) -> None: ... ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally the class 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](#ldap-errors) section. # on_extended_response event This event is fired for Lightweight Directory Access Protocol (LDAP) V3 extended responses. ## Syntax ```text class LDAPExtendedResponseEventParams(object): @property def message_id() -> int: ... @property def dn() -> str: ... @property def result_code() -> int: ... @property def result_description() -> str: ... @property def response_name() -> str: ... @property def response_value() -> bytes: ... # In class LDAP: @property def on_extended_response() -> Callable[[LDAPExtendedResponseEventParams], None]: ... @on_extended_response.setter def on_extended_response(event_hook: Callable[[LDAPExtendedResponseEventParams], None]) -> None: ... ``` ## Remarks The first four parameters are the same as the parameters of the [on_result](#on_result-event) event. *response_name* and *response_value* are related to the corresponding parameters of the call to [extended_request](#extended_request-method). # on_group_list event This event is fired for each group entry returned. ## Syntax ```text class LDAPGroupListEventParams(object): @property def name() -> str: ... @property def description() -> str: ... @property def dn() -> str: ... # In class LDAP: @property def on_group_list() -> Callable[[LDAPGroupListEventParams], None]: ... @on_group_list.setter def on_group_list(event_hook: Callable[[LDAPGroupListEventParams], None]) -> None: ... ``` ## Remarks This event is fired once for each group entry returned when either of the [list_groups](#list_groups-method) or [list_user_groups](#list_user_groups-method) methods are called. # on_pi_trail event This event provides detailed information about the interaction with the server. ## Syntax ```text class LDAPPITrailEventParams(object): @property def direction() -> int: ... @property def description() -> str: ... @property def message() -> str: ... # In class LDAP: @property def on_pi_trail() -> Callable[[LDAPPITrailEventParams], None]: ... @on_pi_trail.setter def on_pi_trail(event_hook: Callable[[LDAPPITrailEventParams], None]) -> None: ... ``` ## 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 This event is fired for every server response, except for search responses. ## Syntax ```text class LDAPResultEventParams(object): @property def message_id() -> int: ... @property def dn() -> str: ... @property def result_code() -> int: ... @property def result_description() -> str: ... # In class LDAP: @property def on_result() -> Callable[[LDAPResultEventParams], None]: ... @on_result.setter def on_result(event_hook: Callable[[LDAPResultEventParams], None]) -> None: ... ``` ## 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) property. # on_search_complete event This event is fired upon completion of a search operation. ## Syntax ```text class LDAPSearchCompleteEventParams(object): @property def message_id() -> int: ... @property def dn() -> str: ... @property def result_code() -> int: ... @property def result_description() -> str: ... # In class LDAP: @property def on_search_complete() -> Callable[[LDAPSearchCompleteEventParams], None]: ... @on_search_complete.setter def on_search_complete(event_hook: Callable[[LDAPSearchCompleteEventParams], None]) -> None: ... ``` ## 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 This event is fired for every page returned from a search operation. ## Syntax ```text class LDAPSearchPageEventParams(object): @property def message_id() -> int: ... @property def dn() -> str: ... @property def result_code() -> int: ... @property def result_description() -> str: ... @property def cancel_search() -> bool: ... @cancel_search.setter def cancel_search(value) -> None: ... # In class LDAP: @property def on_search_page() -> Callable[[LDAPSearchPageEventParams], None]: ... @on_search_page.setter def on_search_page(event_hook: Callable[[LDAPSearchPageEventParams], None]) -> None: ... ``` ## Remarks This event is fired so the client can decide whether or not to continue with the [search](#search-method) operation. The signature is very similar to the [on_search_complete](#on_search_complete-event) 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 This event is fired for every entry returned from a search operation. ## Syntax ```text class LDAPSearchResultEventParams(object): @property def message_id() -> int: ... @property def dn() -> str: ... # In class LDAP: @property def on_search_result() -> Callable[[LDAPSearchResultEventParams], None]: ... @on_search_result.setter def on_search_result(event_hook: Callable[[LDAPSearchResultEventParams], None]) -> None: ... ``` ## 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) events, which are followed by a [on_search_complete](#on_search_complete-event) event. # on_search_result_reference event This event is fired for every result reference returned from a search operation. ## Syntax ```text class LDAPSearchResultReferenceEventParams(object): @property def message_id() -> int: ... @property def ldap_url() -> str: ... # In class LDAP: @property def on_search_result_reference() -> Callable[[LDAPSearchResultReferenceEventParams], None]: ... @on_search_result_reference.setter def on_search_result_reference(event_hook: Callable[[LDAPSearchResultReferenceEventParams], None]) -> None: ... ``` ## 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) 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) event. # on_ssl_server_authentication event Fired after the server presents its certificate to the client. ## Syntax ```text class LDAPSSLServerAuthenticationEventParams(object): @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class LDAP: @property def on_ssl_server_authentication() -> Callable[[LDAPSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[LDAPSSLServerAuthenticationEventParams], None]) -> None: ... ``` ## 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 Fired when secure connection progress messages are available. ## Syntax ```text class LDAPSSLStatusEventParams(object): @property def message() -> str: ... # In class LDAP: @property def on_ssl_status() -> Callable[[LDAPSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[LDAPSSLStatusEventParams], None]) -> None: ... ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # on_user_list event This event is fired once for each user entry returned. ## Syntax ```text class LDAPUserListEventParams(object): @property def name() -> str: ... @property def description() -> str: ... @property def last_logon() -> str: ... @property def member_of() -> str: ... @property def dn() -> str: ... # In class LDAP: @property def on_user_list() -> Callable[[LDAPUserListEventParams], None]: ... @on_user_list.setter def on_user_list(event_hook: Callable[[LDAPUserListEventParams], None]) -> None: ... ``` ## Remarks This event is fired once for each user entry returned when the [list_group_members](#list_group_members-method) method is called. # LDAP Config Settings The class 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 class, access to these *internal properties* is provided through the [config](#config-method) 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) will return only the next result when queried. If no more results are found, querying [result_dn](#result_dn-property) 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 "
"
	Do
		Result = LDAP1.ResultDN
		if (Result <> "") then
			Response.Write Result + "
"
			'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) + "
"
			Next
		End If
	Loop While Result <> ""
	Response.Write "
" ``` **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) does not need to be set before calling [bind](#bind-method) in Active Directory domains. When True, the class 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 class will use [timeout](#timeout-property) 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 class 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 class 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) operation as a whole. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes 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 classes 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 class fails with an error. NOTE: This setting is provided for use by classes 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 classes 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 classes 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 class fails with an error. NOTE: This setting is provided for use by classes 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 class 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) 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 class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [local_host](#local_host-property) 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 class binds. This configuration setting must be set before a connection is attempted. It instructs the class 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 class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class 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. ### 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) 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 class 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 class 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 class 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*. **ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. **SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [do_events](#do_events-method) is called, the class will wait for the amount of time specified here before returning. The default value is 20. **UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *True*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *True*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the class 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. # LDAP Errors ### 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. ### TCPClient 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) 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 class 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. | ### 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). |