1377 lines
39 KiB
JavaScript
1377 lines
39 KiB
JavaScript
// Copyright 2011 Mark Cavage, Inc. All rights reserved.
|
|
|
|
var EventEmitter = require('events').EventEmitter;
|
|
var net = require('net');
|
|
var tls = require('tls');
|
|
var util = require('util');
|
|
var once = require('once');
|
|
var backoff = require('backoff');
|
|
var vasync = require('vasync');
|
|
|
|
var assert = require('assert-plus');
|
|
|
|
var Attribute = require('../attribute');
|
|
var Change = require('../change');
|
|
var Control = require('../controls/index').Control;
|
|
var SearchPager = require('./search_pager');
|
|
var Protocol = require('../protocol');
|
|
var dn = require('../dn');
|
|
var errors = require('../errors');
|
|
var filters = require('../filters');
|
|
var messages = require('../messages');
|
|
var url = require('../url');
|
|
|
|
|
|
|
|
///--- Globals
|
|
|
|
var AbandonRequest = messages.AbandonRequest;
|
|
var AddRequest = messages.AddRequest;
|
|
var BindRequest = messages.BindRequest;
|
|
var CompareRequest = messages.CompareRequest;
|
|
var DeleteRequest = messages.DeleteRequest;
|
|
var ExtendedRequest = messages.ExtendedRequest;
|
|
var ModifyRequest = messages.ModifyRequest;
|
|
var ModifyDNRequest = messages.ModifyDNRequest;
|
|
var SearchRequest = messages.SearchRequest;
|
|
var UnbindRequest = messages.UnbindRequest;
|
|
var UnbindResponse = messages.UnbindResponse;
|
|
|
|
var LDAPResult = messages.LDAPResult;
|
|
var SearchEntry = messages.SearchEntry;
|
|
var SearchReference = messages.SearchReference;
|
|
var SearchResponse = messages.SearchResponse;
|
|
var Parser = messages.Parser;
|
|
|
|
var PresenceFilter = filters.PresenceFilter;
|
|
|
|
var ConnectionError = errors.ConnectionError;
|
|
|
|
var CMP_EXPECT = [errors.LDAP_COMPARE_TRUE, errors.LDAP_COMPARE_FALSE];
|
|
var MAX_MSGID = Math.pow(2, 31) - 1;
|
|
|
|
// node 0.6 got rid of FDs, so make up a client id for logging
|
|
var CLIENT_ID = 0;
|
|
|
|
|
|
|
|
///--- Internal Helpers
|
|
|
|
function nextClientId() {
|
|
if (++CLIENT_ID === MAX_MSGID)
|
|
return 1;
|
|
|
|
return CLIENT_ID;
|
|
}
|
|
|
|
function validateControls(controls) {
|
|
if (Array.isArray(controls)) {
|
|
controls.forEach(function (c) {
|
|
if (!(c instanceof Control))
|
|
throw new TypeError('controls must be [Control]');
|
|
});
|
|
} else if (controls instanceof Control) {
|
|
controls = [controls];
|
|
} else {
|
|
throw new TypeError('controls must be [Control]');
|
|
}
|
|
|
|
return controls;
|
|
}
|
|
|
|
/**
|
|
* Queue to contain LDAP requests.
|
|
*
|
|
* @param {Object} opts queue options
|
|
*
|
|
* Accepted Options:
|
|
* - size: Maximum queue size
|
|
* - timeout: Set timeout between first queue insertion and queue flush.
|
|
*/
|
|
function RequestQueue(opts) {
|
|
if (!opts || typeof (opts) !== 'object') {
|
|
opts = {};
|
|
}
|
|
this.size = (opts.size > 0) ? opts.size : Infinity;
|
|
this.timeout = (opts.timeout > 0) ? opts.timeout : 0;
|
|
this._queue = [];
|
|
this._timer = null;
|
|
this._frozen = false;
|
|
}
|
|
|
|
/**
|
|
* Insert request into queue.
|
|
*
|
|
*/
|
|
RequestQueue.prototype.enqueue = function enqueue(msg, expect, emitter, cb) {
|
|
if (this._queue.length >= this.size || this._frozen) {
|
|
return false;
|
|
}
|
|
var self = this;
|
|
this._queue.push([msg, expect, emitter, cb]);
|
|
if (this.timeout > 0) {
|
|
if (this._timer !== null) {
|
|
this._timer = setTimeout(function () {
|
|
// If queue times out, don't allow new entries until thawed
|
|
self.freeze();
|
|
self.purge();
|
|
}, this.timeout);
|
|
}
|
|
}
|
|
return true;
|
|
};
|
|
|
|
/**
|
|
* Process all queued requests with callback.
|
|
*/
|
|
RequestQueue.prototype.flush = function flush(cb) {
|
|
if (this._timer) {
|
|
clearTimeout(this._timer);
|
|
this._timer = null;
|
|
}
|
|
var items = this._queue;
|
|
this._queue = [];
|
|
items.forEach(function (req) {
|
|
cb(req[0], req[1], req[2], req[3]);
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Purge all queued requests with an error.
|
|
*/
|
|
RequestQueue.prototype.purge = function purge() {
|
|
this.flush(function (msg, expect, emitter, cb) {
|
|
cb(new errors.TimeoutError('request queue timeout'));
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Freeze queue, refusing any new entries.
|
|
*/
|
|
RequestQueue.prototype.freeze = function freeze() {
|
|
this._frozen = true;
|
|
};
|
|
|
|
/**
|
|
* Thaw queue, allowing new entries again.
|
|
*/
|
|
RequestQueue.prototype.thaw = function thaw() {
|
|
this._frozen = false;
|
|
};
|
|
|
|
|
|
/**
|
|
* Track message callback by messageID.
|
|
*/
|
|
function MessageTracker(opts) {
|
|
assert.object(opts);
|
|
assert.string(opts.id);
|
|
assert.object(opts.parser);
|
|
|
|
this.id = opts.id;
|
|
this._msgid = 0;
|
|
this._messages = {};
|
|
this._abandoned = {};
|
|
this.parser = opts.parser;
|
|
|
|
var self = this;
|
|
this.__defineGetter__('pending', function () {
|
|
return Object.keys(self._messages);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Record a messageID and callback.
|
|
*/
|
|
MessageTracker.prototype.track = function track(message, callback) {
|
|
var msgid = this._nextID();
|
|
message.messageID = msgid;
|
|
this._messages[msgid] = callback;
|
|
return msgid;
|
|
};
|
|
|
|
/**
|
|
* Fetch callback based on messageID.
|
|
*/
|
|
MessageTracker.prototype.fetch = function fetch(msgid) {
|
|
var msg = this._messages[msgid];
|
|
if (msg) {
|
|
this._purgeAbandoned(msgid);
|
|
return msg;
|
|
}
|
|
// It's possible that the server has not received the abandon request yet.
|
|
// While waiting for evidence that the abandon has been received, incoming
|
|
// messages that match the abandoned msgid will be handled as normal.
|
|
msg = this._abandoned[msgid];
|
|
if (msg) {
|
|
return msg.cb;
|
|
}
|
|
return null;
|
|
};
|
|
|
|
/**
|
|
* Cease tracking for a given messageID.
|
|
*/
|
|
MessageTracker.prototype.remove = function remove(msgid) {
|
|
if (this._messages[msgid]) {
|
|
delete this._messages[msgid];
|
|
} else if (this._abandoned[msgid]) {
|
|
delete this._abandoned[msgid];
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Mark a messageID as abandoned.
|
|
*/
|
|
MessageTracker.prototype.abandon = function abandonMsg(msgid) {
|
|
if (this._messages[msgid]) {
|
|
// Keep track of "when" the message was abandoned
|
|
this._abandoned[msgid] = {
|
|
age: this._msgid,
|
|
cb: this._messages[msgid]
|
|
};
|
|
delete this._messages[msgid];
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Purge old items from abandoned list.
|
|
*/
|
|
MessageTracker.prototype._purgeAbandoned = function _purgeAbandoned(msgid) {
|
|
var self = this;
|
|
// Is (comp >= ref) according to sliding window
|
|
function geWindow(ref, comp) {
|
|
var max = ref + (MAX_MSGID/2);
|
|
var min = ref;
|
|
if (max >= MAX_MSGID) {
|
|
// Handle roll-over
|
|
max = max - MAX_MSGID - 1;
|
|
return ((comp <= max) || (comp >= min));
|
|
} else {
|
|
return ((comp <= max) && (comp >= min));
|
|
}
|
|
}
|
|
|
|
Object.keys(this._abandoned).forEach(function (id) {
|
|
// Abandoned messageIDs can be forgotten if a received messageID is "newer"
|
|
if (geWindow(self._abandoned[id].age, msgid)) {
|
|
self._abandoned[id].cb(new errors.AbandonedError(
|
|
'client request abandoned'));
|
|
delete self._abandoned[id];
|
|
}
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Allocate the next messageID according to a sliding window.
|
|
*/
|
|
MessageTracker.prototype._nextID = function _nextID() {
|
|
if (++this._msgid >= MAX_MSGID)
|
|
this._msgid = 1;
|
|
|
|
return this._msgid;
|
|
};
|
|
|
|
///--- API
|
|
|
|
/**
|
|
* Constructs a new client.
|
|
*
|
|
* The options object is required, and must contain either a URL (string) or
|
|
* a socketPath (string); the socketPath is only if you want to talk to an LDAP
|
|
* server over a Unix Domain Socket. Additionally, you can pass in a bunyan
|
|
* option that is the result of `new Logger()`, presumably after you've
|
|
* configured it.
|
|
*
|
|
* @param {Object} options must have either url or socketPath.
|
|
* @throws {TypeError} on bad input.
|
|
*/
|
|
function Client(options) {
|
|
assert.ok(options);
|
|
|
|
EventEmitter.call(this, options);
|
|
|
|
var self = this;
|
|
var _url;
|
|
if (options.url)
|
|
_url = url.parse(options.url);
|
|
this.host = _url ? _url.hostname : undefined;
|
|
this.port = _url ? _url.port : false;
|
|
this.secure = _url ? _url.secure : false;
|
|
this.url = _url;
|
|
this.tlsOptions = options.tlsOptions;
|
|
this.socketPath = options.socketPath || false;
|
|
|
|
this.log = options.log.child({clazz: 'Client'}, true);
|
|
|
|
this.timeout = parseInt((options.timeout || 0), 10);
|
|
this.connectTimeout = parseInt((options.connectTimeout || 0), 10);
|
|
this.idleTimeout = parseInt((options.idleTimeout || 0), 10);
|
|
if (options.reconnect) {
|
|
// Fall back to defaults if options.reconnect === true
|
|
var rOpts = (typeof (options.reconnect) === 'object') ?
|
|
options.reconnect : {};
|
|
this.reconnect = {
|
|
initialDelay: parseInt(rOpts.initialDelay || 100, 10),
|
|
maxDelay: parseInt(rOpts.maxDelay || 10000, 10),
|
|
failAfter: parseInt(rOpts.failAfter, 10) || Infinity
|
|
};
|
|
}
|
|
|
|
this.queue = new RequestQueue({
|
|
size: parseInt((options.queueSize || 0), 10),
|
|
timeout: parseInt((options.queueTimeout || 0), 10)
|
|
});
|
|
if (options.queueDisable) {
|
|
this.queue.freeze();
|
|
}
|
|
|
|
// Implicitly configure setup action to bind the client if bindDN and
|
|
// bindCredentials are passed in. This will more closely mimic PooledClient
|
|
// auto-login behavior.
|
|
if (options.bindDN !== undefined &&
|
|
options.bindCredentials !== undefined) {
|
|
this.on('setup', function (clt, cb) {
|
|
clt.bind(options.bindDN, options.bindCredentials, function (err) {
|
|
if (err) {
|
|
self.emit('error', err);
|
|
}
|
|
cb(err);
|
|
});
|
|
});
|
|
}
|
|
|
|
this.socket = null;
|
|
this.connected = false;
|
|
this.connect();
|
|
}
|
|
util.inherits(Client, EventEmitter);
|
|
module.exports = Client;
|
|
|
|
|
|
/**
|
|
* Sends an abandon request to the LDAP server.
|
|
*
|
|
* The callback will be invoked as soon as the data is flushed out to the
|
|
* network, as there is never a response from abandon.
|
|
*
|
|
* @param {Number} messageID the messageID to abandon.
|
|
* @param {Control} controls (optional) either a Control or [Control].
|
|
* @param {Function} callback of the form f(err).
|
|
* @throws {TypeError} on invalid input.
|
|
*/
|
|
Client.prototype.abandon = function abandon(messageID, controls, callback) {
|
|
assert.number(messageID, 'messageID');
|
|
if (typeof (controls) === 'function') {
|
|
callback = controls;
|
|
controls = [];
|
|
} else {
|
|
controls = validateControls(controls);
|
|
}
|
|
assert.func(callback, 'callback');
|
|
|
|
var req = new AbandonRequest({
|
|
abandonID: messageID,
|
|
controls: controls
|
|
});
|
|
|
|
return this._send(req, 'abandon', null, callback);
|
|
};
|
|
|
|
|
|
/**
|
|
* Adds an entry to the LDAP server.
|
|
*
|
|
* Entry can be either [Attribute] or a plain JS object where the
|
|
* values are either a plain value or an array of values. Any value (that's
|
|
* not an array) will get converted to a string, so keep that in mind.
|
|
*
|
|
* @param {String} name the DN of the entry to add.
|
|
* @param {Object} entry an array of Attributes to be added or a JS object.
|
|
* @param {Control} controls (optional) either a Control or [Control].
|
|
* @param {Function} callback of the form f(err, res).
|
|
* @throws {TypeError} on invalid input.
|
|
*/
|
|
Client.prototype.add = function add(name, entry, controls, callback) {
|
|
assert.string(name, 'name');
|
|
assert.object(entry, 'entry');
|
|
if (typeof (controls) === 'function') {
|
|
callback = controls;
|
|
controls = [];
|
|
} else {
|
|
controls = validateControls(controls);
|
|
}
|
|
assert.func(callback, 'callback');
|
|
|
|
if (Array.isArray(entry)) {
|
|
entry.forEach(function (a) {
|
|
if (!Attribute.isAttribute(a))
|
|
throw new TypeError('entry must be an Array of Attributes');
|
|
});
|
|
} else {
|
|
var save = entry;
|
|
|
|
entry = [];
|
|
Object.keys(save).forEach(function (k) {
|
|
var attr = new Attribute({type: k});
|
|
if (Array.isArray(save[k])) {
|
|
save[k].forEach(function (v) {
|
|
attr.addValue(v.toString());
|
|
});
|
|
} else {
|
|
attr.addValue(save[k].toString());
|
|
}
|
|
entry.push(attr);
|
|
});
|
|
}
|
|
|
|
var req = new AddRequest({
|
|
entry: dn.parse(name),
|
|
attributes: entry,
|
|
controls: controls
|
|
});
|
|
|
|
return this._send(req, [errors.LDAP_SUCCESS], null, callback);
|
|
};
|
|
|
|
|
|
/**
|
|
* Performs a simple authentication against the server.
|
|
*
|
|
* @param {String} name the DN to bind as.
|
|
* @param {String} credentials the userPassword associated with name.
|
|
* @param {Control} controls (optional) either a Control or [Control].
|
|
* @param {Function} callback of the form f(err, res).
|
|
* @throws {TypeError} on invalid input.
|
|
*/
|
|
Client.prototype.bind = function bind(name,
|
|
credentials,
|
|
controls,
|
|
callback,
|
|
_bypass) {
|
|
if (typeof (name) !== 'string' && !(name instanceof dn.DN))
|
|
throw new TypeError('name (string) required');
|
|
assert.string(credentials, 'credentials');
|
|
if (typeof (controls) === 'function') {
|
|
callback = controls;
|
|
controls = [];
|
|
} else {
|
|
controls = validateControls(controls);
|
|
}
|
|
assert.func(callback, 'callback');
|
|
|
|
var req = new BindRequest({
|
|
name: name || '',
|
|
authentication: 'Simple',
|
|
credentials: credentials || '',
|
|
controls: controls
|
|
});
|
|
|
|
return this._send(req, [errors.LDAP_SUCCESS], null, callback, _bypass);
|
|
};
|
|
|
|
|
|
/**
|
|
* Compares an attribute/value pair with an entry on the LDAP server.
|
|
*
|
|
* @param {String} name the DN of the entry to compare attributes with.
|
|
* @param {String} attr name of an attribute to check.
|
|
* @param {String} value value of an attribute to check.
|
|
* @param {Control} controls (optional) either a Control or [Control].
|
|
* @param {Function} callback of the form f(err, boolean, res).
|
|
* @throws {TypeError} on invalid input.
|
|
*/
|
|
Client.prototype.compare = function compare(name,
|
|
attr,
|
|
value,
|
|
controls,
|
|
callback) {
|
|
assert.string(name, 'name');
|
|
assert.string(attr, 'attr');
|
|
assert.string(value, 'value');
|
|
if (typeof (controls) === 'function') {
|
|
callback = controls;
|
|
controls = [];
|
|
} else {
|
|
controls = validateControls(controls);
|
|
}
|
|
assert.func(callback, 'callback');
|
|
|
|
var req = new CompareRequest({
|
|
entry: dn.parse(name),
|
|
attribute: attr,
|
|
value: value,
|
|
controls: controls
|
|
});
|
|
|
|
return this._send(req, CMP_EXPECT, null, function (err, res) {
|
|
if (err)
|
|
return callback(err);
|
|
|
|
return callback(null, (res.status === errors.LDAP_COMPARE_TRUE), res);
|
|
});
|
|
};
|
|
|
|
|
|
/**
|
|
* Deletes an entry from the LDAP server.
|
|
*
|
|
* @param {String} name the DN of the entry to delete.
|
|
* @param {Control} controls (optional) either a Control or [Control].
|
|
* @param {Function} callback of the form f(err, res).
|
|
* @throws {TypeError} on invalid input.
|
|
*/
|
|
Client.prototype.del = function del(name, controls, callback) {
|
|
assert.string(name, 'name');
|
|
if (typeof (controls) === 'function') {
|
|
callback = controls;
|
|
controls = [];
|
|
} else {
|
|
controls = validateControls(controls);
|
|
}
|
|
assert.func(callback, 'callback');
|
|
|
|
var req = new DeleteRequest({
|
|
entry: dn.parse(name),
|
|
controls: controls
|
|
});
|
|
|
|
return this._send(req, [errors.LDAP_SUCCESS], null, callback);
|
|
};
|
|
|
|
|
|
/**
|
|
* Performs an extended operation on the LDAP server.
|
|
*
|
|
* Pretty much none of the LDAP extended operations return an OID
|
|
* (responseName), so I just don't bother giving it back in the callback.
|
|
* It's on the third param in `res` if you need it.
|
|
*
|
|
* @param {String} name the OID of the extended operation to perform.
|
|
* @param {String} value value to pass in for this operation.
|
|
* @param {Control} controls (optional) either a Control or [Control].
|
|
* @param {Function} callback of the form f(err, value, res).
|
|
* @throws {TypeError} on invalid input.
|
|
*/
|
|
Client.prototype.exop = function exop(name, value, controls, callback) {
|
|
assert.string(name, 'name');
|
|
if (typeof (value) === 'function') {
|
|
callback = value;
|
|
controls = [];
|
|
value = '';
|
|
}
|
|
if (!(Buffer.isBuffer(value) || typeof (value) === 'string'))
|
|
throw new TypeError('value (Buffer || string) required');
|
|
if (typeof (controls) === 'function') {
|
|
callback = controls;
|
|
controls = [];
|
|
} else {
|
|
controls = validateControls(controls);
|
|
}
|
|
assert.func(callback, 'callback');
|
|
|
|
var req = new ExtendedRequest({
|
|
requestName: name,
|
|
requestValue: value,
|
|
controls: controls
|
|
});
|
|
|
|
return this._send(req, [errors.LDAP_SUCCESS], null, function (err, res) {
|
|
if (err)
|
|
return callback(err);
|
|
|
|
return callback(null, res.responseValue || '', res);
|
|
});
|
|
};
|
|
|
|
|
|
/**
|
|
* Performs an LDAP modify against the server.
|
|
*
|
|
* @param {String} name the DN of the entry to modify.
|
|
* @param {Change} change update to perform (can be [Change]).
|
|
* @param {Control} controls (optional) either a Control or [Control].
|
|
* @param {Function} callback of the form f(err, res).
|
|
* @throws {TypeError} on invalid input.
|
|
*/
|
|
Client.prototype.modify = function modify(name, change, controls, callback) {
|
|
assert.string(name, 'name');
|
|
assert.object(change, 'change');
|
|
|
|
var changes = [];
|
|
|
|
function changeFromObject(change) {
|
|
if (!change.operation && !change.type)
|
|
throw new Error('change.operation required');
|
|
if (typeof (change.modification) !== 'object')
|
|
throw new Error('change.modification (object) required');
|
|
|
|
if (Object.keys(change.modification).length == 2 &&
|
|
typeof (change.modification.type) === 'string' &&
|
|
Array.isArray(change.modification.vals)) {
|
|
// Use modification directly if it's already normalized:
|
|
changes.push(new Change({
|
|
operation: change.operation || change.type,
|
|
modification: change.modification
|
|
}));
|
|
} else {
|
|
// Normalize the modification object
|
|
Object.keys(change.modification).forEach(function (k) {
|
|
var mod = {};
|
|
mod[k] = change.modification[k];
|
|
changes.push(new Change({
|
|
operation: change.operation || change.type,
|
|
modification: mod
|
|
}));
|
|
});
|
|
}
|
|
}
|
|
|
|
if (Change.isChange(change)) {
|
|
changes.push(change);
|
|
} else if (Array.isArray(change)) {
|
|
change.forEach(function (c) {
|
|
if (Change.isChange(c)) {
|
|
changes.push(c);
|
|
} else {
|
|
changeFromObject(c);
|
|
}
|
|
});
|
|
} else {
|
|
changeFromObject(change);
|
|
}
|
|
|
|
if (typeof (controls) === 'function') {
|
|
callback = controls;
|
|
controls = [];
|
|
} else {
|
|
controls = validateControls(controls);
|
|
}
|
|
assert.func(callback, 'callback');
|
|
|
|
var req = new ModifyRequest({
|
|
object: dn.parse(name),
|
|
changes: changes,
|
|
controls: controls
|
|
});
|
|
|
|
return this._send(req, [errors.LDAP_SUCCESS], null, callback);
|
|
};
|
|
|
|
|
|
/**
|
|
* Performs an LDAP modifyDN against the server.
|
|
*
|
|
* This does not allow you to keep the old DN, as while the LDAP protocol
|
|
* has a facility for that, it's stupid. Just Search/Add.
|
|
*
|
|
* This will automatically deal with "new superior" logic.
|
|
*
|
|
* @param {String} name the DN of the entry to modify.
|
|
* @param {String} newName the new DN to move this entry to.
|
|
* @param {Control} controls (optional) either a Control or [Control].
|
|
* @param {Function} callback of the form f(err, res).
|
|
* @throws {TypeError} on invalid input.
|
|
*/
|
|
Client.prototype.modifyDN = function modifyDN(name,
|
|
newName,
|
|
controls,
|
|
callback) {
|
|
if (typeof (name) !== 'string')
|
|
throw new TypeError('name (string) required');
|
|
if (typeof (newName) !== 'string')
|
|
throw new TypeError('newName (string) required');
|
|
if (typeof (controls) === 'function') {
|
|
callback = controls;
|
|
controls = [];
|
|
} else {
|
|
controls = validateControls(controls);
|
|
}
|
|
if (typeof (callback) !== 'function')
|
|
throw new TypeError('callback (function) required');
|
|
|
|
var DN = dn.parse(name);
|
|
var newDN = dn.parse(newName);
|
|
|
|
var req = new ModifyDNRequest({
|
|
entry: DN,
|
|
deleteOldRdn: true,
|
|
controls: controls
|
|
});
|
|
|
|
if (newDN.length !== 1) {
|
|
req.newRdn = dn.parse(newDN.rdns.shift().toString());
|
|
req.newSuperior = newDN;
|
|
} else {
|
|
req.newRdn = newDN;
|
|
}
|
|
|
|
return this._send(req, [errors.LDAP_SUCCESS], null, callback);
|
|
};
|
|
|
|
|
|
/**
|
|
* Performs an LDAP search against the server.
|
|
*
|
|
* Note that the defaults for options are a 'base' search, if that's what
|
|
* you want you can just pass in a string for options and it will be treated
|
|
* as the search filter. Also, you can either pass in programatic Filter
|
|
* objects or a filter string as the filter option.
|
|
*
|
|
* Note that this method is 'special' in that the callback 'res' param will
|
|
* have two important events on it, namely 'entry' and 'end' that you can hook
|
|
* to. The former will emit a SearchEntry object for each record that comes
|
|
* back, and the latter will emit a normal LDAPResult object.
|
|
*
|
|
* @param {String} base the DN in the tree to start searching at.
|
|
* @param {Object} options parameters:
|
|
* - {String} scope default of 'base'.
|
|
* - {String} filter default of '(objectclass=*)'.
|
|
* - {Array} attributes [string] to return.
|
|
* - {Boolean} attrsOnly whether to return values.
|
|
* @param {Control} controls (optional) either a Control or [Control].
|
|
* @param {Function} callback of the form f(err, res).
|
|
* @throws {TypeError} on invalid input.
|
|
*/
|
|
Client.prototype.search = function search(base,
|
|
options,
|
|
controls,
|
|
callback,
|
|
_bypass) {
|
|
if (typeof (base) !== 'string' && !(base instanceof dn.DN))
|
|
throw new TypeError('base (string) required');
|
|
if (Array.isArray(options) || (options instanceof Control)) {
|
|
controls = options;
|
|
options = {};
|
|
} else if (typeof (options) === 'function') {
|
|
callback = options;
|
|
controls = [];
|
|
options = {
|
|
filter: new PresenceFilter({attribute: 'objectclass'})
|
|
};
|
|
} else if (typeof (options) === 'string') {
|
|
options = {filter: filters.parseString(options)};
|
|
} else if (typeof (options) !== 'object') {
|
|
throw new TypeError('options (object) required');
|
|
}
|
|
if (typeof (options.filter) === 'string') {
|
|
options.filter = filters.parseString(options.filter);
|
|
} else if (!options.filter) {
|
|
options.filter = new PresenceFilter({attribute: 'objectclass'});
|
|
} else if (!filters.isFilter(options.filter)) {
|
|
throw new TypeError('options.filter (Filter) required');
|
|
}
|
|
|
|
if (typeof (controls) === 'function') {
|
|
callback = controls;
|
|
controls = [];
|
|
} else {
|
|
controls = validateControls(controls);
|
|
}
|
|
if (typeof (callback) !== 'function')
|
|
throw new TypeError('callback (function) required');
|
|
|
|
if (options.attributes) {
|
|
if (!Array.isArray(options.attributes)) {
|
|
if (typeof (options.attributes) === 'string') {
|
|
options.attributes = [options.attributes];
|
|
} else {
|
|
throw new TypeError('options.attributes must be an Array of Strings');
|
|
}
|
|
}
|
|
}
|
|
|
|
var self = this;
|
|
function sendRequest(ctrls, emitter, cb) {
|
|
var req = new SearchRequest({
|
|
baseObject: typeof (base) === 'string' ? dn.parse(base) : base,
|
|
scope: options.scope || 'base',
|
|
filter: options.filter,
|
|
derefAliases: options.derefAliases || Protocol.NEVER_DEREF_ALIASES,
|
|
sizeLimit: options.sizeLimit || 0,
|
|
timeLimit: options.timeLimit || 10,
|
|
typesOnly: options.typesOnly || false,
|
|
attributes: options.attributes || [],
|
|
controls: ctrls
|
|
});
|
|
|
|
return self._send(req,
|
|
[errors.LDAP_SUCCESS],
|
|
emitter,
|
|
cb,
|
|
_bypass);
|
|
}
|
|
|
|
if (options.paged) {
|
|
// Perform automated search paging
|
|
var pageOpts = typeof (options.paged) === 'object' ? options.paged : {};
|
|
var size = 100; // Default page size
|
|
if (pageOpts.pageSize > 0) {
|
|
size = pageOpts.pageSize;
|
|
} else if (options.sizeLimit > 1) {
|
|
// According to the RFC, servers should ignore the paging control if
|
|
// pageSize >= sizelimit. Some might still send results, but it's safer
|
|
// to stay under that figure when assigning a default value.
|
|
size = options.sizeLimit - 1;
|
|
}
|
|
|
|
var pager = new SearchPager({
|
|
callback: callback,
|
|
controls: controls,
|
|
pageSize: size,
|
|
pagePause: pageOpts.pagePause
|
|
});
|
|
pager.on('search', sendRequest);
|
|
pager.begin();
|
|
} else {
|
|
sendRequest(controls, new EventEmitter, callback);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Unbinds this client from the LDAP server.
|
|
*
|
|
* Note that unbind does not have a response, so this callback is actually
|
|
* optional; either way, the client is disconnected.
|
|
*
|
|
* @param {Function} callback of the form f(err).
|
|
* @throws {TypeError} if you pass in callback as not a function.
|
|
*/
|
|
Client.prototype.unbind = function unbind(callback) {
|
|
if (!callback)
|
|
callback = function () {};
|
|
|
|
if (typeof (callback) !== 'function')
|
|
throw new TypeError('callback must be a function');
|
|
|
|
// When the socket closes, it is useful to know whether it was due to a
|
|
// user-initiated unbind or something else.
|
|
this.unbound = true;
|
|
|
|
if (!this.socket)
|
|
return callback();
|
|
|
|
var req = new UnbindRequest();
|
|
if (this.socket.listeners('error').length === 0) {
|
|
this.socket.once('error', function () {});
|
|
}
|
|
return this._send(req, 'unbind', null, callback);
|
|
};
|
|
|
|
|
|
/**
|
|
* Disconnect from the LDAP server and do not allow reconnection.
|
|
*
|
|
* If the client is instantiated with proper reconnection options, it's
|
|
* possible to initiate new requests after a call to unbind since the client
|
|
* will attempt to reconnect in order to fulfill the request.
|
|
*
|
|
* Calling destroy will prevent any further reconnection from occurring.
|
|
*
|
|
* @param {Object} err (Optional) error that was cause of client destruction
|
|
*/
|
|
Client.prototype.destroy = function destroy(err) {
|
|
this.destroyed = true;
|
|
this.queue.freeze();
|
|
// Purge any queued requests which are now meaningless
|
|
this.queue.flush(function (msg, expect, emitter, cb) {
|
|
if (typeof (cb) === 'function') {
|
|
cb(new Error('client destroyed'));
|
|
}
|
|
});
|
|
if (this.connected) {
|
|
this.unbind();
|
|
} else if (this.socket) {
|
|
this.socket.destroy();
|
|
}
|
|
this.emit('destroy', err);
|
|
};
|
|
|
|
|
|
/**
|
|
* Initiate LDAP connection.
|
|
*/
|
|
Client.prototype.connect = function connect() {
|
|
if (this.connecting || this.connected) {
|
|
return;
|
|
}
|
|
var self = this;
|
|
var log = this.log;
|
|
var socket;
|
|
|
|
// Establish basic socket connection
|
|
function connectSocket(cb) {
|
|
cb = once(cb);
|
|
|
|
function onResult(err, res) {
|
|
if (err) {
|
|
if (self.connectTimer) {
|
|
clearTimeout(self.connectTimer);
|
|
self.connectTimer = null;
|
|
}
|
|
self.emit('connectError', err);
|
|
}
|
|
cb(err, res);
|
|
}
|
|
function onConnect() {
|
|
if (self.connectTimer) {
|
|
clearTimeout(self.connectTimer);
|
|
self.connectTimer = null;
|
|
}
|
|
socket.removeAllListeners('error')
|
|
.removeAllListeners('connect')
|
|
.removeAllListeners('secureConnect');
|
|
|
|
socket.ldap.id = nextClientId() + '__' + socket.ldap.id;
|
|
self.log = self.log.child({ldap_id: socket.ldap.id}, true);
|
|
|
|
// Move on to client setup
|
|
setupClient(cb);
|
|
}
|
|
|
|
var port = (self.port || self.socketPath);
|
|
if (self.secure) {
|
|
socket = tls.connect(port, self.host, self.tlsOptions);
|
|
socket.once('secureConnect', onConnect);
|
|
} else {
|
|
socket = net.connect(port, self.host);
|
|
socket.once('connect', onConnect);
|
|
}
|
|
socket.once('error', onResult);
|
|
initSocket();
|
|
|
|
// Setup connection timeout handling, if desired
|
|
if (self.connectTimeout) {
|
|
self.connectTimer = setTimeout(function onConnectTimeout() {
|
|
if (!socket || !socket.readable || !socket.writeable) {
|
|
socket.destroy();
|
|
self.socket = null;
|
|
onResult(new ConnectionError('connection timeout'));
|
|
}
|
|
}, self.connectTimeout);
|
|
}
|
|
}
|
|
|
|
// Initialize socket events and LDAP parser.
|
|
function initSocket() {
|
|
socket.ldap = new MessageTracker({
|
|
id: self.url ? self.url.href : self.socketPath,
|
|
parser: new Parser({log: log})
|
|
});
|
|
|
|
// This won't be set on TLS. So. Very. Annoying.
|
|
if (typeof (socket.setKeepAlive) !== 'function') {
|
|
socket.setKeepAlive = function setKeepAlive(enable, delay) {
|
|
return socket.socket ?
|
|
socket.socket.setKeepAlive(enable, delay) : false;
|
|
};
|
|
}
|
|
|
|
socket.on('data', function onData(data) {
|
|
if (log.trace())
|
|
log.trace('data event: %s', util.inspect(data));
|
|
|
|
socket.ldap.parser.write(data);
|
|
});
|
|
|
|
// The "router"
|
|
socket.ldap.parser.on('message', function onMessage(message) {
|
|
message.connection = socket;
|
|
var callback = socket.ldap.fetch(message.messageID);
|
|
|
|
if (!callback) {
|
|
log.error({message: message.json}, 'unsolicited message');
|
|
return false;
|
|
}
|
|
|
|
return callback(message);
|
|
});
|
|
|
|
socket.ldap.parser.on('error', function onParseError(err) {
|
|
log.trace({err: err}, 'parser error event');
|
|
self.emit('error', err);
|
|
self.connected = false;
|
|
socket.end();
|
|
});
|
|
}
|
|
|
|
// After connect, register socket event handlers and run any setup actions
|
|
function setupClient(cb) {
|
|
cb = once(cb);
|
|
|
|
// Indicate failure if anything goes awry during setup
|
|
function bail(err) {
|
|
socket.destroy();
|
|
cb(err || new Error('client error during setup'));
|
|
}
|
|
// Work around lack of close event on tls.socket in node < 0.11
|
|
((socket.socket) ? socket.socket : socket).once('close', bail);
|
|
socket.once('error', bail);
|
|
socket.once('end', bail);
|
|
socket.once('timeout', bail);
|
|
|
|
self.socket = socket;
|
|
|
|
// Run any requested setup (such as automatically performing a bind) on
|
|
// socket before signalling successful connection.
|
|
// This setup needs to bypass the request queue since all other activity is
|
|
// blocked until the connection is considered fully established post-setup.
|
|
// Only allow bind/search for now.
|
|
var basicClient = {
|
|
bind: function bindBypass(name, credentials, controls, callback) {
|
|
return self.bind(name, credentials, controls, callback, true);
|
|
},
|
|
search: function searchBypass(base, options, controls, callback) {
|
|
return self.search(base, options, controls, callback, true);
|
|
},
|
|
unbind: self.unbind.bind(self)
|
|
};
|
|
vasync.forEachPipeline({
|
|
func: function (f, callback) {
|
|
f(basicClient, callback);
|
|
},
|
|
inputs: self.listeners('setup')
|
|
}, function (err, res) {
|
|
if (err) {
|
|
self.emit('setupError', err);
|
|
}
|
|
cb(err);
|
|
});
|
|
}
|
|
|
|
// Wire up "official" event handlers after successful connect/setup
|
|
function postSetup() {
|
|
socket.removeAllListeners('error')
|
|
.removeAllListeners('close')
|
|
.removeAllListeners('end')
|
|
.removeAllListeners('timeout');
|
|
|
|
// Work around lack of close event on tls.socket in node < 0.11
|
|
((socket.socket) ? socket.socket : socket).once('close',
|
|
self._onClose.bind(self));
|
|
socket.on('end', function onEnd() {
|
|
if (log.trace())
|
|
log.trace('end event');
|
|
|
|
self.emit('end');
|
|
socket.end();
|
|
});
|
|
socket.on('error', function onSocketError(err) {
|
|
if (log.trace())
|
|
log.trace({err: err}, 'error event: %s', new Error().stack);
|
|
|
|
self.emit('error', err);
|
|
socket.destroy();
|
|
});
|
|
socket.on('timeout', function onTimeout() {
|
|
if (log.trace())
|
|
log.trace('timeout event');
|
|
|
|
self.emit('socketTimeout');
|
|
socket.end();
|
|
});
|
|
}
|
|
|
|
var retry;
|
|
var failAfter;
|
|
if (this.reconnect) {
|
|
retry = backoff.exponential({
|
|
initialDelay: this.reconnect.initialDelay,
|
|
maxDelay: this.reconnect.maxDelay
|
|
});
|
|
failAfter = this.reconnect.failAfter;
|
|
} else {
|
|
retry = backoff.exponential({
|
|
initialDelay: 1,
|
|
maxDelay: 2
|
|
});
|
|
failAfter = 1;
|
|
}
|
|
retry.failAfter(failAfter);
|
|
|
|
retry.on('ready', function (num, delay) {
|
|
if (self.destroyed) {
|
|
// Cease connection attempts if destroyed
|
|
return;
|
|
}
|
|
connectSocket(function (err) {
|
|
if (!err) {
|
|
postSetup();
|
|
self.connecting = false;
|
|
self.connected = true;
|
|
self.emit('connect', socket);
|
|
self.log.debug('connected after %d attempt(s)', num+1);
|
|
// Flush any queued requests
|
|
self._flushQueue();
|
|
self._connectRetry = null;
|
|
} else {
|
|
retry.backoff(err);
|
|
}
|
|
});
|
|
});
|
|
retry.on('fail', function (err) {
|
|
if (self.destroyed) {
|
|
// Silence any connect/setup errors if destroyed
|
|
return;
|
|
}
|
|
self.log.debug('failed to connect after %d attempts', failAfter);
|
|
// Communicate the last-encountered error
|
|
if (err instanceof ConnectionError) {
|
|
self.emit('connectTimeout');
|
|
} else {
|
|
self.emit('error', err);
|
|
}
|
|
});
|
|
|
|
this._connectRetry = retry;
|
|
this.connecting = true;
|
|
retry.backoff();
|
|
};
|
|
|
|
|
|
|
|
///--- Private API
|
|
|
|
/**
|
|
* Flush queued requests out to the socket.
|
|
*/
|
|
Client.prototype._flushQueue = function _flushQueue() {
|
|
// Pull items we're about to process out of the queue.
|
|
this.queue.flush(this._send.bind(this));
|
|
};
|
|
|
|
/**
|
|
* Clean up socket/parser resources after socket close.
|
|
*/
|
|
Client.prototype._onClose = function _onClose(had_err) {
|
|
var socket = this.socket;
|
|
socket.removeAllListeners('connect')
|
|
.removeAllListeners('data')
|
|
.removeAllListeners('drain')
|
|
.removeAllListeners('end')
|
|
.removeAllListeners('error')
|
|
.removeAllListeners('timeout');
|
|
this.socket = null;
|
|
this.connected = false;
|
|
|
|
((socket.socket) ? socket.socket : socket).removeAllListeners('close');
|
|
|
|
if (this.log.trace())
|
|
this.log.trace('close event had_err=%s', had_err ? 'yes' : 'no');
|
|
|
|
this.emit('close', had_err);
|
|
// On close we have to walk the outstanding messages and go invoke their
|
|
// callback with an error.
|
|
socket.ldap.pending.forEach(function (msgid) {
|
|
var cb = socket.ldap.fetch(msgid);
|
|
socket.ldap.remove(msgid);
|
|
|
|
if (socket.unbindMessageID !== parseInt(msgid, 10)) {
|
|
return cb(new ConnectionError(socket.ldap.id + ' closed'));
|
|
} else {
|
|
// Unbinds will be communicated as a success since we're closed
|
|
var unbind = new UnbindResponse({messageID: msgid});
|
|
unbind.status = 'unbind';
|
|
return cb(unbind);
|
|
}
|
|
});
|
|
|
|
delete socket.ldap.parser;
|
|
delete socket.ldap;
|
|
|
|
// Automatically fire reconnect logic if the socket was closed for any reason
|
|
// other than a user-initiated unbind.
|
|
if (this.reconnect && !this.unbound) {
|
|
this.connect();
|
|
}
|
|
this.unbound = false;
|
|
return false;
|
|
};
|
|
|
|
/**
|
|
* Maintain idle timer for client.
|
|
*
|
|
* Will start timer to fire 'idle' event if conditions are satisfied. If
|
|
* conditions are not met and a timer is running, it will be cleared.
|
|
*
|
|
* @param {Boolean} override explicitly disable timer.
|
|
*/
|
|
Client.prototype._updateIdle = function _updateIdle(override) {
|
|
if (this.idleTimeout === 0) {
|
|
return;
|
|
}
|
|
// Client must be connected but not waiting on any request data
|
|
var self = this;
|
|
function isIdle(disable) {
|
|
return ((disable !== true) &&
|
|
(self.socket && self.connected) &&
|
|
(self.socket.ldap.pending.length === 0));
|
|
}
|
|
if (isIdle(override)) {
|
|
if (!this._idleTimer) {
|
|
this._idleTimer = setTimeout(function () {
|
|
// Double-check idleness in case socket was torn down
|
|
if (isIdle()) {
|
|
self.emit('idle');
|
|
}
|
|
}, this.idleTimeout);
|
|
}
|
|
} else {
|
|
if (this._idleTimer) {
|
|
clearTimeout(this._idleTimer);
|
|
this._idleTimer = null;
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Attempt to send an LDAP request.
|
|
*/
|
|
Client.prototype._send = function _send(message,
|
|
expect,
|
|
emitter,
|
|
callback,
|
|
_bypass) {
|
|
assert.ok(message);
|
|
assert.ok(expect);
|
|
assert.ok(typeof (emitter) !== undefined);
|
|
assert.ok(callback);
|
|
|
|
// Allow connect setup traffic to bypass checks
|
|
if (_bypass && this.socket && this.socket.writable) {
|
|
return this._sendSocket(message, expect, emitter, callback);
|
|
}
|
|
if (!this.socket || !this.connected) {
|
|
if (!this.queue.enqueue(message, expect, emitter, callback)) {
|
|
callback(new ConnectionError('connection unavailable'));
|
|
}
|
|
// Initiate reconnect if needed
|
|
if (this.reconnect) {
|
|
this.connect();
|
|
}
|
|
return false;
|
|
} else {
|
|
this._flushQueue();
|
|
return this._sendSocket(message, expect, emitter, callback);
|
|
}
|
|
};
|
|
|
|
Client.prototype._sendSocket = function _sendSocket(message,
|
|
expect,
|
|
emitter,
|
|
callback) {
|
|
var conn = this.socket;
|
|
var log = this.log;
|
|
var self = this;
|
|
var timer = false;
|
|
var sentEmitter = false;
|
|
|
|
function _done(event, obj) {
|
|
if (event === 'error' && self.listeners('resultError')) {
|
|
self.emit('resultError', obj);
|
|
}
|
|
if (emitter) {
|
|
if (event === 'error') {
|
|
// Error will go unhandled if emitter hasn't been sent via callback.
|
|
// Execute callback with the error instead.
|
|
if (!sentEmitter)
|
|
return callback(obj);
|
|
emitter.removeAllListeners('end');
|
|
}
|
|
if (event === 'end')
|
|
emitter.removeAllListeners('error');
|
|
|
|
return emitter.emit(event, obj);
|
|
}
|
|
|
|
if (event === 'error')
|
|
return callback(obj);
|
|
|
|
return callback(null, obj);
|
|
} // end function _done(event, obj)
|
|
|
|
function messageCallback(msg) {
|
|
if (timer)
|
|
clearTimeout(timer);
|
|
|
|
if (log.trace())
|
|
log.trace({msg: msg ? msg.json : null}, 'response received');
|
|
|
|
if (expect === 'abandon')
|
|
return _done('end', null);
|
|
|
|
if (msg instanceof SearchEntry || msg instanceof SearchReference) {
|
|
var event = msg.constructor.name;
|
|
event = event[0].toLowerCase() + event.slice(1);
|
|
return _done(event, msg);
|
|
} else {
|
|
conn.ldap.remove(message.messageID);
|
|
// Potentially mark client as idle
|
|
self._updateIdle();
|
|
|
|
if (msg instanceof LDAPResult) {
|
|
if (expect.indexOf(msg.status) === -1)
|
|
return _done('error', errors.getError(msg));
|
|
|
|
return _done('end', msg);
|
|
} else if (msg instanceof Error) {
|
|
return _done('error', msg);
|
|
} else {
|
|
return _done('error', new errors.ProtocolError(msg.type));
|
|
}
|
|
}
|
|
} // end function messageCallback(msg)
|
|
|
|
function onRequestTimeout() {
|
|
self.emit('timeout', message);
|
|
var cb = conn.ldap.fetch(message.messageID);
|
|
if (cb) {
|
|
//FIXME: the timed-out request should be abandoned
|
|
cb(new errors.TimeoutError('request timeout (client interrupt)'));
|
|
}
|
|
} // end function onRequestTimeout()
|
|
|
|
function writeCallback() {
|
|
if (expect === 'abandon') {
|
|
// Mark the messageID specified as abandoned
|
|
conn.ldap.abandon(message.abandonID);
|
|
// No need to track the abandon request itself
|
|
conn.ldap.remove(message.id);
|
|
return callback(null);
|
|
} else if (expect === 'unbind') {
|
|
conn.unbindMessageID = message.id;
|
|
// Mark client as disconnected once unbind clears the socket
|
|
self.connected = false;
|
|
conn.end();
|
|
} else if (emitter) {
|
|
sentEmitter = true;
|
|
return callback(null, emitter);
|
|
}
|
|
return false;
|
|
} // end writeCallback()
|
|
|
|
// Start actually doing something...
|
|
conn.ldap.track(message, messageCallback);
|
|
// Mark client as active
|
|
this._updateIdle(true);
|
|
|
|
if (self.timeout) {
|
|
log.trace('Setting timeout to %d', self.timeout);
|
|
timer = setTimeout(onRequestTimeout, self.timeout);
|
|
}
|
|
|
|
if (log.trace())
|
|
log.trace('sending request %j', message.json);
|
|
|
|
try {
|
|
return conn.write(message.toBer(), writeCallback);
|
|
} catch (e) {
|
|
if (timer)
|
|
clearTimeout(timer);
|
|
|
|
log.trace({err: e}, 'Error writing message to socket');
|
|
return callback(e);
|
|
}
|
|
};
|