https://github.com/trentm/node-ldapauth

**UNMAINTAINED.** Simple node.js module to authenticate against an LDAP server
https://github.com/trentm/node-ldapauth

Last synced: 3 days ago
JSON representation

**UNMAINTAINED.** Simple node.js module to authenticate against an LDAP server

• Host: GitHub
• URL: https://github.com/trentm/node-ldapauth
• Owner: trentm
• License: mit
• Created: 2011-12-13T23:02:15.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2020-09-24T23:39:37.000Z (over 4 years ago)
• Last Synced: 2024-12-15T08:04:44.897Z (11 days ago)
• Language: Perl
• Homepage:
• Size: 55.7 KB
• Stars: 127
• Watchers: 8
• Forks: 144
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**Note: This repo is unmaintained and has been for a while. If you are

interested in taking over this repo, then please let me know (trentm at

google's email thing).**

* * *

A simple node.js lib to authenticate against an LDAP server.

# Usage

    var LdapAuth = require('ldapauth');

    var options = {

        url: 'ldaps://ldap.example.com:663',

        ...

    };

    var auth = new LdapAuth(options);

    ...

    auth.authenticate(username, password, function(err, user) { ... });

    ...

    auth.close(function(err) { ... })

# Install

    npm install ldapauth

# License

MIT. See "LICENSE" file.

# `LdapAuth` Config Options

[Use the source Luke](https://github.com/trentm/node-ldapauth/blob/master/lib/ldapauth.js#L25-53)

# express/connect basicAuth example

    var connect = require('connect');

    var LdapAuth = require('ldapauth');

    // Config from a .json or .ini file or whatever.

    var config = {

      ldap: {

        url: "ldaps://ldap.example.com:636",

        adminDn: "uid=myadminusername,ou=users,o=example.com",

        adminPassword: "mypassword",

        searchBase: "ou=users,o=example.com",

        searchFilter: "(uid={{username}})"

      }

    };

    var ldap = new LdapAuth({

      url: config.ldap.url,

      adminDn: config.ldap.adminDn,

      adminPassword: config.ldap.adminPassword,

      searchBase: config.ldap.searchBase,

      searchFilter: config.ldap.searchFilter,

      //log4js: require('log4js'),

      cache: true

    });

    var basicAuthMiddleware = connect.basicAuth(function (username, password, callback) {

      ldap.authenticate(username, password, function (err, user) {

        if (err) {

          console.log("LDAP auth error: %s", err);

        }

        callback(err, user)

      });

    });

# Development

Check coding style before commit:

    make check

To cut a release (tagging, npm publish, etc., see

 for details):

    make cutarelease