Package Exports

ldap-authentication

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ldap-authentication) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

A Simple node Library that Authenticates a User Against an LDAP/AD Server

This library use ldapjs as the underneath library. It has two modes of authentications:

If an admin user is provided, the library will login (ldap bind) with the admin user, then search for the user to be authenticated, get its DN (distinguish name), then use the user DN and password to login again. If every thing is ok, the user details will be returned.
If the admin user is not provided, then the user DN must be provided. The lib simply does a login with the user DN and password, then do a search on the user and return the user's details.

Features

Can use an admin to search and authenticate a user
Can also use a regular user and authenticate the user itself
Supports ldap, ldaps, and STARTTLS
Async/Await Promise

How to Use

Installation

npm install ldap-authentication --save

Simple example

let user = await authenticate(options)

Complete example

const { authenticate } = require('ldap-authentication')

async function auth() {

  // auth with admin
  let options = {
    ldapOpts: {
      url: 'ldap://ldap.forumsys.com',
      // tlsOptions: { rejectUnauthorized: false }
    },
    adminDn: 'cn=read-only-admin,dc=example,dc=com',
    adminPassword: 'password',
    userPassword: 'password',
    userSearchBase: 'dc=example,dc=com',
    userSearchFilter: '(uid=gauss)',
    // starttls: false
  }
  
  let user = await authenticate(options)
  console.log(user)

  // auth with regular user
  options = {
    ldapOpts: {
      url: 'ldap://ldap.forumsys.com',
      // tlsOptions: { rejectUnauthorized: false }
    },
    userDn: 'uid=einstein,dc=example,dc=com',
    userPassword: 'password',
    userSearchBase: 'dc=example,dc=com',
    userSearchFilter: '(uid=einstein)',
    // starttls: false
  }

  user = await authenticate(options)
  console.log(user)
}

auth()

Parameters

ldapOpts: This is passed to ldapjs client directly
- url: url of the ldap server. Example: ldap://ldap.forumsys.com
- tlsOptions: options to pass to node tls. Example: { rejectUnauthorized: false }
adminDn: The DN of the admistrator. Example: 'cn=read-only-admin,dc=example,dc=com',
adminPassword: The password of the admin.
userDn: The DN of the user to be authenticated. This is only needed if adminDn and adminPassword are not provided. Example: uid=gauss,dc=example,dc=com
userPassword: The password of the user,
userSearchBase: The ldap base DN to search the user. Example: dc=example,dc=com
usernameAttribute: The ldap search equality attribute name corresponding to the user's username. It will be used with the value in username to construct an ldap filter as ({attribute}={username}) to find the user and get user details in LDAP. Example: uid
username: The username to authenticate with. It is used together with the name in usernameAttribute to construct an ldap filter as ({attribute}={username}) to find the user and get user details in LDAP. Example: some user input
starttls: Boolean. Use STARTTLS or not