anyldap 0.2.0

Quick Usage Example

import anyio

from anyldap.protocols.ldap import ldapclient, ldapconnector, ldapsyntax


async def example():
    serverip = "192.168.128.21"
    basedn = b"dc=example,dc=com"
    binddn = b"bjensen@example.com"
    bindpw = b"secret"
    query = b"(cn=Babs*)"
    overrides = {basedn: (serverip, 389)}
    connection = await ldapconnector.connectToLDAPDNAsync(
        basedn,
        ldapclient.LDAPClient,
        overrides=overrides,
    )
    async with connection as client:
        await client.bind_async(binddn, bindpw)
        entry = ldapsyntax.LDAPEntry(client, basedn)
        results = await entry.search_async(filterText=query)
        for result in results:
            print(result.getLDIF())


if __name__ == "__main__":
    anyio.run(example)

python-ldap’s API but async

anyldap.ldap is python-ldap’s ldap module made async: the names, the arguments they take and the values they hand back are python-ldap’s, with every operation a coroutine, so code written against it ports by adding await. It runs on asyncio and on trio, since it is written against AnyIO, and none of it is a binding to OpenLDAP’s C library – the protocol, the SASL mechanisms and the TLS handshake are anyldap’s own, which is also why the handful of things only libldap can answer are not here:

import anyio

from anyldap import ldap


async def example():
    async with ldap.initialize("ldap://ldap.example.com") as connection:
        await connection.simple_bind_s("bjensen@example.com", b"secret")
        results = await connection.search_s(
            "dc=example,dc=com", ldap.SCOPE_SUBTREE, "(cn=Babs*)"
        )
        for dn, attributes in results:
            print(dn, attributes)


if __name__ == "__main__":
    anyio.run(example)

ldap.controls, ldap.schema, ldap.sasl, ldap.dn, ldap.filter, ldap.modlist, ldap.cidict, ldap.ldapurl, ldap.ldif, ldap.asyncsearch, ldap.syncrepl and ReconnectLDAPObject are here too. What it does and does not cover is in the documentation. Most of python-ldap’s own test suite is ported under interop/, next to tests that run the same operations through both libraries against one OpenLDAP server and compare the answers; tox -e interop runs them.

Installation

Install anyldap from PyPI:

python -m pip install anyldap

To install a repository checkout in editable mode:

python -m pip install -e .

For a server example from a repo checkout, see docs/source/examples/quickstart_server.py.

Dependencies:

• AnyIO for asynchronous networking

• dnspython for LDAP service discovery

• httpx2 for fetching a schema over HTTP

• pyparsing for LDAP filters

• zope.interface