Pike v8.1 release 6
☰

Module Protocols.LDAP

Constant GUID_USERS_CONTAINER
Constant GUID_COMPUTERS_CONTAINER
Constant GUID_SYSTEMS_CONTAINER
Constant GUID_DOMAIN_CONTROLLERS_CONTAINER
Constant GUID_INFRASTRUCTURE_CONTAINER
Constant GUID_DELETED_OBJECTS_CONTAINER
Constant GUID_LOSTANDFOUND_CONTAINER
Constant GUID_FOREIGNSECURITYPRINCIPALS_CONTAINER
Constant GUID_PROGRAM_DATA_CONTAINER
Constant GUID_MICROSOFT_PROGRAM_DATA_CONTAINER
Constant GUID_NTDS_QUOTAS_CONTAINER

constant string Protocols.LDAP.GUID_USERS_CONTAINER
constant string Protocols.LDAP.GUID_COMPUTERS_CONTAINER
constant string Protocols.LDAP.GUID_SYSTEMS_CONTAINER
constant string Protocols.LDAP.GUID_DOMAIN_CONTROLLERS_CONTAINER
constant string Protocols.LDAP.GUID_INFRASTRUCTURE_CONTAINER
constant string Protocols.LDAP.GUID_DELETED_OBJECTS_CONTAINER
constant string Protocols.LDAP.GUID_LOSTANDFOUND_CONTAINER
constant string Protocols.LDAP.GUID_FOREIGNSECURITYPRINCIPALS_CONTAINER
constant string Protocols.LDAP.GUID_PROGRAM_DATA_CONTAINER
constant string Protocols.LDAP.GUID_MICROSOFT_PROGRAM_DATA_CONTAINER
constant string Protocols.LDAP.GUID_NTDS_QUOTAS_CONTAINER

Description

Constants for Microsoft AD Well-Known Object GUIDs. These are e.g. used in LDAP URLs:

"ldap://server/<WKGUID=" + Protocols.LDAP.GUID_USERS_CONTAINER +
  ",dc=my,dc=domain,dc=com>"
Constant LDAP_SUCCESS
Constant LDAP_OPERATIONS_ERROR
Constant LDAP_PROTOCOL_ERROR
Constant LDAP_TIMELIMIT_EXCEEDED
Constant LDAP_SIZELIMIT_EXCEEDED
Constant LDAP_COMPARE_FALSE
Constant LDAP_COMPARE_TRUE
Constant LDAP_AUTH_METHOD_NOT_SUPPORTED
Constant LDAP_STRONG_AUTH_NOT_SUPPORTED
Constant LDAP_STRONG_AUTH_REQUIRED
Constant LDAP_PARTIAL_RESULTS
Constant LDAP_REFERRAL
Constant LDAP_ADMINLIMIT_EXCEEDED
Constant LDAP_UNAVAILABLE_CRITICAL_EXTENSION
Constant LDAP_CONFIDENTIALITY_REQUIRED
Constant LDAP_SASL_BIND_IN_PROGRESS
Constant LDAP_NO_SUCH_ATTRIBUTE
Constant LDAP_UNDEFINED_TYPE
Constant LDAP_INAPPROPRIATE_MATCHING
Constant LDAP_CONSTRAINT_VIOLATION
Constant LDAP_TYPE_OR_VALUE_EXISTS
Constant LDAP_INVALID_SYNTAX
Constant LDAP_NO_SUCH_OBJECT
Constant LDAP_ALIAS_PROBLEM
Constant LDAP_INVALID_DN_SYNTAX
Constant LDAP_IS_LEAF
Constant LDAP_ALIAS_DEREF_PROBLEM
Constant LDAP_INAPPROPRIATE_AUTH
Constant LDAP_INVALID_CREDENTIALS
Constant LDAP_INSUFFICIENT_ACCESS
Constant LDAP_BUSY
Constant LDAP_UNAVAILABLE
Constant LDAP_UNWILLING_TO_PERFORM
Constant LDAP_LOOP_DETECT
Constant LDAP_SORT_CONTROL_MISSING
Constant LDAP_NAMING_VIOLATION
Constant LDAP_OBJECT_CLASS_VIOLATION
Constant LDAP_NOT_ALLOWED_ON_NONLEAF
Constant LDAP_NOT_ALLOWED_ON_RDN
Constant LDAP_ALREADY_EXISTS
Constant LDAP_NO_OBJECT_CLASS_MODS
Constant LDAP_RESULTS_TOO_LARGE
Constant LDAP_AFFECTS_MULTIPLE_DSAS
Constant LDAP_OTHER

