Lightweight LDAP/AD authentication proxy and FastAPI middleware
Project description
LDAPGate
Lightweight LDAP/AD authentication gateway for Python web apps. Install it, configure it, done.
Features
- Two deployment modes — standalone reverse proxy or drop-in FastAPI middleware
- Pure Python LDAP — no OS-level libs required, uses
ldap3 - Signed cookie sessions — stateless, no server-side session storage
- OpenLDAP and Active Directory —
uid=andsAMAccountName=out of the box - Optional group gating — restrict access to members of a specific LDAP group
- Header injection — injects
X-Forwarded-Userfor apps that support it - Bundled login form — responsive, dark/light mode, works air-gapped
Install
pip install ldapgate
Config file
Both modes share the same ldapgate.yaml:
ldap:
url: ldaps://dc.example.com:636
bind_dn: CN=svc,CN=Users,DC=example,DC=com
bind_password: secret
base_dn: DC=example,DC=com
user_filter: "(sAMAccountName={username})" # AD; OpenLDAP: (uid={username})
group_dn: CN=app-users,CN=Users,DC=example,DC=com # optional
proxy:
listen_host: 0.0.0.0
listen_port: 9000
backend_url: http://localhost:8080
secret_key: change-me-to-something-random
session_ttl: 3600
user_header: X-Forwarded-User
login_path: /_auth/login
app_name: MyApp
All settings can also be provided via environment variables with __ separators (e.g. LDAP__URL, PROXY__SECRET_KEY).
Mode 1 — Standalone Reverse Proxy
Run ldapgate as a standalone process in front of any app. Only authenticated requests are forwarded to the backend.
Browser → ldapgate :9000 → backend app :8080
ldapgate serve --config ldapgate.yaml
Example: copyparty
Start copyparty with IDP header auth and point its logout at ldapgate:
copyparty -p 8080 --idp-h-usr X-Forwarded-User --idp-logout /_auth/logout -v ~/Documents:/:rw
copyparty trusts the X-Forwarded-User header injected by ldapgate, and its logout button redirects to /_auth/logout which clears the ldapgate session before sending the user back to the login page.
Mode 2 — FastAPI Middleware
Drop ldapgate auth directly into an existing FastAPI app — no separate process needed.
from fastapi import FastAPI
from ldapgate.config import load_config
from ldapgate.middleware import add_ldap_auth
app = FastAPI()
config = load_config("ldapgate.yaml")
add_ldap_auth(app, config)
@app.get("/api/data")
async def data(request):
return {"user": request.state.user} # authenticated username
Example: lagun — see lagun and torrus for real-world integrations.
CLI Options
ldapgate serve --config PATH Path to ldapgate.yaml [default: ldapgate.yaml]
--host TEXT Override listen host
--port INTEGER Override listen port
--backend TEXT Override backend URL
--reload Enable auto-reload (dev)
Development
Requires uv.
git clone https://github.com/anudeepd/ldapgate
cd ldapgate
uv sync
pytest tests/
License
MIT
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ldapgate-0.1.1.tar.gz.
File metadata
- Download URL: ldapgate-0.1.1.tar.gz
- Upload date:
- Size: 179.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"CachyOS Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cbcba0b92e5fe92e45b1775a23bf2153025e87fe2e34d3db34dc9c3131ec98b5
|
|
| MD5 |
f6db49227695e477df5952ab3dbe7cfb
|
|
| BLAKE2b-256 |
0b9bb9ac4f8ee7edfe9a1d1b1746066e56eb77a0faeb82a3e6275fa8d773bc40
|
File details
Details for the file ldapgate-0.1.1-py3-none-any.whl.
File metadata
- Download URL: ldapgate-0.1.1-py3-none-any.whl
- Upload date:
- Size: 110.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"CachyOS Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
36fb2ba76676ff335c90493c8ea98147c2cee9e152b92c28340d1a5c9621461d
|
|
| MD5 |
02a5ec3da091bdcc0d59d9473c91fad5
|
|
| BLAKE2b-256 |
c40aa795daec4e1caa73d9ebce8ce02d31efa0b3fbc4960c651fc0c9d69778cd
|