an ldap backed user model for unpm
var UNPM = require('unpm')
var ldapAuth = require('unpm-ldap')
var unpm = new UNPM({
User: ldapAuth({
url: 'ldap://localhost:8321',
searchBase: 'ou=example-org',
searchFilter: '(uid={{username}})'
})
})
options are passed to ldapauth-fork.
-
eg. 'ldaps://ldap.example.com:663'
-
eg. 'uid=myapp,ou=users,o=example.com'.
-
Password for bindDn
-
defaults to 'dn'. Property of user to bind against client eg. 'name', 'email'
-
The base DN from which to search for users by username. eg. 'ou=users,o=example.com'
-
Optional, default 'sub'. Scope of the search, one of 'base', 'one', or 'sub'.
-
LDAP search filter with which to find a user by username, e.g. '(uid={{username}})'. Use the literal '{{username}}' to have the given username be interpolated in for the LDAP search.
-
default all. Array of attributes to fetch from LDAP server.
-
default 'dn'. The property of user object to use in '{{dn}}' interpolation of groupSearchFilter.
-
The base DN from which to search for groups. If defined, also groupSearchFilter must be defined for the search to work.
-
default 'sub'.
-
LDAP search filter for groups. The following literals are interpolated from the found user object: '{{dn}}' the property configured with groupDnProperty.
-
default all. Array of attributes to fetch from LDAP server.
-
The require'd log4js module to use for logging. If given this will result in TRACE-level logging for ldapauth.
-
default false. If
log4js
is also given, this will add TRACE-level logging for ldapjs (quite verbose). -
default false. If true, then up to 100 credentials at a time will be cached for 5 minutes.
-
default Infinity. How long the client should let operations live for before timing out.
-
Optional, default is up to the OS. How long the client should wait before timing out on TCP connections.
-
Additional options passed to the TLS connection layer when connecting via ldaps://. See http://nodejs.org/api/tls.html#tls_tls_connect_options_calback for available options
-
Whether or not to enable connection pooling, and if so, how many to maintain.
-
How often to schedule health checks for the connection pool.
-
How long a client can be idle before health-checking the connection (subject to the checkInterval frequency)
-
default false. Set to true to add property '_raw' containing the original buffers to the returned user object. Useful when you need to handle binary attributes
-
node-ldap reconnect option.