constant int Protocols.LDAP.LDAP_SUCCESS
constant int Protocols.LDAP.LDAP_OPERATIONS_ERROR
constant int Protocols.LDAP.LDAP_PROTOCOL_ERROR
constant int Protocols.LDAP.LDAP_TIMELIMIT_EXCEEDED
constant int Protocols.LDAP.LDAP_SIZELIMIT_EXCEEDED
constant int Protocols.LDAP.LDAP_COMPARE_FALSE
constant int Protocols.LDAP.LDAP_COMPARE_TRUE
constant int Protocols.LDAP.LDAP_AUTH_METHOD_NOT_SUPPORTED
constant Protocols.LDAP.LDAP_STRONG_AUTH_NOT_SUPPORTED
constant int Protocols.LDAP.LDAP_STRONG_AUTH_REQUIRED
constant int Protocols.LDAP.LDAP_PARTIAL_RESULTS
constant int Protocols.LDAP.LDAP_REFERRAL
constant int Protocols.LDAP.LDAP_ADMINLIMIT_EXCEEDED
constant int Protocols.LDAP.LDAP_UNAVAILABLE_CRITICAL_EXTENSION
constant int Protocols.LDAP.LDAP_CONFIDENTIALITY_REQUIRED
constant int Protocols.LDAP.LDAP_SASL_BIND_IN_PROGRESS
constant int Protocols.LDAP.LDAP_NO_SUCH_ATTRIBUTE
constant int Protocols.LDAP.LDAP_UNDEFINED_TYPE
constant int Protocols.LDAP.LDAP_INAPPROPRIATE_MATCHING
constant int Protocols.LDAP.LDAP_CONSTRAINT_VIOLATION
constant int Protocols.LDAP.LDAP_TYPE_OR_VALUE_EXISTS
constant int Protocols.LDAP.LDAP_INVALID_SYNTAX
constant int Protocols.LDAP.LDAP_NO_SUCH_OBJECT
constant int Protocols.LDAP.LDAP_ALIAS_PROBLEM
constant int Protocols.LDAP.LDAP_INVALID_DN_SYNTAX
constant int Protocols.LDAP.LDAP_IS_LEAF
constant int Protocols.LDAP.LDAP_ALIAS_DEREF_PROBLEM
constant int Protocols.LDAP.LDAP_INAPPROPRIATE_AUTH
constant int Protocols.LDAP.LDAP_INVALID_CREDENTIALS
constant int Protocols.LDAP.LDAP_INSUFFICIENT_ACCESS
constant int Protocols.LDAP.LDAP_BUSY
constant int Protocols.LDAP.LDAP_UNAVAILABLE
constant int Protocols.LDAP.LDAP_UNWILLING_TO_PERFORM
constant int Protocols.LDAP.LDAP_LOOP_DETECT
constant int Protocols.LDAP.LDAP_SORT_CONTROL_MISSING
constant int Protocols.LDAP.LDAP_NAMING_VIOLATION
constant int Protocols.LDAP.LDAP_OBJECT_CLASS_VIOLATION
constant int Protocols.LDAP.LDAP_NOT_ALLOWED_ON_NONLEAF
constant int Protocols.LDAP.LDAP_NOT_ALLOWED_ON_RDN
constant int Protocols.LDAP.LDAP_ALREADY_EXISTS
constant int Protocols.LDAP.LDAP_NO_OBJECT_CLASS_MODS
constant int Protocols.LDAP.LDAP_RESULTS_TOO_LARGE
constant int Protocols.LDAP.LDAP_AFFECTS_MULTIPLE_DSAS
constant int Protocols.LDAP.LDAP_OTHER

