LDAP4D Directory - Protocol Handling

• LDAPD_BindResponse
• LDAPD_GetMessageID
• LDAPD_ParseBindRequest
• LDAPD_ParseSearchRequest
• LDAPD_SearchResultEntry
• LDAPD_SearchResultDone
  

About this section...

This section describes the methods used to perform selected protocol operations specified in RFC 2251.
These methods generate or parse BER encoded content that can be used with LDAP_Message_Send to request an action from an LDAP server.

To simplify usage and development of this component many aspects of LDAP v3 are not implemented. Primarily, LDAP4D Directory is designed to return search results for email clients.

LDAPD_BindResponse

Syntax:

blob := LDAPD_BindResponse ( iResultCode:LI ; tMatchedDN:T  tErrorMessage:T )

Description:

Create a BER encoded bind response.

Warning:

Note:

SASL Authentication option is NOT supported. See See RFC 2251 4.1.10.

Params:

Example:

$oBlob := LDAPD_BindResponse(0;$tPassword;"Woohoo! Success")

LDAPD_GetMessageID

Syntax:

messageID := LDAPD_GetMessageID (->blob)

Description:

Get the message ID from an input stream.

Warning:

Note:

The message ID pulled from a SearchRequest should be used when sending results (SearchResultEntry and SearchResDone) back to the client.

Params:

Example:

$iMessageID := LDAPD_GetMessageID(->oBlob)

LDAPD_ParseBindRequest

Syntax:

result := LDAP_ParseBindRequest (->oBlob)

Description:

Given a presumed BER encoded blob, pull out an expected BindRequest

Warning:

Note:

Generally called from one of the request handlers.
Check LDAPD_tResultErrorMessage on failure.

Params:

In/Out	Parameter	Type		Example or note
->	inputStream	Pointer	Pointer to blob received via LDAPD_TCP_Receive
<-	result	Boolean	Success or failure (0 or 1)

Example:

$flag := LDAPD_ParseBindRequest (->oBlob)

LDAPD_ParseSearchRequest

Syntax:

$flag := LDAPD_ParseSearchRequest ( pBlob:P; pAttributeNames:P; pAttributeFieldPointers:P; pSearchAttributes:P;  pSearchValues:P; pSearchOperators:P; pAttributeModifiers:P; pRequestedAttributes:P  )

Description:

Warning:

Note:

Generally called from one of the request handlers.

If successful, LDAP_SearchFilter will be populated.
On failure check LDAPD_tResultErrorMessage .

SearchValues will be paired with SearchAttributes. SearchOperators will correspond with values in the LDAP_SearchFilter and will have the following values "and", "or", "not".
AttributeFieldPointers will be set to those that match fields set in LDAPDu_MapFields.
Attribute Modifiers will have the following values "initial", "any", "final", ">=", "<=", "present", "approxMatch". They are used to create the appropriate SQL search statement.
Requested Attributes will be checked against AttributeNames set in LDAPDu_MapFields.

Params:

Example:

$flag :=LDAPD_ParseSearchRequest(->oBlob)

LDAPD_SearchResultEntry

Syntax:

result := LDAPD_SearchResultEntry ( distinguishedName;T ; pAttributeTypes:P ; pAttributeValues:P )

Description:

Create a BER encoded LDAP SearchResultEntry that can then be bundled into an LDAP message and sent back to requesting client.

Warning:

Note:

  `$1 = text = distinguished name
  `$2 = pointer = pointer to text array of attribute names
  `$3 = pointer = pointer to text array of attribute values

The arrays of attribute names and attribute values must be of the same length.
The Distinguished name's fomat is probably not going to be validated anywhere, so you can use what you like. FWIW, there exists RFC 4514:  String Representation of Distinguished Names .
When returning multiple results finish them off with an LDAPD_SearchResultDone.

Params:

Example:

$tText :=LDAPD_SearchResultEntry("uid=tswenson, o=dogboy";->at_attributeArray;->at_attributeValues)

LDAPD_SearchResultDone

Syntax:

blob := LDAPD_SearchResultDone ( distinguishedName;T )

Description:

Create a BER encoded SearchResDone message content.

Warning:

Note:

 Send this with LDAPD_MessageSend

Params:

Example:

$blob := LDAP_SearchResultDone($tDN;"some made up DN";"")