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

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 2002-2004 The OpenLDAP Foundation.
   5  * Portions Copyright 1997,2002-2003 IBM Corporation.
   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 /* ACKNOWLEDGEMENTS:
  17  * This work was initially developed by IBM Corporation for use in
  18  * IBM products and subsequently ported to OpenLDAP Software by
  19  * Steve Omrani.  Additional significant contributors include:
  20  *   Luke Howard
  21  */
  22
  23 #include "portable.h"
  24 #include <slap.h>
  25 #include <slapi.h>
  26
  27 static int
  28 isOkNetscapeParam( int param )
  29 {
  30         switch ( param ) {
  31         case SLAPI_BACKEND:
  32         case SLAPI_CONNECTION:
  33         case SLAPI_OPERATION:
  34         case SLAPI_OPERATION_PARAMETERS:
  35         case SLAPI_OPERATION_TYPE:
  36         case SLAPI_OPERATION_ID:
  37         case SLAPI_OPERATION_AUTHTYPE:
  38         case SLAPI_REQUESTOR_ISROOT:
  39         case SLAPI_BE_MONITORDN:
  40         case SLAPI_BE_TYPE:
  41         case SLAPI_BE_READONLY:
  42         case SLAPI_BE_LASTMOD:
  43         case SLAPI_CONN_ID:
  44         case SLAPI_OPINITIATED_TIME:
  45         case SLAPI_REQUESTOR_DN:
  46         case SLAPI_REQUESTOR_ISUPDATEDN:
  47         case SLAPI_CONN_DN:
  48         case SLAPI_CONN_CLIENTIP:
  49         case SLAPI_CONN_SERVERIP:
  50         case SLAPI_CONN_AUTHTYPE:
  51         case SLAPI_CONN_AUTHMETHOD:
  52         case SLAPI_CONN_CERT:
  53         case SLAPI_X_CONN_IS_UDP:
  54         case SLAPI_X_CONN_CLIENTPATH:
  55         case SLAPI_X_CONN_SERVERPATH:
  56         case SLAPI_X_CONN_SSF:
  57         case SLAPI_X_CONN_SASL_CONTEXT:
  58         case SLAPI_IBM_CONN_DN_ALT:
  59         case SLAPI_IBM_CONN_DN_ORIG:
  60         case SLAPI_IBM_GSSAPI_CONTEXT:
  61         case SLAPI_PLUGIN:
  62         case SLAPI_PLUGIN_PRIVATE:
  63         case SLAPI_PLUGIN_TYPE:
  64         case SLAPI_PLUGIN_ARGV:
  65         case SLAPI_PLUGIN_ARGC:
  66         case SLAPI_PLUGIN_VERSION:
  67         case SLAPI_PLUGIN_OPRETURN:
  68         case SLAPI_PLUGIN_OBJECT:
  69         case SLAPI_PLUGIN_DESTROY_FN:
  70         case SLAPI_PLUGIN_DESCRIPTION:
  71         case SLAPI_PLUGIN_INTOP_RESULT:
  72         case SLAPI_PLUGIN_INTOP_SEARCH_ENTRIES:
  73         case SLAPI_PLUGIN_INTOP_SEARCH_REFERRALS:
  74         case SLAPI_PLUGIN_DB_BIND_FN:
  75         case SLAPI_PLUGIN_DB_UNBIND_FN:
  76         case SLAPI_PLUGIN_DB_SEARCH_FN:
  77         case SLAPI_PLUGIN_DB_COMPARE_FN:
  78         case SLAPI_PLUGIN_DB_MODIFY_FN:
  79         case SLAPI_PLUGIN_DB_MODRDN_FN:
  80         case SLAPI_PLUGIN_DB_ADD_FN:
  81         case SLAPI_PLUGIN_DB_DELETE_FN:
  82         case SLAPI_PLUGIN_DB_ABANDON_FN:
  83         case SLAPI_PLUGIN_DB_CONFIG_FN:
  84         case SLAPI_PLUGIN_CLOSE_FN:
  85         case SLAPI_PLUGIN_DB_FLUSH_FN:
  86         case SLAPI_PLUGIN_START_FN:
  87         case SLAPI_PLUGIN_DB_SEQ_FN:
  88         case SLAPI_PLUGIN_DB_ENTRY_FN:
  89         case SLAPI_PLUGIN_DB_REFERRAL_FN:
  90         case SLAPI_PLUGIN_DB_RESULT_FN:
  91         case SLAPI_PLUGIN_DB_LDIF2DB_FN:
  92         case SLAPI_PLUGIN_DB_DB2LDIF_FN:
  93         case SLAPI_PLUGIN_DB_BEGIN_FN:
  94         case SLAPI_PLUGIN_DB_COMMIT_FN:
  95         case SLAPI_PLUGIN_DB_ABORT_FN:
  96         case SLAPI_PLUGIN_DB_ARCHIVE2DB_FN:
  97         case SLAPI_PLUGIN_DB_DB2ARCHIVE_FN:
  98         case SLAPI_PLUGIN_DB_NEXT_SEARCH_ENTRY_FN:
  99         case SLAPI_PLUGIN_DB_FREE_RESULT_SET_FN:
 100         case SLAPI_PLUGIN_DB_SIZE_FN:
 101         case SLAPI_PLUGIN_DB_TEST_FN:
 102         case SLAPI_PLUGIN_DB_NO_ACL:
 103         case SLAPI_PLUGIN_EXT_OP_FN:
 104         case SLAPI_PLUGIN_EXT_OP_OIDLIST:
 105         case SLAPI_PLUGIN_PRE_BIND_FN:
 106         case SLAPI_PLUGIN_PRE_UNBIND_FN:
 107         case SLAPI_PLUGIN_PRE_SEARCH_FN:
 108         case SLAPI_PLUGIN_PRE_COMPARE_FN:
 109         case SLAPI_PLUGIN_PRE_MODIFY_FN:
 110         case SLAPI_PLUGIN_PRE_MODRDN_FN:
 111         case SLAPI_PLUGIN_PRE_ADD_FN:
 112         case SLAPI_PLUGIN_PRE_DELETE_FN:
 113         case SLAPI_PLUGIN_PRE_ABANDON_FN:
 114         case SLAPI_PLUGIN_PRE_ENTRY_FN:
 115         case SLAPI_PLUGIN_PRE_REFERRAL_FN:
 116         case SLAPI_PLUGIN_PRE_RESULT_FN:
 117         case SLAPI_PLUGIN_POST_BIND_FN:
 118         case SLAPI_PLUGIN_POST_UNBIND_FN:
 119         case SLAPI_PLUGIN_POST_SEARCH_FN:
 120         case SLAPI_PLUGIN_POST_COMPARE_FN:
 121         case SLAPI_PLUGIN_POST_MODIFY_FN:
 122         case SLAPI_PLUGIN_POST_MODRDN_FN:
 123         case SLAPI_PLUGIN_POST_ADD_FN:
 124         case SLAPI_PLUGIN_POST_DELETE_FN:
 125         case SLAPI_PLUGIN_POST_ABANDON_FN:
 126         case SLAPI_PLUGIN_POST_ENTRY_FN:
 127         case SLAPI_PLUGIN_POST_REFERRAL_FN:
 128         case SLAPI_PLUGIN_POST_RESULT_FN:
 129         case SLAPI_PLUGIN_MR_FILTER_CREATE_FN:
 130         case SLAPI_PLUGIN_MR_INDEXER_CREATE_FN:
 131         case SLAPI_PLUGIN_MR_FILTER_MATCH_FN:
 132         case SLAPI_PLUGIN_MR_FILTER_INDEX_FN:
 133         case SLAPI_PLUGIN_MR_FILTER_RESET_FN:
 134         case SLAPI_PLUGIN_MR_INDEX_FN:
 135         case SLAPI_PLUGIN_MR_OID:
 136         case SLAPI_PLUGIN_MR_TYPE:
 137         case SLAPI_PLUGIN_MR_VALUE:
 138         case SLAPI_PLUGIN_MR_VALUES:
 139         case SLAPI_PLUGIN_MR_KEYS:
 140         case SLAPI_PLUGIN_MR_FILTER_REUSABLE:
 141         case SLAPI_PLUGIN_MR_QUERY_OPERATOR:
 142         case SLAPI_PLUGIN_MR_USAGE:
 143         case SLAPI_OP_LESS:
 144         case SLAPI_OP_LESS_OR_EQUAL:
 145         case SLAPI_PLUGIN_MR_USAGE_INDEX:
 146         case SLAPI_PLUGIN_SYNTAX_FILTER_AVA:
 147         case SLAPI_PLUGIN_SYNTAX_FILTER_SUB:
 148         case SLAPI_PLUGIN_SYNTAX_VALUES2KEYS:
 149         case SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_AVA:
 150         case SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_SUB:
 151         case SLAPI_PLUGIN_SYNTAX_NAMES:
 152         case SLAPI_PLUGIN_SYNTAX_OID:
 153         case SLAPI_PLUGIN_SYNTAX_FLAGS:
 154         case SLAPI_PLUGIN_SYNTAX_COMPARE:
 155         case SLAPI_MANAGEDSAIT:
 156         case SLAPI_CONFIG_FILENAME:
 157         case SLAPI_CONFIG_LINENO:
 158         case SLAPI_CONFIG_ARGC:
 159         case SLAPI_CONFIG_ARGV:
 160         case SLAPI_TARGET_DN:
 161         case SLAPI_REQCONTROLS:
 162         case SLAPI_ENTRY_PRE_OP:
 163         case SLAPI_ENTRY_POST_OP:
 164         case SLAPI_RESCONTROLS:
 165         case SLAPI_ADD_RESCONTROL:
 166         case SLAPI_ADD_ENTRY:
 167         case SLAPI_BIND_METHOD:
 168         case SLAPI_BIND_CREDENTIALS:
 169         case SLAPI_BIND_SASLMECHANISM:
 170         case SLAPI_BIND_RET_SASLCREDS:
 171         case SLAPI_COMPARE_TYPE:
 172         case SLAPI_COMPARE_VALUE:
 173         case SLAPI_MODIFY_MODS:
 174         case SLAPI_MODRDN_NEWRDN:
 175         case SLAPI_MODRDN_DELOLDRDN:
 176         case SLAPI_MODRDN_NEWSUPERIOR:
 177         case SLAPI_SEARCH_SCOPE:
 178         case SLAPI_SEARCH_DEREF:
 179         case SLAPI_SEARCH_SIZELIMIT:
 180         case SLAPI_SEARCH_TIMELIMIT:
 181         case SLAPI_SEARCH_FILTER:
 182         case SLAPI_SEARCH_STRFILTER:
 183         case SLAPI_SEARCH_ATTRS:
 184         case SLAPI_SEARCH_ATTRSONLY:
 185         case SLAPI_ABANDON_MSGID:
 186         case SLAPI_SEQ_TYPE:
 187         case SLAPI_SEQ_ATTRNAME:
 188         case SLAPI_SEQ_VAL:
 189         case SLAPI_EXT_OP_REQ_OID:
 190         case SLAPI_EXT_OP_REQ_VALUE:
 191         case SLAPI_EXT_OP_RET_OID:
 192         case SLAPI_EXT_OP_RET_VALUE:
 193         case SLAPI_MR_FILTER_ENTRY:
 194         case SLAPI_MR_FILTER_TYPE:
 195         case SLAPI_MR_FILTER_VALUE:
 196         case SLAPI_MR_FILTER_OID:
 197         case SLAPI_MR_FILTER_DNATTRS:
 198         case SLAPI_LDIF2DB_FILE:
 199         case SLAPI_LDIF2DB_REMOVEDUPVALS:
 200         case SLAPI_DB2LDIF_PRINTKEY:
 201         case SLAPI_PARENT_TXN:
 202         case SLAPI_TXN:
 203         case SLAPI_SEARCH_RESULT_SET:
 204         case SLAPI_SEARCH_RESULT_ENTRY:
 205         case SLAPI_NENTRIES:
 206         case SLAPI_SEARCH_REFERRALS:
 207         case SLAPI_CHANGENUMBER:
 208         case SLAPI_LOG_OPERATION:
 209         case SLAPI_DBSIZE:
 210         case SLAPI_RESULT_CODE:
 211         case SLAPI_RESULT_TEXT:
 212         case SLAPI_RESULT_MATCHED:
 213         case SLAPI_PLUGIN_COMPUTE_EVALUATOR_FN:
 214         case SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN:
 215         case SLAPI_PLUGIN_ACL_ALLOW_ACCESS:
 216         case SLAPI_X_PLUGIN_PRE_GROUP_FN:
 217         case SLAPI_X_PLUGIN_POST_GROUP_FN:
 218         case SLAPI_X_GROUP_ENTRY:
 219         case SLAPI_X_GROUP_ATTRIBUTE:
 220         case SLAPI_X_GROUP_OPERATION_DN:
 221                 return LDAP_SUCCESS;
 222         default:
 223                 return INVALID_PARAM;
 224         }
 225 }
 226
 227 static int
 228 isValidParam( Slapi_PBlock *pb, int param )
 229 {
 230         if ( pb->ckParams == TRUE ) {
 231                 if ( IBM_RESERVED( param ) ) return LDAP_SUCCESS;
 232                 if (param == SLAPI_PLUGIN_AUDIT_FN ||
 233                                 param == SLAPI_PLUGIN_AUDIT_DATA )
 234                         return LDAP_SUCCESS;
 235                 if ( param < LAST_IBM_PARAM ) {
 236                         return INVALID_PARAM;
 237                 } else if ( NETSCAPE_RESERVED( param ) ) {
 238                         return INVALID_PARAM;
 239                 } else {
 240                         return isOkNetscapeParam(param);
 241                 }
 242         } else {
 243                 return LDAP_SUCCESS;
 244         }
 245 }
 246
 247 static void
 248 Lock( Slapi_PBlock *pb )
 249 {
 250         ldap_pvt_thread_mutex_lock(&pb->pblockMutex);
 251 }
 252
 253 static void
 254 unLock( Slapi_PBlock *pb )
 255 {
 256         ldap_pvt_thread_mutex_unlock(&pb->pblockMutex);
 257 }
 258
 259 static int
 260 get( Slapi_PBlock *pb, int param, void **val )
 261 {
 262         int i;
 263
 264         if ( isValidParam( pb, param ) == INVALID_PARAM ) {
 265                 return PBLOCK_ERROR;
 266         }
 267
 268         Lock( pb );
 269
 270         *val = NULL;
 271         for ( i = 0; i < pb->numParams; i++ ) {
 272                 if ( pb->curParams[i] == param ) {
 273                         *val = pb->curVals[i];
 274                         break;
 275                 }
 276         }
 277         unLock( pb );
 278         return LDAP_SUCCESS;
 279 }
 280
 281 static int
 282 set( Slapi_PBlock *pb, int param, void *val )
 283 {
 284 #if defined(LDAP_SLAPI)
 285         int i, freeit;
 286         int addcon = 0;
 287
 288         if ( isValidParam( pb, param ) == INVALID_PARAM ) {
 289                 return PBLOCK_ERROR;
 290         }
 291
 292         Lock( pb );
 293
 294         if ( pb->numParams == PBLOCK_MAX_PARAMS ) {
 295                 unLock( pb );
 296                 return PBLOCK_ERROR;
 297         }
 298
 299         if ( param == SLAPI_ADD_RESCONTROL ) {
 300                 addcon = 1;
 301                 param = SLAPI_RES_CONTROLS;
 302         }
 303
 304         switch ( param ) {
 305         case SLAPI_CONN_DN:
 306         case SLAPI_CONN_AUTHMETHOD:
 307         case SLAPI_IBM_CONN_DN_ALT:
 308         case SLAPI_IBM_CONN_DN_ORIG:
 309         case SLAPI_RESULT_TEXT:
 310         case SLAPI_RESULT_MATCHED:
 311                 freeit = 1; break;
 312         default:
 313                 freeit = 0; break;
 314         }
 315         for( i = 0; i < pb->numParams; i++ ) {
 316                 if ( pb->curParams[i] == param ) {
 317                         break;
 318                 }
 319         }
 320
 321         if ( i >= pb->numParams ) {
 322                 pb->curParams[i] = param;
 323                 pb->numParams++;
 324         }
 325         if ( addcon ) {
 326                 LDAPControl **ctrls = pb->curVals[i];
 327                 int j;
 328
 329                 if ( ctrls ) {
 330                         for (j=0; ctrls[j]; j++);
 331                         ctrls = ch_realloc( ctrls, (j+2)*sizeof(LDAPControl *) );
 332                 } else {
 333                         ctrls = ch_malloc( 2 * sizeof(LDAPControl *) );
 334                         j = 0;
 335                 }
 336                 ctrls[j] = val;
 337                 ctrls[j+1] = NULL;
 338                 pb->curVals[i] = ctrls;
 339         } else {
 340                 if ( freeit ) ch_free( pb->curVals[i] );
 341                 pb->curVals[i] = val;
 342         }
 343
 344         unLock( pb );
 345         return LDAP_SUCCESS;
 346 #endif /* LDAP_SLAPI */
 347         return PBLOCK_ERROR;
 348 }
 349
 350 static void
 351 clearPB( Slapi_PBlock *pb )
 352 {
 353         pb->numParams = 1;
 354 }
 355
 356 static void
 357 checkParams( Slapi_PBlock *pb, int flag )
 358 {
 359         pb->ckParams = flag;
 360 }
 361
 362 static int
 363 deleteParam( Slapi_PBlock *p, int param )
 364 {
 365         int i;
 366
 367         Lock(p);
 368         for ( i = 0; i < p->numParams; i++ ) {
 369                 if ( p->curParams[i] == param ) {
 370                         break;
 371                 }
 372         }
 373
 374         if (i >= p->numParams ) {
 375                 unLock( p );
 376                 return PBLOCK_ERROR;
 377         }
 378         if ( p->numParams > 1 ) {
 379                 p->curParams[i] = p->curParams[p->numParams];
 380                 p->curVals[i] = p->curVals[p->numParams];
 381         }
 382         p->numParams--;
 383         unLock( p );
 384         return LDAP_SUCCESS;
 385 }
 386
 387 Slapi_PBlock *
 388 slapi_pblock_new()
 389 {
 390 #if defined(LDAP_SLAPI)
 391         Slapi_PBlock *pb;
 392
 393         pb = (Slapi_PBlock *) ch_malloc(sizeof(Slapi_PBlock));
 394         if ( pb != NULL ) {
 395                 pb->ckParams = TRUE;
 396                 ldap_pvt_thread_mutex_init( &pb->pblockMutex );
 397                 memset( pb->curParams, 0, sizeof(pb->curParams) );
 398                 memset( pb->curVals, 0, sizeof(pb->curVals) );
 399                 pb->curParams[0] = SLAPI_IBM_PBLOCK;
 400                 pb->curVals[0] = NULL;
 401                 pb->numParams = 1;
 402         }
 403         return pb;
 404 #endif /* LDAP_SLAPI */
 405         return NULL;
 406 }
 407
 408 void
 409 slapi_pblock_destroy( Slapi_PBlock* pb )
 410 {
 411 #if defined(LDAP_SLAPI)
 412         char *str = NULL;
 413         LDAPControl **rescontrols = NULL;
 414
 415         get( pb, SLAPI_CONN_DN,(void **)&str );
 416         if ( str != NULL ) {
 417                 ch_free( str );
 418                 str = NULL;
 419         }
 420
 421         get( pb, SLAPI_CONN_AUTHMETHOD, (void **)&str );
 422         if ( str != NULL ) {
 423                 ch_free( str );
 424                 str = NULL;
 425         }
 426
 427         get( pb, SLAPI_IBM_CONN_DN_ALT, (void **)&str );
 428         if ( str != NULL ) {
 429                 ch_free( str );
 430                 str = NULL;
 431         }
 432
 433         get( pb, SLAPI_IBM_CONN_DN_ORIG, (void **)&str );
 434         if ( str != NULL ) {
 435                 ch_free( str );
 436         }
 437
 438         get( pb, SLAPI_RESULT_TEXT, (void **)&str );
 439         if ( str != NULL ) {
 440                 ch_free( str );
 441                 str = NULL;
 442         }
 443
 444         get( pb, SLAPI_RESULT_MATCHED, (void **)&str );
 445         if ( str != NULL ) {
 446                 ch_free( str );
 447                 str = NULL;
 448         }
 449
 450         get( pb, SLAPI_RESCONTROLS, (void **)&rescontrols );
 451         if ( rescontrols != NULL ) {
 452                 ldap_controls_free( rescontrols );
 453                 rescontrols = NULL;
 454         }
 455
 456         ldap_pvt_thread_mutex_destroy( &pb->pblockMutex );
 457
 458         ch_free( pb );
 459 #endif /* LDAP_SLAPI */
 460 }
 461
 462 int
 463 slapi_pblock_get( Slapi_PBlock *pb, int arg, void *value )
 464 {
 465 #if defined(LDAP_SLAPI)
 466         return get( pb, arg, (void **)value );
 467 #endif /* LDAP_SLAPI */
 468         return PBLOCK_ERROR;
 469 }
 470
 471 int
 472 slapi_pblock_set( Slapi_PBlock *pb, int arg, void *value )
 473 {
 474 #if defined(LDAP_SLAPI)
 475         void *pTmp = NULL;
 476
 477         switch ( arg ) {
 478         case SLAPI_CONN_DN:
 479         case SLAPI_CONN_AUTHMETHOD:
 480         case SLAPI_IBM_CONN_DN_ALT:
 481         case SLAPI_IBM_CONN_DN_ORIG:
 482         case SLAPI_RESULT_TEXT:
 483         case SLAPI_RESULT_MATCHED:
 484                 if ( value != NULL ) {
 485                         pTmp = (void *)slapi_ch_strdup((char *)value);
 486                         if ( pTmp == NULL ) {
 487                                 return LDAP_NO_MEMORY;
 488                         }
 489                 }
 490                 break;
 491         default:
 492                 pTmp = value;
 493                 break;
 494         }
 495         return set( pb, arg, pTmp );
 496 #endif /* LDAP_SLAPI */
 497         return LDAP_NO_MEMORY;
 498 }
 499
 500 void
 501 slapi_pblock_clear( Slapi_PBlock *pb )
 502 {
 503 #if defined(LDAP_SLAPI)
 504    clearPB( pb );
 505 #endif /* LDAP_SLAPI */
 506 }
 507
 508 int
 509 slapi_pblock_delete_param( Slapi_PBlock *p, int param )
 510 {
 511 #if defined(LDAP_SLAPI)
 512         return deleteParam( p, param );
 513 #endif /* LDAP_SLAPI */
 514         return PBLOCK_ERROR;
 515 }
 516
 517 void
 518 slapi_pblock_check_params( Slapi_PBlock *pb, int flag )
 519 {
 520 #if defined(LDAP_SLAPI)
 521         checkParams( pb, flag );
 522 #endif /* LDAP_SLAPI */
 523 }
 524
 525 /*
 526  * OpenLDAP extension
 527  */
 528 int
 529 slapi_int_pblock_get_first( Backend *be, Slapi_PBlock **pb )
 530 {
 531 #if defined(LDAP_SLAPI)
 532         assert( pb );
 533         *pb = (Slapi_PBlock *)be->be_pb;
 534         return (*pb == NULL ? LDAP_OTHER : LDAP_SUCCESS);
 535 #else /* LDAP_SLAPI */
 536         return LDAP_OTHER;
 537 #endif /* LDAP_SLAPI */
 538 }
 539
 540 /*
 541  * OpenLDAP extension
 542  */
 543 int
 544 slapi_int_pblock_get_next( Slapi_PBlock **pb )
 545 {
 546 #if defined(LDAP_SLAPI)
 547         assert( pb );
 548         return slapi_pblock_get( *pb, SLAPI_IBM_PBLOCK, pb );
 549 #else /* LDAP_SLAPI */
 550         return LDAP_OTHER;
 551 #endif /* LDAP_SLAPI */
 552 }
 553