lein-ldapimem (LDAP i[n] mem[ory])

A Leiningen 2 plugin that runs a simple embedded instance of unboundID's in-memory LDAP service. Useful for testing purposes.

Usage

Add [lein-ldapimem "0.1.1"] to the :plugin vector of your project.

Start the LDAP service when running lein by specifying it before the other tasks that you are running, for example:

$ lein ldapimem run

Once the task completes, the LDAP service will be terminated.

If for some reason you'd like to run the plugin by itself you can invoke it like this, without any further tasks:

$ lein ldapimem

When you want to stop it just press Ctrl+C.

Configuration

There are optional pieces of configuration that control how the LDAP service operates:

(defproject my-project "1.0.0-SNAPSHOT"
  ...
  :plugins [[lein-ldapimem "0.1.1"]]
  ...
  :ldapimem {:port 9839 ;optional - default value is 8389
             :basedn "dc=dev,dc=mycorp,dc=com" ; optional - base domain, default is "dc=example,dc=com"
             :ldif-file-path "ldif.txt" ; optional - path of file containing valid LDIF data
             :schema-file-path "schema.txt" ; optional - path of file containing the schema
             :noschema true ; optional - no schema is to be used (not even the default one)
             :logging true ; optional - default is false
             
             :username ; optional - a user to use access control
             :password ; optional - the password for the access control user
             
             :ssl ; optional - if true then the server will run an additional LDAPS listener using SSL
             :secure-port ; optional - the port on which LDAPS will run (default 8636)
             :key-store-path ; optional - the path to the key store, default "resources/keystore.jks"
             :key-store-password ; optional - the password for the key store, default is "password"
             :trust-store-path ; optional - the path to the trust store, default "resources/truststore.jks"
             }
  ...
)

Note that the default key store and trust store use a self-signed certificate which is only suitable for testing!

Simple Example

Pick an existing lein project and insert the following into the project.clj:

:ldapimem {
    :port 8399
    :ldif-file-path "data.ldif"
    :noschema true
    :logging true
  }

and insert the plugin into the :plugins section of the project definition:

:plugins [...
          [lein-ldapimem "0.1.0"]
          ...]}

In the root of the project create a file called data.ldif containing:

n: dc=example,dc=com
objectClass: domain
objectClass: top
dc: server

dn: cn=Test Entry,dc=example,dc=com
objectClass: inetOrgPerson
cn: Test Entry
sn: Entry
givenName: Test

Run your project using lein (I'll just use the task run but just use whatever tasks you normally use):

$ lein ldapimem run

Now you project is running, in another shell type:

$ ldapsearch -x -h localhost -p 8399

and you will see a response that includes information similar to that specified in data.ldif as well as logging information appearing in the running project's console output.

Notes

• The LDAP service only has one unencrypted listener (which is probably enough for local testing).\
• If you want to run many lein builds in parallel using Jenkins, try the Port Allocator Plugin to avoid port conflicts. If you assign a port to $LDAP_PORT, you can set the :port config option for embongo like:

(defproject my-project "1.0.0-SNAPSHOT"
  ...
  :ldapimem {
    :port ~(Integer. (get (System/getenv) "LDAP_PORT" 8389)) ;uses 8389 if env variable not set
  ...

• If you run with LDAPS enabled, the command to connect to search is:

  $ ldapsearch -x -H ldaps://localhost:8636

  but, if you run on a mac (like I do) you may need to change /etc/openldap/ldap.conf to have TLS_REQCERT set to allow instead of demand so that the invalid self-signed certificate won't cause a problem.

License

Copyright © 2015 Matthew Daley

Distributed under the Eclipse Public License, the same as Clojure.