openstack
/
deb-python-pyldap
Code Issues Proposed changes
deb-python-pyldap/Doc/ldap-controls.rst

5.6 KiB
Raw Blame History

:pyldap.controls High-level access to LDAPv3 extended controls

python-ldap project (see http://www.python-ldap.org/)

Variables

Dictionary mapping the OIDs of known response controls to the accompanying :pyResponseControl classes. This is used by :pyDecodeControlTuples to automatically decode control values. Calling application can also register their custom :pyResponseControl classes in this dictionary possibly overriding pre-registered classes.

Classes

This module defines the following classes:

ldap.controls.RequestControl

ldap.controls.ResponseControl

ldap.controls.LDAPControl

Functions

This module defines the following functions:

ldap.controls.RequestControlTuples

ldap.controls.DecodeControlTuples

Sub-modules

Various sub-modules implement specific LDAPv3 extended controls. The classes therein are derived from the base-classes :pyldap.controls.RequestControl, :pyldap.controls.ResponseControl or :pyldap.controls.LDAPControl.

Some of them require :pypyasn1 and :pypyasn1_modules to be installed:

Usually the names of the method arguments and the class attributes match the ASN.1 identifiers used in the specification. So looking at the referenced RFC or Internet-Draft is very helpful to understand the API.

:pyldap.controls.simple Very simple controls

ldap.controls.simple.ValueLessRequestControl

ldap.controls.simple.OctetStringInteger

ldap.controls.simple.BooleanControl

ldap.controls.simple.ManageDSAITControl

3296 - Named Subordinate References in Lightweight Directory Access Protocol (LDAP) Directories

ldap.controls.simple.RelaxRulesControl

ldap.controls.simple.ProxyAuthzControl

4370 - Lightweight Directory Access Protocol (LDAP): Proxied Authorization Control

ldap.controls.simple.AuthorizationIdentityRequestControl

3829 - Lightweight Directory Access Protocol (LDAP): Authorization Identity Request and Response Controls

ldap.controls.simple.AuthorizationIdentityResponseControl

3829 - Lightweight Directory Access Protocol (LDAP): Authorization Identity Request and Response Controls

ldap.controls.simple.GetEffectiveRightsControl

:pyldap.controls.libldap Various controls implemented in OpenLDAP libs

This module wraps C functions in OpenLDAP client libs which implement various request and response controls into Python classes.

ldap.controls.libldap.AssertionControl

4528 - Lightweight Directory Access Protocol (LDAP) Assertion Control

ldap.controls.libldap.MatchedValuesControl

3876 - Returning Matched Values with the Lightweight Directory Access Protocol version 3 (LDAPv3)

ldap.controls.libldap.SimplePagedResultsControl

2696 - LDAP Control Extension for Simple Paged Results Manipulation

:pyldap.controls.psearch LDAP Persistent Search

This module implements request and response controls for LDAP persistent search.

ldap.controls.psearch.PersistentSearchControl

ldap.controls.psearch.EntryChangeNotificationControl

:pyldap.controls.sessiontrack Session tracking control

ldap.controls.sessiontrack.SessionTrackingControl

:pyldap.controls.readentry Read entry control

4527 - Lightweight Directory Access Protocol (LDAP): Read Entry Controls

ldap.controls.readentry.ReadEntryControl

ldap.controls.readentry.PreReadControl

ldap.controls.readentry.PostReadControl