| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486 |
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
| // 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 VError = require('verror').VError;
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;
}
function ensureDN(input, strict) {
if (dn.DN.isDN(input)) {
return dn;
} else if (strict) {
return dn.parse(input);
} else if (typeof (input) === 'string') {
return input;
} else {
throw new Error('invalid DN');
}
}
/**
* 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.strictDN = (options.strictDN !== undefined) ? options.strictDN : true;
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.ok(name !== undefined, '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: ensureDN(name, this.strictDN),
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.optionalString(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.ok(name !== undefined, '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: ensureDN(name, this.strictDN),
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.ok(name !== undefined, 'name');
if (typeof (controls) === 'function') {
callback = controls;
controls = [];
} else {
controls = validateControls(controls);
}
assert.func(callback, 'callback');
var req = new DeleteRequest({
entry: ensureDN(name, this.strictDN),
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.ok(name !== undefined, '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: ensureDN(name, this.strictDN),
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) {
assert.ok(name !== undefined, 'name');
assert.string(newName, 'newName');
if (typeof (controls) === 'function') {
callback = controls;
controls = [];
} else {
controls = validateControls(controls);
}
assert.func(callback);
var DN = ensureDN(name);
// TODO: is non-strict handling desired here?
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) {
assert.ok(base !== undefined, 'search base');
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);
}
assert.func(callback, 'callback');
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;
var baseDN = ensureDN(base, this.strictDN);
function sendRequest(ctrls, emitter, cb) {
var req = new SearchRequest({
baseObject: baseDN,
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();
return this._send(req, 'unbind', null, callback);
};
/**
* Attempt to secure connection with StartTLS.
*/
Client.prototype.starttls = function starttls(options,
controls,
callback,
_bypass) {
assert.optionalObject(options);
options = options || {};
callback = once(callback);
var self = this;
if (this._starttls) {
return callback(new Error('STARTTLS already in progress or active'));
}
function onSend(err, emitter) {
if (err) {
callback(err);
return;
}
/*
* Now that the request has been sent, block all outgoing messages
* until an error is received or we successfully complete the setup.
*/
// TODO: block traffic
self._starttls = {
started: true
};
emitter.on('error', function (err) {
self._starttls = null;
callback(err);
});
emitter.on('end', function (res) {
var sock = self._socket;
/*
* Unplumb socket data during SSL negotiation.
* This will prevent the LDAP parser from stumbling over the TLS
* handshake and raising a ruckus.
*/
sock.removeAllListeners('data');
options.socket = sock;
var secure = tls.connect(options);
secure.once('secureConnect', function () {
/*
* Wire up 'data' and 'error' handlers like the normal socket.
* Handling 'end' events isn't necessary since the underlying socket
* will handle those.
*/
secure.removeAllListeners('error');
secure.on('data', function onData(data) {
if (self.log.trace())
self.log.trace('data event: %s', util.inspect(data));
self._tracker.parser.write(data);
});
secure.on('error', function (err) {
if (self.log.trace())
self.log.trace({err: err}, 'error event: %s', new Error().stack);
self.emit('error', err);
sock.destroy();
});
callback(null);
});
secure.once('error', function (err) {
// If the SSL negotiation failed, to back to plain mode.
self._starttls = null;
secure.removeAllListeners();
callback(err);
});
self._starttls.success = true;
self._socket = secure;
});
}
var req = new ExtendedRequest({
requestName: '1.3.6.1.4.1.1466.20037',
requestValue: null,
controls: controls
});
return this._send(req,
[errors.LDAP_SUCCESS],
new EventEmitter(),
onSend,
_bypass);
};
/**
* 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;
var tracker;
// 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');
tracker.id = nextClientId() + '__' + tracker.id;
self.log = self.log.child({ldap_id: tracker.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() {
tracker = 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));
tracker.parser.write(data);
});
// The "router"
tracker.parser.on('message', function onMessage(message) {
message.connection = self._socket;
var callback = tracker.fetch(message.messageID);
if (!callback) {
log.error({message: message.json}, 'unsolicited message');
return false;
}
return callback(message);
});
tracker.parser.on('error', function onParseError(err) {
self.emit('error', new VError(err, 'Parser error for %s',
tracker.id));
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;
self._tracker = tracker;
// 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/starttls 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);
},
starttls: function starttlsBypass(options, controls, callback) {
return self.starttls(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', err);
} 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;
var tracker = this._tracker;
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.
tracker.pending.forEach(function (msgid) {
var cb = tracker.fetch(msgid);
tracker.remove(msgid);
if (socket.unbindMessageID !== parseInt(msgid, 10)) {
return cb(new ConnectionError(tracker.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);
}
});
// Trash any parser or starttls state
this._tracker = null;
delete this._starttls;
// 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._tracker.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.optionalObject(emitter);
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 tracker = this._tracker;
var log = this.log;
var self = this;
var timer = false;
var sentEmitter = false;
function sendResult(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);
}
return emitter.emit(event, obj);
}
if (event === 'error')
return callback(obj);
return callback(null, obj);
}
function messageCallback(msg) {
if (timer)
clearTimeout(timer);
if (log.trace())
log.trace({msg: msg ? msg.json : null}, 'response received');
if (expect === 'abandon')
return sendResult('end', null);
if (msg instanceof SearchEntry || msg instanceof SearchReference) {
var event = msg.constructor.name;
event = event[0].toLowerCase() + event.slice(1);
return sendResult(event, msg);
} else {
tracker.remove(message.messageID);
// Potentially mark client as idle
self._updateIdle();
if (msg instanceof LDAPResult) {
if (expect.indexOf(msg.status) === -1) {
return sendResult('error', errors.getError(msg));
}
return sendResult('end', msg);
} else if (msg instanceof Error) {
return sendResult('error', msg);
} else {
return sendResult('error', new errors.ProtocolError(msg.type));
}
}
}
function onRequestTimeout() {
self.emit('timeout', message);
var cb = tracker.fetch(message.messageID);
if (cb) {
//FIXME: the timed-out request should be abandoned
cb(new errors.TimeoutError('request timeout (client interrupt)'));
}
}
function writeCallback() {
if (expect === 'abandon') {
// Mark the messageID specified as abandoned
tracker.abandon(message.abandonID);
// No need to track the abandon request itself
tracker.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;
// Some servers will RST the connection after receiving an unbind.
// Socket errors are blackholed since the connection is being closed.
conn.removeAllListeners('error');
conn.on('error', function () {});
conn.end();
} else if (emitter) {
sentEmitter = true;
return callback(null, emitter);
}
return false;
}
// Start actually doing something...
tracker.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);
}
};
|