LDAP Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class ipworksssl.LDAP

Remarks

The LDAP Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over SSL/TLS the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL related settings are also supported via the config 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, a dn (distinguished name) to bind as, and optionally a password. 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 event. The only exceptions are search requests that result in one or more on_search_result events, followed by a final on_search_complete 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 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_time_limit, search_size_limit, search_return_values, and search_deref_aliases.

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 to 0. Please refer to the timeout 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.

Method List

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

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.

Config Settings

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

accept_data Property

This property enables or disables data reception from the server.

Syntax

def get_accept_data() -> bool: ...
def set_accept_data(value: bool) -> None: ...

accept_data = property(get_accept_data, set_accept_data)

Default Value

TRUE

Remarks

This property enables or disables data reception from the server. Setting the property to False, temporarily disables data reception. Setting the property to True, reenables data reception.

Note: It is recommended to use the pause_data or process_data method instead of setting this property.

attr_count Property

The number of records in the Attr arrays.

Syntax

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_type
• attr_value

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

attr_type Property

This property contains the attribute type for the current entry.

Syntax

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 is an empty string, then the attr_value 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.

The attr_index parameter specifies the index of the item in the array. The size of the array is controlled by the attr_count property.

attr_mod_op Property

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

Syntax

def get_attr_mod_op(attr_index: int) -> int: ...
def set_attr_mod_op(attr_index: int, value: int) -> None: ...

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:

The attr_index parameter specifies the index of the item in the array. The size of the array is controlled by the attr_count property.

attr_value Property

This property contains the attribute value for the current entry.

Syntax

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

The attr_index parameter specifies the index of the item in the array. The size of the array is controlled by the attr_count property.

auth_mechanism Property

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

Syntax

def get_auth_mechanism() -> int: ...
def set_auth_mechanism(value: int) -> None: ...

auth_mechanism = property(get_auth_mechanism, set_auth_mechanism)

Default Value

0

Remarks

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

connected Property

This shows whether the class is connected.

Syntax

def get_connected() -> bool: ...
def set_connected(value: bool) -> None: ...

connected = property(get_connected, set_connected)

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the connect or disconnect method instead of setting this property.

delete_old_rdn Property

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

Syntax

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

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:

LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server" LDAPControl.DN = "Domain\Username"

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

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

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host 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

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

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

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

idle will be False if the component is currently busy (communicating and/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

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

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host 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 multi-homed 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 classs) only through that interface.

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 multi-homed 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

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

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

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

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

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

def get_reference_url(reference_index: int) -> str: ...

Default Value

""

Remarks

The url of the LDAP reference. If inside a on_search_result or on_search_result_reference event, it represents a URL to contact to continue the search. If inside the on_result event or on_search_complete 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 property.

This property is read-only.

result_code Property

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

Syntax

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_search_result, or on_search_complete event.

Possible result codes are as follows:

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

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_search_result, or on_search_complete event.

This property is read-only.

result_dn Property

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

Syntax

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 or on_search_complete event.

This property is read-only.

search_deref_aliases Property

This property controls alias dereferencing during searching.

Syntax

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)

Default Value

0

Remarks

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

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

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

def get_search_scope() -> int: ...
def set_search_scope(value: int) -> None: ...

search_scope = property(get_search_scope, set_search_scope)

Default Value

2

Remarks

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

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

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

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

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

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

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, 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:

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:

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

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

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

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

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

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

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

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

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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

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

This is the type of certificate store for this certificate.

Syntax

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)

Default Value

0

Remarks

This is 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:

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

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

This is 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=support@nsoftware.com". Common fields and their meanings are as follows:

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

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:

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 the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

ssl_start_mode Property

Determines how the class starts the SSL negotiation.

Syntax

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)

Default Value

0

Remarks

The ssl_start_mode property may have one of the following values:

timeout Property

A timeout for the class.

Syntax

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

Please note that by default, all timeouts are inactivity timeouts, i.e. 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

def abandon(message_id: int) -> None: ...

Remarks

This method asks the server to abandon the request specified by MessageId. The result of the operation is returned through the on_result 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

def add() -> None: ...

Remarks

This method adds the entry specified by dn to the directory. All entries are required to have an objectClass attribute.

To add a new entry, first bind with credentials that will allow you to perform the new addition. To add attributes instead of entries, use the modify 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 event.

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

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

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

def bind() -> None: ...

Remarks

This method connects and binds to the directory server. If the password 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 event.

Example. Binding:

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

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. OldPassword specifies the current password and NewPassword specifies the new password.

Note: This operation can be performed only over the Secure Sockets Layer (SSL) port. Set server_port 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

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. The result of the operation is returned through the on_result event.

config Method

Sets or retrieves a configuration setting.

