| Extracted from Pike v7.8 release 866 at 2018-02-09.

[Top]
Protocols
Protocols.LDAP

# Module Protocols.LDAP

  `constant Protocols.LDAP.LDAP_SUCCESS`
  `constant Protocols.LDAP.LDAP_OPERATIONS_ERROR`
  `constant Protocols.LDAP.LDAP_PROTOCOL_ERROR`
  `constant Protocols.LDAP.LDAP_TIMELIMIT_EXCEEDED`
  `constant Protocols.LDAP.LDAP_SIZELIMIT_EXCEEDED`
  `constant Protocols.LDAP.LDAP_COMPARE_FALSE`
  `constant Protocols.LDAP.LDAP_COMPARE_TRUE`
  `constant Protocols.LDAP.LDAP_AUTH_METHOD_NOT_SUPPORTED`
  `constant Protocols.LDAP.LDAP_STRONG_AUTH_NOT_SUPPORTED`
  `constant Protocols.LDAP.LDAP_STRONG_AUTH_REQUIRED`
  `constant Protocols.LDAP.LDAP_PARTIAL_RESULTS`
  `constant Protocols.LDAP.LDAP_REFERRAL`
  `constant Protocols.LDAP.LDAP_ADMINLIMIT_EXCEEDED`
  `constant Protocols.LDAP.LDAP_UNAVAILABLE_CRITICAL_EXTENSION`
  `constant Protocols.LDAP.LDAP_CONFIDENTIALITY_REQUIRED`
  `constant Protocols.LDAP.LDAP_SASL_BIND_IN_PROGRESS`
  `constant Protocols.LDAP.LDAP_NO_SUCH_ATTRIBUTE`
  `constant Protocols.LDAP.LDAP_UNDEFINED_TYPE`
  `constant Protocols.LDAP.LDAP_INAPPROPRIATE_MATCHING`
  `constant Protocols.LDAP.LDAP_CONSTRAINT_VIOLATION`
  `constant Protocols.LDAP.LDAP_TYPE_OR_VALUE_EXISTS`
  `constant Protocols.LDAP.LDAP_INVALID_SYNTAX`
  `constant Protocols.LDAP.LDAP_NO_SUCH_OBJECT`
  `constant Protocols.LDAP.LDAP_ALIAS_PROBLEM`
  `constant Protocols.LDAP.LDAP_INVALID_DN_SYNTAX`
  `constant Protocols.LDAP.LDAP_IS_LEAF`
  `constant Protocols.LDAP.LDAP_ALIAS_DEREF_PROBLEM`
  `constant Protocols.LDAP.LDAP_INAPPROPRIATE_AUTH`
  `constant Protocols.LDAP.LDAP_INVALID_CREDENTIALS`
  `constant Protocols.LDAP.LDAP_INSUFFICIENT_ACCESS`
  `constant Protocols.LDAP.LDAP_BUSY`
  `constant Protocols.LDAP.LDAP_UNAVAILABLE`
  `constant Protocols.LDAP.LDAP_UNWILLING_TO_PERFORM`
  `constant Protocols.LDAP.LDAP_LOOP_DETECT`
  `constant Protocols.LDAP.LDAP_SORT_CONTROL_MISSING`
  `constant Protocols.LDAP.LDAP_NAMING_VIOLATION`
  `constant Protocols.LDAP.LDAP_OBJECT_CLASS_VIOLATION`
  `constant Protocols.LDAP.LDAP_NOT_ALLOWED_ON_NONLEAF`
  `constant Protocols.LDAP.LDAP_NOT_ALLOWED_ON_RDN`
  `constant Protocols.LDAP.LDAP_ALREADY_EXISTS`
  `constant Protocols.LDAP.LDAP_NO_OBJECT_CLASS_MODS`
  `constant Protocols.LDAP.LDAP_RESULTS_TOO_LARGE`
  `constant Protocols.LDAP.LDAP_AFFECTS_MULTIPLE_DSAS`
  `constant Protocols.LDAP.LDAP_OTHER`
  `constant Protocols.LDAP.LDAP_SERVER_DOWN`
  `constant Protocols.LDAP.LDAP_LOCAL_ERROR`
  `constant Protocols.LDAP.LDAP_ENCODING_ERROR`
  `constant Protocols.LDAP.LDAP_DECODING_ERROR`
  `constant Protocols.LDAP.LDAP_TIMEOUT`
  `constant Protocols.LDAP.LDAP_AUTH_UNKNOWN`
  `constant Protocols.LDAP.LDAP_FILTER_ERROR`
  `constant Protocols.LDAP.LDAP_USER_CANCELLED`
  `constant Protocols.LDAP.LDAP_PARAM_ERROR`
  `constant Protocols.LDAP.LDAP_NO_MEMORY`
  `constant Protocols.LDAP.LDAP_CONNECT_ERROR`
  `constant Protocols.LDAP.LDAP_NOT_SUPPORTED`
  `constant Protocols.LDAP.LDAP_CONTROL_NOT_FOUND`
  `constant Protocols.LDAP.LDAP_NO_RESULTS_RETURNED`
  `constant Protocols.LDAP.LDAP_MORE_RESULTS_TO_RETURN`
  `constant Protocols.LDAP.LDAP_CLIENT_LOOP`
  `constant Protocols.LDAP.LDAP_REFERRAL_LIMIT_EXCEEDED`

Description

  LDAP result codes.

See also

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

