xo-server-auth-ldap

LDAP authentication plugin for XO-Server

Install

Installation of the npm package:

> npm install xo-server-auth-ldap

Usage

To enable this plugin you have to add it into the configuration file of XO-Server:

plugins:

  auth-ldap:
    uri: "ldap://ldap.example.org"

    # Credentials to use before looking for the user record.
    #
    # Default to anonymous.
    bind:

      # Distinguished name of the user permitted to search the LDAP
      # directory for the user to authenticate.
      dn: 'cn=admin,ou=people,dc=example,dc=org'

      # Password of the user permitted to search the LDAP directory.
      password: 'secret'

    # The base is the part of the directory tree where the users are
    # looked for.
    base: "ou=people,dc=example,dc=org"

    # Filter used to find the user.
    #
    # Default is `'(uid={{name}})'`.
    #filter: '(uid={{name}})'

Algorithm

If bind is defined, attempt to bind using this user.
Searches for the user in the directory starting from the base with the defined filter.
If found, a bind is attempted using the distinguished name of this user and the provided password.

Development

Installing dependencies

> npm install

Compilation

The sources files are watched and automatically recompiled on changes.

> npm run dev

Tests

> npm run test-dev

Contributions

Contributions are very welcomed, either on the documentation or on the code.

You may:

report any issue you've encountered;
fork and create a pull request.

1.9 KiB Raw Blame History