1 /* at.c - routines for dealing with attribute types */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2010 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
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>.
23 #include <ac/socket.h>
24 #include <ac/string.h>
34 for ( ; at != NULL; at = at->sat_sup ) {
35 if ( at->sat_syntax_oid ) {
36 return at->sat_syntax_oid;
50 const char *syn_oid = at_syntax( at );
53 return strcmp( syn_oid, oid ) == 0;
63 for( ; sub != NULL; sub = sub->sat_sup ) {
64 if( sub == sup ) return 1;
71 struct berval air_name;
72 AttributeType *air_at;
75 static Avlnode *attr_index = NULL;
76 static Avlnode *attr_cache = NULL;
77 static LDAP_STAILQ_HEAD(ATList, AttributeType) attr_list
78 = LDAP_STAILQ_HEAD_INITIALIZER(attr_list);
80 /* Last hardcoded attribute registered */
81 AttributeType *at_sys_tail;
90 const struct aindexrec *air1 = v_air1;
91 const struct aindexrec *air2 = v_air2;
92 int i = air1->air_name.bv_len - air2->air_name.bv_len;
94 return (strcasecmp( air1->air_name.bv_val, air2->air_name.bv_val ));
102 const struct berval *type = v_type;
103 const struct aindexrec *air = v_air;
104 int i = type->bv_len - air->air_name.bv_len;
106 return (strncasecmp( type->bv_val, air->air_name.bv_val, type->bv_len ));
110 at_find( const char *name )
114 bv.bv_val = (char *)name;
115 bv.bv_len = strlen( name );
117 return at_bvfind( &bv );
121 at_bvfind( struct berval *name )
123 struct aindexrec *air;
126 air = avl_find( attr_cache, name, attr_index_name_cmp );
127 if ( air ) return air->air_at;
130 air = avl_find( attr_index, name, attr_index_name_cmp );
133 if ( air->air_at->sat_flags & SLAP_AT_DELETED ) {
135 } else if (( slapMode & SLAP_TOOL_MODE ) && at_oc_cache ) {
136 avl_insert( &attr_cache, (caddr_t) air,
137 attr_index_cmp, avl_dup_error );
141 return air != NULL ? air->air_at : NULL;
147 AttributeType ***listp )
149 AttributeType **list;
150 AttributeType **list1;
156 list = ch_calloc(size, sizeof(AttributeType *));
168 list1 = ch_realloc(list, size*sizeof(AttributeType *));
183 AttributeType ***listp )
185 AttributeType **list;
186 AttributeType **list1;
194 for ( i=0; list[i]; i++ )
199 for ( i=pos, j=pos+1; list[j]; i++, j++ ) {
203 /* Tell the runtime this can be shrinked */
204 list1 = ch_realloc(list, (i+1)*sizeof(AttributeType **));
215 AttributeType **list )
222 for ( i=0; list[i]; i++ ) {
223 if ( sat == list[i] ) {
231 at_delete_names( AttributeType *at )
233 char **names = at->sat_names;
236 struct aindexrec tmpair, *air;
238 ber_str2bv( *names, 0, 0, &tmpair.air_name );
240 air = (struct aindexrec *)avl_delete( &attr_index,
241 (caddr_t)&tmpair, attr_index_cmp );
242 assert( air != NULL );
248 /* Mark the attribute as deleted, remove from list, and remove all its
249 * names from the AVL tree. Leave the OID in the tree.
252 at_delete( AttributeType *at )
254 at->sat_flags |= SLAP_AT_DELETED;
256 LDAP_STAILQ_REMOVE(&attr_list, at, AttributeType, sat_next);
258 at_delete_names( at );
262 at_clean( AttributeType *a )
264 if ( a->sat_equality ) {
267 mr = mr_find( a->sat_equality->smr_oid );
268 assert( mr != NULL );
269 if ( mr != a->sat_equality ) {
270 ch_free( a->sat_equality );
271 a->sat_equality = NULL;
275 assert( a->sat_syntax != NULL );
276 if ( a->sat_syntax != NULL ) {
279 syn = syn_find( a->sat_syntax->ssyn_oid );
280 assert( syn != NULL );
281 if ( syn != a->sat_syntax ) {
282 ch_free( a->sat_syntax );
283 a->sat_syntax = NULL;
287 if ( a->sat_oidmacro ) {
288 ldap_memfree( a->sat_oidmacro );
289 a->sat_oidmacro = NULL;
291 if ( a->sat_soidmacro ) {
292 ldap_memfree( a->sat_soidmacro );
293 a->sat_soidmacro = NULL;
295 if ( a->sat_subtypes ) {
296 ldap_memfree( a->sat_subtypes );
297 a->sat_subtypes = NULL;
302 at_destroy_one( void *v )
304 struct aindexrec *air = v;
305 AttributeType *a = air->air_at;
308 ad_destroy(a->sat_ad);
309 ldap_pvt_thread_mutex_destroy(&a->sat_ad_mutex);
310 ldap_attributetype_free((LDAPAttributeType *)a);
319 while( !LDAP_STAILQ_EMPTY(&attr_list) ) {
320 a = LDAP_STAILQ_FIRST(&attr_list);
321 LDAP_STAILQ_REMOVE_HEAD(&attr_list, sat_next);
323 at_delete_names( a );
326 avl_free(attr_index, at_destroy_one);
328 if ( slap_schema.si_at_undefined ) {
329 ad_destroy(slap_schema.si_at_undefined->sat_ad);
332 if ( slap_schema.si_at_proxied ) {
333 ad_destroy(slap_schema.si_at_proxied->sat_ad);
338 at_start( AttributeType **at )
340 assert( at != NULL );
342 *at = LDAP_STAILQ_FIRST(&attr_list);
344 return (*at != NULL);
348 at_next( AttributeType **at )
350 assert( at != NULL );
352 #if 0 /* pedantic check: don't use this */
354 AttributeType *tmp = NULL;
356 LDAP_STAILQ_FOREACH(tmp,&attr_list,sat_next) {
362 assert( tmp != NULL );
366 *at = LDAP_STAILQ_NEXT(*at,sat_next);
368 return (*at != NULL);
372 * check whether the two attributeTypes actually __are__ identical,
373 * or rather inconsistent
378 AttributeType *new_sat )
380 if ( new_sat->sat_oid != NULL ) {
381 if ( sat->sat_oid == NULL ) {
382 return SLAP_SCHERR_ATTR_INCONSISTENT;
385 if ( strcmp( sat->sat_oid, new_sat->sat_oid ) != 0 ) {
386 return SLAP_SCHERR_ATTR_INCONSISTENT;
390 if ( sat->sat_oid != NULL ) {
391 return SLAP_SCHERR_ATTR_INCONSISTENT;
395 if ( new_sat->sat_names ) {
398 if ( sat->sat_names == NULL ) {
399 return SLAP_SCHERR_ATTR_INCONSISTENT;
402 for ( i = 0; new_sat->sat_names[ i ]; i++ ) {
403 if ( sat->sat_names[ i ] == NULL ) {
404 return SLAP_SCHERR_ATTR_INCONSISTENT;
407 if ( strcasecmp( sat->sat_names[ i ],
408 new_sat->sat_names[ i ] ) != 0 )
410 return SLAP_SCHERR_ATTR_INCONSISTENT;
414 if ( sat->sat_names != NULL ) {
415 return SLAP_SCHERR_ATTR_INCONSISTENT;
419 return SLAP_SCHERR_ATTR_DUP;
422 static struct aindexrec *air_old;
425 at_dup_error( void *left, void *right )
437 struct aindexrec *air;
439 AttributeType *sat = *rat;
441 if ( sat->sat_oid ) {
442 air = (struct aindexrec *)
443 ch_calloc( 1, sizeof(struct aindexrec) );
444 ber_str2bv( sat->sat_oid, 0, 0, &air->air_name );
448 if ( avl_insert( &attr_index, (caddr_t) air,
449 attr_index_cmp, at_dup_error ) )
451 AttributeType *old_sat;
456 assert( air_old != NULL );
457 old_sat = air_old->air_at;
459 /* replacing a deleted definition? */
460 if ( old_sat->sat_flags & SLAP_AT_DELETED ) {
462 AttributeDescription *ad;
464 /* Keep old oid, free new oid;
465 * Keep old ads, free new ads;
466 * Keep old ad_mutex, free new ad_mutex;
467 * Keep new everything else, free old
471 old_sat->sat_oid = tmp.sat_oid;
472 tmp.sat_oid = sat->sat_oid;
473 old_sat->sat_ad = tmp.sat_ad;
474 tmp.sat_ad = sat->sat_ad;
475 old_sat->sat_ad_mutex = tmp.sat_ad_mutex;
476 tmp.sat_ad_mutex = sat->sat_ad_mutex;
479 /* Check for basic ad pointing at old cname */
480 for ( ad = old_sat->sat_ad; ad; ad=ad->ad_next ) {
481 if ( ad->ad_cname.bv_val == sat->sat_cname.bv_val ) {
482 ad->ad_cname = old_sat->sat_cname;
488 at_destroy_one( air );
496 rc = at_check_dup( old_sat, sat );
501 /* FIX: temporal consistency check */
502 at_bvfind( &air->air_name );
505 names = sat->sat_names;
508 air = (struct aindexrec *)
509 ch_calloc( 1, sizeof(struct aindexrec) );
510 ber_str2bv( *names, 0, 0, &air->air_name );
512 if ( avl_insert( &attr_index, (caddr_t) air,
513 attr_index_cmp, avl_dup_error ) )
515 AttributeType *old_sat;
520 old_sat = at_bvfind( &air->air_name );
521 assert( old_sat != NULL );
522 rc = at_check_dup( old_sat, sat );
526 while ( names > sat->sat_names ) {
527 struct aindexrec tmpair;
530 ber_str2bv( *names, 0, 0, &tmpair.air_name );
532 air = (struct aindexrec *)avl_delete( &attr_index,
533 (caddr_t)&tmpair, attr_index_cmp );
534 assert( air != NULL );
538 if ( sat->sat_oid ) {
539 struct aindexrec tmpair;
541 ber_str2bv( sat->sat_oid, 0, 0, &tmpair.air_name );
543 air = (struct aindexrec *)avl_delete( &attr_index,
544 (caddr_t)&tmpair, attr_index_cmp );
545 assert( air != NULL );
551 /* FIX: temporal consistency check */
552 at_bvfind(&air->air_name);
557 if ( sat->sat_oid ) {
558 slap_ad_undef_promote( sat->sat_oid, sat );
561 names = sat->sat_names;
564 slap_ad_undef_promote( *names, sat );
569 if ( sat->sat_flags & SLAP_AT_HARDCODE ) {
574 LDAP_STAILQ_INSERT_AFTER( &attr_list, prev, sat, sat_next );
576 LDAP_STAILQ_INSERT_TAIL( &attr_list, sat, sat_next );
584 LDAPAttributeType *at,
586 AttributeType **rsat,
590 AttributeType *sat = NULL;
591 MatchingRule *mr = NULL;
594 int code = LDAP_SUCCESS;
601 return SLAP_SCHERR_ATTR_INCOMPLETE;
604 if ( !OID_LEADCHAR( at->at_oid[0] )) {
607 /* Expand OID macros */
608 oid = oidm_find( at->at_oid );
611 return SLAP_SCHERR_OIDM;
613 if ( oid != at->at_oid ) {
619 if ( at->at_syntax_oid && !OID_LEADCHAR( at->at_syntax_oid[0] )) {
622 /* Expand OID macros */
623 oid = oidm_find( at->at_syntax_oid );
625 *err = at->at_syntax_oid;
626 code = SLAP_SCHERR_OIDM;
629 if ( oid != at->at_syntax_oid ) {
630 soidm = at->at_syntax_oid;
631 at->at_syntax_oid = oid;
635 if ( at->at_names && at->at_names[0] ) {
638 for( i=0; at->at_names[i]; i++ ) {
639 if( !slap_valid_descr( at->at_names[i] ) ) {
640 *err = at->at_names[i];
641 code = SLAP_SCHERR_BAD_DESCR;
646 cname = at->at_names[0];
655 if ( !at->at_usage && at->at_no_user_mod ) {
656 /* user attribute must be modifable */
657 code = SLAP_SCHERR_ATTR_BAD_USAGE;
661 if ( at->at_collective ) {
663 /* collective attributes cannot be operational */
664 code = SLAP_SCHERR_ATTR_BAD_USAGE;
668 if( at->at_single_value ) {
669 /* collective attributes cannot be single-valued */
670 code = SLAP_SCHERR_ATTR_BAD_USAGE;
675 sat = (AttributeType *) ch_calloc( 1, sizeof(AttributeType) );
676 AC_MEMCPY( &sat->sat_atype, at, sizeof(LDAPAttributeType));
678 sat->sat_cname.bv_val = cname;
679 sat->sat_cname.bv_len = strlen( cname );
680 sat->sat_oidmacro = oidm;
681 sat->sat_soidmacro = soidm;
682 ldap_pvt_thread_mutex_init(&sat->sat_ad_mutex);
684 if ( at->at_sup_oid ) {
685 AttributeType *supsat = at_find(at->at_sup_oid);
687 if ( supsat == NULL ) {
688 *err = at->at_sup_oid;
689 code = SLAP_SCHERR_ATTR_NOT_FOUND;
693 sat->sat_sup = supsat;
695 if ( at_append_to_list(sat, &supsat->sat_subtypes) ) {
696 code = SLAP_SCHERR_OUTOFMEM;
700 if ( sat->sat_usage != supsat->sat_usage ) {
701 /* subtypes must have same usage as their SUP */
702 code = SLAP_SCHERR_ATTR_BAD_USAGE;
706 if ( supsat->sat_obsolete && !sat->sat_obsolete ) {
707 /* subtypes must be obsolete if super is */
708 code = SLAP_SCHERR_ATTR_BAD_SUP;
712 if ( sat->sat_flags & SLAP_AT_FINAL ) {
713 /* cannot subtype a "final" attribute type */
714 code = SLAP_SCHERR_ATTR_BAD_SUP;
720 * Inherit definitions from superiors. We only check the
721 * direct superior since that one has already inherited from
724 if ( sat->sat_sup ) {
725 Syntax *syn = syn_find(sat->sat_sup->sat_syntax->ssyn_oid);
726 if ( syn != sat->sat_sup->sat_syntax ) {
727 sat->sat_syntax = ch_malloc( sizeof( Syntax ));
728 *sat->sat_syntax = *sat->sat_sup->sat_syntax;
730 sat->sat_syntax = sat->sat_sup->sat_syntax;
732 if ( sat->sat_sup->sat_equality ) {
733 MatchingRule *mr = mr_find( sat->sat_sup->sat_equality->smr_oid );
734 if ( mr != sat->sat_sup->sat_equality ) {
735 sat->sat_equality = ch_malloc( sizeof( MatchingRule ));
736 *sat->sat_equality = *sat->sat_sup->sat_equality;
738 sat->sat_equality = sat->sat_sup->sat_equality;
741 sat->sat_approx = sat->sat_sup->sat_approx;
742 sat->sat_ordering = sat->sat_sup->sat_ordering;
743 sat->sat_substr = sat->sat_sup->sat_substr;
747 * check for X-ORDERED attributes
749 if ( sat->sat_extensions ) {
750 for (i=0; sat->sat_extensions[i]; i++) {
751 if (!strcasecmp( sat->sat_extensions[i]->lsei_name,
752 "X-ORDERED" ) && sat->sat_extensions[i]->lsei_values ) {
753 if ( !strcasecmp( sat->sat_extensions[i]->lsei_values[0],
755 sat->sat_flags |= SLAP_AT_ORDERED_VAL;
757 } else if ( !strcasecmp( sat->sat_extensions[i]->lsei_values[0],
759 sat->sat_flags |= SLAP_AT_ORDERED_SIB;
767 sat->sat_flags |= SLAP_AT_HARDCODE;
769 if ( at->at_syntax_oid ) {
770 syn = syn_find(sat->sat_syntax_oid);
772 *err = sat->sat_syntax_oid;
773 code = SLAP_SCHERR_SYN_NOT_FOUND;
777 if ( sat->sat_syntax != NULL && sat->sat_syntax != syn ) {
778 /* BEWARE: no loop detection! */
779 if ( syn_is_sup( sat->sat_syntax, syn ) ) {
780 code = SLAP_SCHERR_ATTR_BAD_SUP;
785 sat->sat_syntax = syn;
787 } else if ( sat->sat_syntax == NULL ) {
788 code = SLAP_SCHERR_ATTR_INCOMPLETE;
792 if ( sat->sat_equality_oid ) {
793 mr = mr_find(sat->sat_equality_oid);
796 *err = sat->sat_equality_oid;
797 code = SLAP_SCHERR_MR_NOT_FOUND;
801 if(( mr->smr_usage & SLAP_MR_EQUALITY ) != SLAP_MR_EQUALITY ) {
802 *err = sat->sat_equality_oid;
803 code = SLAP_SCHERR_ATTR_BAD_MR;
807 if( sat->sat_syntax != mr->smr_syntax ) {
808 if( mr->smr_compat_syntaxes == NULL ) {
809 *err = sat->sat_equality_oid;
810 code = SLAP_SCHERR_ATTR_BAD_MR;
814 for(i=0; mr->smr_compat_syntaxes[i]; i++) {
815 if( sat->sat_syntax == mr->smr_compat_syntaxes[i] ) {
822 *err = sat->sat_equality_oid;
823 code = SLAP_SCHERR_ATTR_BAD_MR;
828 sat->sat_equality = mr;
829 sat->sat_approx = mr->smr_associated;
832 if ( sat->sat_ordering_oid ) {
833 if( !sat->sat_equality ) {
834 *err = sat->sat_ordering_oid;
835 code = SLAP_SCHERR_ATTR_BAD_MR;
839 mr = mr_find(sat->sat_ordering_oid);
842 *err = sat->sat_ordering_oid;
843 code = SLAP_SCHERR_MR_NOT_FOUND;
847 if(( mr->smr_usage & SLAP_MR_ORDERING ) != SLAP_MR_ORDERING ) {
848 *err = sat->sat_ordering_oid;
849 code = SLAP_SCHERR_ATTR_BAD_MR;
853 if( sat->sat_syntax != mr->smr_syntax ) {
854 if( mr->smr_compat_syntaxes == NULL ) {
855 *err = sat->sat_ordering_oid;
856 code = SLAP_SCHERR_ATTR_BAD_MR;
860 for(i=0; mr->smr_compat_syntaxes[i]; i++) {
861 if( sat->sat_syntax == mr->smr_compat_syntaxes[i] ) {
868 *err = sat->sat_ordering_oid;
869 code = SLAP_SCHERR_ATTR_BAD_MR;
874 sat->sat_ordering = mr;
877 if ( sat->sat_substr_oid ) {
878 if( !sat->sat_equality ) {
879 *err = sat->sat_substr_oid;
880 code = SLAP_SCHERR_ATTR_BAD_MR;
884 mr = mr_find(sat->sat_substr_oid);
887 *err = sat->sat_substr_oid;
888 code = SLAP_SCHERR_MR_NOT_FOUND;
892 if(( mr->smr_usage & SLAP_MR_SUBSTR ) != SLAP_MR_SUBSTR ) {
893 *err = sat->sat_substr_oid;
894 code = SLAP_SCHERR_ATTR_BAD_MR;
898 /* due to funky LDAP builtin substring rules,
899 * we check against the equality rule assertion
900 * syntax and compat syntaxes instead of those
901 * associated with the substrings rule.
903 if( sat->sat_syntax != sat->sat_equality->smr_syntax ) {
904 if( sat->sat_equality->smr_compat_syntaxes == NULL ) {
905 *err = sat->sat_substr_oid;
906 code = SLAP_SCHERR_ATTR_BAD_MR;
910 for(i=0; sat->sat_equality->smr_compat_syntaxes[i]; i++) {
911 if( sat->sat_syntax ==
912 sat->sat_equality->smr_compat_syntaxes[i] )
920 *err = sat->sat_substr_oid;
921 code = SLAP_SCHERR_ATTR_BAD_MR;
926 sat->sat_substr = mr;
929 code = at_insert( &sat, prev, err );
933 ldap_pvt_thread_mutex_destroy( &sat->sat_ad_mutex );
938 SLAP_FREE( at->at_oid );
943 SLAP_FREE( at->at_syntax_oid );
944 at->at_syntax_oid = soidm;
957 at_index_printnode( void *v_air, void *ignore )
959 struct aindexrec *air = v_air;
961 air->air_name.bv_val,
962 ldap_attributetype2str(&air->air_at->sat_atype) );
967 at_index_print( void )
969 printf("Printing attribute type index:\n");
970 (void) avl_apply( attr_index, at_index_printnode, 0, -1, AVL_INORDER );
976 at_unparse( BerVarray *res, AttributeType *start, AttributeType *end, int sys )
980 struct berval bv, *bva = NULL, idx;
984 start = LDAP_STAILQ_FIRST( &attr_list );
986 /* count the result size */
988 for ( at=start; at; at=LDAP_STAILQ_NEXT(at, sat_next)) {
989 if ( sys && !(at->sat_flags & SLAP_AT_HARDCODE)) break;
991 if ( at == end ) break;
996 bva = ch_malloc( (num+1) * sizeof(struct berval) );
1004 for ( at=start; at; at=LDAP_STAILQ_NEXT(at, sat_next)) {
1005 LDAPAttributeType lat, *latp;
1006 if ( sys && !(at->sat_flags & SLAP_AT_HARDCODE)) break;
1007 if ( at->sat_oidmacro || at->sat_soidmacro ) {
1008 lat = at->sat_atype;
1009 if ( at->sat_oidmacro )
1010 lat.at_oid = at->sat_oidmacro;
1011 if ( at->sat_soidmacro )
1012 lat.at_syntax_oid = at->sat_soidmacro;
1015 latp = &at->sat_atype;
1017 if ( ldap_attributetype2bv( latp, &bv ) == NULL ) {
1018 ber_bvarray_free( bva );
1021 idx.bv_len = sprintf(idx.bv_val, "{%d}", i);
1023 bva[i].bv_len = idx.bv_len + bv.bv_len;
1024 bva[i].bv_val = ch_malloc( bva[i].bv_len + 1 );
1025 strcpy( bva[i].bv_val, ibuf );
1026 strcpy( bva[i].bv_val + idx.bv_len, bv.bv_val );
1028 bva[i].bv_val = NULL;
1029 ldap_memfree( bv.bv_val );
1030 if ( at == end ) break;
1036 at_schema_info( Entry *e )
1038 AttributeDescription *ad_attributeTypes = slap_schema.si_ad_attributeTypes;
1043 LDAP_STAILQ_FOREACH(at,&attr_list,sat_next) {
1044 if( at->sat_flags & SLAP_AT_HIDE ) continue;
1046 if ( ldap_attributetype2bv( &at->sat_atype, &val ) == NULL ) {
1050 ber_str2bv( at->sat_oid, 0, 0, &nval );
1052 if( attr_merge_one( e, ad_attributeTypes, &val, &nval ) )
1056 ldap_memfree( val.bv_val );
1062 register_at( const char *def, AttributeDescription **rad, int dupok )
1064 LDAPAttributeType *at;
1065 int code, freeit = 0;
1067 AttributeDescription *ad = NULL;
1069 at = ldap_str2attributetype( def, &code, &err, LDAP_SCHEMA_ALLOW_ALL );
1071 Debug( LDAP_DEBUG_ANY,
1072 "register_at: AttributeType \"%s\": %s, %s\n",
1073 def, ldap_scherr2str(code), err );
1077 code = at_add( at, 0, NULL, NULL, &err );
1079 if ( code == SLAP_SCHERR_ATTR_DUP && dupok ) {
1083 Debug( LDAP_DEBUG_ANY,
1084 "register_at: AttributeType \"%s\": %s, %s\n",
1085 def, scherr2str(code), err );
1086 ldap_attributetype_free( at );
1090 code = slap_str2ad( at->at_names[0], &ad, &err );
1091 if ( freeit || code ) {
1092 ldap_attributetype_free( at );
1097 Debug( LDAP_DEBUG_ANY, "register_at: AttributeType \"%s\": %s\n",
1100 if ( rad ) *rad = ad;