Description

LDAP result codes.

See also

Protocols.LDAP.client.error_number, Protocols.LDAP.client.result.error_number

Constant LDAP_CONTROL_MANAGE_DSA_IT

constant string Protocols.LDAP.LDAP_CONTROL_MANAGE_DSA_IT

Description

LDAP control: Manage DSA IT LDAPv3 control (RFC 3296): Control to indicate that the operation is intended to manage objects within the DSA (server) Information Tree.

Constant LDAP_CONTROL_VLVREQUEST

constant string Protocols.LDAP.LDAP_CONTROL_VLVREQUEST

Description

LDAP control: LDAP Extensions for Scrolling View Browsing of Search Results (internet draft): Control used to request virtual list view support from the server.

Constant LDAP_CONTROL_VLVRESPONSE

constant string Protocols.LDAP.LDAP_CONTROL_VLVRESPONSE

Description

LDAP control: LDAP Extensions for Scrolling View Browsing of Search Results (internet draft): Control used to pass virtual list view (VLV) data from the server to the client.

Constant LDAP_PAGED_RESULT_OID_STRING

constant string Protocols.LDAP.LDAP_PAGED_RESULT_OID_STRING

Description

LDAP control: Microsoft AD: Control to instruct the server to return the results of a search request in smaller, more manageable packets rather than in one large block.

Constant LDAP_SERVER_ASQ_OID

constant string Protocols.LDAP.LDAP_SERVER_ASQ_OID

Description

LDAP control: Microsoft AD: Control to force the query to be based on a specific DN-valued attribute.

Constant LDAP_SERVER_CROSSDOM_MOVE_TARGET_OID

constant string Protocols.LDAP.LDAP_SERVER_CROSSDOM_MOVE_TARGET_OID

Description

LDAP control: Microsoft AD: Control used with an extended LDAP rename function to move an LDAP object from one domain to another.

Constant LDAP_SERVER_DIRSYNC_OID

constant string Protocols.LDAP.LDAP_SERVER_DIRSYNC_OID

Description

LDAP control: Microsoft AD: Control that enables an application to search the directory for objects changed from a previous state.

Constant LDAP_SERVER_DOMAIN_SCOPE_OID

constant string Protocols.LDAP.LDAP_SERVER_DOMAIN_SCOPE_OID

Description

LDAP control: Microsoft AD: Control used to instruct the LDAP server not to generate any referrals when completing a request.

Constant LDAP_SERVER_EXTENDED_DN_OID

constant string Protocols.LDAP.LDAP_SERVER_EXTENDED_DN_OID

Description

LDAP control: Microsoft AD: Control to request an extended form of an Active Directory object distinguished name.

Constant LDAP_SERVER_LAZY_COMMIT_OID

constant string Protocols.LDAP.LDAP_SERVER_LAZY_COMMIT_OID

Description

LDAP control: Microsoft AD: Control used to instruct the server to return the results of a DS modification command, such as add, delete, or replace, after it has been completed in memory, but before it has been committed to disk.

Constant LDAP_SERVER_NOTIFICATION_OID

constant string Protocols.LDAP.LDAP_SERVER_NOTIFICATION_OID

Description

LDAP control: Microsoft AD: Control used with an extended LDAP asynchronous search function to register the client to be notified when changes are made to an object in Active Directory.

Constant LDAP_SERVER_PERMISSIVE_MODIFY_OID

constant string Protocols.LDAP.LDAP_SERVER_PERMISSIVE_MODIFY_OID

Description

