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

   1 /* backover.c - backend overlay routines */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2003-2005 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16
  17 /* Functions to overlay other modules over a backend. */
  18
  19 #include "portable.h"
  20
  21 #include <stdio.h>
  22
  23 #include <ac/string.h>
  24 #include <ac/socket.h>
  25
  26 #define SLAPD_TOOLS
  27 #include "slap.h"
  28
  29 static slap_overinst *overlays;
  30
  31 enum db_which { db_open = 0, db_close, db_destroy };
  32
  33 static int
  34 over_db_func(
  35         BackendDB *be,
  36         enum db_which which
  37 )
  38 {
  39         slap_overinfo *oi = be->bd_info->bi_private;
  40         slap_overinst *on = oi->oi_list;
  41         BackendInfo *bi_orig = be->bd_info;
  42         BI_db_open **func;
  43         int rc = 0;
  44
  45         func = &oi->oi_orig->bi_db_open;
  46         if ( func[which] ) {
  47                 be->bd_info = oi->oi_orig;
  48                 rc = func[which]( be );
  49         }
  50
  51         for (; on && rc == 0; on=on->on_next) {
  52                 be->bd_info = &on->on_bi;
  53                 func = &on->on_bi.bi_db_open;
  54                 if (func[which]) {
  55                         rc = func[which]( be );
  56                 }
  57         }
  58         be->bd_info = bi_orig;
  59         return rc;
  60 }
  61
  62 static int
  63 over_db_config(
  64         BackendDB *be,
  65         const char *fname,
  66         int lineno,
  67         int argc,
  68         char **argv
  69 )
  70 {
  71         slap_overinfo *oi = be->bd_info->bi_private;
  72         slap_overinst *on = oi->oi_list;
  73         BackendInfo *bi_orig = be->bd_info;
  74         int rc = 0;
  75
  76         if ( oi->oi_orig->bi_db_config ) {
  77                 be->bd_info = oi->oi_orig;
  78                 rc = oi->oi_orig->bi_db_config( be, fname, lineno,
  79                         argc, argv );
  80
  81                 if ( be->bd_info != oi->oi_orig ) {
  82                         slap_overinfo   *oi2;
  83                         slap_overinst   *on2, **onp;
  84                         BackendDB       be2 = *be;
  85                         int             i;
  86
  87                         /* a database added an overlay;
  88                          * work it around... */
  89                         assert( overlay_is_over( be ) );
  90
  91                         oi2 = ( slap_overinfo * )be->bd_info->bi_private;
  92                         on2 = oi2->oi_list;
  93
  94                         /* need to put a uniqueness check here as well;
  95                          * note that in principle there could be more than
  96                          * one overlay as a result of multiple calls to
  97                          * overlay_config() */
  98                         be2.bd_info = (BackendInfo *)oi;
  99
 100                         for ( i = 0, onp = &on2; *onp; i++, onp = &(*onp)->on_next ) {
 101                                 if ( overlay_is_inst( &be2, (*onp)->on_bi.bi_type ) ) {
 102                                         Debug( LDAP_DEBUG_ANY, "over_db_config(): "
 103                                                         "warning, freshly added "
 104                                                         "overlay #%d \"%s\" is already in list\n",
 105                                                         i, (*onp)->on_bi.bi_type, 0 );
 106
 107                                         /* NOTE: if the overlay already exists,
 108                                          * there is no way to merge the results
 109                                          * of the configuration that may have
 110                                          * occurred during bi_db_config(); we
 111                                          * just issue a warning, and the
 112                                          * administrator should deal with this */
 113                                 }
 114                         }
 115                         *onp = oi->oi_list;
 116
 117                         oi->oi_list = on2;
 118
 119                         ch_free( be->bd_info );
 120                 }
 121
 122                 be->bd_info = (BackendInfo *)oi;
 123                 if ( rc != SLAP_CONF_UNKNOWN ) return rc;
 124         }
 125
 126         for (; on; on=on->on_next) {
 127                 if (on->on_bi.bi_db_config) {
 128                         be->bd_info = &on->on_bi;
 129                         rc = on->on_bi.bi_db_config( be, fname, lineno,
 130                                 argc, argv );
 131                         if ( rc != SLAP_CONF_UNKNOWN ) break;
 132                 }
 133         }
 134         be->bd_info = bi_orig;
 135         return rc;
 136 }
 137
 138 static int
 139 over_db_open(
 140         BackendDB *be
 141 )
 142 {
 143         return over_db_func( be, db_open );
 144 }
 145
 146 static int
 147 over_db_close(
 148         BackendDB *be
 149 )
 150 {
 151         slap_overinfo *oi = be->bd_info->bi_private;
 152         slap_overinst *on = oi->oi_list;
 153         BackendInfo *bi_orig = be->bd_info;
 154         int rc = 0;
 155
 156         for (; on && rc == 0; on=on->on_next) {
 157                 be->bd_info = &on->on_bi;
 158                 if ( be->bd_info->bi_db_close ) {
 159                         rc = be->bd_info->bi_db_close( be );
 160                 }
 161         }
 162
 163         if ( oi->oi_orig->bi_db_close ) {
 164                 be->bd_info = oi->oi_orig;
 165                 rc = be->bd_info->bi_db_close( be );
 166         }
 167
 168         be->bd_info = bi_orig;
 169         return rc;
 170 }
 171
 172 static int
 173 over_db_destroy(
 174         BackendDB *be
 175 )
 176 {
 177         slap_overinfo *oi = be->bd_info->bi_private;
 178         slap_overinst *on = oi->oi_list, *next;
 179         int rc;
 180
 181         rc = over_db_func( be, db_destroy );
 182
 183         for (next = on->on_next; on; on=next) {
 184                 next = on->on_next;
 185                 free( on );
 186         }
 187         free( oi );
 188         return rc;
 189 }
 190
 191 static int
 192 over_back_response ( Operation *op, SlapReply *rs )
 193 {
 194         slap_overinfo *oi = op->o_callback->sc_private;
 195         slap_overinst *on = oi->oi_list;
 196         int rc = SLAP_CB_CONTINUE;
 197         BackendDB *be = op->o_bd, db = *op->o_bd;
 198
 199         db.be_flags |= SLAP_DBFLAG_OVERLAY;
 200         op->o_bd = &db;
 201         for (; on; on=on->on_next ) {
 202                 if ( on->on_response ) {
 203                         db.bd_info = (BackendInfo *)on;
 204                         rc = on->on_response( op, rs );
 205                         if ( rc != SLAP_CB_CONTINUE ) break;
 206                 }
 207         }
 208         op->o_bd = be;
 209         return rc;
 210 }
 211
 212 enum op_which {
 213         op_bind = 0,
 214         op_unbind,
 215         op_search,
 216         op_compare,
 217         op_modify,
 218         op_modrdn,
 219         op_add,
 220         op_delete,
 221         op_abandon,
 222         op_cancel,
 223         op_extended,
 224         op_aux_operational,
 225         op_aux_chk_referrals,
 226         op_aux_chk_controls,
 227         op_last
 228 };
 229
 230 /*
 231  * default return code in case of missing backend function
 232  * and overlay stack returning SLAP_CB_CONTINUE
 233  */
 234 static int op_rc[] = {
 235         LDAP_UNWILLING_TO_PERFORM,      /* bind */
 236         LDAP_UNWILLING_TO_PERFORM,      /* unbind */
 237         LDAP_UNWILLING_TO_PERFORM,      /* search */
 238         SLAP_CB_CONTINUE,               /* compare; pass to frontend */
 239         LDAP_UNWILLING_TO_PERFORM,      /* modify */
 240         LDAP_UNWILLING_TO_PERFORM,      /* modrdn */
 241         LDAP_UNWILLING_TO_PERFORM,      /* add */
 242         LDAP_UNWILLING_TO_PERFORM,      /* delete */
 243         LDAP_UNWILLING_TO_PERFORM,      /* abandon */
 244         LDAP_UNWILLING_TO_PERFORM,      /* cancel */
 245         LDAP_UNWILLING_TO_PERFORM,      /* extended */
 246         LDAP_SUCCESS,                   /* aux_operational */
 247         LDAP_SUCCESS,                   /* aux_chk_referrals */
 248         SLAP_CB_CONTINUE                /* aux_chk_controls; pass to frontend */
 249 };
 250
 251 static int
 252 over_access_allowed(
 253         Operation               *op,
 254         Entry                   *e,
 255         AttributeDescription    *desc,
 256         struct berval           *val,
 257         slap_access_t           access,
 258         AccessControlState      *state,
 259         slap_mask_t             *maskp )
 260 {
 261         slap_overinfo *oi;
 262         slap_overinst *on;
 263         BackendDB *be = op->o_bd, db;
 264         int rc = SLAP_CB_CONTINUE;
 265
 266         /* FIXME: used to happen for instance during abandon
 267          * when global overlays are used... */
 268         assert( op->o_bd != NULL );
 269
 270         oi = op->o_bd->bd_info->bi_private;
 271         on = oi->oi_list;
 272
 273         if ( !SLAP_ISOVERLAY( op->o_bd ) ) {
 274                 db = *op->o_bd;
 275                 db.be_flags |= SLAP_DBFLAG_OVERLAY;
 276                 op->o_bd = &db;
 277         }
 278
 279         for ( ; on; on = on->on_next ) {
 280                 if ( on->on_bi.bi_access_allowed ) {
 281                         op->o_bd->bd_info = (BackendInfo *)on;
 282                         rc = on->on_bi.bi_access_allowed( op, e,
 283                                 desc, val, access, state, maskp );
 284                         if ( rc != SLAP_CB_CONTINUE ) break;
 285                 }
 286         }
 287
 288         if ( rc == SLAP_CB_CONTINUE && oi->oi_orig->bi_access_allowed ) {
 289                 op->o_bd->bd_info = oi->oi_orig;
 290                 rc = oi->oi_orig->bi_access_allowed( op, e,
 291                         desc, val, access, state, maskp );
 292         }
 293         /* should not fall thru this far without anything happening... */
 294         if ( rc == SLAP_CB_CONTINUE ) {
 295                 /* access not allowed */
 296                 rc = 0;
 297         }
 298
 299         op->o_bd = be;
 300         return rc;
 301 }
 302
 303 static int
 304 over_op_func(
 305         Operation *op,
 306         SlapReply *rs,
 307         enum op_which which
 308 )
 309 {
 310         slap_overinfo *oi;
 311         slap_overinst *on;
 312         BI_op_bind **func;
 313         BackendDB *be = op->o_bd, db;
 314         slap_callback cb = {NULL, over_back_response, NULL, NULL};
 315         int rc = SLAP_CB_CONTINUE;
 316
 317         /* FIXME: used to happen for instance during abandon
 318          * when global overlays are used... */
 319         assert( op->o_bd != NULL );
 320
 321         oi = op->o_bd->bd_info->bi_private;
 322         on = oi->oi_list;
 323
 324         if ( !SLAP_ISOVERLAY( op->o_bd )) {
 325                 db = *op->o_bd;
 326                 db.be_flags |= SLAP_DBFLAG_OVERLAY;
 327                 op->o_bd = &db;
 328         }
 329         cb.sc_next = op->o_callback;
 330         cb.sc_private = oi;
 331         op->o_callback = &cb;
 332
 333         for (; on; on=on->on_next ) {
 334                 func = &on->on_bi.bi_op_bind;
 335                 if ( func[which] ) {
 336                         op->o_bd->bd_info = (BackendInfo *)on;
 337                         rc = func[which]( op, rs );
 338                         if ( rc != SLAP_CB_CONTINUE ) break;
 339                 }
 340         }
 341
 342         func = &oi->oi_orig->bi_op_bind;
 343         if ( func[which] && rc == SLAP_CB_CONTINUE ) {
 344                 op->o_bd->bd_info = oi->oi_orig;
 345                 rc = func[which]( op, rs );
 346         }
 347         /* should not fall thru this far without anything happening... */
 348         if ( rc == SLAP_CB_CONTINUE ) {
 349                 rc = op_rc[ which ];
 350         }
 351
 352         /* The underlying backend didn't handle the request, make sure
 353          * overlay cleanup is processed.
 354          */
 355         if ( rc == LDAP_UNWILLING_TO_PERFORM ) {
 356                 slap_callback *sc_next;
 357                 for ( ; op->o_callback && op->o_callback != cb.sc_next;
 358                         op->o_callback = sc_next ) {
 359                         sc_next = op->o_callback->sc_next;
 360                         if ( op->o_callback->sc_cleanup ) {
 361                                 op->o_callback->sc_cleanup( op, rs );
 362                         }
 363                 }
 364         }
 365         op->o_bd = be;
 366         op->o_callback = cb.sc_next;
 367         return rc;
 368 }
 369
 370 static int
 371 over_op_bind( Operation *op, SlapReply *rs )
 372 {
 373         return over_op_func( op, rs, op_bind );
 374 }
 375
 376 static int
 377 over_op_unbind( Operation *op, SlapReply *rs )
 378 {
 379         return over_op_func( op, rs, op_unbind );
 380 }
 381
 382 static int
 383 over_op_search( Operation *op, SlapReply *rs )
 384 {
 385         return over_op_func( op, rs, op_search );
 386 }
 387
 388 static int
 389 over_op_compare( Operation *op, SlapReply *rs )
 390 {
 391         return over_op_func( op, rs, op_compare );
 392 }
 393
 394 static int
 395 over_op_modify( Operation *op, SlapReply *rs )
 396 {
 397         return over_op_func( op, rs, op_modify );
 398 }
 399
 400 static int
 401 over_op_modrdn( Operation *op, SlapReply *rs )
 402 {
 403         return over_op_func( op, rs, op_modrdn );
 404 }
 405
 406 static int
 407 over_op_add( Operation *op, SlapReply *rs )
 408 {
 409         return over_op_func( op, rs, op_add );
 410 }
 411
 412 static int
 413 over_op_delete( Operation *op, SlapReply *rs )
 414 {
 415         return over_op_func( op, rs, op_delete );
 416 }
 417
 418 static int
 419 over_op_abandon( Operation *op, SlapReply *rs )
 420 {
 421         return over_op_func( op, rs, op_abandon );
 422 }
 423
 424 static int
 425 over_op_cancel( Operation *op, SlapReply *rs )
 426 {
 427         return over_op_func( op, rs, op_cancel );
 428 }
 429
 430 static int
 431 over_op_extended( Operation *op, SlapReply *rs )
 432 {
 433         return over_op_func( op, rs, op_extended );
 434 }
 435
 436 static int
 437 over_aux_operational( Operation *op, SlapReply *rs )
 438 {
 439         return over_op_func( op, rs, op_aux_operational );
 440 }
 441
 442 static int
 443 over_aux_chk_referrals( Operation *op, SlapReply *rs )
 444 {
 445         return over_op_func( op, rs, op_aux_chk_referrals );
 446 }
 447
 448 static int
 449 over_aux_chk_controls( Operation *op, SlapReply *rs )
 450 {
 451         return over_op_func( op, rs, op_aux_chk_controls );
 452 }
 453
 454 static int
 455 over_connection_destroy(
 456         BackendDB       *bd,
 457         Connection      *conn
 458 )
 459 {
 460         slap_overinfo *oi;
 461         slap_overinst *on;
 462         BackendDB db;
 463         int rc = SLAP_CB_CONTINUE;
 464
 465         /* FIXME: used to happen for instance during abandon
 466          * when global overlays are used... */
 467         assert( bd != NULL );
 468
 469         oi = bd->bd_info->bi_private;
 470         on = oi->oi_list;
 471
 472         if ( !SLAP_ISOVERLAY( bd )) {
 473                 db = *bd;
 474                 db.be_flags |= SLAP_DBFLAG_OVERLAY;
 475                 bd = &db;
 476         }
 477
 478         for (; on; on=on->on_next ) {
 479                 if ( on->on_bi.bi_connection_destroy ) {
 480                         bd->bd_info = (BackendInfo *)on;
 481                         rc = on->on_bi.bi_connection_destroy( bd, conn );
 482                         if ( rc != SLAP_CB_CONTINUE ) break;
 483                 }
 484         }
 485
 486         if ( oi->oi_orig->bi_connection_destroy && rc == SLAP_CB_CONTINUE ) {
 487                 bd->bd_info = oi->oi_orig;
 488                 rc = oi->oi_orig->bi_connection_destroy( bd, conn );
 489         }
 490         /* should not fall thru this far without anything happening... */
 491         if ( rc == SLAP_CB_CONTINUE ) {
 492                 rc = LDAP_UNWILLING_TO_PERFORM;
 493         }
 494
 495         return rc;
 496 }
 497
 498 int
 499 overlay_register(
 500         slap_overinst *on
 501 )
 502 {
 503         on->on_next = overlays;
 504         overlays = on;
 505         return 0;
 506 }
 507
 508 /*
 509  * iterator on registered overlays; overlay_next( NULL ) returns the first
 510  * overlay; * subsequent calls with the previously returned value allow to
 511  * iterate * over the entire list; returns NULL when no more overlays are
 512  * registered.
 513  */
 514
 515 slap_overinst *
 516 overlay_next(
 517         slap_overinst *on
 518 )
 519 {
 520         if ( on == NULL ) {
 521                 return overlays;
 522         }
 523
 524         return on->on_next;
 525 }
 526
 527 /*
 528  * returns a specific registered overlay based on the type; NULL if not
 529  * registered.
 530  */
 531
 532 slap_overinst *
 533 overlay_find( const char *over_type )
 534 {
 535         slap_overinst *on = overlays;
 536
 537         assert( over_type );
 538
 539         for ( ; on; on = on->on_next ) {
 540                 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
 541                         break;
 542                 }
 543         }
 544
 545         return on;
 546 }
 547
 548 static const char overtype[] = "over";
 549
 550 /*
 551  * returns TRUE (1) if the database is actually an overlay instance;
 552  * FALSE (0) otherwise.
 553  */
 554
 555 int
 556 overlay_is_over( BackendDB *be )
 557 {
 558         return be->bd_info->bi_type == overtype;
 559 }
 560
 561 /*
 562  * returns TRUE (1) if the given database is actually an overlay
 563  * instance and, somewhere in the list, contains the requested overlay;
 564  * FALSE (0) otherwise.
 565  */
 566
 567 int
 568 overlay_is_inst( BackendDB *be, const char *over_type )
 569 {
 570         slap_overinst   *on;
 571
 572         assert( be );
 573
 574         if ( !overlay_is_over( be ) ) {
 575                 return 0;
 576         }
 577
 578         on = ((slap_overinfo *)be->bd_info->bi_private)->oi_list;
 579         for ( ; on; on = on->on_next ) {
 580                 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
 581                         return 1;
 582                 }
 583         }
 584
 585         return 0;
 586 }
 587
 588 int
 589 overlay_register_control( BackendDB *be, const char *oid )
 590 {
 591         int             rc = 0;
 592         int             gotit = 0;
 593         int             cid;
 594
 595         if ( slap_find_control_id( oid, &cid ) == LDAP_CONTROL_NOT_FOUND ) {
 596                 return -1;
 597         }
 598
 599         if ( SLAP_DBFLAGS( be ) & SLAP_DBFLAG_GLOBAL_OVERLAY ) {
 600                 BackendDB *bd;
 601
 602                 /* add to all backends... */
 603                 LDAP_STAILQ_FOREACH( bd, &backendDB, be_next ) {
 604                         if ( be == bd ) {
 605                                 gotit = 1;
 606                         }
 607
 608                         bd->be_ctrls[ cid ] = 1;
 609                         bd->be_ctrls[ SLAP_MAX_CIDS ] = 1;
 610                 }
 611
 612         }
 613
 614         if ( rc == 0 && !gotit ) {
 615                 be->be_ctrls[ cid ] = 1;
 616                 be->be_ctrls[ SLAP_MAX_CIDS ] = 1;
 617         }
 618
 619         return rc;
 620 }
 621
 622 /* add an overlay to a particular backend. */
 623 int
 624 overlay_config( BackendDB *be, const char *ov )
 625 {
 626         slap_overinst *on = NULL, *on2 = NULL;
 627         slap_overinfo *oi = NULL;
 628         BackendInfo *bi = NULL;
 629
 630         on = overlay_find( ov );
 631         if ( !on ) {
 632                 Debug( LDAP_DEBUG_ANY, "overlay \"%s\" not found\n", ov, 0, 0 );
 633                 return 1;
 634         }
 635
 636         /* If this is the first overlay on this backend, set up the
 637          * overlay info structure
 638          */
 639         if ( !overlay_is_over( be ) ) {
 640                 oi = ch_malloc( sizeof( slap_overinfo ) );
 641                 oi->oi_orig = be->bd_info;
 642                 oi->oi_bi = *be->bd_info;
 643
 644                 /* NOTE: the first time a global overlay is configured,
 645                  * frontendDB gets this flag; it is used later by overlays
 646                  * to determine if they're stacked on top of the frontendDB */
 647                 if ( oi->oi_orig == frontendDB->bd_info ) {
 648                         SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLOBAL_OVERLAY;
 649                 }
 650
 651                 /* Save a pointer to ourself in bi_private.
 652                  */
 653                 oi->oi_bi.bi_private = oi;
 654                 oi->oi_list = NULL;
 655                 bi = (BackendInfo *)oi;
 656
 657                 bi->bi_type = (char *)overtype;
 658
 659                 bi->bi_db_config = over_db_config;
 660                 bi->bi_db_open = over_db_open;
 661                 bi->bi_db_close = over_db_close;
 662                 bi->bi_db_destroy = over_db_destroy;
 663
 664                 bi->bi_op_bind = over_op_bind;
 665                 bi->bi_op_unbind = over_op_unbind;
 666                 bi->bi_op_search = over_op_search;
 667                 bi->bi_op_compare = over_op_compare;
 668                 bi->bi_op_modify = over_op_modify;
 669                 bi->bi_op_modrdn = over_op_modrdn;
 670                 bi->bi_op_add = over_op_add;
 671                 bi->bi_op_delete = over_op_delete;
 672                 bi->bi_op_abandon = over_op_abandon;
 673                 bi->bi_op_cancel = over_op_cancel;
 674
 675                 bi->bi_extended = over_op_extended;
 676
 677                 /*
 678                  * this is fine because it has the same
 679                  * args of the operations; we need to rework
 680                  * all the hooks to share the same args
 681                  * of the operations...
 682                  */
 683                 bi->bi_operational = over_aux_operational;
 684                 bi->bi_chk_referrals = over_aux_chk_referrals;
 685                 bi->bi_chk_controls = over_aux_chk_controls;
 686
 687                 /* this has a specific arglist */
 688                 bi->bi_access_allowed = over_access_allowed;
 689
 690                 bi->bi_connection_destroy = over_connection_destroy;
 691
 692                 be->bd_info = bi;
 693
 694         } else {
 695                 if ( overlay_is_inst( be, ov ) ) {
 696                         Debug( LDAP_DEBUG_ANY, "overlay_config(): "
 697                                         "warning, overlay \"%s\" "
 698                                         "already in list\n", ov, 0, 0 );
 699                 }
 700
 701                 oi = be->bd_info->bi_private;
 702         }
 703
 704         /* Insert new overlay on head of list. Overlays are executed
 705          * in reverse of config order...
 706          */
 707         on2 = ch_calloc( 1, sizeof(slap_overinst) );
 708         *on2 = *on;
 709         on2->on_info = oi;
 710         on2->on_next = oi->oi_list;
 711         oi->oi_list = on2;
 712
 713         /* Any initialization needed? */
 714         if ( on->on_bi.bi_db_init ) {
 715                 int rc;
 716                 be->bd_info = (BackendInfo *)on2;
 717                 rc = on2->on_bi.bi_db_init( be );
 718                 be->bd_info = (BackendInfo *)oi;
 719                 if ( rc ) return rc;
 720         }
 721
 722         return 0;
 723 }
 724