ldapi support.

Support for using ldapi Unix socket connections. Build the connection
URI differently to suit. Added a new configuration option for specifying
the path to the socket. Don't mandate username and password if using
ldapi.

Signed-off-by: Adar Nimrod <[email protected]>

Author: adarnimrod

docs/index.rst

@@ -60,6 +60,8 @@ directives:
 ``LDAP_PORT``                      The port number of your LDAP server. Default: 389.
 ``LDAP_SCHEMA``                    The LDAP schema to use between 'ldap' and 'ldaps'.
                                    Default: 'ldap'.
+``LDAP_SOCKET_PATH``               If ``LDAP_SCHEMA`` is set to `ldapi`, the
+                                   path to the Unix socket path. Default: `/`.
 ``LDAP_USERNAME``                  **Required**: The user name used to bind.
 ``LDAP_PASSWORD``                  **Required**: The password used to bind.
 ``LDAP_TIMEOUT``                   How long (seconds) a connection can take to be opened

flask_simpleldap/__init__.py

@@ -34,6 +34,7 @@ def init_app(app):
         app.config.setdefault("LDAP_HOST", "localhost")
         app.config.setdefault("LDAP_PORT", 389)
         app.config.setdefault("LDAP_SCHEMA", "ldap")
+        app.config.setdefault("LDAP_SOCKET_PATH", "/")
         app.config.setdefault("LDAP_USERNAME", None)
         app.config.setdefault("LDAP_PASSWORD", None)
         app.config.setdefault("LDAP_TIMEOUT", 10)
@@ -68,9 +69,13 @@ def init_app(app):
             ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_DEMAND)
             ldap.set_option(ldap.OPT_X_TLS_CACERTFILE, app.config["LDAP_CERT_PATH"])
 
-        for option in ["USERNAME", "PASSWORD", "BASE_DN"]:
-            if app.config["LDAP_{0}".format(option)] is None:
-                raise LDAPException("LDAP_{0} cannot be None!".format(option))
+        if app.config["LDAP_BASE_DN"] is None:
+            raise LDAPException("LDAP_BASE_DN cannot be None!")
+
+        if app.config["LDAP_SCHEMA"] != "ldapi":
+            for option in ["USERNAME", "PASSWORD"]:
+                if app.config["LDAP_{0}".format(option)] is None:
+                    raise LDAPException("LDAP_{0} cannot be None!".format(option))
 
     @staticmethod
     def _set_custom_options(conn):
@@ -88,13 +93,18 @@ def initialize(self):
         """
 
         try:
-            conn = ldap.initialize(
-                "{0}://{1}:{2}".format(
+            if current_app.config["LDAP_SCHEMA"] == "ldapi":
+                uri = "{0}://{1}".format(
+                    current_app.config["LDAP_SCHEMA"],
+                    current_app.config["LDAP_SOCKET_PATH"],
+                )
+            else:
+                uri = "{0}://{1}:{2}".format(
                     current_app.config["LDAP_SCHEMA"],
                     current_app.config["LDAP_HOST"],
                     current_app.config["LDAP_PORT"],
                 )
-            )
+            conn = ldap.initialize(uri)
             conn.set_option(
                 ldap.OPT_NETWORK_TIMEOUT, current_app.config["LDAP_TIMEOUT"]
             )