LDAP Component
Properties Methods Events Config Settings Errors
The Lightweight Directory Access Protocol (LDAP) Component is used to search, manage, and maintain internet directory servers.
Syntax
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 event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config 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, a DN (distinguished name) to bind as, and optionally a Password. Then you can call one or more of the component methods to act upon the server. Server responses normally are received through the Result event. The only exceptions are search requests that result in one or more SearchResult events, followed by a final SearchComplete event.
Attributes are set and returned through the Attributes 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 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, SearchTimeLimit, SearchSizeLimit, SearchReturnValues, and SearchDerefAliases.
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 to 0. Please refer to the Timeout 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 | This property indicates whether data reception is currently enabled. |
Attributes | This property includes the attributes for the current entry. |
AuthMechanism | This property is the authentication mechanism to be used when connecting to the Lightweight Directory Access Protocol (LDAP) server. |
Connected | This property shows whether the component is connected. |
DeleteOldRDN | This property controls whether the old RDN (Relative Distinguished Name) should be deleted. |
DN | This property includes the distinguished name used as the base for Lightweight Directory Access Protocol (LDAP) operations. |
Firewall | A set of properties related to firewall access. |
Idle | This property specifies the current status of the component. |
LDAPVersion | The version of the Lightweight Directory Access Protocol (LDAP) used. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MessageId | This property includes the message identifier for the next Lightweight Directory Access Protocol (LDAP) request. |
PageSize | This property includes the maximum number of results per page for the Search method. |
Password | This property includes the password used to authenticate to the Lightweight Directory Access Protocol (LDAP) server. |
References | This property includes a collection of references returned from the server. |
ResultCode | This property includes the result code returned in the last server response. |
ResultDescription | This property includes the descriptive text returned in the last server response (if any). |
ResultDN | This property includes the distinguished name returned in the last server response (if any). |
SearchDerefAliases | This property controls alias dereferencing during searching. |
SearchReturnValues | This property controls whether the search operation returns values of attributes or only types. |
SearchScope | This property controls the scope of Lightweight Directory Access Protocol (LDAP) search operations. |
SearchSizeLimit | This property includes the maximum number of entries that can be returned by the next search operation. |
SearchTimeLimit | This property includes a time limit for the next search operation (in seconds). |
ServerName | This property includes the name or address of the Lightweight Directory Access Protocol (LDAP) server. |
ServerPort | This property includes the server port for the Lightweight Directory Access Protocol (LDAP) connection (the default is 389). |
SortAttributes | This property includes a string of attribute names to sort on with optional relative matching rules. |
SSLAcceptServerCert | This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLEnabled | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
SSLStartMode | This property determines how the component starts the Secure Sockets Layer (SSL) negotiation. |
Timeout | 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 | This method asks the server to abandon a request. |
Add | This method adds an entry specified by DN to the directory server using the type and value attributes defined in the Attributes properties. |
Attr | This method returns the value of the specified Lightweight Directory Access Protocol (LDAP) attribute. |
Bind | This method connects and binds to the directory server. |
ChangePassword | This method changes the password for the specified user. |
Compare | This method compares attributes and values with those of the entry specified by DN . |
Config | Sets or retrieves a configuration setting. |
Connect | This method connects to the directory server without performing any action. |
Delete | Deletes an entry specified by DN from the directory server. |
DoEvents | This method processes events from the internal message queue. |
ExtendedRequest | This method performs a Lightweight Directory Access Protocol (LDAP) V3 extended operation. |
Interrupt | This method interrupts the current method. |
ListComputers | This method lists all computers in the directory. |
ListGroupMembers | This method lists all members of a group. |
ListGroups | This method list all groups in the directory. |
ListUserGroups | This method lists all groups a user is a part of. |
Modify | This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN . |
ModifyRDN | This method performs a Lightweight Directory Access Protocol (LDAP) modify RDN operation on an entry specified by DN . |
MoveToDN | This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN by changing its superior. |
PauseData | This method pauses data reception. |
ProcessData | This method re-enables data reception after a call to PauseData . |
Reset | This method will reset the component. |
Search | This method searches the directory server using the base object specified in DN and the search filter SearchFilter . |
Unbind | 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 | This event is fired for each computer entry returned. |
Connected | This event is fired immediately after a connection completes (or fails). |
ConnectionStatus | This event is fired to indicate changes in the connection state. |
Disconnected | This event is fired when a connection is closed. |
Error | Fired when information is available about errors during data delivery. |
ExtendedResponse | This event is fired for Lightweight Directory Access Protocol (LDAP) V3 extended responses. |
GroupList | This event is fired for each group entry returned. |
PITrail | This event provides detailed information about the interaction with the server. |
Result | This event is fired for every server response, except for search responses. |
SearchComplete | This event is fired upon completion of a search operation. |
SearchPage | This event is fired for every page returned from a search operation. |
SearchResult | This event is fired for every entry returned from a search operation. |
SearchResultReference | This event is fired for every result reference returned from a search operation. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
UserList | 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 | Returns the name of the domain controller. |
FriendlyGUID | Whether to return GUID attribute values in a human readable format. |
FriendlySID | Whether to return SID attribute values in a human readable format. |
MaxAttributes | Instructs component to save the amount of attributes specified that are returned by the server. |
RequestControls | Controls to include in the request. |
ResponseControls | Controls present in the response. |
UseDefaultDC | Whether to connect to the default Domain Controller when calling Bind. |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the component binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AcceptData Property (LDAP Component)
This property indicates whether data reception is currently enabled.
Syntax
Default Value
True
Remarks
This property indicates whether data reception is currently enabled. When false, data reception is disabled. Use the PauseData and ProcessData methods to pause and resume data reception.
This property is read-only and not available at design time.
Attributes Property (LDAP Component)
This property includes the attributes for the current entry.
Syntax
public LDAPAttributeList Attributes { get; }
Public Property Attributes As LDAPAttributeList
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 type.
After a Search, this property will be populated with the attributes of each search result and can be read within the SearchResult event (one event for each resulting DN).
During a Lightweight Directory Access Protocol (LDAP) Modify 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 type for a complete list of fields.AuthMechanism Property (LDAP Component)
This property is the authentication mechanism to be used when connecting to the Lightweight Directory Access Protocol (LDAP) server.
Syntax
public LDAPAuthMechanisms AuthMechanism { get; set; }
enum LDAPAuthMechanisms { lamSimple, lamDigestMD5, lamNegotiate, lamKerberos, lamSASLExternal }
Public Property AuthMechanism As LdapAuthMechanisms
Enum LDAPAuthMechanisms lamSimple lamDigestMD5 lamNegotiate lamKerberos lamSASLExternal End Enum
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 Component)
This property shows whether the component is connected.
Syntax
Default Value
False
Remarks
This property is used to determine whether or not the component is connected to the remote host. Use the Bind and Unbind methods to manage the connection.
This property is read-only and not available at design time.
DeleteOldRDN Property (LDAP Component)
This property controls whether the old RDN (Relative Distinguished Name) should be deleted.
Syntax
Default Value
True
Remarks
This property controls whether the old RDN should be deleted. It is used when ModifyRDN 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 Component)
This property includes the distinguished name used as the base for Lightweight Directory Access Protocol (LDAP) operations.
Syntax
Default Value
""
Remarks
This also includes the base object during LDAP searches.
The distinguished name is provided in string format, as specified by RFC 1779. Example. Setting DN:
LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server"
LDAPControl.DN = "Domain\Username"
Firewall Property (LDAP Component)
A set of properties related to firewall access.
Syntax
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.
Please refer to the Firewall type for a complete list of fields.Idle Property (LDAP Component)
This property specifies the current status of the component.
Syntax
Default Value
True
Remarks
Idle 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 Component)
The version of the Lightweight Directory Access Protocol (LDAP) used.
Syntax
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 Component)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
Default Value
""
Remarks
The LocalHost 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 Component)
This property includes the message identifier for the next Lightweight Directory Access Protocol (LDAP) request.
Syntax
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 Component)
This property includes the maximum number of results per page for the Search method.
Syntax
Default Value
0
Remarks
This property contains the maximum number of results per page for the Search method. The default value is 0 (no paging). If set to a value greater than zero, results will be paged, that is, returned in blocks of maximum PageSize results.
For each page sent by the server, a SearchPage 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 Component)
This property includes the password used to authenticate to the Lightweight Directory Access Protocol (LDAP) server.
Syntax
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 Component)
This property includes a collection of references returned from the server.
Syntax
public LDAPReferenceList References { get; }
Public ReadOnly Property References As LDAPReferenceList
Remarks
This property contains a collection of references returned from the server. References will be SearchResult references if inside a SearchResult or SearchResultReference event. In this case, they represent URLs to contact to continue the search. References will be regular result references if inside the Result event or SearchComplete 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 type for a complete list of fields.ResultCode Property (LDAP Component)
This property includes the result code returned in the last server response.
Syntax
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, SearchResult, or SearchComplete 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 Component)
This property includes the descriptive text returned in the last server response (if any).
Syntax
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, SearchResult, or SearchComplete event.
This property is read-only.
ResultDN Property (LDAP Component)
This property includes the distinguished name returned in the last server response (if any).
Syntax
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 or SearchComplete event.
This property is read-only.
SearchDerefAliases Property (LDAP Component)
This property controls alias dereferencing during searching.
Syntax
public LDAPSearchDerefAliases SearchDerefAliases { get; set; }
enum LDAPSearchDerefAliases { sdaNever, sdaInSearching, sdaFindingBaseObject, sdaAlways }
Public Property SearchDerefAliases As LdapSearchDerefAliases
Enum LDAPSearchDerefAliases sdaNever sdaInSearching sdaFindingBaseObject sdaAlways End Enum
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 Component)
This property controls whether the search operation returns values of attributes or only types.
Syntax
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 Component)
This property controls the scope of Lightweight Directory Access Protocol (LDAP) search operations.
Syntax
public LDAPSearchScopes SearchScope { get; set; }
enum LDAPSearchScopes { ssBaseObject, ssSingleLevel, ssWholeSubtree }
Public Property SearchScope As LdapSearchScopes
Enum LDAPSearchScopes ssBaseObject ssSingleLevel ssWholeSubtree End Enum
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 Component)
This property includes the maximum number of entries that can be returned by the next search operation.
Syntax
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 Component)
This property includes a time limit for the next search operation (in seconds).
Syntax
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 Component)
This property includes the name or address of the Lightweight Directory Access Protocol (LDAP) server.
Syntax
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 Component)
This property includes the server port for the Lightweight Directory Access Protocol (LDAP) connection (the default is 389).
Syntax
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 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 Component)
This property includes a string of attribute names to sort on with optional relative matching rules.
Syntax
Default Value
""
Remarks
This property contains a string of attribute names to sort on with optional relative matching rules. When set before a Search, entries returned by the server will be sorted according to 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:
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 |
1.3.6.1.4.1.1466.115.121.1.24 | generalizedTimeOrderingMatch |
1.3.6.1.4.1.1466.115.121.1.15 | caseIgnoreOrderingMatch |
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 |
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 Component)
This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate SSLAcceptServerCert { get; set; }
Public Property SSLAcceptServerCert As Certificate
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 type for a complete list of fields.SSLCert Property (LDAP Component)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate
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 field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLEnabled Property (LDAP Component)
This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
Syntax
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. Setting SSLStartMode will automatically update this property value.
This property is not available at design time.
SSLProvider Property (LDAP Component)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public LDAPSSLProviders SSLProvider { get; set; }
enum LDAPSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As LdapSSLProviders
Enum LDAPSSLProviders sslpAutomatic sslpPlatform sslpInternal End Enum
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. |
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, the internal implementation is used on all platforms.
The .NET Standard library will always use the internal implementation on all platforms.
SSLServerCert Property (LDAP Component)
This property includes the server certificate for the last established connection.
Syntax
public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate
Remarks
SSLServerCert 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 type for a complete list of fields.SSLStartMode Property (LDAP Component)
This property determines how the component starts the Secure Sockets Layer (SSL) negotiation.
Syntax
public LDAPSSLStartModes SSLStartMode { get; set; }
enum LDAPSSLStartModes { sslAutomatic, sslImplicit, sslExplicit, sslNone }
Public Property SSLStartMode As LdapSSLStartModes
Enum LDAPSSLStartModes sslAutomatic sslImplicit sslExplicit sslNone End Enum
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 Component)
This property includes the timeout for the component.
Syntax
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 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 Component)
This method asks the server to abandon a request.
Syntax
public void Abandon(int messageId); Async Version public async Task Abandon(int messageId); public async Task Abandon(int messageId, CancellationToken cancellationToken);
Public Sub Abandon(ByVal MessageId As Integer) Async Version Public Sub Abandon(ByVal MessageId As Integer) As Task Public Sub Abandon(ByVal MessageId As Integer, cancellationToken As CancellationToken) As Task
Remarks
This method asks the server to abandon the request specified by MessageId. The result of the operation is returned through the Result event.
Add Method (LDAP Component)
This method adds an entry specified by DN to the directory server using the type and value attributes defined in the Attributes properties.
Syntax
public void Add(); Async Version public async Task Add(); public async Task Add(CancellationToken cancellationToken);
Public Sub Add() Async Version Public Sub Add() As Task Public Sub Add(cancellationToken As CancellationToken) As Task
Remarks
This method adds the entry specified by DN to the directory. All entries are required to have an objectClass attribute.
To add a new entry, first Bind with credentials that will allow you to perform the new addition. To add attributes instead of entries, use the Modify method instead. When specifying multivalued attributes, specify the attribute type only in the first occurrence of that attribute type in the Attributes 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 event.
Example. Add a New Entry (including the multivalued objectClass attribute):
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 Component)
This method returns the value of the specified Lightweight Directory Access Protocol (LDAP) attribute.
Syntax
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 collection for more information.
Bind Method (LDAP Component)
This method connects and binds to the directory server.
Syntax
public void Bind(); Async Version public async Task Bind(); public async Task Bind(CancellationToken cancellationToken);
Public Sub Bind() Async Version Public Sub Bind() As Task Public Sub Bind(cancellationToken As CancellationToken) As Task
Remarks
This method connects and binds to the directory server. If the Password property has a value, it is used for authentication. If not, the bind is performed anonymously. Binding is often required on some directory servers, like Active Directory. The result of the operation is returned through the Result event.
Example. Binding:
LDAPControl.DN = "uid=TThompson,ou=Employees,dc=server"
LDAPControl.Password = "mypassword"
LDAPControl.Bind()
LDAPControl.DN = "Domain/Username"
LDAPControl.Password = "mypassword"
LDAPControl.Bind()
ChangePassword Method (LDAP Component)
This method changes the password for the specified user.
Syntax
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);
Public Sub ChangePassword(ByVal user As String, ByVal oldPassword As String, ByVal newPassword As String) Async Version Public Sub ChangePassword(ByVal user As String, ByVal oldPassword As String, ByVal newPassword As String) As Task Public Sub ChangePassword(ByVal user As String, ByVal oldPassword As String, ByVal newPassword As String, cancellationToken As CancellationToken) As Task
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 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 Component)
This method compares attributes and values with those of the entry specified by DN .
Syntax
public void Compare(); Async Version public async Task Compare(); public async Task Compare(CancellationToken cancellationToken);
Public Sub Compare() Async Version Public Sub Compare() As Task Public Sub Compare(cancellationToken As CancellationToken) As Task
Remarks
This method compares attribute types and values specified via the Attributes collection, with the values in the directory for the entry specified by DN. The result of the operation is returned through the Result event.
Config Method (LDAP Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.
Connect Method (LDAP Component)
This method connects to the directory server without performing any action.
Syntax
public void Connect(); Async Version public async Task Connect(); public async Task Connect(CancellationToken cancellationToken);
Public Sub Connect() Async Version Public Sub Connect() As Task Public Sub Connect(cancellationToken As CancellationToken) As Task
Remarks
This method establishes a connection with the directory server specified by ServerName. In most cases, it is recommended to use the Bind method, which will both establish a connection and bind to the directory server.
This method may be useful in cases in which it is desirable to establish a connection without performing any operation (e.g., when testing connectivity).
Delete Method (LDAP Component)
Deletes an entry specified by DN from the directory server.
Syntax
public void Delete(); Async Version public async Task Delete(); public async Task Delete(CancellationToken cancellationToken);
Public Sub Delete() Async Version Public Sub Delete() As Task Public Sub Delete(cancellationToken As CancellationToken) As Task
Remarks
This method deletes the entry specified by DN from the directory. The result of the operation is returned through the Result event.
DoEvents Method (LDAP Component)
This method processes events from the internal message queue.
Syntax
public void DoEvents(); Async Version public async Task DoEvents(); public async Task DoEvents(CancellationToken cancellationToken);
Public Sub DoEvents() Async Version Public Sub DoEvents() As Task Public Sub DoEvents(cancellationToken As CancellationToken) As Task
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 Component)
This method performs a Lightweight Directory Access Protocol (LDAP) V3 extended operation.
Syntax
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);
Public Sub ExtendedRequest(ByVal RequestName As String, ByVal RequestValue As String) Async Version Public Sub ExtendedRequest(ByVal RequestName As String, ByVal RequestValue As String) As Task Public Sub ExtendedRequest(ByVal RequestName As String, ByVal RequestValue As String, cancellationToken As CancellationToken) As Task
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 Component)
This method interrupts the current method.
Syntax
public void Interrupt(); Async Version public async Task Interrupt(); public async Task Interrupt(CancellationToken cancellationToken);
Public Sub Interrupt() Async Version Public Sub Interrupt() As Task Public Sub Interrupt(cancellationToken As CancellationToken) As Task
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListComputers Method (LDAP Component)
This method lists all computers in the directory.
Syntax
public void ListComputers(); Async Version public async Task ListComputers(); public async Task ListComputers(CancellationToken cancellationToken);
Public Sub ListComputers() Async Version Public Sub ListComputers() As Task Public Sub ListComputers(cancellationToken As CancellationToken) As Task
Remarks
This method lists all computers in the directory. The ComputerList event will be fired once for each computer returned.
ListGroupMembers Method (LDAP Component)
This method lists all members of a group.
Syntax
public void ListGroupMembers(string group); Async Version public async Task ListGroupMembers(string group); public async Task ListGroupMembers(string group, CancellationToken cancellationToken);
Public Sub ListGroupMembers(ByVal group As String) Async Version Public Sub ListGroupMembers(ByVal group As String) As Task Public Sub ListGroupMembers(ByVal group As String, cancellationToken As CancellationToken) As Task
Remarks
This method lists all members of the specified group. The UserList event will be fired once for each member returned.
ListGroups Method (LDAP Component)
This method list all groups in the directory.
Syntax
public void ListGroups(); Async Version public async Task ListGroups(); public async Task ListGroups(CancellationToken cancellationToken);
Public Sub ListGroups() Async Version Public Sub ListGroups() As Task Public Sub ListGroups(cancellationToken As CancellationToken) As Task
Remarks
This method lists all groups in the directory. The GroupList event will be fired once for each group returned.
ListUserGroups Method (LDAP Component)
This method lists all groups a user is a part of.
Syntax
public void ListUserGroups(string user); Async Version public async Task ListUserGroups(string user); public async Task ListUserGroups(string user, CancellationToken cancellationToken);
Public Sub ListUserGroups(ByVal user As String) Async Version Public Sub ListUserGroups(ByVal user As String) As Task Public Sub ListUserGroups(ByVal user As String, cancellationToken As CancellationToken) As Task
Remarks
This method lists all groups that the user specified by user is a part of. The GroupList event will fire once for each group the user is a part of.
Modify Method (LDAP Component)
This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN .
Syntax
public void Modify(); Async Version public async Task Modify(); public async Task Modify(CancellationToken cancellationToken);
Public Sub Modify() Async Version Public Sub Modify() As Task Public Sub Modify(cancellationToken As CancellationToken) As Task
Remarks
This method performs an LDAP modify operation on the entry specified by DN. The attributes to modify should be set via the Attributes collection. When specifying multivalued attributes, specify the attribute type only in the first occurrence of that attribute type in the Attributes 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 event.
Example. Modify an Entry (Replace an Attribute Value):
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 Component)
This method performs a Lightweight Directory Access Protocol (LDAP) modify RDN operation on an entry specified by DN .
Syntax
public void ModifyRDN(string newRDN); Async Version public async Task ModifyRDN(string newRDN); public async Task ModifyRDN(string newRDN, CancellationToken cancellationToken);
Public Sub ModifyRDN(ByVal NewRDN As String) Async Version Public Sub ModifyRDN(ByVal NewRDN As String) As Task Public Sub ModifyRDN(ByVal NewRDN As String, cancellationToken As CancellationToken) As Task
Remarks
This method performs an LDAP modify RDN operation on the entry specified by DN.
NewRDN is the new RDN for the entry specified by DN
The result of the operation is returned through the Result event.
MoveToDN Method (LDAP Component)
This method performs a Lightweight Directory Access Protocol (LDAP) modify operation on the entry specified by DN by changing its superior.
Syntax
public void MoveToDN(string newSuperior); Async Version public async Task MoveToDN(string newSuperior); public async Task MoveToDN(string newSuperior, CancellationToken cancellationToken);
Public Sub MoveToDN(ByVal NewSuperior As String) Async Version Public Sub MoveToDN(ByVal NewSuperior As String) As Task Public Sub MoveToDN(ByVal NewSuperior As String, cancellationToken As CancellationToken) As Task
Remarks
This method performs an LDAP modify operation on the entry specified by DN by changing its superior.
Note: None of the entry's attributes will change. DeleteOldRDN property will be set to True to delete the old entry. The result of the operation is returned through the Result event.
PauseData Method (LDAP Component)
This method pauses data reception.
Syntax
public void PauseData(); Async Version public async Task PauseData(); public async Task PauseData(CancellationToken cancellationToken);
Public Sub PauseData() Async Version Public Sub PauseData() As Task Public Sub PauseData(cancellationToken As CancellationToken) As Task
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 to re-enable data reception.
ProcessData Method (LDAP Component)
This method re-enables data reception after a call to PauseData .
Syntax
public void ProcessData(); Async Version public async Task ProcessData(); public async Task ProcessData(CancellationToken cancellationToken);
Public Sub ProcessData() Async Version Public Sub ProcessData() As Task Public Sub ProcessData(cancellationToken As CancellationToken) As Task
Remarks
This method re-enables data reception after a previous call to PauseData. Call this method to re-enable data reception and allow IPPacket to fire.
Note: This method is used only after previously calling PauseData. It does not need to be called to process data by default.
Reset Method (LDAP Component)
This method will reset the component.
Syntax
public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset() Async Version Public Sub Reset() As Task Public Sub Reset(cancellationToken As CancellationToken) As Task
Remarks
This method will reset the component's properties to their default values.
Search Method (LDAP Component)
This method searches the directory server using the base object specified in DN and the search filter SearchFilter .
Syntax
public void Search(string searchFilter); Async Version public async Task Search(string searchFilter); public async Task Search(string searchFilter, CancellationToken cancellationToken);
Public Sub Search(ByVal SearchFilter As String) Async Version Public Sub Search(ByVal SearchFilter As String) As Task Public Sub Search(ByVal SearchFilter As String, cancellationToken As CancellationToken) As Task
Remarks
This method searches the directory server using the base object specified in the DN and the search filter specified in the SearchFilter parameter. Additional search parameters are specified through the SearchScope, SearchDerefAliases, SearchSizeLimit, SearchTimeLimit, and SearchReturnValues properties.
If Attributes are specified before starting a search, the server will return only those results that contain a value for the specified attributes.
Results are returned through zero or more SearchResult events, after which a SearchComplete event is fired.
Example 1. Searching for a User:
LDAPControl.DN = "ou=Employees,dc=server"
LDAPControl.Search("uid=TThompson")
A Directory-Specific Entries (DSE) search will search for the attributes of the server. Example 2. DSE Search:
LDAPControl.DN = ""
LDAPControl.SearchScope = 0
LDAPControl.Search("objectClass=*")
SearchFilter is a string representation of the Lightweight Directory Access Protocol (LDAP) search filter used for the search.
The format of the search filter is specified by RFC 1558 and is identical to the format used by most LDAP applications.
The following are examples of search filters, as provided in the RFC:
Example 3. Search Filters:
(cn=Babs Jensen) (!(cn=Tim Howes)) (&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*))) (o=univ*of*mich*)
The complete specification is given by the following BNF:
<filter> ::= "(" <filtercomp> ")" <filtercomp> ::= <and> | <or> | <not> | <item> <and> ::= "&" <filterlist> <or> ::= "|" <filterlist> <not> ::= "!" <filter> <filterlist> ::= <filter> | <filter> <filterlist> <item> ::= <simple> | <present> | <substring> <simple> ::= <attr> <filtertype> <value> <filtertype> ::= <equal> | <approx> | <greater> | <less> <equal> ::= "=" <approx> ::= "~=" <greater> ::= ">=" <less> ::= "<=" <present> ::= <attr> "=*" <substring> ::= <attr> "=" <initial> <any> <final> <initial> ::= NULL | <value> <any> ::= "*" <starval> <starval> ::= NULL | <value> "*" <starval> <final> ::= NULL | <value>
<attr> is a string representing an attribute type as defined in RFC 1777. <value> is a string representing an attribute value, or part of one, and has the form defined in RFC 1779. If a <value> must contain one of the characters '*' or '(' or ')', these should be escaped by preceding them with the backslash '\' character.
Unbind Method (LDAP Component)
This method unbinds from the directory server.
Syntax
public void Unbind(); Async Version public async Task Unbind(); public async Task Unbind(CancellationToken cancellationToken);
Public Sub Unbind() Async Version Public Sub Unbind() As Task Public Sub Unbind(cancellationToken As CancellationToken) As Task
Remarks
This method unbinds from the directory server and breaks the connection.
ComputerList Event (LDAP Component)
This event is fired for each computer entry returned.
Syntax
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; } }
Public Event OnComputerList As OnComputerListHandler Public Delegate Sub OnComputerListHandler(sender As Object, e As LDAPComputerListEventArgs) Public Class LDAPComputerListEventArgs Inherits EventArgs Public ReadOnly Property name As String Public ReadOnly Property operatingSystem As String Public ReadOnly Property lastLogon As String Public ReadOnly Property logonCount As Integer Public ReadOnly Property dn As String End Class
Remarks
This event is fired once for each computer returned when the ListComputers method is called.
Connected Event (LDAP Component)
This event is fired immediately after a connection completes (or fails).
Syntax
public event OnConnectedHandler OnConnected; public delegate void OnConnectedHandler(object sender, LDAPConnectedEventArgs e); public class LDAPConnectedEventArgs : EventArgs { public int StatusCode { get; } public string Description { get; } }
Public Event OnConnected As OnConnectedHandler Public Delegate Sub OnConnectedHandler(sender As Object, e As LDAPConnectedEventArgs) Public Class LDAPConnectedEventArgs Inherits EventArgs Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
Remarks
If the connection is made normally, StatusCode is 0 and Description is "OK".
If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
ConnectionStatus Event (LDAP Component)
This event is fired to indicate changes in the connection state.
Syntax
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; } }
Public Event OnConnectionStatus As OnConnectionStatusHandler Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As LDAPConnectionStatusEventArgs) Public Class LDAPConnectionStatusEventArgs Inherits EventArgs Public ReadOnly Property ConnectionEvent As String Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The ConnectionStatus 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. |
Disconnected Event (LDAP Component)
This event is fired when a connection is closed.
Syntax
public event OnDisconnectedHandler OnDisconnected; public delegate void OnDisconnectedHandler(object sender, LDAPDisconnectedEventArgs e); public class LDAPDisconnectedEventArgs : EventArgs { public int StatusCode { get; } public string Description { get; } }
Public Event OnDisconnected As OnDisconnectedHandler Public Delegate Sub OnDisconnectedHandler(sender As Object, e As LDAPDisconnectedEventArgs) Public Class LDAPDisconnectedEventArgs Inherits EventArgs Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
Remarks
If the connection is broken normally, StatusCode is 0 and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.
Please refer to the Error Codes section for more information.
Error Event (LDAP Component)
Fired when information is available about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, LDAPErrorEventArgs e); public class LDAPErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As LDAPErrorEventArgs) Public Class LDAPErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
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 section.
ExtendedResponse Event (LDAP Component)
This event is fired for Lightweight Directory Access Protocol (LDAP) V3 extended responses.
Syntax
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; } }
Public Event OnExtendedResponse As OnExtendedResponseHandler Public Delegate Sub OnExtendedResponseHandler(sender As Object, e As LDAPExtendedResponseEventArgs) Public Class LDAPExtendedResponseEventArgs Inherits EventArgs Public ReadOnly Property MessageId As Integer Public ReadOnly Property DN As String Public ReadOnly Property ResultCode As Integer Public ReadOnly Property ResultDescription As String Public ReadOnly Property ResponseName As String Public ReadOnly Property ResponseValue As String
Public ReadOnly Property ResponseValueB As Byte() End Class
Remarks
The first four parameters are the same as the parameters of the Result event. ResponseName and ResponseValue are related to the corresponding parameters of the call to ExtendedRequest.
GroupList Event (LDAP Component)
This event is fired for each group entry returned.
Syntax
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; } }
Public Event OnGroupList As OnGroupListHandler Public Delegate Sub OnGroupListHandler(sender As Object, e As LDAPGroupListEventArgs) Public Class LDAPGroupListEventArgs Inherits EventArgs Public ReadOnly Property name As String Public ReadOnly Property description As String Public ReadOnly Property dn As String End Class
Remarks
This event is fired once for each group entry returned when either of the ListGroups or ListUserGroups methods are called.
PITrail Event (LDAP Component)
This event provides detailed information about the interaction with the server.
Syntax
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; } }
Public Event OnPITrail As OnPITrailHandler Public Delegate Sub OnPITrailHandler(sender As Object, e As LDAPPITrailEventArgs) Public Class LDAPPITrailEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer Public ReadOnly Property Description As String Public ReadOnly Property Message As String End Class
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 Component)
This event is fired for every server response, except for search responses.
Syntax
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; } }
Public Event OnResult As OnResultHandler Public Delegate Sub OnResultHandler(sender As Object, e As LDAPResultEventArgs) Public Class LDAPResultEventArgs Inherits EventArgs Public ReadOnly Property MessageId As Integer Public ReadOnly Property DN As String Public ReadOnly Property ResultCode As Integer Public ReadOnly Property ResultDescription As String End Class
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 property.
SearchComplete Event (LDAP Component)
This event is fired upon completion of a search operation.
Syntax
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; } }
Public Event OnSearchComplete As OnSearchCompleteHandler Public Delegate Sub OnSearchCompleteHandler(sender As Object, e As LDAPSearchCompleteEventArgs) Public Class LDAPSearchCompleteEventArgs Inherits EventArgs Public ReadOnly Property MessageId As Integer Public ReadOnly Property DN As String Public ReadOnly Property ResultCode As Integer Public ReadOnly Property ResultDescription As String End Class
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 Component)
This event is fired for every page returned from a search operation.
Syntax
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; } }
Public Event OnSearchPage As OnSearchPageHandler Public Delegate Sub OnSearchPageHandler(sender As Object, e As LDAPSearchPageEventArgs) Public Class LDAPSearchPageEventArgs Inherits EventArgs Public ReadOnly Property MessageId As Integer Public ReadOnly Property DN As String Public ReadOnly Property ResultCode As Integer Public ReadOnly Property ResultDescription As String Public Property CancelSearch As Boolean End Class
Remarks
This event is fired so the client can decide whether or not to continue with the Search operation. The signature is very similar to the SearchComplete 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 Component)
This event is fired for every entry returned from a search operation.
Syntax
public event OnSearchResultHandler OnSearchResult; public delegate void OnSearchResultHandler(object sender, LDAPSearchResultEventArgs e); public class LDAPSearchResultEventArgs : EventArgs { public int MessageId { get; } public string DN { get; } }
Public Event OnSearchResult As OnSearchResultHandler Public Delegate Sub OnSearchResultHandler(sender As Object, e As LDAPSearchResultEventArgs) Public Class LDAPSearchResultEventArgs Inherits EventArgs Public ReadOnly Property MessageId As Integer Public ReadOnly Property DN As String End Class
Remarks
MessageId identifies the corresponding search request. DN contains the distinguished name of the entry. The attribute type and value provided in the Attributes 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 events, which are followed by a SearchComplete event.
SearchResultReference Event (LDAP Component)
This event is fired for every result reference returned from a search operation.
Syntax
public event OnSearchResultReferenceHandler OnSearchResultReference; public delegate void OnSearchResultReferenceHandler(object sender, LDAPSearchResultReferenceEventArgs e); public class LDAPSearchResultReferenceEventArgs : EventArgs { public int MessageId { get; } public string LdapUrl { get; } }
Public Event OnSearchResultReference As OnSearchResultReferenceHandler Public Delegate Sub OnSearchResultReferenceHandler(sender As Object, e As LDAPSearchResultReferenceEventArgs) Public Class LDAPSearchResultReferenceEventArgs Inherits EventArgs Public ReadOnly Property MessageId As Integer Public ReadOnly Property LdapUrl As String End Class
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 events and a sequence of 0 or more SearchResultReference events, which are followed by a SearchComplete event.
SSLServerAuthentication Event (LDAP Component)
Fired after the server presents its certificate to the client.
Syntax
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; } }
Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As LDAPSSLServerAuthenticationEventArgs) Public Class LDAPSSLServerAuthenticationEventArgs Inherits EventArgs Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() Public ReadOnly Property CertSubject As String Public ReadOnly Property CertIssuer As String Public ReadOnly Property Status As String Public Property Accept As Boolean End Class
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 Component)
Fired when secure connection progress messages are available.
Syntax
public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, LDAPSSLStatusEventArgs e); public class LDAPSSLStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnSSLStatus As OnSSLStatusHandler Public Delegate Sub OnSSLStatusHandler(sender As Object, e As LDAPSSLStatusEventArgs) Public Class LDAPSSLStatusEventArgs Inherits EventArgs Public ReadOnly Property Message As String End Class
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
UserList Event (LDAP Component)
This event is fired once for each user entry returned.
Syntax
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; } }
Public Event OnUserList As OnUserListHandler Public Delegate Sub OnUserListHandler(sender As Object, e As LDAPUserListEventArgs) Public Class LDAPUserListEventArgs Inherits EventArgs Public ReadOnly Property name As String Public ReadOnly Property description As String Public ReadOnly Property lastLogon As String Public ReadOnly Property memberOf As String Public ReadOnly Property dn As String End Class
Remarks
This event is fired once for each user entry returned when the ListGroupMembers 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.
Fields
EffectiveDate
string (read-only)
Default: ""
This is 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: ""
This is the date 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: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default: ""
This is 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: ""
This is 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: ""
This is 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: ""
This is 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: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
bool (read-only)
Default: False
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
string (read-only)
Default: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string (read-only)
Default: ""
This field contains 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
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default: ""
This is 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 field contains 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"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the 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"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the 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 property is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default: 0
This is 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:
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, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default: ""
This field contains 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: ""
This field contains 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: ""
This field contains 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: ""
This field contains the text description of UsageFlags.
This value will be of 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
This field contains the flags that show intended use for the certificate. The value of 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 field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
string
Default: ""
This is 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=support@nsoftware.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: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte []
Default: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
public Certificate();
Public Certificate()
Creates a instance whose properties can be set. This is useful for use with when generating new certificates.
public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] encoded);
Public Certificate(ByVal Encoded As Byte())
Parses Encoded as an X.509 public key.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)
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.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
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.
public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())
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.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)
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.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
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.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())
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 and the FirewallType.
Fields
AutoDetect
bool
Default: False
This field tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType
FirewallTypes
Default: 0
This field determines 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 is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
string
Default: ""
This field contains the name or IP address of the firewall (optional). If a 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: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and 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
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
string
Default: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.
Constructors
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 field is used only in Modify operations.
Fields
AttributeType
string
Default: ""
This field contains the attribute type for the current entry.
If the value of AttributeType is an empty string, then the 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.
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 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.
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 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.
Constructors
public LDAPAttribute();
Public LDAPAttribute()
public LDAPAttribute(string attributeType);
Public LDAPAttribute(ByVal AttributeType As String)
public LDAPAttribute(string attributeType, string value);
Public LDAPAttribute(ByVal AttributeType As String, ByVal Value As String)
public LDAPAttribute(string attributeType, string value, LDAPAttributeModOps modOp);
Public LDAPAttribute(ByVal AttributeType As String, ByVal Value As String, ByVal ModOp As LDAPAttributeModOps)
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, SearchResultReference, Result, or SearchComplete events.
When inside a SearchResult or SearchResultReference 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 or SearchComplete event, a reference will be a regular referral, in which case it represents the URL to contact to complete the requested operation.
Fields
URL
string (read-only)
Default: ""
The url of the LDAP reference. If inside a SearchResult or SearchResultReference event, it represents a URL to contact to continue the search. If inside the Result event or SearchComplete event it represents the URL to contact in order to complete the requested operation.
Constructors
public LDAPReference();
Public LDAPReference()
Config Settings (LDAP 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 method.LDAP Config Settings
Note: This functionality is available only in Windows.
Note: This functionality is not available in Java.
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 collection when this configuration is set. This configuration specifies only a maximum for returned attributes.
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:
ldap.Config("RequestControls=1.3.6.1.4.1.42.2.27.8.5.1");
Log(ldap.Config("ResponseControls"));
The output may look something like this:
1.2.826.0.1.3344810.2.3 04
Note: This functionality is available only in Windows.
Note: This functionality is not available in Java.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the 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.
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 event.
The connection to the firewall is made by calling the Connect method.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if 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 is a positive value, the system will attempt to send pending data until the specified 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.
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 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).
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.
If an EOL string is found in the input stream before 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 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 is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
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.
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
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.
- 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.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
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 article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
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.
If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.
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 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 at this time. A connection is in progress. |
112 | You cannot change 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). |