Struct ipworksauth::LDAP

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworksauth::LDAP

Remarks

The LDAP Struct supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the on_ssl_server_authentication 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 through the config method.

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

The first step in using the struct is specifying the server_name, a dn (distinguished name) to bind as, and optionally a password. Then you can call one or more of the struct methods to act upon the server. Server responses normally are received through the on_result 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 struct operates synchronously by default (waits for a response before returning control to the caller); however, the struct also may operate asynchronously (return control immediately), by setting timeout to 0. Please refer to the timeout property for more information.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksAuth. Due to this, the LDAP struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of LDAP when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

accept_data property (LDAP Struct)

This property indicates whether data reception is currently enabled.

Syntax

fn accept_data(&self ) -> Result<bool, IPWorksAuthError> 

Default Value

true

Remarks

This property indicates whether data reception is currently enabled. When false, data reception is disabled. Use the pause_data and process_data methods to pause and resume data reception.

This property is read-only.

Data Type

bool

attr_count property (LDAP Struct)

The number of records in the Attr arrays.

Syntax

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

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.

Data Type

i32

attr_type property (LDAP Struct)

This property contains the attribute type for the current entry.

Syntax

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

Default Value

""

Remarks

This property contains the attribute type for the current entry.

If the value of attr_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 attr_attribute_type.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

Data Type

String

attr_mod_op property (LDAP Struct)

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

Syntax

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

Possible Values

0   // Add
1   // Delete
2   // 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:

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

Data Type

i32

attr_value property (LDAP Struct)

This property contains the attribute value for the current entry.

Syntax

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

Default Value

""

Remarks

This property contains the attribute value for the current entry.

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

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

Data Type

Vec

auth_mechanism property (LDAP Struct)

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

Syntax

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

Possible Values

0   // Simple
1   // DigestMD5
2   // Negotiate
6   // Kerberos
7   // SASLExternal

Default Value

0

Remarks

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

Data Type

i32

connected property (LDAP Struct)

This property shows whether the struct is connected.

Syntax

fn connected(&self ) -> Result<bool, IPWorksAuthError> 

Default Value

false

Remarks

This property is used to determine whether or not the struct is connected to the remote host. Use the bind and unbind methods to manage the connection.

This property is read-only.

Data Type

bool

delete_old_rdn property (LDAP Struct)

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

Syntax

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

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.

Data Type

bool

dn property (LDAP Struct)

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

Syntax

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

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"

Data Type

String

firewall_auto_detect property (LDAP Struct)

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

Syntax

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

Default Value

false

Remarks

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

Data Type

bool

firewall_type property (LDAP Struct)

The type of firewall to connect through.

Syntax

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

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

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

Data Type

i32

firewall_host property (LDAP Struct)

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

Syntax

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

Default Value

""

Remarks

The name or IP address of the 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 struct fails with an error.

Data Type

String

firewall_password property (LDAP Struct)

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

Syntax

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

Default Value

""

Remarks

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 struct fails with an error.

Data Type

String

firewall_port property (LDAP Struct)

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

Syntax

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

Default Value

0

Remarks

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_firewall_type is set to a valid value. See the description of the firewall_firewall_type property for details.

Data Type

i32

