Skip to main content

A Pure-Python Twisted library for LDAP

Project description

Codecov Read the Docs GitHub Actions PyPI

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

Uploaded Source

Built Distribution

ldaptor-20.1.0-py2.py3-none-any.whl (182.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: ldaptor-20.1.0.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.50.0 CPython/3.8.6

File hashes

Hashes for ldaptor-20.1.0.tar.gz
Algorithm Hash digest
SHA256 5f7da3aaf00fa8ba3329e9d5c6ee3f66868ca2e5bf935f7b2537701a3ee01597
MD5 b2014a1bf4ad479d564faceaa0fff85a
BLAKE2b-256 1259fd7b60efa1d135af461df54d7b410b44f4c3d8c5ebed5b411ce7c0f4cf34

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ldaptor-20.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 182.0 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.50.0 CPython/3.8.6

File hashes

Hashes for ldaptor-20.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 485685f3ff05377dc32247478a68e174bb071a959ad5fb83e4bf90dfe6772cb4
MD5 d11f3bb4abf91cb610d5c5417327d623
BLAKE2b-256 dd36e69b685c6dfe1e0184a13e511413b840f27dcf728e83175f2d46c083a008

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