Spring Boot LDAP HTTP REST API

This is an example of a LDAP server with a HTTP REST API interface. This sample illustrates the CRUD of users under OU Users to the domain theinterview.com. The management of users is made via a HTTP REST API.

In the subsequent sections you will see: i) how to setup the environment; ii) the commands required to run the server; and iii) how to run tests.

Setting up the environment

Have the following requirements installed on your machine:

• Docker CE (Ubuntu | MacOS X);
• MacOS X or Linux (Docker is unstable on Windows).

Project Structure

See the project structure bellow.

.
├── .env
├── README.md
├── config
│   └── create_ou_users.ldif
├── docker-compose.yaml
└── ldap-rest-api (Java Project)
    ├── mvnw
    ├── mvnw.cmd
    ├── pom.xml
    └── src

The docker-compose.yaml describes the orchestration of two container services. The first one, ldap-server, runs an instance of the OpenLDAP server, see osixia/openldap. The second service, rest-api, runs the Java Spring Boot project inside folder ldap-rest-api which is the HTTP REST API interface.

The file config/create_ou_users.ldif describes the OU Users structure that will hold the users that come from the HTTP REST API.

How to run the server

Execute the command as follows to startup the server.

docker-compose up -d

The default LDAP_ADMIN_PASSWORD is 123456 and comes from the .env file at the root of the project. If you want to change the LDAP server password you can override the value by exporting the environment variable LDAP_ADMIN_PASSWORD or change the value at the .env file.

To shutdown the server, execute docker-compose down.

Persisting data

You may wish to persist data even after the container stops. To do so, at your host machine, create the folders ${PATH_TO_YOUR_DATA}/lpad/sldap/database and ${PATH_TO_YOUR_DATA}/lpad/sldap/config. Then bind these folders as follows in your docker-compose.yaml:

version: '3'
services:
  ldap-server:
    image: "osixia/openldap:1.3.0"
    .
    .
    .
    volumes:
        .
        .
        .
        - ${PATH_TO_YOUR_DATA}/lpad/sldap/database:/var/lib/ldap
        - ${PATH_TO_YOUR_DATA}/lpad/sldap/config:/etc/ldap/slapd.d
    .
    .
    .

How to see logs

To see the logs, execute the command:

docker-compose logs -f

How to run tests

Execute the maven wrapper with the following args:

./mvnw test

This requires Java JDK 11 installed.

HTTP REST API Endpoints

You can see the documentation after starting up your server at http://localhost:8080/swagger-ui/. In addition, the table bellow describes each endpoint.

Path	Method	Request Body	Description
/Users	POST	{ "uid": "john", "cn": "John", "sn": "Doe" }	Add an user entry.
/Users	GET	N/A	Retrieve all users.
/Users/<uid>	GET	N/A	Retrieve a user entry.given an user uid.
/Users/<uid>	DELETE	N/A	Delete a user entry. given an user uid.