LDAP Client and Server API for node.js
Go to file
Axel Kittenberger e2c0949dd5 transcontextual safe type checks 2023-03-28 10:34:04 -04:00
.github Update supported Node versions (CI) 2023-02-22 14:09:27 -05:00
docs Quick fix for outdated client doc 2023-03-07 16:09:06 -05:00
examples Update deps 2023-02-22 14:09:27 -05:00
lib transcontextual safe type checks 2023-03-28 10:34:04 -04:00
scripts chore: fix building docs 2021-11-13 01:08:01 -06:00
test Resolve issue #845 2023-03-08 17:11:44 -05:00
test-integration Add test for issue 860 2023-03-27 09:57:55 -04:00
.eslintignore chore(lint): use eslint instead of standard 2020-12-06 11:10:55 -06:00
.eslintrc.js Replace messages with @ldapjs/messages 2023-02-22 14:09:27 -05:00
.gitignore docs: simplify docs 2021-02-25 01:39:35 -06:00
.npmrc Replace messages with @ldapjs/messages 2023-02-22 14:09:27 -05:00
.taprc.yml Reduce coverage requirement 2023-02-22 14:09:27 -05:00
CHANGES.md Update changelog 2020-05-31 08:58:50 -04:00
LICENSE Touch up package.json, license, readme 2019-08-27 17:22:26 -04:00
README.md Add Node.js version support to readme 2023-03-08 17:25:16 -05:00
docker-compose.yml Update docker config 2022-03-27 12:02:59 -04:00
package.json build(deps): bump @ldapjs/messages from 1.0.1 to 1.0.2 2023-03-11 08:55:04 -05:00

README.md

LDAPjs

Build Status Coverage Status

LDAPjs makes the LDAP protocol a first class citizen in Node.js.

Usage

For full docs, head on over to http://ldapjs.org.

var ldap = require('ldapjs');

var server = ldap.createServer();

server.search('dc=example', function(req, res, next) {
  var 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, function() {
  console.log('ldapjs listening at ' + server.url);
});

To run that, assuming you've got the OpenLDAP client on your system:

ldapsearch -H ldap://localhost:1389 -x -b dc=example objectclass=*

Installation

npm install ldapjs

Node.js Version Support

As of ldapjs@3 we only support the active Node.js LTS releases. See https://github.com/nodejs/release#release-schedule for the LTS release schedule.

For a definitive list of Node.js version we support, see the version matrix we test against in our CI configuration.

Note: given the release date of ldapjs@3, and the short window of time that Node.js v14 had remaining on its LTS window, we opted to not support Node.js v14 with ldapjs@3 (we released late February 2023 and v14 goes into maintenance in late April 2023). Also, Node.js v14 will be end-of-life (EOL) on September 11, 2023; this is a very shortened EOL timeline and makes it even more reasonable to not support it at this point.

License

MIT.

Bugs

See https://github.com/ldapjs/node-ldapjs/issues.