3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6 /* backend.c - routines for dealing with back-end databases */
13 #include <ac/string.h>
14 #include <ac/socket.h>
22 #include "back-ldap/external.h"
25 #include "back-ldbm/external.h"
28 #include "back-bdb2/external.h"
31 #include "back-passwd/external.h"
34 #include "back-perl/external.h"
37 #include "back-shell/external.h"
40 #include "back-tcl/external.h"
43 static BackendInfo binfo[] = {
44 #if defined(SLAPD_LDAP) && !defined(SLAPD_LDAP_DYNAMIC)
45 {"ldap", ldap_back_initialize},
47 #if defined(SLAPD_LDBM) && !defined(SLAPD_LDBM_DYNAMIC)
48 {"ldbm", ldbm_back_initialize},
50 #if defined(SLAPD_BDB2) && !defined(SLAPD_BDB2_DYNAMIC)
51 {"bdb2", bdb2_back_initialize},
53 #if defined(SLAPD_PASSWD) && !defined(SLAPD_PASSWD_DYNAMIC)
54 {"passwd", passwd_back_initialize},
56 #if defined(SLAPD_PERL) && !defined(SLAPD_PERL_DYNAMIC)
57 {"perl", perl_back_initialize},
59 #if defined(SLAPD_SHELL) && !defined(SLAPD_SHELL_DYNAMIC)
60 {"shell", shell_back_initialize},
62 #if defined(SLAPD_TCL) && !defined(SLAPD_LDAP_TCL)
63 {"tcl", tcl_back_initialize},
69 BackendInfo *backendInfo = NULL;
72 BackendDB *backendDB = NULL;
74 int backend_init(void)
78 if((nBackendInfo != 0) || (backendInfo != NULL)) {
79 /* already initialized */
80 Debug( LDAP_DEBUG_ANY,
81 "backend_init: already initialized.\n", 0, 0, 0 );
86 binfo[nBackendInfo].bi_type != NULL;
89 rc = binfo[nBackendInfo].bi_init( &binfo[nBackendInfo] );
92 Debug( LDAP_DEBUG_ANY,
93 "backend_init: initialized for type \"%s\"\n",
94 binfo[nBackendInfo].bi_type, 0, 0 );
96 /* destroy those we've already inited */
101 if ( binfo[nBackendInfo].bi_destroy ) {
102 binfo[nBackendInfo].bi_destroy(
103 &binfo[nBackendInfo] );
110 if ( nBackendInfo > 0) {
118 Debug( LDAP_DEBUG_ANY,
119 "backend_init: failed\n",
123 #endif /* SLAPD_MODULES */
126 int backend_add(BackendInfo *aBackendInfo)
130 if ((rc = aBackendInfo->bi_init(aBackendInfo)) != 0) {
131 Debug( LDAP_DEBUG_ANY,
132 "backend_add: initialization for type \"%s\" failed\n",
133 aBackendInfo->bi_type, 0, 0 );
137 /* now add the backend type to the Backend Info List */
139 BackendInfo *newBackendInfo = 0;
141 /* if backendInfo == binfo no deallocation of old backendInfo */
142 if (backendInfo == binfo) {
143 newBackendInfo = ch_calloc(nBackendInfo + 1, sizeof(BackendInfo));
144 memcpy(newBackendInfo, backendInfo, sizeof(BackendInfo) *
147 newBackendInfo = ch_realloc(backendInfo, sizeof(BackendInfo) *
150 memcpy(&newBackendInfo[nBackendInfo], aBackendInfo,
151 sizeof(BackendInfo));
152 backendInfo = newBackendInfo;
159 int backend_startup(Backend *be)
164 if( ! ( nBackendDB > 0 ) ) {
166 Debug( LDAP_DEBUG_ANY,
167 "backend_startup: %d databases to startup.\n",
173 /* startup a specific backend database */
174 Debug( LDAP_DEBUG_TRACE,
175 "backend_startup: starting database\n",
178 if ( be->bd_info->bi_open ) {
179 rc = be->bd_info->bi_open( be->bd_info );
183 Debug( LDAP_DEBUG_ANY,
184 "backend_startup: bi_open failed!\n",
189 if ( be->bd_info->bi_db_open ) {
190 rc = be->bd_info->bi_db_open( be );
194 Debug( LDAP_DEBUG_ANY,
195 "backend_startup: bi_db_open failed!\n",
203 /* open each backend type */
204 for( i = 0; i < nBackendInfo; i++ ) {
205 if( backendInfo[i].bi_nDB == 0) {
206 /* no database of this type, don't open */
210 if( backendInfo[i].bi_open ) {
211 rc = backendInfo[i].bi_open(
216 Debug( LDAP_DEBUG_ANY,
217 "backend_startup: bi_open %d failed!\n",
223 /* open each backend database */
224 for( i = 0; i < nBackendDB; i++ ) {
225 if ( backendDB[i].bd_info->bi_db_open ) {
226 rc = backendDB[i].bd_info->bi_db_open(
231 Debug( LDAP_DEBUG_ANY,
232 "backend_startup: bi_db_open %d failed!\n",
241 int backend_num( Backend *be )
245 if( be == NULL ) return -1;
247 for( i = 0; i < nBackendDB; i++ ) {
248 if( be == &backendDB[i] ) return i;
253 int backend_shutdown( Backend *be )
259 /* shutdown a specific backend database */
261 if ( be->bd_info->bi_nDB == 0 ) {
262 /* no database of this type, we never opened it */
266 if ( be->bd_info->bi_db_close ) {
267 be->bd_info->bi_db_close( be );
270 if( be->bd_info->bi_close ) {
271 be->bd_info->bi_close( be->bd_info );
277 /* close each backend database */
278 for( i = 0; i < nBackendDB; i++ ) {
279 if ( backendDB[i].bd_info->bi_db_close ) {
280 backendDB[i].bd_info->bi_db_close(
285 Debug( LDAP_DEBUG_ANY,
286 "backend_close: bi_close %s failed!\n",
287 backendDB[i].be_type, 0, 0 );
291 /* close each backend type */
292 for( i = 0; i < nBackendInfo; i++ ) {
293 if( backendInfo[i].bi_nDB == 0 ) {
294 /* no database of this type */
298 if( backendInfo[i].bi_close ) {
299 backendInfo[i].bi_close(
307 int backend_destroy(void)
311 /* destroy each backend database */
312 for( i = 0; i < nBackendDB; i++ ) {
313 if ( backendDB[i].bd_info->bi_db_destroy ) {
314 backendDB[i].bd_info->bi_db_destroy(
319 /* destroy each backend type */
320 for( i = 0; i < nBackendInfo; i++ ) {
321 if( backendInfo[i].bi_destroy ) {
322 backendInfo[i].bi_destroy(
328 if (backendInfo != binfo) {
331 #endif /* SLAPD_MODULES */
339 BackendInfo* backend_info(const char *type)
343 /* search for the backend type */
344 for( i = 0; i < nBackendInfo; i++ ) {
345 if( strcasecmp(backendInfo[i].bi_type, type) == 0 ) {
346 return &backendInfo[i];
360 BackendInfo *bi = backend_info(type);
364 fprintf( stderr, "Unrecognized database type (%s)\n", type );
368 backendDB = (BackendDB *) ch_realloc(
370 (nBackendDB + 1) * sizeof(Backend) );
372 memset( &backendDB[nbackends], '\0', sizeof(Backend) );
374 be = &backends[nbackends++];
377 be->be_sizelimit = defsize;
378 be->be_timelimit = deftime;
380 /* assign a default depth limit for alias deref */
381 be->be_max_deref_depth = SLAPD_DEFAULT_MAXDEREFDEPTH;
383 be->be_realm = global_realm != NULL
384 ? ch_strdup( global_realm ) : NULL;
387 rc = bi->bi_db_init( be );
391 fprintf( stderr, "database init failed (%s)\n", type );
405 for ( i = 0; i < nbackends; i++ ) {
406 if ( backends[i].bd_info->bi_db_close ) {
407 (*backends[i].bd_info->bi_db_close)( &backends[i] );
413 select_backend( const char * dn )
415 int i, j, len, dnlen;
417 dnlen = strlen( dn );
418 for ( i = 0; i < nbackends; i++ ) {
419 for ( j = 0; backends[i].be_nsuffix != NULL &&
420 backends[i].be_nsuffix[j] != NULL; j++ )
422 len = strlen( backends[i].be_nsuffix[j] );
428 if ( strcmp( backends[i].be_nsuffix[j],
429 dn + (dnlen - len) ) == 0 ) {
430 return( &backends[i] );
435 #ifdef LDAP_ALLOW_NULL_SEARCH_BASE
436 /* Add greg@greg.rim.or.jp
437 * It's quick hack for cheap client
438 * Some browser offer a NULL base at ldap_search
440 * Should only be used as a last resort. -Kdz
443 Debug( LDAP_DEBUG_TRACE,
444 "select_backend: use default backend\n", 0, 0, 0 );
445 return( &backends[0] );
447 #endif /* LDAP_ALLOW_NULL_SEARCH_BASE */
460 for ( i = 0; be->be_nsuffix != NULL && be->be_nsuffix[i] != NULL; i++ ) {
461 if ( strcmp( be->be_nsuffix[i], suffix ) == 0 ) {
470 be_isroot( Backend *be, const char *ndn )
474 if ( ndn == NULL || be->be_root_ndn == NULL ) {
478 rc = strcmp( be->be_root_ndn, ndn ) ? 0 : 1;
484 be_root_dn( Backend *be )
486 if ( be->be_root_dn == NULL ) {
490 return be->be_root_dn;
494 be_isroot_pw( Backend *be, const char *ndn, struct berval *cred )
498 if ( ! be_isroot( be, ndn ) ) {
503 ldap_pvt_thread_mutex_lock( &crypt_mutex );
506 result = lutil_passwd( cred->bv_val, be->be_root_pw, NULL );
509 ldap_pvt_thread_mutex_unlock( &crypt_mutex );
516 be_entry_release_rw( Backend *be, Entry *e, int rw )
518 if ( be->be_release ) {
519 /* free and release entry from backend */
520 return be->be_release( be, e, rw );
536 for ( i = 0; i < nbackends; i++ ) {
537 if ( backends[i].be_unbind ) {
538 (*backends[i].be_unbind)( &backends[i], conn, op );
546 backend_connection_init(
552 for ( i = 0; i < nbackends; i++ ) {
553 if ( backends[i].be_connection_init ) {
554 (*backends[i].be_connection_init)( &backends[i], conn);
562 backend_connection_destroy(
568 for ( i = 0; i < nbackends; i++ ) {
569 if ( backends[i].be_connection_destroy ) {
570 (*backends[i].be_connection_destroy)( &backends[i], conn);
583 const char *objectclassValue,
584 const char *groupattrName
588 return( be->be_group(be, target, gr_ndn, op_ndn,
589 objectclassValue, groupattrName) );
594 #ifdef SLAPD_SCHEMA_DN
595 Attribute *backend_subschemasubentry( Backend *be )
597 /* should be backend specific */
598 static struct berval ss_val = {
599 sizeof(SLAPD_SCHEMA_DN)-1,
601 static struct berval *ss_vals[2] = { &ss_val, NULL };
602 static Attribute ss_attr = {
605 SYNTAX_DN | SYNTAX_CIS,