# LDAP Component The Lightweight Directory Access Protocol (LDAP) Component is used to search, manage, and maintain internet directory servers. ## Syntax ```text nsoftware.IPWorksAuth.LDAP ``` ## Remarks The LDAP Component 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 [SSLServerAuthentication](#sslserverauthentication-event-ldap-component) event allows you to check the server identity and other security attributes. The [SSLStatus](#sslstatus-event-ldap-component) event provides information about the SSL handshake. Additional SSL-related settings are also supported through the [Config](#config-method-ldap-component) method. The LDAP Component 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 component is specifying the [ServerName](#servername-property-ldap-component), a [DN](#dn-property-ldap-component) (distinguished name) to bind as, and optionally a [Password](#password-property-ldap-component). Then you can call one or more of the component methods to act upon the server. Server responses normally are received through the [Result](#result-event-ldap-component) event. The only exceptions are search requests that result in one or more [SearchResult](#searchresult-event-ldap-component) events, followed by a final [SearchComplete](#searchcomplete-event-ldap-component) event. Attributes are set and returned through the [Attributes](#attributes-property-ldap-component) collection. Other command arguments are specified through other properties. These are specified in detail in each method. Search filters are to be specified as string arguments to the [Search](#search-method-ldap-component) method. The format must be a standard LDAP search string as specified in RFC 1558. Other search attributes are set in properties, such as [SearchScope](#searchscope-property-ldap-component), [SearchTimeLimit](#searchtimelimit-property-ldap-component), [SearchSizeLimit](#searchsizelimit-property-ldap-component), [SearchReturnValues](#searchreturnvalues-property-ldap-component), and [SearchDerefAliases](#searchderefaliases-property-ldap-component). The component operates synchronously by default (waits for a response before returning control to the caller); however, the component also may operate asynchronously (return control immediately), by setting [Timeout](#timeout-property-ldap-component) to 0. Please refer to the [Timeout](#timeout-property-ldap-component) property for more information. ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AcceptData](#acceptdata-property-ldap-component) | This property indicates whether data reception is currently enabled. | | [Attributes](#attributes-property-ldap-component) | This property includes the attributes for the current entry. | | [AuthMechanism](#authmechanism-property-ldap-component) | This property is the authentication mechanism to be used when connecting to the Lightweight Directory Access Protocol (LDAP) server. | | [Connected](#connected-property-ldap-component) | This property shows whether the component is connected. | | [DeleteOldRDN](#deleteoldrdn-property-ldap-component) | This property controls whether the old RDN (Relative Distinguished Name) should be deleted. | | [DN](#dn-property-ldap-component) | This property includes the distinguished name used as the base for Lightweight Directory Access Protocol (LDAP) operations. | | [Firewall](#firewall-property-ldap-component) | A set of properties related to firewall access. | | [Idle](#idle-property-ldap-component) | The current status of the component. | | [LDAPVersion](#ldapversion-property-ldap-component) | The version of the Lightweight Directory Access Protocol (LDAP) used. | | [LocalHost](#localhost-property-ldap-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [MessageId](#messageid-property-ldap-component) | This property includes the message identifier for the next Lightweight Directory Access Protocol (LDAP) request. | | [PageSize](#pagesize-property-ldap-component) | This property includes the maximum number of results per page for the [Search](#search-method-ldap-component) method. | | [Password](#password-property-ldap-component) | This property includes the password used to authenticate to the Lightweight Directory Access Protocol (LDAP) server. | | [References](#references-property-ldap-component) | This property includes a collection of references returned from the server. | | [ResultCode](#resultcode-property-ldap-component) | This property includes the result code returned in the last server response. | | [ResultDescription](#resultdescription-property-ldap-component) | This property includes the descriptive text returned in the last server response (if any). | | [ResultDN](#resultdn-property-ldap-component) | This property includes the distinguished name returned in the last server response (if any). | | [SearchDerefAliases](#searchderefaliases-property-ldap-component) | This property controls alias dereferencing during searching. | | [SearchReturnValues](#searchreturnvalues-property-ldap-component) | This property controls whether the search operation returns values of attributes or only types. | | [SearchScope](#searchscope-property-ldap-component) | This property controls the scope of Lightweight Directory Access Protocol (LDAP) search operations. | | [SearchSizeLimit](#searchsizelimit-property-ldap-component) | This property includes the maximum number of entries that can be returned by the next search operation. | | [SearchTimeLimit](#searchtimelimit-property-ldap-component) | This property includes a time limit for the next search operation (in seconds). | | [ServerName](#servername-property-ldap-component) | This property includes the name or address of the Lightweight Directory Access Protocol (LDAP) server. | | [ServerPort](#serverport-property-ldap-component) | This property includes the server port for the Lightweight Directory Access Protocol (LDAP) connection (the default is 389). | | [SortAttributes](#sortattributes-property-ldap-component) | This property includes a string of attribute names to sort on with optional relative matching rules. | | [SSLAcceptServerCert](#sslacceptservercert-property-ldap-component) | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-ldap-component) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLEnabled](#sslenabled-property-ldap-component) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. | | [SSLProvider](#sslprovider-property-ldap-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-ldap-component) | The server certificate for the last established connection. | | [SSLStartMode](#sslstartmode-property-ldap-component) | This property determines how the component starts the Secure Sockets Layer (SSL) negotiation. | | [Timeout](#timeout-property-ldap-component) | This property includes the timeout for the component. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Abandon](#abandon-method-ldap-component) | This method asks the server to abandon a request. | | [Add](#add-method-ldap-component) | This method adds an entry specified by [DN](#dn-property-ldap-component) to the directory server using the type and value attributes defined in the [Attributes](#attributes-property-ldap-component) properties. | | [Attr](#attr-method-ldap-component) | This method returns the value of the specified Lightweight Directory Access Protocol (LDAP) attribute. | | [Bind](#bind-method-ldap-component) | This method connects and binds to the directory server. | | [ChangePassword](#changepassword-method-ldap-component) | This method changes the password for the specified user. | | [Compare](#compare-method-ldap-component) | This method compares attributes and values with those of the entry specified by [DN](#dn-property-ldap-component) . | | [Config](#config-method-ldap-component) | Sets or retrieves a configuration setting. | | [Connect](#connect-method-ldap-component) | This method connects to the directory server without performing any action. | | [Delete](#delete-method-ldap-component) | Deletes an entry specified by [DN](#dn-property-ldap-component) from the directory server. | | [DoEvents](#doevents-method-ldap-component) | This method processes events from the internal message queue. | | [ExtendedRequest](#extendedrequest-method-ldap-component) | This method performs a Lightweight Directory Access Protocol (LDAP) V3 extended operation. | | [Interrupt](#interrupt-method-ldap-component) | This method interrupts the current method. | | [ListComputers](#listcomputers-method-ldap-component) | This method lists all computers in the directory. | | [ListGroupMembers](#listgroupmembers-method-ldap-component) | This method lists all members of a group. | | [ListGroups](#listgroups-method-ldap-component) | This method list all groups in the directory. | | [ListUserGroups](#listusergroups-method-ldap-component) | This method lists all groups a user is a part of. | | [Modify](#modify-method-ldap-component) | This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by [DN](#dn-property-ldap-component) . | | [ModifyRDN](#modifyrdn-method-ldap-component) | This method performs a Lightweight Directory Access Protocol (LDAP) modify RDN operation on an entry specified by [DN](#dn-property-ldap-component) . | | [MoveToDN](#movetodn-method-ldap-component) | This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by [DN](#dn-property-ldap-component) by changing its superior. | | [PauseData](#pausedata-method-ldap-component) | This method pauses data reception. | | [ProcessData](#processdata-method-ldap-component) | This method re-enables data reception after a call to [PauseData](#pausedata-method-ldap-component) . | | [Reset](#reset-method-ldap-component) | This method will reset the component. | | [Search](#search-method-ldap-component) | This method searches the directory server using the base object specified in [DN](#dn-property-ldap-component) and the search filter SearchFilter . | | [Unbind](#unbind-method-ldap-component) | This method unbinds from the directory server. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ComputerList](#computerlist-event-ldap-component) | This event is fired for each computer entry returned. | | [Connected](#connected-event-ldap-component) | Fired immediately after a connection completes (or fails). | | [ConnectionStatus](#connectionstatus-event-ldap-component) | Fired to indicate changes in the connection state. | | [Disconnected](#disconnected-event-ldap-component) | Fired when a connection is closed. | | [Error](#error-event-ldap-component) | Fired when information is available about errors during data delivery. | | [ExtendedResponse](#extendedresponse-event-ldap-component) | This event is fired for Lightweight Directory Access Protocol (LDAP) V3 extended responses. | | [GroupList](#grouplist-event-ldap-component) | This event is fired for each group entry returned. | | [PITrail](#pitrail-event-ldap-component) | This event provides detailed information about the interaction with the server. | | [Result](#result-event-ldap-component) | This event is fired for every server response, except for search responses. | | [SearchComplete](#searchcomplete-event-ldap-component) | This event is fired upon completion of a search operation. | | [SearchPage](#searchpage-event-ldap-component) | This event is fired for every page returned from a search operation. | | [SearchResult](#searchresult-event-ldap-component) | This event is fired for every entry returned from a search operation. | | [SearchResultReference](#searchresultreference-event-ldap-component) | This event is fired for every result reference returned from a search operation. | | [SSLServerAuthentication](#sslserverauthentication-event-ldap-component) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-ldap-component) | Fired when secure connection progress messages are available. | | [UserList](#userlist-event-ldap-component) | This event is fired once for each user entry returned. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [DomainController](#DomainController) | Returns the name of the domain controller. | | [FriendlyGUID](#FriendlyGUID) | Whether to return GUID attribute values in a human readable format. | | [FriendlySID](#FriendlySID) | Whether to return SID attribute values in a human readable format. | | [MaxAttributes](#MaxAttributes) | Instructs component to save the amount of attributes specified that are returned by the server. | | [RequestControls](#RequestControls) | Controls to include in the request. | | [ResponseControls](#ResponseControls) | Controls present in the response. | | [UseDefaultDC](#UseDefaultDC) | Whether to connect to the default Domain Controller when calling Bind. | | [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the component will close the upload or download stream after the transfer. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. | | [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the component whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallListener](#FirewallListener) | If true, the component binds to a SOCKS firewall as a server (TCPClient only). | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the component binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AcceptData Property ([LDAP](#ldap-component) Component) This property indicates whether data reception is currently enabled. ## Syntax ```text public bool AcceptData { get; } ``` ## Default Value True ## Remarks This property indicates whether data reception is currently enabled. When *false*, data reception is disabled. Use the [PauseData](#pausedata-method-ldap-component) and [ProcessData](#processdata-method-ldap-component) methods to pause and resume data reception. This property is read-only and not available at design time. # Attributes Property ([LDAP](#ldap-component) Component) This property includes the attributes for the current entry. ## Syntax ```text public LDAPAttributeList Attributes { get; } ``` ## Remarks This property contains a collection of all of the attributes for the current entry. Each attribute's details are found in the fields of the [LDAPAttribute](#ldapattribute-type) type. After a [Search](#search-method-ldap-component), this property will be populated with the attributes of each search result and can be read within the [SearchResult](#searchresult-event-ldap-component) event (one event for each resulting DN). During a Lightweight Directory Access Protocol (LDAP) [Modify](#modify-method-ldap-component) operation, this property describes the modifications that are to be made to the attributes. You may specify the attribute, the new value, and the operation to be executed by the server in this property. This collection is indexed from *0* to *Count - 1*. This property is not available at design time. Please refer to the [LDAPAttribute](#ldapattribute-type) type for a complete list of fields. # AuthMechanism Property ([LDAP](#ldap-component) Component) This property is the authentication mechanism to be used when connecting to the Lightweight Directory Access Protocol (LDAP) server. ## Syntax ```text public LDAPAuthMechanisms AuthMechanism { get; set; } enum LDAPAuthMechanisms { lamSimple, lamDigestMD5, lamNegotiate, lamKerberos, lamSASLExternal } ``` ## Default Value 0 ## Remarks This property specifies the authentication mechanism used. Possible values are as follows: | | | | --- | --- | | 0 (lamSimple - default) | Plaintext authentication | | 1 (lamDigestMD5) | DIGEST-MD5 authentication | | 2 (lamNegotiate) | NTLM/Negotiate authentication | | 6 (lamKerberos) | Kerberos authentication | | 7 (lamSASLExternal) | SASL EXTERNAL authentication | # Connected Property ([LDAP](#ldap-component) Component) This property shows whether the component is connected. ## Syntax ```text public bool Connected { get; } ``` ## Default Value False ## Remarks This property is used to determine whether or not the component is connected to the remote host. Use the [Bind](#bind-method-ldap-component) and [Unbind](#unbind-method-ldap-component) methods to manage the connection. This property is read-only and not available at design time. # DeleteOldRDN Property ([LDAP](#ldap-component) Component) This property controls whether the old RDN (Relative Distinguished Name) should be deleted. ## Syntax ```text public bool DeleteOldRDN { get; set; } ``` ## Default Value True ## Remarks This property controls whether the old RDN should be deleted. It is used when [ModifyRDN](#modifyrdn-method-ldap-component) is called. The default value is True, which instructs the server to delete the old RDN. This property is not available at design time. # DN Property ([LDAP](#ldap-component) Component) This property includes the distinguished name used as the base for Lightweight Directory Access Protocol (LDAP) operations. ## Syntax ```text public string DN { get; set; } ``` ## Default Value "" ## Remarks This also includes the base object during LDAP searches. The distinguished name is provided in string format, as specified by RFC 1779. **Example. Setting DN:** ```text LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server" LDAPControl.DN = "Domain\Username" ``` # Firewall Property ([LDAP](#ldap-component) Component) A set of properties related to firewall access. ## Syntax ```text public Firewall Firewall { get; set; } ``` ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the component will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # Idle Property ([LDAP](#ldap-component) Component) The current status of the component. ## Syntax ```text public bool Idle { get; } ``` ## 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. # LDAPVersion Property ([LDAP](#ldap-component) Component) The version of the Lightweight Directory Access Protocol (LDAP) used. ## Syntax ```text public int LDAPVersion { get; set; } ``` ## Default Value 3 ## Remarks This property contains the version of LDAP used. The default value is 3 (for LDAPv3). This property is not available at design time. # LocalHost Property ([LDAP](#ldap-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text public string LocalHost { get; set; } ``` ## 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 component initiate connections (or accept in the case of server components) 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 component is connected, the LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window. # MessageId Property ([LDAP](#ldap-component) Component) This property includes the message identifier for the next Lightweight Directory Access Protocol (LDAP) request. ## Syntax ```text public int MessageId { get; set; } ``` ## 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 component increments this property automatically after each request. This property is not available at design time. # PageSize Property ([LDAP](#ldap-component) Component) This property includes the maximum number of results per page for the [Search](#search-method-ldap-component) method. ## Syntax ```text public int PageSize { get; set; } ``` ## Default Value 0 ## Remarks This property contains the maximum number of results per page for the [Search](#search-method-ldap-component) 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 PageSize results. For each page sent by the server, a [SearchPage](#searchpage-event-ldap-component) event will fire. You may decide to cancel or continue displaying results from within this event. NOTE: Lightweight Directory Access Protocol (LDAP) paging functionality is described by LDAP extension RFCs and may or may not be implemented by the LDAP server being accessed. # Password Property ([LDAP](#ldap-component) Component) This property includes the password used to authenticate to the Lightweight Directory Access Protocol (LDAP) server. ## Syntax ```text public string Password { get; set; } ``` ## Default Value "" ## Remarks This property contains the password used to authenticate to the LDAP server. Leave this value empty if no password is required. This property is not available at design time. # References Property ([LDAP](#ldap-component) Component) This property includes a collection of references returned from the server. ## Syntax ```text public LDAPReferenceList References { get; } ``` ## Remarks This property contains a collection of references returned from the server. References will be SearchResult references if inside a [SearchResult](#searchresult-event-ldap-component) or [SearchResultReference](#searchresultreference-event-ldap-component) event. In this case, they represent URLs to contact to continue the search. References will be regular result references if inside the [Result](#result-event-ldap-component) event or [SearchComplete](#searchcomplete-event-ldap-component) event. In this case, they represent the URLs to contact to complete the requested operation. This collection is indexed from *0* to *Count - 1*. This property is read-only and not available at design time. Please refer to the [LDAPReference](#ldapreference-type) type for a complete list of fields. # ResultCode Property ([LDAP](#ldap-component) Component) This property includes the result code returned in the last server response. ## Syntax ```text public int ResultCode { get; } ``` ## 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 [Result](#result-event-ldap-component), [SearchResult](#searchresult-event-ldap-component), or [SearchComplete](#searchcomplete-event-ldap-component) event. Possible result codes are as follows: | | | | --- | --- | | 0 | success | | 1 | operationsError | | 2 | protocolError | | 3 | timeLimitExceeded | | 4 | sizeLimitExceeded | | 5 | compareFalse | | 6 | compareTrue | | 7 | authMethodNotSupported | | 8 | strongAuthRequired | | 9 | reserved | | 10 | referral | | 11 | adminLimitExceeded | | 12 | unavailableCriticalExtension | | 13 | confidentialityRequired | | 14 | saslBindInProgress | | 16 | noSuchAttribute | | 17 | undefinedAttributeType | | 18 | inappropriateMatching | | 19 | constraintViolation | | 20 | attributeOrValueExists | | 21 | invalidAttributeSyntax | | 32 | noSuchObject | | 33 | aliasProblem | | 34 | invalidDNSyntax | | 35 | reserved for undefined isLeaf | | 36 | aliasDereferencingProblem | | 48 | inappropriateAuthentication | | 49 | invalidCredentials | | 50 | insufficientAccessRights | | 51 | busy | | 52 | unavailable | | 53 | unwillingToPerform | | 54 | loopDetect | | 64 | namingViolation | | 65 | objectClassViolation | | 66 | notAllowedOnNonLeaf | | 67 | notAllowedOnRDN | | 68 | entryAlreadyExists | | 69 | objectClassModsProhibited | | 70 | reserved for CLDAP | | 71 | affectsMultipleDSAs | All the result codes with the exception of success, compareFalse and compareTrue are to be treated as meaning the operation could not be completed in its entirety. Result codes from 16 to 21 indicate an AttributeProblem; codes 32, 33, 34, and 36 indicate a NameProblem; codes 48, 49, and 50 indicate a SecurityProblem; codes 51 to 54 indicate a ServiceProblem; and codes 64 to 69 and 71 indicate an UpdateProblem. This property is read-only. # ResultDescription Property ([LDAP](#ldap-component) Component) This property includes the descriptive text returned in the last server response (if any). ## Syntax ```text public string ResultDescription { get; } ``` ## 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 [Result](#result-event-ldap-component), [SearchResult](#searchresult-event-ldap-component), or [SearchComplete](#searchcomplete-event-ldap-component) event. This property is read-only. # ResultDN Property ([LDAP](#ldap-component) Component) This property includes the distinguished name returned in the last server response (if any). ## Syntax ```text public string ResultDN { get; } ``` ## 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 [Result](#result-event-ldap-component) or [SearchComplete](#searchcomplete-event-ldap-component) event. This property is read-only. # SearchDerefAliases Property ([LDAP](#ldap-component) Component) This property controls alias dereferencing during searching. ## Syntax ```text public LDAPSearchDerefAliases SearchDerefAliases { get; set; } enum LDAPSearchDerefAliases { sdaNever, sdaInSearching, sdaFindingBaseObject, sdaAlways } ``` ## Default Value 0 ## Remarks This property controls the alias dereferencing during searching. The possible values are as follows: | | | | --- | --- | | sdaNever (0) | Do not dereference aliases in searching or in locating the base object of the search. | | sdaInSearching (1) | Dereference aliases in subordinates of the base object in searching, but not in locating the base object of the search. | | sdaFindingBaseObject (2) | Dereference aliases in locating the base object of the search, but not when searching subordinates of the base object. | | sdaAlways (3) | Dereference aliases both in searching and in locating the base object of the search. | The default is to never dereference aliases. # SearchReturnValues Property ([LDAP](#ldap-component) Component) This property controls whether the search operation returns values of attributes or only types. ## Syntax ```text public bool SearchReturnValues { get; set; } ``` ## 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. # SearchScope Property ([LDAP](#ldap-component) Component) This property controls the scope of Lightweight Directory Access Protocol (LDAP) search operations. ## Syntax ```text public LDAPSearchScopes SearchScope { get; set; } enum LDAPSearchScopes { ssBaseObject, ssSingleLevel, ssWholeSubtree } ``` ## Default Value 2 ## Remarks This property controls the scope of LDAP search operations. Possible values are as follows: | | | | --- | --- | | ssBaseObject (0) | Search only the base object. | | ssSingleLevel (1) | Search only one level, including objects directly below the base object, but not the base object. | | ssWholeSubtree (2) | Search the whole subtree, including the base object. | The default is to search the whole subtree. # SearchSizeLimit Property ([LDAP](#ldap-component) Component) This property includes the maximum number of entries that can be returned by the next search operation. ## Syntax ```text public int SearchSizeLimit { get; set; } ``` ## 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. # SearchTimeLimit Property ([LDAP](#ldap-component) Component) This property includes a time limit for the next search operation (in seconds). ## Syntax ```text public int SearchTimeLimit { get; set; } ``` ## 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. # ServerName Property ([LDAP](#ldap-component) Component) This property includes the name or address of the Lightweight Directory Access Protocol (LDAP) server. ## Syntax ```text public string ServerName { get; set; } ``` ## 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. # ServerPort Property ([LDAP](#ldap-component) Component) This property includes the server port for the Lightweight Directory Access Protocol (LDAP) connection (the default is 389). ## Syntax ```text public int ServerPort { get; set; } ``` ## 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 [SSLStartMode](#sslstartmode-property-ldap-component) 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. This property is not available at design time. # SortAttributes Property ([LDAP](#ldap-component) Component) This property includes a string of attribute names to sort on with optional relative matching rules. ## Syntax ```text public string SortAttributes { get; set; } ``` ## Default Value "" ## Remarks This property contains a string of attribute names to sort on with optional relative matching rules. When set before a [Search](#search-method-ldap-component), entries returned by the server will be sorted according to SortAttributes. The format consists of one or more attribute names separated by spaces. Each attribute may be followed by an optional matching rule. If matching rules are defined, they should be separated from the attribute names with a "/". Normally, the values are returned in ascending order. If descending (reverse) order of sorting is desired, the attribute type must be preceded with a "-". Following are examples: ```text LDAPControl.SortAttributes = "loginTime" LDAPControl.SortAttributes = "name/caseIgnoreSubstringsMatch age/numericStringSubstringsMatch" LDAPControl.SortAttributes = "cn age/1.3.6.1.4.1.1466.115.121.1.27" LDAPControl.SortAttributes = "-cn age/1.3.6.1.4.1.1466.115.121.1.27" ``` **Example 1. Matching Rules for Equality Filters:** | | | | --- | --- | | 1.3.6.1.4.1.1466.115.121.1.38 | objectIdentifierMatch | | 1.3.6.1.4.1.1466.115.121.1.12 | distinguishedNameMatch | | 1.3.6.1.4.1.1466.115.121.1.15 | caseIgnoreMatch | | 1.3.6.1.4.1.1466.115.121.1.36 | numericStringMatch | | 1.3.6.1.4.1.1466.115.121.1.41 | caseIgnoreListMatch | | 1.3.6.1.4.1.1466.115.121.1.27 | integerMatch | | 1.3.6.1.4.1.1466.115.121.1.6 | bitStringMatch | | 1.3.6.1.4.1.1466.115.121.1.50 | telephoneNumberMatch | | 1.3.6.1.4.1.1466.115.121.1.43 | presentationAddressMatch | | 1.3.6.1.4.1.1466.115.121.1.34 | uniqueMemberMatch | | 1.3.6.1.4.1.1466.115.121.1.42 | protocolInformationMatch | | 1.3.6.1.4.1.1466.115.121.1.24 | generalizedTimeMatch | | 1.3.6.1.4.1.1466.115.121.1.26 | caseExactIA5Match | | 1.3.6.1.4.1.1466.115.121.1.26 | caseIgnoreIA5Match | **Example 2. Matching Rules for Inequality Filters:** | | | | --- | --- | | 1.3.6.1.4.1.1466.115.121.1.24 | generalizedTimeOrderingMatch | | 1.3.6.1.4.1.1466.115.121.1.15 | caseIgnoreOrderingMatch | **Example 3. Matching Rules for Substring Filters:** | | | | --- | --- | | 1.3.6.1.4.1.1466.115.121.1.58 | caseIgnoreSubstringsMatch | | 1.3.6.1.4.1.1466.115.121.1.58 | telephoneNumberSubstringsMatch | | 1.3.6.1.4.1.1466.115.121.1.58 | numericStringSubstringsMatch | **Example 4. Matching Rules for Subschema Attributes:** | | | | --- | --- | | 1.3.6.1.4.1.1466.115.121.1.27 | integerFirstComponentMatch | | 1.3.6.1.4.1.1466.115.121.1.38 | objectIdentifierFirstComponentMatch | # SSLAcceptServerCert Property ([LDAP](#ldap-component) Component) Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text public Certificate SSLAcceptServerCert { get; set; } ``` ## Remarks If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLCert Property ([LDAP](#ldap-component) Component) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text public Certificate SSLCert { get; set; } ``` ## Remarks This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLEnabled Property ([LDAP](#ldap-component) Component) This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. ## Syntax ```text public bool SSLEnabled { get; set; } ``` ## Default Value False ## Remarks This property specifies whether TLS/SSL is enabled in the component. When False (default), the component operates in plaintext mode. When True, TLS/SSL is enabled. TLS/SSL may also be enabled by setting [SSLStartMode](#sslstartmode-property-ldap-component). Setting [SSLStartMode](#sslstartmode-property-ldap-component) will automatically update this property value. This property is not available at design time. # SSLProvider Property ([LDAP](#ldap-component) Component) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text public LDAPSSLProviders SSLProvider { get; set; } enum LDAPSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal } ``` ## 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 component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform. When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. The .NET Standard library will always use the internal implementation on all platforms. # SSLServerCert Property ([LDAP](#ldap-component) Component) The server certificate for the last established connection. ## Syntax ```text public Certificate SSLServerCert { get; } ``` ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. This property is read-only. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLStartMode Property ([LDAP](#ldap-component) Component) This property determines how the component starts the Secure Sockets Layer (SSL) negotiation. ## Syntax ```text public LDAPSSLStartModes SSLStartMode { get; set; } enum LDAPSSLStartModes { sslAutomatic, sslImplicit, sslExplicit, sslNone } ``` ## Default Value 3 ## Remarks The SSLStartMode property may have one of the following values: | | | | --- | --- | | 0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the component will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). | | 1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. | | 2 (sslExplicit) | The component will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. | | 3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. | # Timeout Property ([LDAP](#ldap-component) Component) This property includes the timeout for the component. ## Syntax ```text public int Timeout { get; set; } ``` ## 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 component will wait for the operation to complete before returning control. The component will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of Timeout seconds. The component will use [DoEvents](#doevents-method-ldap-component) 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 component throws an exception. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. # Abandon Method ([LDAP](#ldap-component) Component) This method asks the server to abandon a request. ## Syntax ```text public void Abandon(int messageId); Async Version public async Task Abandon(int messageId); public async Task Abandon(int messageId, CancellationToken cancellationToken); ``` ## Remarks This method asks the server to abandon the request specified by *MessageId*. The result of the operation is returned through the [Result](#result-event-ldap-component) event. # Add Method ([LDAP](#ldap-component) Component) This method adds an entry specified by [DN](#dn-property-ldap-component) to the directory server using the type and value attributes defined in the [Attributes](#attributes-property-ldap-component) properties. ## Syntax ```text public void Add(); Async Version public async Task Add(); public async Task Add(CancellationToken cancellationToken); ``` ## Remarks This method adds the entry specified by [DN](#dn-property-ldap-component) to the directory. All entries are required to have an objectClass attribute. To add a new entry, first [Bind](#bind-method-ldap-component) with credentials that will allow you to perform the new addition. To add attributes instead of entries, use the [Modify](#modify-method-ldap-component) method instead. When specifying multivalued attributes, specify the attribute type only in the first occurrence of that attribute type in the [Attributes](#attributes-property-ldap-component) collection. 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 [Result](#result-event-ldap-component) event. **Example. Add a New Entry (including the multivalued objectClass attribute):** ```text LDAPControl.DN = "uid=NewUser,ou=Employees,dc=server" LDAPControl.Attributes.Add(new LDAPAttribute("objectClass", "top")) LDAPControl.Attributes.Add(new LDAPAttribute("", "person")) LDAPControl.Attributes.Add(new LDAPAttribute("", "organizationalPerson")) LDAPControl.Attributes.Add(new LDAPAttribute("", "inetorgperson")) LDAPControl.Attributes.Add(new LDAPAttribute("sn", "UserName")) LDAPControl.Attributes.Add(new LDAPAttribute("cn", "New S. UserName")) LDAPControl.Attributes.Add(new LDAPAttribute("uid", "NewUser")) LDAPControl.Add() ``` # Attr Method ([LDAP](#ldap-component) Component) This method returns the value of the specified Lightweight Directory Access Protocol (LDAP) attribute. ## Syntax ```text public string Attr(string attrType); Async Version public async Task Attr(string attrType); public async Task Attr(string attrType, CancellationToken cancellationToken); ``` ## 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](#attributes-property-ldap-component) collection for more information. # Bind Method ([LDAP](#ldap-component) Component) This method connects and binds to the directory server. ## Syntax ```text public void Bind(); Async Version public async Task Bind(); public async Task Bind(CancellationToken cancellationToken); ``` ## Remarks This method connects and binds to the directory server. If the [Password](#password-property-ldap-component) 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 [Result](#result-event-ldap-component) event. **Example. Binding:** ```text LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server" LDAPControl.Password = "mypassword" LDAPControl.Bind() LDAPControl.DN = "Domain/Username" LDAPControl.Password = "mypassword" LDAPControl.Bind() ``` # ChangePassword Method ([LDAP](#ldap-component) Component) This method changes the password for the specified user. ## Syntax ```text public void ChangePassword(string user, string oldPassword, string newPassword); Async Version public async Task ChangePassword(string user, string oldPassword, string newPassword); public async Task ChangePassword(string user, string oldPassword, string newPassword, CancellationToken cancellationToken); ``` ## Remarks This method changes the password for the specified user. The *user* parameter is the name of the user for which the password will be changed. *oldPassword* specifies the current password and *newPassword* specifies the new password. NOTE: This operation can be performed only over the Secure Sockets Layer (SSL) port. Set [ServerPort](#serverport-property-ldap-component) 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](#ldap-component) Component) This method compares attributes and values with those of the entry specified by [DN](#dn-property-ldap-component) . ## Syntax ```text public void Compare(); Async Version public async Task Compare(); public async Task Compare(CancellationToken cancellationToken); ``` ## Remarks This method compares attribute types and values specified via the [Attributes](#attributes-property-ldap-component) collection, with the values in the directory for the entry specified by [DN](#dn-property-ldap-component). The result of the operation is returned through the [Result](#result-event-ldap-component) event. # Config Method ([LDAP](#ldap-component) Component) Sets or retrieves a configuration setting. ## Syntax ```text public string Config(string configurationString); Async Version public async Task Config(string configurationString); public async Task Config(string configurationString, CancellationToken cancellationToken); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-ldap-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-ldap-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Connect Method ([LDAP](#ldap-component) Component) This method connects to the directory server without performing any action. ## Syntax ```text public void Connect(); Async Version public async Task Connect(); public async Task Connect(CancellationToken cancellationToken); ``` ## Remarks This method establishes a connection with the directory server specified by [ServerName](#servername-property-ldap-component). In most cases, it is recommended to use the [Bind](#bind-method-ldap-component) 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](#ldap-component) Component) Deletes an entry specified by [DN](#dn-property-ldap-component) from the directory server. ## Syntax ```text public void Delete(); Async Version public async Task Delete(); public async Task Delete(CancellationToken cancellationToken); ``` ## Remarks This method deletes the entry specified by [DN](#dn-property-ldap-component) from the directory. The result of the operation is returned through the [Result](#result-event-ldap-component) event. # DoEvents Method ([LDAP](#ldap-component) Component) This method processes events from the internal message queue. ## Syntax ```text public void DoEvents(); Async Version public async Task DoEvents(); public async Task DoEvents(CancellationToken cancellationToken); ``` ## Remarks When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns. # ExtendedRequest Method ([LDAP](#ldap-component) Component) This method performs a Lightweight Directory Access Protocol (LDAP) V3 extended operation. ## Syntax ```text public void ExtendedRequest(string requestName, byte[] requestValue); Async Version public async Task ExtendedRequest(string requestName, byte[] requestValue); public async Task ExtendedRequest(string requestName, byte[] requestValue, CancellationToken cancellationToken); ``` ## Remarks This method performs an LDAP V3 extended operation. *RequestName* must contain the object identifier of the operation, and *RequestValue* may contain an optional value. # Interrupt Method ([LDAP](#ldap-component) Component) This method interrupts the current method. ## Syntax ```text public void Interrupt(); Async Version public async Task Interrupt(); public async Task Interrupt(CancellationToken cancellationToken); ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # ListComputers Method ([LDAP](#ldap-component) Component) This method lists all computers in the directory. ## Syntax ```text public void ListComputers(); Async Version public async Task ListComputers(); public async Task ListComputers(CancellationToken cancellationToken); ``` ## Remarks This method lists all computers in the directory. The [ComputerList](#computerlist-event-ldap-component) event will be fired once for each computer returned. # ListGroupMembers Method ([LDAP](#ldap-component) Component) This method lists all members of a group. ## Syntax ```text public void ListGroupMembers(string group); Async Version public async Task ListGroupMembers(string group); public async Task ListGroupMembers(string group, CancellationToken cancellationToken); ``` ## Remarks This method lists all members of the specified *group*. The [UserList](#userlist-event-ldap-component) event will be fired once for each member returned. # ListGroups Method ([LDAP](#ldap-component) Component) This method list all groups in the directory. ## Syntax ```text public void ListGroups(); Async Version public async Task ListGroups(); public async Task ListGroups(CancellationToken cancellationToken); ``` ## Remarks This method lists all groups in the directory. The [GroupList](#grouplist-event-ldap-component) event will be fired once for each group returned. # ListUserGroups Method ([LDAP](#ldap-component) Component) This method lists all groups a user is a part of. ## Syntax ```text public void ListUserGroups(string user); Async Version public async Task ListUserGroups(string user); public async Task ListUserGroups(string user, CancellationToken cancellationToken); ``` ## Remarks This method lists all groups that the user specified by *user* is a part of. The [GroupList](#grouplist-event-ldap-component) event will fire once for each group the user is a part of. # Modify Method ([LDAP](#ldap-component) Component) This method performs a Lightweight Directory Access Protocol (LDAP) * modify * operation on the entry specified by [DN](#dn-property-ldap-component) . ## Syntax ```text public void Modify(); Async Version public async Task Modify(); public async Task Modify(CancellationToken cancellationToken); ``` ## Remarks This method performs an LDAP *modify* operation on the entry specified by [DN](#dn-property-ldap-component). The attributes to modify should be set via the [Attributes](#attributes-property-ldap-component) collection. When specifying multivalued attributes, specify the attribute type only in the first occurrence of that attribute type in the [Attributes](#attributes-property-ldap-component) collection. 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 [Result](#result-event-ldap-component) event. **Example. Modify an Entry (Replace an Attribute Value):** ```text LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server" LDAPControl.Attributes.Add(New LDAPAttribute("url", "www.url1.net", LDAPAttributeModOps.amoReplace)) LDAPControl.Attributes.Add(New LDAPAttribute("", "www.url2.net", LDAPAttributeModOps.amoReplace)) LDAPControl.Modify() ``` # ModifyRDN Method ([LDAP](#ldap-component) Component) This method performs a Lightweight Directory Access Protocol (LDAP) * modify RDN * operation on an entry specified by [DN](#dn-property-ldap-component) . ## Syntax ```text public void ModifyRDN(string newRDN); Async Version public async Task ModifyRDN(string newRDN); public async Task ModifyRDN(string newRDN, CancellationToken cancellationToken); ``` ## Remarks This method performs an LDAP *modify RDN* operation on the entry specified by [DN](#dn-property-ldap-component). *NewRDN* is the new RDN for the entry specified by [DN](#dn-property-ldap-component) The result of the operation is returned through the [Result](#result-event-ldap-component) event. # MoveToDN Method ([LDAP](#ldap-component) Component) This method performs a Lightweight Directory Access Protocol (LDAP) * modify * operation on the entry specified by [DN](#dn-property-ldap-component) by changing its superior. ## Syntax ```text public void MoveToDN(string newSuperior); Async Version public async Task MoveToDN(string newSuperior); public async Task MoveToDN(string newSuperior, CancellationToken cancellationToken); ``` ## Remarks This method performs an LDAP *modify* operation on the entry specified by [DN](#dn-property-ldap-component) by changing its superior. NOTE: None of the entry's attributes will change. [DeleteOldRDN](#deleteoldrdn-property-ldap-component) property will be set to True to delete the old entry. The result of the operation is returned through the [Result](#result-event-ldap-component) event. # PauseData Method ([LDAP](#ldap-component) Component) This method pauses data reception. ## Syntax ```text public void PauseData(); Async Version public async Task PauseData(); public async Task PauseData(CancellationToken cancellationToken); ``` ## 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 [ProcessData](#processdata-method-ldap-component) to re-enable data reception. # ProcessData Method ([LDAP](#ldap-component) Component) This method re-enables data reception after a call to [PauseData](#pausedata-method-ldap-component) . ## Syntax ```text public void ProcessData(); Async Version public async Task ProcessData(); public async Task ProcessData(CancellationToken cancellationToken); ``` ## Remarks This method re-enables data reception after a previous call to [PauseData](#pausedata-method-ldap-component). Call this method to re-enable data reception and allow IPPacket to fire. NOTE: This method is used only after previously calling [PauseData](#pausedata-method-ldap-component). It does not need to be called to process data by default. # Reset Method ([LDAP](#ldap-component) Component) This method will reset the component. ## Syntax ```text public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken); ``` ## Remarks This method will reset the component's properties to their default values. # Search Method ([LDAP](#ldap-component) Component) This method searches the directory server using the base object specified in [DN](#dn-property-ldap-component) and the search filter * SearchFilter * . ## Syntax ```text public void Search(string searchFilter); Async Version public async Task Search(string searchFilter); public async Task Search(string searchFilter, CancellationToken cancellationToken); ``` ## Remarks This method searches the directory server using the base object specified in the [DN](#dn-property-ldap-component) and the search filter specified in the *SearchFilter* parameter. Additional search parameters are specified through the [SearchScope](#searchscope-property-ldap-component), [SearchDerefAliases](#searchderefaliases-property-ldap-component), [SearchSizeLimit](#searchsizelimit-property-ldap-component), [SearchTimeLimit](#searchtimelimit-property-ldap-component), and [SearchReturnValues](#searchreturnvalues-property-ldap-component) properties. If [Attributes](#attributes-property-ldap-component) 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 [SearchResult](#searchresult-event-ldap-component) events, after which a [SearchComplete](#searchcomplete-event-ldap-component) event is fired. **Example 1. Searching for a User:** ```text LDAPControl.DN = "ou=Employees,dc=server" LDAPControl.Search("uid=TThompson") ``` A Directory-Specific Entries (DSE) search will search for the attributes of the server. **Example 2. DSE Search:** ```text LDAPControl.DN = "" LDAPControl.SearchScope = 0 LDAPControl.Search("objectClass=*") ``` *SearchFilter* is a string representation of the Lightweight Directory Access Protocol (LDAP) search filter used for the search. The format of the search filter is specified by RFC 1558 and is identical to the format used by most LDAP applications. The following are examples of search filters, as provided in the RFC: **Example 3. Search Filters:** ```text (cn=Babs Jensen) (!(cn=Tim Howes)) (&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*))) (o=univ*of*mich*) ``` The complete specification is given by the following BNF: ```text ::= "(" ")" ::= | | | ::= "&" ::= "|" ::= "!" ::= | ::= | | ::= ::= | | | ::= "=" ::= "~=" ::= ">=" ::= "<=" ::= "=*" ::= "=" ::= NULL | ::= "*" ::= NULL | "*" ::= NULL | ``` is a string representing an attribute type as defined in RFC 1777. is a string representing an attribute value, or part of one, and has the form defined in RFC 1779. If a must contain one of the characters '*' or '(' or ')', these should be escaped by preceding them with the backslash '\' character. # Unbind Method ([LDAP](#ldap-component) Component) This method unbinds from the directory server. ## Syntax ```text public void Unbind(); Async Version public async Task Unbind(); public async Task Unbind(CancellationToken cancellationToken); ``` ## Remarks This method unbinds from the directory server and breaks the connection. # ComputerList Event ([LDAP](#ldap-component) Component) This event is fired for each computer entry returned. ## Syntax ```text public event OnComputerListHandler OnComputerList; public delegate void OnComputerListHandler(object sender, LDAPComputerListEventArgs e); public class LDAPComputerListEventArgs : EventArgs { public string name { get; } public string operatingSystem { get; } public string lastLogon { get; } public int logonCount { get; } public string dn { get; } } ``` ## Remarks This event is fired once for each computer returned when the [ListComputers](#listcomputers-method-ldap-component) method is called. # Connected Event ([LDAP](#ldap-component) Component) Fired immediately after a connection completes (or fails). ## Syntax ```text public event OnConnectedHandler OnConnected; public delegate void OnConnectedHandler(object sender, LDAPConnectedEventArgs e); public class LDAPConnectedEventArgs : EventArgs { public int StatusCode { get; } public string Description { get; } } ``` ## Remarks If the connection is made normally, *StatusCode* is 0 and *Description* is "OK". If the connection fails, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. Please refer to the [Error Codes](#trappable-errors-ldap-component) section for more information. # ConnectionStatus Event ([LDAP](#ldap-component) Component) Fired to indicate changes in the connection state. ## Syntax ```text public event OnConnectionStatusHandler OnConnectionStatus; public delegate void OnConnectionStatusHandler(object sender, LDAPConnectionStatusEventArgs e); public class LDAPConnectionStatusEventArgs : EventArgs { public string ConnectionEvent { get; } public int StatusCode { get; } public string Description { get; } } ``` ## 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 *ConnectionEvent* parameter indicates the type of connection event. Values may include the following: | | | | --- | --- | | | Firewall connection complete. | | | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | | | Remote host connection complete. | | | Remote host disconnected. | | | SSL or S/Shell connection broken. | | | Firewall host disconnected. | *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. # Disconnected Event ([LDAP](#ldap-component) Component) Fired when a connection is closed. ## Syntax ```text public event OnDisconnectedHandler OnDisconnected; public delegate void OnDisconnectedHandler(object sender, LDAPDisconnectedEventArgs e); public class LDAPDisconnectedEventArgs : EventArgs { public int StatusCode { get; } public string Description { get; } } ``` ## Remarks If the connection is broken normally, *StatusCode* is 0 and *Description* is "OK". If the connection is broken for any other reason, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the TCP/IP error. Please refer to the [Error Codes](#trappable-errors-ldap-component) section for more information. # Error Event ([LDAP](#ldap-component) Component) Fired when information is available about errors during data delivery. ## Syntax ```text public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, LDAPErrorEventArgs e); public class LDAPErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } } ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-ldap-component) section. # ExtendedResponse Event ([LDAP](#ldap-component) Component) This event is fired for Lightweight Directory Access Protocol (LDAP) V3 extended responses. ## Syntax ```text public event OnExtendedResponseHandler OnExtendedResponse; public delegate void OnExtendedResponseHandler(object sender, LDAPExtendedResponseEventArgs e); public class LDAPExtendedResponseEventArgs : EventArgs { public int MessageId { get; } public string DN { get; } public int ResultCode { get; } public string ResultDescription { get; } public string ResponseName { get; } public string ResponseValue { get; } public byte[] ResponseValueB { get; } } ``` ## Remarks The first four parameters are the same as the parameters of the [Result](#result-event-ldap-component) event. *ResponseName* and *ResponseValue* are related to the corresponding parameters of the call to [ExtendedRequest](#extendedrequest-method-ldap-component). # GroupList Event ([LDAP](#ldap-component) Component) This event is fired for each group entry returned. ## Syntax ```text public event OnGroupListHandler OnGroupList; public delegate void OnGroupListHandler(object sender, LDAPGroupListEventArgs e); public class LDAPGroupListEventArgs : EventArgs { public string name { get; } public string description { get; } public string dn { get; } } ``` ## Remarks This event is fired once for each group entry returned when either of the [ListGroups](#listgroups-method-ldap-component) or [ListUserGroups](#listusergroups-method-ldap-component) methods are called. # PITrail Event ([LDAP](#ldap-component) Component) This event provides detailed information about the interaction with the server. ## Syntax ```text public event OnPITrailHandler OnPITrail; public delegate void OnPITrailHandler(object sender, LDAPPITrailEventArgs e); public class LDAPPITrailEventArgs : EventArgs { public int Direction { get; } public string Description { get; } public string Message { get; } } ``` ## Remarks The PITrail 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. # Result Event ([LDAP](#ldap-component) Component) This event is fired for every server response, except for search responses. ## Syntax ```text public event OnResultHandler OnResult; public delegate void OnResultHandler(object sender, LDAPResultEventArgs e); public class LDAPResultEventArgs : EventArgs { public int MessageId { get; } public string DN { get; } public int ResultCode { get; } public string ResultDescription { get; } } ``` ## Remarks The *MessageId* parameter identifies the corresponding request. *ResultCode* and *ResultDescription* show whether or not the operation was successful (on a successful operation, the *ResultCode* is 0). For a full list of possible result codes, see the [ResultCode](#resultcode-property-ldap-component) property. # SearchComplete Event ([LDAP](#ldap-component) Component) This event is fired upon completion of a search operation. ## Syntax ```text public event OnSearchCompleteHandler OnSearchComplete; public delegate void OnSearchCompleteHandler(object sender, LDAPSearchCompleteEventArgs e); public class LDAPSearchCompleteEventArgs : EventArgs { public int MessageId { get; } public string DN { get; } public int ResultCode { get; } public string ResultDescription { get; } } ``` ## Remarks The *MessageId* parameter identifies the corresponding request. *ResultCode* and *ResultDescription* show whether the operation was successful (on a successful operation, the *ResultCode* is 0). # SearchPage Event ([LDAP](#ldap-component) Component) This event is fired for every page returned from a search operation. ## Syntax ```text public event OnSearchPageHandler OnSearchPage; public delegate void OnSearchPageHandler(object sender, LDAPSearchPageEventArgs e); public class LDAPSearchPageEventArgs : EventArgs { public int MessageId { get; } public string DN { get; } public int ResultCode { get; } public string ResultDescription { get; } public bool CancelSearch { get; set; } } ``` ## Remarks This event is fired so the client can decide whether or not to continue with the [Search](#search-method-ldap-component) operation. The signature is very similar to the [SearchComplete](#searchcomplete-event-ldap-component) event, with the addition of a *CancelSearch* parameter. If the search should be canceled (no more pages), the *CancelSearch* parameter should be set to True. # SearchResult Event ([LDAP](#ldap-component) Component) This event is fired for every entry returned from a search operation. ## Syntax ```text public event OnSearchResultHandler OnSearchResult; public delegate void OnSearchResultHandler(object sender, LDAPSearchResultEventArgs e); public class LDAPSearchResultEventArgs : EventArgs { public int MessageId { get; } public string DN { get; } } ``` ## Remarks *MessageId* identifies the corresponding search request. *DN* contains the distinguished name of the entry. The attribute type and value provided in the [Attributes](#attributes-property-ldap-component) collection show the list of retrieved attributes for the entry. Every search operation results in a sequence of 0 or more SearchResult events and a sequence of 0 or more [SearchResultReference](#searchresultreference-event-ldap-component) events, which are followed by a [SearchComplete](#searchcomplete-event-ldap-component) event. # SearchResultReference Event ([LDAP](#ldap-component) Component) This event is fired for every result reference returned from a search operation. ## Syntax ```text public event OnSearchResultReferenceHandler OnSearchResultReference; public delegate void OnSearchResultReferenceHandler(object sender, LDAPSearchResultReferenceEventArgs e); public class LDAPSearchResultReferenceEventArgs : EventArgs { public int MessageId { get; } public string LdapUrl { get; } } ``` ## Remarks *MessageId* identifies the corresponding search request. *LdapUrl* contains a URL reference to a server that can be used for continuing the search operation. Every search operation results in a sequence of 0 or more [SearchResult](#searchresult-event-ldap-component) events and a sequence of 0 or more SearchResultReference events, which are followed by a [SearchComplete](#searchcomplete-event-ldap-component) event. # SSLServerAuthentication Event ([LDAP](#ldap-component) Component) Fired after the server presents its certificate to the client. ## Syntax ```text public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, LDAPSSLServerAuthenticationEventArgs e); public class LDAPSSLServerAuthenticationEventArgs : EventArgs { public string CertEncoded { get; } public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } } ``` ## 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. # SSLStatus Event ([LDAP](#ldap-component) Component) Fired when secure connection progress messages are available. ## Syntax ```text public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, LDAPSSLStatusEventArgs e); public class LDAPSSLStatusEventArgs : EventArgs { public string Message { get; } } ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # UserList Event ([LDAP](#ldap-component) Component) This event is fired once for each user entry returned. ## Syntax ```text public event OnUserListHandler OnUserList; public delegate void OnUserListHandler(object sender, LDAPUserListEventArgs e); public class LDAPUserListEventArgs : EventArgs { public string name { get; } public string description { get; } public string lastLogon { get; } public string memberOf { get; } public string dn { get; } } ``` ## Remarks This event is fired once for each user entry returned when the [ListGroupMembers](#listgroupmembers-method-ldap-component) method is called. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *string (read-only)* Default: "" 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. **ExpirationDate** *string (read-only)* Default: "" 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. **ExtendedKeyUsage** *string (read-only)* Default: "" A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *string (read-only)* Default: "" 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* **FingerprintSHA1** *string (read-only)* Default: "" 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* **FingerprintSHA256** *string (read-only)* Default: "" 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* **Issuer** *string (read-only)* Default: "" The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. **PrivateKey** *string (read-only)* Default: "" The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *bool (read-only)* Default: False Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *string (read-only)* Default: "" The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *string (read-only)* Default: "" The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *string (read-only)* Default: "" 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. **PublicKeyLength** *int (read-only)* Default: 0 The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *string (read-only)* Default: "" 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. **SignatureAlgorithm** *string (read-only)* Default: "" 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. **Store** *string* Default: "MY" The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *byte []* Default: "MY" The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *string* Default: "" If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. **StoreType** *CertStoreTypes* Default: 0 The type of certificate store for this certificate. The component supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the component will automatically determine the type. This field can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) component by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **SubjectAltNames** *string (read-only)* Default: "" Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *string (read-only)* Default: "" 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. **ThumbprintSHA1** *string (read-only)* Default: "" 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. **ThumbprintSHA256** *string (read-only)* Default: "" 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. **Usage** *string (read-only)* Default: "" The text description of [UsageFlags](#Certificate_f_UsageFlags). 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. **UsageFlags** *int (read-only)* Default: 0 The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *string (read-only)* Default: "" The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *string* Default: "" The subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **Encoded** *string* Default: "" The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *byte []* Default: "" The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(string certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # Firewall Type The firewall the component will connect through. ## Remarks When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType). The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *bool* Default: False Whether to automatically detect and use firewall system settings, if available. **FirewallType** *FirewallTypes* Default: 0 The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. | **Host** *string* Default: "" The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting. If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception. **Password** *string* Default: "" A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception. **Port** *int* Default: 0 The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details. NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details. **User** *string* Default: "" A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the component throws an exception. ## Constructors ```text public Firewall(); ``` # LDAPAttribute Type This types describes an attribute for the current entry. ## Remarks This type describes an attribute for the current Lightweight Directory Access Protocol (LDAP) entry. The [ModOp](#LDAPAttribute_f_ModOp) field is used only in [Modify](#modify-method-ldap-component) operations. The following fields are available: - [AttributeType](#LDAPAttribute_f_AttributeType) - [ModOp](#LDAPAttribute_f_ModOp) - [Value](#LDAPAttribute_f_Value) ## Fields **AttributeType** *string* Default: "" This field contains the attribute type for the current entry. If the value of [AttributeType](#LDAPAttribute_f_AttributeType) is an empty string, then the [Value](#LDAPAttribute_f_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 collection with a nonempty [AttributeType](#LDAPAttribute_f_AttributeType). **ModOp** *LDAPAttributeModOps* Default: 0 This field contains an operation to apply to attributes during a Lightweight Directory Access Protocol (LDAP) modify operation. Possible values include the following: | | | | --- | --- | | amoAdd (0) | amoAdd will add the specified value to the given attribute, creating the attribute if it does not already exist. | | amoDelete (1) | amoDelete will delete the specified value from the given attribute. If all or none of the values are specified for the value, the entire attribute will be deleted; otherwise, only the specific value(s) listed will be removed. | | amoReplace (2) | amoReplace will replace all existing values of the given attribute with the new values specified. | **Value** *string* Default: "" This field contains the attribute value for the current entry. If the value is part of a set of values, the [AttributeType](#LDAPAttribute_f_AttributeType) 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 collection with a nonempty [AttributeType](#LDAPAttribute_f_AttributeType). **ValueB** *byte []* Default: "" This field contains the attribute value for the current entry. If the value is part of a set of values, the [AttributeType](#LDAPAttribute_f_AttributeType) 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 collection with a nonempty [AttributeType](#LDAPAttribute_f_AttributeType). ## Constructors ```text public LDAPAttribute(); ``` ```text public LDAPAttribute(string attributeType); ``` ```text public LDAPAttribute(string attributeType, string value); ``` ```text public LDAPAttribute(string attributeType, string value, LDAPAttributeModOps modOp); ``` # LDAPReference Type This type includes a reference returned from the server. ## Remarks This type describes a Lightweight Directory Access Protocol (LDAP) reference, which may be queried inside the [SearchResult](#searchresult-event-ldap-component), [SearchResultReference](#searchresultreference-event-ldap-component), [Result](#result-event-ldap-component), or [SearchComplete](#searchcomplete-event-ldap-component) events. When inside a [SearchResult](#searchresult-event-ldap-component) or [SearchResultReference](#searchresultreference-event-ldap-component) event, references will be a search result reference (that is, a continuation reference), in which case they represent the URLs to contact to continue the search. When inside a [Result](#result-event-ldap-component) or [SearchComplete](#searchcomplete-event-ldap-component) event, a reference will be a regular referral, in which case it represents the URL to contact to complete the requested operation. The following fields are available: - [URL](#LDAPReference_f_URL) ## Fields **URL** *string (read-only)* Default: "" The url of the LDAP reference. If inside a [SearchResult](#searchresult-event-ldap-component) or [SearchResultReference](#searchresultreference-event-ldap-component) event, it represents a URL to contact to continue the search. If inside the [Result](#result-event-ldap-component) event or [SearchComplete](#searchcomplete-event-ldap-component) event it represents the URL to contact in order to complete the requested operation. ## Constructors ```text public LDAPReference(); ``` # Config Settings ([LDAP](#ldap-component) Component) The component accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the [Config](#config-method-ldap-component) method. ### LDAP Config Settings **DomainController**: Returns the name of the domain controller.This configuration setting may be queried to return the name of the default domain controller in Active Directory domains. NOTE: This functionality is available only in Windows. NOTE: This functionality is not available in Java. **FriendlyGUID**: Whether to return GUID attribute values in a human readable format.When inspecting object attributes, this configuration setting determines whether GUID attributes, such as "objectGUID" are returned as binary objects or converted into a human readable string, such as "708d9374-d64a-49b2-97ea-489ddc717703". When set to True, a friendly string value is returned. When set to False (default), a binary object is returned. **FriendlySID**: Whether to return SID attribute values in a human readable format.When inspecting object attributes, this configuration setting determines whether SID attributes, such as "objectSid" are returned as binary objects or converted into a human readable string, such as "S-1-5-21-4272240814-246508344-1325542772-12464". When set to True, a friendly string value is returned. When set to False (default), a binary object is returned. **MaxAttributes**: Instructs component to save the amount of attributes specified that are returned by the server.This configuration setting should be set when populating the [Attributes](#attributes-property-ldap-component) collection as a result of a Lightweight Directory Access Protocol (LDAP) search. This value represents the number of LDAP attributes that are to be saved in the collection. To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection. You may still add to the [Attributes](#attributes-property-ldap-component) collection when this configuration is set. This configuration specifies only a maximum for returned attributes. **RequestControls**: Controls to include in the request.This configuration setting may be used to specify LDAP controls in the request. The expected format is a space-separated sequence of OIDs and hex-encoded values. For instance, a single control with a value of 04 may be sent as follows: ```text ldap.Config("RequestControls=1.2.826.0.1.3344810.2.3 04"); ``` To send a control without a value, specify only the OID. For instance: ```text ldap.Config("RequestControls=1.3.6.1.4.1.42.2.27.8.5.1"); ``` **ResponseControls**: Controls present in the response.This configuration setting holds the LDAP controls returned in the response (if any). The format is a space-separated sequence of OIDs and hex-encoded values. For instance: ```text Log(ldap.Config("ResponseControls")); ``` The output may look something like this: *1.2.826.0.1.3344810.2.3 04* **UseDefaultDC**: Whether to connect to the default Domain Controller when calling Bind.If this configuration setting is set to True, [ServerName](#servername-property-ldap-component) does not need to be set before calling [Bind](#bind-method-ldap-component) in Active Directory domains. When True, the component will query the system for the default domain controller and attempt to establish a connection with that server. NOTE: This functionality is available only in Windows. NOTE: This functionality is not available in Java. ### TCPClient Config Settings **CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True. **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use [Timeout](#timeout-property-ldap-component) for establishing a connection and transmitting/receiving data. **EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and RemoteHost resolves to more than one address, the component will try the remaining addresses in turn if the connection to the first one fails, and only throws an exception once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent. NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved. This setting must be set before the connection is established. The default value for this setting is False. **FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the component will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout. NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the [Connected](#connected-property-ldap-component) operation as a whole. **FirewallAutoDetect**: Tells the component whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by components that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallListener**: If true, the component binds to a SOCKS firewall as a server (TCPClient only).This entry is for TCPClient only and does not work for other components that descend from TCPClient. If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case. RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the [ConnectionStatus](#connectionstatus-event-ldap-component) event. The connection to the firewall is made by calling the [Connect](#connect-method-ldap-component) method. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by components that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-ldap-component) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. If the component is connected, the [LocalHost](#localhost-property-ldap-component) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the component binds. This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the component will use IPv4 exclusively. When set to *1*, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-ldap-component) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the component does not attempt to process external events. **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *true*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to *true*. Setting this configuration setting to *true* tells the component to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. NOTE: This setting is static. The value set is applicable to all components used in the application. When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file. # Trappable Errors ([LDAP](#ldap-component) Component) ### LDAP Errors | | | | --- | --- | | 118 | Firewall error. Error message contains detailed description. | | 301 | Index out of range. | | 331 | Bad attribute index. | | 334 | Busy executing current method. | | 335 | Error in search filter. | | 336 | Protocol error. | The component may also return one of the following error codes, which are inherited from other components. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-ldap-component) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the component is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 303 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |