Swiss-army knife to synchronize Postgres roles and privileges from YAML or LDAP.
Postgres is able to check password of an existing role using the LDAP protocol out of the box. ldap2pg automates the creation, update and removal of PostgreSQL roles and users from an entreprise directory.
Managing roles is close to managing privileges as you expect roles to have proper default privileges. ldap2pg can grant and revoke privileges too.
Features
- Reads settings from an expressive YAML config file.
- Creates, alters and drops PostgreSQL roles from LDAP searches.
- Creates static roles from YAML to complete LDAP entries.
- Manages role parents (alias groups).
- Grants or revokes privileges statically or from LDAP entries.
- Dry run, check mode.
- Logs LDAP searches as
ldapsearch(1)commands. - Logs every SQL statements.
Here is a sample configuration and execution:
$ cat ldap2pg.yml
version: 6
rules:
- role:
name: nominal
options: NOLOGIN
comment: "Database owner"
- ldapsearch:
base: ou=people,dc=ldap,dc=ldap2pg,dc=docker
filter: "(objectClass=organizationalPerson)"
role:
name: '{cn}'
options:
LOGIN: yes
CONNECTION LIMIT: 5
$ ldap2pg --real
08:25:12 INFO Starting ldap2pg version=v6.0-alpha5 runtime=go1.21.0 commit=<none>
08:25:12 INFO Using YAML configuration file. path=docs/readme/ldap2pg.yml
08:25:12 INFO Running as unprivileged user. user=ldap2pg super=false server="PostgreSQL 15.3" cluster=ldap2pg-dev database=nominal
08:25:12 INFO Connected to LDAP directory. uri=ldaps://ldap.ldap2pg.docker authzid="dn:cn=admin,dc=ldap,dc=ldap2pg,dc=docker"
08:25:12 INFO Real mode. Postgres instance will modified.
08:25:12 CHANGE Create role. role=charles database=nominal
08:25:12 CHANGE Set role comment. role=charles database=nominal
08:25:12 CHANGE Inherit role for management. role=charles database=nominal
08:25:12 CHANGE Alter options. role=alain options="LOGIN CONNECTION LIMIT 5" database=nominal
08:25:12 CHANGE Terminate running sessions. role=omar database=nominal
08:25:12 CHANGE Allow current user to reassign objects. role=omar parent=ldap2pg database=nominal
08:25:12 CHANGE Reassign objects and purge ACL. role=omar owner=nominal database=nominal
08:25:12 CHANGE Drop role. role=omar database=nominal
08:25:12 INFO Comparison complete. elapsed=68.47058ms mempeak=1.6MiB postgres=15.323294ms queries=8 ldap=635.894µs searches=1
$Installation
Download package or binary from Releases page.
$ sudo yum install https://github.com/dalibo/ldap2pg/releases/download/v6.0-alpha5/ldap2pg_6.0-alpha5_linux_amd64.rpm
...
Installed:
ldap2pg-6.0.0~alpha5-1.x86_64
Complete!
$ ldap2pg --help
usage: ldap2pg [OPTIONS]
--check Check mode: exits with 1 if Postgres instance is unsynchronized.
--color Force color output. (default true)
-c, --config string Path to YAML configuration file. Use - for stdin.
-?, --help Show this help message and exit. (default true)
-q, --quiet count Decrease log verbosity.
-R, --real Real mode. Apply changes to Postgres instance.
-P, --skip-privileges Turn off privilege synchronisation.
-v, --verbose count Increase log verbosity.
-V, --version Show version and exit. (default true)
By default, ldap2pg runs in dry mode.
ldap2pg requires a configuration file to describe LDAP searches and mappings.
See https://ldap2pg.readthedocs.io/en/latest/ for further details.
$ldap2pg is licensed under PostgreSQL license.
ldap2pg requires a configuration file called ldap2pg.yaml.
Project ships a tested ldap2pg.yml as a starting point.
# curl -LO https://github.com/dalibo/ldap2pg/raw/master/ldap2pg.yml
# editor ldap2pg.ymlFinally, it's up to you to use ldap2pg in a crontab or a playbook.
Have fun!
ldap2pg is reported to work with OpenLDAP,
FreeIPA,
Oracle Internet Directory and
Microsoft Active Directory.
Support
If you need support and you didn't found it in documentation, just drop a question in a GitHub issue! French accepted. Don't miss the cookbook for advanced use cases.
Authors
ldap2pg is a Dalibo Labs project.
- Étienne BERSAC is the maintainer.
- Damien Cazeils designed the logo.
- Harold le CLÉMENT de SAINT-MARCQ implemented LDAP sub searches.
- Randolph Voorhies implemented role configuration synchronization.