summaryrefslogtreecommitdiff
path: root/source4/lib/ldb/ldb_map/ldb_map.c
blob: dea3c24e37e370c5da7fb75fb40ff1ff0142b98c (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
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
/* 
   ldb database library - map backend

   Copyright (C) Jelmer Vernooij 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 2 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, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#include "includes.h"
#include "lib/ldb/include/ldb.h"
#include "lib/ldb/include/ldb_private.h"
#include "lib/ldb/ldb_map/ldb_map.h"

/* TODO:
 *  - objectclass hint in ldb_map_attribute 
 *     for use when multiple remote attributes (independant of each other)
 *     map to one local attribute. E.g.: (uid, gidNumber) -> unixName
 */

struct map_private {
	const struct ldb_map_attribute *attribute_maps;
	const struct ldb_map_objectclass *objectclass_maps;
	const char *last_err_string;
};

/* find an attribute by the local name */
static const struct ldb_map_attribute *map_find_attr_local(struct ldb_module *module, const char *attr)
{
	struct map_private *privdat = module->private_data;
	int i;
	for (i = 0; privdat->attribute_maps[i].local_name; i++) {
		if (!strcmp(privdat->attribute_maps[i].local_name, attr)) 
			return &privdat->attribute_maps[i];
	}

	return NULL;
}

/* find an attribute by the remote name */
static const struct ldb_map_attribute *map_find_attr_remote(struct ldb_module *module, const char *attr)
{
	struct map_private *privdat = module->private_data;
	int i;
	for (i = 0; privdat->attribute_maps[i].local_name; i++) {
		if (privdat->attribute_maps[i].type != MAP_RENAME &&
			privdat->attribute_maps[i].type != MAP_CONVERT) 
			continue;

		if (!strcmp(privdat->attribute_maps[i].u.rename.remote_name, attr)) 
			return &privdat->attribute_maps[i];
	}

	return NULL;
}

static struct ldb_parse_tree *ldb_map_parse_tree(struct ldb_module *module, const struct ldb_parse_tree *tree)
{
	int i;
	const struct ldb_map_attribute *attr;
	struct ldb_parse_tree *new_tree = talloc_memdup(module, tree, sizeof(*tree));

	/* Find attr in question and:
	 *  - if it has a convert_operator function, run that
	 *  - otherwise, replace attr name with required[0] */

	if (tree->operation == LDB_OP_AND || 
		tree->operation == LDB_OP_OR) {
		for (i = 0; i < tree->u.list.num_elements; i++) {
			new_tree->u.list.elements[i] = ldb_map_parse_tree(module, tree->u.list.elements[i]);
		}

		return new_tree;
	}
		
	if (tree->operation == LDB_OP_NOT) {
		new_tree->u.isnot.child = ldb_map_parse_tree(module, tree->u.isnot.child);
		return new_tree;
	}

	/* tree->operation is LDB_OP_EQUALITY, LDB_OP_SUBSTRING, LDB_OP_GREATER,
	 * LDB_OP_LESS, LDB_OP_APPROX, LDB_OP_PRESENT or LDB_OP_EXTENDED
	 *
	 * (all have attr as the first element)
	 */

	attr = map_find_attr_local(module, tree->u.equality.attr);

	if (!attr) {
		DEBUG(0, ("Unable to find local attribute '%s', leaving as is", tree->u.equality.attr));
		return new_tree;
	}

	if (attr->type == MAP_IGNORE)
		return NULL;

	if (attr->convert_operator) {
		/* Run convert_operator */
		talloc_free(new_tree);
		new_tree = attr->convert_operator(module, tree);
	} else {
		new_tree->u.equality.attr = talloc_strdup(new_tree, attr->u.rename.remote_name);
	}

	return new_tree;
}

/* Remote DN -> Local DN */
static struct ldb_dn *map_remote_dn(struct ldb_module *module, const struct ldb_dn *dn)
{
	struct ldb_dn *newdn;
	int i;

	newdn = talloc_memdup(module, dn, sizeof(*dn));
	if (!newdn) 
		return NULL;

	newdn->components = talloc_memdup(newdn, dn->components, sizeof(struct ldb_dn_component) * newdn->comp_num); 

	if (!newdn->components)
		return NULL;

	/* For each rdn, map the attribute name and possibly the 
	 * complete rdn */
	
	for (i = 0; i < dn->comp_num; i++) {
		const struct ldb_map_attribute *attr = map_find_attr_remote(module, dn->components[i].name);

		/* Unknown attribute - leave this dn as is and hope the best... */
		if (!attr)
			continue;

		if (attr->type == MAP_IGNORE) {
			DEBUG(0, ("Local MAP_IGNORE attribute '%s' used in DN!", dn->components[i].name));
			talloc_free(newdn);
			return NULL;
		}

		if (attr->type == MAP_GENERATE) {
			DEBUG(0, ("Local MAP_GENERATE attribute '%s' used in DN!", dn->components[i].name));
			talloc_free(newdn);

			return NULL;
		}

		if (attr->type == MAP_CONVERT) {
			struct ldb_message_element elm, *newelm;
			struct ldb_val vals[1] = { dn->components[i].value };
			elm.flags = 0;
			elm.name = attr->u.convert.remote_name;
			elm.num_values = 1;
			elm.values = vals;

			newelm = attr->u.convert.convert_remote(module, attr->local_name, &elm);

			newdn->components[i].name = talloc_strdup(module, newelm->name);
			newdn->components[i].value = newelm->values[0];
		} else if (attr->type == MAP_RENAME) {
			newdn->components[i].name = talloc_strdup(module, attr->local_name);
		}
	}
	return newdn;
}

/* Local DN -> Remote DN */
static struct ldb_dn *map_local_dn(struct ldb_module *module, const struct ldb_dn *dn)
{	struct ldb_dn *newdn;
	int i;
	struct ldb_parse_tree eqtree, *new_eqtree;

	newdn = talloc_memdup(module, dn, sizeof(*dn));
	if (!newdn) 
		return NULL;

	newdn->components = talloc_memdup(newdn, dn->components, sizeof(struct ldb_dn_component) * newdn->comp_num); 

	if (!newdn->components)
		return NULL;

	/* For each rdn, map the attribute name and possibly the 
	 * complete rdn using an equality convert_operator call */
	
	for (i = 0; i < dn->comp_num; i++) {
		const struct ldb_map_attribute *attr = map_find_attr_local(module, dn->components[i].name);

		/* Unknown attribute - leave this dn as is and hope the best... */
		if (!attr)
			continue;

		if (attr->type == MAP_IGNORE) {
			DEBUG(0, ("Local MAP_IGNORE attribute '%s' used in DN!", dn->components[i].name));
			talloc_free(newdn);
			return NULL;
		}

		if (attr->type == MAP_GENERATE) {
			DEBUG(0, ("Local MAP_GENERATE attribute '%s' used in DN!", dn->components[i].name));
			talloc_free(newdn);

			return NULL;
		}

		/* Simple rename/convert only */
		if (attr->convert_operator) {
			/* Fancy stuff */
			eqtree.operation = LDB_OP_EQUALITY;
			eqtree.u.equality.attr = dn->components[i].name;
			eqtree.u.equality.value = dn->components[i].value;

			new_eqtree = ldb_map_parse_tree(module, &eqtree);

			/* Silently continue for now */
			if (!new_eqtree) {
				DEBUG(0, ("Unable to convert RDN for attribute %s\n", dn->components[i].name));
				continue;
			}

			newdn->components[i].name = new_eqtree->u.equality.attr;
			newdn->components[i].value = new_eqtree->u.equality.value;
		} else if (attr->type == MAP_CONVERT) {
			struct ldb_message_element elm, *newelm;
			struct ldb_val vals[1] = { dn->components[i].value };
			elm.flags = 0;
			elm.name = attr->local_name;
			elm.num_values = 1;
			elm.values = vals;

			newelm = attr->u.convert.convert_local(module, attr->u.convert.remote_name, &elm);

			newdn->components[i].name = talloc_strdup(module, newelm->name);
			newdn->components[i].value = newelm->values[0];
		} else if (attr->type == MAP_RENAME) {
			newdn->components[i].name = talloc_strdup(module, attr->u.rename.remote_name);
		}
	}

	return newdn;
}



/* Loop over ldb_map_attribute array and add remote_names */
static const char **ldb_map_attrs(struct ldb_module *module, const char *const attrs[])
{
	int i;
	const char **ret;
	int ar_size = 0, last_element = 0;

	/* Start with good guess of number of elements */
	for (i = 0; attrs[i]; i++);

	ret = talloc_array(module, const char *, i);
	ar_size = i;

	for (i = 0; attrs[i]; i++) {
		int j;
		const struct ldb_map_attribute *attr = map_find_attr_local(module, attrs[i]);

		if (!attr) {
			DEBUG(0, ("Local attribute '%s' does not have a definition!\n", attrs[i]));
			continue;
		}

		switch (attr->type)
		{ 
			case MAP_IGNORE: break;
			case MAP_KEEP: 
				if (last_element >= ar_size) {
					ret = talloc_realloc(module, ret, const char *, ar_size+1);
					ar_size++;
				}
				ret[last_element] = attr->local_name;
				last_element++;
				break;

			case MAP_RENAME:
			case MAP_CONVERT:
				if (last_element >= ar_size) {
					ret = talloc_realloc(module, ret, const char *, ar_size+1);
					ar_size++;
				}
				ret[last_element] = attr->u.rename.remote_name;
				last_element++;
				break;

			case MAP_GENERATE:
				/* Add remote_names[] for this attribute to the list of 
				 * attributes to request from the remote server */
				for (j = 0; attr->u.generate.remote_names[j]; j++) {
					if (last_element >= ar_size) {
						ret = talloc_realloc(module, ret, const char *, ar_size+1);
						ar_size++;
					}
					ret[last_element] = attr->u.generate.remote_names[j];			
					last_element++;
				}
				break;
		} 
	}

	return NULL;
}

static struct ldb_message *ldb_map_message_incoming(struct ldb_module *module, const char * const*attrs, const struct ldb_message *mi)
{
	int i;
	struct ldb_message *msg = talloc_zero(module, struct ldb_message);
	struct ldb_message_element *elm, *oldelm;

	msg->dn = map_remote_dn(module, mi->dn);

	/* Loop over attrs, find in ldb_map_attribute array and 
	 * run generate() */

	for (i = 0; attrs[i]; i++) {
		const struct ldb_map_attribute *attr = map_find_attr_local(module, attrs[i]);

		if (!attr) {
			DEBUG(0, ("Unable to find local attribute '%s' when generating incoming message", attrs[i]));
			continue;
		}

		switch (attr->type) {
			case MAP_IGNORE:break;
			case MAP_RENAME:
				oldelm = ldb_msg_find_element(mi, attr->u.rename.remote_name);
				elm = talloc_memdup(msg, oldelm, sizeof(*oldelm));
				elm->name = talloc_strdup(elm, attr->local_name);

				ldb_msg_add(module->ldb, msg, elm, 0);
				break;
				
			case MAP_CONVERT:
				oldelm = ldb_msg_find_element(mi, attr->u.rename.remote_name);
				elm = attr->u.convert.convert_local(msg, attr->local_name, oldelm);

				ldb_msg_add(module->ldb, msg, elm, 0);
				break;

			case MAP_KEEP:
				ldb_msg_add(module->ldb, msg, ldb_msg_find_element(mi, attr->local_name), 0);
				break;

			case MAP_GENERATE:
				elm = attr->u.generate.generate_local(msg, attr->local_name, mi);
				ldb_msg_add(module->ldb, msg, elm, 0);
				break;
			default: 
				DEBUG(0, ("Unknown attr->type for %s", attr->local_name));
				break;
		}
	}

	return msg;
}

static struct ldb_message *ldb_map_message_outgoing(struct ldb_module *module, const struct ldb_message *mo)
{
	struct ldb_message *msg = talloc_zero(module, struct ldb_message);
	struct ldb_message_element *elm;
	int i;
	
	msg->private_data = mo->private_data;
	
	msg->dn = map_local_dn(module, mo->dn);

	/* Loop over mi and call generate_remote for each attribute */
	for (i = 0; i < mo->num_elements; i++) {
		const struct ldb_map_attribute *attr = map_find_attr_local(module, mo->elements[i].name);

		if (!attr) {
			DEBUG(0, ("Undefined local attribute '%s', ignoring\n", mo->elements[i].name));
			continue;
		}

		switch (attr->type) {
		case MAP_IGNORE: break;
		case MAP_RENAME:
			elm = talloc_memdup(msg, &msg->elements[i], sizeof(*elm));
			elm->name = talloc_strdup(elm, attr->u.rename.remote_name);

			ldb_msg_add(module->ldb, msg, elm, 0);
			break;

		case MAP_CONVERT:
			elm = attr->u.convert.convert_remote(msg, attr->local_name, &msg->elements[i]);
			ldb_msg_add(module->ldb, msg, elm, 0);
			break;

		case MAP_KEEP:
			ldb_msg_add(module->ldb, msg, &msg->elements[i], 0);	
			break;

		case MAP_GENERATE:
			attr->u.generate.generate_remote(attr->local_name, mo, msg);
			break;
		} 
	}

	return msg;
}

/*
  rename a record
*/
static int map_rename(struct ldb_module *module, const struct ldb_dn *olddn, const struct ldb_dn *newdn)
{
	struct ldb_dn *n_olddn, *n_newdn;
	int ret;
	
	n_olddn = map_local_dn(module, olddn);
	n_newdn = map_local_dn(module, newdn);

	ret = ldb_next_rename_record(module, n_olddn, n_newdn);

	talloc_free(n_olddn);
	talloc_free(n_newdn);
	
	return ret;
}

/*
  delete a record
*/
static int map_delete(struct ldb_module *module, const struct ldb_dn *dn)
{
	struct ldb_dn *newdn;
	int ret;

	newdn = map_local_dn(module, dn);

	ret = ldb_next_delete_record(module, newdn);

	talloc_free(newdn);

	return ret;
}

/*
  search for matching records using a ldb_parse_tree
*/
static int map_search_bytree(struct ldb_module *module, const struct ldb_dn *base,
			      enum ldb_scope scope, struct ldb_parse_tree *tree,
			      const char * const *attrs, struct ldb_message ***res)
{
	int ret;
	const char **newattrs;
	struct ldb_parse_tree *new_tree;
	struct ldb_dn *new_base;
	struct ldb_message **newres;
	int i;

	new_tree = ldb_map_parse_tree(module, tree);
	newattrs = ldb_map_attrs(module, attrs); 
	new_base = map_local_dn(module, base);

	ret = ldb_next_search_bytree(module, new_base, scope, new_tree, newattrs, &newres);

	talloc_free(new_base);
	talloc_free(new_tree);
	talloc_free(newattrs);

	for (i = 0; i < ret; i++) {
		*res[i] = ldb_map_message_incoming(module, attrs, newres[i]);
		talloc_free(newres[i]);
	}

	return ret;
}
/*
  search for matching records
*/
static int map_search(struct ldb_module *module, const struct ldb_dn *base,
		       enum ldb_scope scope, const char *expression,
		       const char * const *attrs, struct ldb_message ***res)
{
	struct map_private *map = module->private_data;
	struct ldb_parse_tree *tree;
	int ret;

	tree = ldb_parse_tree(map, expression);
	if (tree == NULL) {
		map->last_err_string = "expression parse failed";
		return -1;
	}

	ret = map_search_bytree(module, base, scope, tree, attrs, res);
	talloc_free(tree);
	return ret;
}

/*
  add a record
*/
static int map_add(struct ldb_module *module, const struct ldb_message *msg)
{
	struct ldb_message *nmsg = ldb_map_message_outgoing(module, msg);
	int ret;

	ret = ldb_next_add_record(module, nmsg);

	talloc_free(nmsg);

	return ret;
}




/*
  modify a record
*/
static int map_modify(struct ldb_module *module, const struct ldb_message *msg)
{
	struct ldb_message *nmsg = ldb_map_message_outgoing(module, msg);
	int ret;

	ret = ldb_next_modify_record(module, nmsg);

	talloc_free(nmsg);

	return ret;
}

static int map_lock(struct ldb_module *module, const char *lockname)
{
	return ldb_next_named_lock(module, lockname);
}

static int map_unlock(struct ldb_module *module, const char *lockname)
{
	return ldb_next_named_unlock(module, lockname);
}

/*
  return extended error information
*/
static const char *map_errstring(struct ldb_module *module)
{
	struct map_private *map = module->private_data;
	
	if (map->last_err_string)
		return map->last_err_string;

	return ldb_next_errstring(module);
}

static const struct ldb_module_ops map_ops = {
	.name          = "map",
	.search        = map_search,
	.search_bytree = map_search_bytree,
	.add_record    = map_add,
	.modify_record = map_modify,
	.delete_record = map_delete,
	.rename_record = map_rename,
	.named_lock    = map_lock,
	.named_unlock  = map_unlock,
	.errstring     = map_errstring
};

/* the init function */
struct ldb_module *ldb_map_init(struct ldb_context *ldb, const struct ldb_map_attribute *attrs, const struct ldb_map_objectclass *ocls, const char *options[])
{
	struct ldb_module *ctx;
	struct map_private *data;

	ctx = talloc(ldb, struct ldb_module);
	if (!ctx)
		return NULL;

	data = talloc(ctx, struct map_private);
	if (!data) {
		talloc_free(ctx);
		return NULL;
	}

	data->attribute_maps = attrs;
	data->objectclass_maps = ocls;
	ctx->private_data = data;
	ctx->ldb = ldb;
	ctx->prev = ctx->next = NULL;
	ctx->ops = &map_ops;

	return ctx;
}