Constant ldap_error_strings

  `constant Protocols.LDAP.ldap_error_strings`

Description

  Mapping from `LDAP_*` result codes to descriptive strings.

  `constant Protocols.LDAP.SEARCH_LOWER_ATTRS`
  `constant Protocols.LDAP.SEARCH_MULTIVAL_ARRAYS_ONLY`
  `constant 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 Locale.Charset.DecodeError object.

  `constant Protocols.LDAP.SCOPE_BASE`
  `constant Protocols.LDAP.SCOPE_ONE`
  `constant 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 Protocols.LDAP.MODIFY_ADD`
  `constant Protocols.LDAP.MODIFY_DELETE`
  `constant Protocols.LDAP.MODIFY_REPLACE`

Description

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

Constant LDAP_CONTROL_MANAGE_DSA_IT

  `constant 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 Protocols.LDAP.SYNTAX_ATTR_TYPE_DESCR`
  `constant Protocols.LDAP.SYNTAX_BINARY`
  `constant Protocols.LDAP.SYNTAX_BIT_STRING`
  `constant Protocols.LDAP.SYNTAX_BOOLEAN`
  `constant Protocols.LDAP.SYNTAX_CERT`
  `constant Protocols.LDAP.SYNTAX_CERT_LIST`
  `constant Protocols.LDAP.SYNTAX_CERT_PAIR`
  `constant Protocols.LDAP.SYNTAX_COUNTRY_STR`
  `constant Protocols.LDAP.SYNTAX_DN`
  `constant Protocols.LDAP.SYNTAX_DIRECTORY_STR`
  `constant Protocols.LDAP.SYNTAX_DIT_CONTENT_RULE_DESCR`
  `constant Protocols.LDAP.SYNTAX_FACSIMILE_PHONE_NUM`
  `constant Protocols.LDAP.SYNTAX_FAX`
  `constant Protocols.LDAP.SYNTAX_GENERALIZED_TIME`
  `constant Protocols.LDAP.SYNTAX_IA5_STR`
  `constant Protocols.LDAP.SYNTAX_INT`
  `constant Protocols.LDAP.SYNTAX_JPEG`
  `constant Protocols.LDAP.SYNTAX_MATCHING_RULE_DESCR`
  `constant Protocols.LDAP.SYNTAX_MATCHING_RULE_USE_DESCR`
  `constant Protocols.LDAP.SYNTAX_MHS_OR_ADDR`
  `constant Protocols.LDAP.SYNTAX_NAME_AND_OPTIONAL_UID`
  `constant Protocols.LDAP.SYNTAX_NAME_FORM_DESCR`
  `constant Protocols.LDAP.SYNTAX_NUMERIC_STRING`
  `constant Protocols.LDAP.SYNTAX_OBJECT_CLASS_DESCR`
  `constant Protocols.LDAP.SYNTAX_OID`
  `constant Protocols.LDAP.SYNTAX_OTHER_MAILBOX`
  `constant Protocols.LDAP.SYNTAX_POSTAL_ADDR`
  `constant Protocols.LDAP.SYNTAX_PRESENTATION_ADDR`
  `constant Protocols.LDAP.SYNTAX_PRINTABLE_STR`
  `constant Protocols.LDAP.SYNTAX_PHONE_NUM`
  `constant Protocols.LDAP.SYNTAX_UTC_TIME`
  `constant Protocols.LDAP.SYNTAX_LDAP_SYNTAX_DESCR`
  `constant 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 Protocols.LDAP.SYNTAX_DELIVERY_METHOD`
  `constant Protocols.LDAP.SYNTAX_ENHANCED_GUIDE`
  `constant Protocols.LDAP.SYNTAX_GUIDE`
  `constant Protocols.LDAP.SYNTAX_OCTET_STR`
  `constant Protocols.LDAP.SYNTAX_TELETEX_TERMINAL_ID`
  `constant Protocols.LDAP.SYNTAX_TELETEX_NUM`
  `constant Protocols.LDAP.SYNTAX_SUPPORTED_ALGORITHM`

Description

  LDAP syntax: Standard syntaxes from RFC 2256.

  `constant Protocols.LDAP.SYNTAX_AD_CASE_IGNORE_STR`
  `constant Protocols.LDAP.SYNTAX_AD_LARGE_INT`
  `constant 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 mapping

  `constant Protocols.LDAP.mapping`

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 mapping

  `constant Protocols.LDAP.mapping`

Description

  Mapping containing the reverse functions from syntax_decode_fns .

  `constant Protocols.LDAP.GUID_USERS_CONTAINER`
  `constant Protocols.LDAP.GUID_COMPUTERS_CONTAINER`
  `constant Protocols.LDAP.GUID_SYSTEMS_CONTAINER`
  `constant Protocols.LDAP.GUID_DOMAIN_CONTROLLERS_CONTAINER`
  `constant Protocols.LDAP.GUID_INFRASTRUCTURE_CONTAINER`
  `constant Protocols.LDAP.GUID_DELETED_OBJECTS_CONTAINER`
  `constant Protocols.LDAP.GUID_LOSTANDFOUND_CONTAINER`
  `constant Protocols.LDAP.GUID_FOREIGNSECURITYPRINCIPALS_CONTAINER`
  `constant Protocols.LDAP.GUID_PROGRAM_DATA_CONTAINER`
  `constant Protocols.LDAP.GUID_MICROSOFT_PROGRAM_DATA_CONTAINER`
  `constant 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>"