simple-ldap-search/index.js

Simple LDAP Searching.

/**
 * A simple LDAP query machine
 */
import ldap from 'ldapjs';
import cleanEntry from './lib/cleanEntry.js';
import addListenerIfNotAdded from './lib/addListenerIfNotAdded.js';

export default class SimpleLDAPSearch {
  constructor({ url, base, dn, password, tlsOptions = {} }) {
    this.config = {
      url,
      base,
      dn,
      password,
      tlsOptions,
    };

    this.client = ldap.createClient({ url, tlsOptions });
    this.isBoundTo = null;
    this.isBinding = false;
    this.queue = [];
  }

  /**
   * destroys the ldap client
   */
  destroy() {
    if (this.client) {
      this.client.destroy();
      this.client = null;
    }
    this.isBoundTo = null;
  }

  bindDN() {
    const self = this;
    const { dn, password } = this.config;

    return new Promise((resolve, reject) => {
      // handle case where ldapjs client emits 'error' event
      // e.g. if a bad URL is given
      addListenerIfNotAdded(self.client, 'error', reject);

      if (!dn || !password) {
        return reject(new Error('No bind credentials provided'));
      }

      if (this.isBoundTo === dn) {
        return resolve();
      }

      if (this.isBoundTo && this.isBoundTo !== dn) {
        return reject(new Error(`bound to different dn: ${dn}`));
      }

      if (this.isBinding) {
        // put this resolve function on the queue
        // to be called when binding completes
        return this.queue.push(resolve);
      }

      self.isBinding = true;
      return this.client.bind(dn, password, (err, res) => {
        if (err) return reject(err);

        self.isBinding = false;
        self.isBoundTo = dn;

        // resolve everything on this.queue
        self.queue.forEach((fn) => fn());
        self.queue = [];
        return resolve(res);
      });
    });
  }

  /**
   * searches ldap. Will autobind if
   * this.config.dn and this.config.password are set.
   */
  async search(filter = '(objectclass=*)', attributes) {
    const self = this;
    const opts = {
      scope: 'sub',
      filter,
      attributes,
    };
    const results = [];

    // bind if not bound
    await self.bindDN();

    return new Promise((resolve, reject) => {
      // handle case where ldapjs client emits 'error' event
      addListenerIfNotAdded(this.client, 'error', reject);

      self.client.search(self.config.base, opts, (err, res) => {
        if (err) {
          return reject(new Error(`Search failed: ${err.message}`));
        }

        return res
          .on('searchEntry', (entry) => results.push(cleanEntry(entry.object)))
          .once('error', (resError) =>
            reject(new Error(`Search error: ${resError}`)),
          )
          .once('end', () => resolve(results));
      });
    });
  }
}