1 /* rwm.c - rewrite/remap operations */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2003-2004 The OpenLDAP Foundation.
6 * Portions Copyright 2003 Pierangelo Masarati.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
28 rwm_op_dn_massage( Operation *op, SlapReply *rs, void *cookie )
30 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
31 struct ldaprwmap *rwmap =
32 (struct ldaprwmap *)on->on_bi.bi_private;
34 struct berval dn, ndn, mdn = { 0, NULL };
39 * Rewrite the bind dn if needed
45 dc.ctx = (char *)cookie;
47 dc.tofrom = ((int *)cookie)[0];
51 rc = rwm_dn_massage( &dc, &op->o_req_dn, &mdn );
52 if ( rc != LDAP_SUCCESS ) {
56 if ( mdn.bv_val == op->o_req_dn.bv_val ) {
60 rc = dnPrettyNormal( NULL, &mdn, &dn, &ndn, op->o_tmpmemctx );
61 if ( rc != LDAP_SUCCESS ) {
65 if ( mdn.bv_val != dn.bv_val ) {
66 ch_free( mdn.bv_val );
69 op->o_tmpfree( op->o_req_dn.bv_val, op->o_tmpmemctx );
70 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
79 rwm_add( Operation *op, SlapReply *rs )
81 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
82 struct ldaprwmap *rwmap =
83 (struct ldaprwmap *)on->on_bi.bi_private;
88 Attribute **ap = NULL;
91 rc = rwm_op_dn_massage( op, rs, "addDn" );
94 rc = rwm_op_dn_massage( op, rs, &rc );
96 if ( rc != LDAP_SUCCESS ) {
97 op->o_bd->bd_info = (BackendInfo *)on->on_info;
98 send_ldap_error( op, rs, rc, "addDn massage error" );
102 /* Count number of attributes in entry */
103 isupdate = be_isupdate( op->o_bd, &op->o_ndn );
104 for ( i = 0, ap = &op->oq_add.rs_e->e_attrs; *ap; ) {
105 struct berval mapped;
108 if ( !isupdate && (*ap)->a_desc->ad_type->sat_no_user_mod ) {
112 rwm_map( &rwmap->rwm_at, &(*ap)->a_desc->ad_cname,
114 if ( mapped.bv_val == NULL || mapped.bv_val[0] == '\0' ) {
118 if ( (*ap)->a_desc->ad_type->sat_syntax
119 == slap_schema.si_syn_distinguishedName )
122 * FIXME: rewrite could fail; in this case
123 * the operation should give up, right?
125 #ifdef ENABLE_REWRITE
126 rc = rwm_dnattr_rewrite( op, rs, "addDn",
130 rc = rwm_dnattr_rewrite( op, rs, &rc,
142 /* FIXME: leaking attribute/values? */
146 ber_bvarray_free( a->a_vals );
147 ber_bvarray_free( a->a_nvals );
152 /* TODO: map attribute types, values of DN-valued attributes ... */
153 return SLAP_CB_CONTINUE;
157 rwm_bind( Operation *op, SlapReply *rs )
159 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
160 struct ldaprwmap *rwmap =
161 (struct ldaprwmap *)on->on_bi.bi_private;
164 #ifdef ENABLE_REWRITE
165 ( void )rewrite_session_init( rwmap->rwm_rw, op->o_conn );
167 rc = rwm_op_dn_massage( op, rs, "bindDn" );
170 rc = rwm_op_dn_massage( op, rs, &rc );
172 if ( rc != LDAP_SUCCESS ) {
173 op->o_bd->bd_info = (BackendInfo *)on->on_info;
174 send_ldap_error( op, rs, rc, "bindDn massage error" );
178 return SLAP_CB_CONTINUE;
182 rwm_unbind( Operation *op, SlapReply *rs )
184 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
185 struct ldaprwmap *rwmap =
186 (struct ldaprwmap *)on->on_bi.bi_private;
188 #ifdef ENABLE_REWRITE
189 rewrite_session_delete( rwmap->rwm_rw, op->o_conn );
192 return SLAP_CB_CONTINUE;
196 rwm_compare( Operation *op, SlapReply *rs )
198 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
199 struct ldaprwmap *rwmap =
200 (struct ldaprwmap *)on->on_bi.bi_private;
203 struct berval mapped_at = { 0, NULL },
204 mapped_vals[2] = { { 0, NULL }, { 0, NULL } };
206 #ifdef ENABLE_REWRITE
207 rc = rwm_op_dn_massage( op, rs, "compareDn" );
210 rc = rwm_op_dn_massage( op, rs, &rc );
212 if ( rc != LDAP_SUCCESS ) {
213 op->o_bd->bd_info = (BackendInfo *)on->on_info;
214 send_ldap_error( op, rs, rc, "compareDn massage error" );
218 /* if the attribute is an objectClass, try to remap its value */
219 if ( op->orc_ava->aa_desc == slap_schema.si_ad_objectClass
220 || op->orc_ava->aa_desc == slap_schema.si_ad_structuralObjectClass )
222 rwm_map( &rwmap->rwm_oc, &op->orc_ava->aa_value,
223 &mapped_vals[0], RWM_MAP );
224 if ( mapped_vals[0].bv_val == NULL
225 || mapped_vals[0].bv_val[0] == '\0')
227 op->o_bd->bd_info = (BackendInfo *)on->on_info;
228 send_ldap_error( op, rs, LDAP_OTHER, "compare objectClass map error" );
231 } else if ( mapped_vals[0].bv_val != op->orc_ava->aa_value.bv_val ) {
232 free( op->orc_ava->aa_value.bv_val );
233 op->orc_ava->aa_value = mapped_vals[0];
235 mapped_at = op->orc_ava->aa_desc->ad_cname;
238 rwm_map( &rwmap->rwm_at,
239 &op->orc_ava->aa_desc->ad_cname,
242 if ( mapped_at.bv_val == NULL
243 || mapped_at.bv_val[0] == '\0')
245 op->o_bd->bd_info = (BackendInfo *)on->on_info;
246 send_ldap_error( op, rs, LDAP_OTHER, "compare attributeType map error" );
249 if ( op->orc_ava->aa_desc->ad_type->sat_syntax == slap_schema.si_syn_distinguishedName )
251 mapped_vals[0] = op->orc_ava->aa_value;
252 rc = rwm_dnattr_rewrite( op, rs, "compareAttrDN", mapped_vals );
253 if ( rc != LDAP_SUCCESS ) {
254 op->o_bd->bd_info = (BackendInfo *)on->on_info;
255 send_ldap_error( op, rs, rc, "compareAttrDN massage error" );
259 if ( mapped_vals[0].bv_val != op->orc_ava->aa_value.bv_val ) {
260 free( op->orc_ava->aa_value.bv_val );
261 op->orc_ava->aa_value = mapped_vals[0];
266 /* TODO: rewrite attribute types, values of DN-valued attributes ... */
267 return SLAP_CB_CONTINUE;
271 rwm_delete( Operation *op, SlapReply *rs )
273 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
276 #ifdef ENABLE_REWRITE
277 rc = rwm_op_dn_massage( op, rs, "deleteDn" );
280 rc = rwm_op_dn_massage( op, rs, &rc );
282 if ( rc != LDAP_SUCCESS ) {
283 op->o_bd->bd_info = (BackendInfo *)on->on_info;
284 send_ldap_error( op, rs, rc, "deleteDn massage error" );
288 return SLAP_CB_CONTINUE;
292 rwm_modify( Operation *op, SlapReply *rs )
294 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
297 #ifdef ENABLE_REWRITE
298 rc = rwm_op_dn_massage( op, rs, "modifyDn" );
301 rc = rwm_op_dn_massage( op, rs, &rc );
303 if ( rc != LDAP_SUCCESS ) {
304 op->o_bd->bd_info = (BackendInfo *)on->on_info;
305 send_ldap_error( op, rs, rc, "modifyDn massage error" );
309 /* TODO: rewrite attribute types, values of DN-valued attributes ... */
310 return SLAP_CB_CONTINUE;
314 rwm_modrdn( Operation *op, SlapReply *rs )
316 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
319 #ifdef ENABLE_REWRITE
320 rc = rwm_op_dn_massage( op, rs, "renameDn" );
323 rc = rwm_op_dn_massage( op, rs, &rc );
325 if ( rc != LDAP_SUCCESS ) {
326 op->o_bd->bd_info = (BackendInfo *)on->on_info;
327 send_ldap_error( op, rs, rc, "renameDn massage error" );
331 /* TODO: rewrite attribute types, values of DN-valued attributes ... */
332 return SLAP_CB_CONTINUE;
336 rwm_search( Operation *op, SlapReply *rs )
338 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
341 #ifdef ENABLE_REWRITE
342 rc = rwm_op_dn_massage( op, rs, "searchDn" );
345 rc = rwm_op_dn_massage( op, rs, &rc );
347 if ( rc != LDAP_SUCCESS ) {
348 op->o_bd->bd_info = (BackendInfo *)on->on_info;
349 send_ldap_error( op, rs, rc, "searchDn massage error" );
353 /* TODO: rewrite/map filter & attrs */
354 return SLAP_CB_CONTINUE;
358 rwm_extended( Operation *op, SlapReply *rs )
360 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
363 #ifdef ENABLE_REWRITE
364 rc = rwm_op_dn_massage( op, rs, "extendedDn" );
367 rc = rwm_op_dn_massage( op, rs, &rc );
369 if ( rc != LDAP_SUCCESS ) {
370 op->o_bd->bd_info = (BackendInfo *)on->on_info;
371 send_ldap_error( op, rs, rc, "extendedDn massage error" );
375 /* TODO: rewrite/map extended data ? ... */
380 rwm_matched( Operation *op, SlapReply *rs )
382 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
383 struct ldaprwmap *rwmap =
384 (struct ldaprwmap *)on->on_bi.bi_private;
386 struct berval dn, mdn;
389 if ( rs->sr_matched == NULL ) {
390 return SLAP_CB_CONTINUE;
394 #ifdef ENABLE_REWRITE
395 dc.conn = op->o_conn;
397 dc.ctx = "matchedDN";
402 ber_str2bv( rs->sr_matched, 0, 0, &dn );
403 rwm_dn_massage( &dc, &dn, &mdn );
405 if ( mdn.bv_val != dn.bv_val ) {
406 if ( rs->sr_flags & REP_MATCHED_MUSTBEFREED ) {
407 ch_free( (void *)rs->sr_matched );
409 rs->sr_flags |= REP_MATCHED_MUSTBEFREED;
411 rs->sr_matched = mdn.bv_val;
414 return SLAP_CB_CONTINUE;
418 rwm_send_entry( Operation *op, SlapReply *rs )
420 slap_overinst *on = (slap_overinst *) op->o_bd->bd_info;
421 struct ldaprwmap *rwmap =
422 (struct ldaprwmap *)on->on_bi.bi_private;
425 struct berval dn = { 0, NULL }, ndn = { 0, NULL };
427 int rc = SLAP_CB_CONTINUE;
429 assert( rs->sr_entry );
434 * Rewrite the dn of the result, if needed
437 #ifdef ENABLE_REWRITE
438 dc.conn = op->o_conn;
440 dc.ctx = "searchResult";
445 if ( rwm_dn_massage( &dc, &e->e_name, &dn ) ) {
449 if ( e->e_name.bv_val == dn.bv_val ) {
450 return SLAP_CB_CONTINUE;
454 * Note: this may fail if the target host(s) schema differs
455 * from the one known to the meta, and a DN with unknown
456 * attributes is returned.
458 if ( dnNormalize( 0, NULL, NULL, &dn, &ndn, NULL ) != LDAP_SUCCESS ) {
459 if ( dn.bv_val != e->e_name.bv_val ) {
460 ch_free( dn.bv_val );
462 rc = LDAP_INVALID_DN_SYNTAX;
466 if ( !( rs->sr_flags & REP_ENTRY_MODIFIABLE ) ) {
471 rs->sr_flags |= ( REP_ENTRY_MODIFIABLE | REP_ENTRY_MUSTBEFREED );
474 free( e->e_name.bv_val );
475 free( e->e_nname.bv_val );
482 /* TODO: map entry attribute types, objectclasses
483 * and dn-valued attribute values */
485 return SLAP_CB_CONTINUE;
488 if ( dn.bv_val && ( dn.bv_val != e->e_name.bv_val ) ) {
489 ch_free( dn.bv_val );
493 ch_free( ndn.bv_val );
508 #ifdef ENABLE_REWRITE
509 slap_overinst *on = (slap_overinst *) be->bd_info;
510 struct ldaprwmap *rwmap =
511 (struct ldaprwmap *)on->on_bi.bi_private;
513 return rewrite_parse( rwmap->rwm_rw,
514 fname, lineno, argc, argv );
516 #else /* !ENABLE_REWRITE */
517 fprintf( stderr, "%s: line %d: rewrite capabilities "
518 "are not enabled\n", fname, lineno );
519 #endif /* !ENABLE_REWRITE */
525 rwm_suffixmassage_config(
533 slap_overinst *on = (slap_overinst *) be->bd_info;
534 struct ldaprwmap *rwmap =
535 (struct ldaprwmap *)on->on_bi.bi_private;
537 struct berval bvnc, nvnc, pvnc, brnc, nrnc, prnc;
538 #ifdef ENABLE_REWRITE
540 #endif /* ENABLE_REWRITE */
545 * suffixmassage <suffix> <massaged suffix>
547 * the <suffix> field must be defined as a valid suffix
548 * (or suffixAlias?) for the current database;
549 * the <massaged suffix> shouldn't have already been
550 * defined as a valid suffix or suffixAlias for the
554 fprintf( stderr, "%s: line %d: syntax is"
555 " \"suffixMassage <suffix>"
556 " <massaged suffix>\"\n",
561 ber_str2bv( argv[1], 0, 0, &bvnc );
562 if ( dnPrettyNormal( NULL, &bvnc, &pvnc, &nvnc, NULL ) != LDAP_SUCCESS ) {
563 fprintf( stderr, "%s: line %d: suffix DN %s is invalid\n",
564 fname, lineno, bvnc.bv_val );
568 ber_str2bv( argv[2], 0, 0, &brnc );
569 if ( dnPrettyNormal( NULL, &brnc, &prnc, &nrnc, NULL ) != LDAP_SUCCESS ) {
570 fprintf( stderr, "%s: line %d: suffix DN %s is invalid\n",
571 fname, lineno, brnc.bv_val );
577 #ifdef ENABLE_REWRITE
579 * The suffix massaging is emulated
580 * by means of the rewrite capabilities
582 rc = rwm_suffix_massage_config( rwmap->rwm_rw,
583 &pvnc, &nvnc, &prnc, &nrnc );
591 #else /* !ENABLE_REWRITE */
592 ber_bvarray_add( &rwmap->rwm_suffix_massage, &pvnc );
593 ber_bvarray_add( &rwmap->rwm_suffix_massage, &nvnc );
595 ber_bvarray_add( &rwmap->rwm_suffix_massage, &prnc );
596 ber_bvarray_add( &rwmap->rwm_suffix_massage, &nrnc );
597 #endif /* !ENABLE_REWRITE */
611 slap_overinst *on = (slap_overinst *) be->bd_info;
612 struct ldaprwmap *rwmap =
613 (struct ldaprwmap *)on->on_bi.bi_private;
615 /* objectclass/attribute mapping */
616 return rwm_map_config( &rwmap->rwm_oc,
618 fname, lineno, argc, argv );
622 rwm_response( Operation *op, SlapReply *rs )
626 if ( op->o_tag == LDAP_REQ_SEARCH && rs->sr_type == REP_SEARCH ) {
627 return rwm_send_entry( op, rs );
630 switch( op->o_tag ) {
633 case LDAP_REQ_DELETE:
634 case LDAP_REQ_MODRDN:
635 case LDAP_REQ_MODIFY:
636 case LDAP_REQ_COMPARE:
637 case LDAP_REQ_SEARCH:
638 case LDAP_REQ_EXTENDED:
639 rc = rwm_matched( op, rs );
642 rc = SLAP_CB_CONTINUE;
661 if ( strncasecmp( argv[ 0 ], "rwm-", sizeof( "rwm-" ) - 1 ) == 0 ) {
663 argv[ 0 ] = &argv0[ sizeof( "rwm-" ) - 1 ];
666 if ( strncasecmp( argv[0], "rewrite", sizeof("rewrite") - 1 ) == 0 ) {
667 rc = rwm_rw_config( be, fname, lineno, argc, argv );
669 } else if (strcasecmp( argv[0], "map" ) == 0 ) {
670 rc = rwm_m_config( be, fname, lineno, argc, argv );
672 } else if (strcasecmp( argv[0], "suffixmassage" ) == 0 ) {
673 rc = rwm_suffixmassage_config( be, fname, lineno, argc, argv );
676 rc = SLAP_CONF_UNKNOWN;
691 slap_overinst *on = (slap_overinst *) be->bd_info;
692 struct ldapmapping *mapping = NULL;
693 struct ldaprwmap *rwmap;
695 rwmap = (struct ldaprwmap *)ch_malloc(sizeof(struct ldaprwmap));
696 memset(rwmap, 0, sizeof(struct ldaprwmap));
698 #ifdef ENABLE_REWRITE
699 rwmap->rwm_rw = rewrite_info_init( REWRITE_MODE_USE_DEFAULT );
700 if ( rwmap->rwm_rw == NULL ) {
708 /* this rewriteContext by default must be null;
709 * rules can be added if required */
710 rargv[ 0 ] = "rewriteContext";
711 rargv[ 1 ] = "searchFilter";
713 rewrite_parse( rwmap->rwm_rw, "<suffix massage>", 1, 2, rargv );
715 rargv[ 0 ] = "rewriteContext";
716 rargv[ 1 ] = "default";
718 rewrite_parse( rwmap->rwm_rw, "<suffix massage>", 2, 2, rargv );
721 #endif /* ENABLE_REWRITE */
723 rwm_map_init( &rwmap->rwm_oc, &mapping );
724 rwm_map_init( &rwmap->rwm_at, &mapping );
726 on->on_bi.bi_private = (void *)rwmap;
736 slap_overinst *on = (slap_overinst *) be->bd_info;
739 if ( on->on_bi.bi_private ) {
740 struct ldaprwmap *rwmap =
741 (struct ldaprwmap *)on->on_bi.bi_private;
743 #ifdef ENABLE_REWRITE
745 rewrite_info_delete( &rwmap->rwm_rw );
747 #else /* !ENABLE_REWRITE */
748 if ( rwmap->rwm_suffix_massage ) {
749 ber_bvarray_free( rwmap->rwm_suffix_massage );
751 #endif /* !ENABLE_REWRITE */
753 avl_free( rwmap->rwm_oc.remap, NULL );
754 avl_free( rwmap->rwm_oc.map, rwm_mapping_free );
755 avl_free( rwmap->rwm_at.remap, NULL );
756 avl_free( rwmap->rwm_at.map, rwm_mapping_free );
762 static slap_overinst rwm = { { NULL } };
767 memset( &rwm, 0, sizeof(slap_overinst) );
769 rwm.on_bi.bi_type = "rwm";
770 rwm.on_bi.bi_db_init = rwm_over_init;
771 rwm.on_bi.bi_db_config = rwm_config;
772 rwm.on_bi.bi_db_destroy = rwm_destroy;
774 rwm.on_bi.bi_op_bind = rwm_bind;
775 rwm.on_bi.bi_op_search = rwm_search;
776 rwm.on_bi.bi_op_compare = rwm_compare;
777 rwm.on_bi.bi_op_modify = rwm_modify;
778 rwm.on_bi.bi_op_modrdn = rwm_modrdn;
779 rwm.on_bi.bi_op_add = rwm_add;
780 rwm.on_bi.bi_op_delete = rwm_delete;
781 rwm.on_bi.bi_op_unbind = rwm_unbind;
782 rwm.on_bi.bi_extended = rwm_extended;
784 rwm.on_response = rwm_response;
786 return overlay_register( &rwm );
789 #if SLAPD_OVER_RWM == SLAPD_MOD_DYNAMIC
790 int init_module(int argc, char *argv[]) {
795 #endif /* SLAPD_OVER_RWM */