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-2005 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         case SLAPI_X_GROUP_TARGET_ENTRY:
 222                 return LDAP_SUCCESS;
 223         default:
 224                 return INVALID_PARAM;
 225         }
 226 }
 227
 228 static int
 229 isValidParam( Slapi_PBlock *pb, int param )
 230 {
 231         if ( !pb ) {
 232                 return INVALID_PARAM;
 233         }
 234
 235         if ( pb->ckParams == TRUE ) {
 236                 if ( IBM_RESERVED( param ) ) return LDAP_SUCCESS;
 237                 if (param == SLAPI_PLUGIN_AUDIT_FN ||
 238                                 param == SLAPI_PLUGIN_AUDIT_DATA )
 239                         return LDAP_SUCCESS;
 240                 if ( param < LAST_IBM_PARAM ) {
 241                         return INVALID_PARAM;
 242                 } else if ( NETSCAPE_RESERVED( param ) ) {
 243                         return INVALID_PARAM;
 244                 } else {
 245                         return isOkNetscapeParam(param);
 246                 }
 247         } else {
 248                 return LDAP_SUCCESS;
 249         }
 250 }
 251
 252 static void
 253 Lock( Slapi_PBlock *pb )
 254 {
 255         ldap_pvt_thread_mutex_lock(&pb->pblockMutex);
 256 }
 257
 258 static void
 259 unLock( Slapi_PBlock *pb )
 260 {
 261         ldap_pvt_thread_mutex_unlock(&pb->pblockMutex);
 262 }
 263
 264 static int
 265 get( Slapi_PBlock *pb, int param, void **val )
 266 {
 267         int i;
 268
 269         if ( isValidParam( pb, param ) == INVALID_PARAM ) {
 270                 return PBLOCK_ERROR;
 271         }
 272
 273         Lock( pb );
 274
 275         *val = NULL;
 276         for ( i = 0; i < pb->numParams; i++ ) {
 277                 if ( pb->curParams[i] == param ) {
 278                         *val = pb->curVals[i];
 279                         break;
 280                 }
 281         }
 282         unLock( pb );
 283         return LDAP_SUCCESS;
 284 }
 285
 286 static int
 287 set( Slapi_PBlock *pb, int param, void *val )
 288 {
 289 #if defined(LDAP_SLAPI)
 290         int i, freeit;
 291         int addcon = 0;
 292
 293         if ( isValidParam( pb, param ) == INVALID_PARAM ) {
 294                 return PBLOCK_ERROR;
 295         }
 296
 297         Lock( pb );
 298
 299         if ( pb->numParams == PBLOCK_MAX_PARAMS ) {
 300                 unLock( pb );
 301                 return PBLOCK_ERROR;
 302         }
 303
 304         if ( param == SLAPI_ADD_RESCONTROL ) {
 305                 addcon = 1;
 306                 param = SLAPI_RES_CONTROLS;
 307         }
 308
 309         switch ( param ) {
 310         case SLAPI_CONN_DN:
 311         case SLAPI_CONN_AUTHMETHOD:
 312         case SLAPI_IBM_CONN_DN_ALT:
 313         case SLAPI_IBM_CONN_DN_ORIG:
 314         case SLAPI_RESULT_TEXT:
 315         case SLAPI_RESULT_MATCHED:
 316                 freeit = 1; break;
 317         default:
 318                 freeit = 0; break;
 319         }
 320         for( i = 0; i < pb->numParams; i++ ) {
 321                 if ( pb->curParams[i] == param ) {
 322                         break;
 323                 }
 324         }
 325
 326         if ( i >= pb->numParams ) {
 327                 pb->curParams[i] = param;
 328                 pb->numParams++;
 329         }
 330         if ( addcon ) {
 331                 LDAPControl **ctrls = pb->curVals[i];
 332                 int j;
 333
 334                 if ( ctrls ) {
 335                         for (j=0; ctrls[j]; j++);
 336                         ctrls = ch_realloc( ctrls, (j+2)*sizeof(LDAPControl *) );
 337                 } else {
 338                         ctrls = ch_malloc( 2 * sizeof(LDAPControl *) );
 339                         j = 0;
 340                 }
 341                 ctrls[j] = val;
 342                 ctrls[j+1] = NULL;
 343                 pb->curVals[i] = ctrls;
 344         } else {
 345                 if ( freeit ) ch_free( pb->curVals[i] );
 346                 pb->curVals[i] = val;
 347         }
 348
 349         unLock( pb );
 350         return LDAP_SUCCESS;
 351 #endif /* LDAP_SLAPI */
 352         return PBLOCK_ERROR;
 353 }
 354
 355 static void
 356 clearPB( Slapi_PBlock *pb )
 357 {
 358         pb->numParams = 1;
 359 }
 360
 361 static void
 362 checkParams( Slapi_PBlock *pb, int flag )
 363 {
 364         pb->ckParams = flag;
 365 }
 366
 367 static int
 368 deleteParam( Slapi_PBlock *p, int param )
 369 {
 370         int i;
 371
 372         Lock(p);
 373         for ( i = 0; i < p->numParams; i++ ) {
 374                 if ( p->curParams[i] == param ) {
 375                         break;
 376                 }
 377         }
 378
 379         if (i >= p->numParams ) {
 380                 unLock( p );
 381                 return PBLOCK_ERROR;
 382         }
 383         if ( p->numParams > 1 ) {
 384                 p->curParams[i] = p->curParams[p->numParams];
 385                 p->curVals[i] = p->curVals[p->numParams];
 386         }
 387         p->numParams--;
 388         unLock( p );
 389         return LDAP_SUCCESS;
 390 }
 391
 392 Slapi_PBlock *
 393 slapi_pblock_new()
 394 {
 395 #if defined(LDAP_SLAPI)
 396         Slapi_PBlock *pb;
 397
 398         pb = (Slapi_PBlock *) ch_malloc(sizeof(Slapi_PBlock));
 399         if ( pb != NULL ) {
 400                 pb->ckParams = TRUE;
 401                 ldap_pvt_thread_mutex_init( &pb->pblockMutex );
 402                 memset( pb->curParams, 0, sizeof(pb->curParams) );
 403                 memset( pb->curVals, 0, sizeof(pb->curVals) );
 404                 pb->curParams[0] = SLAPI_IBM_PBLOCK;
 405                 pb->curVals[0] = NULL;
 406                 pb->numParams = 1;
 407         }
 408         return pb;
 409 #endif /* LDAP_SLAPI */
 410         return NULL;
 411 }
 412
 413 void
 414 slapi_pblock_destroy( Slapi_PBlock* pb )
 415 {
 416 #if defined(LDAP_SLAPI)
 417         char *str = NULL;
 418         LDAPControl **rescontrols = NULL;
 419
 420         get( pb, SLAPI_CONN_DN,(void **)&str );
 421         if ( str != NULL ) {
 422                 ch_free( str );
 423                 str = NULL;
 424         }
 425
 426         get( pb, SLAPI_CONN_AUTHMETHOD, (void **)&str );
 427         if ( str != NULL ) {
 428                 ch_free( str );
 429                 str = NULL;
 430         }
 431
 432         get( pb, SLAPI_IBM_CONN_DN_ALT, (void **)&str );
 433         if ( str != NULL ) {
 434                 ch_free( str );
 435                 str = NULL;
 436         }
 437
 438         get( pb, SLAPI_IBM_CONN_DN_ORIG, (void **)&str );
 439         if ( str != NULL ) {
 440                 ch_free( str );
 441         }
 442
 443         get( pb, SLAPI_RESULT_TEXT, (void **)&str );
 444         if ( str != NULL ) {
 445                 ch_free( str );
 446                 str = NULL;
 447         }
 448
 449         get( pb, SLAPI_RESULT_MATCHED, (void **)&str );
 450         if ( str != NULL ) {
 451                 ch_free( str );
 452                 str = NULL;
 453         }
 454
 455         get( pb, SLAPI_RESCONTROLS, (void **)&rescontrols );
 456         if ( rescontrols != NULL ) {
 457                 ldap_controls_free( rescontrols );
 458                 rescontrols = NULL;
 459         }
 460
 461         ldap_pvt_thread_mutex_destroy( &pb->pblockMutex );
 462
 463         ch_free( pb );
 464 #endif /* LDAP_SLAPI */
 465 }
 466
 467 int
 468 slapi_pblock_get( Slapi_PBlock *pb, int arg, void *value )
 469 {
 470 #if defined(LDAP_SLAPI)
 471         return get( pb, arg, (void **)value );
 472 #endif /* LDAP_SLAPI */
 473         return PBLOCK_ERROR;
 474 }
 475
 476 int
 477 slapi_pblock_set( Slapi_PBlock *pb, int arg, void *value )
 478 {
 479 #if defined(LDAP_SLAPI)
 480         void *pTmp = NULL;
 481
 482         switch ( arg ) {
 483         case SLAPI_CONN_DN:
 484         case SLAPI_CONN_AUTHMETHOD:
 485         case SLAPI_IBM_CONN_DN_ALT:
 486         case SLAPI_IBM_CONN_DN_ORIG:
 487         case SLAPI_RESULT_TEXT:
 488         case SLAPI_RESULT_MATCHED:
 489                 if ( value != NULL ) {
 490                         pTmp = (void *)slapi_ch_strdup((char *)value);
 491                         if ( pTmp == NULL ) {
 492                                 return LDAP_NO_MEMORY;
 493                         }
 494                 }
 495                 break;
 496         default:
 497                 pTmp = value;
 498                 break;
 499         }
 500         return set( pb, arg, pTmp );
 501 #endif /* LDAP_SLAPI */
 502         return LDAP_NO_MEMORY;
 503 }
 504
 505 void
 506 slapi_pblock_clear( Slapi_PBlock *pb )
 507 {
 508 #if defined(LDAP_SLAPI)
 509    clearPB( pb );
 510 #endif /* LDAP_SLAPI */
 511 }
 512
 513 int
 514 slapi_pblock_delete_param( Slapi_PBlock *p, int param )
 515 {
 516 #if defined(LDAP_SLAPI)
 517         return deleteParam( p, param );
 518 #endif /* LDAP_SLAPI */
 519         return PBLOCK_ERROR;
 520 }
 521
 522 void
 523 slapi_pblock_check_params( Slapi_PBlock *pb, int flag )
 524 {
 525 #if defined(LDAP_SLAPI)
 526         checkParams( pb, flag );
 527 #endif /* LDAP_SLAPI */
 528 }
 529
 530 /*
 531  * OpenLDAP extension
 532  */
 533 int
 534 slapi_int_pblock_get_first( Backend *be, Slapi_PBlock **pb )
 535 {
 536 #if defined(LDAP_SLAPI)
 537         assert( pb );
 538         *pb = (Slapi_PBlock *)be->be_pb;
 539         return (*pb == NULL ? LDAP_OTHER : LDAP_SUCCESS);
 540 #else /* LDAP_SLAPI */
 541         return LDAP_OTHER;
 542 #endif /* LDAP_SLAPI */
 543 }
 544
 545 /*
 546  * OpenLDAP extension
 547  */
 548 int
 549 slapi_int_pblock_get_next( Slapi_PBlock **pb )
 550 {
 551 #if defined(LDAP_SLAPI)
 552         assert( pb );
 553         return slapi_pblock_get( *pb, SLAPI_IBM_PBLOCK, pb );
 554 #else /* LDAP_SLAPI */
 555         return LDAP_OTHER;
 556 #endif /* LDAP_SLAPI */
 557 }
 558