]> git.sur5r.net Git - openldap/blob - servers/slapd/root_dse.c
20178f17adf9a4cbe0c1c46898685a86734af54e
[openldap] / servers / slapd / root_dse.c
1 /* root_dse.c - Provides the Root DSA-Specific Entry */
2 /* $OpenLDAP$ */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4  *
5  * Copyright 1999-2011 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 #include "portable.h"
18
19 #include <stdio.h>
20
21 #include <ac/string.h>
22
23 #include "slap.h"
24 #include <ldif.h>
25 #include "lber_pvt.h"
26
27 #ifdef LDAP_SLAPI
28 #include "slapi/slapi.h"
29 #endif
30
31 static struct berval    builtin_supportedFeatures[] = {
32         BER_BVC(LDAP_FEATURE_MODIFY_INCREMENT),         /* Modify/increment */
33         BER_BVC(LDAP_FEATURE_ALL_OP_ATTRS),             /* All Op Attrs (+) */
34         BER_BVC(LDAP_FEATURE_OBJECTCLASS_ATTRS),        /* OCs in Attrs List (@class) */
35         BER_BVC(LDAP_FEATURE_ABSOLUTE_FILTERS),         /* (&) and (|) search filters */
36         BER_BVC(LDAP_FEATURE_LANGUAGE_TAG_OPTIONS),     /* Language Tag Options */
37         BER_BVC(LDAP_FEATURE_LANGUAGE_RANGE_OPTIONS),   /* Language Range Options */
38 #ifdef LDAP_DEVEL
39         BER_BVC(LDAP_FEATURE_SUBORDINATE_SCOPE),        /* "children" search scope */
40 #endif
41         BER_BVNULL
42 };
43 static struct berval    *supportedFeatures;
44
45 static Entry    *usr_attr = NULL;
46
47 /*
48  * allow modules to register functions that muck with the root DSE entry
49  */
50
51 typedef struct entry_info_t {
52         SLAP_ENTRY_INFO_FN      func;
53         void                    *arg;
54         struct entry_info_t     *next;
55 } entry_info_t;
56
57 static entry_info_t *extra_info;
58
59 int
60 entry_info_register( SLAP_ENTRY_INFO_FN func, void *arg )
61 {
62         entry_info_t    *ei = ch_calloc( 1, sizeof( entry_info_t ) );
63
64         ei->func = func;
65         ei->arg = arg;
66
67         ei->next = extra_info;
68         extra_info = ei;
69
70         return 0;
71 }
72
73 int
74 entry_info_unregister( SLAP_ENTRY_INFO_FN func, void *arg )
75 {
76         entry_info_t    **eip;
77
78         for ( eip = &extra_info; *eip != NULL; eip = &(*eip)->next ) {
79                 if ( (*eip)->func == func && (*eip)->arg == arg ) {
80                         entry_info_t    *ei = *eip;
81
82                         *eip = ei->next;
83
84                         ch_free( ei );
85
86                         return 0;
87                 }
88         }
89
90         return -1;
91 }
92
93 void
94 entry_info_destroy( void )
95 {
96         entry_info_t    **eip;
97
98         for ( eip = &extra_info; *eip != NULL;  ) {
99                 entry_info_t    *ei = *eip;
100
101                 eip = &(*eip)->next;
102
103                 ch_free( ei );
104         }
105 }
106
107 /*
108  * Allow modules to register supported features
109  */
110
111 static int
112 supported_feature_init( void )
113 {
114         int             i;
115
116         if ( supportedFeatures != NULL ) {
117                 return 0;
118         }
119
120         for ( i = 0; !BER_BVISNULL( &builtin_supportedFeatures[ i ] ); i++ )
121                 ;
122
123         supportedFeatures = ch_calloc( sizeof( struct berval ), i + 1 );
124         if ( supportedFeatures == NULL ) {
125                 return -1;
126         }
127
128         for ( i = 0; !BER_BVISNULL( &builtin_supportedFeatures[ i ] ); i++ ) {
129                 ber_dupbv( &supportedFeatures[ i ], &builtin_supportedFeatures[ i ] );
130         }
131         BER_BVZERO( &supportedFeatures[ i ] );
132
133         return 0;
134 }
135
136 int
137 supported_feature_destroy( void )
138 {
139         int             i;
140
141         if ( supportedFeatures == NULL ) {
142                 return 0;
143         }
144         
145         for ( i = 0; !BER_BVISNULL( &supportedFeatures[ i ] ); i++ ) {
146                 ch_free( supportedFeatures[ i ].bv_val );
147         }
148
149         ch_free( supportedFeatures );
150         supportedFeatures = NULL;
151
152         return 0;
153 }
154
155 int
156 supported_feature_load( struct berval *f )
157 {
158         struct berval   *tmp;
159         int             i;
160
161         supported_feature_init();
162
163         for ( i = 0; !BER_BVISNULL( &supportedFeatures[ i ] ); i++ )
164                 ;
165
166         tmp = ch_realloc( supportedFeatures, sizeof( struct berval ) * ( i + 2 ) );
167         if ( tmp == NULL ) {
168                 return -1;
169         }
170         supportedFeatures = tmp;
171
172         ber_dupbv( &supportedFeatures[ i ], f );
173         BER_BVZERO( &supportedFeatures[ i + 1 ] );
174
175         return 0;
176 }
177
178 int
179 root_dse_info(
180         Connection *conn,
181         Entry **entry,
182         const char **text )
183 {
184         Entry           *e;
185         struct berval val;
186 #ifdef LDAP_SLAPI
187         struct berval *bv;
188 #endif
189         int             i, j;
190         char ** supportedSASLMechanisms;
191         BackendDB *be;
192
193         AttributeDescription *ad_structuralObjectClass
194                 = slap_schema.si_ad_structuralObjectClass;
195         AttributeDescription *ad_objectClass
196                 = slap_schema.si_ad_objectClass;
197         AttributeDescription *ad_namingContexts
198                 = slap_schema.si_ad_namingContexts;
199 #ifdef LDAP_SLAPI
200         AttributeDescription *ad_supportedExtension
201                 = slap_schema.si_ad_supportedExtension;
202 #endif
203         AttributeDescription *ad_supportedLDAPVersion
204                 = slap_schema.si_ad_supportedLDAPVersion;
205         AttributeDescription *ad_supportedSASLMechanisms
206                 = slap_schema.si_ad_supportedSASLMechanisms;
207         AttributeDescription *ad_supportedFeatures
208                 = slap_schema.si_ad_supportedFeatures;
209         AttributeDescription *ad_monitorContext
210                 = slap_schema.si_ad_monitorContext;
211         AttributeDescription *ad_configContext
212                 = slap_schema.si_ad_configContext;
213         AttributeDescription *ad_ref
214                 = slap_schema.si_ad_ref;
215
216         e = entry_alloc();
217         if( e == NULL ) {
218                 Debug( LDAP_DEBUG_ANY,
219                         "root_dse_info: entry_alloc failed", 0, 0, 0 );
220                 return LDAP_OTHER;
221         }
222
223         e->e_attrs = NULL;
224         e->e_name.bv_val = ch_strdup( LDAP_ROOT_DSE );
225         e->e_name.bv_len = sizeof( LDAP_ROOT_DSE )-1;
226         e->e_nname.bv_val = ch_strdup( LDAP_ROOT_DSE );
227         e->e_nname.bv_len = sizeof( LDAP_ROOT_DSE )-1;
228
229         /* the DN is an empty string so no pretty/normalization is needed */
230         assert( !e->e_name.bv_len );
231         assert( !e->e_nname.bv_len );
232
233         e->e_private = NULL;
234
235         /* FIXME: is this really needed? */
236         BER_BVSTR( &val, "top" );
237         if( attr_merge_one( e, ad_objectClass, &val, NULL ) ) {
238 fail:
239                 entry_free( e );
240                 return LDAP_OTHER;
241         }
242
243         BER_BVSTR( &val, "OpenLDAProotDSE" );
244         if( attr_merge_one( e, ad_objectClass, &val, NULL ) ) {
245                 goto fail;
246         }
247         if( attr_merge_one( e, ad_structuralObjectClass, &val, NULL ) ) {
248                 goto fail;
249         }
250
251         LDAP_STAILQ_FOREACH( be, &backendDB, be_next ) {
252                 if ( be->be_suffix == NULL
253                                 || be->be_nsuffix == NULL ) {
254                         /* no suffix! */
255                         continue;
256                 }
257                 if ( SLAP_MONITOR( be )) {
258                         if( attr_merge_one( e, ad_monitorContext,
259                                         &be->be_suffix[0],
260                                         &be->be_nsuffix[0] ) )
261                         {
262                                 goto fail;
263                         }
264                         continue;
265                 }
266                 if ( SLAP_CONFIG( be )) {
267                         if( attr_merge_one( e, ad_configContext,
268                                         &be->be_suffix[0],
269                                         & be->be_nsuffix[0] ) )
270                         {
271                                 goto fail;
272                         }
273                         continue;
274                 }
275                 if ( SLAP_GLUE_SUBORDINATE( be ) && !SLAP_GLUE_ADVERTISE( be ) ) {
276                         continue;
277                 }
278                 for ( j = 0; be->be_suffix[j].bv_val != NULL; j++ ) {
279                         if( attr_merge_one( e, ad_namingContexts,
280                                         &be->be_suffix[j], NULL ) )
281                         {
282                                 goto fail;
283                         }
284                 }
285         }
286
287         /* altServer unsupported */
288
289         /* supportedControl */
290         if ( controls_root_dse_info( e ) != 0 ) {
291                 goto fail;
292         }
293
294         /* supportedExtension */
295         if ( exop_root_dse_info( e ) != 0 ) {
296                 goto fail;
297         }
298
299 #ifdef LDAP_SLAPI
300         /* netscape supportedExtension */
301         for ( i = 0; (bv = slapi_int_get_supported_extop(i)) != NULL; i++ ) {
302                 if( attr_merge_one( e, ad_supportedExtension, bv, NULL ) ) {
303                         goto fail;
304                 }
305         }
306 #endif /* LDAP_SLAPI */
307
308         /* supportedFeatures */
309         if ( supportedFeatures == NULL ) {
310                 supported_feature_init();
311         }
312
313         if( attr_merge( e, ad_supportedFeatures, supportedFeatures, NULL ) ) {
314                 goto fail;
315         }
316
317         /* supportedLDAPVersion */
318                 /* don't publish version 2 as we don't really support it
319                  * (even when configured to accept version 2 Bind requests)
320                  * and the value would never be used by true LDAPv2 (or LDAPv3)
321                  * clients.
322                  */
323         for ( i=LDAP_VERSION3; i<=LDAP_VERSION_MAX; i++ ) {
324                 char buf[sizeof("255")];
325                 snprintf(buf, sizeof buf, "%d", i);
326                 val.bv_val = buf;
327                 val.bv_len = strlen( val.bv_val );
328                 if( attr_merge_one( e, ad_supportedLDAPVersion, &val, NULL ) ) {
329                         goto fail;
330                 }
331         }
332
333         /* supportedSASLMechanism */
334         supportedSASLMechanisms = slap_sasl_mechs( conn );
335
336         if( supportedSASLMechanisms != NULL ) {
337                 for ( i=0; supportedSASLMechanisms[i] != NULL; i++ ) {
338                         val.bv_val = supportedSASLMechanisms[i];
339                         val.bv_len = strlen( val.bv_val );
340                         if( attr_merge_one( e, ad_supportedSASLMechanisms, &val, NULL ) ) {
341                                 ldap_charray_free( supportedSASLMechanisms );
342                                 goto fail;
343                         }
344                 }
345                 ldap_charray_free( supportedSASLMechanisms );
346         }
347
348         if ( default_referral != NULL ) {
349                 if( attr_merge( e, ad_ref, default_referral, NULL /* FIXME */ ) ) {
350                         goto fail;
351                 }
352         }
353
354         if( usr_attr != NULL) {
355                 Attribute *a;
356                 for( a = usr_attr->e_attrs; a != NULL; a = a->a_next ) {
357                         if( attr_merge( e, a->a_desc, a->a_vals,
358                                 (a->a_nvals == a->a_vals) ? NULL : a->a_nvals ) )
359                         {
360                                 goto fail;
361                         }
362                 }
363         }
364
365         if ( extra_info ) {
366                 entry_info_t    *ei = extra_info;
367
368                 for ( ; ei; ei = ei->next ) {
369                         ei->func( ei->arg, e );
370                 }
371         }
372
373         *entry = e;
374         return LDAP_SUCCESS;
375 }
376
377 int
378 root_dse_init( void )
379 {
380         return 0;
381 }
382
383 int
384 root_dse_destroy( void )
385 {
386         if ( usr_attr ) {
387                 entry_free( usr_attr );
388                 usr_attr = NULL;
389         }
390
391         return 0;
392 }
393
394 /*
395  * Read the entries specified in fname and merge the attributes
396  * to the user defined rootDSE. Note thaat if we find any errors
397  * what so ever, we will discard the entire entries, print an
398  * error message and return.
399  */
400 int
401 root_dse_read_file( const char *fname )
402 {
403         struct LDIFFP   *fp;
404         int rc = 0, lineno = 0, lmax = 0, ldifrc;
405         char    *buf = NULL;
406
407         if ( (fp = ldif_open( fname, "r" )) == NULL ) {
408                 Debug( LDAP_DEBUG_ANY,
409                         "root_dse_read_file: could not open rootdse attr file \"%s\" - absolute path?\n",
410                         fname, 0, 0 );
411                 perror( fname );
412                 return EXIT_FAILURE;
413         }
414
415         usr_attr = entry_alloc();
416         if( usr_attr == NULL ) {
417                 Debug( LDAP_DEBUG_ANY,
418                         "root_dse_read_file: entry_alloc failed", 0, 0, 0 );
419                 ldif_close( fp );
420                 return LDAP_OTHER;
421         }
422         usr_attr->e_attrs = NULL;
423
424         while(( ldifrc = ldif_read_record( fp, &lineno, &buf, &lmax )) > 0 ) {
425                 Entry *e = str2entry( buf );
426                 Attribute *a;
427
428                 if( e == NULL ) {
429                         Debug( LDAP_DEBUG_ANY, "root_dse_read_file: "
430                                 "could not parse entry (file=\"%s\" line=%d)\n",
431                                 fname, lineno, 0 );
432                         rc = LDAP_OTHER;
433                         break;
434                 }
435
436                 /* make sure the DN is the empty DN */
437                 if( e->e_nname.bv_len ) {
438                         Debug( LDAP_DEBUG_ANY,
439                                 "root_dse_read_file: invalid rootDSE "
440                                 "- dn=\"%s\" (file=\"%s\" line=%d)\n",
441                                 e->e_dn, fname, lineno );
442                         entry_free( e );
443                         rc = LDAP_OTHER;
444                         break;
445                 }
446
447                 /*
448                  * we found a valid entry, so walk thru all the attributes in the
449                  * entry, and add each attribute type and description to the
450                  * usr_attr entry
451                  */
452
453                 for(a = e->e_attrs; a != NULL; a = a->a_next) {
454                         if( attr_merge( usr_attr, a->a_desc, a->a_vals,
455                                 (a->a_nvals == a->a_vals) ? NULL : a->a_nvals ) )
456                         {
457                                 rc = LDAP_OTHER;
458                                 break;
459                         }
460                 }
461
462                 entry_free( e );
463                 if (rc) break;
464         }
465
466         if ( ldifrc < 0 )
467                 rc = LDAP_OTHER;
468
469         if (rc) {
470                 entry_free( usr_attr );
471                 usr_attr = NULL;
472         }
473
474         ch_free( buf );
475
476         ldif_close( fp );
477
478         Debug(LDAP_DEBUG_CONFIG, "rootDSE file=\"%s\" read.\n", fname, 0, 0);
479         return rc;
480 }
481
482 int
483 slap_discover_feature(
484         slap_bindconf   *sb,
485         const char      *attr,
486         const char      *val )
487 {
488         LDAP            *ld = NULL;
489         LDAPMessage     *res = NULL, *entry;
490         int             rc, i;
491         struct berval   bv_val,
492                         **values = NULL;
493         char            *attrs[ 2 ] = { NULL, NULL };
494
495         rc = slap_client_connect( &ld, sb );
496         if ( rc != LDAP_SUCCESS ) {
497                 goto done;
498         }
499
500         attrs[ 0 ] = (char *) attr;
501         rc = ldap_search_ext_s( ld, "", LDAP_SCOPE_BASE, "(objectClass=*)",
502                         attrs, 0, NULL, NULL, NULL, 0, &res );
503         if ( rc != LDAP_SUCCESS ) {
504                 goto done;
505         }
506
507         entry = ldap_first_entry( ld, res );
508         if ( entry == NULL ) {
509                 goto done;
510         }
511
512         values = ldap_get_values_len( ld, entry, attrs[ 0 ] );
513         if ( values == NULL ) {
514                 rc = LDAP_NO_SUCH_ATTRIBUTE;
515                 goto done;
516         }
517
518         ber_str2bv( val, 0, 0, &bv_val );
519         for ( i = 0; values[ i ] != NULL; i++ ) {
520                 if ( bvmatch( &bv_val, values[ i ] ) ) {
521                         rc = LDAP_COMPARE_TRUE;
522                         goto done;
523                 }
524         }
525
526         rc = LDAP_COMPARE_FALSE;
527
528 done:;
529         if ( values != NULL ) {
530                 ldap_value_free_len( values );
531         }
532
533         if ( res != NULL ) {
534                 ldap_msgfree( res );
535         }
536
537         ldap_unbind_ext( ld, NULL, NULL );
538
539         return rc;
540 }
541