2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2004 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in the file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
15 /* Portions Copyright (c) 1994 Regents of the University of Michigan.
16 * All rights reserved.
23 #include <ac/stdlib.h>
24 #include <ac/socket.h>
25 #include <ac/string.h>
29 #include "ldap_schema.h"
31 /* extension to UFN that turns trailing "dc=value" rdns in DNS style,
32 * e.g. "ou=People,dc=openldap,dc=org" => "People, openldap.org" */
36 /* parsing/printing routines */
37 static int str2strval( const char *str, ber_len_t stoplen, struct berval *val,
38 const char **next, unsigned flags, int *retFlags, void *ctx );
39 static int DCE2strval( const char *str, struct berval *val,
40 const char **next, unsigned flags, void *ctx );
41 static int IA52strval( const char *str, struct berval *val,
42 const char **next, unsigned flags, void *ctx );
43 static int quotedIA52strval( const char *str, struct berval *val,
44 const char **next, unsigned flags, void *ctx );
45 static int hexstr2binval( const char *str, struct berval *val,
46 const char **next, unsigned flags, void *ctx );
47 static int hexstr2bin( const char *str, char *c );
48 static int byte2hexpair( const char *val, char *pair );
49 static int binval2hexstr( struct berval *val, char *str );
50 static int strval2strlen( struct berval *val, unsigned flags,
52 static int strval2str( struct berval *val, char *str, unsigned flags,
54 static int strval2IA5strlen( struct berval *val, unsigned flags,
56 static int strval2IA5str( struct berval *val, char *str, unsigned flags,
58 static int strval2DCEstrlen( struct berval *val, unsigned flags,
60 static int strval2DCEstr( struct berval *val, char *str, unsigned flags,
62 static int strval2ADstrlen( struct berval *val, unsigned flags,
64 static int strval2ADstr( struct berval *val, char *str, unsigned flags,
66 static int dn2domain( LDAPDN dn, struct berval *bv, int pos, int *iRDN );
69 static LDAPAVA * ldapava_new(
70 const struct berval *attr, const struct berval *val, unsigned flags, void *ctx );
72 /* Higher level helpers */
73 static int rdn2strlen( LDAPRDN rdn, unsigned flags, ber_len_t *len,
74 int ( *s2l )( struct berval *, unsigned, ber_len_t * ) );
75 static int rdn2str( LDAPRDN rdn, char *str, unsigned flags, ber_len_t *len,
76 int ( *s2s )( struct berval *, char *, unsigned, ber_len_t * ));
77 static int rdn2UFNstrlen( LDAPRDN rdn, unsigned flags, ber_len_t *len );
78 static int rdn2UFNstr( LDAPRDN rdn, char *str, unsigned flags, ber_len_t *len );
79 static int rdn2DCEstrlen( LDAPRDN rdn, unsigned flags, ber_len_t *len );
80 static int rdn2DCEstr( LDAPRDN rdn, char *str, unsigned flag, ber_len_t *len, int first );
81 static int rdn2ADstrlen( LDAPRDN rdn, unsigned flags, ber_len_t *len );
82 static int rdn2ADstr( LDAPRDN rdn, char *str, unsigned flags, ber_len_t *len, int first );
85 * RFC 1823 ldap_get_dn
88 ldap_get_dn( LDAP *ld, LDAPMessage *entry )
94 LDAP_LOG ( OPERATION, ENTRY, "ldap_get_dn\n", 0, 0, 0 );
96 Debug( LDAP_DEBUG_TRACE, "ldap_get_dn\n", 0, 0, 0 );
100 assert( LDAP_VALID(ld) );
101 assert( entry != NULL );
103 tmp = *entry->lm_ber; /* struct copy */
104 if ( ber_scanf( &tmp, "{a" /*}*/, &dn ) == LBER_ERROR ) {
105 ld->ld_errno = LDAP_DECODING_ERROR;
113 ldap_get_dn_ber( LDAP *ld, LDAPMessage *entry, BerElement **berout,
116 BerElement tmp, *ber;
118 int rc = LDAP_SUCCESS;
121 LDAP_LOG ( OPERATION, ENTRY, "ldap_get_dn_ber\n", 0, 0, 0 );
123 Debug( LDAP_DEBUG_TRACE, "ldap_get_dn_ber\n", 0, 0, 0 );
126 assert( ld != NULL );
127 assert( LDAP_VALID(ld) );
128 assert( entry != NULL );
129 assert( dn != NULL );
136 ber = ldap_alloc_ber_with_options( ld );
138 return LDAP_NO_MEMORY;
145 *ber = *entry->lm_ber; /* struct copy */
146 if ( ber_scanf( ber, "{ml{" /*}*/, dn, &len ) == LBER_ERROR ) {
147 rc = ld->ld_errno = LDAP_DECODING_ERROR;
149 if ( rc == LDAP_SUCCESS ) {
150 /* set the length to avoid overrun */
151 rc = ber_set_option( ber, LBER_OPT_REMAINING_BYTES, &len );
152 if( rc != LBER_OPT_SUCCESS ) {
153 rc = ld->ld_errno = LDAP_LOCAL_ERROR;
156 if ( rc != LDAP_SUCCESS && berout ) {
164 * RFC 1823 ldap_dn2ufn
167 ldap_dn2ufn( LDAP_CONST char *dn )
172 LDAP_LOG ( OPERATION, ENTRY, "ldap_dn2ufn\n", 0, 0, 0 );
174 Debug( LDAP_DEBUG_TRACE, "ldap_dn2ufn\n", 0, 0, 0 );
177 ( void )ldap_dn_normalize( dn, LDAP_DN_FORMAT_LDAP,
178 &out, LDAP_DN_FORMAT_UFN );
184 * RFC 1823 ldap_explode_dn
187 ldap_explode_dn( LDAP_CONST char *dn, int notypes )
190 char **values = NULL;
192 unsigned flag = notypes ? LDAP_DN_FORMAT_UFN : LDAP_DN_FORMAT_LDAPV3;
195 LDAP_LOG ( OPERATION, ENTRY, "ldap_explode_dn\n", 0, 0, 0 );
197 Debug( LDAP_DEBUG_TRACE, "ldap_explode_dn\n", 0, 0, 0 );
200 if ( ldap_str2dn( dn, &tmpDN, LDAP_DN_FORMAT_LDAP )
205 if( tmpDN == NULL ) {
206 values = LDAP_MALLOC( sizeof( char * ) );
207 if( values == NULL ) return NULL;
213 for ( iRDN = 0; tmpDN[ iRDN ]; iRDN++ );
215 values = LDAP_MALLOC( sizeof( char * ) * ( 1 + iRDN ) );
216 if ( values == NULL ) {
217 ldap_dnfree( tmpDN );
221 for ( iRDN = 0; tmpDN[ iRDN ]; iRDN++ ) {
222 ldap_rdn2str( tmpDN[ iRDN ], &values[ iRDN ], flag );
224 ldap_dnfree( tmpDN );
225 values[ iRDN ] = NULL;
231 ldap_explode_rdn( LDAP_CONST char *rdn, int notypes )
234 char **values = NULL;
239 LDAP_LOG ( OPERATION, ENTRY, "ldap_explode_rdn\n", 0, 0, 0 );
241 Debug( LDAP_DEBUG_TRACE, "ldap_explode_rdn\n", 0, 0, 0 );
245 * we only parse the first rdn
246 * FIXME: we prefer efficiency over checking if the _ENTIRE_
249 if ( ldap_str2rdn( rdn, &tmpRDN, (char **) &p, LDAP_DN_FORMAT_LDAP )
254 for ( iAVA = 0; tmpRDN[ iAVA ]; iAVA++ ) ;
255 values = LDAP_MALLOC( sizeof( char * ) * ( 1 + iAVA ) );
256 if ( values == NULL ) {
257 ldap_rdnfree( tmpRDN );
261 for ( iAVA = 0; tmpRDN[ iAVA ]; iAVA++ ) {
262 ber_len_t l = 0, vl, al = 0;
264 LDAPAVA *ava = tmpRDN[ iAVA ];
266 if ( ava->la_flags & LDAP_AVA_BINARY ) {
267 vl = 1 + 2 * ava->la_value.bv_len;
270 if ( strval2strlen( &ava->la_value,
271 ava->la_flags, &vl ) ) {
277 al = ava->la_attr.bv_len;
278 l = vl + ava->la_attr.bv_len + 1;
280 str = LDAP_MALLOC( l + 1 );
281 AC_MEMCPY( str, ava->la_attr.bv_val,
282 ava->la_attr.bv_len );
287 str = LDAP_MALLOC( l + 1 );
290 if ( ava->la_flags & LDAP_AVA_BINARY ) {
292 if ( binval2hexstr( &ava->la_value, &str[ al ] ) ) {
297 if ( strval2str( &ava->la_value, &str[ al ],
298 ava->la_flags, &vl ) ) {
304 values[ iAVA ] = str;
306 values[ iAVA ] = NULL;
308 ldap_rdnfree( tmpRDN );
313 LBER_VFREE( values );
314 ldap_rdnfree( tmpRDN );
319 ldap_dn2dcedn( LDAP_CONST char *dn )
324 LDAP_LOG ( OPERATION, ENTRY, "ldap_dn2dcedn\n", 0, 0, 0 );
326 Debug( LDAP_DEBUG_TRACE, "ldap_dn2dcedn\n", 0, 0, 0 );
329 ( void )ldap_dn_normalize( dn, LDAP_DN_FORMAT_LDAP,
330 &out, LDAP_DN_FORMAT_DCE );
336 ldap_dcedn2dn( LDAP_CONST char *dce )
341 LDAP_LOG ( OPERATION, ENTRY, "ldap_dcedn2dn\n", 0, 0, 0 );
343 Debug( LDAP_DEBUG_TRACE, "ldap_dcedn2dn\n", 0, 0, 0 );
346 ( void )ldap_dn_normalize( dce, LDAP_DN_FORMAT_DCE, &out, LDAP_DN_FORMAT_LDAPV3 );
352 ldap_dn2ad_canonical( LDAP_CONST char *dn )
357 LDAP_LOG ( OPERATION, ENTRY, "ldap_dn2ad_canonical\n", 0, 0, 0 );
359 Debug( LDAP_DEBUG_TRACE, "ldap_dn2ad_canonical\n", 0, 0, 0 );
362 ( void )ldap_dn_normalize( dn, LDAP_DN_FORMAT_LDAP,
363 &out, LDAP_DN_FORMAT_AD_CANONICAL );
369 * function that changes the string representation of dnin
370 * from ( fin & LDAP_DN_FORMAT_MASK ) to ( fout & LDAP_DN_FORMAT_MASK )
373 * LDAP_DN_FORMAT_LDAP (rfc 2253 and ldapbis liberal,
374 * plus some rfc 1779)
375 * LDAP_DN_FORMAT_LDAPV3 (rfc 2253 and ldapbis)
376 * LDAP_DN_FORMAT_LDAPV2 (rfc 1779)
377 * LDAP_DN_FORMAT_DCE (?)
379 * fout can be any of the above except
380 * LDAP_DN_FORMAT_LDAP
382 * LDAP_DN_FORMAT_UFN (rfc 1781, partial and with extensions)
383 * LDAP_DN_FORMAT_AD_CANONICAL (?)
386 ldap_dn_normalize( LDAP_CONST char *dnin,
387 unsigned fin, char **dnout, unsigned fout )
393 LDAP_LOG ( OPERATION, ENTRY, "ldap_dn_normalize\n", 0, 0, 0 );
395 Debug( LDAP_DEBUG_TRACE, "ldap_dn_normalize\n", 0, 0, 0 );
402 if ( dnin == NULL ) {
403 return( LDAP_SUCCESS );
406 rc = ldap_str2dn( dnin , &tmpDN, fin );
407 if ( rc != LDAP_SUCCESS ) {
411 rc = ldap_dn2str( tmpDN, dnout, fout );
413 ldap_dnfree( tmpDN );
421 /* #define B4ATTRTYPE 0x0001 */
422 #define B4OIDATTRTYPE 0x0002
423 #define B4STRINGATTRTYPE 0x0003
425 #define B4AVAEQUALS 0x0100
426 #define B4AVASEP 0x0200
427 #define B4RDNSEP 0x0300
428 #define GOTAVA 0x0400
430 #define B4ATTRVALUE 0x0010
431 #define B4STRINGVALUE 0x0020
432 #define B4IA5VALUEQUOTED 0x0030
433 #define B4IA5VALUE 0x0040
434 #define B4BINARYVALUE 0x0050
437 * Helpers (mostly from slap.h)
438 * c is assumed to Unicode in an ASCII compatible format (UTF-8)
439 * Macros assume "C" Locale (ASCII)
441 #define LDAP_DN_ASCII_SPACE(c) \
442 ( (c) == ' ' || (c) == '\t' || (c) == '\n' || (c) == '\r' )
443 #define LDAP_DN_ASCII_LOWER(c) LDAP_LOWER(c)
444 #define LDAP_DN_ASCII_UPPER(c) LDAP_UPPER(c)
445 #define LDAP_DN_ASCII_ALPHA(c) LDAP_ALPHA(c)
447 #define LDAP_DN_ASCII_DIGIT(c) LDAP_DIGIT(c)
448 #define LDAP_DN_ASCII_LCASE_HEXALPHA(c) LDAP_HEXLOWER(c)
449 #define LDAP_DN_ASCII_UCASE_HEXALPHA(c) LDAP_HEXUPPER(c)
450 #define LDAP_DN_ASCII_HEXDIGIT(c) LDAP_HEX(c)
451 #define LDAP_DN_ASCII_ALNUM(c) LDAP_ALNUM(c)
452 #define LDAP_DN_ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
455 #define LDAP_DN_OID_LEADCHAR(c) LDAP_DIGIT(c)
456 #define LDAP_DN_DESC_LEADCHAR(c) LDAP_ALPHA(c)
457 #define LDAP_DN_DESC_CHAR(c) LDAP_LDH(c)
458 #define LDAP_DN_LANG_SEP(c) ( (c) == ';' )
459 #define LDAP_DN_ATTRDESC_CHAR(c) \
460 ( LDAP_DN_DESC_CHAR(c) || LDAP_DN_LANG_SEP(c) )
462 /* special symbols */
463 #define LDAP_DN_AVA_EQUALS(c) ( (c) == '=' )
464 #define LDAP_DN_AVA_SEP(c) ( (c) == '+' )
465 #define LDAP_DN_RDN_SEP(c) ( (c) == ',' )
466 #define LDAP_DN_RDN_SEP_V2(c) ( LDAP_DN_RDN_SEP(c) || (c) == ';' )
467 #define LDAP_DN_OCTOTHORPE(c) ( (c) == '#' )
468 #define LDAP_DN_QUOTES(c) ( (c) == '\"' )
469 #define LDAP_DN_ESCAPE(c) ( (c) == '\\' )
470 #define LDAP_DN_VALUE_END(c) \
471 ( LDAP_DN_RDN_SEP(c) || LDAP_DN_AVA_SEP(c) )
472 #define LDAP_DN_NE(c) \
473 ( LDAP_DN_RDN_SEP_V2(c) || LDAP_DN_AVA_SEP(c) \
474 || LDAP_DN_AVA_EQUALS(c) || LDAP_DN_QUOTES(c) \
475 || (c) == '<' || (c) == '>' )
476 #define LDAP_DN_MAYESCAPE(c) \
477 ( LDAP_DN_ESCAPE(c) || LDAP_DN_NE(c) \
478 || LDAP_DN_ASCII_SPACE(c) || LDAP_DN_OCTOTHORPE(c) )
479 #define LDAP_DN_NEEDESCAPE(c) \
480 ( LDAP_DN_ESCAPE(c) || LDAP_DN_NE(c) )
481 #define LDAP_DN_NEEDESCAPE_LEAD(c) LDAP_DN_MAYESCAPE(c)
482 #define LDAP_DN_NEEDESCAPE_TRAIL(c) \
483 ( LDAP_DN_ASCII_SPACE(c) || LDAP_DN_NEEDESCAPE(c) )
484 #define LDAP_DN_WILLESCAPE_CHAR(c) \
485 ( LDAP_DN_RDN_SEP(c) || LDAP_DN_AVA_SEP(c) || LDAP_DN_ESCAPE(c) )
486 #define LDAP_DN_IS_PRETTY(f) ( (f) & LDAP_DN_PRETTY )
487 #define LDAP_DN_WILLESCAPE_HEX(f, c) \
488 ( ( !LDAP_DN_IS_PRETTY( f ) ) && LDAP_DN_WILLESCAPE_CHAR(c) )
491 #define LDAP_DN_VALUE_END_V2(c) \
492 ( LDAP_DN_RDN_SEP_V2(c) || LDAP_DN_AVA_SEP(c) )
494 #define LDAP_DN_V2_SPECIAL(c) \
495 ( LDAP_DN_RDN_SEP_V2(c) || LDAP_DN_AVA_EQUALS(c) \
496 || LDAP_DN_AVA_SEP(c) || (c) == '<' || (c) == '>' \
497 || LDAP_DN_OCTOTHORPE(c) )
498 #define LDAP_DN_V2_PAIR(c) \
499 ( LDAP_DN_V2_SPECIAL(c) || LDAP_DN_ESCAPE(c) || LDAP_DN_QUOTES(c) )
502 * DCE (mostly from Luke Howard and IBM implementation for AIX)
504 * From: "Application Development Guide - Directory Services" (FIXME: add link?)
505 * Here escapes and valid chars for GDS are considered; as soon as more
506 * specific info is found, the macros will be updated.
508 * Chars: 'a'-'z', 'A'-'Z', '0'-'9',
509 * '.', ':', ',', ''', '+', '-', '=', '(', ')', '?', '/', ' '.
511 * Metachars: '/', ',', '=', '\'.
513 * the '\' is used to escape other metachars.
519 * Attribute types must start with alphabetic chars and can contain
520 * alphabetic chars and digits (FIXME: no '-'?). OIDs are allowed.
522 #define LDAP_DN_RDN_SEP_DCE(c) ( (c) == '/' )
523 #define LDAP_DN_AVA_SEP_DCE(c) ( (c) == ',' )
524 #define LDAP_DN_ESCAPE_DCE(c) ( LDAP_DN_ESCAPE(c) )
525 #define LDAP_DN_VALUE_END_DCE(c) \
526 ( LDAP_DN_RDN_SEP_DCE(c) || LDAP_DN_AVA_SEP_DCE(c) )
527 #define LDAP_DN_NEEDESCAPE_DCE(c) \
528 ( LDAP_DN_VALUE_END_DCE(c) || LDAP_DN_AVA_EQUALS(c) )
531 #define LDAP_DN_RDN_SEP_AD(c) ( (c) == '/' )
532 #define LDAP_DN_ESCAPE_AD(c) ( LDAP_DN_ESCAPE(c) )
533 #define LDAP_DN_AVA_SEP_AD(c) ( (c) == ',' ) /* assume same as DCE */
534 #define LDAP_DN_VALUE_END_AD(c) \
535 ( LDAP_DN_RDN_SEP_AD(c) || LDAP_DN_AVA_SEP_AD(c) )
536 #define LDAP_DN_NEEDESCAPE_AD(c) \
537 ( LDAP_DN_VALUE_END_AD(c) || LDAP_DN_AVA_EQUALS(c) )
540 #define LDAP_DN_HEXPAIR(s) \
541 ( LDAP_DN_ASCII_HEXDIGIT((s)[0]) && LDAP_DN_ASCII_HEXDIGIT((s)[1]) )
542 /* better look at the AttributeDescription? */
544 /* FIXME: no composite rdn or non-"dc" types, right?
545 * (what about "dc" in OID form?) */
546 /* FIXME: we do not allow binary values in domain, right? */
547 /* NOTE: use this macro only when ABSOLUTELY SURE rdn IS VALID! */
548 /* NOTE: don't use strcasecmp() as it is locale specific! */
549 #define LDAP_DC_ATTR "dc"
550 #define LDAP_DC_ATTRU "DC"
551 #define LDAP_DN_IS_RDN_DC( r ) \
552 ( (r) && (r)[0] && !(r)[1] \
553 && ((r)[0]->la_flags & LDAP_AVA_STRING) \
554 && ((r)[0]->la_attr.bv_len == 2) \
555 && (((r)[0]->la_attr.bv_val[0] == LDAP_DC_ATTR[0]) \
556 || ((r)[0]->la_attr.bv_val[0] == LDAP_DC_ATTRU[0])) \
557 && (((r)[0]->la_attr.bv_val[1] == LDAP_DC_ATTR[1]) \
558 || ((r)[0]->la_attr.bv_val[1] == LDAP_DC_ATTRU[1])))
560 /* Composite rules */
561 #define LDAP_DN_ALLOW_ONE_SPACE(f) \
562 ( LDAP_DN_LDAPV2(f) \
563 || !( (f) & LDAP_DN_P_NOSPACEAFTERRDN ) )
564 #define LDAP_DN_ALLOW_SPACES(f) \
565 ( LDAP_DN_LDAPV2(f) \
566 || !( (f) & ( LDAP_DN_P_NOLEADTRAILSPACES | LDAP_DN_P_NOSPACEAFTERRDN ) ) )
567 #define LDAP_DN_LDAP(f) \
568 ( ( (f) & LDAP_DN_FORMAT_MASK ) == LDAP_DN_FORMAT_LDAP )
569 #define LDAP_DN_LDAPV3(f) \
570 ( ( (f) & LDAP_DN_FORMAT_MASK ) == LDAP_DN_FORMAT_LDAPV3 )
571 #define LDAP_DN_LDAPV2(f) \
572 ( ( (f) & LDAP_DN_FORMAT_MASK ) == LDAP_DN_FORMAT_LDAPV2 )
573 #define LDAP_DN_DCE(f) \
574 ( ( (f) & LDAP_DN_FORMAT_MASK ) == LDAP_DN_FORMAT_DCE )
575 #define LDAP_DN_UFN(f) \
576 ( ( (f) & LDAP_DN_FORMAT_MASK ) == LDAP_DN_FORMAT_UFN )
577 #define LDAP_DN_ADC(f) \
578 ( ( (f) & LDAP_DN_FORMAT_MASK ) == LDAP_DN_FORMAT_AD_CANONICAL )
579 #define LDAP_DN_FORMAT(f) ( (f) & LDAP_DN_FORMAT_MASK )
582 * LDAPAVA helpers (will become part of the API for operations
583 * on structural representations of DNs).
586 ldapava_new( const struct berval *attr, const struct berval *val,
587 unsigned flags, void *ctx )
594 ava = LDAP_MALLOCX( sizeof( LDAPAVA ) + attr->bv_len + 1, ctx );
597 ava->la_attr.bv_len = attr->bv_len;
598 ava->la_attr.bv_val = (char *)(ava+1);
599 AC_MEMCPY( ava->la_attr.bv_val, attr->bv_val, attr->bv_len );
600 ava->la_attr.bv_val[attr->bv_len] = '\0';
602 ava->la_value = *val;
603 ava->la_flags = flags | LDAP_AVA_FREE_VALUE;
605 ava->la_private = NULL;
612 ldapava_free( LDAPAVA *ava, void *ctx )
617 /* ava's private must be freed by caller
618 * (at present let's skip this check because la_private
619 * basically holds static data) */
620 assert( ava->la_private == NULL );
623 if (ava->la_flags & LDAP_AVA_FREE_VALUE)
624 LDAP_FREEX( ava->la_value.bv_val, ctx );
626 LDAP_FREEX( ava, ctx );
630 ldap_rdnfree( LDAPRDN rdn )
632 ldap_rdnfree_x( rdn, NULL );
636 ldap_rdnfree_x( LDAPRDN rdn, void *ctx )
644 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
645 ldapava_free( rdn[ iAVA ], ctx );
648 LDAP_FREEX( rdn, ctx );
652 ldap_dnfree( LDAPDN dn )
654 ldap_dnfree_x( dn, NULL );
658 ldap_dnfree_x( LDAPDN dn, void *ctx )
666 for ( iRDN = 0; dn[ iRDN ]; iRDN++ ) {
667 ldap_rdnfree_x( dn[ iRDN ], ctx );
670 LDAP_FREEX( dn, ctx );
674 * Converts a string representation of a DN (in LDAPv3, LDAPv2 or DCE)
675 * into a structural representation of the DN, by separating attribute
676 * types and values encoded in the more appropriate form, which is
677 * string or OID for attribute types and binary form of the BER encoded
678 * value or Unicode string. Formats different from LDAPv3 are parsed
679 * according to their own rules and turned into the more appropriate
680 * form according to LDAPv3.
682 * NOTE: I realize the code is getting spaghettish; it is rather
683 * experimental and will hopefully turn into something more simple
684 * and readable as soon as it works as expected.
688 * Default sizes of AVA and RDN static working arrays; if required
689 * the are dynamically resized. The values can be tuned in case
690 * of special requirements (e.g. very deep DN trees or high number
693 #define TMP_AVA_SLOTS 8
694 #define TMP_RDN_SLOTS 32
697 ldap_str2dn( LDAP_CONST char *str, LDAPDN *dn, unsigned flags )
703 bv.bv_len = strlen( str );
704 bv.bv_val = (char *) str;
706 return ldap_bv2dn_x( &bv, dn, flags, NULL );
710 ldap_bv2dn( struct berval *bv, LDAPDN *dn, unsigned flags )
712 return ldap_bv2dn_x( bv, dn, flags, NULL );
716 ldap_bv2dn_x( struct berval *bvin, LDAPDN *dn, unsigned flags, void *ctx )
719 int rc = LDAP_DECODING_ERROR;
723 LDAPRDN newRDN = NULL, tmpDN_[TMP_RDN_SLOTS], *tmpDN = tmpDN_;
724 int num_slots = TMP_RDN_SLOTS;
726 struct berval bvtmp, *bv = &bvtmp;
729 assert( bvin->bv_val );
734 end = str + bv->bv_len;
737 LDAP_LOG ( OPERATION, ARGS, "ldap_bv2dn(%s,%u)\n%s", str, flags, "" );
739 Debug( LDAP_DEBUG_TRACE, "=> ldap_bv2dn(%s,%u)\n%s", str, flags, "" );
744 switch ( LDAP_DN_FORMAT( flags ) ) {
745 case LDAP_DN_FORMAT_LDAP:
746 case LDAP_DN_FORMAT_LDAPV3:
747 case LDAP_DN_FORMAT_DCE:
750 /* allow DN enclosed in brackets */
751 case LDAP_DN_FORMAT_LDAPV2:
752 if ( str[0] == '<' ) {
753 if ( bv->bv_len < 2 || end[ -1 ] != '>' ) {
754 rc = LDAP_DECODING_ERROR;
764 /* unsupported in str2dn */
765 case LDAP_DN_FORMAT_UFN:
766 case LDAP_DN_FORMAT_AD_CANONICAL:
767 return LDAP_PARAM_ERROR;
769 case LDAP_DN_FORMAT_LBER:
771 return LDAP_PARAM_ERROR;
774 if ( bv->bv_len == 0 ) {
778 if( memchr( bv->bv_val, '\0', bv->bv_len ) != NULL ) {
779 /* value must have embedded NULs */
780 return LDAP_DECODING_ERROR;
784 if ( LDAP_DN_DCE( flags ) ) {
787 * (from Luke Howard: thnx) A RDN separator is required
788 * at the beginning of an (absolute) DN.
790 if ( !LDAP_DN_RDN_SEP_DCE( p[ 0 ] ) ) {
796 * actually we do not want to accept by default the DCE form,
797 * we do not want to auto-detect it
800 } else if ( LDAP_DN_LDAP( flags ) ) {
802 * if dn starts with '/' let's make it a DCE dn
804 if ( LDAP_DN_RDN_SEP_DCE( p[ 0 ] ) ) {
805 flags |= LDAP_DN_FORMAT_DCE;
811 for ( ; p < end; p++ ) {
814 tmpbv.bv_len = bv->bv_len - ( p - str );
815 tmpbv.bv_val = (char *)p;
817 err = ldap_bv2rdn_x( &tmpbv, &newRDN, (char **) &p, flags,ctx);
818 if ( err != LDAP_SUCCESS ) {
823 * We expect a rdn separator
825 if ( p < end && p[ 0 ] ) {
826 switch ( LDAP_DN_FORMAT( flags ) ) {
827 case LDAP_DN_FORMAT_LDAPV3:
828 if ( !LDAP_DN_RDN_SEP( p[ 0 ] ) ) {
829 rc = LDAP_DECODING_ERROR;
834 case LDAP_DN_FORMAT_LDAP:
835 case LDAP_DN_FORMAT_LDAPV2:
836 if ( !LDAP_DN_RDN_SEP_V2( p[ 0 ] ) ) {
837 rc = LDAP_DECODING_ERROR;
842 case LDAP_DN_FORMAT_DCE:
843 if ( !LDAP_DN_RDN_SEP_DCE( p[ 0 ] ) ) {
844 rc = LDAP_DECODING_ERROR;
852 tmpDN[nrdns++] = newRDN;
856 * make the static RDN array dynamically rescalable
858 if ( nrdns == num_slots ) {
861 if ( tmpDN == tmpDN_ ) {
862 tmp = LDAP_MALLOCX( num_slots * 2 * sizeof( LDAPRDN * ), ctx );
867 AC_MEMCPY( tmp, tmpDN, num_slots * sizeof( LDAPRDN * ) );
870 tmp = LDAP_REALLOCX( tmpDN, num_slots * 2 * sizeof( LDAPRDN * ), ctx );
881 if ( p >= end || p[ 0 ] == '\0' ) {
883 * the DN is over, phew
885 newDN = (LDAPDN)LDAP_MALLOCX( sizeof(LDAPRDN *) * (nrdns+1), ctx );
886 if ( newDN == NULL ) {
892 if ( LDAP_DN_DCE( flags ) ) {
893 /* add in reversed order */
894 for ( i=0; i<nrdns; i++ )
895 newDN[i] = tmpDN[nrdns-1-i];
897 for ( i=0; i<nrdns; i++ )
909 ldap_rdnfree_x( newRDN, ctx );
912 for ( nrdns-- ;nrdns >= 0; nrdns-- ) {
913 ldap_rdnfree_x( tmpDN[nrdns], ctx );
918 if ( tmpDN != tmpDN_ ) {
919 LDAP_FREEX( tmpDN, ctx );
923 LDAP_LOG ( OPERATION, RESULTS, "<= ldap_bv2dn(%s,%u)=%d\n",
926 Debug( LDAP_DEBUG_TRACE, "<= ldap_bv2dn(%s,%u)=%d\n", str, flags, rc );
936 * Parses a relative DN according to flags up to a rdn separator
937 * or to the end of str.
938 * Returns the rdn and a pointer to the string continuation, which
939 * corresponds to the rdn separator or to '\0' in case the string is over.
942 ldap_str2rdn( LDAP_CONST char *str, LDAPRDN *rdn,
943 char **n_in, unsigned flags )
948 assert( str[ 0 ] != '\0' ); /* FIXME: is this required? */
950 bv.bv_len = strlen( str );
951 bv.bv_val = (char *) str;
953 return ldap_bv2rdn_x( &bv, rdn, n_in, flags, NULL );
957 ldap_bv2rdn( struct berval *bv, LDAPRDN *rdn,
958 char **n_in, unsigned flags )
960 return ldap_bv2rdn_x( bv, rdn, n_in, flags, NULL );
964 ldap_bv2rdn_x( struct berval *bv, LDAPRDN *rdn,
965 char **n_in, unsigned flags, void *ctx )
967 const char **n = (const char **) n_in;
971 int rc = LDAP_DECODING_ERROR;
972 int attrTypeEncoding = LDAP_AVA_STRING,
973 attrValueEncoding = LDAP_AVA_STRING;
975 struct berval attrType = BER_BVNULL;
976 struct berval attrValue = BER_BVNULL;
978 LDAPRDN newRDN = NULL;
979 LDAPAVA *tmpRDN_[TMP_AVA_SLOTS], **tmpRDN = tmpRDN_;
980 int num_slots = TMP_AVA_SLOTS;
986 assert( bv->bv_len );
987 assert( bv->bv_val );
988 assert( rdn || flags & LDAP_DN_SKIP );
992 stoplen = bv->bv_len;
999 switch ( LDAP_DN_FORMAT( flags ) ) {
1000 case LDAP_DN_FORMAT_LDAP:
1001 case LDAP_DN_FORMAT_LDAPV3:
1002 case LDAP_DN_FORMAT_LDAPV2:
1003 case LDAP_DN_FORMAT_DCE:
1006 /* unsupported in str2dn */
1007 case LDAP_DN_FORMAT_UFN:
1008 case LDAP_DN_FORMAT_AD_CANONICAL:
1009 return LDAP_PARAM_ERROR;
1011 case LDAP_DN_FORMAT_LBER:
1013 return LDAP_PARAM_ERROR;
1016 if ( bv->bv_len == 0 ) {
1017 return LDAP_SUCCESS;
1021 if( memchr( bv->bv_val, '\0', bv->bv_len ) != NULL ) {
1022 /* value must have embedded NULs */
1023 return LDAP_DECODING_ERROR;
1027 for ( ; p[ 0 ] || state == GOTAVA; ) {
1030 * The parser in principle advances one token a time,
1031 * or toggles state if preferable.
1036 * an AttributeType can be encoded as:
1037 * - its string representation; in detail, implementations
1038 * MUST recognize AttributeType string type names listed
1039 * in section 2.3 of draft-ietf-ldapbis-dn-XX.txt, and
1040 * MAY recognize other names.
1041 * - its numeric OID (a dotted decimal string); in detail
1042 * RFC 2253 asserts that ``Implementations MUST allow
1043 * an oid in the attribute type to be prefixed by one
1044 * of the character strings "oid." or "OID."''. As soon
1045 * as draft-ietf-ldapbis-dn-XX.txt obsoletes RFC 2253
1046 * I'm not sure whether this is required or not any
1047 * longer; to be liberal, we still implement it.
1050 if ( LDAP_DN_ASCII_SPACE( p[ 0 ] ) ) {
1051 if ( !LDAP_DN_ALLOW_ONE_SPACE( flags ) ) {
1058 if ( LDAP_DN_ASCII_SPACE( p[ 0 ] ) ) {
1059 if ( !LDAP_DN_ALLOW_SPACES( flags ) ) {
1064 /* whitespace is allowed (and trimmed) */
1066 while ( p[ 0 ] && LDAP_DN_ASCII_SPACE( p[ 0 ] ) ) {
1071 /* error: we expected an AVA */
1077 if ( LDAP_DN_OID_LEADCHAR( p[ 0 ] ) ) {
1078 state = B4OIDATTRTYPE;
1082 /* else must be alpha */
1083 if ( !LDAP_DN_DESC_LEADCHAR( p[ 0 ] ) ) {
1087 /* LDAPv2 "oid." prefix */
1088 if ( LDAP_DN_LDAPV2( flags ) ) {
1090 * to be overly pedantic, we only accept
1093 if ( flags & LDAP_DN_PEDANTIC ) {
1094 if ( !strncmp( p, "OID.", 4 )
1095 || !strncmp( p, "oid.", 4 ) ) {
1097 state = B4OIDATTRTYPE;
1101 if ( !strncasecmp( p, "oid.", 4 ) ) {
1103 state = B4OIDATTRTYPE;
1109 state = B4STRINGATTRTYPE;
1112 case B4OIDATTRTYPE: {
1113 int err = LDAP_SUCCESS;
1115 attrType.bv_val = ldap_int_parse_numericoid( &p, &err,
1118 if ( err != LDAP_SUCCESS ) {
1121 attrType.bv_len = p - attrType.bv_val;
1123 attrTypeEncoding = LDAP_AVA_BINARY;
1125 state = B4AVAEQUALS;
1129 case B4STRINGATTRTYPE: {
1130 const char *startPos, *endPos = NULL;
1134 * the starting char has been found to be
1135 * a LDAP_DN_DESC_LEADCHAR so we don't re-check it
1136 * FIXME: DCE attr types seem to have a more
1137 * restrictive syntax (no '-' ...)
1139 for ( startPos = p++; p[ 0 ]; p++ ) {
1140 if ( LDAP_DN_DESC_CHAR( p[ 0 ] ) ) {
1144 if ( LDAP_DN_LANG_SEP( p[ 0 ] ) ) {
1147 * RFC 2253 does not explicitly
1148 * allow lang extensions to attribute
1151 if ( flags & LDAP_DN_PEDANTIC ) {
1156 * we trim ';' and following lang
1157 * and so from attribute types
1160 for ( ; LDAP_DN_ATTRDESC_CHAR( p[ 0 ] )
1161 || LDAP_DN_LANG_SEP( p[ 0 ] ); p++ ) {
1169 len = ( endPos ? endPos : p ) - startPos;
1174 attrTypeEncoding = LDAP_AVA_STRING;
1177 * here we need to decide whether to use it as is
1178 * or turn it in OID form; as a consequence, we
1179 * need to decide whether to binary encode the value
1182 state = B4AVAEQUALS;
1184 if ( flags & LDAP_DN_SKIP ) {
1188 attrType.bv_val = (char *)startPos;
1189 attrType.bv_len = len;
1195 /* spaces may not be allowed */
1196 if ( LDAP_DN_ASCII_SPACE( p[ 0 ] ) ) {
1197 if ( !LDAP_DN_ALLOW_SPACES( flags ) ) {
1202 for ( p++; LDAP_DN_ASCII_SPACE( p[ 0 ] ); p++ ) {
1207 /* need equal sign */
1208 if ( !LDAP_DN_AVA_EQUALS( p[ 0 ] ) ) {
1213 /* spaces may not be allowed */
1214 if ( LDAP_DN_ASCII_SPACE( p[ 0 ] ) ) {
1215 if ( !LDAP_DN_ALLOW_SPACES( flags ) ) {
1220 for ( p++; LDAP_DN_ASCII_SPACE( p[ 0 ] ); p++ ) {
1226 * octothorpe means a BER encoded value will follow
1227 * FIXME: I don't think DCE will allow it
1229 if ( LDAP_DN_OCTOTHORPE( p[ 0 ] ) ) {
1231 attrValueEncoding = LDAP_AVA_BINARY;
1232 state = B4BINARYVALUE;
1236 /* STRING value expected */
1239 * if we're pedantic, an attribute type in OID form
1240 * SHOULD imply a BER encoded attribute value; we
1241 * should at least issue a warning
1243 if ( ( flags & LDAP_DN_PEDANTIC )
1244 && ( attrTypeEncoding == LDAP_AVA_BINARY ) ) {
1245 /* OID attrType SHOULD use binary encoding */
1249 attrValueEncoding = LDAP_AVA_STRING;
1252 * LDAPv2 allows the attribute value to be quoted;
1253 * also, IA5 values are expected, in principle
1255 if ( LDAP_DN_LDAPV2( flags ) || LDAP_DN_LDAP( flags ) ) {
1256 if ( LDAP_DN_QUOTES( p[ 0 ] ) ) {
1258 state = B4IA5VALUEQUOTED;
1262 if ( LDAP_DN_LDAPV2( flags ) ) {
1269 * here STRING means RFC 2253 string
1270 * FIXME: what about DCE strings?
1276 state = B4STRINGVALUE;
1281 if ( hexstr2binval( p, &attrValue, &p, flags, ctx ) ) {
1289 switch ( LDAP_DN_FORMAT( flags ) ) {
1290 case LDAP_DN_FORMAT_LDAP:
1291 case LDAP_DN_FORMAT_LDAPV3:
1292 if ( str2strval( p, stoplen - ( p - str ),
1293 &attrValue, &p, flags,
1294 &attrValueEncoding, ctx ) ) {
1299 case LDAP_DN_FORMAT_DCE:
1300 if ( DCE2strval( p, &attrValue, &p, flags, ctx ) ) {
1313 if ( IA52strval( p, &attrValue, &p, flags, ctx ) ) {
1320 case B4IA5VALUEQUOTED:
1322 /* lead quote already stripped */
1323 if ( quotedIA52strval( p, &attrValue,
1324 &p, flags, ctx ) ) {
1334 if ( !( flags & LDAP_DN_SKIP ) ) {
1338 * we accept empty values
1340 ava = ldapava_new( &attrType, &attrValue,
1341 attrValueEncoding, ctx );
1342 if ( ava == NULL ) {
1343 rc = LDAP_NO_MEMORY;
1346 tmpRDN[navas++] = ava;
1348 attrValue.bv_val = NULL;
1349 attrValue.bv_len = 0;
1352 * prepare room for new AVAs if needed
1354 if (navas == num_slots) {
1357 if ( tmpRDN == tmpRDN_ ) {
1358 tmp = LDAP_MALLOCX( num_slots * 2 * sizeof( LDAPAVA * ), ctx );
1359 if ( tmp == NULL ) {
1360 rc = LDAP_NO_MEMORY;
1363 AC_MEMCPY( tmp, tmpRDN, num_slots * sizeof( LDAPAVA * ) );
1366 tmp = LDAP_REALLOCX( tmpRDN, num_slots * 2 * sizeof( LDAPAVA * ), ctx );
1367 if ( tmp == NULL ) {
1368 rc = LDAP_NO_MEMORY;
1379 * if we got an AVA separator ('+', or ',' for DCE )
1380 * we expect a new AVA for this RDN; otherwise
1381 * we add the RDN to the DN
1383 switch ( LDAP_DN_FORMAT( flags ) ) {
1384 case LDAP_DN_FORMAT_LDAP:
1385 case LDAP_DN_FORMAT_LDAPV3:
1386 case LDAP_DN_FORMAT_LDAPV2:
1387 if ( !LDAP_DN_AVA_SEP( p[ 0 ] ) ) {
1392 case LDAP_DN_FORMAT_DCE:
1393 if ( !LDAP_DN_AVA_SEP_DCE( p[ 0 ] ) ) {
1401 * the RDN is over, phew
1404 if ( !( flags & LDAP_DN_SKIP ) ) {
1405 newRDN = (LDAPRDN)LDAP_MALLOCX(
1406 sizeof(LDAPAVA) * (navas+1), ctx );
1407 if ( newRDN == NULL ) {
1408 rc = LDAP_NO_MEMORY;
1411 AC_MEMCPY( newRDN, tmpRDN, sizeof(LDAPAVA *) * navas);
1412 newRDN[navas] = NULL;
1420 /* they should have been used in an AVA */
1421 attrType.bv_val = NULL;
1422 attrValue.bv_val = NULL;
1437 /* They are set to NULL after they're used in an AVA */
1439 if ( attrValue.bv_val ) {
1440 LDAP_FREEX( attrValue.bv_val, ctx );
1443 for ( navas-- ; navas >= 0; navas-- ) {
1444 ldapava_free( tmpRDN[navas], ctx );
1449 if ( tmpRDN != tmpRDN_ ) {
1450 LDAP_FREEX( tmpRDN, ctx );
1461 * reads in a UTF-8 string value, unescaping stuff:
1462 * '\' + LDAP_DN_NEEDESCAPE(c) -> 'c'
1463 * '\' + HEXPAIR(p) -> unhex(p)
1466 str2strval( const char *str, ber_len_t stoplen, struct berval *val, const char **next, unsigned flags, int *retFlags, void *ctx )
1468 const char *p, *end, *startPos, *endPos = NULL;
1469 ber_len_t len, escapes;
1476 end = str + stoplen;
1477 for ( startPos = p = str, escapes = 0; p < end; p++ ) {
1478 if ( LDAP_DN_ESCAPE( p[ 0 ] ) ) {
1480 if ( p[ 0 ] == '\0' ) {
1483 if ( LDAP_DN_MAYESCAPE( p[ 0 ] ) ) {
1488 if ( LDAP_DN_HEXPAIR( p ) ) {
1491 hexstr2bin( p, &c );
1494 if ( !LDAP_DN_ASCII_PRINTABLE( c ) ) {
1497 * we assume the string is UTF-8
1499 *retFlags = LDAP_AVA_NONPRINTABLE;
1506 if ( LDAP_DN_PEDANTIC & flags ) {
1510 * we do not allow escaping
1511 * of chars that don't need
1512 * to and do not belong to
1517 } else if (!LDAP_DN_ASCII_PRINTABLE( p[ 0 ] ) ) {
1518 if ( p[ 0 ] == '\0' ) {
1521 *retFlags = LDAP_AVA_NONPRINTABLE;
1523 } else if ( ( LDAP_DN_LDAP( flags ) && LDAP_DN_VALUE_END_V2( p[ 0 ] ) )
1524 || ( LDAP_DN_LDAPV3( flags ) && LDAP_DN_VALUE_END( p[ 0 ] ) ) ) {
1527 } else if ( LDAP_DN_NEEDESCAPE( p[ 0 ] ) ) {
1529 * FIXME: maybe we can add
1530 * escapes if not pedantic?
1537 * we do allow unescaped spaces at the end
1538 * of the value only in non-pedantic mode
1540 if ( p > startPos + 1 && LDAP_DN_ASCII_SPACE( p[ -1 ] ) &&
1541 !LDAP_DN_ESCAPE( p[ -2 ] ) ) {
1542 if ( flags & LDAP_DN_PEDANTIC ) {
1546 /* strip trailing (unescaped) spaces */
1547 for ( endPos = p - 1;
1548 endPos > startPos + 1 &&
1549 LDAP_DN_ASCII_SPACE( endPos[ -1 ] ) &&
1550 !LDAP_DN_ESCAPE( endPos[ -2 ] );
1557 if ( flags & LDAP_DN_SKIP ) {
1562 * FIXME: test memory?
1564 len = ( endPos ? endPos : p ) - startPos - escapes;
1567 if ( escapes == 0 ) {
1568 if ( *retFlags & LDAP_AVA_NONPRINTABLE ) {
1569 val->bv_val = LDAP_MALLOCX( len + 1, ctx );
1570 AC_MEMCPY( val->bv_val, startPos, len );
1571 val->bv_val[ len ] = '\0';
1573 val->bv_val = LDAP_STRNDUPX( startPos, len, ctx );
1579 val->bv_val = LDAP_MALLOCX( len + 1, ctx );
1580 for ( s = 0, d = 0; d < len; ) {
1581 if ( LDAP_DN_ESCAPE( startPos[ s ] ) ) {
1583 if ( LDAP_DN_MAYESCAPE( startPos[ s ] ) ) {
1584 val->bv_val[ d++ ] =
1587 } else if ( LDAP_DN_HEXPAIR( &startPos[ s ] ) ) {
1590 hexstr2bin( &startPos[ s ], &c );
1591 val->bv_val[ d++ ] = c;
1595 /* we should never get here */
1600 val->bv_val[ d++ ] = startPos[ s++ ];
1604 val->bv_val[ d ] = '\0';
1612 DCE2strval( const char *str, struct berval *val, const char **next, unsigned flags, void *ctx )
1614 const char *p, *startPos, *endPos = NULL;
1615 ber_len_t len, escapes;
1623 for ( startPos = p = str, escapes = 0; p[ 0 ]; p++ ) {
1624 if ( LDAP_DN_ESCAPE_DCE( p[ 0 ] ) ) {
1626 if ( LDAP_DN_NEEDESCAPE_DCE( p[ 0 ] ) ) {
1633 } else if ( LDAP_DN_VALUE_END_DCE( p[ 0 ] ) ) {
1638 * FIXME: can we accept anything else? I guess we need
1639 * to stop if a value is not legal
1644 * (unescaped) trailing spaces are trimmed must be silently ignored;
1647 if ( p > startPos + 1 && LDAP_DN_ASCII_SPACE( p[ -1 ] ) &&
1648 !LDAP_DN_ESCAPE( p[ -2 ] ) ) {
1649 if ( flags & LDAP_DN_PEDANTIC ) {
1653 /* strip trailing (unescaped) spaces */
1654 for ( endPos = p - 1;
1655 endPos > startPos + 1 &&
1656 LDAP_DN_ASCII_SPACE( endPos[ -1 ] ) &&
1657 !LDAP_DN_ESCAPE( endPos[ -2 ] );
1664 if ( flags & LDAP_DN_SKIP ) {
1668 len = ( endPos ? endPos : p ) - startPos - escapes;
1670 if ( escapes == 0 ){
1671 val->bv_val = LDAP_STRNDUPX( startPos, len, ctx );
1676 val->bv_val = LDAP_MALLOCX( len + 1, ctx );
1677 for ( s = 0, d = 0; d < len; ) {
1679 * This point is reached only if escapes
1680 * are properly used, so all we need to
1683 if ( LDAP_DN_ESCAPE_DCE( startPos[ s ] ) ) {
1687 val->bv_val[ d++ ] = startPos[ s++ ];
1689 val->bv_val[ d ] = '\0';
1690 assert( strlen( val->bv_val ) == len );
1697 IA52strval( const char *str, struct berval *val, const char **next, unsigned flags, void *ctx )
1699 const char *p, *startPos, *endPos = NULL;
1700 ber_len_t len, escapes;
1712 for ( startPos = p = str, escapes = 0; p[ 0 ]; p++ ) {
1713 if ( LDAP_DN_ESCAPE( p[ 0 ] ) ) {
1715 if ( p[ 0 ] == '\0' ) {
1719 if ( !LDAP_DN_NEEDESCAPE( p[ 0 ] )
1720 && ( LDAP_DN_PEDANTIC & flags ) ) {
1725 } else if ( LDAP_DN_VALUE_END_V2( p[ 0 ] ) ) {
1730 * FIXME: can we accept anything else? I guess we need
1731 * to stop if a value is not legal
1735 /* strip trailing (unescaped) spaces */
1737 endPos > startPos + 1 &&
1738 LDAP_DN_ASCII_SPACE( endPos[ -1 ] ) &&
1739 !LDAP_DN_ESCAPE( endPos[ -2 ] );
1745 if ( flags & LDAP_DN_SKIP ) {
1749 len = ( endPos ? endPos : p ) - startPos - escapes;
1751 if ( escapes == 0 ) {
1752 val->bv_val = LDAP_STRNDUPX( startPos, len, ctx );
1757 val->bv_val = LDAP_MALLOCX( len + 1, ctx );
1758 for ( s = 0, d = 0; d < len; ) {
1759 if ( LDAP_DN_ESCAPE( startPos[ s ] ) ) {
1762 val->bv_val[ d++ ] = startPos[ s++ ];
1764 val->bv_val[ d ] = '\0';
1765 assert( strlen( val->bv_val ) == len );
1772 quotedIA52strval( const char *str, struct berval *val, const char **next, unsigned flags, void *ctx )
1774 const char *p, *startPos, *endPos = NULL;
1776 unsigned escapes = 0;
1784 /* initial quote already eaten */
1785 for ( startPos = p = str; p[ 0 ]; p++ ) {
1787 * According to RFC 1779, the quoted value can
1788 * contain escaped as well as unescaped special values;
1789 * as a consequence we tolerate escaped values
1790 * (e.g. '"\,"' -> '\,') and escape unescaped specials
1791 * (e.g. '","' -> '\,').
1793 if ( LDAP_DN_ESCAPE( p[ 0 ] ) ) {
1794 if ( p[ 1 ] == '\0' ) {
1799 if ( !LDAP_DN_V2_PAIR( p[ 0 ] )
1800 && ( LDAP_DN_PEDANTIC & flags ) ) {
1802 * do we allow to escape normal chars?
1803 * LDAPv2 does not allow any mechanism
1804 * for escaping chars with '\' and hex
1811 } else if ( LDAP_DN_QUOTES( p[ 0 ] ) ) {
1813 /* eat closing quotes */
1819 * FIXME: can we accept anything else? I guess we need
1820 * to stop if a value is not legal
1824 if ( endPos == NULL ) {
1828 /* Strip trailing (unescaped) spaces */
1829 for ( ; p[ 0 ] && LDAP_DN_ASCII_SPACE( p[ 0 ] ); p++ ) {
1834 if ( flags & LDAP_DN_SKIP ) {
1838 len = endPos - startPos - escapes;
1839 assert( endPos >= startPos + escapes );
1841 if ( escapes == 0 ) {
1842 val->bv_val = LDAP_STRNDUPX( startPos, len, ctx );
1847 val->bv_val = LDAP_MALLOCX( len + 1, ctx );
1850 for ( s = d = 0; d < len; ) {
1851 if ( LDAP_DN_ESCAPE( str[ s ] ) ) {
1854 val->bv_val[ d++ ] = str[ s++ ];
1856 val->bv_val[ d ] = '\0';
1857 assert( strlen( val->bv_val ) == len );
1864 hexstr2bin( const char *str, char *c )
1874 if ( LDAP_DN_ASCII_DIGIT( c1 ) ) {
1878 if ( LDAP_DN_ASCII_UCASE_HEXALPHA( c1 ) ) {
1881 assert( LDAP_DN_ASCII_LCASE_HEXALPHA( c1 ) );
1888 if ( LDAP_DN_ASCII_DIGIT( c2 ) ) {
1892 if ( LDAP_DN_ASCII_UCASE_HEXALPHA( c2 ) ) {
1893 *c += c2 - 'A' + 10;
1895 assert( LDAP_DN_ASCII_LCASE_HEXALPHA( c2 ) );
1896 *c += c2 - 'a' + 10;
1904 hexstr2binval( const char *str, struct berval *val, const char **next, unsigned flags, void *ctx )
1906 const char *p, *startPos, *endPos = NULL;
1916 for ( startPos = p = str; p[ 0 ]; p += 2 ) {
1917 switch ( LDAP_DN_FORMAT( flags ) ) {
1918 case LDAP_DN_FORMAT_LDAPV3:
1919 if ( LDAP_DN_VALUE_END( p[ 0 ] ) ) {
1924 case LDAP_DN_FORMAT_LDAP:
1925 case LDAP_DN_FORMAT_LDAPV2:
1926 if ( LDAP_DN_VALUE_END_V2( p[ 0 ] ) ) {
1931 case LDAP_DN_FORMAT_DCE:
1932 if ( LDAP_DN_VALUE_END_DCE( p[ 0 ] ) ) {
1938 if ( LDAP_DN_ASCII_SPACE( p[ 0 ] ) ) {
1939 if ( flags & LDAP_DN_PEDANTIC ) {
1944 for ( ; p[ 0 ]; p++ ) {
1945 switch ( LDAP_DN_FORMAT( flags ) ) {
1946 case LDAP_DN_FORMAT_LDAPV3:
1947 if ( LDAP_DN_VALUE_END( p[ 0 ] ) ) {
1952 case LDAP_DN_FORMAT_LDAP:
1953 case LDAP_DN_FORMAT_LDAPV2:
1954 if ( LDAP_DN_VALUE_END_V2( p[ 0 ] ) ) {
1959 case LDAP_DN_FORMAT_DCE:
1960 if ( LDAP_DN_VALUE_END_DCE( p[ 0 ] ) ) {
1969 if ( !LDAP_DN_HEXPAIR( p ) ) {
1977 if ( flags & LDAP_DN_SKIP ) {
1981 len = ( ( endPos ? endPos : p ) - startPos ) / 2;
1983 assert( 2 * len == (ber_len_t) (( endPos ? endPos : p ) - startPos ));
1986 val->bv_val = LDAP_MALLOCX( len + 1, ctx );
1987 if ( val->bv_val == NULL ) {
1988 return( LDAP_NO_MEMORY );
1991 for ( s = 0, d = 0; d < len; s += 2, d++ ) {
1994 hexstr2bin( &startPos[ s ], &c );
1996 val->bv_val[ d ] = c;
1999 val->bv_val[ d ] = '\0';
2005 * convert a byte in a hexadecimal pair
2008 byte2hexpair( const char *val, char *pair )
2010 static const char hexdig[] = "0123456789ABCDEF";
2016 * we assume the string has enough room for the hex encoding
2020 pair[ 0 ] = hexdig[ 0x0f & ( val[ 0 ] >> 4 ) ];
2021 pair[ 1 ] = hexdig[ 0x0f & val[ 0 ] ];
2027 * convert a binary value in hexadecimal pairs
2030 binval2hexstr( struct berval *val, char *str )
2037 if ( val->bv_len == 0 ) {
2042 * we assume the string has enough room for the hex encoding
2046 for ( s = 0, d = 0; s < val->bv_len; s++, d += 2 ) {
2047 byte2hexpair( &val->bv_val[ s ], &str[ d ] );
2054 * Length of the string representation, accounting for escaped hex
2058 strval2strlen( struct berval *val, unsigned flags, ber_len_t *len )
2060 ber_len_t l, cl = 1;
2062 int escaped_byte_len = LDAP_DN_IS_PRETTY( flags ) ? 1 : 3;
2063 #ifdef PRETTY_ESCAPE
2064 int escaped_ascii_len = LDAP_DN_IS_PRETTY( flags ) ? 2 : 3;
2065 #endif /* PRETTY_ESCAPE */
2071 if ( val->bv_len == 0 ) {
2075 for ( l = 0, p = val->bv_val; p < val->bv_val + val->bv_len; p += cl ) {
2080 if ( p[ 0 ] == '\0' ) {
2086 cl = LDAP_UTF8_CHARLEN2( p, cl );
2088 /* illegal utf-8 char! */
2091 } else if ( cl > 1 ) {
2094 for ( cnt = 1; cnt < cl; cnt++ ) {
2095 if ( ( p[ cnt ] & 0xc0 ) != 0x80 ) {
2099 l += escaped_byte_len * cl;
2101 } else if ( LDAP_DN_NEEDESCAPE( p[ 0 ] )
2102 || ( p == val->bv_val && LDAP_DN_NEEDESCAPE_LEAD( p[ 0 ] ) )
2103 || ( !p[ 1 ] && LDAP_DN_NEEDESCAPE_TRAIL( p[ 0 ] ) ) ) {
2104 #ifdef PRETTY_ESCAPE
2106 if ( LDAP_DN_WILLESCAPE_HEX( flags, p[ 0 ] ) ) {
2108 if ( LDAP_DN_WILLESCAPE_CHAR( p[ 0 ] ) ) {
2112 * there might be some chars we want
2113 * to escape in form of a couple
2114 * of hexdigits for optimization purposes
2119 l += escaped_ascii_len;
2121 #else /* ! PRETTY_ESCAPE */
2123 #endif /* ! PRETTY_ESCAPE */
2136 * convert to string representation, escaping with hex the UTF-8 stuff;
2137 * assume the destination has enough room for escaping
2140 strval2str( struct berval *val, char *str, unsigned flags, ber_len_t *len )
2142 ber_len_t s, d, end;
2148 if ( val->bv_len == 0 ) {
2154 * we assume the string has enough room for the hex encoding
2157 for ( s = 0, d = 0, end = val->bv_len - 1; s < val->bv_len; ) {
2163 if ( val->bv_val[ s ] == '\0' ) {
2173 * The length was checked in strval2strlen();
2174 * LDAP_UTF8_CHARLEN() should suffice
2176 cl = LDAP_UTF8_CHARLEN2( &val->bv_val[ s ], cl );
2180 * there might be some chars we want to escape in form
2181 * of a couple of hexdigits for optimization purposes
2183 if ( ( cl > 1 && !LDAP_DN_IS_PRETTY( flags ) )
2184 #ifdef PRETTY_ESCAPE
2186 || LDAP_DN_WILLESCAPE_HEX( flags, val->bv_val[ s ] )
2188 || LDAP_DN_WILLESCAPE_CHAR( val->bv_val[ s ] )
2190 #else /* ! PRETTY_ESCAPE */
2191 || LDAP_DN_NEEDESCAPE( val->bv_val[ s ] )
2192 || ( d == 0 && LDAP_DN_NEEDESCAPE_LEAD( val->bv_val[ s ] ) )
2193 || ( s == end && LDAP_DN_NEEDESCAPE_TRAIL( val->bv_val[ s ] ) )
2195 #endif /* ! PRETTY_ESCAPE */
2199 byte2hexpair( &val->bv_val[ s ], &str[ d ] );
2204 } else if ( cl > 1 ) {
2206 str[ d++ ] = val->bv_val[ s++ ];
2210 #ifdef PRETTY_ESCAPE
2211 if ( LDAP_DN_NEEDESCAPE( val->bv_val[ s ] )
2212 || ( d == 0 && LDAP_DN_NEEDESCAPE_LEAD( val->bv_val[ s ] ) )
2213 || ( s == end && LDAP_DN_NEEDESCAPE_TRAIL( val->bv_val[ s ] ) ) ) {
2215 if ( !LDAP_DN_IS_PRETTY( flags ) ) {
2216 byte2hexpair( &val->bv_val[ s ], &str[ d ] );
2222 #endif /* PRETTY_ESCAPE */
2223 str[ d++ ] = val->bv_val[ s++ ];
2233 * Length of the IA5 string representation (no UTF-8 allowed)
2236 strval2IA5strlen( struct berval *val, unsigned flags, ber_len_t *len )
2245 if ( val->bv_len == 0 ) {
2249 if ( flags & LDAP_AVA_NONPRINTABLE ) {
2251 * Turn value into a binary encoded BER
2256 for ( l = 0, p = val->bv_val; p[ 0 ]; p++ ) {
2257 if ( LDAP_DN_NEEDESCAPE( p[ 0 ] )
2258 || ( p == val->bv_val && LDAP_DN_NEEDESCAPE_LEAD( p[ 0 ] ) )
2259 || ( !p[ 1 ] && LDAP_DN_NEEDESCAPE_TRAIL( p[ 0 ] ) ) ) {
2274 * convert to string representation (np UTF-8)
2275 * assume the destination has enough room for escaping
2278 strval2IA5str( struct berval *val, char *str, unsigned flags, ber_len_t *len )
2280 ber_len_t s, d, end;
2286 if ( val->bv_len == 0 ) {
2291 if ( flags & LDAP_AVA_NONPRINTABLE ) {
2293 * Turn value into a binary encoded BER
2300 * we assume the string has enough room for the hex encoding
2304 for ( s = 0, d = 0, end = val->bv_len - 1; s < val->bv_len; ) {
2305 if ( LDAP_DN_NEEDESCAPE( val->bv_val[ s ] )
2306 || ( s == 0 && LDAP_DN_NEEDESCAPE_LEAD( val->bv_val[ s ] ) )
2307 || ( s == end && LDAP_DN_NEEDESCAPE_TRAIL( val->bv_val[ s ] ) ) ) {
2310 str[ d++ ] = val->bv_val[ s++ ];
2320 * Length of the (supposedly) DCE string representation,
2321 * accounting for escaped hex of UTF-8 chars
2324 strval2DCEstrlen( struct berval *val, unsigned flags, ber_len_t *len )
2333 if ( val->bv_len == 0 ) {
2337 if ( flags & LDAP_AVA_NONPRINTABLE ) {
2339 * FIXME: Turn the value into a binary encoded BER?
2344 for ( l = 0, p = val->bv_val; p[ 0 ]; p++ ) {
2345 if ( LDAP_DN_NEEDESCAPE_DCE( p[ 0 ] ) ) {
2360 * convert to (supposedly) DCE string representation,
2361 * escaping with hex the UTF-8 stuff;
2362 * assume the destination has enough room for escaping
2365 strval2DCEstr( struct berval *val, char *str, unsigned flags, ber_len_t *len )
2373 if ( val->bv_len == 0 ) {
2378 if ( flags & LDAP_AVA_NONPRINTABLE ) {
2380 * FIXME: Turn the value into a binary encoded BER?
2388 * we assume the string has enough room for the hex encoding
2392 for ( s = 0, d = 0; s < val->bv_len; ) {
2393 if ( LDAP_DN_NEEDESCAPE_DCE( val->bv_val[ s ] ) ) {
2396 str[ d++ ] = val->bv_val[ s++ ];
2406 * Length of the (supposedly) AD canonical string representation,
2407 * accounting for escaped hex of UTF-8 chars
2410 strval2ADstrlen( struct berval *val, unsigned flags, ber_len_t *len )
2419 if ( val->bv_len == 0 ) {
2423 if ( flags & LDAP_AVA_NONPRINTABLE ) {
2425 * FIXME: Turn the value into a binary encoded BER?
2430 for ( l = 0, p = val->bv_val; p[ 0 ]; p++ ) {
2431 if ( LDAP_DN_NEEDESCAPE_AD( p[ 0 ] ) ) {
2446 * convert to (supposedly) AD string representation,
2447 * escaping with hex the UTF-8 stuff;
2448 * assume the destination has enough room for escaping
2451 strval2ADstr( struct berval *val, char *str, unsigned flags, ber_len_t *len )
2459 if ( val->bv_len == 0 ) {
2464 if ( flags & LDAP_AVA_NONPRINTABLE ) {
2466 * FIXME: Turn the value into a binary encoded BER?
2474 * we assume the string has enough room for the hex encoding
2478 for ( s = 0, d = 0; s < val->bv_len; ) {
2479 if ( LDAP_DN_NEEDESCAPE_AD( val->bv_val[ s ] ) ) {
2482 str[ d++ ] = val->bv_val[ s++ ];
2492 * If the DN is terminated by single-AVA RDNs with attribute type of "dc",
2493 * the first part of the AD representation of the DN is written in DNS
2494 * form, i.e. dot separated domain name components (as suggested
2495 * by Luke Howard, http://www.padl.com/~lukeh)
2498 dn2domain( LDAPDN dn, struct berval *bv, int pos, int *iRDN )
2501 int domain = 0, first = 1;
2502 ber_len_t l = 1; /* we move the null also */
2505 /* we are guaranteed there's enough memory in str */
2511 assert( *iRDN >= 0 );
2513 str = bv->bv_val + pos;
2515 for ( i = *iRDN; i >= 0; i-- ) {
2525 if ( !LDAP_DN_IS_RDN_DC( rdn ) ) {
2533 AC_MEMCPY( str, ava->la_value.bv_val,
2534 ava->la_value.bv_len + 1);
2535 l += ava->la_value.bv_len;
2538 AC_MEMCPY( str + ava->la_value.bv_len + 1, bv->bv_val + pos, l);
2539 AC_MEMCPY( str, ava->la_value.bv_val,
2540 ava->la_value.bv_len );
2541 str[ ava->la_value.bv_len ] = '.';
2542 l += ava->la_value.bv_len + 1;
2547 bv->bv_len = pos + l - 1;
2553 rdn2strlen( LDAPRDN rdn, unsigned flags, ber_len_t *len,
2554 int ( *s2l )( struct berval *v, unsigned f, ber_len_t *l ) )
2561 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
2562 LDAPAVA *ava = rdn[ iAVA ];
2564 /* len(type) + '=' + '+' | ',' */
2565 l += ava->la_attr.bv_len + 2;
2567 if ( ava->la_flags & LDAP_AVA_BINARY ) {
2568 /* octothorpe + twice the length */
2569 l += 1 + 2 * ava->la_value.bv_len;
2573 unsigned f = flags | ava->la_flags;
2575 if ( ( *s2l )( &ava->la_value, f, &vl ) ) {
2588 rdn2str( LDAPRDN rdn, char *str, unsigned flags, ber_len_t *len,
2589 int ( *s2s ) ( struct berval *v, char * s, unsigned f, ber_len_t *l ) )
2594 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
2595 LDAPAVA *ava = rdn[ iAVA ];
2597 AC_MEMCPY( &str[ l ], ava->la_attr.bv_val,
2598 ava->la_attr.bv_len );
2599 l += ava->la_attr.bv_len;
2603 if ( ava->la_flags & LDAP_AVA_BINARY ) {
2605 if ( binval2hexstr( &ava->la_value, &str[ l ] ) ) {
2608 l += 2 * ava->la_value.bv_len;
2612 unsigned f = flags | ava->la_flags;
2614 if ( ( *s2s )( &ava->la_value, &str[ l ], f, &vl ) ) {
2619 str[ l++ ] = ( rdn[ iAVA + 1] ? '+' : ',' );
2628 rdn2DCEstrlen( LDAPRDN rdn, unsigned flags, ber_len_t *len )
2635 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
2636 LDAPAVA *ava = rdn[ iAVA ];
2638 /* len(type) + '=' + ',' | '/' */
2639 l += ava->la_attr.bv_len + 2;
2641 if ( ava->la_flags & LDAP_AVA_BINARY ) {
2642 /* octothorpe + twice the length */
2643 l += 1 + 2 * ava->la_value.bv_len;
2646 unsigned f = flags | ava->la_flags;
2648 if ( strval2DCEstrlen( &ava->la_value, f, &vl ) ) {
2661 rdn2DCEstr( LDAPRDN rdn, char *str, unsigned flags, ber_len_t *len, int first )
2666 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
2667 LDAPAVA *ava = rdn[ iAVA ];
2672 str[ l++ ] = ( iAVA ? ',' : '/' );
2675 AC_MEMCPY( &str[ l ], ava->la_attr.bv_val,
2676 ava->la_attr.bv_len );
2677 l += ava->la_attr.bv_len;
2681 if ( ava->la_flags & LDAP_AVA_BINARY ) {
2683 if ( binval2hexstr( &ava->la_value, &str[ l ] ) ) {
2686 l += 2 * ava->la_value.bv_len;
2689 unsigned f = flags | ava->la_flags;
2691 if ( strval2DCEstr( &ava->la_value, &str[ l ], f, &vl ) ) {
2704 rdn2UFNstrlen( LDAPRDN rdn, unsigned flags, ber_len_t *len )
2714 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
2715 LDAPAVA *ava = rdn[ iAVA ];
2718 l += ( rdn[ iAVA + 1 ] ? 3 : 2 );
2720 /* FIXME: are binary values allowed in UFN? */
2721 if ( ava->la_flags & LDAP_AVA_BINARY ) {
2722 /* octothorpe + twice the value */
2723 l += 1 + 2 * ava->la_value.bv_len;
2727 unsigned f = flags | ava->la_flags;
2729 if ( strval2strlen( &ava->la_value, f, &vl ) ) {
2742 rdn2UFNstr( LDAPRDN rdn, char *str, unsigned flags, ber_len_t *len )
2747 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
2748 LDAPAVA *ava = rdn[ iAVA ];
2750 if ( ava->la_flags & LDAP_AVA_BINARY ) {
2752 if ( binval2hexstr( &ava->la_value, &str[ l ] ) ) {
2755 l += 2 * ava->la_value.bv_len;
2759 unsigned f = flags | ava->la_flags;
2761 if ( strval2str( &ava->la_value, &str[ l ], f, &vl ) ) {
2767 if ( rdn[ iAVA + 1 ] ) {
2768 AC_MEMCPY( &str[ l ], " + ", 3 );
2772 AC_MEMCPY( &str[ l ], ", ", 2 );
2783 rdn2ADstrlen( LDAPRDN rdn, unsigned flags, ber_len_t *len )
2793 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
2794 LDAPAVA *ava = rdn[ iAVA ];
2799 /* FIXME: are binary values allowed in UFN? */
2800 if ( ava->la_flags & LDAP_AVA_BINARY ) {
2801 /* octothorpe + twice the value */
2802 l += 1 + 2 * ava->la_value.bv_len;
2805 unsigned f = flags | ava->la_flags;
2807 if ( strval2ADstrlen( &ava->la_value, f, &vl ) ) {
2820 rdn2ADstr( LDAPRDN rdn, char *str, unsigned flags, ber_len_t *len, int first )
2825 for ( iAVA = 0; rdn[ iAVA ]; iAVA++ ) {
2826 LDAPAVA *ava = rdn[ iAVA ];
2831 str[ l++ ] = ( iAVA ? ',' : '/' );
2834 if ( ava->la_flags & LDAP_AVA_BINARY ) {
2836 if ( binval2hexstr( &ava->la_value, &str[ l ] ) ) {
2839 l += 2 * ava->la_value.bv_len;
2842 unsigned f = flags | ava->la_flags;
2844 if ( strval2ADstr( &ava->la_value, &str[ l ], f, &vl ) ) {
2859 * Returns in str a string representation of rdn based on flags.
2860 * There is some duplication of code between this and ldap_dn2str;
2861 * this is wanted to reduce the allocation of temporary buffers.
2864 ldap_rdn2str( LDAPRDN rdn, char **str, unsigned flags )
2871 if((flags & LDAP_DN_FORMAT_MASK) == LDAP_DN_FORMAT_LBER) {
2872 return LDAP_PARAM_ERROR;
2875 rc = ldap_rdn2bv_x( rdn, &bv, flags, NULL );
2881 ldap_rdn2bv( LDAPRDN rdn, struct berval *bv, unsigned flags )
2883 return ldap_rdn2bv_x( rdn, bv, flags, NULL );
2887 ldap_rdn2bv_x( LDAPRDN rdn, struct berval *bv, unsigned flags, void *ctx )
2897 if ( rdn == NULL ) {
2898 bv->bv_val = LDAP_STRDUPX( "", ctx );
2899 return( LDAP_SUCCESS );
2903 * This routine wastes "back" bytes at the end of the string
2906 switch ( LDAP_DN_FORMAT( flags ) ) {
2907 case LDAP_DN_FORMAT_LDAPV3:
2908 if ( rdn2strlen( rdn, flags, &l, strval2strlen ) ) {
2909 return LDAP_DECODING_ERROR;
2913 case LDAP_DN_FORMAT_LDAPV2:
2914 if ( rdn2strlen( rdn, flags, &l, strval2IA5strlen ) ) {
2915 return LDAP_DECODING_ERROR;
2919 case LDAP_DN_FORMAT_UFN:
2920 if ( rdn2UFNstrlen( rdn, flags, &l ) ) {
2921 return LDAP_DECODING_ERROR;
2925 case LDAP_DN_FORMAT_DCE:
2926 if ( rdn2DCEstrlen( rdn, flags, &l ) ) {
2927 return LDAP_DECODING_ERROR;
2931 case LDAP_DN_FORMAT_AD_CANONICAL:
2932 if ( rdn2ADstrlen( rdn, flags, &l ) ) {
2933 return LDAP_DECODING_ERROR;
2938 return LDAP_PARAM_ERROR;
2941 bv->bv_val = LDAP_MALLOCX( l + 1, ctx );
2943 switch ( LDAP_DN_FORMAT( flags ) ) {
2944 case LDAP_DN_FORMAT_LDAPV3:
2945 rc = rdn2str( rdn, bv->bv_val, flags, &l, strval2str );
2949 case LDAP_DN_FORMAT_LDAPV2:
2950 rc = rdn2str( rdn, bv->bv_val, flags, &l, strval2IA5str );
2954 case LDAP_DN_FORMAT_UFN:
2955 rc = rdn2UFNstr( rdn, bv->bv_val, flags, &l );
2959 case LDAP_DN_FORMAT_DCE:
2960 rc = rdn2DCEstr( rdn, bv->bv_val, flags, &l, 1 );
2964 case LDAP_DN_FORMAT_AD_CANONICAL:
2965 rc = rdn2ADstr( rdn, bv->bv_val, flags, &l, 1 );
2970 /* need at least one of the previous */
2971 return LDAP_PARAM_ERROR;
2975 LDAP_FREEX( bv->bv_val, ctx );
2979 bv->bv_len = l - back;
2980 bv->bv_val[ bv->bv_len ] = '\0';
2982 return LDAP_SUCCESS;
2986 * Very bulk implementation; many optimizations can be performed
2987 * - a NULL dn results in an empty string ""
2990 * a) what do we do if a UTF-8 string must be converted in LDAPv2?
2991 * we must encode it in binary form ('#' + HEXPAIRs)
2992 * b) does DCE/AD support UTF-8?
2993 * no clue; don't think so.
2994 * c) what do we do when binary values must be converted in UTF/DCE/AD?
2995 * use binary encoded BER
2997 int ldap_dn2str( LDAPDN dn, char **str, unsigned flags )
3004 if((flags & LDAP_DN_FORMAT_MASK) == LDAP_DN_FORMAT_LBER) {
3005 return LDAP_PARAM_ERROR;
3008 rc = ldap_dn2bv_x( dn, &bv, flags, NULL );
3013 int ldap_dn2bv( LDAPDN dn, struct berval *bv, unsigned flags )
3015 return ldap_dn2bv_x( dn, bv, flags, NULL );
3018 int ldap_dn2bv_x( LDAPDN dn, struct berval *bv, unsigned flags, void *ctx )
3021 int rc = LDAP_ENCODING_ERROR;
3024 /* stringifying helpers for LDAPv3/LDAPv2 */
3025 int ( *sv2l ) ( struct berval *v, unsigned f, ber_len_t *l );
3026 int ( *sv2s ) ( struct berval *v, char *s, unsigned f, ber_len_t *l );
3033 LDAP_LOG ( OPERATION, ARGS, "=> ldap_dn2bv(%u)\n%s%s",
3036 Debug( LDAP_DEBUG_TRACE, "=> ldap_dn2bv(%u)\n%s%s", flags, "", "" );
3040 * a null dn means an empty dn string
3041 * FIXME: better raise an error?
3044 bv->bv_val = LDAP_STRDUPX( "", ctx );
3045 return( LDAP_SUCCESS );
3048 switch ( LDAP_DN_FORMAT( flags ) ) {
3049 case LDAP_DN_FORMAT_LDAPV3:
3050 sv2l = strval2strlen;
3054 case LDAP_DN_FORMAT_LDAPV2:
3055 sv2l = strval2IA5strlen;
3056 sv2s = strval2IA5str;
3059 for ( iRDN = 0, len = 0; dn[ iRDN ]; iRDN++ ) {
3061 if ( rdn2strlen( dn[ iRDN ], flags, &rdnl, sv2l ) ) {
3062 goto return_results;
3068 if ( ( bv->bv_val = LDAP_MALLOCX( len + 1, ctx ) ) == NULL ) {
3069 rc = LDAP_NO_MEMORY;
3073 for ( l = 0, iRDN = 0; dn[ iRDN ]; iRDN++ ) {
3076 if ( rdn2str( dn[ iRDN ], &bv->bv_val[ l ], flags,
3078 LDAP_FREEX( bv->bv_val, ctx );
3080 goto return_results;
3088 * trim the last ',' (the allocated memory
3089 * is one byte longer than required)
3091 bv->bv_len = len - 1;
3092 bv->bv_val[ bv->bv_len ] = '\0';
3097 case LDAP_DN_FORMAT_UFN: {
3099 * FIXME: quoting from RFC 1781:
3101 To take a distinguished name, and generate a name of this format with
3102 attribute types omitted, the following steps are followed.
3104 1. If the first attribute is of type CommonName, the type may be
3107 2. If the last attribute is of type Country, the type may be
3110 3. If the last attribute is of type Country, the last
3111 Organisation attribute may have the type omitted.
3113 4. All attributes of type OrganisationalUnit may have the type
3114 omitted, unless they are after an Organisation attribute or
3115 the first attribute is of type OrganisationalUnit.
3117 * this should be the pedantic implementation.
3119 * Here the standard implementation reflects
3120 * the one historically provided by OpenLDAP
3121 * (and UMIch, I presume), with the variant
3122 * of spaces and plusses (' + ') separating
3125 * A non-standard but nice implementation could
3126 * be to turn the final "dc" attributes into a
3127 * dot-separated domain.
3129 * Other improvements could involve the use of
3130 * friendly country names and so.
3133 int leftmost_dc = -1;
3135 #endif /* DC_IN_UFN */
3137 for ( iRDN = 0, len = 0; dn[ iRDN ]; iRDN++ ) {
3140 if ( rdn2UFNstrlen( dn[ iRDN ], flags, &rdnl ) ) {
3141 goto return_results;
3146 if ( LDAP_DN_IS_RDN_DC( dn[ iRDN ] ) ) {
3147 if ( leftmost_dc == -1 ) {
3153 #endif /* DC_IN_UFN */
3156 if ( ( bv->bv_val = LDAP_MALLOCX( len + 1, ctx ) ) == NULL ) {
3157 rc = LDAP_NO_MEMORY;
3162 if ( leftmost_dc == -1 ) {
3163 #endif /* DC_IN_UFN */
3164 for ( l = 0, iRDN = 0; dn[ iRDN ]; iRDN++ ) {
3167 if ( rdn2UFNstr( dn[ iRDN ], &bv->bv_val[ l ],
3169 LDAP_FREEX( bv->bv_val, ctx );
3171 goto return_results;
3177 * trim the last ', ' (the allocated memory
3178 * is two bytes longer than required)
3180 bv->bv_len = len - 2;
3181 bv->bv_val[ bv->bv_len ] = '\0';
3184 last_iRDN = iRDN - 1;
3186 for ( l = 0, iRDN = 0; iRDN < leftmost_dc; iRDN++ ) {
3189 if ( rdn2UFNstr( dn[ iRDN ], &bv->bv_val[ l ],
3191 LDAP_FREEX( bv->bv_val, ctx );
3193 goto return_results;
3198 if ( !dn2domain( dn, bv, l, &last_iRDN ) ) {
3199 LDAP_FREEX( bv->bv_val, ctx );
3201 goto return_results;
3204 /* the string is correctly terminated by dn2domain */
3206 #endif /* DC_IN_UFN */
3212 case LDAP_DN_FORMAT_DCE:
3213 for ( iRDN = 0, len = 0; dn[ iRDN ]; iRDN++ ) {
3215 if ( rdn2DCEstrlen( dn[ iRDN ], flags, &rdnl ) ) {
3216 goto return_results;
3222 if ( ( bv->bv_val = LDAP_MALLOCX( len + 1, ctx ) ) == NULL ) {
3223 rc = LDAP_NO_MEMORY;
3227 for ( l = 0; iRDN--; ) {
3230 if ( rdn2DCEstr( dn[ iRDN ], &bv->bv_val[ l ], flags,
3232 LDAP_FREEX( bv->bv_val, ctx );
3234 goto return_results;
3242 bv->bv_val[ bv->bv_len ] = '\0';
3247 case LDAP_DN_FORMAT_AD_CANONICAL: {
3248 int trailing_slash = 1;
3251 * Sort of UFN for DCE DNs: a slash ('/') separated
3252 * global->local DN with no types; strictly speaking,
3253 * the naming context should be a domain, which is
3254 * written in DNS-style, e.g. dot-deparated.
3258 * "givenName=Bill+sn=Gates,ou=People,dc=microsoft,dc=com"
3262 * "microsoft.com/People/Bill,Gates"
3264 for ( iRDN = 0, len = -1; dn[ iRDN ]; iRDN++ ) {
3267 if ( rdn2ADstrlen( dn[ iRDN ], flags, &rdnl ) ) {
3268 goto return_results;
3274 /* reserve room for trailing '/' in case the DN
3275 * is exactly a domain */
3276 if ( ( bv->bv_val = LDAP_MALLOCX( len + 1 + 1, ctx ) ) == NULL )
3278 rc = LDAP_NO_MEMORY;
3283 if ( iRDN && dn2domain( dn, bv, 0, &iRDN ) != 0 ) {
3284 for ( l = bv->bv_len; iRDN >= 0 ; iRDN-- ) {
3289 if ( rdn2ADstr( dn[ iRDN ], &bv->bv_val[ l ],
3290 flags, &rdnl, 0 ) ) {
3291 LDAP_FREEX( bv->bv_val, ctx );
3293 goto return_results;
3302 * Strictly speaking, AD canonical requires
3303 * a DN to be in the form "..., dc=smtg",
3304 * i.e. terminated by a domain component
3306 if ( flags & LDAP_DN_PEDANTIC ) {
3307 LDAP_FREEX( bv->bv_val, ctx );
3309 rc = LDAP_ENCODING_ERROR;
3313 for ( l = 0; iRDN >= 0 ; iRDN-- ) {
3316 if ( rdn2ADstr( dn[ iRDN ], &bv->bv_val[ l ],
3317 flags, &rdnl, first ) ) {
3318 LDAP_FREEX( bv->bv_val, ctx );
3320 goto return_results;
3329 if ( trailing_slash ) {
3330 /* the DN is exactly a domain -- need a trailing
3331 * slash; room was reserved in advance */
3332 bv->bv_val[ len ] = '/';
3337 bv->bv_val[ bv->bv_len ] = '\0';
3343 return LDAP_PARAM_ERROR;
3347 LDAP_LOG ( OPERATION, RESULTS, "<= ldap_dn2bv(%s,%u)=%d\n",
3348 bv->bv_val, flags, rc );
3350 Debug( LDAP_DEBUG_TRACE, "<= ldap_dn2bv(%s,%u)=%d\n",
3351 bv->bv_val, flags, rc );
3359 #include <openssl/x509.h>
3360 #include <openssl/err.h>
3362 /* Convert a structured DN from an X.509 certificate into an LDAPV3 DN.
3363 * x509_name must be an (X509_NAME *). If func is non-NULL, the
3364 * constructed DN will use numeric OIDs to identify attributeTypes,
3365 * and the func() will be invoked to rewrite the DN with the given
3368 * Otherwise the DN will use shortNames as defined in the OpenSSL
3371 * It's preferable to let slapd do the OID to attributeType mapping,
3372 * because the OpenSSL tables are known to have many typos in versions
3373 * up to (at least) 0.9.6c. However, the LDAP client has no schema tables,
3374 * so we're forced to use OpenSSL's mapping there.
3375 * -- Howard Chu 2002-04-18
3379 ldap_X509dn2bv( void *x509_name, struct berval *bv, LDAPDN_rewrite_func *func,
3384 LDAPAVA *newAVA, *baseAVA;
3385 X509_NAME_ENTRY *ne;
3388 char oids[8192], *oidptr = oids, *oidbuf = NULL;
3390 int i, j, k = 0, navas, nrdns, rc = LDAP_SUCCESS;
3392 size_t dnsize, oidrem = sizeof(oids), oidsize = 0;
3401 /* Get the number of AVAs. This is not necessarily the same as
3402 * the number of RDNs.
3404 navas = X509_NAME_entry_count( x509_name );
3406 /* Get the last element, to see how many RDNs there are */
3407 ne = X509_NAME_get_entry( x509_name, navas - 1 );
3408 nrdns = ne->set + 1;
3410 /* Allocate the DN/RDN/AVA stuff as a single block */
3411 dnsize = sizeof(LDAPRDN) * (nrdns+1);
3412 dnsize += sizeof(LDAPAVA *) * (navas+nrdns);
3413 dnsize += sizeof(LDAPAVA) * navas;
3414 if (dnsize > sizeof(ptrs)) {
3415 newDN = (LDAPDN)LDAP_MALLOC( dnsize );
3416 if ( newDN == NULL )
3417 return LDAP_NO_MEMORY;
3419 newDN = (LDAPDN)ptrs;
3422 newDN[nrdns] = NULL;
3423 newRDN = (LDAPRDN)(newDN + nrdns+1);
3424 newAVA = (LDAPAVA *)(newRDN + navas + nrdns);
3427 /* Retrieve RDNs in reverse order; LDAP is backwards from X.500. */
3428 for ( i = nrdns - 1, j = 0; i >= 0; i-- ) {
3429 ne = X509_NAME_get_entry( x509_name, i );
3430 obj = X509_NAME_ENTRY_get_object( ne );
3431 str = X509_NAME_ENTRY_get_data( ne );
3433 /* If set changed, move to next RDN */
3434 if ( set != ne->set ) {
3435 /* If this is not the first time, end the
3436 * previous RDN and advance.
3442 newDN[j++] = newRDN;
3447 newAVA->la_private = NULL;
3448 newAVA->la_flags = LDAP_AVA_STRING;
3451 int n = OBJ_obj2nid( obj );
3455 newAVA->la_attr.bv_val = (char *)OBJ_nid2sn( n );
3456 newAVA->la_attr.bv_len = strlen( newAVA->la_attr.bv_val );
3458 newAVA->la_attr.bv_val = LDAP_STRDUP( newAVA->la_attr.bv_val );
3459 __etoa( newAVA->la_attr.bv_val );
3460 newAVA->la_flags |= LDAP_AVA_FREE_ATTR;
3463 get_oid: newAVA->la_attr.bv_val = oidptr;
3464 newAVA->la_attr.bv_len = OBJ_obj2txt( oidptr, oidrem, obj, 1 );
3466 __etoa( newAVA->la_attr.bv_val );
3468 oidptr += newAVA->la_attr.bv_len + 1;
3469 oidrem -= newAVA->la_attr.bv_len + 1;
3471 /* Running out of OID buffer space? */
3473 if ( oidsize == 0 ) {
3474 oidsize = sizeof(oids) * 2;
3476 oidbuf = LDAP_MALLOC( oidsize );
3477 if ( oidbuf == NULL ) goto nomem;
3481 oidbuf = LDAP_REALLOC( oidbuf, oidsize*2 );
3482 if ( oidbuf == NULL ) goto nomem;
3483 /* Buffer moved! Fix AVA pointers */
3484 if ( old != oidbuf ) {
3486 long dif = oidbuf - old;
3488 for (a=baseAVA; a<=newAVA; a++){
3489 if (a->la_attr.bv_val >= old &&
3490 a->la_attr.bv_val <= (old + oidsize))
3491 a->la_attr.bv_val += dif;
3494 oidptr = oidbuf + oidsize - oidrem;
3500 Val.bv_val = (char *) str->data;
3501 Val.bv_len = str->length;
3502 switch( str->type ) {
3503 case V_ASN1_UNIVERSALSTRING:
3504 /* This uses 32-bit ISO 10646-1 */
3505 csize = 4; goto to_utf8;
3506 case V_ASN1_BMPSTRING:
3507 /* This uses 16-bit ISO 10646-1 */
3508 csize = 2; goto to_utf8;
3509 case V_ASN1_T61STRING:
3510 /* This uses 8-bit, assume ISO 8859-1 */
3512 to_utf8: rc = ldap_ucs_to_utf8s( &Val, csize, &newAVA->la_value );
3513 newAVA->la_flags |= LDAP_AVA_FREE_VALUE;
3514 if (rc != LDAP_SUCCESS) goto nomem;
3515 newAVA->la_flags = LDAP_AVA_NONPRINTABLE;
3517 case V_ASN1_UTF8STRING:
3518 newAVA->la_flags = LDAP_AVA_NONPRINTABLE;
3519 /* This is already in UTF-8 encoding */
3520 case V_ASN1_IA5STRING:
3521 case V_ASN1_PRINTABLESTRING:
3522 /* These are always 7-bit strings */
3523 newAVA->la_value = Val;
3534 rc = func( newDN, flags, NULL );
3535 if ( rc != LDAP_SUCCESS )
3539 rc = ldap_dn2bv_x( newDN, bv, LDAP_DN_FORMAT_LDAPV3, NULL );
3542 for (;baseAVA < newAVA; baseAVA++) {
3543 if (baseAVA->la_flags & LDAP_AVA_FREE_ATTR)
3544 LDAP_FREE( baseAVA->la_attr.bv_val );
3545 if (baseAVA->la_flags & LDAP_AVA_FREE_VALUE)
3546 LDAP_FREE( baseAVA->la_value.bv_val );
3550 LDAP_FREE( oidbuf );
3551 if ( newDN != (LDAPDN) ptrs )
3555 #endif /* HAVE_TLS */