LDAP control: Microsoft AD: An LDAP modify request will normally fail if it attempts to add an attribute that already exists, or if it attempts to delete an attribute that does not exist. With this control, as long as the attribute to be added has the same value as the existing attribute, then the modify will succeed. With this control, deletion of an attribute that does not exist will also succeed.

Constant LDAP_SERVER_QUOTA_CONTROL_OID

constant string Protocols.LDAP.LDAP_SERVER_QUOTA_CONTROL_OID

Description

LDAP control: Microsoft AD: Control used to pass the SID of a security principal, whose quota is being queried, to the server in a LDAP search operation.

Constant LDAP_SERVER_RESP_SORT_OID

constant string Protocols.LDAP.LDAP_SERVER_RESP_SORT_OID

Description

LDAP control: Microsoft AD: Control used by the server to indicate the results of a search function initiated using the LDAP_SERVER_SORT_OID control.

Constant LDAP_SERVER_SD_FLAGS_OID

constant string Protocols.LDAP.LDAP_SERVER_SD_FLAGS_OID

Description

LDAP control: Microsoft AD: Control used to pass flags to the server to control various security descriptor results.

Constant LDAP_SERVER_SEARCH_OPTIONS_OID

constant string Protocols.LDAP.LDAP_SERVER_SEARCH_OPTIONS_OID

Description

LDAP control: Microsoft AD: Control used to pass flags to the server to control various search behaviors.

Constant LDAP_SERVER_SHOW_DELETED_OID

constant string Protocols.LDAP.LDAP_SERVER_SHOW_DELETED_OID

Description

LDAP control: Microsoft AD: Control used to specify that the search results include any deleted objects that match the search filter.

Constant LDAP_SERVER_SORT_OID

constant string Protocols.LDAP.LDAP_SERVER_SORT_OID

Description

LDAP control: Microsoft AD: Control used to instruct the server to sort the search results before returning them to the client application.

Constant LDAP_SERVER_TREE_DELETE_OID

constant string Protocols.LDAP.LDAP_SERVER_TREE_DELETE_OID

Description

LDAP control: Microsoft AD: Control used to delete an entire subtree in the directory.

Constant LDAP_SERVER_VERIFY_NAME_OID

constant string Protocols.LDAP.LDAP_SERVER_VERIFY_NAME_OID

Description

LDAP control: Microsoft AD: Control used to instruct the DC accepting the update which DC it should verify with, the existence of any DN attribute values.

Constant MODIFY_ADD
Constant MODIFY_DELETE
Constant MODIFY_REPLACE

constant int Protocols.LDAP.MODIFY_ADD
constant int Protocols.LDAP.MODIFY_DELETE
constant int Protocols.LDAP.MODIFY_REPLACE

Description

Constants used in the attropval argument to Protocols.LDAP.client.modify.

Constant SCOPE_BASE
Constant SCOPE_ONE
Constant SCOPE_SUB

constant int Protocols.LDAP.SCOPE_BASE
constant int Protocols.LDAP.SCOPE_ONE
constant int Protocols.LDAP.SCOPE_SUB

Description

Constants for the search scope used with e.g. Protocols.LDAP.client.set_scope.

SCOPE_BASE

Return the object specified by the DN.

SCOPE_ONE

Return the immediate subobjects of the object specified by the DN.

SCOPE_SUB

Return the object specified by the DN and all objects below it (on any level).

Constant SEARCH_LOWER_ATTRS
Constant SEARCH_MULTIVAL_ARRAYS_ONLY
Constant SEARCH_RETURN_DECODE_ERRORS

constant int Protocols.LDAP.SEARCH_LOWER_ATTRS
constant int Protocols.LDAP.SEARCH_MULTIVAL_ARRAYS_ONLY
constant int Protocols.LDAP.SEARCH_RETURN_DECODE_ERRORS

Description

Bitfield flags given to Protocols.LDAP.client.search:

SEARCH_LOWER_ATTRS