firewall_user property (LDAP Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

idle property (LDAP Struct)

The current status of the struct.

Syntax

fn idle(&self ) -> Result<bool, IPWorksAuthError> 

Default Value

true

Remarks

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

This property is read-only.

Data Type

bool

ldap_version property (LDAP Struct)

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

Syntax

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

Default Value

3

Remarks

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

Data Type

i32

local_host property (LDAP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

message_id property (LDAP Struct)

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

Syntax

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

Default Value

1

Remarks

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

Data Type

i32

page_size property (LDAP Struct)

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

Syntax

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

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.

Data Type

i32

password property (LDAP Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

reference_count property (LDAP Struct)

The number of records in the Reference arrays.

Syntax

fn reference_count(&self ) -> Result<i32, IPWorksAuthError> 

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.

Data Type

i32

reference_url property (LDAP Struct)

The url of the LDAP reference.

Syntax

fn reference_url(&self , ReferenceIndex : i32) -> Result<String, IPWorksAuthError> 

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 ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only.

Data Type

String

result_code property (LDAP Struct)

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

Syntax

fn result_code(&self ) -> Result<i32, IPWorksAuthError> 

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.

Data Type

i32

result_description property (LDAP Struct)

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

Syntax

fn result_description(&self ) -> Result<String, IPWorksAuthError> 

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.

Data Type

String

result_dn property (LDAP Struct)

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

Syntax

fn result_dn(&self ) -> Result<String, IPWorksAuthError> 

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.

Data Type

String

search_deref_aliases property (LDAP Struct)

This property controls alias dereferencing during searching.

Syntax

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

Possible Values

0   // Never
1   // InSearching
2   // FindingBaseObject
3   // Always

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.

Data Type

i32

search_return_values property (LDAP Struct)

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

Syntax

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

Default Value

true

Remarks

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

Data Type

bool

search_scope property (LDAP Struct)

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

Syntax

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

Possible Values

0   // BaseObject
1   // SingleLevel
2   // WholeSubtree

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.

Data Type

i32

search_size_limit property (LDAP Struct)

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

Syntax

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

Default Value

0

Remarks

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

Data Type

i32

search_time_limit property (LDAP Struct)

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

Syntax

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

Default Value

0

Remarks

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

Data Type

i32

server_name property (LDAP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

Data Type

String

server_port property (LDAP Struct)

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

Syntax

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

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.

Data Type

i32

sort_attributes property (LDAP Struct)

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

Syntax

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

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:

Example 2. Matching Rules for Inequality Filters: Example 3. Matching Rules for Substring Filters: Example 4. Matching Rules for Subschema Attributes:

Data Type

String

ssl_accept_server_cert_effective_date property (LDAP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (LDAP Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (LDAP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (LDAP Struct)

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

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (LDAP Struct)

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

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (LDAP Struct)

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

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (LDAP Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (LDAP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, IPWorksAuthError> 

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 may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (LDAP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, IPWorksAuthError> 

Default Value

false

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (LDAP Struct)

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

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (LDAP Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (LDAP Struct)

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

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (LDAP Struct)

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

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, IPWorksAuthError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (LDAP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (LDAP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (LDAP Struct)

The name of the certificate store for the client certificate.

Syntax

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

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_accept_server_cert_store_password property (LDAP Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

ssl_accept_server_cert_store_type property (LDAP Struct)

The type of certificate store for this certificate.

Syntax

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

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (LDAP Struct)

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

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (LDAP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (LDAP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (LDAP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (LDAP Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (LDAP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, IPWorksAuthError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

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

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (LDAP Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (LDAP Struct)

The subject of the certificate used for client authentication.

Syntax

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

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:

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

Data Type

String

ssl_accept_server_cert_encoded property (LDAP Struct)

The certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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.

Data Type

Vec

ssl_cert_effective_date property (LDAP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (LDAP Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (LDAP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (LDAP Struct)

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

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (LDAP Struct)

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

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (LDAP Struct)

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

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_issuer property (LDAP Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_private_key property (LDAP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksAuthError> 

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 may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (LDAP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksAuthError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (LDAP Struct)

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

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (LDAP Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (LDAP Struct)

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

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (LDAP Struct)

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

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksAuthError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (LDAP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (LDAP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_store property (LDAP Struct)

The name of the certificate store for the client certificate.

Syntax

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

Default Value

"MY"

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (LDAP Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

ssl_cert_store_type property (LDAP Struct)

The type of certificate store for this certificate.

Syntax

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

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

ssl_cert_subject_alt_names property (LDAP Struct)

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

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (LDAP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (LDAP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (LDAP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_usage property (LDAP Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (LDAP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksAuthError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

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

This property is read-only.

Data Type

i32

ssl_cert_version property (LDAP Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_subject property (LDAP Struct)

The subject of the certificate used for client authentication.

Syntax

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

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:

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

Data Type

String

ssl_cert_encoded property (LDAP Struct)

The certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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.

Data Type

Vec

ssl_enabled property (LDAP Struct)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

fn ssl_enabled(&self ) -> Result<bool, IPWorksAuthError> 
fn set_ssl_enabled(&self, value : bool) ->  Option<IPWorksAuthError> 

Default Value

false

Remarks

This property specifies whether TLS/SSL is enabled in the struct. When False (default), the struct operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting ssl_start_mode. Setting ssl_start_mode will automatically update this property value.

Data Type

bool

ssl_provider property (LDAP Struct)

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

Syntax

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

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

0

Remarks

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

Possible values are as follows:

Additional Notes

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

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

Data Type

i32

ssl_server_cert_effective_date property (LDAP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (LDAP Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (LDAP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (LDAP Struct)

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

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (LDAP Struct)

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

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (LDAP Struct)

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

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (LDAP Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (LDAP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, IPWorksAuthError> 

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 may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (LDAP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, IPWorksAuthError> 

Default Value

false

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (LDAP Struct)

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

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (LDAP Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (LDAP Struct)

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

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (LDAP Struct)

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

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, IPWorksAuthError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (LDAP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (LDAP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_store property (LDAP Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksAuthError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (LDAP Struct)

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

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (LDAP Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, IPWorksAuthError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (LDAP Struct)

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

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (LDAP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (LDAP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (LDAP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_usage property (LDAP Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (LDAP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, IPWorksAuthError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

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

This property is read-only.

Data Type

i32

ssl_server_cert_version property (LDAP Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, IPWorksAuthError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_subject property (LDAP Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, IPWorksAuthError> 

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:

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

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (LDAP Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksAuthError> 

Default Value

""

Remarks

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.

Data Type

Vec

ssl_start_mode property (LDAP Struct)

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

Syntax

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

Possible Values

0   // Automatic
1   // Implicit
2   // Explicit
3   // None

Default Value

3

Remarks

The ssl_start_mode property may have one of the following values:

Data Type

i32

timeout property (LDAP Struct)

This property includes the timeout for the struct.

Syntax

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

Default Value

60

Remarks

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

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

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

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

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

The default value for the timeout property is 60 seconds.

Data Type

i32

abandon method (LDAP Struct)

This method asks the server to abandon a request.

Syntax

fn abandon(&self, message_id : i32) -> Result<(), IPWorksAuthError>

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

add method (LDAP Struct)

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

Syntax

fn add(&self) -> Result<(), IPWorksAuthError>

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 (LDAP Struct)

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

Syntax

fn attr(&self, attr_type : &str) ->  Result<String, IPWorksAuthError>

Remarks

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

Please refer to the attributes properties for more information.

bind method (LDAP Struct)

This method connects and binds to the directory server.

Syntax

fn bind(&self) -> Result<(), IPWorksAuthError>

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 (LDAP Struct)

This method changes the password for the specified user.

Syntax

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

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 to the SSL port of the server (typically 636) before calling this method.

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

compare method (LDAP Struct)

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

Syntax

fn compare(&self) -> Result<(), IPWorksAuthError>

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 (LDAP Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksAuthError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

connect method (LDAP Struct)

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

Syntax

fn connect(&self) -> Result<(), IPWorksAuthError>

Remarks

This method establishes a connection with the directory server specified by server_name. In most cases, it is recommended to use the bind method, which will both establish a connection and bind to the directory server.

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

delete method (LDAP Struct)

Deletes an entry specified by DN from the directory server.

Syntax

fn delete(&self) -> Result<(), IPWorksAuthError>

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 (LDAP Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksAuthError>

Remarks

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

extended_request method (LDAP Struct)

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

Syntax

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

Remarks

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

interrupt method (LDAP Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), IPWorksAuthError>

Remarks

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

list_computers method (LDAP Struct)

This method lists all computers in the directory.

Syntax

fn list_computers(&self) -> Result<(), IPWorksAuthError>

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 (LDAP Struct)

This method lists all members of a group.

Syntax

fn list_group_members(&self, group : &str) -> Result<(), IPWorksAuthError>

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 (LDAP Struct)

This method list all groups in the directory.

Syntax

fn list_groups(&self) -> Result<(), IPWorksAuthError>

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 (LDAP Struct)

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

Syntax

fn list_user_groups(&self, user : &str) -> Result<(), IPWorksAuthError>

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 (LDAP Struct)

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

Syntax

fn modify(&self) -> Result<(), IPWorksAuthError>

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 (LDAP Struct)

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

Syntax

fn modify_rdn(&self, new_rdn : &str) -> Result<(), IPWorksAuthError>

Remarks

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

new_rdn 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 (LDAP Struct)

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

Syntax

fn move_to_dn(&self, new_superior : &str) -> Result<(), IPWorksAuthError>

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 (LDAP Struct)

This method pauses data reception.

Syntax

fn pause_data(&self) -> Result<(), IPWorksAuthError>

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 re-enable data reception.

process_data method (LDAP Struct)

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

Syntax

fn process_data(&self) -> Result<(), IPWorksAuthError>

Remarks

This method re-enables data reception after a previous call to pause_data. 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. It does not need to be called to process data by default.

reset method (LDAP Struct)

This method will reset the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksAuthError>

Remarks

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

search method (LDAP Struct)

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

Syntax

fn search(&self, search_filter : &str) -> Result<(), IPWorksAuthError>

Remarks

This method searches the directory server using the base object specified in the dn and the search filter specified in the search_filter 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=*")

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:

     (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 (LDAP Struct)

This method unbinds from the directory server.

Syntax

fn unbind(&self) -> Result<(), IPWorksAuthError>

Remarks

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

on_computer_list event (LDAP Struct)

This event is fired for each computer entry returned.

Syntax

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

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

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

Remarks

This event is fired once for each computer returned when the list_computers method is called.

on_connected event (LDAP Struct)

Fired immediately after a connection completes (or fails).

Syntax

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

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

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

Remarks

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

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

Please refer to the Error Codes section for more information.

on_connection_status event (LDAP Struct)

Fired to indicate changes in the connection state.

Syntax

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

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

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

Remarks

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

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

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

on_disconnected event (LDAP Struct)

Fired when a connection is closed.

Syntax

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

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

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

Remarks

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

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

Please refer to the Error Codes section for more information.

on_error event (LDAP Struct)

Fired when information is available about errors during data delivery.

Syntax

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

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

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

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_extended_response event (LDAP Struct)

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

Syntax

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

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

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

Remarks

The first four parameters are the same as the parameters of the on_result event. response_name and response_value are related to the corresponding parameters of the call to extended_request.

on_group_list event (LDAP Struct)

This event is fired for each group entry returned.

Syntax

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

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

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

Remarks

This event is fired once for each group entry returned when either of the list_groups or list_user_groups methods are called.

on_pi_trail event (LDAP Struct)

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

Syntax

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

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

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

Remarks

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

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

• 0 - Client
• 1 - Server

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

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

on_result event (LDAP Struct)

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

Syntax

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

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

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

Remarks

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

on_search_complete event (LDAP Struct)

This event is fired upon completion of a search operation.

Syntax

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

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

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

Remarks

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

on_search_page event (LDAP Struct)

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

Syntax

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

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

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

Remarks

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

on_search_result event (LDAP Struct)

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

Syntax

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

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

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

Remarks

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

Every search operation results in a sequence of 0 or more on_search_result events and a sequence of 0 or more on_search_result_reference events, which are followed by a on_search_complete event.

on_search_result_reference event (LDAP Struct)

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

Syntax

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

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

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

Remarks

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

Every search operation results in a sequence of 0 or more on_search_result 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 (LDAP Struct)

Fired after the server presents its certificate to the client.

Syntax

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

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

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

Remarks

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

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

on_ssl_status event (LDAP Struct)

Fired when secure connection progress messages are available.

Syntax

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

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

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

Remarks

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

on_user_list event (LDAP Struct)

This event is fired once for each user entry returned.

Syntax

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

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

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

Remarks

This event is fired once for each user entry returned when the list_group_members method is called.

Config Settings (LDAP Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

LDAP Config Settings

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (LDAP Struct)

LDAP Errors

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

TCPClient Errors

TCP/IP Errors