Socket
Socket
Sign inDemoInstall

ldap2pg

Package Overview
Dependencies
2
Maintainers
2
Alerts
File Explorer

Install Socket

Protect your apps from supply chain attacks

Install

ldap2pg

Manage PostgreSQL roles and privileges from YAML or LDAP

    5.9

Maintainers
2

Readme

|ldap2pg|

| |CircleCI| |Codecov| |RTD| |PyPI| |Docker|

Swiss-army knife to synchronize Postgres roles and privileges from YAML or LDAP.

.. _documentation: https://ldap2pg.readthedocs.io/en/latest/
.. _license:       https://opensource.org/licenses/postgresql
.. _contributors:  https://github.com/dalibo/ldap2pg/blob/master/CONTRIBUTING.md#contributors

Postgres is able to check password against an entreprise directory using the
LDAP protocol out of the box. ldap2pg automates the creation, update and
removal of PostgreSQL roles and users based on entreprise organigram described
in the 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 members (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 query.

Here is a sample configuration and execution:

::

    $ cat ldap2pg.yml
    - role:
        name: ldap_roles
        options: NOLOGIN
    - ldapsearch:
        base: ou=people,dc=ldap,dc=ldap2pg,dc=docker
        filter: "(objectClass=organizationalPerson)"
      role:
        name: '{cn}'
        options: LOGIN
        parent: ldap_roles
    $ ldap2pg --real
    Starting ldap2pg 5.7.
    Using .../ldap2pg.yml.
    Running in real mode.
    Inspecting roles in Postgres cluster...
    Querying LDAP ou=people,dc=ldap,dc=lda... (objectClass...
    Create domitille.
    Add missing ldap_roles members.
    Delete spurious ldap_roles members.
    Update options of albert.
    Reassign oscar objects and purge ACL on postgres.
    Reassign oscar objects and purge ACL on template1.
    Drop oscar.
    Synchronization complete.
    $


Installation
============

ldap2pg requires Python 2.6+ or 3+, pyyaml, python-ldap and psycopg2.

The universal installation method is to download from PyPI using pip. Other
methods and more details are described in this documentation.

    # apt install -y libldap2-dev libsasl2-dev
    # pip install ldap2pg psycopg2-binary

``ldap2pg`` is licensed under PostgreSQL license_. ``ldap2pg`` is available with
the help of wonderful people, jump to contributors_ list to see them.

ldap2pg **requires** a configuration file called ``ldap2pg.yaml``. The [dumb
but tested
`ldap2pg.yml`](https://github.com/dalibo/ldap2pg/blob/master/ldap2pg.yml) is a
good way to start.

    # curl -LO https://github.com/dalibo/ldap2pg/raw/master/ldap2pg.yml
    # editor ldap2pg.yml

Finally, 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.

.. _OpenLDAP: https://www.openldap.org/
.. _FreeIPA: https://www.freeipa.org/


Support
=======

If you need support and you didn't found it in documentation_, just drop a
question in a `GitHub issue <https://github.com/dalibo/ldap2pg/issues/new>`_!
French accepted. Don't miss the `cookbook
<https://ldap2pg.readthedocs.io/en/latest/cookbook/>`_. You're welcome!


.. |Codecov| image:: https://codecov.io/gh/dalibo/ldap2pg/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/dalibo/ldap2pg
   :alt: Code coverage report

.. |CircleCI| image:: https://circleci.com/gh/dalibo/ldap2pg.svg?style=shield
   :target: https://circleci.com/gh/dalibo/ldap2pg
   :alt: Continuous Integration report

.. |Docker| image:: https://img.shields.io/docker/automated/dalibo/ldap2pg.svg
   :target: https://hub.docker.com/r/dalibo/ldap2pg
   :alt: Docker Image Available

.. |ldap2pg| image:: https://github.com/dalibo/ldap2pg/raw/master/docs/img/logo-phrase.png
   :target: https://labs.dalibo.com/ldap2pg
   :alt: ldap2pg: PostgreSQL role and privileges management

.. |PyPI| image:: https://img.shields.io/pypi/v/ldap2pg.svg
   :target: https://pypi.python.org/pypi/ldap2pg
   :alt: Version on PyPI

.. |RTD| image:: https://readthedocs.org/projects/ldap2pg/badge/?version=latest
   :target: https://ldap2pg.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation

FAQs


Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc