IP*Works! SSL ldaps Component : ldaps OCX, ldaps .NET Component, ldaps Class, ldaps Bean, ldaps Object

Available in: SSH | SSL

LDAPS Component [IP*Works! SSL V8]

Properties Methods Events Configuration Settings

The LDAPS component is used to communicate with LDAP Directory Servers using the LDAP (Lightweight Directory Access) protocol.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The LDAPS component is the SSL-enabled equivalent of the IP*Works! LDAP component. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The SSLProvider configuration setting chooses a security provider subsystem. The SSLEnabledProtocols and SSLCipherStrength configuration settings determine which protocols are enabled and at what security level. The property is used to select a client certificate if the server is requesting client authentication. The SSLSecurityFlags configuration setting, together with the event allow you to check the server identity and other security attributes. Finally, the event provides information about the SSL handshake.

The LDAPS 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 , a (Distinguished Name) to bind as, and optionally a . Then you can call one or more of the component methods to act upon the server. Server responses are normally received through the event. The only exception are search requests which result in one or more events, followed by a final event.

Attributes are set and returned through the properties . Other command arguments are specified through other properties. These are specified in detail in each method.

Search filters are to be specified as string arguments to the method. The format must be a standard LDAP search string as specified in RFC 1558. Other search attributes are set in properties such as , , , , and .

The component operates synchronously by default (waits for a response before returning control to the caller), however, the component may also operate asynchronously (return control immediately), by setting to 0. Please refer to the 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	Enables or disables data reception from the server.
Attributes	Attributes for the current entry.
Connected	Shows whether the component is connected.
DeleteOldRDN	Controls whether the old RDN (Relative Distinguished Name) should be deleted.
DN	The Distinguished Name used as the base for LDAP operations.
Firewall	A set of properties related to firewall access.
Idle	The current status of the component.
LDAPVersion	The version of LDAP used.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MessageId	The message id for the next LDAP request.
PageSize	The maximum number of results per page for the Search method.
Password	The password used to authenticate to the LDAP server.
References	Collection of References returned from the server.
ResultCode	The result code returned in the last server response.
ResultDescription	The descriptive text returned in the last server response (if any).
ResultDN	The Distinguished Name returned in the last server response (if any).
SearchDerefAliases	Controls alias dereferencing during searching.
SearchReturnValues	Controls whether the search operation returns values of attributes, or only types.
SearchScope	Controls the scope of LDAP search operations.
SearchSizeLimit	Maximum number of entries that can be returned by the next search operation.
SearchTimeLimit	A time limit for the next search operation (in seconds).
ServerName	The name or address of the LDAP server.
ServerPort	The server port for the LDAP connection (default is 389).
SortAttributes	A string of attribute names to sort on with optional relative matching rules.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during ssl negotiation.
SSLServerCert	The server certificate for the last established connection.
SSLStartMode	Determines how the component starts the SSL negotiation.
Timeout	A 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	Ask the server to abandon a request.
Add	Add an entry specified by DN to the directory server using the type and value attributes defined in Attributes properties .
Attr	Returns the value of the specified ldap attribute.
Bind	Connect and bind to the directory server.
Compare	Compare attributes and values with those of the entry specified by DN .
Config	Sets or retrieves a configuration setting.
CopyToDN	Performs an LDAP 'modify' operation on the entry specified by DN by duplicating it.
Delete	Delete an entry specified by DN from the directory server.
DoEvents	Processes events from the internal message queue.
ExtendedRequest	Perform an LDAP V3 Extended Operation.
Interrupt	Interrupt the current method.
Modify	Perform an LDAP 'modify' operation on the entry specified by DN .
ModifyRDN	Perform an LDAP 'modify RDN' operation an entry specified by DN .
MoveToDN	Performs an LDAP 'modify' operation on the entry specified by DN by changing its superior.
Search	Search the directory server using the base object specified in DN and the search filter SearchFilter .
Unbind	Unbind 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.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
Disconnected	Fired when a connection is closed.
Error	Information about errors during data delivery.
ExtendedResponse	Fired for LDAP V3 Extended Responses.
Result	Fired for every server response, except search responses.
SearchComplete	Fired upon completion of a search operation.
SearchPage	Fired for every page returned from a search operation.
SearchResult	Fired for every entry returned from a search operation.
SearchResultReference	Fired for every result reference returned from a search operation.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.

Configuration Settings

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


MaxAttributes	Instructs component to save the amount of attributes specified that are returned by the server.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
TcpNoDelay	Whether or not to delay when sending packets
AcceptAnyServerCert	If set the component will accept any certificate presented by the server
SSLProvider	The name of the security provider to use.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLSecurityFlags	Flags that control certificate verification
ReuseSSLSession	Determines if the SSL session is reused.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator(PRNG).
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCADir	The path to a directory containing CA certificates.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).