ldapjs

Common errors

Warnings

Install

Imports

• default (ldap)
  wrong

  import ldap from 'ldapjs';

  correct

  const ldap = require('ldapjs');

  ldapjs is a CommonJS module and does not support ESM default import. Use require() instead.

• createClient
  wrong

  const { createClient } = require('ldapjs'); const client = createClient({ url: '...' });

  correct

  const ldap = require('ldapjs'); const client = ldap.createClient({ url: 'ldap://localhost:1389' });

  Named exports are available via destructuring, but ensure the module is required first. Direct destructuring without require is not valid.

• Attribute
  wrong

  const { Attribute } = require('ldapjs'); const attr = new Attribute({ ... });

  correct

  const ldap = require('ldapjs'); const attr = new ldap.Attribute({ type: 'cn', vals: ['test'] });

  Same as above: require the module, then destructure.

Quickstart

Creates a simple LDAP server that responds to searches, and a client that binds and unbinds.

const ldap = require('ldapjs');

// Create a server
const server = ldap.createServer();

server.search('dc=example', (req, res, next) => {
  const obj = {
    dn: req.dn.toString(),
    attributes: {
      objectclass: ['organization', 'top'],
      o: 'example'
    }
  };
  if (req.filter.matches(obj.attributes)) res.send(obj);
  res.end();
});

server.listen(1389, () => {
  console.log('LDAP server listening at ' + server.url);
});

// Also create a client
const client = ldap.createClient({ url: 'ldap://localhost:1389' });
client.bind('cn=root', 'secret', (err) => {
  if (err) console.error(err);
  else console.log('bound');
});
client.unbind();