Skip to main content
Latest Version License TRAVIS-CI build status for master branch

ldap3 is a strictly RFC 4510 conforming LDAP V3 pure Python client library. The same codebase runs in Python 2, Python 3, PyPy and PyPy3.

A more pythonic LDAP

LDAP operations look clumsy and hard-to-use because they reflect the old-age idea that time-consuming operations should be performed client-side to not hog the server with heavy elaborations. To alleviate this ldap3 includes a fully functional Abstraction Layer that lets you interact with the LDAP server in a modern and pythonic way. With the Abstraction Layer you don’t need to directly issue any LDAP operation at all.

Thread safe strategies

In multithreaded programs you must use on of SAFE_SYNC (synchronous connection strategy), SAFE_RESTARTABLE (restartable syncronous connection strategy) or ASYNC (asynchronous connection strategy).

Each LDAP operation with SAFE_SYNC or SAFE_RESTARTABLE strategies returns a tuple of four elements: status, result, response and request.

  • status: states if the operation was successful

  • result: the LDAP result of the operation

  • response: the response of a LDAP Search Operation

  • request: the original request of the operation

The SafeSync strategy can be used with the Abstract Layer, but the Abstract Layer currently is NOT thread safe. For example, to use SAFE_SYNC:

from ldap3 import Server, Connection, SAFE_SYNC
server = Server('my_server')
conn = Connection(server, 'my_user', 'my_password', client_strategy=SAFE_SYNC, auto_bind=True)
status, result, response, _ = conn.search('o=test', '(objectclass=*)')  # usually you don't need the original request (4th element of the returned tuple)

With ASYNC you must request the response with the get_response() method.

Home Page

The home page of the ldap3 project is https://github.com/cannatag/ldap3

Documentation

Documentation is available at http://ldap3.readthedocs.io

License

The ldap3 project is open source software released under the LGPL v3 license. Copyright 2013 - 2020 Giovanni Cannata

PEP8 Compliance

ldap3 is PEP8 compliant, except for line length.

Download

Package download is available at https://pypi.python.org/pypi/ldap3.

Install

Install with pip install ldap3

Git repository

You can download the latest source at https://github.com/cannatag/ldap3

Continuous integration

Continuous integration for testing is at https://travis-ci.org/cannatag/ldap3

Support & Development

You can submit support tickets on https://github.com/cannatag/ldap3/issues/new You can submit pull request on the dev branch at https://github.com/cannatag/ldap3/tree/dev

Thanks to

  • Ilya Etingof, the author of the pyasn1 package for his excellent work and support.

  • Mark Lutz for his Learning Python and Programming Python excellent books series and John Goerzen and Brandon Rhodes for their book Foundations of Python Network Programming. These books are wonderful tools for learning Python and this project owes a lot to them.

  • JetBrains for donating to this project the Open Source license of PyCharm Professional.

  • GitHub for providing the free source repository space and the tools I use to develop this project.

  • The FreeIPA team for letting me use their demo LDAP server in the ldap3 tutorial.

Contact me

For information and suggestions you can contact me at cannatag@gmail.com. You can also open a support ticket on https://github.com/cannatag/ldap3/issues/new

Donate

If you want to keep this project up and running you can send me an Amazon gift card. I will use it to improve my skills in Information and Communication technologies.

Changelog

Updated changelog at https://ldap3.readthedocs.io/changelog.html

Release files for ldap3 2.9.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ldap3 2.9.1
File Size Uploaded
ldap3-2.9.1.tar.gz 398.8 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for ldap3 2.9.1
File
ldap3-2.9.1-py3.9.egg Legacy Egg format - - Details
ldap3-2.9.1-py2.py3-none-any.whl Python 2, Python 3 none any Details
ldap3-2.9.1-py2.7.egg Legacy Egg format - - Details
ldap3-2.9.1-py2.6.egg Legacy Egg format - - Details

Total release size: 3.4 MB

Release files / ldap3-2.9.1.tar.gz

Download URL ldap3-2.9.1.tar.gz
Size 398.8 kB
Tags Source
SHA-256 checksum
How to use checksums
f3e7fc4718e3f09dda568b57100095e0ce58633bcabbed8667ce3f8fbaa4229f
BLAKE2b-256 checksum
How to use checksums
43ac96bd5464e3edbc61595d0d69989f5d9969ae411866427b2500a8e5b812c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.4

Release files / ldap3-2.9.1-py3.9.egg

Download URL ldap3-2.9.1-py3.9.egg
Size 856.8 kB
Tags Egg
SHA-256 checksum
How to use checksums
5630d1383e09ba94839e253e013f1aa1a2cf7a547628ba1265cb7b9a844b5687
BLAKE2b-256 checksum
How to use checksums
e17f9bc8ea8dcaa502168a8972d1c80d0ef6c50b2397de454bb9d452220e54cf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.4

Release files / ldap3-2.9.1-py2.py3-none-any.whl

Download URL ldap3-2.9.1-py2.py3-none-any.whl
Size 432.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
5869596fc4948797020d3f03b7939da938778a0f9e2009f7a072ccf92b8e8d70
BLAKE2b-256 checksum
How to use checksums
4ef671d6ec9f18da0b2201287ce9db6afb1a1f637dedb3f0703409558981c723
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.4

Release files / ldap3-2.9.1-py2.7.egg

Download URL ldap3-2.9.1-py2.7.egg
Size 858.2 kB
Tags Egg
SHA-256 checksum
How to use checksums
2bc966556fc4d4fa9f445a1c31dc484ee81d44a51ab0e2d0fd05b62cac75daa6
BLAKE2b-256 checksum
How to use checksums
16db517b2cdd8e2eb19a41a24ce436ff3ac6986bb5687d82b5af10cfc01c4317
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.4

Release files / ldap3-2.9.1-py2.6.egg

Download URL ldap3-2.9.1-py2.6.egg
Size 858.0 kB
Tags Egg
SHA-256 checksum
How to use checksums
5ab7febc00689181375de40c396dcad4f2659cd260fc5e94c508b6d77c17e9d5
BLAKE2b-256 checksum
How to use checksums
4a5f76dd3f942e1a73406cbb56efe0b7c4a49511f99e1476e7610f50feb657c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.4
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page