Syntax

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 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, you must call Config("PROPERTY"). The value will be returned as a string.

connect Method

This method connects to the remote host without performing any action.

Syntax

def connect() -> None: ...

Remarks

This method establishes a connection with the remote host specified by url, but it does not send a request. In most cases, it is recommended to use the appropriate method, such as get or post, which will both establish a connection and send a request.

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

def delete() -> None: ...

Remarks

This method deletes the entry specified by dn from the directory. The result of the operation is returned through the on_result event.

do_events Method

Processes events from the internal message queue.

Syntax

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

def extended_request(request_name: str, request_value: bytes) -> None: ...

Remarks

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

interrupt Method

Interrupt the current method.

Syntax

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

def list_computers() -> None: ...

Remarks

This method lists all computers in the directory. The on_computer_list event will be fired once for each computer returned.

list_group_members Method

This method lists all members of a group.

Syntax

def list_group_members(group: str) -> None: ...

Remarks

This method lists all members of the specified group. The on_user_list event will be fired once for each member returned.

list_groups Method

This method list all groups in the directory.

Syntax

def list_groups() -> None: ...

Remarks

This method lists all groups in the directory. The on_group_list 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

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

def modify() -> None: ...

Remarks

This method performs an LDAP modify operation on the entry specified by dn. 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 event.

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

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

def modify_rdn(new_rdn: str) -> None: ...

Remarks

This method performs an LDAP modify RDN operation on the entry specified by dn.

NewRDN is the new RDN for the entry specified by dn

The result of the operation is returned through the on_result 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

def move_to_dn(new_superior: str) -> None: ...

Remarks

This method performs an LDAP modify operation on the entry specified by dn by changing its superior.

Note: None of the entry's attributes will change. delete_old_rdn property will be set to True to delete the old entry. The result of the operation is returned through the on_result event.

pause_data Method

This method pauses data reception.

Syntax

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 to reenable data reception.

process_data Method

This method reenables data reception after a call to PauseData .

Syntax

def process_data() -> None: ...

Remarks

This method reenables data reception after a previous call to pause_data. Call this method to reenable data reception and allow on_ip_packet to fire.

Note: This method is used only after previously calling pause_data. It does not need to be called to process data by default.

reset Method

Reset the class.

Syntax

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

def search(search_filter: str) -> None: ...

Remarks

This method searches the directory server using the base object specified in the dn and the search filter specified in the SearchFilter parameter. Additional search parameters are specified through the search_scope, search_deref_aliases, search_size_limit, search_time_limit, and search_return_values 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 events, after which a on_search_complete event is fired.

Example 1. Searching for a User:

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:

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

SearchFilter 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:

     (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:

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

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

unbind Method

This method unbinds from the directory server.

Syntax

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

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 method is called.

on_connected Event

This event is fired immediately after a connection completes (or fails).

Syntax

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, StatusCode is 0 and Description is "OK".

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

Please refer to the Error Codes section for more information.

on_connection_status Event

This event is fired to indicate changes in the connection state.

Syntax

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

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

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

on_disconnected Event

This event is fired when a connection is closed.

Syntax

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, StatusCode is 0 and Description is "OK".

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

Please refer to the Error Codes section for more information.

on_error Event

Information about errors during data delivery.

Syntax

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 ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_extended_response Event

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

Syntax

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 event. ResponseName and ResponseValue are related to the corresponding parameters of the call to extended_request.

on_group_list Event

This event is fired for each group entry returned.

Syntax

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 or list_user_groups methods are called.

on_pi_trail Event

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

Syntax

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

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 MessageId parameter identifies the corresponding request. ResultCode and ResultDescription show whether or not the operation was successful (on a successful operation, the ResultCode is 0). For a full list of possible result codes, see the result_code property.

on_search_complete Event

This event is fired upon completion of a search operation.

Syntax

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 MessageId parameter identifies the corresponding request. ResultCode and ResultDescription show whether the operation was successful (on a successful operation, the ResultCode is 0).

on_search_page Event

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

Syntax

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 operation. The signature is very similar to the on_search_complete event, with the addition of a CancelSearch parameter. If the search should be canceled (no more pages), the CancelSearch parameter should be set to True.

on_search_result Event

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

Syntax

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

MessageId 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 events, which are followed by a on_search_complete event.

on_search_result_reference Event

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

Syntax

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

MessageId identifies the corresponding search request. LdapUrl 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 events and a sequence of 0 or more on_search_result_reference events, which are followed by a on_search_complete event.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

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

Shows the progress of the secure connection.

Syntax

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

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 method is called.

LDAP Config Settings

LDAP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

LDAP Errors

LDAP Errors

The class may also return one of the following error codes, which are inherited from other classes.

SSLClient Errors

SSL Errors

TCP/IP Errors