/ldap-in-memory

The in-memory LDAP server (IM-LDAP) simplifies the task of standing up an LDAP server for non-production environments.

Primary LanguageJavaApache License 2.0Apache-2.0

.___   _____            .____     ________      _____ __________
|   | /     \           |    |    \______ \    /  _  \\______   \
|   |/  \ /  \   ______ |    |     |    |  \  /  /_\  \|     ___/
|   /    Y    \ /_____/ |    |___  |    `   \/    |    \    |
|___\____|__  /         |_______ \/_______  /\____|__  /____|
            \/                  \/        \/         \/

In-Memory LDAP Server

Overview

The in-memory LDAP server (IM-LDAP) simplifies the task of standing up an LDAP server for non-production environments. This document explains how to easily configure an IM-LDAP directory server for testing, demonstration purposes, or simple LDAP data processing tasks. IM-LDAP allows for easy, cross-platform development of applications, such as the Secure Data Service, that rely on an LDAP server.

This implementation leverages the UnboundedID Java SDK. This library includes a fast, powerful, and user-friendly Java API for communicating with LDAP directory servers. The UnboundID Identity Data Platform provides a directory services solution designed to scale for extremely large identity datasets and also provides the data synchronization services necessary to support a low-risk migration from existing directory services solutions.

The UnboundID LDAP SDK for Java is free to use and redistribute in open source or proprietary applications under the GPLv2, LGPLv2.1 and the UnboundID Free Use License. It does not have any third-party dependencies and commercial support is available from UnboundID.

The UnboundedID Java SDK has capability restrictions that require LDAP schema changes to be performed offline. For more information on LDAP SDK features refer to:

https://www.unboundid.com/products/ldapsdk/docs/getting-started/features.php

IMPORTANT

The UnboundedID Java SDK only provides an implementation to support plain text passwords (an interface is provided to create other extensions). When LDIF files are imported, the IM-LDAP server will automatically reset the password to "username" + "1234".

Configuration

The IM-LDAP self-configures by using the contents of the configuration file ldap-inmemory-config.xml, which is discussed below. The configuration file allows for specification of the root node, binding details (including password), the ability to add individual LDAP entries (without attributes), and the import of specified LDIF export files.

LDIF Adjustor

The LDAP schema is loaded from the LDIF file that is defined in the configuration file. A utility class has been added as a tool to simplify the configuration process. LDIF exports must conform to the schema and include the changetype attribute. A helper class has been added which can be run to generate modified LDIF export files to add the missing attribute.

Please refer to the class com.slc.sli.ldap.inmemory.utils.LdifAdjustor for more information. This class supports both IDE and command line execution.

Deployment

Deployment occurs by adding a WAR file and resources. To accomplish this, you will copy and modify the resources from test into your classpath to a servlet container such as Jetty or Tomcat. A class is provided within the test package to allow the server to be easily run within an IDE. By default, the application is configured to run on localhost 127.0.0.1 and on port 10389.

Logging

Logging occurs through the SLF4J logging facade which is backed by Log4J. Log levels can be configured from within the log4j.xml. Two handlers have been implemented to allow IM-LDAP events to be exposed by log statements, which could also be captured by specific log file appenders (not included at this time).

Listener

The IM-LDAP allows for multiple listeners to be configured against the same internal server repository distinguished by port and authentication mechanism. However, currently, this implementation only supports use of one listener via the configuration file. Refer to the UnboundedID documentation [link] for more information.

Supported Platforms

The IM-LDAP runs within a Java Virtual Machine.

Recommended Skill Sets

Skill set for IM-LDAP out-of-box use:

  • Maven
  • Jetty

Skill set to change or modify how IM-LDAP works:

  • Familiarity with LDAP (entries, Apache Directory Studio, LDIF export format, LDAP schemas, keystones)
  • Maven
  • Jetty/Tomcat
  • XML
  • Java (classpath)

LDAP Best Practices

http://www.ldapguru.info/ldap/ldap-programming-practices.html

Integrating with the Secure Data Service

  • SDS installation/configuration is recommended prior to setting up LDAP. Then, once the LDAP is set up, you can deploy and run it on the configured SDS platform. The links below provide information on SDS installation/configuration:

  • inBloom platform with the following components running:

    • API
    • Simple IDP
    • Ingest
    • Search Indexer

  • Small dataset successfully loaded.

Configuration

Platform

After SDS artifacts have been built and deployed, you must modify the sli.properties entries. Alternatively, the YML used to generate sli.properties could be modified. However, this procedure is more complex and changes the default "local" behavior.

To generate a value for the property sli.api.ldap.pass that matches the IM-LDAP root password, run the org.slc.sli.encryption.tool.Encryptor class via your IDE. The class contains a main method that can be executed from within the IDE (or modified locally as required). The example below uses a value based on the password “test1234”.

NOTE: sli.simple-idp.ldap.urls should use the appropriate IP address. This implementation will attempt to bind to all interfaces available on the provided address.

Within sli.properties change the following values:

  sli.simple-idp.ldap.urls = ldap://127.0.0.1:10389
  sli.api.ldap.pass = FEEBEC071D0C8CA1886224930EEE3F6D

For reference: the original value from git:

  sli.api.ldap.pass = F8EEEB5397084B5DD8EA44604D8CC39A
  sli.api.ldap.user = cn=Admin,dc=slidev,dc=org

ldap-inmemory-config.xml

  • Refer to the ldap-inmemory-config.xml file found within the test/resources. This config file is validated against the ldap-inmemory-config.xsd.
  • A root element must be specified within the configuration. All LDIFs are loaded beneath the root. If an LDIF contains the root node, remove it from the LDIF and add it to the config file. Note that only one root element may be specified.
  • LDIF files are loaded, in order, as defined in the configuration file. One to many LDIF files may be loaded. Optionally, zero to many LDAP entries may be specified (without attributes).
  • At this time, only one listener is supported. If the address is not specified for a listener, the server will attempt to bind to all available local interfaces. (This is considered default behavior for the UnboundedID SDK. For more information, refer to the UnboundedID documentation [link].)

Local Deployment

A local deployment can be invoked directly via Maven. When the IM-LDAP server is run in this mode, it will use the "test" classpath and "test" resources.

  1. Access the git repository and navigate to the root directory.
  2. Build the artifacts: mvn clean install package -Dsli.env=local-ldap-server.
  3. Run the server using mvn jetty:run. This will use the “test” classpath (which means resources found beneath test).
  4. Start the inBloom admin-rails application.
  5. Select the URL: http://local.slidev.org:3001/application_authorizations
  6. Login to the inBloom realm using iladmin.
  7. Start the data browser: http://local.slidev.org:3000
  8. Login to "Il daybreak 4529" realm using the user "rrogers". Remember, all passwords are reset to "username" + "1234" when LDIFs are loaded, so the password will be "rrogers1234".
  9. Browse data.

NOTE: It is possible to restart the IM-LDAP server while Simple IDP is running without affecting their respective functionality.

Deployment

A deployment can be invoked directly via Maven. When the IM-LDAP server is run in this mode, it will use the "test" classpath and "test" resources.

  1. Access the git repository and navigate to the root directory.
  2. Build the artifacts: mvn clean install package.
  3. Copy the resulting war file into your Java servlet container/application server (e.g. Tomcat or Jetty).
  4. Make the required resources are available on the classpath:
  5. ldap-inmemory-config.xml
  6. Resources specified within the XML must exist relative to classpath: - src/test/resources/ldif/ldap-schema.ldif (Replace with LDIF schema export if customized, one schema for all LDIFs.) - src/test/resources/ldif/2014_01_16_ldap_export.ldif.modified (Replace with LDIFs, if customized.)
  7. Start the server.
  8. Verify proper functionality using Apache Directory Studio.

Apache Directory Studio

You can connect to the IM-LDAP by using the Apache Directory Studio. Create a new connection to the local LDAP:

Property Setting
Hostname 127.0.0.1
Port 10389
Authentication Method Simple Authentication
Bind DN cn=Admin,dc=slidev,dc=org
Bind Password test1234

Resources

The following list includes items related to this solution: