Skip to main content

A Pure-Python Twisted library for LDAP

Project description

https://travis-ci.org/twisted/ldaptor.svg?branch=master https://codecov.io/gh/twisted/ldaptor/branch/master/graph/badge.svg

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-20.0.0rc1.tar.gz (302.6 kB view details)

Uploaded Source

Built Distribution

ldaptor-20.0.0rc1-py2.py3-none-any.whl (181.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file ldaptor-20.0.0rc1.tar.gz.

File metadata

  • Download URL: ldaptor-20.0.0rc1.tar.gz
  • Upload date:
  • Size: 302.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.6

File hashes

Hashes for ldaptor-20.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 58c5d959187a8a7cbe344b4050a4d3fd4578c7cb1568426d7e58719f92d202dc
MD5 563e98f4f7d52fc35cc88b61fb858f50
BLAKE2b-256 1126cd90cb6ad67b4cc272fe3810f5a5ee5a61513ebc8244dfc5a056afaa8187

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ldaptor-20.0.0rc1-py2.py3-none-any.whl
  • Upload date:
  • Size: 181.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.6

File hashes

Hashes for ldaptor-20.0.0rc1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 659ef02350e9f7ad9b3eacb2df78ae9845321d207cf1d18f57766ade3aa2e7e8
MD5 19ffdfd92e0bcba9ad671f036cf07335
BLAKE2b-256 8c31a14c4bd5789682cfbf6265ba000c53cfd945b4df149f1cca4621aff79380

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