1 /* dn.c - routines for dealing with distinguished names */
4 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
13 #include <ac/socket.h>
14 #include <ac/string.h>
21 #define SLAP_LDAPDN_PRETTY 0x1
24 * The DN syntax-related functions take advantage of the dn representation
25 * handling functions ldap_str2dn/ldap_dn2str. The latter are not schema-
26 * aware, so the attributes and their values need be validated (and possibly
27 * normalized). In the current implementation the required validation/nor-
28 * malization/"pretty"ing are done on newly created DN structural represen-
29 * tations; however the idea is to move towards DN handling in structural
30 * representation instead of the current string representation. To this
31 * purpose, we need to do only the required operations and keep track of
32 * what has been done to minimize their impact on performances.
34 * Developers are strongly encouraged to use this feature, to speed-up
38 #define AVA_PRIVATE( ava ) ( ( AttributeDescription * )(ava)->la_private )
41 * In-place, schema-aware validation of the
42 * structural representation of a distinguished name.
45 LDAPDN_validate( LDAPDN *dn )
52 for ( iRDN = 0; dn[ iRDN ]; iRDN++ ) {
53 LDAPRDN *rdn = dn[ iRDN ][ 0 ];
58 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
59 LDAPAVA *ava = rdn[ iAVA ][ 0 ];
60 AttributeDescription *ad;
61 slap_syntax_validate_func *validate = NULL;
65 if ( ( ad = AVA_PRIVATE( ava ) ) == NULL ) {
66 const char *text = NULL;
68 rc = slap_bv2ad( ava->la_attr, &ad, &text );
69 if ( rc != LDAP_SUCCESS ) {
70 return LDAP_INVALID_SYNTAX;
73 ava->la_private = ( void * )ad;
77 * Replace attr oid/name with the canonical name
79 ber_bvfree( ava->la_attr );
80 ava->la_attr = ber_bvdup( &ad->ad_cname );
82 validate = ad->ad_type->sat_syntax->ssyn_validate;
86 * validate value by validate function
88 rc = ( *validate )( ad->ad_type->sat_syntax,
91 if ( rc != LDAP_SUCCESS ) {
92 return LDAP_INVALID_SYNTAX;
102 * dn validate routine
114 if ( in->bv_len == 0 ) {
115 return( LDAP_SUCCESS );
118 rc = ldap_str2dn( in->bv_val, &dn, LDAP_DN_FORMAT_LDAP );
121 * Schema-aware validate
123 if ( rc == LDAP_SUCCESS ) {
124 rc = LDAPDN_validate( dn );
129 if ( rc != LDAP_SUCCESS ) {
130 return( LDAP_INVALID_SYNTAX );
133 return( LDAP_SUCCESS );
137 * AVA sorting inside a RDN
139 * rule: sort attributeTypes in alphabetical order; in case of multiple
140 * occurrences of the same attributeType, sort values in byte order
141 * (use memcmp, which implies alphabetical order in case of IA5 value;
142 * this should guarantee the repeatability of the operation).
144 * uses a linear search; should be fine since the number of AVAs in
145 * a RDN should be limited.
148 AVA_Sort( LDAPRDN *rdn, int iAVA )
151 LDAPAVA *ava_in = rdn[ iAVA ][ 0 ];
156 for ( i = 0; i < iAVA; i++ ) {
157 LDAPAVA *ava = rdn[ i ][ 0 ];
162 a = strcmp( ava_in->la_attr->bv_val, ava->la_attr->bv_val );
171 d = ava_in->la_value->bv_len - ava->la_value->bv_len;
173 v = memcmp( ava_in->la_value->bv_val,
174 ava->la_value->bv_val,
175 d <= 0 ? ava_in->la_value->bv_len
176 : ava->la_value->bv_len );
178 if ( v == 0 && d != 0 ) {
197 a = strcmp( ava_in->la_value->bv_val,
198 ava->la_value->bv_val );
204 for ( j = iAVA; j > i; j-- ) {
205 rdn[ j ][ 0 ] = rdn[ j - 1 ][ 0 ];
207 rdn[ i ][ 0 ] = ava_in;
214 * In-place, schema-aware normalization / "pretty"ing of the
215 * structural representation of a distinguished name.
218 LDAPDN_rewrite( LDAPDN *dn, unsigned flags )
225 for ( iRDN = 0; dn[ iRDN ]; iRDN++ ) {
226 LDAPRDN *rdn = dn[ iRDN ][ 0 ];
231 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
232 LDAPAVA *ava = rdn[ iAVA ][ 0 ];
233 AttributeDescription *ad;
234 slap_syntax_transform_func *transf = NULL;
236 struct berval *bv = NULL;
240 if ( ( ad = AVA_PRIVATE( ava ) ) == NULL ) {
241 const char *text = NULL;
243 rc = slap_bv2ad( ava->la_attr, &ad, &text );
244 if ( rc != LDAP_SUCCESS ) {
245 return LDAP_INVALID_SYNTAX;
248 ava->la_private = ( void * )ad;
252 * Replace attr oid/name with the canonical name
254 ber_bvfree( ava->la_attr );
255 ava->la_attr = ber_bvdup( &ad->ad_cname );
257 if( flags & SLAP_LDAPDN_PRETTY ) {
258 transf = ad->ad_type->sat_syntax->ssyn_pretty;
261 transf = ad->ad_type->sat_syntax->ssyn_normalize;
262 mr = ad->ad_type->sat_equality;
267 * transform value by normalize/pretty function
269 rc = ( *transf )( ad->ad_type->sat_syntax,
270 ava->la_value, &bv );
272 if ( rc != LDAP_SUCCESS ) {
273 return LDAP_INVALID_SYNTAX;
277 if( mr && ( mr->smr_usage & SLAP_MR_DN_FOLD ) ) {
278 struct berval *s = bv;
280 bv = ber_bvstr( UTF8normalize( bv ? bv : ava->la_value,
287 ber_bvfree( ava->la_value );
291 AVA_Sort( rdn, iAVA );
299 * dn normalize routine
305 struct berval **normalized )
307 struct berval *out = NULL;
309 Debug( LDAP_DEBUG_TRACE, ">>> dnNormalize: <%s>\n", val->bv_val, 0, 0 );
312 assert( normalized );
314 assert( *normalized == NULL );
316 if ( val->bv_len != 0 ) {
322 * Go to structural representation
324 rc = ldap_str2dn( val->bv_val, &dn, LDAP_DN_FORMAT_LDAP );
325 if ( rc != LDAP_SUCCESS ) {
326 return LDAP_INVALID_SYNTAX;
330 * Schema-aware rewrite
332 if ( LDAPDN_rewrite( dn, 0 ) != LDAP_SUCCESS ) {
334 return LDAP_INVALID_SYNTAX;
338 * Back to string representation
340 rc = ldap_dn2str( dn, &dn_out, LDAP_DN_FORMAT_LDAPV3 );
344 if ( rc != LDAP_SUCCESS ) {
345 return LDAP_INVALID_SYNTAX;
348 out = ber_bvstr( dn_out );
351 out = ber_bvdup( val );
354 Debug( LDAP_DEBUG_TRACE, "<<< dnNormalize: <%s>\n", out->bv_val, 0, 0 );
362 * dn "pretty"ing routine
368 struct berval **pretty)
370 struct berval *out = NULL;
372 Debug( LDAP_DEBUG_TRACE, ">>> dnPretty: <%s>\n", val->bv_val, 0, 0 );
376 assert( *pretty == NULL );
378 if ( val->bv_len != 0 ) {
383 /* FIXME: should be liberal in what we accept */
384 rc = ldap_str2dn( val->bv_val, &dn, LDAP_DN_FORMAT_LDAP );
385 if ( rc != LDAP_SUCCESS ) {
386 return LDAP_INVALID_SYNTAX;
390 * Schema-aware rewrite
392 if ( LDAPDN_rewrite( dn, SLAP_LDAPDN_PRETTY ) != LDAP_SUCCESS ) {
394 return LDAP_INVALID_SYNTAX;
397 /* FIXME: not sure why the default isn't pretty */
398 /* RE: the default is the form that is used as
399 * an internal representation; the pretty form
401 rc = ldap_dn2str( dn, &dn_out,
402 LDAP_DN_FORMAT_LDAPV3 | LDAP_DN_PRETTY );
406 if ( rc != LDAP_SUCCESS ) {
407 return LDAP_INVALID_SYNTAX;
410 out = ber_bvstr( dn_out );
413 out = ber_bvdup( val );
416 Debug( LDAP_DEBUG_TRACE, "<<< dnPretty: <%s>\n", out->bv_val, 0, 0 );
426 * note: uses exact string match (strcmp) because it is supposed to work
435 struct berval *value,
436 void *assertedValue )
439 struct berval *asserted = (struct berval *) assertedValue;
443 assert( assertedValue );
445 match = value->bv_len - asserted->bv_len;
448 match = strcmp( value->bv_val, asserted->bv_val );
452 LDAP_LOG(( "schema", LDAP_LEVEL_ENTRY,
453 "dnMatch: %d\n %s\n %s\n", match,
454 value->bv_val, asserted->bv_val ));
456 Debug( LDAP_DEBUG_ARGS, "dnMatch %d\n\t\"%s\"\n\t\"%s\"\n",
457 match, value->bv_val, asserted->bv_val );
461 return( LDAP_SUCCESS );
464 #ifdef SLAP_DN_MIGRATION
466 * these routines are provided for migration purposes only!
467 * dn_validate is deprecated in favor of dnValidate
468 * dn_normalize is deprecated in favor of dnNormalize
469 * strcmp/strcasecmp for DNs is deprecated in favor of dnMatch
471 * other routines are likewise deprecated but may not yet have
472 * replacement functions.
476 * dn_validate - validate and compress dn. the dn is
477 * compressed in place are returned if valid.
478 * Deprecated in favor of dnValidate()
481 dn_validate( char *dn )
484 struct berval *pretty = NULL;
487 if ( dn == NULL || dn[0] == '\0' ) {
492 val.bv_len = strlen( dn );
494 rc = dnPretty( NULL, &val, &pretty );
495 if ( rc != LDAP_SUCCESS ) {
499 if ( val.bv_len < pretty->bv_len ) {
500 ber_bvfree( pretty );
504 AC_MEMCPY( dn, pretty->bv_val, pretty->bv_len + 1 );
505 ber_bvfree( pretty );
511 * dn_normalize - put dn into a canonical form suitable for storing
512 * in a hash database. this involves normalizing the case as well as
513 * the format. the dn is normalized in place as well as returned if valid.
514 * Deprecated in favor of dnNormalize()
517 dn_normalize( char *dn )
520 struct berval *normalized = NULL;
523 if ( dn == NULL || dn[0] == '\0' ) {
528 val.bv_len = strlen( dn );
530 rc = dnNormalize( NULL, &val, &normalized );
531 if ( rc != LDAP_SUCCESS ) {
535 if ( val.bv_len < normalized->bv_len ) {
536 ber_bvfree( normalized );
540 AC_MEMCPY( dn, normalized->bv_val, normalized->bv_len + 1 );
541 ber_bvfree( normalized );
547 * dnParent - dn's parent, in-place
558 rc = ldap_str2rdn( dn, &tmpRDN, &p, LDAP_DN_FORMAT_LDAP );
559 if ( rc != LDAP_SUCCESS ) {
562 ldap_rdnfree( tmpRDN );
564 assert( DN_SEPARATOR( p[ 0 ] ) );
567 while ( ASCII_SPACE( p[ 0 ] ) ) {
577 * dn_parent - return the dn's parent, in-place
578 * FIXME: should be replaced by dnParent()
591 while ( dn[ 0 ] != '\0' && ASCII_SPACE( dn[ 0 ] ) ) {
595 if ( dn[ 0 ] == '\0' ) {
599 if ( be != NULL && be_issuffix( be, dn ) ) {
603 if ( dnParent( dn, &pdn ) != LDAP_SUCCESS ) {
607 return ( char * )pdn;
613 struct berval **rdn )
623 rc = ldap_str2rdn( dn, &tmpRDN, &p, LDAP_DN_FORMAT_LDAP );
624 if ( rc != LDAP_SUCCESS ) {
628 rc = ldap_rdn2str( tmpRDN, &rdnout, LDAP_DN_FORMAT_LDAPV3 );
629 ldap_rdnfree( tmpRDN );
630 if ( rc != LDAP_SUCCESS ) {
634 *rdn = ber_bvstr( rdnout );
635 if ( *rdn == NULL ) {
637 return LDAP_NO_MEMORY;
644 * FIXME: should be replaced by dnExtractRdn() (together with dn_rdn)
651 struct berval *rdn = NULL;
656 if ( dn_in == NULL ) {
660 while ( dn_in[ 0 ] && ASCII_SPACE( dn_in[ 0 ] ) ) {
664 if ( dn_in[ 0 ] == '\0' ) {
668 if ( be != NULL && be_issuffix( be, dn_in ) ) {
672 if ( dnExtractRdn( dn_in, &rdn ) != LDAP_SUCCESS ) {
677 retval = rdn->bv_len;
684 * FIXME: should be replaced by dnExtractRdn() (together with dn_rdnlen)
690 struct berval *rdn = NULL;
695 if ( dn_in == NULL ) {
699 while ( dn_in[ 0 ] && ASCII_SPACE( dn_in[ 0 ] ) ) {
703 if ( dn_in[ 0 ] == '\0' ) {
707 if ( be != NULL && be_issuffix( be, dn_in ) ) {
711 if ( dnExtractRdn( dn_in, &rdn ) != LDAP_SUCCESS ) {
716 retval = rdn->bv_val;
723 * return a charray of all subtrees to which the DN resides in
729 char **subtree = NULL;
732 charray_add( &subtree, dn );
734 dn = dn_parent( be, dn );
736 } while ( dn != NULL );
742 * dn_issuffix - tells whether suffix is a suffix of dn.
743 * Both dn and suffix must be normalized.
744 * deprecated in favor of dnIsSuffix()
752 struct berval bvdn, bvsuffix;
757 bvdn.bv_val = (char *) dn;
758 bvdn.bv_len = strlen( dn );
759 bvsuffix.bv_val = (char *) suffix;
760 bvsuffix.bv_len = strlen( suffix );
762 return dnIsSuffix( &bvdn, &bvsuffix );
767 * Given a string (i.e. an rdn) of the form:
768 * "attribute_type = attribute_value"
769 * this function returns the type of an attribute, that is the
770 * string "attribute_type" which is placed in newly allocated
771 * memory. The returned string will be null-terminated.
776 char * rdn_attr_type( const char * s )
778 char **attrs, **values, *retval;
780 if ( rdn_attrs( s, &attrs, &values ) != LDAP_SUCCESS ) {
784 retval = ch_strdup( attrs[ 0 ] );
786 charray_free( attrs );
787 charray_free( values );
795 * Given a string (i.e. an rdn) of the form:
796 * "attribute_type = attribute_value"
797 * this function returns "attribute_type" which is placed in newly allocated
798 * memory. The returned string will be null-terminated and may contain
799 * spaces (i.e. "John Doe\0").
805 rdn_attr_value( const char * rdn )
807 char **attrs, **values, *retval;
809 if ( rdn_attrs( rdn, &attrs, &values ) != LDAP_SUCCESS ) {
813 retval = ch_strdup( values[ 0 ] );
815 charray_free( attrs );
816 charray_free( values );
824 * Given a string (i.e. an rdn) of the form:
825 * "attribute_type=attribute_value[+attribute_type=attribute_value[...]]"
826 * this function stores the types of the attributes in ptypes, that is the
827 * array of strings "attribute_type" which is placed in newly allocated
828 * memory, and the values of the attributes in pvalues, that is the
829 * array of strings "attribute_value" which is placed in newly allocated
830 * memory. Returns 0 on success, -1 on failure.
832 * note: got part of the code from dn_validate
834 * Deprecated; directly use LDAPRDN from ldap_str2rdn
838 rdn_attrs( const char * rdn, char ***types, char ***values)
849 rc = ldap_str2rdn( rdn, &tmpRDN, &p, LDAP_DN_FORMAT_LDAP );
850 if ( rc != LDAP_SUCCESS ) {
854 for ( iAVA = 0; tmpRDN[ iAVA ]; iAVA++ ) {
855 LDAPAVA *ava = tmpRDN[ iAVA ][ 0 ];
858 assert( ava->la_attr );
859 assert( ava->la_value );
861 charray_add_n( types, ava->la_attr->bv_val,
862 ava->la_attr->bv_len );
863 charray_add_n( values, ava->la_value->bv_val,
864 ava->la_value->bv_len );
867 ldap_rdnfree( tmpRDN );
875 * 1 if rdn is a legal rdn;
876 * 0 otherwise (including a sequence of rdns)
879 rdn_validate( const char *rdn )
881 LDAPRDN *RDN, **DN[ 2 ] = { &RDN, NULL };
888 if ( rdn == NULL || rdn == '\0' ) {
895 rc = ldap_str2rdn( rdn, &RDN, &p, LDAP_DN_FORMAT_LDAP );
896 if ( rc != LDAP_SUCCESS ) {
903 if ( p[ 0 ] != '\0' ) {
908 * Schema-aware validate
910 if ( rc == LDAP_SUCCESS ) {
911 rc = LDAPDN_validate( DN );
916 * Must validate (there's a repeated parsing ...)
918 return ( rc == LDAP_SUCCESS );
924 * Used by ldbm/bdb2 back_modrdn to create the new dn of entries being
927 * new_dn = parent (p_dn) + separator + rdn (newrdn) + null.
931 build_new_dn( char ** new_dn,
932 const char * entry_dn,
933 const char * parent_dn,
934 const char * newrdn )
937 if ( parent_dn == NULL ) {
938 *new_dn = ch_strdup( newrdn );
942 *new_dn = (char *) ch_malloc(
943 strlen( parent_dn ) + strlen( newrdn ) + 2 );
945 strcpy( *new_dn, newrdn );
946 strcat( *new_dn, "," );
947 strcat( *new_dn, parent_dn );
950 #endif /* SLAP_DN_MIGRATION */
953 * dnIsSuffix - tells whether suffix is a suffix of dn.
954 * Both dn and suffix must be normalized.
958 const struct berval *dn,
959 const struct berval *suffix )
961 int d = dn->bv_len - suffix->bv_len;
966 /* empty suffix matches any dn */
967 if ( suffix->bv_len == 0 ) {
971 /* suffix longer than dn */
976 /* no rdn separator or escaped rdn separator */
977 if ( d > 1 && ( !DN_SEPARATOR( dn->bv_val[ d - 1 ] )
978 || DN_ESCAPE( dn->bv_val[ d - 2 ] ) ) ) {
982 /* no possible match or malformed dn */
988 return( strcmp( dn->bv_val + d, suffix->bv_val ) == 0 );