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