Lowercase all attribute values. This makes it easier to match specific attributes in the mappings returned by Protocols.LDAP.client.result.fetch since LDAP attribute names are case insensitive.

SEARCH_MULTIVAL_ARRAYS_ONLY

Only use arrays for attribute values where the attribute syntax specify multiple values. I.e. the values for single valued attributes are returned as strings instead of arrays containing one string element.

If no value is returned for a single valued attribute, e.g. when attrsonly is set in the search call, then a zero will be used as value.

The special "dn" value is also returned as a string when this flag is set.

Note that it's the attribute type descriptions that are used to decide this, not the number of values a particular attribute happens to have in the search result.

SEARCH_RETURN_DECODE_ERRORS

Don't throw attribute value decode errors, instead return them in the result from Protocols.LDAP.client.result.fetch in place of the value. I.e. anywhere an attribute value string occurs, you might instead have a Charset.DecodeError object.

Constant SYNTAX_AD_CASE_IGNORE_STR
Constant SYNTAX_AD_LARGE_INT
Constant SYNTAX_AD_OBJECT_SECURITY_DESCRIPTOR

constant string Protocols.LDAP.SYNTAX_AD_CASE_IGNORE_STR
constant string Protocols.LDAP.SYNTAX_AD_LARGE_INT
constant string Protocols.LDAP.SYNTAX_AD_OBJECT_SECURITY_DESCRIPTOR

Description

LDAP syntax: Microsoft AD: Additional syntaxes used in AD. C.f. <http://community.roxen.com/(all)/developers/idocs/drafts/ draft-armijo-ldap-syntax-00.html>.

Constant SYNTAX_ATTR_TYPE_DESCR
Constant SYNTAX_BINARY
Constant SYNTAX_BIT_STRING
Constant SYNTAX_BOOLEAN
Constant SYNTAX_CERT
Constant SYNTAX_CERT_LIST
Constant SYNTAX_CERT_PAIR
Constant SYNTAX_COUNTRY_STR
Constant SYNTAX_DN
Constant SYNTAX_DIRECTORY_STR
Constant SYNTAX_DIT_CONTENT_RULE_DESCR
Constant SYNTAX_FACSIMILE_PHONE_NUM
Constant SYNTAX_FAX
Constant SYNTAX_GENERALIZED_TIME
Constant SYNTAX_IA5_STR
Constant SYNTAX_INT
Constant SYNTAX_JPEG
Constant SYNTAX_MATCHING_RULE_DESCR
Constant SYNTAX_MATCHING_RULE_USE_DESCR
Constant SYNTAX_MHS_OR_ADDR
Constant SYNTAX_NAME_AND_OPTIONAL_UID
Constant SYNTAX_NAME_FORM_DESCR
Constant SYNTAX_NUMERIC_STRING
Constant SYNTAX_OBJECT_CLASS_DESCR
Constant SYNTAX_OID
Constant SYNTAX_OTHER_MAILBOX
Constant SYNTAX_POSTAL_ADDR
Constant SYNTAX_PRESENTATION_ADDR
Constant SYNTAX_PRINTABLE_STR
Constant SYNTAX_PHONE_NUM
Constant SYNTAX_UTC_TIME
Constant SYNTAX_LDAP_SYNTAX_DESCR
Constant SYNTAX_DIT_STRUCTURE_RULE_DESCR

