LDAP Client and Server API for node.js

Go to file

Patrick Mooney 92362e01f3 Improve parser error handling - Wrap parser errors with VError - Catch initial potential sequence errors - Improve parser test coverage - Emit parser errors instead of implicitly logging Fix mcavage/node-ldapjs#221		2014-09-16 15:23:21 -05:00
bin	Cleanup lint/cruft	2014-07-29 10:21:57 -05:00
deps	Update jsstyle version	2014-06-16 09:31:12 -05:00
docs	Merge dozoisch/patch-1	2014-07-05 23:04:07 -05:00
examples	Remove pooled client example	2014-07-06 01:01:28 -05:00
lib	Improve parser error handling	2014-09-16 15:23:21 -05:00
test	Improve parser error handling	2014-09-16 15:23:21 -05:00
tools	Improve client reconnect behavior	2014-06-27 16:15:04 -05:00
.dir-locals.el	Initial setup for 0.5 (use eng.git layout)	2012-02-18 08:15:52 +00:00
.gitignore	Convert tests to use tape/istanbul/faucet	2014-07-08 15:09:26 -05:00
.gitmodules	Initial setup for 0.5 (use eng.git layout)	2012-02-18 08:15:52 +00:00
.npmignore	npm ignore	2013-01-29 18:39:41 +00:00
.travis.yml	Add node.js 0.11 to Travis tests	2014-07-18 10:43:45 -05:00
CHANGES.md	Add resultError event to client	2014-07-25 13:35:15 -05:00
LICENSE	Initial working client/server version	2011-08-04 13:32:01 -07:00
Makefile	Convert tests to use tape/istanbul/faucet	2014-07-08 15:09:26 -05:00
README.md	Cleanup README formatting	2014-07-06 11:59:08 -05:00
package.json	Improve parser error handling	2014-09-16 15:23:21 -05:00

README.md

LDAPjs

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

Formatting objectGUID attribute value

var ldap = require('ldapjs');

ldap.Attribute.settings.guid_format = ldap.GUID_FORMAT_B;

var client = ldap.createClient({
  url: 'ldap://127.0.0.1/CN=test,OU=Development,DC=Home'
});

var opts = {
  filter: '(objectclass=user)',
  scope: 'sub',
  attributes: ['objectGUID']
};

client.bind('username', 'password', function (err) {
  client.search('CN=test,OU=Development,DC=Home', opts, function (err, search) {
    search.on('searchEntry', function (entry) {
      var user = entry.object;
      console.log(user.objectGUID);
    });
  });
});

Note: for the sake of simplicity all checks and error handling was removed from the sample above.

The console output may be similar to the following (depending on the amount of users in the directory):

{a7667bb1-4aee-48ce-9d9d-a1193550deba}
{8d642ac8-14c6-4f27-ac5-94d39833da88}

Available formatting modes:

GUID_FORMAT_N
    N specifier, 32 digits:
    00000000000000000000000000000000
GUID_FORMAT_D
    D specifier, 32 digits separated by hypens:
    00000000-0000-0000-0000-000000000000
GUID_FORMAT_B
    B specifier, 32 digits separated by hyphens, enclosed in braces:
    {00000000-0000-0000-0000-000000000000}
GUID_FORMAT_P
    P speficier, 32 digits separated by hyphens, enclosed in parentheses:
    (00000000-0000-0000-0000-000000000000)
GUID_FORMAT_X
    X speficier, four hexadecimal values enclosed in braces,
    where the fourth value is a subset of eight hexadecimal values that is also enclosed in braces:
    {0x00000000,0x0000,0x0000,{0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00}}

GUID formatting is unobtrusive by default. You should explicitly define formatting mode in order to enable it.

License

MIT.

Bugs

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