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