Waterlock-multiple-ldap-auth NPM

Waterlock Multiple LDAP Auth

waterlock-multiple-ldap-auth is a module for waterlock providing multiple LDAP authentication methods for users based on customizable LDAP queries. It uses ldapauth-fork to faciliate LDAP authentication.

Usage

npm install waterlock-multiple-ldap-auth

By modifying the configration settings in config/waterlock.js, you can configure the connection string as an object, naming each one as you see fit. The login action will iterate over these when a user attempts to login. The first connection to respond successfully, returns a success result.

authMethod:[
  {
    name: "waterlock-multiple-ldap-auth",
    connection: {
      example : {
        url             : "ldaps://ldap.example.com:636",
        bindDn          : "uid=myadminusername,ou=users,o=example.com",
        bindCredentials : "mypassword",
        searchBase      : "ou=users,o=example.com",
        searchFilter    : "(uid={{username}})",
        cache           : true
      },
      insecure : {
        url             : "ldap://ldap.insecure.com:389",
        bindDn          : "uid=myadminusername,ou=users,o=insecure.com",
        bindCredentials : "mypassword",
        searchBase      : "ou=users,o=insecure.com",
        searchFilter    : "(uid={{username}})",
        cache           : true
      },
      cannibalCorpse : {
        url             : "ldaps://ldap.cannibalcorpse.net:636",
        bindDn          : "uid=george,ou=users,o=cannibalcorpse.net",
        bindCredentials : "kill",
        searchBase      : "ou=users,o=cannibalcorpse.net",
        searchFilter    : "(uid={{username}})",
        cache           : true
      },
    },
    attributes: {}
  }
]

Auth Model

LDAP auth adds the following attributes onto the Auth model:

  entryUUID: {
    type: 'string',
    unique: true
  },
  dn: {
    type: 'string',
    unique: true
  }

They map the dn and theentryUUID values of the LDAP user to the Auth model.

With the way waterlock is designed and this model you can override any of these attributes.

waterlock-multiple-ldap-auth will create a new Auth and User if LDAP authentication succeeds but no Auth/User is found.

Mapping LDAP attributes

It is possible to map attributes from the LDAP user object to the Auth model automatically. Just add objects to the attributes property:

authMethod:[
  {
    name: "waterlock-multiple-ldap-auth",
    connection: { ... },
    attributes: {
      uid: {
        uid: {
          type: 'string'
        }
      },
      cn: {
        fullname: {
          type: 'string'
        }
      },
      mail: {
        email: {
          type: 'string'
        }
      }
    }
  }
]

This example adds a mapping from LDAP to Auth model: