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

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