]> git.sur5r.net Git - openldap/blob - servers/slapd/dn.c
f871e38ce7526289fbd467303ca77840cbff3e0e
[openldap] / servers / slapd / dn.c
1 /* dn.c - routines for dealing with distinguished names */
2 /* $OpenLDAP$ */
3 /*
4  * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6  */
7
8 #include "portable.h"
9
10 #include <stdio.h>
11
12 #include <ac/ctype.h>
13 #include <ac/socket.h>
14 #include <ac/string.h>
15 #include <ac/time.h>
16
17 #include "ldap_pvt.h"
18
19 #include "slap.h"
20
21 const struct berval slap_empty_bv = { 0, "" };
22
23 #define SLAP_LDAPDN_PRETTY 0x1
24
25 /*
26  * The DN syntax-related functions take advantage of the dn representation
27  * handling functions ldap_str2dn/ldap_dn2str.  The latter are not schema-
28  * aware, so the attributes and their values need be validated (and possibly
29  * normalized).  In the current implementation the required validation/nor-
30  * malization/"pretty"ing are done on newly created DN structural represen-
31  * tations; however the idea is to move towards DN handling in structural
32  * representation instead of the current string representation.  To this
33  * purpose, we need to do only the required operations and keep track of
34  * what has been done to minimize their impact on performances.
35  *
36  * Developers are strongly encouraged to use this feature, to speed-up
37  * its stabilization.
38  */
39
40 #define AVA_PRIVATE( ava ) ( ( AttributeDescription * )(ava)->la_private )
41
42 /*
43  * In-place, schema-aware validation of the
44  * structural representation of a distinguished name.
45  */
46 static int
47 LDAPDN_validate( LDAPDN *dn )
48 {
49         int             iRDN;
50         int             rc;
51
52         assert( dn );
53
54         for ( iRDN = 0; dn[ 0 ][ iRDN ]; iRDN++ ) {
55                 LDAPRDN         *rdn = dn[ 0 ][ iRDN ];
56                 int             iAVA;
57
58                 assert( rdn );
59
60                 for ( iAVA = 0; rdn[ 0 ][ iAVA ]; iAVA++ ) {
61                         LDAPAVA                 *ava = rdn[ 0 ][ iAVA ];
62                         AttributeDescription    *ad;
63                         slap_syntax_validate_func *validate = NULL;
64
65                         assert( ava );
66                         
67                         if ( ( ad = AVA_PRIVATE( ava ) ) == NULL ) {
68                                 const char      *text = NULL;
69
70                                 rc = slap_bv2ad( &ava->la_attr, &ad, &text );
71                                 if ( rc != LDAP_SUCCESS ) {
72                                         return LDAP_INVALID_SYNTAX;
73                                 }
74
75                                 ava->la_private = ( void * )ad;
76                         }
77
78                         /* 
79                          * Replace attr oid/name with the canonical name
80                          */
81                         ava->la_attr = ad->ad_cname;
82
83                         validate = ad->ad_type->sat_syntax->ssyn_validate;
84
85                         if ( validate ) {
86                                 /*
87                                  * validate value by validate function
88                                  */
89                                 rc = ( *validate )( ad->ad_type->sat_syntax,
90                                         &ava->la_value );
91                         
92                                 if ( rc != LDAP_SUCCESS ) {
93                                         return LDAP_INVALID_SYNTAX;
94                                 }
95                         }
96                 }
97         }
98
99         return LDAP_SUCCESS;
100 }
101
102 /*
103  * dn validate routine
104  */
105 int
106 dnValidate(
107         Syntax *syntax,
108         struct berval *in )
109 {
110         int             rc;
111         LDAPDN          *dn = NULL;
112
113         assert( in );
114
115         if ( in->bv_len == 0 ) {
116                 return( LDAP_SUCCESS );
117         }
118
119         /* FIXME: str2dn should take a bv and handle this */
120         if( strlen( in->bv_val ) != in->bv_len ) {
121                 return LDAP_INVALID_SYNTAX;
122         }
123
124         rc = ldap_str2dn( in->bv_val, &dn, LDAP_DN_FORMAT_LDAP );
125
126         /*
127          * Schema-aware validate
128          */
129         if ( rc == LDAP_SUCCESS ) {
130                 rc = LDAPDN_validate( dn );
131                 ldap_dnfree( dn );
132         }
133         
134         if ( rc != LDAP_SUCCESS ) {
135                 return( LDAP_INVALID_SYNTAX );
136         }
137
138         return( LDAP_SUCCESS );
139 }
140
141 /*
142  * AVA sorting inside a RDN
143  *
144  * rule: sort attributeTypes in alphabetical order; in case of multiple
145  * occurrences of the same attributeType, sort values in byte order
146  * (use memcmp, which implies alphabetical order in case of IA5 value;
147  * this should guarantee the repeatability of the operation).
148  *
149  * Note: the sorting can be slightly improved by sorting first
150  * by attribute type length, then by alphabetical order.
151  *
152  * uses a linear search; should be fine since the number of AVAs in
153  * a RDN should be limited.
154  */
155 static void
156 AVA_Sort( LDAPRDN *rdn, int iAVA )
157 {
158         int             i;
159         LDAPAVA         *ava_in = rdn[ 0 ][ iAVA ];
160
161         assert( rdn );
162         assert( ava_in );
163         
164         for ( i = 0; i < iAVA; i++ ) {
165                 LDAPAVA         *ava = rdn[ 0 ][ i ];
166                 int             a, j;
167
168                 assert( ava );
169
170                 a = strcmp( ava_in->la_attr.bv_val, ava->la_attr.bv_val );
171
172                 if ( a > 0 ) {
173                         break;
174                 }
175
176                 while ( a == 0 ) {
177                         int             v, d;
178
179                         d = ava_in->la_value.bv_len - ava->la_value.bv_len;
180
181                         v = memcmp( ava_in->la_value.bv_val, 
182                                         ava->la_value.bv_val,
183                                         d <= 0 ? ava_in->la_value.bv_len 
184                                                 : ava->la_value.bv_len );
185
186                         if ( v == 0 && d != 0 ) {
187                                 v = d;
188                         }
189
190                         if ( v <= 0 ) {
191                                 /* 
192                                  * got it!
193                                  */
194                                 break;
195                         }
196
197                         if ( ++i == iAVA ) {
198                                 /*
199                                  * already sorted
200                                  */
201                                 return;
202                         }
203
204                         ava = rdn[ 0 ][ i ];
205                         a = strcmp( ava_in->la_attr.bv_val, 
206                                         ava->la_attr.bv_val );
207                 }
208
209                 /*
210                  * move ahead
211                  */
212                 for ( j = iAVA; j > i; j-- ) {
213                         rdn[ 0 ][ j ] = rdn[ 0 ][ j - 1 ];
214                 }
215                 rdn[ 0 ][ i ] = ava_in;
216
217                 return;
218         }
219 }
220
221 /*
222  * In-place, schema-aware normalization / "pretty"ing of the
223  * structural representation of a distinguished name.
224  */
225 static int
226 LDAPDN_rewrite( LDAPDN *dn, unsigned flags )
227 {
228         int             iRDN;
229         int             rc;
230
231         assert( dn );
232
233         for ( iRDN = 0; dn[ 0 ][ iRDN ]; iRDN++ ) {
234                 LDAPRDN         *rdn = dn[ 0 ][ iRDN ];
235                 int             iAVA;
236
237                 assert( rdn );
238
239                 for ( iAVA = 0; rdn[ 0 ][ iAVA ]; iAVA++ ) {
240                         LDAPAVA                 *ava = rdn[ 0 ][ iAVA ];
241                         AttributeDescription    *ad;
242                         slap_syntax_transform_func *transf = NULL;
243                         MatchingRule *mr;
244                         struct berval           bv = { 0, NULL };
245                         int                     do_sort = 0;
246
247                         assert( ava );
248
249                         if ( ( ad = AVA_PRIVATE( ava ) ) == NULL ) {
250                                 const char      *text = NULL;
251
252                                 rc = slap_bv2ad( &ava->la_attr, &ad, &text );
253                                 if ( rc != LDAP_SUCCESS ) {
254                                         return LDAP_INVALID_SYNTAX;
255                                 }
256                                 
257                                 ava->la_private = ( void * )ad;
258                                 do_sort = 1;
259                         }
260
261                         /* 
262                          * Replace attr oid/name with the canonical name
263                          */
264                         ava->la_attr = ad->ad_cname;
265
266                         if( ava->la_flags & LDAP_AVA_BINARY ) {
267                                 /* AVA is binary encoded, don't muck with it */
268                                 transf = NULL;
269                                 mr = NULL;
270
271                         } else if( flags & SLAP_LDAPDN_PRETTY ) {
272                                 transf = ad->ad_type->sat_syntax->ssyn_pretty;
273                                 mr = NULL;
274                         } else {
275                                 transf = ad->ad_type->sat_syntax->ssyn_normalize;
276                                 mr = ad->ad_type->sat_equality;
277                         }
278
279                         if ( transf ) {
280                                 /*
281                                  * transform value by normalize/pretty function
282                                  *      if value is empty, use empty_bv
283                                  */
284                                 rc = ( *transf )( ad->ad_type->sat_syntax,
285                                         ava->la_value.bv_len
286                                                 ? &ava->la_value
287                                                 : (struct berval *) &slap_empty_bv,
288                                         &bv );
289                         
290                                 if ( rc != LDAP_SUCCESS ) {
291                                         return LDAP_INVALID_SYNTAX;
292                                 }
293                         }
294
295                         if( mr && ( mr->smr_usage & SLAP_MR_DN_FOLD ) ) {
296                                 char *s = bv.bv_val;
297
298                                 ber_str2bv( UTF8normalize( bv.bv_val ? &bv
299                                         : &ava->la_value, LDAP_UTF8_CASEFOLD ),
300                                         0, 0, &bv );
301                                 free( s );
302                         }
303
304                         if( bv.bv_val ) {
305                                 free( ava->la_value.bv_val );
306                                 ava->la_value = bv;
307                         }
308
309                         if( do_sort ) AVA_Sort( rdn, iAVA );
310                 }
311         }
312
313         return LDAP_SUCCESS;
314 }
315
316 /*
317  * dn normalize routine
318  */
319 int
320 dnNormalize(
321         Syntax *syntax,
322         struct berval *val,
323         struct berval **normalized )
324 {
325         struct berval *out;
326         int rc;
327
328         assert( normalized && *normalized == NULL );
329
330         out = ch_malloc( sizeof( struct berval ) );
331         rc = dnNormalize2( syntax, val, out );
332         if ( rc != LDAP_SUCCESS )
333                 free( out );
334         else
335                 *normalized = out;
336         return rc;
337 }
338
339 int
340 dnNormalize2(
341         Syntax *syntax,
342         struct berval *val,
343         struct berval *out )
344 {
345         assert( val );
346         assert( out );
347
348         Debug( LDAP_DEBUG_TRACE, ">>> dnNormalize: <%s>\n", val->bv_val, 0, 0 );
349
350         if ( val->bv_len != 0 ) {
351                 LDAPDN          *dn = NULL;
352                 int             rc;
353
354                 /*
355                  * Go to structural representation
356                  */
357                 rc = ldap_str2dn( val->bv_val, &dn, LDAP_DN_FORMAT_LDAP );
358                 if ( rc != LDAP_SUCCESS ) {
359                         return LDAP_INVALID_SYNTAX;
360                 }
361
362                 /*
363                  * Schema-aware rewrite
364                  */
365                 if ( LDAPDN_rewrite( dn, 0 ) != LDAP_SUCCESS ) {
366                         ldap_dnfree( dn );
367                         return LDAP_INVALID_SYNTAX;
368                 }
369
370                 /*
371                  * Back to string representation
372                  */
373                 rc = ldap_dn2bv( dn, out, LDAP_DN_FORMAT_LDAPV3 );
374
375                 ldap_dnfree( dn );
376
377                 if ( rc != LDAP_SUCCESS ) {
378                         return LDAP_INVALID_SYNTAX;
379                 }
380         } else {
381                 ber_dupbv( out, val );
382         }
383
384         Debug( LDAP_DEBUG_TRACE, "<<< dnNormalize: <%s>\n", out->bv_val, 0, 0 );
385
386         return LDAP_SUCCESS;
387 }
388
389 /*
390  * dn "pretty"ing routine
391  */
392 int
393 dnPretty(
394         Syntax *syntax,
395         struct berval *val,
396         struct berval **pretty)
397 {
398         struct berval *out;
399         int rc;
400
401         assert( pretty && *pretty == NULL );
402
403         out = ch_malloc( sizeof( struct berval ) );
404         rc = dnPretty2( syntax, val, out );
405         if ( rc != LDAP_SUCCESS )
406                 free( out );
407         else
408                 *pretty = out;
409         return rc;
410 }
411
412 int
413 dnPretty2(
414         Syntax *syntax,
415         struct berval *val,
416         struct berval *out)
417 {
418         assert( val );
419         assert( out );
420
421         Debug( LDAP_DEBUG_TRACE, ">>> dnPretty: <%s>\n", val->bv_val, 0, 0 );
422
423         if ( val->bv_len != 0 ) {
424                 LDAPDN          *dn = NULL;
425                 int             rc;
426
427                 /* FIXME: str2dn should take a bv and handle this */
428                 if( strlen( val->bv_val ) != val->bv_len ) {
429                         return LDAP_INVALID_SYNTAX;
430                 }
431
432                 /* FIXME: should be liberal in what we accept */
433                 rc = ldap_str2dn( val->bv_val, &dn, LDAP_DN_FORMAT_LDAP );
434                 if ( rc != LDAP_SUCCESS ) {
435                         return LDAP_INVALID_SYNTAX;
436                 }
437
438                 /*
439                  * Schema-aware rewrite
440                  */
441                 if ( LDAPDN_rewrite( dn, SLAP_LDAPDN_PRETTY ) != LDAP_SUCCESS ) {
442                         ldap_dnfree( dn );
443                         return LDAP_INVALID_SYNTAX;
444                 }
445
446                 /* FIXME: not sure why the default isn't pretty */
447                 /* RE: the default is the form that is used as
448                  * an internal representation; the pretty form
449                  * is a variant */
450                 rc = ldap_dn2bv( dn, out,
451                         LDAP_DN_FORMAT_LDAPV3 | LDAP_DN_PRETTY );
452
453                 ldap_dnfree( dn );
454
455                 if ( rc != LDAP_SUCCESS ) {
456                         return LDAP_INVALID_SYNTAX;
457                 }
458         } else {
459                 ber_dupbv( out, val );
460         }
461
462         Debug( LDAP_DEBUG_TRACE, "<<< dnPretty: <%s>\n", out->bv_val, 0, 0 );
463
464         return LDAP_SUCCESS;
465 }
466
467 /*
468  * Combination of both dnPretty and dnNormalize
469  */
470 int
471 dnPrettyNormal(
472         Syntax *syntax,
473         struct berval *val,
474         struct berval *pretty,
475         struct berval *normal)
476 {
477         Debug( LDAP_DEBUG_TRACE, ">>> dnPrettyNormal: <%s>\n", val->bv_val, 0, 0 );
478
479         assert( val );
480         assert( pretty );
481         assert( normal );
482
483         if ( val->bv_len != 0 ) {
484                 LDAPDN          *dn = NULL;
485                 int             rc;
486
487                 pretty->bv_val = NULL;
488                 normal->bv_val = NULL;
489                 pretty->bv_len = 0;
490                 normal->bv_len = 0;
491
492                 /* FIXME: str2dn should take a bv and handle this */
493                 if( strlen( val->bv_val ) != val->bv_len ) {
494                         return LDAP_INVALID_SYNTAX;
495                 }
496
497                 /* FIXME: should be liberal in what we accept */
498                 rc = ldap_str2dn( val->bv_val, &dn, LDAP_DN_FORMAT_LDAP );
499                 if ( rc != LDAP_SUCCESS ) {
500                         return LDAP_INVALID_SYNTAX;
501                 }
502
503                 /*
504                  * Schema-aware rewrite
505                  */
506                 if ( LDAPDN_rewrite( dn, SLAP_LDAPDN_PRETTY ) != LDAP_SUCCESS ) {
507                         ldap_dnfree( dn );
508                         return LDAP_INVALID_SYNTAX;
509                 }
510
511                 rc = ldap_dn2bv( dn, pretty,
512                         LDAP_DN_FORMAT_LDAPV3 | LDAP_DN_PRETTY );
513
514                 if ( rc != LDAP_SUCCESS ) {
515                         ldap_dnfree( dn );
516                         return LDAP_INVALID_SYNTAX;
517                 }
518
519                 if ( LDAPDN_rewrite( dn, 0 ) != LDAP_SUCCESS ) {
520                         ldap_dnfree( dn );
521                         free( pretty->bv_val );
522                         pretty->bv_val = NULL;
523                         pretty->bv_len = 0;
524                         return LDAP_INVALID_SYNTAX;
525                 }
526
527                 rc = ldap_dn2bv( dn, normal, LDAP_DN_FORMAT_LDAPV3 );
528
529                 ldap_dnfree( dn );
530                 if ( rc != LDAP_SUCCESS ) {
531                         free( pretty->bv_val );
532                         pretty->bv_val = NULL;
533                         pretty->bv_len = 0;
534                         return LDAP_INVALID_SYNTAX;
535                 }
536         } else {
537                 ber_dupbv( pretty, val );
538                 ber_dupbv( normal, val );
539         }
540
541         Debug( LDAP_DEBUG_TRACE, "<<< dnPrettyNormal: <%s>, <%s>\n",
542                 pretty->bv_val, normal->bv_val, 0 );
543
544         return LDAP_SUCCESS;
545 }
546
547 /*
548  * dnMatch routine
549  */
550 int
551 dnMatch(
552         int *matchp,
553         slap_mask_t flags,
554         Syntax *syntax,
555         MatchingRule *mr,
556         struct berval *value,
557         void *assertedValue )
558 {
559         int match;
560         struct berval *asserted = (struct berval *) assertedValue;
561
562         assert( matchp );
563         assert( value );
564         assert( assertedValue );
565         
566         match = value->bv_len - asserted->bv_len;
567
568         if ( match == 0 ) {
569                 match = strcmp( value->bv_val, asserted->bv_val );
570         }
571
572 #ifdef NEW_LOGGING
573         LDAP_LOG(( "schema", LDAP_LEVEL_ENTRY,
574                 "dnMatch: %d\n    %s\n    %s\n", match,
575                 value->bv_val, asserted->bv_val ));
576 #else
577         Debug( LDAP_DEBUG_ARGS, "dnMatch %d\n\t\"%s\"\n\t\"%s\"\n",
578                 match, value->bv_val, asserted->bv_val );
579 #endif
580
581         *matchp = match;
582         return( LDAP_SUCCESS );
583 }
584
585 /*
586  * dnParent - dn's parent, in-place
587  *
588  * note: the incoming dn is assumed to be normalized/prettyfied,
589  * so that escaped rdn/ava separators are in '\'+hexpair form
590  */
591 void
592 dnParent( 
593         struct berval   *dn, 
594         struct berval   *pdn )
595 {
596         char    *p;
597
598         p = strchr( dn->bv_val, ',' );
599
600         /* one-level dn */
601         if ( p == NULL ) {
602                 *pdn = slap_empty_bv;
603                 return;
604         }
605
606         assert( DN_SEPARATOR( p[ 0 ] ) );
607         p++;
608
609         assert( ATTR_LEADCHAR( p[ 0 ] ) );
610         pdn->bv_val = p;
611         pdn->bv_len = dn->bv_len - (p - dn->bv_val);
612
613         return;
614 }
615
616 int
617 dnExtractRdn( 
618         struct berval   *dn, 
619         struct berval   *rdn )
620 {
621         LDAPRDN         *tmpRDN;
622         const char      *p;
623         int             rc;
624
625         assert( dn );
626         assert( rdn );
627
628         if( dn->bv_len == 0 ) {
629                 return LDAP_OTHER;
630         }
631
632         rc = ldap_str2rdn( dn->bv_val, &tmpRDN, (char **)&p, LDAP_DN_FORMAT_LDAP );
633         if ( rc != LDAP_SUCCESS ) {
634                 return rc;
635         }
636
637         rc = ldap_rdn2bv( tmpRDN, rdn, LDAP_DN_FORMAT_LDAPV3 );
638         ldap_rdnfree( tmpRDN );
639         if ( rc != LDAP_SUCCESS ) {
640                 return rc;
641         }
642
643         return LDAP_SUCCESS;
644 }
645
646 /*
647  * We can assume the input is a prettied or normalized DN
648  */
649 int 
650 dn_rdnlen(
651         Backend         *be,
652         struct berval   *dn_in )
653 {
654         const char      *p;
655
656         assert( dn_in );
657
658         if ( dn_in == NULL ) {
659                 return 0;
660         }
661
662         if ( !dn_in->bv_len ) {
663                 return 0;
664         }
665
666         if ( be != NULL && be_issuffix( be, dn_in ) ) {
667                 return 0;
668         }
669
670         p = strchr( dn_in->bv_val, ',' );
671
672         return p ? p - dn_in->bv_val : dn_in->bv_len;
673 }
674
675
676 /* rdnValidate:
677  *
678  * LDAP_SUCCESS if rdn is a legal rdn;
679  * LDAP_INVALID_SYNTAX otherwise (including a sequence of rdns)
680  */
681 int
682 rdnValidate( struct berval *rdn )
683 {
684 #if 1
685         /* Major cheat!
686          * input is a pretty or normalized DN
687          * hence, we can just search for ','
688          */
689         if( rdn == NULL || rdn->bv_len == 0 ) {
690                 return LDAP_INVALID_SYNTAX;
691         }
692
693         return strchr( rdn->bv_val, ',' ) == NULL
694                 ? LDAP_SUCCESS : LDAP_INVALID_SYNTAX;
695
696 #else
697         LDAPRDN         *RDN, **DN[ 2 ] = { &RDN, NULL };
698         const char      *p;
699         int             rc;
700
701         /*
702          * must be non-empty
703          */
704         if ( rdn == NULL || rdn == '\0' ) {
705                 return 0;
706         }
707
708         /*
709          * must be parsable
710          */
711         rc = ldap_str2rdn( rdn, &RDN, (char **)&p, LDAP_DN_FORMAT_LDAP );
712         if ( rc != LDAP_SUCCESS ) {
713                 return 0;
714         }
715
716         /*
717          * Must be one-level
718          */
719         if ( p[ 0 ] != '\0' ) {
720                 return 0;
721         }
722
723         /*
724          * Schema-aware validate
725          */
726         if ( rc == LDAP_SUCCESS ) {
727                 rc = LDAPDN_validate( DN );
728         }
729         ldap_rdnfree( RDN );
730
731         /*
732          * Must validate (there's a repeated parsing ...)
733          */
734         return ( rc == LDAP_SUCCESS );
735 #endif
736 }
737
738
739 /* build_new_dn:
740  *
741  * Used by ldbm/bdb2 back_modrdn to create the new dn of entries being
742  * renamed.
743  *
744  * new_dn = parent (p_dn) + separator + rdn (newrdn) + null.
745  */
746
747 void
748 build_new_dn( struct berval * new_dn,
749         struct berval * parent_dn,
750         struct berval * newrdn )
751 {
752         char *ptr;
753
754         if ( parent_dn == NULL ) {
755                 ber_dupbv( new_dn, newrdn );
756                 return;
757         }
758
759         new_dn->bv_len = parent_dn->bv_len + newrdn->bv_len + 1;
760         new_dn->bv_val = (char *) ch_malloc( new_dn->bv_len + 1 );
761
762         ptr = slap_strcopy( new_dn->bv_val, newrdn->bv_val );
763         *ptr++ = ',';
764         strcpy( ptr, parent_dn->bv_val );
765 }
766
767
768 /*
769  * dnIsSuffix - tells whether suffix is a suffix of dn.
770  * Both dn and suffix must be normalized.
771  */
772 int
773 dnIsSuffix(
774         const struct berval *dn,
775         const struct berval *suffix )
776 {
777         int     d = dn->bv_len - suffix->bv_len;
778
779         assert( dn );
780         assert( suffix );
781
782         /* empty suffix matches any dn */
783         if ( suffix->bv_len == 0 ) {
784                 return 1;
785         }
786
787         /* suffix longer than dn */
788         if ( d < 0 ) {
789                 return 0;
790         }
791
792         /* no rdn separator or escaped rdn separator */
793         if ( d > 1 && !DN_SEPARATOR( dn->bv_val[ d - 1 ] ) ) {
794                 return 0;
795         }
796
797         /* no possible match or malformed dn */
798         if ( d == 1 ) {
799                 return 0;
800         }
801
802         /* compare */
803         return( strcmp( dn->bv_val + d, suffix->bv_val ) == 0 );
804 }