constant string Protocols.LDAP.SYNTAX_ATTR_TYPE_DESCR
constant string Protocols.LDAP.SYNTAX_BINARY
constant string Protocols.LDAP.SYNTAX_BIT_STRING
constant string Protocols.LDAP.SYNTAX_BOOLEAN
constant string Protocols.LDAP.SYNTAX_CERT
constant string Protocols.LDAP.SYNTAX_CERT_LIST
constant string Protocols.LDAP.SYNTAX_CERT_PAIR
constant string Protocols.LDAP.SYNTAX_COUNTRY_STR
constant string Protocols.LDAP.SYNTAX_DN
constant string Protocols.LDAP.SYNTAX_DIRECTORY_STR
constant string Protocols.LDAP.SYNTAX_DIT_CONTENT_RULE_DESCR
constant string Protocols.LDAP.SYNTAX_FACSIMILE_PHONE_NUM
constant string Protocols.LDAP.SYNTAX_FAX
constant string Protocols.LDAP.SYNTAX_GENERALIZED_TIME
constant string Protocols.LDAP.SYNTAX_IA5_STR
constant string Protocols.LDAP.SYNTAX_INT
constant string Protocols.LDAP.SYNTAX_JPEG
constant string Protocols.LDAP.SYNTAX_MATCHING_RULE_DESCR
constant string Protocols.LDAP.SYNTAX_MATCHING_RULE_USE_DESCR
constant string Protocols.LDAP.SYNTAX_MHS_OR_ADDR
constant string Protocols.LDAP.SYNTAX_NAME_AND_OPTIONAL_UID
constant string Protocols.LDAP.SYNTAX_NAME_FORM_DESCR
constant string Protocols.LDAP.SYNTAX_NUMERIC_STRING
constant string Protocols.LDAP.SYNTAX_OBJECT_CLASS_DESCR
constant string Protocols.LDAP.SYNTAX_OID
constant string Protocols.LDAP.SYNTAX_OTHER_MAILBOX
constant string Protocols.LDAP.SYNTAX_POSTAL_ADDR
constant string Protocols.LDAP.SYNTAX_PRESENTATION_ADDR
constant string Protocols.LDAP.SYNTAX_PRINTABLE_STR
constant string Protocols.LDAP.SYNTAX_PHONE_NUM
constant string Protocols.LDAP.SYNTAX_UTC_TIME
constant string Protocols.LDAP.SYNTAX_LDAP_SYNTAX_DESCR
constant string Protocols.LDAP.SYNTAX_DIT_STRUCTURE_RULE_DESCR

Description

LDAP syntax: Standard syntaxes from RFC 2252.

Constant SYNTAX_CASE_EXACT_STR

constant Protocols.LDAP.SYNTAX_CASE_EXACT_STR

Description

"caseExactString" is an alias used in e.g. RFC 2079.

Constant SYNTAX_DELIVERY_METHOD
Constant SYNTAX_ENHANCED_GUIDE
Constant SYNTAX_GUIDE
Constant SYNTAX_OCTET_STR
Constant SYNTAX_TELETEX_TERMINAL_ID
Constant SYNTAX_TELETEX_NUM
Constant SYNTAX_SUPPORTED_ALGORITHM

constant string Protocols.LDAP.SYNTAX_DELIVERY_METHOD
constant string Protocols.LDAP.SYNTAX_ENHANCED_GUIDE
constant string Protocols.LDAP.SYNTAX_GUIDE
constant string Protocols.LDAP.SYNTAX_OCTET_STR
constant string Protocols.LDAP.SYNTAX_TELETEX_TERMINAL_ID
constant string Protocols.LDAP.SYNTAX_TELETEX_NUM
constant string Protocols.LDAP.SYNTAX_SUPPORTED_ALGORITHM

Description

LDAP syntax: Standard syntaxes from RFC 2256.

Constant ldap_error_strings

constant Protocols.LDAP.ldap_error_strings

Description

Mapping from LDAP_* result codes to descriptive strings.

Constant syntax_decode_fns

constant mapping(string:function(string:string)) Protocols.LDAP.syntax_decode_fns

Description

Mapping containing functions to decode charsets in syntaxes where that's necessary. If the syntax is complex in a way that makes the result ambiguous if decoded with a single charset transformation then it should typically not be decoded here.

These decoders are used on all attribute values returned by Protocols.LDAP.client.result functions.

Constant syntax_encode_fns

constant mapping(string:function(string:string)) Protocols.LDAP.syntax_encode_fns

Description

Mapping containing the reverse functions from syntax_decode_fns.