git.sur5r.net Git - openldap/blob - servers/slapd/overlays/deref.c

   1 /* deref.c - dereference overlay */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1998-2010 The OpenLDAP Foundation.
   6  * Portions Copyright 2008 Pierangelo Masarati.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted only as authorized by the OpenLDAP
  11  * Public License.
  12  *
  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>.
  16  */
  17 /* ACKNOWLEDGEMENTS:
  18  * This work was initially developed by Pierangelo Masarati
  19  * for inclusion in OpenLDAP Software.
  20  */
  21
  22 #include "portable.h"
  23
  24 #ifdef SLAPD_OVER_DEREF
  25
  26 #include <stdio.h>
  27
  28 #include "ac/string.h"
  29 #include "ac/socket.h"
  30
  31 #include "slap.h"
  32 #include "config.h"
  33
  34 #include "lutil.h"
  35
  36 /*
  37  * 1. Specification
  38  *
  39  * 1.1. Request
  40  *
  41  *  controlValue ::= SEQUENCE OF derefSpec DerefSpec
  42  *
  43  *  DerefSpec ::= SEQUENCE {
  44  *      derefAttr       attributeDescription,    ; DN-valued
  45  *      attributes      AttributeList }
  46  *
  47  *  AttributeList ::= SEQUENCE OF attr AttributeDescription
  48  *
  49  *  derefAttr MUST be unique within controlValue
  50  *
  51  *
  52  * 1.2. Response
  53  *
  54  *  controlValue ::= SEQUENCE OF DerefRes
  55  *
  56  * From RFC 4511:
  57  *      PartialAttribute ::= SEQUENCE {
  58  *           type       AttributeDescription,
  59  *           vals       SET OF value AttributeValue }
  60  *
  61  *      PartialAttributeList ::= SEQUENCE OF
  62  *                           partialAttribute PartialAttribute
  63  *
  64  *  DerefRes ::= SEQUENCE {
  65  *      derefAttr       AttributeDescription,
  66  *      derefVal        LDAPDN,
  67  *      attrVals        [0] PartialAttributeList OPTIONAL }
  68  *
  69  *  If vals is empty, partialAttribute is omitted.
  70  *  If all vals in attrVals are empty, attrVals is omitted.
  71  *
  72  * 2. Examples
  73  *
  74  * 2.1. Example
  75  *
  76  * 2.1.1. Request
  77  *
  78  * { { member, { GUID, SID } }, { memberOf, { GUID, SID } } }
  79  *
  80  * 2.1.2. Response
  81  *
  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" ] } } } }
  88  *
  89  * 2.2. Example
  90  *
  91  * 2.2.1. Request
  92  *
  93  * { { member, { cn, uid, drink } } }
  94  *
  95  * 2.2.2. Response
  96  *
  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" } }
 101  *
 102  *
 103  * 3. Security considerations
 104  *
 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
 111  * attribute's value.
 112  */
 113
 114 #define o_deref                 o_ctrlflag[deref_cid]
 115 #define o_ctrlderef             o_controls[deref_cid]
 116
 117 typedef struct DerefSpec {
 118         AttributeDescription    *ds_derefAttr;
 119         AttributeDescription    **ds_attributes;
 120         int                     ds_nattrs;
 121         struct DerefSpec        *ds_next;
 122 } DerefSpec;
 123
 124 typedef struct DerefVal {
 125         struct berval   dv_derefSpecVal;
 126         BerVarray       *dv_attrVals;
 127 } DerefVal;
 128
 129 typedef struct DerefRes {
 130         DerefSpec               dr_spec;
 131         DerefVal                *dr_vals;
 132         struct DerefRes         *dr_next;
 133 } DerefRes;
 134
 135 typedef struct deref_cb_t {
 136         slap_overinst *dc_on;
 137         DerefSpec *dc_ds;
 138 } deref_cb_t;
 139
 140 static int                      deref_cid;
 141 static slap_overinst            deref;
 142
 143 static int
 144 deref_parseCtrl (
 145         Operation *op,
 146         SlapReply *rs,
 147         LDAPControl *ctrl )
 148 {
 149         ber_tag_t tag;
 150         BerElementBuffer berbuf;
 151         BerElement *ber = (BerElement *)&berbuf;
 152         ber_len_t len;
 153         char *last;
 154         DerefSpec *dshead = NULL, **dsp = &dshead;
 155         BerVarray attributes = NULL;
 156
 157         if ( op->o_deref != SLAP_CONTROL_NONE ) {
 158                 rs->sr_text = "Dereference control specified multiple times";
 159                 return LDAP_PROTOCOL_ERROR;
 160         }
 161
 162         if ( BER_BVISNULL( &ctrl->ldctl_value ) ) {
 163                 rs->sr_text = "Dereference control value is absent";
 164                 return LDAP_PROTOCOL_ERROR;
 165         }
 166
 167         if ( BER_BVISEMPTY( &ctrl->ldctl_value ) ) {
 168                 rs->sr_text = "Dereference control value is empty";
 169                 return LDAP_PROTOCOL_ERROR;
 170         }
 171
 172         ber_init2( ber, &ctrl->ldctl_value, 0 );
 173
 174         for ( tag = ber_first_element( ber, &len, &last );
 175                 tag != LBER_DEFAULT;
 176                 tag = ber_next_element( ber, &len, last ) )
 177         {
 178                 struct berval derefAttr;
 179                 DerefSpec *ds, *dstmp;
 180                 const char *text;
 181                 int rc;
 182                 ber_len_t cnt = sizeof(struct berval);
 183                 ber_len_t off = 0;
 184
 185                 if ( ber_scanf( ber, "{m{M}}", &derefAttr, &attributes, &cnt, off ) == LBER_ERROR )
 186                 {
 187                         rs->sr_text = "Dereference control: derefSpec decoding error";
 188                         rs->sr_err = LDAP_PROTOCOL_ERROR;
 189                         goto done;
 190                 }
 191
 192                 ds = (DerefSpec *)op->o_tmpcalloc( 1,
 193                         sizeof(DerefSpec) + sizeof(AttributeDescription *)*(cnt + 1),
 194                         op->o_tmpmemctx );
 195                 ds->ds_attributes = (AttributeDescription **)&ds[ 1 ];
 196                 ds->ds_nattrs = cnt;
 197
 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;
 202                         goto done;
 203                 }
 204
 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;
 209                                 goto done;
 210                         }
 211                 }
 212
 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;
 217                                 goto done;
 218                         }
 219
 220                         rs->sr_err = LDAP_SUCCESS;
 221                         goto justcleanup;
 222                 }
 223
 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;
 229                                 goto done;
 230                         }
 231                 }
 232
 233                 ber_memfree_x( attributes, op->o_tmpmemctx );
 234                 attributes = NULL;
 235
 236                 *dsp = ds;
 237                 dsp = &ds->ds_next;
 238         }
 239
 240         op->o_ctrlderef = (void *)dshead;
 241
 242         op->o_deref = ctrl->ldctl_iscritical
 243                 ? SLAP_CONTROL_CRITICAL
 244                 : SLAP_CONTROL_NONCRITICAL;
 245
 246         rs->sr_err = LDAP_SUCCESS;
 247
 248 done:;
 249         if ( rs->sr_err != LDAP_SUCCESS ) {
 250 justcleanup:;
 251                 for ( ; dshead; ) {
 252                         DerefSpec *dsnext = dshead->ds_next;
 253                         op->o_tmpfree( dshead, op->o_tmpmemctx );
 254                         dshead = dsnext;
 255                 }
 256         }
 257
 258         if ( attributes != NULL ) {
 259                 ber_memfree_x( attributes, op->o_tmpmemctx );
 260         }
 261
 262         return rs->sr_err;
 263 }
 264
 265 static int
 266 deref_cleanup( Operation *op, SlapReply *rs )
 267 {
 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;
 271
 272                 op->o_tmpfree( op->o_ctrlderef, op->o_tmpmemctx );
 273                 op->o_ctrlderef = NULL;
 274         }
 275
 276         return SLAP_CB_CONTINUE;
 277 }
 278
 279 static int
 280 deref_response( Operation *op, SlapReply *rs )
 281 {
 282         int rc = SLAP_CB_CONTINUE;
 283
 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;
 288                 DerefSpec *ds;
 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[2];
 294                 AccessControlState acl_state = ACL_STATE_INIT;
 295                 static char dummy = '\0';
 296                 Entry *ebase;
 297                 int i;
 298
 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;
 302                 }
 303
 304                 for ( ds = dc->dc_ds; ds; ds = ds->ds_next ) {
 305                         Attribute *a = attr_find( ebase->e_attrs, ds->ds_derefAttr );
 306
 307                         if ( a != NULL ) {
 308                                 DerefVal *dv;
 309                                 BerVarray *bva;
 310
 311                                 if ( !access_allowed( op, rs->sr_entry, a->a_desc,
 312                                                 NULL, ACL_READ, &acl_state ) )
 313                                 {
 314                                         continue;
 315                                 }
 316
 317                                 dr = op->o_tmpcalloc( 1,
 318                                         sizeof( DerefRes ) + ( sizeof( DerefVal ) + sizeof( BerVarray * ) * ds->ds_nattrs ) * ( a->a_numvals + 1 ),
 319                                         op->o_tmpmemctx );
 320                                 dr->dr_spec = *ds;
 321                                 dv = dr->dr_vals = (DerefVal *)&dr[ 1 ];
 322                                 bva = (BerVarray *)&dv[ a->a_numvals + 1 ];
 323
 324                                 bv.bv_len += ds->ds_derefAttr->ad_cname.bv_len;
 325                                 nAttrs++;
 326                                 nDerefRes++;
 327
 328                                 for ( i = 0; !BER_BVISNULL( &a->a_nvals[ i ] ); i++ ) {
 329                                         Entry *e = NULL;
 330
 331                                         dv[ i ].dv_attrVals = bva;
 332                                         bva += ds->ds_nattrs;
 333
 334
 335                                         if ( !access_allowed( op, rs->sr_entry, a->a_desc,
 336                                                         &a->a_nvals[ i ], ACL_READ, &acl_state ) )
 337                                         {
 338                                                 dv[ i ].dv_derefSpecVal.bv_val = &dummy;
 339                                                 continue;
 340                                         }
 341
 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;
 344                                         nVals++;
 345                                         nDerefVals++;
 346
 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 ) {
 349                                                 int j;
 350
 351                                                 if ( access_allowed( op, e, slap_schema.si_ad_entry,
 352                                                         NULL, ACL_READ, NULL ) )
 353                                                 {
 354                                                         for ( j = 0; j < ds->ds_nattrs; j++ ) {
 355                                                                 Attribute *aa;
 356
 357                                                                 if ( !access_allowed( op, e, ds->ds_attributes[ j ], NULL,
 358                                                                         ACL_READ, &acl_state ) )
 359                                                                 {
 360                                                                         continue;
 361                                                                 }
 362
 363                                                                 aa = attr_find( e->e_attrs, ds->ds_attributes[ j ] );
 364                                                                 if ( aa != NULL ) {
 365                                                                         unsigned k, h, last = aa->a_numvals;
 366
 367                                                                         ber_bvarray_dup_x( &dv[ i ].dv_attrVals[ j ],
 368                                                                                 aa->a_vals, op->o_tmpmemctx );
 369
 370                                                                         bv.bv_len += ds->ds_attributes[ j ]->ad_cname.bv_len;
 371
 372                                                                         for ( k = 0, h = 0; k < aa->a_numvals; k++ ) {
 373                                                                                 if ( !access_allowed( op, e,
 374                                                                                         aa->a_desc,
 375                                                                                         &aa->a_nvals[ k ],
 376                                                                                         ACL_READ, &acl_state ) )
 377                                                                                 {
 378                                                                                         op->o_tmpfree( dv[ i ].dv_attrVals[ j ][ h ].bv_val,
 379                                                                                                 op->o_tmpmemctx );
 380                                                                                         dv[ i ].dv_attrVals[ j ][ h ] = dv[ i ].dv_attrVals[ j ][ --last ];
 381                                                                                         BER_BVZERO( &dv[ i ].dv_attrVals[ j ][ last ] );
 382                                                                                         continue;
 383                                                                                 }
 384                                                                                 bv.bv_len += dv[ i ].dv_attrVals[ j ][ h ].bv_len;
 385                                                                                 nVals++;
 386                                                                                 h++;
 387                                                                         }
 388                                                                         nAttrs++;
 389                                                                 }
 390                                                         }
 391                                                 }
 392
 393                                                 overlay_entry_release_ov( op, e, 0, dc->dc_on );
 394                                         }
 395                                 }
 396
 397                                 *drp = dr;
 398                                 drp = &dr->dr_next;
 399                         }
 400                 }
 401                 overlay_entry_release_ov( op, ebase, 0, dc->dc_on );
 402
 403                 if ( drhead == NULL ) {
 404                         return SLAP_CB_CONTINUE;
 405                 }
 406
 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 );
 413
 414                 ber_init2( ber, &bv, LBER_USE_DER );
 415                 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
 416
 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++ ) {
 420                                 int j, first = 1;
 421
 422                                 if ( dr->dr_vals[ i ].dv_derefSpecVal.bv_val == &dummy ) {
 423                                         continue;
 424                                 }
 425
 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 ) {
 432                                                 if ( first ) {
 433                                                         rc = ber_printf( ber, "t{" /*}*/,
 434                                                                 (LBER_CONSTRUCTED|LBER_CLASS_CONTEXT) );
 435                                                         first = 0;
 436                                                 }
 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 ],
 441                                                         op->o_tmpmemctx );
 442                                         }
 443                                 }
 444                                 if ( !first ) {
 445                                         rc = ber_printf( ber, /*{{*/ "}N}" );
 446                                 } else {
 447                                         rc = ber_printf( ber, /*{*/ "}" );
 448                                 }
 449                         }
 450                 }
 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;
 455
 456                         } else {
 457                                 rc = SLAP_CB_CONTINUE;
 458                         }
 459                         goto cleanup;
 460                 }
 461
 462                 ctrl = op->o_tmpcalloc( 1,
 463                         sizeof( LDAPControl ) + ctrlval.bv_len + 1,
 464                         op->o_tmpmemctx );
 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                 AC_MEMCPY( ctrl->ldctl_value.bv_val, ctrlval.bv_val, ctrlval.bv_len );
 470                 ctrl->ldctl_value.bv_val[ ctrl->ldctl_value.bv_len ] = '\0';
 471
 472                 ber_free_buf( ber );
 473
 474                 ctrlsp[0] = ctrl;
 475                 ctrlsp[1] = NULL;
 476                 slap_add_ctrls( op, rs, ctrlsp );
 477
 478                 rc = SLAP_CB_CONTINUE;
 479
 480 cleanup:;
 481                 /* release all */
 482                 for ( ; drhead != NULL; ) {
 483                         DerefRes *drnext = drhead->dr_next;
 484                         op->o_tmpfree( drhead, op->o_tmpmemctx );
 485                         drhead = drnext;
 486                 }
 487
 488         } else if ( rs->sr_type == REP_RESULT ) {
 489                 rc = deref_cleanup( op, rs );
 490         }
 491
 492         return rc;
 493 }
 494
 495 static int
 496 deref_op_search( Operation *op, SlapReply *rs )
 497 {
 498         if ( op->o_deref ) {
 499                 slap_callback *sc;
 500                 deref_cb_t *dc;
 501
 502                 sc = op->o_tmpcalloc( 1, sizeof( slap_callback ) + sizeof( deref_cb_t ), op->o_tmpmemctx );
 503
 504                 dc = (deref_cb_t *)&sc[ 1 ];
 505                 dc->dc_on = (slap_overinst *)op->o_bd->bd_info;
 506                 dc->dc_ds = (DerefSpec *)op->o_ctrlderef;
 507
 508                 sc->sc_response = deref_response;
 509                 sc->sc_cleanup = deref_cleanup;
 510                 sc->sc_private = (void *)dc;
 511
 512                 sc->sc_next = op->o_callback->sc_next;
 513                 op->o_callback->sc_next = sc;
 514         }
 515
 516         return SLAP_CB_CONTINUE;
 517 }
 518
 519 int
 520 deref_initialize(void)
 521 {
 522         int rc;
 523
 524         rc = register_supported_control( LDAP_CONTROL_X_DEREF,
 525                 SLAP_CTRL_SEARCH, NULL,
 526                 deref_parseCtrl, &deref_cid );
 527         if ( rc != LDAP_SUCCESS ) {
 528                 Debug( LDAP_DEBUG_ANY,
 529                         "deref_init: Failed to register control (%d)\n",
 530                         rc, 0, 0 );
 531                 return -1;
 532         }
 533
 534         deref.on_bi.bi_type = "deref";
 535         deref.on_bi.bi_op_search = deref_op_search;
 536
 537         return overlay_register( &deref );
 538 }
 539
 540 #if SLAPD_OVER_DEREF == SLAPD_MOD_DYNAMIC
 541 int
 542 init_module( int argc, char *argv[] )
 543 {
 544         return deref_initialize();
 545 }
 546 #endif /* SLAPD_OVER_DEREF == SLAPD_MOD_DYNAMIC */
 547
 548 #endif /* SLAPD_OVER_DEREF */