summaryrefslogtreecommitdiff
path: root/ldb/common/ldb_controls.c
blob: e3f8551407a393042af393f3886c95f52857f910 (plain)
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
/* 
   ldb database library

   Copyright (C) Simo Sorce  2005

     ** NOTE! The following LGPL license applies to the ldb
     ** library. This does NOT imply that all of Samba is released
     ** under the LGPL
   
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 3 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/

/*
 *  Name: ldb_controls.c
 *
 *  Component: ldb controls utility functions
 *
 *  Description: helper functions for control modules
 *
 *  Author: Simo Sorce
 */

#include "ldb_includes.h"

/* check if a control with the specified "oid" exist and return it */
/* returns NULL if not found */
struct ldb_control *ldb_request_get_control(struct ldb_request *req, const char *oid)
{
	int i;

	/* check if there's a paged request control */
	if (req->controls != NULL) {
		for (i = 0; req->controls[i]; i++) {
			if (strcmp(oid, req->controls[i]->oid) == 0) {
				break;
			}
		}

		return req->controls[i];
	}

	return NULL;
}

/* saves the current controls list into the "saver" and replace the one in req with a new one excluding
the "exclude" control */
/* returns False on error */
int save_controls(struct ldb_control *exclude, struct ldb_request *req, struct ldb_control ***saver)
{
	struct ldb_control **lcs;
	int i, j;

	*saver = req->controls;
	for (i = 0; req->controls[i]; i++);
	if (i == 1) {
		req->controls = NULL;
		return 1;
	}

	lcs = talloc_array(req, struct ldb_control *, i);
	if (!lcs) {
		return 0;
	}

	for (i = 0, j = 0; (*saver)[i]; i++) {
		if (exclude == (*saver)[i]) continue;
		lcs[j] = (*saver)[i];
		j++;
	}
	lcs[j] = NULL;

	req->controls = lcs;
	return 1;
}

/* check if there's any control marked as critical in the list */
/* return True if any, False if none */
int check_critical_controls(struct ldb_control **controls)
{
	int i;

	if (controls == NULL) {
		return 0;
	}

	for (i = 0; controls[i]; i++) {
		if (controls[i]->critical) {
			return 1;
		}
	}

	return 0;
}

int ldb_request_add_control(struct ldb_request *req, const char *oid, bool critical, void *data)
{
	unsigned n;
	struct ldb_control **ctrls;
	struct ldb_control *ctrl;

	for (n=0; req->controls && req->controls[n];) { n++; }

	ctrls = talloc_realloc(req, req->controls,
			       struct ldb_control *,
			       n + 2);
	if (!ctrls) return LDB_ERR_OPERATIONS_ERROR;
	req->controls = ctrls;
	ctrls[n] = NULL;
	ctrls[n+1] = NULL;

	ctrl = talloc(ctrls, struct ldb_control);
	if (!ctrl) return LDB_ERR_OPERATIONS_ERROR;

	ctrl->oid	= talloc_strdup(ctrl, oid);
	if (!ctrl->oid) return LDB_ERR_OPERATIONS_ERROR;
	ctrl->critical	= critical;
	ctrl->data	= data;

	ctrls[n] = ctrl;
	return LDB_SUCCESS;
}

/* Parse controls from the format used on the command line and in ejs */

struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, void *mem_ctx, const char **control_strings)
{
	int i;
	struct ldb_control **ctrl;

	char *error_string = NULL;

	if (control_strings == NULL || control_strings[0] == NULL)
		return NULL;

	for (i = 0; control_strings[i]; i++);

	ctrl = talloc_array(mem_ctx, struct ldb_control *, i + 1);

	for (i = 0; control_strings[i]; i++) {
		if (strncmp(control_strings[i], "vlv:", 4) == 0) {
			struct ldb_vlv_req_control *control;
			const char *p;
			char attr[1024];
			char ctxid[1024];
			int crit, bc, ac, os, cc, ret;

			attr[0] = '\0';
			ctxid[0] = '\0';
			p = &(control_strings[i][4]);
			ret = sscanf(p, "%d:%d:%d:%d:%d:%1023[^$]", &crit, &bc, &ac, &os, &cc, ctxid);
			if (ret < 5) {
				ret = sscanf(p, "%d:%d:%d:%1023[^:]:%1023[^$]", &crit, &bc, &ac, attr, ctxid);
			}
			       
			if ((ret < 4) || (crit < 0) || (crit > 1)) {
				error_string = talloc_asprintf(mem_ctx, "invalid server_sort control syntax\n");
				error_string = talloc_asprintf_append(error_string, " syntax: crit(b):bc(n):ac(n):<os(n):cc(n)|attr(s)>[:ctxid(o)]\n");
				error_string = talloc_asprintf_append(error_string, "   note: b = boolean, n = number, s = string, o = b64 binary blob");
				ldb_set_errstring(ldb, error_string);
				talloc_free(error_string);
				return NULL;
			}
			if (!(ctrl[i] = talloc(ctrl, struct ldb_control))) {
				ldb_oom(ldb);
				return NULL;
			}
			ctrl[i]->oid = LDB_CONTROL_VLV_REQ_OID;
			ctrl[i]->critical = crit;
			if (!(control = talloc(ctrl[i],
					       struct ldb_vlv_req_control))) {
				ldb_oom(ldb);
				return NULL;
			}
			control->beforeCount = bc;
			control->afterCount = ac;
			if (attr[0]) {
				control->type = 1;
				control->match.gtOrEq.value = talloc_strdup(control, attr);
				control->match.gtOrEq.value_len = strlen(attr);
			} else {
				control->type = 0;
				control->match.byOffset.offset = os;
				control->match.byOffset.contentCount = cc;
			}
			if (ctxid[0]) {
				control->ctxid_len = ldb_base64_decode(ctxid);
				control->contextId = (char *)talloc_memdup(control, ctxid, control->ctxid_len);
			} else {
				control->ctxid_len = 0;
				control->contextId = NULL;
			}
			ctrl[i]->data = control;

			continue;
		}

		if (strncmp(control_strings[i], "dirsync:", 8) == 0) {
			struct ldb_dirsync_control *control;
			const char *p;
			char cookie[1024];
			int crit, flags, max_attrs, ret;
		       
			cookie[0] = '\0';
			p = &(control_strings[i][8]);
			ret = sscanf(p, "%d:%d:%d:%1023[^$]", &crit, &flags, &max_attrs, cookie);

			if ((ret < 3) || (crit < 0) || (crit > 1) || (flags < 0) || (max_attrs < 0)) {
				error_string = talloc_asprintf(mem_ctx, "invalid dirsync control syntax\n");
				error_string = talloc_asprintf_append(error_string, " syntax: crit(b):flags(n):max_attrs(n)[:cookie(o)]\n");
				error_string = talloc_asprintf_append(error_string, "   note: b = boolean, n = number, o = b64 binary blob");
				ldb_set_errstring(ldb, error_string);
				talloc_free(error_string);
				return NULL;
			}

			/* w2k3 seems to ignore the parameter,
			 * but w2k sends a wrong cookie when this value is to small
			 * this would cause looping forever, while getting
			 * the same data and same cookie forever
			 */
			if (max_attrs == 0) max_attrs = 0x0FFFFFFF;

			ctrl[i] = talloc(ctrl, struct ldb_control);
			ctrl[i]->oid = LDB_CONTROL_DIRSYNC_OID;
			ctrl[i]->critical = crit;
			control = talloc(ctrl[i], struct ldb_dirsync_control);
			control->flags = flags;
			control->max_attributes = max_attrs;
			if (*cookie) {
				control->cookie_len = ldb_base64_decode(cookie);
				control->cookie = (char *)talloc_memdup(control, cookie, control->cookie_len);
			} else {
				control->cookie = NULL;
				control->cookie_len = 0;
			}
			ctrl[i]->data = control;

			continue;
		}

		if (strncmp(control_strings[i], "asq:", 4) == 0) {
			struct ldb_asq_control *control;
			const char *p;
			char attr[256];
			int crit, ret;

			attr[0] = '\0';
			p = &(control_strings[i][4]);
			ret = sscanf(p, "%d:%255[^$]", &crit, attr);
			if ((ret != 2) || (crit < 0) || (crit > 1) || (attr[0] == '\0')) {
				error_string = talloc_asprintf(mem_ctx, "invalid asq control syntax\n");
				error_string = talloc_asprintf_append(error_string, " syntax: crit(b):attr(s)\n");
				error_string = talloc_asprintf_append(error_string, "   note: b = boolean, s = string");
				ldb_set_errstring(ldb, error_string);
				talloc_free(error_string);
				return NULL;
			}

			ctrl[i] = talloc(ctrl, struct ldb_control);
			if (!ctrl[i]) {
				ldb_oom(ldb);
				return NULL;
			}
			ctrl[i]->oid = LDB_CONTROL_ASQ_OID;
			ctrl[i]->critical = crit;
			control = talloc(ctrl[i], struct ldb_asq_control);
			control->request = 1;
			control->source_attribute = talloc_strdup(control, attr);
			control->src_attr_len = strlen(attr);
			ctrl[i]->data = control;

			continue;
		}

		if (strncmp(control_strings[i], "extended_dn:", 12) == 0) {
			struct ldb_extended_dn_control *control;
			const char *p;
			int crit, type, ret;

			p = &(control_strings[i][12]);
			ret = sscanf(p, "%d:%d", &crit, &type);
			if ((ret != 2) || (crit < 0) || (crit > 1) || (type < 0) || (type > 1)) {
				ret = sscanf(p, "%d", &crit);
				if ((ret != 1) || (crit < 0) || (crit > 1)) {
					error_string = talloc_asprintf(mem_ctx, "invalid extended_dn control syntax\n");
					error_string = talloc_asprintf_append(error_string, " syntax: crit(b)[:type(i)]\n");
					error_string = talloc_asprintf_append(error_string, "   note: b = boolean\n");
					error_string = talloc_asprintf_append(error_string, "         i = integer\n");
					error_string = talloc_asprintf_append(error_string, "   valid values are: 0 - hexadecimal representation\n");
					error_string = talloc_asprintf_append(error_string, "                     1 - normal string representation");
					ldb_set_errstring(ldb, error_string);
					talloc_free(error_string);
					return NULL;
				}
				control = NULL;
			} else {
				control = talloc(ctrl, struct ldb_extended_dn_control);
				control->type = type;
			}

			ctrl[i] = talloc(ctrl, struct ldb_control);
			if (!ctrl[i]) {
				ldb_oom(ldb);
				return NULL;
			}
			ctrl[i]->oid = LDB_CONTROL_EXTENDED_DN_OID;
			ctrl[i]->critical = crit;
			ctrl[i]->data = talloc_steal(ctrl[i], control);

			continue;
		}

		if (strncmp(control_strings[i], "sd_flags:", 9) == 0) {
			struct ldb_sd_flags_control *control;
			const char *p;
			int crit, ret;
			unsigned secinfo_flags;

			p = &(control_strings[i][9]);
			ret = sscanf(p, "%d:%u", &crit, &secinfo_flags);
			if ((ret != 2) || (crit < 0) || (crit > 1) || (secinfo_flags < 0) || (secinfo_flags > 0xF)) {
				error_string = talloc_asprintf(mem_ctx, "invalid sd_flags control syntax\n");
				error_string = talloc_asprintf_append(error_string, " syntax: crit(b):secinfo_flags(n)\n");
				error_string = talloc_asprintf_append(error_string, "   note: b = boolean, n = number");
				ldb_set_errstring(ldb, error_string);
				talloc_free(error_string);
				return NULL;
			}

			ctrl[i] = talloc(ctrl, struct ldb_control);
			if (!ctrl[i]) {
				ldb_oom(ldb);
				return NULL;
			}
			ctrl[i]->oid = LDB_CONTROL_SD_FLAGS_OID;
			ctrl[i]->critical = crit;
			control = talloc(ctrl[i], struct ldb_sd_flags_control);
			control->secinfo_flags = secinfo_flags;
			ctrl[i]->data = control;

			continue;
		}

		if (strncmp(control_strings[i], "search_options:", 15) == 0) {
			struct ldb_search_options_control *control;
			const char *p;
			int crit, ret;
			unsigned search_options;

			p = &(control_strings[i][15]);
			ret = sscanf(p, "%d:%u", &crit, &search_options);
			if ((ret != 2) || (crit < 0) || (crit > 1) || (search_options < 0) || (search_options > 0xF)) {
				error_string = talloc_asprintf(mem_ctx, "invalid search_options control syntax\n");
				error_string = talloc_asprintf_append(error_string, " syntax: crit(b):search_options(n)\n");
				error_string = talloc_asprintf_append(error_string, "   note: b = boolean, n = number");
				ldb_set_errstring(ldb, error_string);
				talloc_free(error_string);
				return NULL;
			}

			ctrl[i] = talloc(ctrl, struct ldb_control);
			if (!ctrl[i]) {
				ldb_oom(ldb);
				return NULL;
			}
			ctrl[i]->oid = LDB_CONTROL_SEARCH_OPTIONS_OID;
			ctrl[i]->critical = crit;
			control = talloc(ctrl[i], struct ldb_search_options_control);
			control->search_options = search_options;
			ctrl[i]->data = control;

			continue;
		}

		if (strncmp(control_strings[i], "domain_scope:", 13) == 0) {
			const char *p;
			int crit, ret;

			p = &(control_strings[i][13]);
			ret = sscanf(p, "%d", &crit);
			if ((ret != 1) || (crit < 0) || (crit > 1)) {
				error_string = talloc_asprintf(mem_ctx, "invalid domain_scope control syntax\n");
				error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
				error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
				ldb_set_errstring(ldb, error_string);
				talloc_free(error_string);
				return NULL;
			}

			ctrl[i] = talloc(ctrl, struct ldb_control);
			if (!ctrl[i]) {
				ldb_oom(ldb);
				return NULL;
			}
			ctrl[i]->oid = LDB_CONTROL_DOMAIN_SCOPE_OID;
			ctrl[i]->critical = crit;
			ctrl[i]->data = NULL;

			continue;
		}

		if (strncmp(control_strings[i], "paged_results:", 14) == 0) {
			struct ldb_paged_control *control;
			const char *p;
			int crit, size, ret;
		       
			p = &(control_strings[i][14]);
			ret = sscanf(p, "%d:%d", &crit, &size);

			if ((ret != 2) || (crit < 0) || (crit > 1) || (size < 0)) {
				error_string = talloc_asprintf(mem_ctx, "invalid paged_results control syntax\n");
				error_string = talloc_asprintf_append(error_string, " syntax: crit(b):size(n)\n");
				error_string = talloc_asprintf_append(error_string, "   note: b = boolean, n = number");
				ldb_set_errstring(ldb, error_string);
				talloc_free(error_string);
				return NULL;
			}

			ctrl[i] = talloc(ctrl, struct ldb_control);
			if (!ctrl[i]) {
				ldb_oom(ldb);
				return NULL;
			}
			ctrl[i]->oid = LDB_CONTROL_PAGED_RESULTS_OID;
			ctrl[i]->critical = crit;
			control = talloc(ctrl[i], struct ldb_paged_control);
			control->size = size;
			control->cookie = NULL;
			control->cookie_len = 0;
			ctrl[i]->data = control;

			continue;
		}

		if (strncmp(control_strings[i], "server_sort:", 12) == 0) {
			struct ldb_server_sort_control **control;
			const char *p;
			char attr[256];
			char rule[128];
			int crit, rev, ret;

			attr[0] = '\0';
			rule[0] = '\0';
			p = &(control_strings[i][12]);
			ret = sscanf(p, "%d:%d:%255[^:]:%127[^:]", &crit, &rev, attr, rule);
			if ((ret < 3) || (crit < 0) || (crit > 1) || (rev < 0 ) || (rev > 1) ||attr[0] == '\0') {
				error_string = talloc_asprintf(mem_ctx, "invalid server_sort control syntax\n");
				error_string = talloc_asprintf_append(error_string, " syntax: crit(b):rev(b):attr(s)[:rule(s)]\n");
				error_string = talloc_asprintf_append(error_string, "   note: b = boolean, s = string");
				ldb_set_errstring(ldb, error_string);
				talloc_free(error_string);
				return NULL;
			}
			ctrl[i] = talloc(ctrl, struct ldb_control);
			if (!ctrl[i]) {
				ldb_oom(ldb);
				return NULL;
			}
			ctrl[i]->oid = LDB_CONTROL_SERVER_SORT_OID;
			ctrl[i]->critical = crit;
			control = talloc_array(ctrl[i], struct ldb_server_sort_control *, 2);
			control[0] = talloc(control, struct ldb_server_sort_control);
			control[0]->attributeName = talloc_strdup(control, attr);
			if (rule[0])
				control[0]->orderingRule = talloc_strdup(control, rule);
			else
				control[0]->orderingRule = NULL;
			control[0]->reverse = rev;
			control[1] = NULL;
			ctrl[i]->data = control;

			continue;
		}

		if (strncmp(control_strings[i], "notification:", 13) == 0) {
			const char *p;
			int crit, ret;

			p = &(control_strings[i][13]);
			ret = sscanf(p, "%d", &crit);
			if ((ret != 1) || (crit < 0) || (crit > 1)) {
				error_string = talloc_asprintf(mem_ctx, "invalid notification control syntax\n");
				error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
				error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
				ldb_set_errstring(ldb, error_string);
				talloc_free(error_string);
				return NULL;
			}

			ctrl[i] = talloc(ctrl, struct ldb_control);
			if (!ctrl[i]) {
				ldb_oom(ldb);
				return NULL;
			}
			ctrl[i]->oid = LDB_CONTROL_NOTIFICATION_OID;
			ctrl[i]->critical = crit;
			ctrl[i]->data = NULL;

			continue;
		}

		if (strncmp(control_strings[i], "show_deleted:", 13) == 0) {
			const char *p;
			int crit, ret;

			p = &(control_strings[i][13]);
			ret = sscanf(p, "%d", &crit);
			if ((ret != 1) || (crit < 0) || (crit > 1)) {
				error_string = talloc_asprintf(mem_ctx, "invalid show_deleted control syntax\n");
				error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
				error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
				ldb_set_errstring(ldb, error_string);
				talloc_free(error_string);
				return NULL;
			}

			ctrl[i] = talloc(ctrl, struct ldb_control);
			if (!ctrl[i]) {
				ldb_oom(ldb);
				return NULL;
			}
			ctrl[i]->oid = LDB_CONTROL_SHOW_DELETED_OID;
			ctrl[i]->critical = crit;
			ctrl[i]->data = NULL;

			continue;
		}

		if (strncmp(control_strings[i], "permissive_modify:", 18) == 0) {
			const char *p;
			int crit, ret;

			p = &(control_strings[i][18]);
			ret = sscanf(p, "%d", &crit);
			if ((ret != 1) || (crit < 0) || (crit > 1)) {
				error_string = talloc_asprintf(mem_ctx, "invalid permissive_modify control syntax\n");
				error_string = talloc_asprintf_append(error_string, " syntax: crit(b)\n");
				error_string = talloc_asprintf_append(error_string, "   note: b = boolean");
				ldb_set_errstring(ldb, error_string);
				talloc_free(error_string);
				return NULL;
			}

			ctrl[i] = talloc(ctrl, struct ldb_control);
			if (!ctrl[i]) {
				ldb_oom(ldb);
				return NULL;
			}
			ctrl[i]->oid = LDB_CONTROL_PERMISSIVE_MODIFY_OID;
			ctrl[i]->critical = crit;
			ctrl[i]->data = NULL;

			continue;
		}

		/* no controls matched, throw an error */
		ldb_asprintf_errstring(ldb, "Invalid control name: '%s'", control_strings[i]);
		return NULL;
	}

	ctrl[i] = NULL;

	return ctrl;
}