1 /* dn.c - routines for dealing with distinguished names */
4 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
13 #include <ac/socket.h>
14 #include <ac/string.h>
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 ];
58 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
59 LDAPAVA *ava = rdn[ iAVA ];
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 ava->la_attr = ad->ad_cname;
81 validate = ad->ad_type->sat_syntax->ssyn_validate;
85 * validate value by validate function
87 rc = ( *validate )( ad->ad_type->sat_syntax,
90 if ( rc != LDAP_SUCCESS ) {
91 return LDAP_INVALID_SYNTAX;
101 * dn validate routine
113 if ( in->bv_len == 0 ) {
116 } else if ( in->bv_len > SLAP_LDAPDN_MAXLEN ) {
117 return LDAP_INVALID_SYNTAX;
120 rc = ldap_bv2dn( in, &dn, LDAP_DN_FORMAT_LDAP );
121 if ( rc != LDAP_SUCCESS ) {
122 return LDAP_INVALID_SYNTAX;
125 assert( strlen( in->bv_val ) == in->bv_len );
128 * Schema-aware validate
130 rc = LDAPDN_validate( dn );
133 if ( rc != LDAP_SUCCESS ) {
134 return LDAP_INVALID_SYNTAX;
141 * AVA sorting inside a RDN
143 * rule: sort attributeTypes in alphabetical order; in case of multiple
144 * occurrences of the same attributeType, sort values in byte order
145 * (use memcmp, which implies alphabetical order in case of IA5 value;
146 * this should guarantee the repeatability of the operation).
148 * Note: the sorting can be slightly improved by sorting first
149 * by attribute type length, then by alphabetical order.
151 * uses a linear search; should be fine since the number of AVAs in
152 * a RDN should be limited.
155 AVA_Sort( LDAPRDN rdn, int iAVA )
158 LDAPAVA *ava_in = rdn[ iAVA ];
163 for ( i = 0; i < iAVA; i++ ) {
164 LDAPAVA *ava = rdn[ i ];
169 a = strcmp( ava_in->la_attr.bv_val, ava->la_attr.bv_val );
178 d = ava_in->la_value.bv_len - ava->la_value.bv_len;
180 v = memcmp( ava_in->la_value.bv_val,
181 ava->la_value.bv_val,
182 d <= 0 ? ava_in->la_value.bv_len
183 : ava->la_value.bv_len );
185 if ( v == 0 && d != 0 ) {
204 a = strcmp( ava_in->la_attr.bv_val,
205 ava->la_attr.bv_val );
211 for ( j = iAVA; j > i; j-- ) {
212 rdn[ j ] = rdn[ j - 1 ];
221 * In-place, schema-aware normalization / "pretty"ing of the
222 * structural representation of a distinguished name.
225 LDAPDN_rewrite( LDAPDN dn, unsigned flags, void *ctx )
232 for ( iRDN = 0; dn[ iRDN ]; iRDN++ ) {
233 LDAPRDN rdn = dn[ iRDN ];
238 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
239 LDAPAVA *ava = rdn[ iAVA ];
240 AttributeDescription *ad;
241 slap_syntax_validate_func *validf = NULL;
242 slap_mr_normalize_func *normf = NULL;
243 slap_syntax_transform_func *transf = NULL;
244 MatchingRule *mr = NULL;
245 struct berval bv = { 0, NULL };
250 if ( ( ad = AVA_PRIVATE( ava ) ) == NULL ) {
251 const char *text = NULL;
253 rc = slap_bv2ad( &ava->la_attr, &ad, &text );
254 if ( rc != LDAP_SUCCESS ) {
255 return LDAP_INVALID_SYNTAX;
258 ava->la_private = ( void * )ad;
263 * Replace attr oid/name with the canonical name
265 ava->la_attr = ad->ad_cname;
267 if( ava->la_flags & LDAP_AVA_BINARY ) {
268 if( ava->la_value.bv_len == 0 ) {
269 /* BER encoding is empty */
270 return LDAP_INVALID_SYNTAX;
273 /* AVA is binary encoded, don't muck with it */
274 } else if( flags & SLAP_LDAPDN_PRETTY ) {
275 transf = ad->ad_type->sat_syntax->ssyn_pretty;
277 validf = ad->ad_type->sat_syntax->ssyn_validate;
279 } else { /* normalization */
280 validf = ad->ad_type->sat_syntax->ssyn_validate;
281 mr = ad->ad_type->sat_equality;
282 if( mr ) normf = mr->smr_normalize;
286 /* validate value before normalization */
287 rc = ( *validf )( ad->ad_type->sat_syntax,
290 : (struct berval *) &slap_empty_bv );
292 if ( rc != LDAP_SUCCESS ) {
293 return LDAP_INVALID_SYNTAX;
299 * transform value by pretty function
300 * if value is empty, use empty_bv
302 rc = ( *transf )( ad->ad_type->sat_syntax,
305 : (struct berval *) &slap_empty_bv,
308 if ( rc != LDAP_SUCCESS ) {
309 return LDAP_INVALID_SYNTAX;
316 * if value is empty, use empty_bv
320 ad->ad_type->sat_syntax,
324 : (struct berval *) &slap_empty_bv,
327 if ( rc != LDAP_SUCCESS ) {
328 return LDAP_INVALID_SYNTAX;
334 ber_memfree_x( ava->la_value.bv_val, ctx );
338 if( do_sort ) AVA_Sort( rdn, iAVA );
357 Debug( LDAP_DEBUG_TRACE, ">>> dnNormalize: <%s>\n", val->bv_val, 0, 0 );
359 if ( val->bv_len != 0 ) {
364 * Go to structural representation
366 rc = ldap_bv2dn_x( val, &dn, LDAP_DN_FORMAT_LDAP, ctx );
367 if ( rc != LDAP_SUCCESS ) {
368 return LDAP_INVALID_SYNTAX;
371 assert( strlen( val->bv_val ) == val->bv_len );
374 * Schema-aware rewrite
376 if ( LDAPDN_rewrite( dn, 0, ctx ) != LDAP_SUCCESS ) {
378 return LDAP_INVALID_SYNTAX;
382 * Back to string representation
384 rc = ldap_dn2bv_x( dn, out,
385 LDAP_DN_FORMAT_LDAPV3 | LDAP_DN_PRETTY, ctx );
387 ldap_dnfree_x( dn, ctx );
389 if ( rc != LDAP_SUCCESS ) {
390 return LDAP_INVALID_SYNTAX;
393 ber_dupbv_x( out, val, ctx );
396 Debug( LDAP_DEBUG_TRACE, "<<< dnNormalize: <%s>\n", out->bv_val, 0, 0 );
403 * dn "pretty"ing routine
409 struct berval **pretty)
414 assert( pretty && *pretty == NULL );
416 out = ch_malloc( sizeof( struct berval ) );
417 rc = dnPretty2( syntax, val, out );
418 if ( rc != LDAP_SUCCESS )
437 LDAP_LOG( OPERATION, ARGS, ">>> dnPretty: <%s>\n", val->bv_val, 0, 0 );
439 Debug( LDAP_DEBUG_TRACE, ">>> dnPretty: <%s>\n", val->bv_val, 0, 0 );
442 if ( val->bv_len == 0 ) {
443 ber_dupbv_x( out, val, ctx );
445 } else if ( val->bv_len > SLAP_LDAPDN_MAXLEN ) {
446 return LDAP_INVALID_SYNTAX;
452 /* FIXME: should be liberal in what we accept */
453 rc = ldap_bv2dn_x( val, &dn, LDAP_DN_FORMAT_LDAP, ctx );
454 if ( rc != LDAP_SUCCESS ) {
455 return LDAP_INVALID_SYNTAX;
458 assert( strlen( val->bv_val ) == val->bv_len );
461 * Schema-aware rewrite
463 if ( LDAPDN_rewrite( dn, SLAP_LDAPDN_PRETTY, ctx ) != LDAP_SUCCESS ) {
464 ldap_dnfree_x( dn, ctx );
465 return LDAP_INVALID_SYNTAX;
468 /* FIXME: not sure why the default isn't pretty */
469 /* RE: the default is the form that is used as
470 * an internal representation; the pretty form
472 rc = ldap_dn2bv_x( dn, out,
473 LDAP_DN_FORMAT_LDAPV3 | LDAP_DN_PRETTY, ctx );
475 ldap_dnfree_x( dn, ctx );
477 if ( rc != LDAP_SUCCESS ) {
478 return LDAP_INVALID_SYNTAX;
482 Debug( LDAP_DEBUG_TRACE, "<<< dnPretty: <%s>\n", out->bv_val, 0, 0 );
499 LDAP_LOG( OPERATION, ARGS, ">>> dn%sDN: <%s>\n",
500 flags == SLAP_LDAPDN_PRETTY ? "Pretty" : "Normal",
503 Debug( LDAP_DEBUG_TRACE, ">>> dn%sDN: <%s>\n",
504 flags == SLAP_LDAPDN_PRETTY ? "Pretty" : "Normal",
508 if ( val->bv_len == 0 ) {
511 } else if ( val->bv_len > SLAP_LDAPDN_MAXLEN ) {
512 return LDAP_INVALID_SYNTAX;
517 /* FIXME: should be liberal in what we accept */
518 rc = ldap_bv2dn_x( val, dn, LDAP_DN_FORMAT_LDAP, ctx );
519 if ( rc != LDAP_SUCCESS ) {
520 return LDAP_INVALID_SYNTAX;
523 assert( strlen( val->bv_val ) == val->bv_len );
526 * Schema-aware rewrite
528 if ( LDAPDN_rewrite( *dn, flags, ctx ) != LDAP_SUCCESS ) {
529 ldap_dnfree_x( *dn, ctx );
531 return LDAP_INVALID_SYNTAX;
535 Debug( LDAP_DEBUG_TRACE, "<<< dn%sDN\n",
536 flags == SLAP_LDAPDN_PRETTY ? "Pretty" : "Normal",
543 * Combination of both dnPretty and dnNormalize
549 struct berval *pretty,
550 struct berval *normal,
554 LDAP_LOG ( OPERATION, ENTRY, ">>> dnPrettyNormal: <%s>\n", val->bv_val, 0, 0 );
556 Debug( LDAP_DEBUG_TRACE, ">>> dnPrettyNormal: <%s>\n", val->bv_val, 0, 0 );
563 if ( val->bv_len == 0 ) {
564 ber_dupbv_x( pretty, val, ctx );
565 ber_dupbv_x( normal, val, ctx );
567 } else if ( val->bv_len > SLAP_LDAPDN_MAXLEN ) {
569 return LDAP_INVALID_SYNTAX;
575 pretty->bv_val = NULL;
576 normal->bv_val = NULL;
580 /* FIXME: should be liberal in what we accept */
581 rc = ldap_bv2dn_x( val, &dn, LDAP_DN_FORMAT_LDAP, ctx );
582 if ( rc != LDAP_SUCCESS ) {
583 return LDAP_INVALID_SYNTAX;
586 assert( strlen( val->bv_val ) == val->bv_len );
589 * Schema-aware rewrite
591 if ( LDAPDN_rewrite( dn, SLAP_LDAPDN_PRETTY, ctx ) != LDAP_SUCCESS ) {
592 ldap_dnfree_x( dn, ctx );
593 return LDAP_INVALID_SYNTAX;
596 rc = ldap_dn2bv_x( dn, pretty,
597 LDAP_DN_FORMAT_LDAPV3 | LDAP_DN_PRETTY, ctx );
599 if ( rc != LDAP_SUCCESS ) {
600 ldap_dnfree_x( dn, ctx );
601 return LDAP_INVALID_SYNTAX;
604 if ( LDAPDN_rewrite( dn, 0, ctx ) != LDAP_SUCCESS ) {
605 ldap_dnfree_x( dn, ctx );
606 ber_memfree_x( pretty->bv_val, ctx );
607 pretty->bv_val = NULL;
609 return LDAP_INVALID_SYNTAX;
612 rc = ldap_dn2bv_x( dn, normal,
613 LDAP_DN_FORMAT_LDAPV3 | LDAP_DN_PRETTY, ctx );
615 ldap_dnfree_x( dn, ctx );
616 if ( rc != LDAP_SUCCESS ) {
617 ber_memfree_x( pretty->bv_val, ctx );
618 pretty->bv_val = NULL;
620 return LDAP_INVALID_SYNTAX;
625 LDAP_LOG (OPERATION, RESULTS, "<<< dnPrettyNormal: <%s>, <%s>\n",
626 pretty->bv_val, normal->bv_val, 0 );
628 Debug( LDAP_DEBUG_TRACE, "<<< dnPrettyNormal: <%s>, <%s>\n",
629 pretty->bv_val, normal->bv_val, 0 );
644 struct berval *value,
645 void *assertedValue )
648 struct berval *asserted = (struct berval *) assertedValue;
652 assert( assertedValue );
654 match = value->bv_len - asserted->bv_len;
657 match = memcmp( value->bv_val, asserted->bv_val,
662 LDAP_LOG( CONFIG, ENTRY, "dnMatch: %d\n %s\n %s\n",
663 match, value->bv_val, asserted->bv_val );
665 Debug( LDAP_DEBUG_ARGS, "dnMatch %d\n\t\"%s\"\n\t\"%s\"\n",
666 match, value->bv_val, asserted->bv_val );
670 return( LDAP_SUCCESS );
674 * dnParent - dn's parent, in-place
676 * note: the incoming dn is assumed to be normalized/prettyfied,
677 * so that escaped rdn/ava separators are in '\'+hexpair form
686 p = strchr( dn->bv_val, ',' );
691 pdn->bv_val = dn->bv_val + dn->bv_len;
695 assert( DN_SEPARATOR( p[ 0 ] ) );
698 assert( ATTR_LEADCHAR( p[ 0 ] ) );
700 pdn->bv_len = dn->bv_len - (p - dn->bv_val);
718 if( dn->bv_len == 0 ) {
722 rc = ldap_bv2rdn_x( dn, &tmpRDN, (char **)&p, LDAP_DN_FORMAT_LDAP, ctx );
723 if ( rc != LDAP_SUCCESS ) {
727 rc = ldap_rdn2bv_x( tmpRDN, rdn, LDAP_DN_FORMAT_LDAPV3 | LDAP_DN_PRETTY, ctx );
729 ldap_rdnfree_x( tmpRDN, ctx );
730 if ( rc != LDAP_SUCCESS ) {
738 * We can assume the input is a prettied or normalized DN
743 struct berval *dn_in )
749 if ( dn_in == NULL ) {
753 if ( !dn_in->bv_len ) {
757 if ( be != NULL && be_issuffix( be, dn_in ) ) {
761 p = strchr( dn_in->bv_val, ',' );
763 return p ? p - dn_in->bv_val : dn_in->bv_len;
769 * LDAP_SUCCESS if rdn is a legal rdn;
770 * LDAP_INVALID_SYNTAX otherwise (including a sequence of rdns)
773 rdnValidate( struct berval *rdn )
777 * input is a pretty or normalized DN
778 * hence, we can just search for ','
780 if( rdn == NULL || rdn->bv_len == 0 ||
781 rdn->bv_len > SLAP_LDAPDN_MAXLEN )
783 return LDAP_INVALID_SYNTAX;
786 return strchr( rdn->bv_val, ',' ) == NULL
787 ? LDAP_SUCCESS : LDAP_INVALID_SYNTAX;
790 LDAPRDN *RDN, **DN[ 2 ] = { &RDN, NULL };
797 if ( rdn == NULL || rdn == '\0' ) {
804 rc = ldap_bv2rdn( rdn, &RDN, (char **)&p, LDAP_DN_FORMAT_LDAP );
805 if ( rc != LDAP_SUCCESS ) {
812 if ( p[ 0 ] != '\0' ) {
817 * Schema-aware validate
819 if ( rc == LDAP_SUCCESS ) {
820 rc = LDAPDN_validate( DN );
825 * Must validate (there's a repeated parsing ...)
827 return ( rc == LDAP_SUCCESS );
834 * Used by ldbm/bdb2 back_modrdn to create the new dn of entries being
837 * new_dn = parent (p_dn) + separator + rdn (newrdn) + null.
841 build_new_dn( struct berval * new_dn,
842 struct berval * parent_dn,
843 struct berval * newrdn )
847 if ( parent_dn == NULL ) {
848 ber_dupbv( new_dn, newrdn );
852 new_dn->bv_len = parent_dn->bv_len + newrdn->bv_len + 1;
853 new_dn->bv_val = (char *) ch_malloc( new_dn->bv_len + 1 );
855 ptr = lutil_strcopy( new_dn->bv_val, newrdn->bv_val );
857 strcpy( ptr, parent_dn->bv_val );
862 * dnIsSuffix - tells whether suffix is a suffix of dn.
863 * Both dn and suffix must be normalized.
867 const struct berval *dn,
868 const struct berval *suffix )
870 int d = dn->bv_len - suffix->bv_len;
875 /* empty suffix matches any dn */
876 if ( suffix->bv_len == 0 ) {
880 /* suffix longer than dn */
885 /* no rdn separator or escaped rdn separator */
886 if ( d > 1 && !DN_SEPARATOR( dn->bv_val[ d - 1 ] ) ) {
890 /* no possible match or malformed dn */
896 return( strcmp( dn->bv_val + d, suffix->bv_val ) == 0 );
901 * Convert an X.509 DN into a normalized LDAP DN
904 dnX509normalize( void *x509_name, struct berval *out )
906 /* Invoke the LDAP library's converter with our schema-rewriter */
907 return ldap_X509dn2bv( x509_name, out, LDAPDN_rewrite, 0 );
911 * Get the TLS session's peer's DN into a normalized LDAP DN
914 dnX509peerNormalize( void *ssl, struct berval *dn )
917 return ldap_pvt_tls_get_peer_dn( ssl, dn, (LDAPDN_rewrite_dummy *)LDAPDN_rewrite, 0 );