Skip to main content

A Pure-Python Twisted library for LDAP

Project description

https://travis-ci.org/twisted/ldaptor.svg?branch=master

Ldaptor is a pure-Python library that implements:

  • LDAP client logic

  • separately-accessible LDAP and BER protocol message generation/parsing

  • ASCII-format LDAP filter generation and parsing

  • LDIF format data generation

  • Samba password changing logic

Also included is a set of LDAP utilities for use from the command line.

Verbose documentation can be found on ReadTheDocs.

Quick Usage Example

from twisted.internet import reactor, defer
from ldaptor.protocols.ldap import ldapclient, ldapsyntax, ldapconnector

@defer.inlineCallbacks
def example():
    # The following arguments may be also specified as unicode strings
    # but it is recommended to use byte strings for ldaptor objects
    serverip = b'192.168.128.21'
    basedn = b'dc=example,dc=com'
    binddn = b'bjensen@example.com'
    bindpw = b'secret'
    query = b'(cn=Babs*)'
    c = ldapconnector.LDAPClientCreator(reactor, ldapclient.LDAPClient)
    overrides = {basedn: (serverip, 389)}
    client = yield c.connect(basedn, overrides=overrides)
    yield client.bind(binddn, bindpw)
    o = ldapsyntax.LDAPEntry(client, basedn)
    results = yield o.search(filterText=query)
    for entry in results:
        print(entry.getLDIF())

if __name__ == '__main__':
    df = example()
    df.addErrback(lambda err: err.printTraceback())
    df.addCallback(lambda _: reactor.stop())
    reactor.run()

Installation

Ldaptor can be installed using the standard command line method:

python setup.py install

or using pip from PyPI:

pip install ldaptor

Linux distributions may also have ready packaged versions of Ldaptor and Twisted. Debian and Ubuntu have quality Ldaptor packages that can be installed e.g., by:

apt-get install python-ldaptor

To run the LDAP server (bind port 38942) from a repo checkout with the project installed:

twistd -n --pidfile=ldapserver.pid --logfile=ldapserver.log \
    -y test-ldapserver.tac

Dependencies:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ldaptor-19.0.0.tar.gz (294.6 kB view details)

Uploaded Source

Built Distribution

ldaptor-19.0.0-py2.py3-none-any.whl (178.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file ldaptor-19.0.0.tar.gz.

File metadata

  • Download URL: ldaptor-19.0.0.tar.gz
  • Upload date:
  • Size: 294.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.8

File hashes

Hashes for ldaptor-19.0.0.tar.gz
Algorithm Hash digest
SHA256 100ee49fb76ffb2707653b2d7847715f8bc7469d8738391056c6a96ef63f27ea
MD5 c1d1bbad6258c87bd1835fcaa951de35
BLAKE2b-256 1e67ed943daf78ba4d66d5842991eafe75a909072d9ad7e28c4c61dab3548f94

See more details on using hashes here.

File details

Details for the file ldaptor-19.0.0-py2.py3-none-any.whl.

File metadata

  • Download URL: ldaptor-19.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 178.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.8

File hashes

Hashes for ldaptor-19.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 86050d890cea32002ddbc437a54c5300bc81d47fa3a87fcd98d0a75bb187f2de
MD5 3b0b6207c4d018f88397a89c7dc7090e
BLAKE2b-256 350b28b79755d0173d996f077be517be19c0563b690f3e438d2b113cb90ff508

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page