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

   1 /* backend.c - routines for dealing with back-end databases */
   2
   3
   4 #include "portable.h"
   5
   6 #include <stdio.h>
   7
   8 #include <ac/string.h>
   9 #include <ac/socket.h>
  10
  11 #include <sys/stat.h>
  12
  13 #include "slap.h"
  14 #include "lutil.h"
  15
  16 #ifdef SLAPD_LDAP
  17 #include "back-ldap/external.h"
  18 #endif
  19 #ifdef SLAPD_LDBM
  20 #include "back-ldbm/external.h"
  21 #endif
  22 #ifdef SLAPD_BDB2
  23 #include "back-bdb2/external.h"
  24 #endif
  25 #ifdef SLAPD_PASSWD
  26 #include "back-passwd/external.h"
  27 #endif
  28 #ifdef SLAPD_PERL
  29 #include "back-perl/external.h"
  30 #endif
  31 #ifdef SLAPD_SHELL
  32 #include "back-shell/external.h"
  33 #endif
  34 #ifdef SLAPD_TCL
  35 #include "back-tcl/external.h"
  36 #endif
  37
  38 static BackendInfo binfo[] = {
  39 #if defined(SLAPD_LDAP) && !defined(SLAPD_LDAP_DYNAMIC)
  40         {"ldap",        ldap_back_initialize},
  41 #endif
  42 #if defined(SLAPD_LDBM) && !defined(SLAPD_LDBM_DYNAMIC)
  43         {"ldbm",        ldbm_back_initialize},
  44 #endif
  45 #if defined(SLAPD_BDB2) && !defined(SLAPD_BDB2_DYNAMIC)
  46         {"bdb2",        bdb2_back_initialize},
  47 #endif
  48 #if defined(SLAPD_PASSWD) && !defined(SLAPD_PASSWD_DYNAMIC)
  49         {"passwd",      passwd_back_initialize},
  50 #endif
  51 #if defined(SLAPD_PERL) && !defined(SLAPD_PERL_DYNAMIC)
  52         {"perl",        perl_back_initialize},
  53 #endif
  54 #if defined(SLAPD_SHELL) && !defined(SLAPD_SHELL_DYNAMIC)
  55         {"shell",       shell_back_initialize},
  56 #endif
  57 #if defined(SLAPD_TCL) && !defined(SLAPD_LDAP_TCL)
  58         {"tcl",         tcl_back_initialize},
  59 #endif
  60         {NULL}
  61 };
  62
  63 int                     nBackendInfo = 0;
  64 BackendInfo     *backendInfo = NULL;
  65
  66 int                     nBackendDB = 0;
  67 BackendDB       *backendDB = NULL;
  68
  69 int backend_init(void)
  70 {
  71         int rc = -1;
  72
  73         if((nBackendInfo != 0) || (backendInfo != NULL)) {
  74                 /* already initialized */
  75                 Debug( LDAP_DEBUG_ANY,
  76                         "backend_init: already initialized.\n", 0, 0, 0 );
  77                 return -1;
  78         }
  79
  80         for( ;
  81                 binfo[nBackendInfo].bi_type !=  NULL;
  82                 nBackendInfo++ )
  83         {
  84                 rc = binfo[nBackendInfo].bi_init(
  85                         &binfo[nBackendInfo] );
  86
  87                 if(rc != 0) {
  88                         Debug( LDAP_DEBUG_ANY,
  89                                 "backend_init: initialized for type \"%s\"\n",
  90                                         binfo[nBackendInfo].bi_type, 0, 0 );
  91
  92                         /* destroy those we've already inited */
  93                         for( nBackendInfo--;
  94                                 nBackendInfo >= 0 ;
  95                                 nBackendInfo-- )
  96                         {
  97                                 if ( binfo[nBackendInfo].bi_destroy ) {
  98                                         binfo[nBackendInfo].bi_destroy(
  99                                                 &binfo[nBackendInfo] );
 100                                 }
 101                         }
 102                         return rc;
 103                 }
 104         }
 105
 106         if ( nBackendInfo > 0) {
 107                 backendInfo = binfo;
 108                 return 0;
 109         }
 110
 111 #ifdef SLAPD_MODULES
 112         return 0;
 113 #else
 114         Debug( LDAP_DEBUG_ANY,
 115                 "backend_init: failed\n",
 116                 0, 0, 0 );
 117
 118         return rc;
 119 #endif /* SLAPD_MODULES */
 120 }
 121
 122 int backend_add(BackendInfo *aBackendInfo)
 123 {
 124    int rc = 0;
 125
 126    if ((rc = aBackendInfo->bi_init(aBackendInfo)) != 0) {
 127       Debug( LDAP_DEBUG_ANY,
 128              "backend_add: initialization for type \"%s\" failed\n",
 129              aBackendInfo->bi_type, 0, 0 );
 130       return rc;
 131    }
 132
 133    /* now add the backend type to the Backend Info List */
 134    {
 135       BackendInfo *newBackendInfo = 0;
 136
 137       /* if backendInfo == binfo no deallocation of old backendInfo */
 138       if (backendInfo == binfo) {
 139          newBackendInfo = ch_calloc(nBackendInfo + 1, sizeof(BackendInfo));
 140          memcpy(newBackendInfo, backendInfo, sizeof(BackendInfo) *
 141                 nBackendInfo);
 142       } else {
 143          newBackendInfo = ch_realloc(backendInfo, sizeof(BackendInfo) *
 144                                      (nBackendInfo + 1));
 145       }
 146       memcpy(&newBackendInfo[nBackendInfo], aBackendInfo,
 147              sizeof(BackendInfo));
 148       backendInfo = newBackendInfo;
 149       nBackendInfo++;
 150
 151       return 0;
 152    }
 153 }
 154
 155 int backend_startup(int n)
 156 {
 157         int i;
 158         int rc = 0;
 159
 160         if( ! ( nBackendDB > 0 ) ) {
 161                 /* no databases */
 162                 Debug( LDAP_DEBUG_ANY,
 163                         "backend_startup: %d databases to startup.\n",
 164                         nBackendDB, 0, 0 );
 165                 return 1;
 166         }
 167
 168         if(n >= 0) {
 169                 /* startup a specific backend database */
 170                 Debug( LDAP_DEBUG_TRACE,
 171                         "backend_startup: starting database %d\n",
 172                         n, 0, 0 );
 173
 174                 /* make sure, n does not exceed the number of backend databases */
 175                 if ( n >= nbackends ) {
 176
 177                         Debug( LDAP_DEBUG_ANY,
 178                                 "backend_startup: database number %d exceeding maximum (%d)\n",
 179                                 n, nbackends, 0 );
 180                         return 1;
 181                 }
 182
 183                 if ( backendDB[n].bd_info->bi_open ) {
 184                         rc = backendDB[n].bd_info->bi_open(
 185                                 backendDB[n].bd_info );
 186                 }
 187
 188                 if(rc != 0) {
 189                         Debug( LDAP_DEBUG_ANY,
 190                                 "backend_startup: bi_open failed!\n",
 191                                 0, 0, 0 );
 192                         return rc;
 193                 }
 194
 195                 if ( backendDB[n].bd_info->bi_db_open ) {
 196                         rc = backendDB[n].bd_info->bi_db_open(
 197                                 &backendDB[n] );
 198                 }
 199
 200                 if(rc != 0) {
 201                         Debug( LDAP_DEBUG_ANY,
 202                                 "backend_startup: bi_db_open failed!\n",
 203                                 0, 0, 0 );
 204                         return rc;
 205                 }
 206
 207                 return rc;
 208         }
 209
 210         /* open each backend type */
 211         for( i = 0; i < nBackendInfo; i++ ) {
 212                 if( backendInfo[i].bi_nDB == 0) {
 213                         /* no database of this type, don't open */
 214                         continue;
 215                 }
 216
 217                 if( backendInfo[i].bi_open ) {
 218                         rc = backendInfo[i].bi_open(
 219                                 &backendInfo[i] );
 220                 }
 221
 222                 if(rc != 0) {
 223                         Debug( LDAP_DEBUG_ANY,
 224                                 "backend_startup: bi_open %d failed!\n",
 225                                 i, 0, 0 );
 226                         return rc;
 227                 }
 228         }
 229
 230         /* open each backend database */
 231         for( i = 0; i < nBackendDB; i++ ) {
 232                 if ( backendDB[i].bd_info->bi_db_open ) {
 233                         rc = backendDB[i].bd_info->bi_db_open(
 234                                 &backendDB[i] );
 235                 }
 236
 237                 if(rc != 0) {
 238                         Debug( LDAP_DEBUG_ANY,
 239                                 "backend_startup: bi_db_open %d failed!\n",
 240                                 i, 0, 0 );
 241                         return rc;
 242                 }
 243         }
 244
 245         return rc;
 246 }
 247
 248 int backend_shutdown(int n)
 249 {
 250         int i;
 251         int rc = 0;
 252
 253         if(n >= 0) {
 254                 /* shutdown a specific backend database */
 255
 256                 /* make sure, n does not exceed the number of backend databases */
 257                 if ( n >= nbackends ) {
 258
 259                         Debug( LDAP_DEBUG_ANY,
 260                                 "backend_startup: database number %d exceeding maximum (%d)\n",
 261                                 n, nbackends, 0 );
 262                         return 1;
 263                 }
 264
 265                 if ( backendDB[n].bd_info->bi_nDB == 0 ) {
 266                         /* no database of this type, we never opened it */
 267                         return 0;
 268                 }
 269
 270                 if ( backendDB[n].bd_info->bi_db_close ) {
 271                         backendDB[n].bd_info->bi_db_close(
 272                                 &backendDB[n] );
 273                 }
 274
 275                 if( backendDB[n].bd_info->bi_close ) {
 276                         backendDB[n].bd_info->bi_close(
 277                                 backendDB[n].bd_info );
 278                 }
 279
 280                 return 0;
 281         }
 282
 283         /* close each backend database */
 284         for( i = 0; i < nBackendDB; i++ ) {
 285                 BackendInfo  *bi;
 286
 287                 if ( backendDB[i].bd_info->bi_db_close ) {
 288                         backendDB[i].bd_info->bi_db_close(
 289                                 &backendDB[i] );
 290                 }
 291
 292                 if(rc != 0) {
 293                         Debug( LDAP_DEBUG_ANY,
 294                                 "backend_close: bi_close %s failed!\n",
 295                                 bi->bi_type, 0, 0 );
 296                 }
 297         }
 298
 299         /* close each backend type */
 300         for( i = 0; i < nBackendInfo; i++ ) {
 301                 if( backendInfo[i].bi_nDB == 0 ) {
 302                         /* no database of this type */
 303                         continue;
 304                 }
 305
 306                 if( backendInfo[i].bi_close ) {
 307                         backendInfo[i].bi_close(
 308                                 &backendInfo[i] );
 309                 }
 310         }
 311
 312         return 0;
 313 }
 314
 315 int backend_destroy(void)
 316 {
 317         int i;
 318
 319         /* destroy each backend database */
 320         for( i = 0; i < nBackendDB; i++ ) {
 321                 if ( backendDB[i].bd_info->bi_db_destroy ) {
 322                         backendDB[i].bd_info->bi_db_destroy(
 323                                 &backendDB[i] );
 324                 }
 325         }
 326
 327         /* destroy each backend type */
 328         for( i = 0; i < nBackendInfo; i++ ) {
 329                 if( backendInfo[i].bi_destroy ) {
 330                         backendInfo[i].bi_destroy(
 331                                 &backendInfo[i] );
 332                 }
 333         }
 334
 335 #ifdef SLAPD_MODULES
 336         if (backendInfo != binfo) {
 337            free(backendInfo);
 338         }
 339 #endif /* SLAPD_MODULES */
 340
 341         nBackendInfo = 0;
 342         backendInfo = NULL;
 343
 344         return 0;
 345 }
 346
 347 BackendInfo* backend_info(char *type)
 348 {
 349         int i;
 350
 351         /* search for the backend type */
 352         for( i = 0; i < nBackendInfo; i++ ) {
 353                 if( strcasecmp(backendInfo[i].bi_type, type) == 0 ) {
 354                         return &backendInfo[i];
 355                 }
 356         }
 357
 358         return NULL;
 359 }
 360
 361
 362 BackendDB *
 363 backend_db_init(
 364     char        *type
 365 )
 366 {
 367         Backend *be;
 368         BackendInfo *bi = backend_info(type);
 369         int     rc = 0;
 370
 371         if( bi == NULL ) {
 372                 fprintf( stderr, "Unrecognized database type (%s)\n", type );
 373                 return NULL;
 374         }
 375
 376         backendDB = (BackendDB *) ch_realloc(
 377                         (char *) backendDB,
 378                     (nBackendDB + 1) * sizeof(Backend) );
 379
 380         memset( &backendDB[nbackends], '\0', sizeof(Backend) );
 381
 382         be = &backends[nbackends++];
 383
 384         be->bd_info = bi;
 385         be->be_sizelimit = defsize;
 386         be->be_timelimit = deftime;
 387
 388         be->be_realm = global_realm != NULL
 389                 ? ch_strdup( global_realm ) : NULL;
 390
 391         if(bi->bi_db_init) {
 392                 rc = bi->bi_db_init( be );
 393         }
 394
 395         if(rc != 0) {
 396                 fprintf( stderr, "database init failed (%s)\n", type );
 397                 nbackends--;
 398                 return NULL;
 399         }
 400
 401         bi->bi_nDB++;
 402         return( be );
 403 }
 404
 405 void
 406 be_db_close( void )
 407 {
 408         int     i;
 409
 410         for ( i = 0; i < nbackends; i++ ) {
 411                 if ( backends[i].bd_info->bi_db_close ) {
 412                         (*backends[i].bd_info->bi_db_close)( &backends[i] );
 413                 }
 414         }
 415 }
 416
 417 Backend *
 418 select_backend( char * dn )
 419 {
 420         int     i, j, len, dnlen;
 421
 422         dnlen = strlen( dn );
 423         for ( i = 0; i < nbackends; i++ ) {
 424                 for ( j = 0; backends[i].be_nsuffix != NULL &&
 425                     backends[i].be_nsuffix[j] != NULL; j++ )
 426                 {
 427                         len = strlen( backends[i].be_nsuffix[j] );
 428
 429                         if ( len > dnlen ) {
 430                                 continue;
 431                         }
 432
 433                         if ( strcmp( backends[i].be_nsuffix[j],
 434                             dn + (dnlen - len) ) == 0 ) {
 435                                 return( &backends[i] );
 436                         }
 437                 }
 438         }
 439
 440 #ifdef LDAP_ALLOW_NULL_SEARCH_BASE
 441         /* Add greg@greg.rim.or.jp
 442          * It's quick hack for cheap client
 443          * Some browser offer a NULL base at ldap_search
 444          *
 445          * Should only be used as a last resort. -Kdz
 446          */
 447         if(dnlen == 0) {
 448                 Debug( LDAP_DEBUG_TRACE,
 449                         "select_backend: use default backend\n", 0, 0, 0 );
 450                 return( &backends[0] );
 451         }
 452 #endif /* LDAP_ALLOW_NULL_SEARCH_BASE */
 453
 454         return( NULL );
 455 }
 456
 457 int
 458 be_issuffix(
 459     Backend     *be,
 460     char        *suffix
 461 )
 462 {
 463         int     i;
 464
 465         for ( i = 0; be->be_nsuffix != NULL && be->be_nsuffix[i] != NULL; i++ ) {
 466                 if ( strcmp( be->be_nsuffix[i], suffix ) == 0 ) {
 467                         return( 1 );
 468                 }
 469         }
 470
 471         return( 0 );
 472 }
 473
 474 int
 475 be_isroot( Backend *be, char *ndn )
 476 {
 477         int rc;
 478
 479         if ( ndn == NULL || be->be_root_ndn == NULL ) {
 480                 return( 0 );
 481         }
 482
 483         rc = strcmp( be->be_root_ndn, ndn ) ? 0 : 1;
 484
 485         return(rc);
 486 }
 487
 488 char *
 489 be_root_dn( Backend *be )
 490 {
 491         if ( be->be_root_dn == NULL ) {
 492                 return( "" );
 493         }
 494
 495         return be->be_root_dn;
 496 }
 497
 498 int
 499 be_isroot_pw( Backend *be, char *ndn, struct berval *cred )
 500 {
 501         int result;
 502
 503         if ( ! be_isroot( be, ndn ) ) {
 504                 return( 0 );
 505         }
 506
 507 #ifdef SLAPD_CRYPT
 508         ldap_pvt_thread_mutex_lock( &crypt_mutex );
 509 #endif
 510
 511         result = lutil_passwd( cred->bv_val, be->be_root_pw, NULL );
 512
 513 #ifdef SLAPD_CRYPT
 514         ldap_pvt_thread_mutex_unlock( &crypt_mutex );
 515 #endif
 516
 517         return result == 0;
 518 }
 519
 520 int
 521 be_entry_release_rw( Backend *be, Entry *e, int rw )
 522 {
 523         if ( be->be_release ) {
 524                 /* free and release entry from backend */
 525                 return be->be_release( be, e, rw );
 526         } else {
 527                 /* free entry */
 528                 entry_free( e );
 529                 return 0;
 530         }
 531 }
 532
 533 int
 534 backend_unbind(
 535         Connection   *conn,
 536         Operation    *op
 537 )
 538 {
 539         int     i;
 540
 541         for ( i = 0; i < nbackends; i++ ) {
 542                 if ( backends[i].be_unbind ) {
 543                         (*backends[i].be_unbind)( &backends[i], conn, op );
 544                 }
 545         }
 546
 547         return 0;
 548 }
 549
 550 int
 551 backend_connection_init(
 552         Connection   *conn
 553 )
 554 {
 555         int     i;
 556
 557         for ( i = 0; i < nbackends; i++ ) {
 558                 if ( backends[i].be_connection_init ) {
 559                         (*backends[i].be_connection_init)( &backends[i], conn);
 560                 }
 561         }
 562
 563         return 0;
 564 }
 565
 566 int
 567 backend_connection_destroy(
 568         Connection   *conn
 569 )
 570 {
 571         int     i;
 572
 573         for ( i = 0; i < nbackends; i++ ) {
 574                 if ( backends[i].be_connection_destroy ) {
 575                         (*backends[i].be_connection_destroy)( &backends[i], conn);
 576                 }
 577         }
 578
 579         return 0;
 580 }
 581
 582 int
 583 backend_group(
 584         Backend *be,
 585         Entry   *target,
 586         char    *gr_ndn,
 587         char    *op_ndn,
 588         char    *objectclassValue,
 589         char    *groupattrName
 590 )
 591 {
 592         if (be->be_group)
 593                 return( be->be_group(be, target, gr_ndn, op_ndn,
 594                         objectclassValue, groupattrName) );
 595         else
 596                 return(1);
 597 }