]> git.sur5r.net Git - openldap/blob - servers/slapd/backover.c
fix overlay access control; cleanup
[openldap] / servers / slapd / backover.c
1 /* backover.c - backend overlay routines */
2 /* $OpenLDAP$ */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4  *
5  * Copyright 2003-2005 The OpenLDAP Foundation.
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
17 /* Functions to overlay other modules over a backend. */
18
19 #include "portable.h"
20
21 #include <stdio.h>
22
23 #include <ac/string.h>
24 #include <ac/socket.h>
25
26 #define SLAPD_TOOLS
27 #include "slap.h"
28
29 static slap_overinst *overlays;
30
31 enum db_which { db_open = 0, db_close, db_destroy };
32
33 static int
34 over_db_func(
35         BackendDB *be,
36         enum db_which which
37 )
38 {
39         slap_overinfo *oi = be->bd_info->bi_private;
40         slap_overinst *on = oi->oi_list;
41         BackendInfo *bi_orig = be->bd_info;
42         BI_db_open **func;
43         int rc = 0;
44
45         func = &oi->oi_orig->bi_db_open;
46         if ( func[which] ) {
47                 be->bd_info = oi->oi_orig;
48                 rc = func[which]( be );
49         }
50
51         for (; on && rc == 0; on=on->on_next) {
52                 be->bd_info = &on->on_bi;
53                 func = &on->on_bi.bi_db_open;
54                 if (func[which]) {
55                         rc = func[which]( be );
56                 }
57         }
58         be->bd_info = bi_orig;
59         return rc;
60 }
61
62 static int
63 over_db_config(
64         BackendDB *be,
65         const char *fname,
66         int lineno,
67         int argc,
68         char **argv
69 )
70 {
71         slap_overinfo *oi = be->bd_info->bi_private;
72         slap_overinst *on = oi->oi_list;
73         BackendInfo *bi_orig = be->bd_info;
74         int rc = 0;
75
76         if ( oi->oi_orig->bi_db_config ) {
77                 be->bd_info = oi->oi_orig;
78                 rc = oi->oi_orig->bi_db_config( be, fname, lineno,
79                         argc, argv );
80
81                 if ( be->bd_info != oi->oi_orig ) {
82                         slap_overinfo   *oi2;
83                         slap_overinst   *on2, **onp;
84                         BackendDB       be2 = *be;
85                         int             i;
86
87                         /* a database added an overlay;
88                          * work it around... */
89                         assert( overlay_is_over( be ) );
90                         
91                         oi2 = ( slap_overinfo * )be->bd_info->bi_private;
92                         on2 = oi2->oi_list;
93
94                         /* need to put a uniqueness check here as well;
95                          * note that in principle there could be more than
96                          * one overlay as a result of multiple calls to
97                          * overlay_config() */
98                         be2.bd_info = (BackendInfo *)oi;
99
100                         for ( i = 0, onp = &on2; *onp; i++, onp = &(*onp)->on_next ) {
101                                 if ( overlay_is_inst( &be2, (*onp)->on_bi.bi_type ) ) {
102                                         Debug( LDAP_DEBUG_ANY, "over_db_config(): "
103                                                         "warning, freshly added "
104                                                         "overlay #%d \"%s\" is already in list\n",
105                                                         i, (*onp)->on_bi.bi_type, 0 );
106
107                                         /* NOTE: if the overlay already exists,
108                                          * there is no way to merge the results
109                                          * of the configuration that may have 
110                                          * occurred during bi_db_config(); we
111                                          * just issue a warning, and the 
112                                          * administrator should deal with this */
113                                 }
114                         }
115                         *onp = oi->oi_list;
116
117                         oi->oi_list = on2;
118
119                         ch_free( be->bd_info );
120                 }
121
122                 be->bd_info = (BackendInfo *)oi;
123                 if ( rc != SLAP_CONF_UNKNOWN ) return rc;
124         }
125
126         for (; on; on=on->on_next) {
127                 if (on->on_bi.bi_db_config) {
128                         be->bd_info = &on->on_bi;
129                         rc = on->on_bi.bi_db_config( be, fname, lineno,
130                                 argc, argv );
131                         if ( rc != SLAP_CONF_UNKNOWN ) break;
132                 }
133         }
134         be->bd_info = bi_orig;
135         return rc;
136 }
137
138 static int
139 over_db_open(
140         BackendDB *be
141 )
142 {
143         return over_db_func( be, db_open );
144 }
145
146 static int
147 over_db_close(
148         BackendDB *be
149 )
150 {
151         slap_overinfo *oi = be->bd_info->bi_private;
152         slap_overinst *on = oi->oi_list;
153         BackendInfo *bi_orig = be->bd_info;
154         int rc = 0;
155
156         for (; on && rc == 0; on=on->on_next) {
157                 be->bd_info = &on->on_bi;
158                 if ( be->bd_info->bi_db_close ) {
159                         rc = be->bd_info->bi_db_close( be );
160                 }
161         }
162
163         if ( oi->oi_orig->bi_db_close ) {
164                 be->bd_info = oi->oi_orig;
165                 rc = be->bd_info->bi_db_close( be );
166         }
167
168         be->bd_info = bi_orig;
169         return rc;
170 }
171
172 static int
173 over_db_destroy(
174         BackendDB *be
175 )
176 {
177         slap_overinfo *oi = be->bd_info->bi_private;
178         slap_overinst *on = oi->oi_list, *next;
179         int rc;
180
181         rc = over_db_func( be, db_destroy );
182
183         for (next = on->on_next; on; on=next) {
184                 next = on->on_next;
185                 free( on );
186         }
187         free( oi );
188         return rc;
189 }
190
191 static int
192 over_back_response ( Operation *op, SlapReply *rs )
193 {
194         slap_overinfo *oi = op->o_callback->sc_private;
195         slap_overinst *on = oi->oi_list;
196         int rc = SLAP_CB_CONTINUE;
197         BackendDB *be = op->o_bd, db = *op->o_bd;
198
199         db.be_flags |= SLAP_DBFLAG_OVERLAY;
200         op->o_bd = &db;
201         for (; on; on=on->on_next ) {
202                 if ( on->on_response ) {
203                         db.bd_info = (BackendInfo *)on;
204                         rc = on->on_response( op, rs );
205                         if ( rc != SLAP_CB_CONTINUE ) break;
206                 }
207         }
208         op->o_bd = be;
209         return rc;
210 }
211
212 enum op_which {
213         op_bind = 0,
214         op_unbind,
215         op_search,
216         op_compare,
217         op_modify,
218         op_modrdn,
219         op_add,
220         op_delete,
221         op_abandon,
222         op_cancel,
223         op_extended,
224         op_aux_operational,
225         op_aux_chk_referrals,
226         op_aux_chk_controls,
227         op_last
228 };
229
230 /*
231  * default return code in case of missing backend function
232  * and overlay stack returning SLAP_CB_CONTINUE
233  */
234 static int op_rc[] = {
235         LDAP_UNWILLING_TO_PERFORM,      /* bind */
236         LDAP_UNWILLING_TO_PERFORM,      /* unbind */
237         LDAP_UNWILLING_TO_PERFORM,      /* search */
238         SLAP_CB_CONTINUE,               /* compare; pass to frontend */
239         LDAP_UNWILLING_TO_PERFORM,      /* modify */
240         LDAP_UNWILLING_TO_PERFORM,      /* modrdn */
241         LDAP_UNWILLING_TO_PERFORM,      /* add */
242         LDAP_UNWILLING_TO_PERFORM,      /* delete */
243         LDAP_UNWILLING_TO_PERFORM,      /* abandon */
244         LDAP_UNWILLING_TO_PERFORM,      /* cancel */
245         LDAP_UNWILLING_TO_PERFORM,      /* extended */
246         LDAP_SUCCESS,                   /* aux_operational */
247         LDAP_SUCCESS,                   /* aux_chk_referrals */
248         SLAP_CB_CONTINUE                /* aux_chk_controls; pass to frontend */
249 };
250
251 #ifdef SLAP_OVERLAY_ACCESS
252 static int
253 over_access_allowed(
254         Operation               *op,
255         Entry                   *e,
256         AttributeDescription    *desc,
257         struct berval           *val,
258         slap_access_t           access,
259         AccessControlState      *state,
260         slap_mask_t             *maskp )
261 {
262         slap_overinfo *oi;
263         slap_overinst *on;
264         BackendInfo *bi = op->o_bd->bd_info;
265         BackendDB *be = op->o_bd, db;
266         int rc = SLAP_CB_CONTINUE;
267
268         /* FIXME: used to happen for instance during abandon
269          * when global overlays are used... */
270         assert( op->o_bd != NULL );
271
272         oi = op->o_bd->bd_info->bi_private;
273         on = oi->oi_list;
274
275         for ( ; on; on = on->on_next ) {
276                 if ( on->on_bi.bi_access_allowed ) {
277                         /* NOTE: do not copy the structure until required */
278                         if ( !SLAP_ISOVERLAY( op->o_bd ) ) {
279                                 db = *op->o_bd;
280                                 db.be_flags |= SLAP_DBFLAG_OVERLAY;
281                                 op->o_bd = &db;
282                         }
283
284                         op->o_bd->bd_info = (BackendInfo *)on;
285                         rc = on->on_bi.bi_access_allowed( op, e,
286                                 desc, val, access, state, maskp );
287                         if ( rc != SLAP_CB_CONTINUE ) break;
288                 }
289         }
290
291         if ( rc == SLAP_CB_CONTINUE ) {
292                 BI_access_allowed       *bi_access_allowed;
293
294                 /* if the database structure was changed, o_bd points to a
295                  * copy of the structure; put the original bd_info in place */
296                 if ( SLAP_ISOVERLAY( op->o_bd ) ) {
297                         op->o_bd->bd_info = oi->oi_orig;
298                 }
299
300                 if ( oi->oi_orig->bi_access_allowed ) {
301                         bi_access_allowed = oi->oi_orig->bi_access_allowed;
302                 } else {
303                         bi_access_allowed = slap_access_allowed;
304                 }
305
306                 rc = bi_access_allowed( op, e,
307                         desc, val, access, state, maskp );
308         }
309         /* should not fall thru this far without anything happening... */
310         if ( rc == SLAP_CB_CONTINUE ) {
311                 /* access not allowed */
312                 rc = 0;
313         }
314
315         op->o_bd = be;
316         op->o_bd->bd_info = bi;
317
318         return rc;
319 }
320 #endif /* SLAP_OVERLAY_ACCESS */
321
322 static int
323 over_op_func(
324         Operation *op,
325         SlapReply *rs,
326         enum op_which which
327 )
328 {
329         slap_overinfo *oi;
330         slap_overinst *on;
331         BI_op_bind **func;
332         BackendDB *be = op->o_bd, db;
333         slap_callback cb = {NULL, over_back_response, NULL, NULL};
334         int rc = SLAP_CB_CONTINUE;
335
336         /* FIXME: used to happen for instance during abandon
337          * when global overlays are used... */
338         assert( op->o_bd != NULL );
339
340         oi = op->o_bd->bd_info->bi_private;
341         on = oi->oi_list;
342
343         if ( !SLAP_ISOVERLAY( op->o_bd )) {
344                 db = *op->o_bd;
345                 db.be_flags |= SLAP_DBFLAG_OVERLAY;
346                 op->o_bd = &db;
347         }
348         cb.sc_next = op->o_callback;
349         cb.sc_private = oi;
350         op->o_callback = &cb;
351
352         for (; on; on=on->on_next ) {
353                 func = &on->on_bi.bi_op_bind;
354                 if ( func[which] ) {
355                         op->o_bd->bd_info = (BackendInfo *)on;
356                         rc = func[which]( op, rs );
357                         if ( rc != SLAP_CB_CONTINUE ) break;
358                 }
359         }
360
361         func = &oi->oi_orig->bi_op_bind;
362         if ( func[which] && rc == SLAP_CB_CONTINUE ) {
363                 op->o_bd->bd_info = oi->oi_orig;
364                 rc = func[which]( op, rs );
365         }
366         /* should not fall thru this far without anything happening... */
367         if ( rc == SLAP_CB_CONTINUE ) {
368                 rc = op_rc[ which ];
369         }
370
371         /* The underlying backend didn't handle the request, make sure
372          * overlay cleanup is processed.
373          */
374         if ( rc == LDAP_UNWILLING_TO_PERFORM ) {
375                 slap_callback *sc_next;
376                 for ( ; op->o_callback && op->o_callback != cb.sc_next; 
377                         op->o_callback = sc_next ) {
378                         sc_next = op->o_callback->sc_next;
379                         if ( op->o_callback->sc_cleanup ) {
380                                 op->o_callback->sc_cleanup( op, rs );
381                         }
382                 }
383         }
384         op->o_bd = be;
385         op->o_callback = cb.sc_next;
386         return rc;
387 }
388
389 static int
390 over_op_bind( Operation *op, SlapReply *rs )
391 {
392         return over_op_func( op, rs, op_bind );
393 }
394
395 static int
396 over_op_unbind( Operation *op, SlapReply *rs )
397 {
398         return over_op_func( op, rs, op_unbind );
399 }
400
401 static int
402 over_op_search( Operation *op, SlapReply *rs )
403 {
404         return over_op_func( op, rs, op_search );
405 }
406
407 static int
408 over_op_compare( Operation *op, SlapReply *rs )
409 {
410         return over_op_func( op, rs, op_compare );
411 }
412
413 static int
414 over_op_modify( Operation *op, SlapReply *rs )
415 {
416         return over_op_func( op, rs, op_modify );
417 }
418
419 static int
420 over_op_modrdn( Operation *op, SlapReply *rs )
421 {
422         return over_op_func( op, rs, op_modrdn );
423 }
424
425 static int
426 over_op_add( Operation *op, SlapReply *rs )
427 {
428         return over_op_func( op, rs, op_add );
429 }
430
431 static int
432 over_op_delete( Operation *op, SlapReply *rs )
433 {
434         return over_op_func( op, rs, op_delete );
435 }
436
437 static int
438 over_op_abandon( Operation *op, SlapReply *rs )
439 {
440         return over_op_func( op, rs, op_abandon );
441 }
442
443 static int
444 over_op_cancel( Operation *op, SlapReply *rs )
445 {
446         return over_op_func( op, rs, op_cancel );
447 }
448
449 static int
450 over_op_extended( Operation *op, SlapReply *rs )
451 {
452         return over_op_func( op, rs, op_extended );
453 }
454
455 static int
456 over_aux_operational( Operation *op, SlapReply *rs )
457 {
458         return over_op_func( op, rs, op_aux_operational );
459 }
460
461 static int
462 over_aux_chk_referrals( Operation *op, SlapReply *rs )
463 {
464         return over_op_func( op, rs, op_aux_chk_referrals );
465 }
466
467 static int
468 over_aux_chk_controls( Operation *op, SlapReply *rs )
469 {
470         return over_op_func( op, rs, op_aux_chk_controls );
471 }
472
473 static int
474 over_connection_destroy(
475         BackendDB       *bd,
476         Connection      *conn
477 )
478 {
479         slap_overinfo *oi;
480         slap_overinst *on;
481         BackendDB db;
482         int rc = SLAP_CB_CONTINUE;
483
484         /* FIXME: used to happen for instance during abandon
485          * when global overlays are used... */
486         assert( bd != NULL );
487
488         oi = bd->bd_info->bi_private;
489         on = oi->oi_list;
490
491         if ( !SLAP_ISOVERLAY( bd )) {
492                 db = *bd;
493                 db.be_flags |= SLAP_DBFLAG_OVERLAY;
494                 bd = &db;
495         }
496
497         for (; on; on=on->on_next ) {
498                 if ( on->on_bi.bi_connection_destroy ) {
499                         bd->bd_info = (BackendInfo *)on;
500                         rc = on->on_bi.bi_connection_destroy( bd, conn );
501                         if ( rc != SLAP_CB_CONTINUE ) break;
502                 }
503         }
504
505         if ( oi->oi_orig->bi_connection_destroy && rc == SLAP_CB_CONTINUE ) {
506                 bd->bd_info = oi->oi_orig;
507                 rc = oi->oi_orig->bi_connection_destroy( bd, conn );
508         }
509         /* should not fall thru this far without anything happening... */
510         if ( rc == SLAP_CB_CONTINUE ) {
511                 rc = LDAP_UNWILLING_TO_PERFORM;
512         }
513
514         return rc;
515 }
516
517 int
518 overlay_register(
519         slap_overinst *on
520 )
521 {
522         on->on_next = overlays;
523         overlays = on;
524         return 0;
525 }
526
527 /*
528  * iterator on registered overlays; overlay_next( NULL ) returns the first
529  * overlay; * subsequent calls with the previously returned value allow to 
530  * iterate * over the entire list; returns NULL when no more overlays are 
531  * registered.
532  */
533
534 slap_overinst *
535 overlay_next(
536         slap_overinst *on
537 )
538 {
539         if ( on == NULL ) {
540                 return overlays;
541         }
542
543         return on->on_next;
544 }
545
546 /*
547  * returns a specific registered overlay based on the type; NULL if not
548  * registered.
549  */
550
551 slap_overinst *
552 overlay_find( const char *over_type )
553 {
554         slap_overinst *on = overlays;
555
556         assert( over_type );
557
558         for ( ; on; on = on->on_next ) {
559                 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
560                         break;
561                 }
562         }
563
564         return on;
565 }
566
567 static const char overtype[] = "over";
568
569 /*
570  * returns TRUE (1) if the database is actually an overlay instance;
571  * FALSE (0) otherwise.
572  */
573
574 int
575 overlay_is_over( BackendDB *be )
576 {
577         return be->bd_info->bi_type == overtype;
578 }
579
580 /*
581  * returns TRUE (1) if the given database is actually an overlay
582  * instance and, somewhere in the list, contains the requested overlay;
583  * FALSE (0) otherwise.
584  */
585
586 int
587 overlay_is_inst( BackendDB *be, const char *over_type )
588 {
589         slap_overinst   *on;
590
591         assert( be );
592
593         if ( !overlay_is_over( be ) ) {
594                 return 0;
595         }
596         
597         on = ((slap_overinfo *)be->bd_info->bi_private)->oi_list;
598         for ( ; on; on = on->on_next ) {
599                 if ( strcmp( on->on_bi.bi_type, over_type ) == 0 ) {
600                         return 1;
601                 }
602         }
603
604         return 0;
605 }
606
607 int
608 overlay_register_control( BackendDB *be, const char *oid )
609 {
610         int             rc = 0;
611         int             gotit = 0;
612         int             cid;
613
614         if ( slap_find_control_id( oid, &cid ) == LDAP_CONTROL_NOT_FOUND ) {
615                 return -1;
616         }
617
618         if ( SLAP_DBFLAGS( be ) & SLAP_DBFLAG_GLOBAL_OVERLAY ) {
619                 BackendDB *bd;
620                 
621                 /* add to all backends... */
622                 LDAP_STAILQ_FOREACH( bd, &backendDB, be_next ) {
623                         if ( be == bd ) {
624                                 gotit = 1;
625                         }
626
627                         bd->be_ctrls[ cid ] = 1;
628                         bd->be_ctrls[ SLAP_MAX_CIDS ] = 1;
629                 }
630
631         }
632         
633         if ( rc == 0 && !gotit ) {
634                 be->be_ctrls[ cid ] = 1;
635                 be->be_ctrls[ SLAP_MAX_CIDS ] = 1;
636         }
637
638         return rc;
639 }
640
641 /* add an overlay to a particular backend. */
642 int
643 overlay_config( BackendDB *be, const char *ov )
644 {
645         slap_overinst *on = NULL, *on2 = NULL;
646         slap_overinfo *oi = NULL;
647         BackendInfo *bi = NULL;
648
649         on = overlay_find( ov );
650         if ( !on ) {
651                 Debug( LDAP_DEBUG_ANY, "overlay \"%s\" not found\n", ov, 0, 0 );
652                 return 1;
653         }
654
655         /* If this is the first overlay on this backend, set up the
656          * overlay info structure
657          */
658         if ( !overlay_is_over( be ) ) {
659                 oi = ch_malloc( sizeof( slap_overinfo ) );
660                 oi->oi_orig = be->bd_info;
661                 oi->oi_bi = *be->bd_info;
662
663                 /* NOTE: the first time a global overlay is configured,
664                  * frontendDB gets this flag; it is used later by overlays
665                  * to determine if they're stacked on top of the frontendDB */
666                 if ( oi->oi_orig == frontendDB->bd_info ) {
667                         SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_GLOBAL_OVERLAY;
668                 }
669
670                 /* Save a pointer to ourself in bi_private.
671                  */
672                 oi->oi_bi.bi_private = oi;
673                 oi->oi_list = NULL;
674                 bi = (BackendInfo *)oi;
675
676                 bi->bi_type = (char *)overtype;
677
678                 bi->bi_db_config = over_db_config;
679                 bi->bi_db_open = over_db_open;
680                 bi->bi_db_close = over_db_close;
681                 bi->bi_db_destroy = over_db_destroy;
682
683                 bi->bi_op_bind = over_op_bind;
684                 bi->bi_op_unbind = over_op_unbind;
685                 bi->bi_op_search = over_op_search;
686                 bi->bi_op_compare = over_op_compare;
687                 bi->bi_op_modify = over_op_modify;
688                 bi->bi_op_modrdn = over_op_modrdn;
689                 bi->bi_op_add = over_op_add;
690                 bi->bi_op_delete = over_op_delete;
691                 bi->bi_op_abandon = over_op_abandon;
692                 bi->bi_op_cancel = over_op_cancel;
693
694                 bi->bi_extended = over_op_extended;
695
696                 /*
697                  * this is fine because it has the same
698                  * args of the operations; we need to rework
699                  * all the hooks to share the same args
700                  * of the operations...
701                  */
702                 bi->bi_operational = over_aux_operational;
703                 bi->bi_chk_referrals = over_aux_chk_referrals;
704                 bi->bi_chk_controls = over_aux_chk_controls;
705
706 #ifdef SLAP_OVERLAY_ACCESS
707                 /* this has a specific arglist */
708                 bi->bi_access_allowed = over_access_allowed;
709 #endif /* SLAP_OVERLAY_ACCESS */
710                 
711                 bi->bi_connection_destroy = over_connection_destroy;
712
713                 be->bd_info = bi;
714
715         } else {
716                 if ( overlay_is_inst( be, ov ) ) {
717                         Debug( LDAP_DEBUG_ANY, "overlay_config(): "
718                                         "warning, overlay \"%s\" "
719                                         "already in list\n", ov, 0, 0 );
720                 }
721
722                 oi = be->bd_info->bi_private;
723         }
724
725         /* Insert new overlay on head of list. Overlays are executed
726          * in reverse of config order...
727          */
728         on2 = ch_calloc( 1, sizeof(slap_overinst) );
729         *on2 = *on;
730         on2->on_info = oi;
731         on2->on_next = oi->oi_list;
732         oi->oi_list = on2;
733
734         /* Any initialization needed? */
735         if ( on->on_bi.bi_db_init ) {
736                 int rc;
737                 be->bd_info = (BackendInfo *)on2;
738                 rc = on2->on_bi.bi_db_init( be );
739                 be->bd_info = (BackendInfo *)oi;
740                 if ( rc ) return rc;
741         }
742
743         return 0;
744 }
745