1 /* deref.c - dereference overlay */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2008 The OpenLDAP Foundation.
6 * Portions Copyright 2008 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>.
18 * This work was initially developed by Pierangelo Masarati
19 * for inclusion in OpenLDAP Software.
24 #ifdef SLAPD_OVER_DEREF
28 #include "ac/string.h"
29 #include "ac/socket.h"
41 * controlValue ::= SEQUENCE OF derefSpec DerefSpec
43 * DerefSpec ::= SEQUENCE {
44 * derefAttr attributeDescription, ; DN-valued
45 * attributes AttributeList }
47 * AttributeList ::= SEQUENCE OF attr AttributeDescription
49 * derefAttr MUST be unique within controlValue
54 * controlValue ::= SEQUENCE OF DerefRes
57 * PartialAttribute ::= SEQUENCE {
58 * type AttributeDescription,
59 * vals SET OF value AttributeValue }
61 * PartialAttributeList ::= SEQUENCE OF
62 * partialAttribute PartialAttribute
64 * DerefRes ::= SEQUENCE {
65 * derefAttr AttributeDescription,
67 * attrVals [0] PartialAttributeList OPTIONAL }
69 * If vals is empty, partialAttribute is omitted.
70 * If all vals in attrVals are empty, attrVals is omitted.
78 * { { member, { GUID, SID } }, { memberOf, { GUID, SID } } }
82 * { { memberOf, "cn=abartlet,cn=users,dc=abartlet,dc=net",
83 * { { GUID, [ "0bc11d00-e431-40a0-8767-344a320142fa" ] },
84 * { SID, [ "S-1-2-3-2345" ] } } },
85 * { memberOf, "cn=ando,cn=users,dc=sys-net,dc=it",
86 * { { GUID, [ "0bc11d00-e431-40a0-8767-344a320142fb" ] },
87 * { SID, [ "S-1-2-3-2346" ] } } } }
93 * { { member, { cn, uid, drink } } }
97 * { { member, "cn=ando,cn=users,dc=sys-net,dc=it",
98 * { { cn, [ "ando", "Pierangelo Masarati" ] },
99 * { uid, [ "ando" ] } } },
100 * { member, "dc=sys-net,dc=it" } }
103 * 3. Security considerations
105 * The control result must not disclose information the client's
106 * identity could not have accessed directly by performing the related
107 * search operations. The presence of a derefVal in the control
108 * response does not imply neither the existence of nor any access
109 * privilege to the corresponding entry. It is merely a consequence
110 * of the read access the client's identity has on the corresponding
114 #define o_deref o_ctrlflag[deref_cid]
115 #define o_ctrlderef o_controls[deref_cid]
117 typedef struct DerefSpec {
118 AttributeDescription *ds_derefAttr;
119 AttributeDescription **ds_attributes;
121 struct DerefSpec *ds_next;
124 typedef struct DerefVal {
125 struct berval dv_derefSpecVal;
126 BerVarray *dv_attrVals;
129 typedef struct DerefRes {
132 struct DerefRes *dr_next;
135 typedef struct deref_cb_t {
136 slap_overinst *dc_on;
140 static int deref_cid;
141 static slap_overinst deref;
150 BerElementBuffer berbuf;
151 BerElement *ber = (BerElement *)&berbuf;
154 DerefSpec *dshead = NULL, **dsp = &dshead;
155 BerVarray attributes = NULL;
157 if ( op->o_deref != SLAP_CONTROL_NONE ) {
158 rs->sr_text = "Dereference control specified multiple times";
159 return LDAP_PROTOCOL_ERROR;
162 if ( BER_BVISNULL( &ctrl->ldctl_value ) ) {
163 rs->sr_text = "Dereference control value is absent";
164 return LDAP_PROTOCOL_ERROR;
167 if ( BER_BVISEMPTY( &ctrl->ldctl_value ) ) {
168 rs->sr_text = "Dereference control value is empty";
169 return LDAP_PROTOCOL_ERROR;
172 ber_init2( ber, &ctrl->ldctl_value, 0 );
174 for ( tag = ber_first_element( ber, &len, &last );
176 tag = ber_next_element( ber, &len, last ) )
178 struct berval derefAttr;
179 DerefSpec *ds, *dstmp;
182 ber_len_t cnt = sizeof(struct berval);
185 if ( ber_scanf( ber, "{m{M}}", &derefAttr, &attributes, &cnt, off ) == LBER_ERROR )
187 rs->sr_text = "Dereference control: derefSpec decoding error";
188 rs->sr_err = LDAP_PROTOCOL_ERROR;
192 ds = (DerefSpec *)op->o_tmpcalloc( 1,
193 sizeof(DerefSpec) + sizeof(AttributeDescription *)*(cnt + 1),
195 ds->ds_attributes = (AttributeDescription **)&ds[ 1 ];
198 rc = slap_bv2ad( &derefAttr, &ds->ds_derefAttr, &text );
199 if ( rc != LDAP_SUCCESS ) {
200 rs->sr_text = "Dereference control: derefAttr decoding error";
201 rs->sr_err = LDAP_PROTOCOL_ERROR;
205 for ( dstmp = dshead; dstmp && dstmp != ds; dstmp = dstmp->ds_next ) {
206 if ( dstmp->ds_derefAttr == ds->ds_derefAttr ) {
207 rs->sr_text = "Dereference control: derefAttr must be unique within control";
208 rs->sr_err = LDAP_PROTOCOL_ERROR;
213 if ( ds->ds_derefAttr->ad_type->sat_syntax != slap_schema.si_syn_distinguishedName ) {
214 if ( ctrl->ldctl_iscritical ) {
215 rs->sr_text = "Dereference control: derefAttr syntax not distinguishedName";
216 rs->sr_err = LDAP_PROTOCOL_ERROR;
220 rs->sr_err = LDAP_SUCCESS;
224 for ( cnt = 0; !BER_BVISNULL( &attributes[ cnt ] ); cnt++ ) {
225 rc = slap_bv2ad( &attributes[ cnt ], &ds->ds_attributes[ cnt ], &text );
226 if ( rc != LDAP_SUCCESS ) {
227 rs->sr_text = "Dereference control: attribute decoding error";
228 rs->sr_err = LDAP_PROTOCOL_ERROR;
233 ber_memfree_x( attributes, op->o_tmpmemctx );
240 op->o_ctrlderef = (void *)dshead;
242 op->o_deref = ctrl->ldctl_iscritical
243 ? SLAP_CONTROL_CRITICAL
244 : SLAP_CONTROL_NONCRITICAL;
246 rs->sr_err = LDAP_SUCCESS;
249 if ( rs->sr_err != LDAP_SUCCESS ) {
252 DerefSpec *dsnext = dshead->ds_next;
253 op->o_tmpfree( dshead, op->o_tmpmemctx );
258 if ( attributes != NULL ) {
259 ber_memfree_x( attributes, op->o_tmpmemctx );
266 deref_cleanup( Operation *op, SlapReply *rs )
268 if ( rs->sr_type == REP_RESULT || rs->sr_err == SLAPD_ABANDON ) {
269 op->o_tmpfree( op->o_callback, op->o_tmpmemctx );
270 op->o_callback = NULL;
272 op->o_tmpfree( op->o_ctrlderef, op->o_tmpmemctx );
273 op->o_ctrlderef = NULL;
276 return SLAP_CB_CONTINUE;
280 deref_response( Operation *op, SlapReply *rs )
282 int rc = SLAP_CB_CONTINUE;
284 if ( rs->sr_type == REP_SEARCH ) {
285 BerElementBuffer berbuf;
286 BerElement *ber = (BerElement *) &berbuf;
287 deref_cb_t *dc = (deref_cb_t *)op->o_callback->sc_private;
289 DerefRes *dr, *drhead = NULL, **drp = &drhead;
290 struct berval bv = BER_BVNULL;
291 int nDerefRes = 0, nDerefVals = 0, nAttrs = 0, nVals = 0;
292 struct berval ctrlval;
293 LDAPControl *ctrl, **ctrlsp;
294 AccessControlState acl_state = ACL_STATE_INIT;
295 static char dummy = '\0';
299 rc = overlay_entry_get_ov( op, &rs->sr_entry->e_nname, NULL, NULL, 0, &ebase, dc->dc_on );
300 if ( rc != LDAP_SUCCESS || ebase == NULL ) {
301 return SLAP_CB_CONTINUE;
304 for ( ds = dc->dc_ds; ds; ds = ds->ds_next ) {
305 Attribute *a = attr_find( ebase->e_attrs, ds->ds_derefAttr );
311 if ( !access_allowed( op, rs->sr_entry, a->a_desc,
312 NULL, ACL_READ, &acl_state ) )
317 dr = op->o_tmpcalloc( 1,
318 sizeof( DerefRes ) + ( sizeof( DerefVal ) + sizeof( BerVarray * ) * ds->ds_nattrs ) * ( a->a_numvals + 1 ),
321 dv = dr->dr_vals = (DerefVal *)&dr[ 1 ];
322 bva = (BerVarray *)&dv[ a->a_numvals + 1 ];
324 bv.bv_len += ds->ds_derefAttr->ad_cname.bv_len;
328 for ( i = 0; !BER_BVISNULL( &a->a_nvals[ i ] ); i++ ) {
331 dv[ i ].dv_attrVals = bva;
332 bva += ds->ds_nattrs;
335 if ( !access_allowed( op, rs->sr_entry, a->a_desc,
336 &a->a_nvals[ i ], ACL_READ, &acl_state ) )
338 dv[ i ].dv_derefSpecVal.bv_val = &dummy;
342 ber_dupbv_x( &dv[ i ].dv_derefSpecVal, &a->a_vals[ i ], op->o_tmpmemctx );
343 bv.bv_len += dv[ i ].dv_derefSpecVal.bv_len;
347 rc = overlay_entry_get_ov( op, &a->a_nvals[ i ], NULL, NULL, 0, &e, dc->dc_on );
348 if ( rc == LDAP_SUCCESS && e != NULL ) {
351 if ( access_allowed( op, e, slap_schema.si_ad_entry,
352 NULL, ACL_READ, NULL ) )
354 for ( j = 0; j < ds->ds_nattrs; j++ ) {
357 if ( !access_allowed( op, e, ds->ds_attributes[ j ], NULL,
358 ACL_READ, &acl_state ) )
363 aa = attr_find( e->e_attrs, ds->ds_attributes[ j ] );
365 unsigned k, h, last = aa->a_numvals;
367 ber_bvarray_dup_x( &dv[ i ].dv_attrVals[ j ],
368 aa->a_vals, op->o_tmpmemctx );
370 bv.bv_len += ds->ds_attributes[ j ]->ad_cname.bv_len;
372 for ( k = 0, h = 0; k < aa->a_numvals; k++ ) {
373 if ( !access_allowed( op, e,
376 ACL_READ, &acl_state ) )
378 op->o_tmpfree( dv[ i ].dv_attrVals[ j ][ h ].bv_val,
380 dv[ i ].dv_attrVals[ j ][ h ] = dv[ i ].dv_attrVals[ j ][ --last ];
381 BER_BVZERO( &dv[ i ].dv_attrVals[ j ][ last ] );
384 bv.bv_len += dv[ i ].dv_attrVals[ j ][ h ].bv_len;
393 overlay_entry_release_ov( op, e, 0, dc->dc_on );
401 overlay_entry_release_ov( op, ebase, 0, dc->dc_on );
403 if ( drhead == NULL ) {
404 return SLAP_CB_CONTINUE;
407 /* cook the control value */
408 bv.bv_len += nVals * sizeof(struct berval)
409 + nAttrs * sizeof(struct berval)
410 + nDerefVals * sizeof(DerefVal)
411 + nDerefRes * sizeof(DerefRes);
412 bv.bv_val = op->o_tmpalloc( bv.bv_len, op->o_tmpmemctx );
414 ber_init2( ber, &bv, LBER_USE_DER );
415 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
417 rc = ber_printf( ber, "{" /*}*/ );
418 for ( dr = drhead; dr != NULL; dr = dr->dr_next ) {
419 for ( i = 0; !BER_BVISNULL( &dr->dr_vals[ i ].dv_derefSpecVal ); i++ ) {
422 if ( dr->dr_vals[ i ].dv_derefSpecVal.bv_val == &dummy ) {
426 rc = ber_printf( ber, "{OO" /*}*/,
427 &dr->dr_spec.ds_derefAttr->ad_cname,
428 &dr->dr_vals[ i ].dv_derefSpecVal );
429 op->o_tmpfree( dr->dr_vals[ i ].dv_derefSpecVal.bv_val, op->o_tmpmemctx );
430 for ( j = 0; j < dr->dr_spec.ds_nattrs; j++ ) {
431 if ( dr->dr_vals[ i ].dv_attrVals[ j ] != NULL ) {
433 rc = ber_printf( ber, "t{" /*}*/,
434 (LBER_CONSTRUCTED|LBER_CLASS_CONTEXT) );
437 rc = ber_printf( ber, "{O[W]}",
438 &dr->dr_spec.ds_attributes[ j ]->ad_cname,
439 dr->dr_vals[ i ].dv_attrVals[ j ] );
440 op->o_tmpfree( dr->dr_vals[ i ].dv_attrVals[ j ],
445 rc = ber_printf( ber, /*{{*/ "}N}" );
447 rc = ber_printf( ber, /*{*/ "}" );
451 rc = ber_printf( ber, /*{*/ "}" );
452 if ( ber_flatten2( ber, &ctrlval, 0 ) == -1 ) {
453 if ( op->o_deref == SLAP_CONTROL_CRITICAL ) {
454 rc = LDAP_CONSTRAINT_VIOLATION;
457 rc = SLAP_CB_CONTINUE;
462 ctrl = op->o_tmpcalloc( 1,
463 sizeof( LDAPControl ) + ctrlval.bv_len + 1,
465 ctrl->ldctl_value.bv_val = (char *)&ctrl[ 1 ];
466 ctrl->ldctl_oid = LDAP_CONTROL_X_DEREF;
467 ctrl->ldctl_iscritical = 0;
468 ctrl->ldctl_value.bv_len = ctrlval.bv_len;
469 lutil_strncopy( ctrl->ldctl_value.bv_val, ctrlval.bv_val, ctrlval.bv_len );
470 ctrl->ldctl_value.bv_val[ ctrl->ldctl_value.bv_len ] = '\0';
475 if ( rs->sr_ctrls ) {
476 for ( ; rs->sr_ctrls[ i ] != NULL; i++ )
480 ctrlsp = op->o_tmpcalloc( i, sizeof(LDAPControl *), op->o_tmpmemctx );
482 if ( rs->sr_ctrls != NULL ) {
483 for ( ; rs->sr_ctrls[ i ] != NULL; i++ ) {
484 ctrlsp[ i ] = rs->sr_ctrls[ i ];
487 ctrlsp[ i++ ] = ctrl;
488 ctrlsp[ i++ ] = NULL;
489 if ( rs->sr_flags & REP_CTRLS_MUSTBEFREED ) {
490 op->o_tmpfree( rs->sr_ctrls, op->o_tmpmemctx );
492 rs->sr_ctrls = ctrlsp;
493 rs->sr_flags |= REP_CTRLS_MUSTBEFREED;
495 rc = SLAP_CB_CONTINUE;
499 for ( ; drhead != NULL; ) {
500 DerefRes *drnext = drhead->dr_next;
501 op->o_tmpfree( drhead, op->o_tmpmemctx );
505 } else if ( rs->sr_type == REP_RESULT ) {
506 rc = deref_cleanup( op, rs );
513 deref_op_search( Operation *op, SlapReply *rs )
519 sc = op->o_tmpcalloc( 1, sizeof( slap_callback ) + sizeof( deref_cb_t ), op->o_tmpmemctx );
521 dc = (deref_cb_t *)&sc[ 1 ];
522 dc->dc_on = (slap_overinst *)op->o_bd->bd_info;
523 dc->dc_ds = (DerefSpec *)op->o_ctrlderef;
525 sc->sc_response = deref_response;
526 sc->sc_cleanup = deref_cleanup;
527 sc->sc_private = (void *)dc;
529 sc->sc_next = op->o_callback->sc_next;
530 op->o_callback->sc_next = sc;
533 return SLAP_CB_CONTINUE;
537 deref_initialize(void)
541 rc = register_supported_control( LDAP_CONTROL_X_DEREF,
542 SLAP_CTRL_SEARCH, NULL,
543 deref_parseCtrl, &deref_cid );
544 if ( rc != LDAP_SUCCESS ) {
545 Debug( LDAP_DEBUG_ANY,
546 "deref_init: Failed to register control (%d)\n",
551 deref.on_bi.bi_type = "deref";
552 deref.on_bi.bi_op_search = deref_op_search;
554 return overlay_register( &deref );
557 #if SLAPD_OVER_DEREF == SLAPD_MOD_DYNAMIC
559 init_module( int argc, char *argv[] )
561 return deref_initialize();
563 #endif /* SLAPD_OVER_DEREF == SLAPD_MOD_DYNAMIC */
565 #endif /* SLAPD_OVER_DEREF */