]> git.sur5r.net Git - openldap/blob - servers/slapd/backend.c
misc cleanup
[openldap] / servers / slapd / backend.c
1 /* $OpenLDAP$ */
2 /*
3  * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
5  */
6 /* backend.c - routines for dealing with back-end databases */
7
8
9 #include "portable.h"
10
11 #include <stdio.h>
12
13 #include <ac/string.h>
14 #include <ac/socket.h>
15 #include <sys/stat.h>
16
17 #include "slap.h"
18 #include "lutil.h"
19 #include "lber_pvt.h"
20
21 #include "ldap_rq.h"
22
23 #ifdef LDAP_SLAPI
24 #include "slapi.h"
25 #endif
26
27 /*
28  * If a module is configured as dynamic, its header should not
29  * get included into slapd. While this is a general rule and does
30  * not have much of an effect in UNIX, this rule should be adhered
31  * to for Windows, where dynamic object code should not be implicitly
32  * imported into slapd without appropriate __declspec(dllimport) directives.
33  */
34
35 #if defined(SLAPD_BDB) && !defined(SLAPD_BDB_DYNAMIC)
36 #include "back-bdb/external.h"
37 #endif
38 #if defined(SLAPD_DNSSRV) && !defined(SLAPD_DNSSRV_DYNAMIC)
39 #include "back-dnssrv/external.h"
40 #endif
41 #if defined(SLAPD_HDB) && !defined(SLAPD_HDB_DYNAMIC)
42 #include "back-hdb/external.h"
43 #endif
44 #if defined(SLAPD_LDAP) && !defined(SLAPD_LDAP_DYNAMIC)
45 #include "back-ldap/external.h"
46 #endif
47 #if defined(SLAPD_LDBM) && !defined(SLAPD_LDBM_DYNAMIC)
48 #include "back-ldbm/external.h"
49 #endif
50 #if defined(SLAPD_META) && !defined(SLAPD_META_DYNAMIC)
51 #include "back-meta/external.h"
52 #endif
53 #if defined(SLAPD_MONITOR) && !defined(SLAPD_MONITOR_DYNAMIC)
54 #include "back-monitor/external.h"
55 #endif
56 #if defined(SLAPD_NULL) && !defined(SLAPD_NULL_DYNAMIC)
57 #include "back-null/external.h"
58 #endif
59 #if defined(SLAPD_PASSWD) && !defined(SLAPD_PASSWD_DYNAMIC)
60 #include "back-passwd/external.h"
61 #endif
62 #if defined(SLAPD_PERL) && !defined(SLAPD_PERL_DYNAMIC)
63 #include "back-perl/external.h"
64 #endif
65 #if defined(SLAPD_SHELL) && !defined(SLAPD_SHELL_DYNAMIC)
66 #include "back-shell/external.h"
67 #endif
68 #if defined(SLAPD_TCL) && !defined(SLAPD_TCL_DYNAMIC)
69 #include "back-tcl/external.h"
70 #endif
71 #if defined(SLAPD_SQL) && !defined(SLAPD_SQL_DYNAMIC)
72 #include "back-sql/external.h"
73 #endif
74 #if defined(SLAPD_PRIVATE) && !defined(SLAPD_PRIVATE_DYNAMIC)
75 #include "private/external.h"
76 #endif
77
78 static BackendInfo binfo[] = {
79 #if defined(SLAPD_BDB) && !defined(SLAPD_BDB_DYNAMIC)
80         {"bdb", bdb_initialize},
81 #endif
82 #if defined(SLAPD_DNSSRV) && !defined(SLAPD_DNSSRV_DYNAMIC)
83         {"dnssrv",      dnssrv_back_initialize},
84 #endif
85 #if defined(SLAPD_HDB) && !defined(SLAPD_HDB_DYNAMIC)
86         {"hdb", hdb_initialize},
87 #endif
88 #if defined(SLAPD_LDAP) && !defined(SLAPD_LDAP_DYNAMIC)
89         {"ldap",        ldap_back_initialize},
90 #endif
91 #if defined(SLAPD_LDBM) && !defined(SLAPD_LDBM_DYNAMIC)
92         {"ldbm",        ldbm_back_initialize},
93 #endif
94 #if defined(SLAPD_META) && !defined(SLAPD_META_DYNAMIC)
95         {"meta",        meta_back_initialize},
96 #endif
97 #if defined(SLAPD_MONITOR) && !defined(SLAPD_MONITOR_DYNAMIC)
98         {"monitor",     monitor_back_initialize},
99 #endif
100 #if defined(SLAPD_NULL) && !defined(SLAPD_NULL_DYNAMIC)
101         {"null",        null_back_initialize},
102 #endif
103 #if defined(SLAPD_PASSWD) && !defined(SLAPD_PASSWD_DYNAMIC)
104         {"passwd",      passwd_back_initialize},
105 #endif
106 #if defined(SLAPD_PERL) && !defined(SLAPD_PERL_DYNAMIC)
107         {"perl",        perl_back_initialize},
108 #endif
109 #if defined(SLAPD_SHELL) && !defined(SLAPD_SHELL_DYNAMIC)
110         {"shell",       shell_back_initialize},
111 #endif
112 #if defined(SLAPD_TCL) && !defined(SLAPD_TCL_DYNAMIC)
113         {"tcl",         tcl_back_initialize},
114 #endif
115 #if defined(SLAPD_SQL) && !defined(SLAPD_SQL_DYNAMIC)
116         {"sql",         sql_back_initialize},
117 #endif
118         /* for any private backend */
119 #if defined(SLAPD_PRIVATE) && !defined(SLAPD_PRIVATE_DYNAMIC)
120         {"private",     private_back_initialize},
121 #endif
122         {NULL}
123 };
124
125 int                     nBackendInfo = 0;
126 BackendInfo     *backendInfo = NULL;
127
128 int                     nBackendDB = 0; 
129 BackendDB       *backendDB = NULL;
130
131 #ifdef LDAP_SYNCREPL
132 ldap_pvt_thread_pool_t  syncrepl_pool;
133 int                     syncrepl_pool_max = SLAP_MAX_SYNCREPL_THREADS;
134 #endif
135
136 int backend_init(void)
137 {
138         int rc = -1;
139
140 #ifdef LDAP_SYNCREPL
141         ldap_pvt_thread_pool_init( &syncrepl_pool, syncrepl_pool_max, 0 );
142 #endif
143
144         if((nBackendInfo != 0) || (backendInfo != NULL)) {
145                 /* already initialized */
146 #ifdef NEW_LOGGING
147                 LDAP_LOG( BACKEND, ERR, 
148                         "backend_init:  backend already initialized\n", 0, 0, 0 );
149 #else
150                 Debug( LDAP_DEBUG_ANY,
151                         "backend_init: already initialized.\n", 0, 0, 0 );
152 #endif
153                 return -1;
154         }
155
156         for( ;
157                 binfo[nBackendInfo].bi_type != NULL;
158                 nBackendInfo++ )
159         {
160                 rc = binfo[nBackendInfo].bi_init( &binfo[nBackendInfo] );
161
162                 if(rc != 0) {
163 #ifdef NEW_LOGGING
164                         LDAP_LOG( BACKEND, INFO, 
165                                 "backend_init:  initialized for type \"%s\"\n",
166                                 binfo[nBackendInfo].bi_type, 0, 0 );
167 #else
168                         Debug( LDAP_DEBUG_ANY,
169                                 "backend_init: initialized for type \"%s\"\n",
170                                 binfo[nBackendInfo].bi_type, 0, 0 );
171 #endif
172                         /* destroy those we've already inited */
173                         for( nBackendInfo--;
174                                 nBackendInfo >= 0 ;
175                                 nBackendInfo-- )
176                         { 
177                                 if ( binfo[nBackendInfo].bi_destroy ) {
178                                         binfo[nBackendInfo].bi_destroy(
179                                                 &binfo[nBackendInfo] );
180                                 }
181                         }
182                         return rc;
183                 }
184         }
185
186         if ( nBackendInfo > 0) {
187                 backendInfo = binfo;
188                 return 0;
189         }
190
191 #ifdef SLAPD_MODULES    
192         return 0;
193 #else
194
195 #ifdef NEW_LOGGING
196         LDAP_LOG( BACKEND, ERR, "backend_init: failed\n", 0, 0, 0 );
197 #else
198         Debug( LDAP_DEBUG_ANY,
199                 "backend_init: failed\n",
200                 0, 0, 0 );
201 #endif
202
203         return rc;
204 #endif /* SLAPD_MODULES */
205 }
206
207 int backend_add(BackendInfo *aBackendInfo)
208 {
209    int rc = 0;
210
211    if ((rc = aBackendInfo->bi_init(aBackendInfo)) != 0) {
212 #ifdef NEW_LOGGING
213         LDAP_LOG( BACKEND, ERR, 
214                   "backend_add:  initialization for type \"%s\" failed\n",
215                   aBackendInfo->bi_type, 0, 0 );
216 #else
217       Debug( LDAP_DEBUG_ANY,
218              "backend_add: initialization for type \"%s\" failed\n",
219              aBackendInfo->bi_type, 0, 0 );
220 #endif
221       return rc;
222    }
223
224    /* now add the backend type to the Backend Info List */
225    {
226       BackendInfo *newBackendInfo = 0;
227
228       /* if backendInfo == binfo no deallocation of old backendInfo */
229       if (backendInfo == binfo) {
230          newBackendInfo = ch_calloc(nBackendInfo + 1, sizeof(BackendInfo));
231          AC_MEMCPY(newBackendInfo, backendInfo, sizeof(BackendInfo) * 
232                 nBackendInfo);
233       } else {
234          newBackendInfo = ch_realloc(backendInfo, sizeof(BackendInfo) * 
235                                      (nBackendInfo + 1));
236       }
237       AC_MEMCPY(&newBackendInfo[nBackendInfo], aBackendInfo, 
238              sizeof(BackendInfo));
239       backendInfo = newBackendInfo;
240       nBackendInfo++;
241
242       return 0;
243    }        
244 }
245
246 int backend_startup(Backend *be)
247 {
248         int i;
249         int rc = 0;
250
251 #ifdef LDAP_SYNCREPL
252         init_syncrepl();
253 #endif
254
255         if( ! ( nBackendDB > 0 ) ) {
256                 /* no databases */
257 #ifdef NEW_LOGGING
258                 LDAP_LOG( BACKEND, INFO, 
259                         "backend_startup: %d databases to startup. \n", nBackendDB, 0, 0 );
260 #else
261                 Debug( LDAP_DEBUG_ANY,
262                         "backend_startup: %d databases to startup.\n",
263                         nBackendDB, 0, 0 );
264 #endif
265                 return 1;
266         }
267
268         if(be != NULL) {
269                 /* startup a specific backend database */
270
271 #ifdef LDAP_SYNC
272                 LDAP_TAILQ_INIT( &be->be_pending_csn_list );
273 #endif
274
275 #ifdef NEW_LOGGING
276                 LDAP_LOG( BACKEND, DETAIL1, "backend_startup:  starting \"%s\"\n",
277                            be->be_suffix[0].bv_val, 0, 0 );
278 #else
279                 Debug( LDAP_DEBUG_TRACE,
280                         "backend_startup: starting \"%s\"\n",
281                         be->be_suffix[0].bv_val, 0, 0 );
282 #endif
283
284                 if ( be->bd_info->bi_open ) {
285                         rc = be->bd_info->bi_open( be->bd_info );
286                         if ( rc != 0 ) {
287 #ifdef NEW_LOGGING
288                                 LDAP_LOG( BACKEND, CRIT, "backend_startup: bi_open failed!\n", 0, 0, 0 );
289 #else
290                                 Debug( LDAP_DEBUG_ANY,
291                                         "backend_startup: bi_open failed!\n",
292                                         0, 0, 0 );
293 #endif
294
295                                 return rc;
296                         }
297                 }
298
299                 if ( be->bd_info->bi_db_open ) {
300                         rc = be->bd_info->bi_db_open( be );
301                         if ( rc != 0 ) {
302 #ifdef NEW_LOGGING
303                                 LDAP_LOG( BACKEND, CRIT, 
304                                         "backend_startup: bi_db_open failed! (%d)\n", rc, 0, 0 );
305 #else
306                                 Debug( LDAP_DEBUG_ANY,
307                                         "backend_startup: bi_db_open failed! (%d)\n",
308                                         rc, 0, 0 );
309 #endif
310                                 return rc;
311                         }
312                 }
313
314                 return rc;
315         }
316
317         /* open each backend type */
318         for( i = 0; i < nBackendInfo; i++ ) {
319                 if( backendInfo[i].bi_nDB == 0) {
320                         /* no database of this type, don't open */
321                         continue;
322                 }
323
324                 if( backendInfo[i].bi_open ) {
325                         rc = backendInfo[i].bi_open(
326                                 &backendInfo[i] );
327                         if ( rc != 0 ) {
328 #ifdef NEW_LOGGING
329                                 LDAP_LOG( BACKEND, CRIT, 
330                                         "backend_startup: bi_open %d failed!\n", i, 0, 0 );
331 #else
332                                 Debug( LDAP_DEBUG_ANY,
333                                         "backend_startup: bi_open %d failed!\n",
334                                         i, 0, 0 );
335 #endif
336                                 return rc;
337                         }
338                 }
339         }
340
341 #ifdef LDAP_SYNCREPL
342         ldap_pvt_thread_mutex_init( &syncrepl_rq.rq_mutex );
343         LDAP_STAILQ_INIT( &syncrepl_rq.task_list );
344         LDAP_STAILQ_INIT( &syncrepl_rq.run_list );
345 #endif
346
347         /* open each backend database */
348         for( i = 0; i < nBackendDB; i++ ) {
349                 /* append global access controls */
350                 acl_append( &backendDB[i].be_acl, global_acl );
351
352 #ifdef LDAP_SYNC
353                 LDAP_TAILQ_INIT( &backendDB[i].be_pending_csn_list );
354 #endif
355
356                 if ( backendDB[i].bd_info->bi_db_open ) {
357                         rc = backendDB[i].bd_info->bi_db_open(
358                                 &backendDB[i] );
359                         if ( rc != 0 ) {
360 #ifdef NEW_LOGGING
361                                 LDAP_LOG( BACKEND, CRIT, 
362                                         "backend_startup: bi_db_open(%d) failed! (%d)\n", i, rc, 0 );
363 #else
364                                 Debug( LDAP_DEBUG_ANY,
365                                         "backend_startup: bi_db_open(%d) failed! (%d)\n",
366                                         i, rc, 0 );
367 #endif
368                                 return rc;
369                         }
370                 }
371
372 #ifdef LDAP_SYNCREPL
373                 if ( backendDB[i].syncinfo != NULL ) {
374                         syncinfo_t *si = ( syncinfo_t * ) backendDB[i].syncinfo;
375                         si->be = &backendDB[i];
376                         ldap_pvt_thread_mutex_lock( &syncrepl_rq.rq_mutex );
377                         ldap_pvt_runqueue_insert( &syncrepl_rq, si->interval,
378                                                         do_syncrepl, (void *) backendDB[i].syncinfo );
379                         ldap_pvt_thread_mutex_unlock( &syncrepl_rq.rq_mutex );
380                 }
381 #endif
382         }
383
384         return rc;
385 }
386
387 int backend_num( Backend *be )
388 {
389         int i;
390
391         if( be == NULL ) return -1;
392
393         for( i = 0; i < nBackendDB; i++ ) {
394                 if( be == &backendDB[i] ) return i;
395         }
396         return -1;
397 }
398
399 int backend_shutdown( Backend *be )
400 {
401         int i;
402         int rc = 0;
403
404         if( be != NULL ) {
405                 /* shutdown a specific backend database */
406
407                 if ( be->bd_info->bi_nDB == 0 ) {
408                         /* no database of this type, we never opened it */
409                         return 0;
410                 }
411
412                 if ( be->bd_info->bi_db_close ) {
413                         be->bd_info->bi_db_close( be );
414                 }
415
416                 if( be->bd_info->bi_close ) {
417                         be->bd_info->bi_close( be->bd_info );
418                 }
419
420                 return 0;
421         }
422
423         /* close each backend database */
424         for( i = 0; i < nBackendDB; i++ ) {
425                 if ( backendDB[i].bd_info->bi_db_close ) {
426                         backendDB[i].bd_info->bi_db_close(
427                                 &backendDB[i] );
428                 }
429
430                 if(rc != 0) {
431 #ifdef NEW_LOGGING
432                         LDAP_LOG( BACKEND, NOTICE, 
433                                 "backend_shutdown: bi_close %s failed!\n",
434                                 backendDB[i].be_type, 0, 0 );
435 #else
436                         Debug( LDAP_DEBUG_ANY,
437                                 "backend_close: bi_close %s failed!\n",
438                                 backendDB[i].be_type, 0, 0 );
439 #endif
440                 }
441         }
442
443         /* close each backend type */
444         for( i = 0; i < nBackendInfo; i++ ) {
445                 if( backendInfo[i].bi_nDB == 0 ) {
446                         /* no database of this type */
447                         continue;
448                 }
449
450                 if( backendInfo[i].bi_close ) {
451                         backendInfo[i].bi_close(
452                                 &backendInfo[i] );
453                 }
454         }
455
456         return 0;
457 }
458
459 int backend_destroy(void)
460 {
461         int i;
462         BackendDB *bd;
463
464 #ifdef LDAP_SYNCREPL
465         ldap_pvt_thread_pool_destroy( &syncrepl_pool, 1 );
466 #endif
467
468         /* destroy each backend database */
469         for( i = 0, bd = backendDB; i < nBackendDB; i++, bd++ ) {
470                 if ( bd->bd_info->bi_db_destroy ) {
471                         bd->bd_info->bi_db_destroy( bd );
472                 }
473                 ber_bvarray_free( bd->be_suffix );
474                 ber_bvarray_free( bd->be_nsuffix );
475                 if ( bd->be_rootdn.bv_val ) free( bd->be_rootdn.bv_val );
476                 if ( bd->be_rootndn.bv_val ) free( bd->be_rootndn.bv_val );
477                 if ( bd->be_rootpw.bv_val ) free( bd->be_rootpw.bv_val );
478                 acl_destroy( bd->be_acl, global_acl );
479         }
480         free( backendDB );
481
482         /* destroy each backend type */
483         for( i = 0; i < nBackendInfo; i++ ) {
484                 if( backendInfo[i].bi_destroy ) {
485                         backendInfo[i].bi_destroy(
486                                 &backendInfo[i] );
487                 }
488         }
489
490 #ifdef SLAPD_MODULES
491         if (backendInfo != binfo) {
492            free(backendInfo);
493         }
494 #endif /* SLAPD_MODULES */
495
496         nBackendInfo = 0;
497         backendInfo = NULL;
498
499         return 0;
500 }
501
502 BackendInfo* backend_info(const char *type)
503 {
504         int i;
505
506         /* search for the backend type */
507         for( i = 0; i < nBackendInfo; i++ ) {
508                 if( strcasecmp(backendInfo[i].bi_type, type) == 0 ) {
509                         return &backendInfo[i];
510                 }
511         }
512
513         return NULL;
514 }
515
516
517 BackendDB *
518 backend_db_init(
519     const char  *type
520 )
521 {
522         Backend *be;
523         BackendInfo *bi = backend_info(type);
524         int     rc = 0;
525
526         if( bi == NULL ) {
527                 fprintf( stderr, "Unrecognized database type (%s)\n", type );
528                 return NULL;
529         }
530
531         backendDB = (BackendDB *) ch_realloc(
532                         (char *) backendDB,
533                     (nBackendDB + 1) * sizeof(Backend) );
534
535         memset( &backendDB[nbackends], '\0', sizeof(Backend) );
536
537         be = &backends[nbackends++];
538
539         be->bd_info = bi;
540         be->be_def_limit = deflimit;
541         be->be_dfltaccess = global_default_access;
542
543         be->be_restrictops = global_restrictops;
544         be->be_requires = global_requires;
545         be->be_ssf_set = global_ssf_set;
546
547 #ifdef LDAP_SYNC
548         be->be_context_csn.bv_len = 0;
549         be->be_context_csn.bv_val = NULL;
550         ldap_pvt_thread_mutex_init( &be->be_pcl_mutex );
551         ldap_pvt_thread_mutex_init( &be->be_context_csn_mutex );
552 #endif
553
554 #ifdef LDAP_SYNCREPL
555         be->syncinfo = NULL;
556 #endif
557
558         /* assign a default depth limit for alias deref */
559         be->be_max_deref_depth = SLAPD_DEFAULT_MAXDEREFDEPTH; 
560
561         if(bi->bi_db_init) {
562                 rc = bi->bi_db_init( be );
563         }
564
565         if(rc != 0) {
566                 fprintf( stderr, "database init failed (%s)\n", type );
567                 nbackends--;
568                 return NULL;
569         }
570
571         bi->bi_nDB++;
572         return( be );
573 }
574
575 void
576 be_db_close( void )
577 {
578         int     i;
579
580         for ( i = 0; i < nbackends; i++ ) {
581                 if ( backends[i].bd_info->bi_db_close ) {
582                         (*backends[i].bd_info->bi_db_close)( &backends[i] );
583                 }
584         }
585 }
586
587 Backend *
588 select_backend(
589         struct berval * dn,
590         int manageDSAit,
591         int noSubs )
592 {
593         int     i, j;
594         ber_len_t len, dnlen = dn->bv_len;
595         Backend *be = NULL;
596
597         for ( i = 0; i < nbackends; i++ ) {
598                 for ( j = 0; backends[i].be_nsuffix != NULL &&
599                     backends[i].be_nsuffix[j].bv_val != NULL; j++ )
600                 {
601                         if ( ( SLAP_GLUE_SUBORDINATE( &backends[i] ) )
602                                 && noSubs )
603                         {
604                                 continue;
605                         }
606
607                         len = backends[i].be_nsuffix[j].bv_len;
608
609                         if ( len > dnlen ) {
610                                 /* suffix is longer than DN */
611                                 continue;
612                         }
613                         
614                         /*
615                          * input DN is normalized, so the separator check
616                          * need not look at escaping
617                          */
618                         if ( len && len < dnlen &&
619                                 !DN_SEPARATOR( dn->bv_val[(dnlen-len)-1] ))
620                         {
621                                 continue;
622                         }
623
624                         if ( strcmp( backends[i].be_nsuffix[j].bv_val,
625                                 &dn->bv_val[dnlen-len] ) == 0 )
626                         {
627                                 if( be == NULL ) {
628                                         be = &backends[i];
629
630                                         if( manageDSAit && len == dnlen ) {
631                                                 continue;
632                                         }
633                                 } else {
634                                         be = &backends[i];
635                                 }
636                                 return be;
637                         }
638                 }
639         }
640
641         return be;
642 }
643
644 int
645 be_issuffix(
646     Backend     *be,
647     struct berval       *bvsuffix
648 )
649 {
650         int     i;
651
652         for ( i = 0; be->be_nsuffix != NULL && be->be_nsuffix[i].bv_val != NULL; i++ ) {
653                 if ( bvmatch( &be->be_nsuffix[i], bvsuffix ) ) {
654                         return( 1 );
655                 }
656         }
657
658         return( 0 );
659 }
660
661 int
662 be_isroot( Backend *be, struct berval *ndn )
663 {
664         if ( !ndn->bv_len ) {
665                 return( 0 );
666         }
667
668         if ( !be->be_rootndn.bv_len ) {
669                 return( 0 );
670         }
671
672         return dn_match( &be->be_rootndn, ndn );
673 }
674
675 int
676 be_isupdate( Backend *be, struct berval *ndn )
677 {
678         if ( !ndn->bv_len ) {
679                 return( 0 );
680         }
681
682         if ( !be->be_update_ndn.bv_len ) {
683                 return( 0 );
684         }
685
686         return dn_match( &be->be_update_ndn, ndn );
687 }
688
689 struct berval *
690 be_root_dn( Backend *be )
691 {
692         return &be->be_rootdn;
693 }
694
695 int
696 be_isroot_pw( Operation *op )
697 {
698         int result;
699         char *errmsg;
700
701         if ( ! be_isroot( op->o_bd, &op->o_req_ndn ) ) {
702                 return 0;
703         }
704
705         if( op->o_bd->be_rootpw.bv_len == 0 ) {
706                 return 0;
707         }
708
709 #if defined( SLAPD_CRYPT ) || defined( SLAPD_SPASSWD )
710         ldap_pvt_thread_mutex_lock( &passwd_mutex );
711 #ifdef SLAPD_SPASSWD
712         lutil_passwd_sasl_conn = op->o_conn->c_sasl_authctx;
713 #endif
714 #endif
715
716         result = lutil_passwd( &op->o_bd->be_rootpw, &op->orb_cred, NULL, NULL );
717
718 #if defined( SLAPD_CRYPT ) || defined( SLAPD_SPASSWD )
719 #ifdef SLAPD_SPASSWD
720         lutil_passwd_sasl_conn = NULL;
721 #endif
722         ldap_pvt_thread_mutex_unlock( &passwd_mutex );
723 #endif
724
725         return result == 0;
726 }
727
728 int
729 be_entry_release_rw(
730         Operation *op,
731         Entry *e,
732         int rw )
733 {
734         if ( op->o_bd->be_release ) {
735                 /* free and release entry from backend */
736                 return op->o_bd->be_release( op, e, rw );
737         } else {
738                 /* free entry */
739                 entry_free( e );
740                 return 0;
741         }
742 }
743
744 int
745 backend_unbind( Operation *op, SlapReply *rs )
746 {
747         int             i;
748 #if defined( LDAP_SLAPI )
749         Slapi_PBlock *pb = op->o_pb;
750
751         int     rc;
752         slapi_x_pblock_set_operation( pb, op );
753 #endif /* defined( LDAP_SLAPI ) */
754
755         for ( i = 0; i < nbackends; i++ ) {
756 #if defined( LDAP_SLAPI )
757                 slapi_pblock_set( pb, SLAPI_BACKEND, (void *)&backends[i] );
758                 rc = doPluginFNs( &backends[i], SLAPI_PLUGIN_PRE_UNBIND_FN,
759                                 (Slapi_PBlock *)pb );
760                 if ( rc < 0 ) {
761                         /*
762                          * A preoperation plugin failure will abort the
763                          * entire operation.
764                          */
765 #ifdef NEW_LOGGING
766                         LDAP_LOG( OPERATION, INFO, "do_bind: Unbind preoperation plugin "
767                                         "failed\n", 0, 0, 0);
768 #else
769                         Debug(LDAP_DEBUG_TRACE, "do_bind: Unbind preoperation plugin "
770                                         "failed.\n", 0, 0, 0);
771 #endif
772                         return 0;
773                 }
774 #endif /* defined( LDAP_SLAPI ) */
775
776                 if ( backends[i].be_unbind ) {
777                         op->o_bd = &backends[i];
778                         (*backends[i].be_unbind)( op, rs );
779                 }
780
781 #if defined( LDAP_SLAPI )
782                 if ( doPluginFNs( &backends[i], SLAPI_PLUGIN_POST_UNBIND_FN,
783                                 (Slapi_PBlock *)pb ) < 0 ) {
784 #ifdef NEW_LOGGING
785                         LDAP_LOG( OPERATION, INFO, "do_unbind: Unbind postoperation plugins "
786                                         "failed\n", 0, 0, 0);
787 #else
788                         Debug(LDAP_DEBUG_TRACE, "do_unbind: Unbind postoperation plugins "
789                                         "failed.\n", 0, 0, 0);
790 #endif
791                 }
792 #endif /* defined( LDAP_SLAPI ) */
793         }
794
795         return 0;
796 }
797
798 int
799 backend_connection_init(
800         Connection   *conn
801 )
802 {
803         int     i;
804
805         for ( i = 0; i < nbackends; i++ ) {
806                 if ( backends[i].be_connection_init ) {
807                         (*backends[i].be_connection_init)( &backends[i], conn);
808                 }
809         }
810
811         return 0;
812 }
813
814 int
815 backend_connection_destroy(
816         Connection   *conn
817 )
818 {
819         int     i;
820
821         for ( i = 0; i < nbackends; i++ ) {
822                 if ( backends[i].be_connection_destroy ) {
823                         (*backends[i].be_connection_destroy)( &backends[i], conn);
824                 }
825         }
826
827         return 0;
828 }
829
830 static int
831 backend_check_controls(
832         Operation *op,
833         SlapReply *rs )
834 {
835         LDAPControl **ctrls = op->o_ctrls;
836         rs->sr_err = LDAP_SUCCESS;
837
838         if( ctrls ) {
839                 for( ; *ctrls != NULL ; ctrls++ ) {
840                         if( (*ctrls)->ldctl_iscritical && !ldap_charray_inlist(
841                                 op->o_bd->be_controls, (*ctrls)->ldctl_oid ) )
842                         {
843                                 rs->sr_text = "control unavailable in context";
844                                 rs->sr_err = LDAP_UNAVAILABLE_CRITICAL_EXTENSION;
845                                 break;
846                         }
847                 }
848         }
849
850         return rs->sr_err;
851 }
852
853 int
854 backend_check_restrictions(
855         Operation *op,
856         SlapReply *rs,
857         struct berval *opdata )
858 {
859         slap_mask_t restrictops;
860         slap_mask_t requires;
861         slap_mask_t opflag;
862         slap_ssf_set_t *ssf;
863         int updateop = 0;
864         int starttls = 0;
865         int session = 0;
866
867         if( op->o_bd ) {
868                 if ( backend_check_controls( op, rs ) != LDAP_SUCCESS ) {
869                         return rs->sr_err;
870                 }
871
872                 restrictops = op->o_bd->be_restrictops;
873                 requires = op->o_bd->be_requires;
874                 ssf = &op->o_bd->be_ssf_set;
875
876         } else {
877                 restrictops = global_restrictops;
878                 requires = global_requires;
879                 ssf = &global_ssf_set;
880         }
881
882         switch( op->o_tag ) {
883         case LDAP_REQ_ADD:
884                 opflag = SLAP_RESTRICT_OP_ADD;
885                 updateop++;
886                 break;
887         case LDAP_REQ_BIND:
888                 opflag = SLAP_RESTRICT_OP_BIND;
889                 session++;
890                 break;
891         case LDAP_REQ_COMPARE:
892                 opflag = SLAP_RESTRICT_OP_COMPARE;
893                 break;
894         case LDAP_REQ_DELETE:
895                 updateop++;
896                 opflag = SLAP_RESTRICT_OP_DELETE;
897                 break;
898         case LDAP_REQ_EXTENDED:
899                 opflag = SLAP_RESTRICT_OP_EXTENDED;
900
901                 if( !opdata ) {
902                         /* treat unspecified as a modify */
903                         opflag = SLAP_RESTRICT_OP_MODIFY;
904                         updateop++;
905                         break;
906                 }
907
908                 {
909                         if( bvmatch( opdata, &slap_EXOP_START_TLS ) ) {
910                                 session++;
911                                 starttls++;
912                                 break;
913                         }
914                 }
915
916                 {
917                         if( bvmatch( opdata, &slap_EXOP_WHOAMI ) ) {
918                                 break;
919                         }
920                 }
921
922 #ifdef LDAP_EXOP_X_CANCEL
923                 {
924                         if ( bvmatch( opdata, &slap_EXOP_CANCEL ) ) {
925                                 break;
926                         }
927                 }
928 #endif
929
930                 /* treat everything else as a modify */
931                 opflag = SLAP_RESTRICT_OP_MODIFY;
932                 updateop++;
933                 break;
934
935         case LDAP_REQ_MODIFY:
936                 updateop++;
937                 opflag = SLAP_RESTRICT_OP_MODIFY;
938                 break;
939         case LDAP_REQ_RENAME:
940                 updateop++;
941                 opflag = SLAP_RESTRICT_OP_RENAME;
942                 break;
943         case LDAP_REQ_SEARCH:
944                 opflag = SLAP_RESTRICT_OP_SEARCH;
945                 break;
946         case LDAP_REQ_UNBIND:
947                 session++;
948                 opflag = 0;
949                 break;
950         default:
951                 rs->sr_text = "restrict operations internal error";
952                 rs->sr_err = LDAP_OTHER;
953                 return rs->sr_err;
954         }
955
956         if ( !starttls ) {
957                 /* these checks don't apply to StartTLS */
958
959                 rs->sr_err = LDAP_CONFIDENTIALITY_REQUIRED;
960                 if( op->o_transport_ssf < ssf->sss_transport ) {
961                         rs->sr_text = "transport confidentiality required";
962                         return rs->sr_err;
963                 }
964
965                 if( op->o_tls_ssf < ssf->sss_tls ) {
966                         rs->sr_text = "TLS confidentiality required";
967                         return rs->sr_err;
968                 }
969
970
971                 if( op->o_tag == LDAP_REQ_BIND && opdata == NULL ) {
972                         /* simple bind specific check */
973                         if( op->o_ssf < ssf->sss_simple_bind ) {
974                                 rs->sr_text = "confidentiality required";
975                                 return rs->sr_err;
976                         }
977                 }
978
979                 if( op->o_tag != LDAP_REQ_BIND || opdata == NULL ) {
980                         /* these checks don't apply to SASL bind */
981
982                         if( op->o_sasl_ssf < ssf->sss_sasl ) {
983                                 rs->sr_text = "SASL confidentiality required";
984                                 return rs->sr_err;
985                         }
986
987                         if( op->o_ssf < ssf->sss_ssf ) {
988                                 rs->sr_text = "confidentiality required";
989                                 return rs->sr_err;
990                         }
991                 }
992
993                 if( updateop ) {
994                         if( op->o_transport_ssf < ssf->sss_update_transport ) {
995                                 rs->sr_text = "transport update confidentiality required";
996                                 return rs->sr_err;
997                         }
998
999                         if( op->o_tls_ssf < ssf->sss_update_tls ) {
1000                                 rs->sr_text = "TLS update confidentiality required";
1001                                 return rs->sr_err;
1002                         }
1003
1004                         if( op->o_sasl_ssf < ssf->sss_update_sasl ) {
1005                                 rs->sr_text = "SASL update confidentiality required";
1006                                 return rs->sr_err;
1007                         }
1008
1009                         if( op->o_ssf < ssf->sss_update_ssf ) {
1010                                 rs->sr_text = "update confidentiality required";
1011                                 return rs->sr_err;
1012                         }
1013
1014                         if( !( global_allows & SLAP_ALLOW_UPDATE_ANON ) &&
1015                                 op->o_ndn.bv_len == 0 )
1016                         {
1017                                 rs->sr_text = "modifications require authentication";
1018                                 rs->sr_err = LDAP_STRONG_AUTH_REQUIRED;
1019                                 return rs->sr_err;
1020                         }
1021
1022 #ifdef SLAP_X_LISTENER_MOD
1023                         if ( op->o_conn->c_listener && ! ( op->o_conn->c_listener->sl_perms & ( op->o_ndn.bv_len > 0 ? S_IWUSR : S_IWOTH ) ) ) {
1024                                 /* no "w" mode means readonly */
1025                                 rs->sr_text = "modifications not allowed on this listener";
1026                                 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
1027                                 return rs->sr_err;
1028                         }
1029 #endif /* SLAP_X_LISTENER_MOD */
1030                 }
1031         }
1032
1033         if ( !session ) {
1034                 /* these checks don't apply to Bind, StartTLS, or Unbind */
1035
1036                 if( requires & SLAP_REQUIRE_STRONG ) {
1037                         /* should check mechanism */
1038                         if( ( op->o_transport_ssf < ssf->sss_transport
1039                                 && op->o_authmech.bv_len == 0 ) || op->o_dn.bv_len == 0 )
1040                         {
1041                                 rs->sr_text = "strong authentication required";
1042                                 rs->sr_err = LDAP_STRONG_AUTH_REQUIRED;
1043                                 return rs->sr_err;
1044                         }
1045                 }
1046
1047                 if( requires & SLAP_REQUIRE_SASL ) {
1048                         if( op->o_authmech.bv_len == 0 || op->o_dn.bv_len == 0 ) {
1049                                 rs->sr_text = "SASL authentication required";
1050                                 rs->sr_err = LDAP_STRONG_AUTH_REQUIRED;
1051                                 return rs->sr_err;
1052                         }
1053                 }
1054                         
1055                 if( requires & SLAP_REQUIRE_AUTHC ) {
1056                         if( op->o_dn.bv_len == 0 ) {
1057                                 rs->sr_text = "authentication required";
1058                                 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
1059                                 return rs->sr_err;
1060                         }
1061                 }
1062
1063                 if( requires & SLAP_REQUIRE_BIND ) {
1064                         int version;
1065                         ldap_pvt_thread_mutex_lock( &op->o_conn->c_mutex );
1066                         version = op->o_conn->c_protocol;
1067                         ldap_pvt_thread_mutex_unlock( &op->o_conn->c_mutex );
1068
1069                         if( !version ) {
1070                                 /* no bind has occurred */
1071                                 rs->sr_text = "BIND required";
1072                                 rs->sr_err = LDAP_OPERATIONS_ERROR;
1073                                 return rs->sr_err;
1074                         }
1075                 }
1076
1077                 if( requires & SLAP_REQUIRE_LDAP_V3 ) {
1078                         if( op->o_protocol < LDAP_VERSION3 ) {
1079                                 /* no bind has occurred */
1080                                 rs->sr_text = "operation restricted to LDAPv3 clients";
1081                                 rs->sr_err = LDAP_OPERATIONS_ERROR;
1082                                 return rs->sr_err;
1083                         }
1084                 }
1085
1086 #ifdef SLAP_X_LISTENER_MOD
1087                 if ( !starttls && op->o_dn.bv_len == 0 ) {
1088                         if ( op->o_conn->c_listener && ! ( op->o_conn->c_listener->sl_perms & S_IXOTH ) ) {
1089                                 /* no "x" mode means bind required */
1090                                 rs->sr_text = "bind required on this listener";
1091                                 rs->sr_err = LDAP_STRONG_AUTH_REQUIRED;
1092                                 return rs->sr_err;
1093                         }
1094                 }
1095
1096                 if ( !starttls && !updateop ) {
1097                         if ( op->o_conn->c_listener && ! ( op->o_conn->c_listener->sl_perms & ( op->o_dn.bv_len > 0 ? S_IRUSR : S_IROTH ) ) ) {
1098                                 /* no "r" mode means no read */
1099                                 rs->sr_text = "read not allowed on this listener";
1100                                 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
1101                                 return rs->sr_err;
1102                         }
1103                 }
1104 #endif /* SLAP_X_LISTENER_MOD */
1105
1106         }
1107
1108         if( restrictops & opflag ) {
1109                 if( restrictops == SLAP_RESTRICT_OP_READS ) {
1110                         rs->sr_text = "read operations restricted";
1111                 } else {
1112                         rs->sr_text = "operation restricted";
1113                 }
1114                 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
1115                 return rs->sr_err;
1116         }
1117
1118         rs->sr_err = LDAP_SUCCESS;
1119         return rs->sr_err;
1120 }
1121
1122 int backend_check_referrals( Operation *op, SlapReply *rs )
1123 {
1124         rs->sr_err = LDAP_SUCCESS;
1125
1126         if( op->o_bd->be_chk_referrals ) {
1127                 rs->sr_err = op->o_bd->be_chk_referrals( op, rs );
1128
1129                 if( rs->sr_err != LDAP_SUCCESS && rs->sr_err != LDAP_REFERRAL ) {
1130                         send_ldap_result( op, rs );
1131                 }
1132         }
1133
1134         return rs->sr_err;
1135 }
1136
1137 int
1138 be_entry_get_rw(
1139         Operation *op,
1140         struct berval *ndn,
1141         ObjectClass *oc,
1142         AttributeDescription *at,
1143         int rw,
1144         Entry **e )
1145 {
1146         int rc;
1147
1148         *e = NULL;
1149
1150         if (op->o_bd == NULL) {
1151                 rc = LDAP_NO_SUCH_OBJECT;
1152         } else if ( op->o_bd->be_fetch ) {
1153                 rc = ( op->o_bd->be_fetch )( op, ndn,
1154                         oc, at, rw, e );
1155         } else {
1156                 rc = LDAP_UNWILLING_TO_PERFORM;
1157         }
1158         return rc;
1159 }
1160
1161 int 
1162 backend_group(
1163         Operation *op,
1164         Entry   *target,
1165         struct berval *gr_ndn,
1166         struct berval *op_ndn,
1167         ObjectClass *group_oc,
1168         AttributeDescription *group_at
1169 )
1170 {
1171         Entry *e;
1172         Attribute *a;
1173         int rc;
1174         GroupAssertion *g;
1175         Backend *be = op->o_bd;
1176
1177         if ( op->o_abandon ) return SLAPD_ABANDON;
1178
1179         op->o_bd = select_backend( gr_ndn, 0, 0 );
1180
1181         ldap_pvt_thread_mutex_lock( &op->o_conn->c_mutex );
1182
1183         for (g = op->o_conn->c_groups; g; g=g->ga_next) {
1184                 if (g->ga_be != op->o_bd || g->ga_oc != group_oc ||
1185                         g->ga_at != group_at || g->ga_len != gr_ndn->bv_len)
1186                         continue;
1187                 if (strcmp( g->ga_ndn, gr_ndn->bv_val ) == 0)
1188                         break;
1189         }
1190
1191         ldap_pvt_thread_mutex_unlock( &op->o_conn->c_mutex );
1192
1193         if (g) {
1194                 rc = g->ga_res;
1195                 goto done;
1196         }
1197
1198         if ( target && dn_match( &target->e_nname, gr_ndn ) ) {
1199                 e = target;
1200         } else {
1201                 rc = be_entry_get_rw(op, gr_ndn, group_oc, group_at, 0, &e );
1202         }
1203         if ( e ) {
1204                 a = attr_find( e->e_attrs, group_at );
1205                 if ( a ) {
1206                         rc = value_find_ex( group_at,
1207                                 SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH |
1208                                 SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH,
1209                                 a->a_nvals, op_ndn, op->o_tmpmemctx );
1210                 } else {
1211                         rc = LDAP_NO_SUCH_ATTRIBUTE;
1212                 }
1213                 if (e != target ) {
1214                         be_entry_release_r( op, e );
1215                 }
1216         } else {
1217                 rc = LDAP_NO_SUCH_OBJECT;
1218         }
1219
1220         if ( op->o_tag != LDAP_REQ_BIND && !op->o_do_not_cache ) {
1221                 g = ch_malloc(sizeof(GroupAssertion) + gr_ndn->bv_len);
1222                 g->ga_be = op->o_bd;
1223                 g->ga_oc = group_oc;
1224                 g->ga_at = group_at;
1225                 g->ga_res = rc;
1226                 g->ga_len = gr_ndn->bv_len;
1227                 strcpy(g->ga_ndn, gr_ndn->bv_val);
1228                 ldap_pvt_thread_mutex_lock( &op->o_conn->c_mutex );
1229                 g->ga_next = op->o_conn->c_groups;
1230                 op->o_conn->c_groups = g;
1231                 ldap_pvt_thread_mutex_unlock( &op->o_conn->c_mutex );
1232         }
1233 done:
1234         op->o_bd = be;
1235         return rc;
1236 }
1237
1238 int 
1239 backend_attribute(
1240         Operation *op,
1241         Entry   *target,
1242         struct berval   *edn,
1243         AttributeDescription *entry_at,
1244         BerVarray *vals
1245 )
1246 {
1247         Entry *e;
1248         Attribute *a;
1249         int i, j, rc = LDAP_SUCCESS;
1250         AccessControlState acl_state = ACL_STATE_INIT;
1251         Backend *be = op->o_bd;
1252
1253         op->o_bd = select_backend( edn, 0, 0 );
1254
1255         if ( target && dn_match( &target->e_nname, edn ) ) {
1256                 e = target;
1257         } else {
1258                 rc = be_entry_get_rw(op, edn, NULL, entry_at, 0, &e );
1259         } 
1260
1261         if ( e ) {
1262                 a = attr_find( e->e_attrs, entry_at );
1263                 if ( a ) {
1264                         BerVarray v;
1265
1266                         if ( op->o_conn && access_allowed( op,
1267                                 e, entry_at, NULL, ACL_AUTH,
1268                                 &acl_state ) == 0 ) {
1269                                 rc = LDAP_INSUFFICIENT_ACCESS;
1270                                 goto freeit;
1271                         }
1272
1273                         for ( i=0; a->a_vals[i].bv_val; i++ ) ;
1274                         
1275                         v = op->o_tmpalloc( sizeof(struct berval) * (i+1), op->o_tmpmemctx );
1276                         for ( i=0,j=0; a->a_vals[i].bv_val; i++ ) {
1277                                 if ( op->o_conn && access_allowed( op,
1278                                         e, entry_at,
1279                                         &a->a_nvals[i],
1280                                         ACL_AUTH, &acl_state ) == 0 ) {
1281                                         continue;
1282                                 }
1283                                 ber_dupbv_x( &v[j],
1284                                         &a->a_nvals[i], op->o_tmpmemctx );
1285                                 if (v[j].bv_val ) j++;
1286                         }
1287                         if (j == 0) {
1288                                 op->o_tmpfree( v, op->o_tmpmemctx );
1289                                 *vals = NULL;
1290                                 rc = LDAP_INSUFFICIENT_ACCESS;
1291                         } else {
1292                                 v[j].bv_val = NULL;
1293                                 v[j].bv_len = 0;
1294                                 *vals = v;
1295                                 rc = LDAP_SUCCESS;
1296                         }
1297                 }
1298 freeit:         if (e != target ) {
1299                         be_entry_release_r( op, e );
1300                 }
1301         }
1302
1303         op->o_bd = be;
1304         return rc;
1305 }
1306
1307 Attribute *backend_operational(
1308         Operation *op,
1309         SlapReply *rs,
1310         int opattrs     )
1311 {
1312         Attribute *a = NULL, **ap = &a;
1313
1314         /*
1315          * If operational attributes (allegedly) are required, 
1316          * and the backend supports specific operational attributes, 
1317          * add them to the attribute list
1318          */
1319         if ( opattrs || ( op->ors_attrs &&
1320                 ad_inlist( slap_schema.si_ad_subschemaSubentry, op->ors_attrs )) ) {
1321                 *ap = slap_operational_subschemaSubentry( op->o_bd );
1322                 ap = &(*ap)->a_next;
1323         }
1324
1325         if ( ( opattrs || op->ors_attrs ) && op->o_bd && op->o_bd->be_operational != NULL ) {
1326                 ( void )op->o_bd->be_operational( op, rs, opattrs, ap );
1327         }
1328
1329         return a;
1330 }
1331