schema_init.c 88.1 KB
Newer Older
1
2
/* schema_init.c - init builtin schema */
/* $OpenLDAP$ */
Kurt Zeilenga's avatar
Kurt Zeilenga committed
3
4
/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
 *
Kurt Zeilenga's avatar
Kurt Zeilenga committed
5
 * Copyright 1998-2004 The OpenLDAP Foundation.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
6
7
8
9
10
11
12
13
14
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted only as authorized by the OpenLDAP
 * Public License.
 *
 * A copy of this license is available in the file LICENSE in the
 * top-level directory of the distribution or, alternatively, at
 * <http://www.OpenLDAP.org/license.html>.
15
16
17
18
19
 */

#include "portable.h"

#include <stdio.h>
Kurt Zeilenga's avatar
Kurt Zeilenga committed
20
#include <limits.h>
21
22

#include <ac/ctype.h>
23
#include <ac/errno.h>
24
25
26
27
#include <ac/string.h>
#include <ac/socket.h>

#include "slap.h"
28

29
30
#include "ldap_utf8.h"

31
32
33
34
35
36
37
38
39
40
41
42
#ifdef HAVE_TLS
#include <openssl/x509.h>
#include <openssl/err.h>
#include <openssl/rsa.h>
#include <openssl/crypto.h>
#include <openssl/pem.h>
#include <openssl/bio.h>
#include <openssl/asn1.h>
#include <openssl/x509v3.h>
#include <openssl/ssl.h>
#endif

43
#include "lutil.h"
44
45
46
47
48
49
#include "lutil_hash.h"
#define HASH_BYTES				LUTIL_HASH_BYTES
#define HASH_CONTEXT			lutil_HASH_CTX
#define HASH_Init(c)			lutil_HASHInit(c)
#define HASH_Update(c,buf,len)	lutil_HASHUpdate(c,buf,len)
#define HASH_Final(d,c)			lutil_HASHFinal(d,c)
50

Pierangelo Masarati's avatar
Pierangelo Masarati committed
51
52
#define	OpenLDAPaciMatch			NULL

53
54
/* approx matching rules */
#define directoryStringApproxMatchOID	"1.3.6.1.4.1.4203.666.4.4"
55
#define directoryStringApproxMatch		approxMatch
Gary Williams's avatar
Gary Williams committed
56
#define directoryStringApproxIndexer	approxIndexer
57
#define directoryStringApproxFilter		approxFilter
58
#define IA5StringApproxMatchOID			"1.3.6.1.4.1.4203.666.4.5"
Gary Williams's avatar
Gary Williams committed
59
#define IA5StringApproxMatch			approxMatch
60
#define IA5StringApproxIndexer			approxIndexer
Gary Williams's avatar
Gary Williams committed
61
#define IA5StringApproxFilter			approxFilter
62

63
64
65
66
67
unsigned int index_substr_if_minlen = SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT;
unsigned int index_substr_if_maxlen = SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT;
unsigned int index_substr_any_len = SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT;
unsigned int index_substr_any_step = SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT;

Kurt Zeilenga's avatar
Kurt Zeilenga committed
68
69
70
71
static int
inValidate(
	Syntax *syntax,
	struct berval *in )
72
{
Kurt Zeilenga's avatar
Kurt Zeilenga committed
73
74
75
	/* no value allowed */
	return LDAP_INVALID_SYNTAX;
}
76

Kurt Zeilenga's avatar
Kurt Zeilenga committed
77
78
79
80
81
82
83
static int
blobValidate(
	Syntax *syntax,
	struct berval *in )
{
	/* any value allowed */
	return LDAP_SUCCESS;
84
}
85

Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
86
87
#define berValidate blobValidate

88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
static int
sequenceValidate(
	Syntax *syntax,
	struct berval *in )
{
	if ( in->bv_len < 2 ) return LDAP_INVALID_SYNTAX;
	if ( in->bv_val[0] != LBER_SEQUENCE ) return LDAP_INVALID_SYNTAX;

	return LDAP_SUCCESS;
}


#ifdef HAVE_TLS
static int certificateValidate( Syntax *syntax, struct berval *in )
{
	X509 *xcert=NULL;
104
	unsigned char *p = (unsigned char *)in->bv_val;
105
106
107
108
109
110
111
112
113
114
 
	xcert = d2i_X509(NULL, &p, in->bv_len);
	if ( !xcert ) return LDAP_INVALID_SYNTAX;
	X509_free(xcert);
	return LDAP_SUCCESS;
}
#else
#define certificateValidate sequenceValidate
#endif

115
116
117
static int
octetStringMatch(
	int *matchp,
118
	slap_mask_t flags,
119
120
121
122
123
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *value,
	void *assertedValue )
{
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
124
125
	struct berval *asserted = (struct berval *) assertedValue;
	int match = value->bv_len - asserted->bv_len;
126
127

	if( match == 0 ) {
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
128
		match = memcmp( value->bv_val, asserted->bv_val, value->bv_len );
129
130
131
132
133
134
	}

	*matchp = match;
	return LDAP_SUCCESS;
}

135
136
137
138
139
140
141
142
143
static int
octetStringOrderingMatch(
	int *matchp,
	slap_mask_t flags,
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *value,
	void *assertedValue )
{
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
144
	struct berval *asserted = (struct berval *) assertedValue;
145
	ber_len_t v_len  = value->bv_len;
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
146
	ber_len_t av_len = asserted->bv_len;
147

Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
148
	int match = memcmp( value->bv_val, asserted->bv_val,
149
		(v_len < av_len ? v_len : av_len) );
150
151
152

	if( match == 0 ) match = v_len - av_len;

153
154
155
156
	*matchp = match;
	return LDAP_SUCCESS;
}

157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
hashDigestify(
	HASH_CONTEXT *HASHcontext,
	unsigned char *HASHdigest,
	struct berval *prefix,
	char pre,
	Syntax *syntax,
	MatchingRule *mr,
	unsigned char *value,
	int value_len)
{
	HASH_Init(HASHcontext);
	if(prefix && prefix->bv_len > 0) {
		HASH_Update(HASHcontext,
			(unsigned char *)prefix->bv_val, prefix->bv_len);
	}
	if(pre) HASH_Update(HASHcontext, (unsigned char*)&pre, sizeof(pre));
	HASH_Update(HASHcontext, (unsigned char*)syntax->ssyn_oid, syntax->ssyn_oidlen);
	HASH_Update(HASHcontext, (unsigned char*)mr->smr_oid, mr->smr_oidlen);
	HASH_Update(HASHcontext, value, value_len);
	HASH_Final(HASHdigest, HASHcontext);
	return;
}

180
/* Index generation function */
181
int octetStringIndexer(
182
183
	slap_mask_t use,
	slap_mask_t flags,
184
185
186
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *prefix,
187
	BerVarray values,
Howard Chu's avatar
Howard Chu committed
188
189
	BerVarray *keysp,
	void *ctx )
190
191
192
{
	int i;
	size_t slen, mlen;
193
	BerVarray keys;
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
194
195
	HASH_CONTEXT HASHcontext;
	unsigned char HASHdigest[HASH_BYTES];
196
	struct berval digest;
197
	digest.bv_val = (char *)HASHdigest;
198
	digest.bv_len = sizeof(HASHdigest);
199

200
	for( i=0; values[i].bv_val != NULL; i++ ) {
201
202
203
		/* just count them */
	}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
204
205
206
	/* we should have at least one value at this point */
	assert( i > 0 );

207
	keys = slap_sl_malloc( sizeof( struct berval ) * (i+1), ctx );
208

209
210
	slen = syntax->ssyn_oidlen;
	mlen = mr->smr_oidlen;
211

212
	for( i=0; values[i].bv_val != NULL; i++ ) {
213
214
		hashDigestify( &HASHcontext, HASHdigest, prefix, 0,
			syntax, mr, (unsigned char *)values[i].bv_val, values[i].bv_len );
Howard Chu's avatar
Howard Chu committed
215
		ber_dupbv_x( &keys[i], &digest, ctx );
216
217
	}

218
	keys[i].bv_val = NULL;
219
	keys[i].bv_len = 0;
220
221
222
223
224
225
226

	*keysp = keys;

	return LDAP_SUCCESS;
}

/* Index generation function */
227
int octetStringFilter(
228
229
	slap_mask_t use,
	slap_mask_t flags,
230
231
232
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *prefix,
233
	void * assertedValue,
Howard Chu's avatar
Howard Chu committed
234
235
	BerVarray *keysp,
	void *ctx )
236
237
{
	size_t slen, mlen;
238
	BerVarray keys;
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
239
240
	HASH_CONTEXT HASHcontext;
	unsigned char HASHdigest[HASH_BYTES];
241
	struct berval *value = (struct berval *) assertedValue;
242
	struct berval digest;
243
	digest.bv_val = (char *)HASHdigest;
244
	digest.bv_len = sizeof(HASHdigest);
245

246
247
	slen = syntax->ssyn_oidlen;
	mlen = mr->smr_oidlen;
248

249
	keys = slap_sl_malloc( sizeof( struct berval ) * 2, ctx );
250

251
252
	hashDigestify( &HASHcontext, HASHdigest, prefix, 0,
		syntax, mr, (unsigned char *)value->bv_val, value->bv_len );
253

Howard Chu's avatar
Howard Chu committed
254
	ber_dupbv_x( keys, &digest, ctx );
255
	keys[1].bv_val = NULL;
256
	keys[1].bv_len = 0;
257
258
259
260
261

	*keysp = keys;

	return LDAP_SUCCESS;
}
262

263
static int
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
264
octetStringSubstringsMatch(
Kurt Zeilenga's avatar
Kurt Zeilenga committed
265
266
	int *matchp,
	slap_mask_t flags,
267
	Syntax *syntax,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
268
269
270
	MatchingRule *mr,
	struct berval *value,
	void *assertedValue )
271
{
Kurt Zeilenga's avatar
Kurt Zeilenga committed
272
273
274
275
	int match = 0;
	SubstringsAssertion *sub = assertedValue;
	struct berval left = *value;
	int i;
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
276
	ber_len_t inlen = 0;
277

Kurt Zeilenga's avatar
Kurt Zeilenga committed
278
279
280
	/* Add up asserted input length */
	if( sub->sa_initial.bv_val ) {
		inlen += sub->sa_initial.bv_len;
281
	}
Kurt Zeilenga's avatar
Kurt Zeilenga committed
282
283
284
285
286
287
288
	if( sub->sa_any ) {
		for(i=0; sub->sa_any[i].bv_val != NULL; i++) {
			inlen += sub->sa_any[i].bv_len;
		}
	}
	if( sub->sa_final.bv_val ) {
		inlen += sub->sa_final.bv_len;
289
290
	}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
291
292
293
294
	if( sub->sa_initial.bv_val ) {
		if( inlen > left.bv_len ) {
			match = 1;
			goto done;
295
296
		}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
297
298
		match = memcmp( sub->sa_initial.bv_val, left.bv_val,
			sub->sa_initial.bv_len );
299

Kurt Zeilenga's avatar
Kurt Zeilenga committed
300
301
302
		if( match != 0 ) {
			goto done;
		}
303

Kurt Zeilenga's avatar
Kurt Zeilenga committed
304
305
306
307
		left.bv_val += sub->sa_initial.bv_len;
		left.bv_len -= sub->sa_initial.bv_len;
		inlen -= sub->sa_initial.bv_len;
	}
308

Kurt Zeilenga's avatar
Kurt Zeilenga committed
309
310
311
312
313
	if( sub->sa_final.bv_val ) {
		if( inlen > left.bv_len ) {
			match = 1;
			goto done;
		}
314

Kurt Zeilenga's avatar
Kurt Zeilenga committed
315
316
317
		match = memcmp( sub->sa_final.bv_val,
			&left.bv_val[left.bv_len - sub->sa_final.bv_len],
			sub->sa_final.bv_len );
318

Kurt Zeilenga's avatar
Kurt Zeilenga committed
319
320
		if( match != 0 ) {
			goto done;
321
322
		}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
323
324
		left.bv_len -= sub->sa_final.bv_len;
		inlen -= sub->sa_final.bv_len;
325
326
	}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
327
328
329
330
	if( sub->sa_any ) {
		for(i=0; sub->sa_any[i].bv_val; i++) {
			ber_len_t idx;
			char *p;
331

Kurt Zeilenga's avatar
Kurt Zeilenga committed
332
333
334
335
336
337
retry:
			if( inlen > left.bv_len ) {
				/* not enough length */
				match = 1;
				goto done;
			}
338

Kurt Zeilenga's avatar
Kurt Zeilenga committed
339
340
341
			if( sub->sa_any[i].bv_len == 0 ) {
				continue;
			}
342

Kurt Zeilenga's avatar
Kurt Zeilenga committed
343
			p = memchr( left.bv_val, *sub->sa_any[i].bv_val, left.bv_len );
344

Kurt Zeilenga's avatar
Kurt Zeilenga committed
345
346
347
			if( p == NULL ) {
				match = 1;
				goto done;
348
349
			}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
350
			idx = p - left.bv_val;
351

Kurt Zeilenga's avatar
Kurt Zeilenga committed
352
353
354
355
			if( idx >= left.bv_len ) {
				/* this shouldn't happen */
				return LDAP_OTHER;
			}
356

Kurt Zeilenga's avatar
Kurt Zeilenga committed
357
358
			left.bv_val = p;
			left.bv_len -= idx;
359

Kurt Zeilenga's avatar
Kurt Zeilenga committed
360
361
362
363
364
			if( sub->sa_any[i].bv_len > left.bv_len ) {
				/* not enough left */
				match = 1;
				goto done;
			}
365

Kurt Zeilenga's avatar
Kurt Zeilenga committed
366
367
368
			match = memcmp( left.bv_val,
				sub->sa_any[i].bv_val,
				sub->sa_any[i].bv_len );
369

Kurt Zeilenga's avatar
Kurt Zeilenga committed
370
371
372
373
374
			if( match != 0 ) {
				left.bv_val++;
				left.bv_len--;
				goto retry;
			}
375

Kurt Zeilenga's avatar
Kurt Zeilenga committed
376
377
378
			left.bv_val += sub->sa_any[i].bv_len;
			left.bv_len -= sub->sa_any[i].bv_len;
			inlen -= sub->sa_any[i].bv_len;
379
380
381
		}
	}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
382
383
done:
	*matchp = match;
384
385
386
	return LDAP_SUCCESS;
}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
387
388
/* Substrings Index generation function */
static int
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
389
octetStringSubstringsIndexer(
Kurt Zeilenga's avatar
Kurt Zeilenga committed
390
391
392
393
394
395
	slap_mask_t use,
	slap_mask_t flags,
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *prefix,
	BerVarray values,
Howard Chu's avatar
Howard Chu committed
396
397
	BerVarray *keysp,
	void *ctx )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
398
{
399
	ber_len_t i, j, len, nkeys;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
400
401
402
	size_t slen, mlen;
	BerVarray keys;

Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
403
404
	HASH_CONTEXT HASHcontext;
	unsigned char HASHdigest[HASH_BYTES];
Kurt Zeilenga's avatar
Kurt Zeilenga committed
405
	struct berval digest;
406
	digest.bv_val = (char *)HASHdigest;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
407
408
409
410
411
412
413
	digest.bv_len = sizeof(HASHdigest);

	nkeys=0;

	for( i=0; values[i].bv_val != NULL; i++ ) {
		/* count number of indices to generate */
		if( flags & SLAP_INDEX_SUBSTR_INITIAL ) {
414
415
416
417
418
			if( values[i].bv_len >= index_substr_if_maxlen ) {
				nkeys += index_substr_if_maxlen -
					(index_substr_if_minlen - 1);
			} else if( values[i].bv_len >= index_substr_if_minlen ) {
				nkeys += values[i].bv_len - (index_substr_if_minlen - 1);
Kurt Zeilenga's avatar
Kurt Zeilenga committed
419
420
421
422
			}
		}

		if( flags & SLAP_INDEX_SUBSTR_ANY ) {
423
424
			if( values[i].bv_len >= index_substr_any_len ) {
				nkeys += values[i].bv_len - (index_substr_any_len - 1);
Kurt Zeilenga's avatar
Kurt Zeilenga committed
425
426
427
428
			}
		}

		if( flags & SLAP_INDEX_SUBSTR_FINAL ) {
429
430
431
432
433
			if( values[i].bv_len >= index_substr_if_maxlen ) {
				nkeys += index_substr_if_maxlen -
					(index_substr_if_minlen - 1);
			} else if( values[i].bv_len >= index_substr_if_minlen ) {
				nkeys += values[i].bv_len - (index_substr_if_minlen - 1);
Kurt Zeilenga's avatar
Kurt Zeilenga committed
434
435
436
437
438
439
440
441
442
443
			}
		}
	}

	if( nkeys == 0 ) {
		/* no keys to generate */
		*keysp = NULL;
		return LDAP_SUCCESS;
	}

444
	keys = slap_sl_malloc( sizeof( struct berval ) * (nkeys+1), ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
445
446
447
448
449
450
451
452
453

	slen = syntax->ssyn_oidlen;
	mlen = mr->smr_oidlen;

	nkeys=0;
	for( i=0; values[i].bv_val != NULL; i++ ) {
		ber_len_t j,max;

		if( ( flags & SLAP_INDEX_SUBSTR_ANY ) &&
454
			( values[i].bv_len >= index_substr_any_len ) )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
455
456
		{
			char pre = SLAP_INDEX_SUBSTR_PREFIX;
457
			max = values[i].bv_len - (index_substr_any_len - 1);
Kurt Zeilenga's avatar
Kurt Zeilenga committed
458
459

			for( j=0; j<max; j++ ) {
460
				hashDigestify( &HASHcontext, HASHdigest, prefix, pre,
461
					syntax, mr, (unsigned char *)&values[i].bv_val[j], index_substr_any_len);
Howard Chu's avatar
Howard Chu committed
462
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
463
464
465
			}
		}

466
		/* skip if too short */ 
467
		if( values[i].bv_len < index_substr_if_minlen ) continue;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
468

469
470
		max = index_substr_if_maxlen < values[i].bv_len
			? index_substr_if_maxlen : values[i].bv_len;
471

472
		for( j=index_substr_if_minlen; j<=max; j++ ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
473
474
475
476
			char pre;

			if( flags & SLAP_INDEX_SUBSTR_INITIAL ) {
				pre = SLAP_INDEX_SUBSTR_INITIAL_PREFIX;
477
478
				hashDigestify( &HASHcontext, HASHdigest, prefix, pre,
					syntax, mr, (unsigned char *)values[i].bv_val, j );
Howard Chu's avatar
Howard Chu committed
479
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
480
481
482
483
			}

			if( flags & SLAP_INDEX_SUBSTR_FINAL ) {
				pre = SLAP_INDEX_SUBSTR_FINAL_PREFIX;
484
485
				hashDigestify( &HASHcontext, HASHdigest, prefix, pre,
					syntax, mr, (unsigned char *)&values[i].bv_val[values[i].bv_len-j], j );
Howard Chu's avatar
Howard Chu committed
486
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
			}

		}
	}

	if( nkeys > 0 ) {
		keys[nkeys].bv_val = NULL;
		*keysp = keys;
	} else {
		ch_free( keys );
		*keysp = NULL;
	}

	return LDAP_SUCCESS;
}

static int
octetStringSubstringsFilter (
	slap_mask_t use,
	slap_mask_t flags,
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *prefix,
	void * assertedValue,
Howard Chu's avatar
Howard Chu committed
511
512
	BerVarray *keysp,
	void *ctx)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
513
514
515
{
	SubstringsAssertion *sa;
	char pre;
516
	ber_len_t len, max, nkeys = 0;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
517
518
	size_t slen, mlen, klen;
	BerVarray keys;
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
519
520
	HASH_CONTEXT HASHcontext;
	unsigned char HASHdigest[HASH_BYTES];
Kurt Zeilenga's avatar
Kurt Zeilenga committed
521
522
523
524
525
	struct berval *value;
	struct berval digest;

	sa = (SubstringsAssertion *) assertedValue;

526
527
	if( flags & SLAP_INDEX_SUBSTR_INITIAL &&
		sa->sa_initial.bv_val != NULL &&
528
		sa->sa_initial.bv_len >= index_substr_if_minlen )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
529
530
	{
		nkeys++;
531
		if ( sa->sa_initial.bv_len > index_substr_if_maxlen &&
532
533
			( flags & SLAP_INDEX_SUBSTR_ANY ))
		{
534
			nkeys += (sa->sa_initial.bv_len - index_substr_if_maxlen) / index_substr_any_step;
535
		}
Kurt Zeilenga's avatar
Kurt Zeilenga committed
536
537
538
539
540
	}

	if( flags & SLAP_INDEX_SUBSTR_ANY && sa->sa_any != NULL ) {
		ber_len_t i;
		for( i=0; sa->sa_any[i].bv_val != NULL; i++ ) {
541
			if( sa->sa_any[i].bv_len >= index_substr_any_len ) {
542
				/* don't bother accounting with stepping */
Kurt Zeilenga's avatar
Kurt Zeilenga committed
543
				nkeys += sa->sa_any[i].bv_len -
544
					( index_substr_any_len - 1 );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
545
546
547
548
			}
		}
	}

549
550
	if( flags & SLAP_INDEX_SUBSTR_FINAL &&
		sa->sa_final.bv_val != NULL &&
551
		sa->sa_final.bv_len >= index_substr_if_minlen )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
552
553
	{
		nkeys++;
554
		if ( sa->sa_final.bv_len > index_substr_if_maxlen &&
555
556
			( flags & SLAP_INDEX_SUBSTR_ANY ))
		{
557
			nkeys += (sa->sa_final.bv_len - index_substr_if_maxlen) / index_substr_any_step;
558
		}
Kurt Zeilenga's avatar
Kurt Zeilenga committed
559
560
561
562
563
564
565
	}

	if( nkeys == 0 ) {
		*keysp = NULL;
		return LDAP_SUCCESS;
	}

566
	digest.bv_val = (char *)HASHdigest;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
567
568
569
570
571
	digest.bv_len = sizeof(HASHdigest);

	slen = syntax->ssyn_oidlen;
	mlen = mr->smr_oidlen;

572
	keys = slap_sl_malloc( sizeof( struct berval ) * (nkeys+1), ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
573
574
	nkeys = 0;

575
576
	if( flags & SLAP_INDEX_SUBSTR_INITIAL &&
		sa->sa_initial.bv_val != NULL &&
577
		sa->sa_initial.bv_len >= index_substr_if_minlen )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
578
579
580
581
	{
		pre = SLAP_INDEX_SUBSTR_INITIAL_PREFIX;
		value = &sa->sa_initial;

582
583
		klen = index_substr_if_maxlen < value->bv_len
			? index_substr_if_maxlen : value->bv_len;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
584

585
586
		hashDigestify( &HASHcontext, HASHdigest, prefix, pre,
			syntax, mr, (unsigned char *)value->bv_val, klen );
Howard Chu's avatar
Howard Chu committed
587
		ber_dupbv_x( &keys[nkeys++], &digest, ctx );
588
589
590
591

		/* If initial is too long and we have subany indexed, use it
		 * to match the excess...
		 */
592
		if (value->bv_len > index_substr_if_maxlen && (flags & SLAP_INDEX_SUBSTR_ANY))
593
594
595
		{
			ber_len_t j;
			pre = SLAP_INDEX_SUBSTR_PREFIX;
596
			for ( j=index_substr_if_maxlen-1; j <= value->bv_len - index_substr_any_len; j+=index_substr_any_step )
597
598
			{
				hashDigestify( &HASHcontext, HASHdigest, prefix, pre,
599
					syntax, mr, (unsigned char *)&value->bv_val[j], index_substr_any_len );
600
601
602
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
			}
		}
Kurt Zeilenga's avatar
Kurt Zeilenga committed
603
604
605
606
607
	}

	if( flags & SLAP_INDEX_SUBSTR_ANY && sa->sa_any != NULL ) {
		ber_len_t i, j;
		pre = SLAP_INDEX_SUBSTR_PREFIX;
608
		klen = index_substr_any_len;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
609
610

		for( i=0; sa->sa_any[i].bv_val != NULL; i++ ) {
611
			if( sa->sa_any[i].bv_len < index_substr_any_len ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
612
613
614
615
616
617
				continue;
			}

			value = &sa->sa_any[i];

			for(j=0;
618
619
				j <= value->bv_len - index_substr_any_len;
				j += index_substr_any_step )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
620
			{
621
622
				hashDigestify( &HASHcontext, HASHdigest, prefix, pre,
					syntax, mr, (unsigned char *)&value->bv_val[j], klen ); 
Howard Chu's avatar
Howard Chu committed
623
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
624
625
626
627
			}
		}
	}

628
629
	if( flags & SLAP_INDEX_SUBSTR_FINAL &&
		sa->sa_final.bv_val != NULL &&
630
		sa->sa_final.bv_len >= index_substr_if_minlen )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
631
632
633
634
	{
		pre = SLAP_INDEX_SUBSTR_FINAL_PREFIX;
		value = &sa->sa_final;

635
636
		klen = index_substr_if_maxlen < value->bv_len
			? index_substr_if_maxlen : value->bv_len;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
637

638
639
		hashDigestify( &HASHcontext, HASHdigest, prefix, pre,
			syntax, mr, (unsigned char *)&value->bv_val[value->bv_len-klen], klen );
Howard Chu's avatar
Howard Chu committed
640
		ber_dupbv_x( &keys[nkeys++], &digest, ctx );
641
642
643
644

		/* If final is too long and we have subany indexed, use it
		 * to match the excess...
		 */
645
		if (value->bv_len > index_substr_if_maxlen && (flags & SLAP_INDEX_SUBSTR_ANY))
646
647
648
		{
			ber_len_t j;
			pre = SLAP_INDEX_SUBSTR_PREFIX;
649
			for ( j=0; j <= value->bv_len - index_substr_if_maxlen; j+=index_substr_any_step )
650
651
			{
				hashDigestify( &HASHcontext, HASHdigest, prefix, pre,
652
					syntax, mr, (unsigned char *)&value->bv_val[j], index_substr_any_len );
653
654
655
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
			}
		}
Kurt Zeilenga's avatar
Kurt Zeilenga committed
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
	}

	if( nkeys > 0 ) {
		keys[nkeys].bv_val = NULL;
		*keysp = keys;
	} else {
		ch_free( keys );
		*keysp = NULL;
	}

	return LDAP_SUCCESS;
}

static int
bitStringValidate(
	Syntax *syntax,
	struct berval *in )
{
	ber_len_t i;

	/* very unforgiving validation, requires no normalization
	 * before simplistic matching
	 */
	if( in->bv_len < 3 ) {
		return LDAP_INVALID_SYNTAX;
	}

	/*
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
684
685
686
	 * RFC 2252 section 6.3 Bit String
	 *	bitstring = "'" *binary-digit "'B"
	 *	binary-digit = "0" / "1"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
	 * example: '0101111101'B
	 */
	
	if( in->bv_val[0] != '\'' ||
		in->bv_val[in->bv_len-2] != '\'' ||
		in->bv_val[in->bv_len-1] != 'B' )
	{
		return LDAP_INVALID_SYNTAX;
	}

	for( i=in->bv_len-3; i>0; i-- ) {
		if( in->bv_val[i] != '0' && in->bv_val[i] != '1' ) {
			return LDAP_INVALID_SYNTAX;
		}
	}

	return LDAP_SUCCESS;
}

706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
/*
 * Syntax is [RFC2252]:
 *

6.3. Bit String

   ( 1.3.6.1.4.1.1466.115.121.1.6 DESC 'Bit String' )

   Values in this syntax are encoded according to the following BNF:

      bitstring = "'" *binary-digit "'B"

      binary-digit = "0" / "1"

   ... 

6.21. Name And Optional UID

   ( 1.3.6.1.4.1.1466.115.121.1.34 DESC 'Name And Optional UID' )

   Values in this syntax are encoded according to the following BNF:

      NameAndOptionalUID = DistinguishedName [ "#" bitstring ]

   Although the '#' character may occur in a string representation of a
   distinguished name, no additional special quoting is done.  This
   syntax has been added subsequent to RFC 1778.

   Example:

      1.3.6.1.4.1.1466.0=#04024869,O=Test,C=GB#'0101'B

 *
 * draft-ietf-ldapbis-syntaxes-xx.txt says:
 *

3.3.2.  Bit String

   A value of the Bit String syntax is a sequence of binary digits.  The
   LDAP-specific encoding of a value of this syntax is defined by the
   following ABNF:

      BitString    = SQUOTE *binary-digit SQUOTE "B"

      binary-digit = "0" / "1"

   The <SQUOTE> rule is defined in [MODELS].

      Example:
         '0101111101'B

   The LDAP definition for the Bit String syntax is:

      ( 1.3.6.1.4.1.1466.115.121.1.6 DESC 'Bit String' )

   This syntax corresponds to the BIT STRING ASN.1 type from [ASN.1].

   ...

3.3.21.  Name and Optional UID

   A value of the Name and Optional UID syntax is the distinguished name
   [MODELS] of an entity optionally accompanied by a unique identifier
   that serves to differentiate the entity from others with an identical
   distinguished name.

   The LDAP-specific encoding of a value of this syntax is defined by
   the following ABNF:

       NameAndOptionalUID = distinguishedName [ SHARP BitString ]

   The <BitString> rule is defined in Section 3.3.2.  The
   <distinguishedName> rule is defined in [LDAPDN].  The <SHARP> rule is
   defined in [MODELS].

   Note that although the '#' character may occur in the string
   representation of a distinguished name, no additional escaping of
   this character is performed when a <distinguishedName> is encoded in
   a <NameAndOptionalUID>.

      Example:
         1.3.6.1.4.1.1466.0=#04024869,O=Test,C=GB#'0101'B

   The LDAP definition for the Name and Optional UID syntax is:

      ( 1.3.6.1.4.1.1466.115.121.1.34 DESC 'Name And Optional UID' )

   This syntax corresponds to the NameAndOptionalUID ASN.1 type from
   [X.520].

 *
 * draft-ietf-ldapbis-models-xx.txt [MODELS] says:
 *

1.4. Common ABNF Productions

  ...
      SHARP   = %x23 ; octothorpe (or sharp sign) ("#")
  ...
      SQUOTE  = %x27 ; single quote ("'")
  ...
      
 *
 * Note: normalization strips any leading "0"s, unless the
 * bit string is exactly "'0'B", so the normalized example,
 * in slapd, would result in
 * 
 * 1.3.6.1.4.1.1466.0=#04024869,o=test,c=gb#'101'B
 * 
 * Since draft-ietf-ldapbis-dn-xx.txt clarifies that SHARP,
 * i.e. "#", doesn't have to be escaped except when at the
 * beginning of a value, the definition of Name and Optional
 * UID appears to be flawed, because there is no clear means
 * to determine whether the UID part is present or not.
 *
 * Example:
 *
 * 	cn=Someone,dc=example,dc=com#'1'B
 *
 * could be either a NameAndOptionalUID with trailing UID, i.e.
 *
 * 	DN = "cn=Someone,dc=example,dc=com"
 * 	UID = "'1'B"
 * 
 * or a NameAndOptionalUID with no trailing UID, and the AVA
 * in the last RDN made of
 *
 * 	attributeType = dc 
 * 	attributeValue = com#'1'B
 *
 * in fact "com#'1'B" is a valid IA5 string.
 *
 * As a consequence, current slapd code assumes that the
 * presence of portions of a BitString at the end of the string 
 * representation of a NameAndOptionalUID means a BitString
 * is expected, and cause an error otherwise.  This is quite
 * arbitrary, and might change in the future.
 */


Kurt Zeilenga's avatar
Kurt Zeilenga committed
846
847
848
849
850
851
static int
nameUIDValidate(
	Syntax *syntax,
	struct berval *in )
{
	int rc;
852
	struct berval dn, uid;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
853
854
855
856
857
858

	if( in->bv_len == 0 ) return LDAP_SUCCESS;

	ber_dupbv( &dn, in );
	if( !dn.bv_val ) return LDAP_OTHER;

859
860
861
862
863
864
865
866
867
868
869
870
	/* if there's a "#", try bitStringValidate()... */
	uid.bv_val = strrchr( dn.bv_val, '#' );
	if ( uid.bv_val ) {
		uid.bv_val++;
		uid.bv_len = dn.bv_len - ( uid.bv_val - dn.bv_val );

		rc = bitStringValidate( NULL, &uid );
		if ( rc == LDAP_SUCCESS ) {
			/* in case of success, trim the UID,
			 * otherwise treat it as part of the DN */
			dn.bv_len -= uid.bv_len + 1;
			uid.bv_val[-1] = '\0';
Kurt Zeilenga's avatar
Kurt Zeilenga committed
871
872
873
874
875
876
877
878
879
		}
	}

	rc = dnValidate( NULL, &dn );

	ber_memfree( dn.bv_val );
	return rc;
}

880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
int
nameUIDPretty(
	Syntax *syntax,
	struct berval *val,
	struct berval *out,
	void *ctx )
{
	assert( val );
	assert( out );


	Debug( LDAP_DEBUG_TRACE, ">>> nameUIDPretty: <%s>\n", val->bv_val, 0, 0 );

	if( val->bv_len == 0 ) {
		ber_dupbv_x( out, val, ctx );

	} else if ( val->bv_len > SLAP_LDAPDN_MAXLEN ) {
		return LDAP_INVALID_SYNTAX;

	} else {
900
901
902
		int		rc;
		struct berval	dnval = *val;
		struct berval	uidval = BER_BVNULL;
903

904
905
906
907
		uidval.bv_val = strrchr( val->bv_val, '#' );
		if ( uidval.bv_val ) {
			uidval.bv_val++;
			uidval.bv_len = val->bv_len - ( uidval.bv_val - val->bv_val );
908

909
			rc = bitStringValidate( NULL, &uidval );
910

911
912
913
914
			if ( rc == LDAP_SUCCESS ) {
				ber_dupbv_x( &dnval, val, ctx );
				dnval.bv_len -= uidval.bv_len + 1;
				dnval.bv_val[dnval.bv_len] = '\0';
915

916
917
918
			} else {
				uidval.bv_val = NULL;
			}
919
920
921
		}

		rc = dnPretty( syntax, &dnval, out, ctx );
922
923
924
925
926
927
		if ( dnval.bv_val != val->bv_val ) {
			slap_sl_free( dnval.bv_val, ctx );
		}
		if( rc != LDAP_SUCCESS ) {
			return rc;
		}
928
929

		if( uidval.bv_val ) {
930
931
932
			int	i, c, got1;
			char	*tmp;

933
934
			tmp = slap_sl_realloc( out->bv_val, out->bv_len 
				+ STRLENOF( "#" ) + uidval.bv_len + 1,
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
935
				ctx );
936
937
938
939
			if( tmp == NULL ) {
				ber_memfree_x( out->bv_val, ctx );
				return LDAP_OTHER;
			}
940
			out->bv_val = tmp;
941
			out->bv_val[out->bv_len++] = '#';
942
			out->bv_val[out->bv_len++] = '\'';
943
944

			got1 = uidval.bv_len < sizeof("'0'B"); 
945
			for( i = 1; i < uidval.bv_len - 2; i++ ) {
946
947
948
949
950
951
952
953
				c = uidval.bv_val[i];
				switch(c) {
					case '0':
						if( got1 ) out->bv_val[out->bv_len++] = c;
						break;
					case '1':
						got1 = 1;
						out->bv_val[out->bv_len++] = c;
954
						break;
955
956
957
				}
			}

958
959
			out->bv_val[out->bv_len++] = '\'';
			out->bv_val[out->bv_len++] = 'B';
960
961
962
963
964
965
966
967
968
			out->bv_val[out->bv_len] = '\0';
		}
	}

	Debug( LDAP_DEBUG_TRACE, "<<< nameUIDPretty: <%s>\n", out->bv_val, 0, 0 );

	return LDAP_SUCCESS;
}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
969
970
971
972
973
974
static int
uniqueMemberNormalize(
	slap_mask_t usage,
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *val,
Howard Chu's avatar
Howard Chu committed
975
976
	struct berval *normalized,
	void *ctx )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
977
978
979
980
{
	struct berval out;
	int rc;

981
982
	assert( SLAP_MR_IS_VALUE_OF_SYNTAX( usage ));

Pierangelo Masarati's avatar
Pierangelo Masarati committed
983
984
	ber_dupbv_x( &out, val, ctx );
	if ( BER_BVISEMPTY( &out ) ) {
985
986
987
		*normalized = out;

	} else {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
988
		struct berval uid = BER_BVNULL;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
989

990
991
992
993
994
995
996
997
998
999
1000
		uid.bv_val = strrchr( out.bv_val, '#' );
		if ( uid.bv_val ) {
			uid.bv_val++;
			uid.bv_len = out.bv_len - ( uid.bv_val - out.bv_val );

			rc = bitStringValidate( NULL, &uid );
			if ( rc == LDAP_SUCCESS ) {
				uid.bv_val[-1] = '\0';
				out.bv_len -= uid.bv_len + 1;
			} else {
				uid.bv_val = NULL;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1001
1002
1003
			}
		}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
1004
		rc = dnNormalize( 0, NULL, NULL, &out, normalized, ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1005
1006

		if( rc != LDAP_SUCCESS ) {
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1007
			slap_sl_free( out.bv_val, ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1008
1009
1010
			return LDAP_INVALID_SYNTAX;
		}

1011
1012
1013
1014
		if( uid.bv_val ) {
			char	*tmp;

			tmp = ch_realloc( normalized->bv_val,
1015
1016
				normalized->bv_len + uid.bv_len
				+ STRLENOF("#") + 1 );
1017
1018
1019
1020
1021
1022
			if ( tmp == NULL ) {
				ber_memfree_x( normalized->bv_val, ctx );
				return LDAP_OTHER;
			}

			normalized->bv_val = tmp;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035

			/* insert the separator */
			normalized->bv_val[normalized->bv_len++] = '#';

			/* append the UID */
			AC_MEMCPY( &normalized->bv_val[normalized->bv_len],
				uid.bv_val, uid.bv_len );
			normalized->bv_len += uid.bv_len;

			/* terminate */
			normalized->bv_val[normalized->bv_len] = '\0';
		}

Pierangelo Masarati's avatar
Pierangelo Masarati committed
1036
		slap_sl_free( out.bv_val, ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1037
1038
1039
1040
1041
	}

	return LDAP_SUCCESS;
}

1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
static int
uniqueMemberMatch(
	int *matchp,
	slap_mask_t flags,
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *value,
	void *assertedValue )
{
	int match;
	struct berval *asserted = (struct berval *) assertedValue;
1053
	struct berval assertedDN = *asserted;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1054
1055
1056
	struct berval assertedUID = BER_BVNULL;
	struct berval valueDN = BER_BVNULL;
	struct berval valueUID = BER_BVNULL;
1057

1058
	if ( !BER_BVISEMPTY( asserted ) ) {
1059
1060
1061
1062
1063
		assertedUID.bv_val = strrchr( assertedDN.bv_val, '#' );
		if ( !BER_BVISNULL( &assertedUID ) ) {
			assertedUID.bv_val++;
			assertedUID.bv_len = assertedDN.bv_len
				- ( assertedUID.bv_val - assertedDN.bv_val );
1064

1065
1066
			if ( bitStringValidate( NULL, &assertedUID ) == LDAP_SUCCESS ) {
				assertedDN.bv_len -= assertedUID.bv_len + 1;
1067

1068
1069
1070
			} else {
				BER_BVZERO( &assertedUID );
			}
1071
1072
1073
		}
	}

1074
	if ( !BER_BVISEMPTY( value ) ) {
1075
1076
		valueDN = *value;

1077
1078
1079
1080
1081
		valueUID.bv_val = strrchr( valueDN.bv_val, '#' );
		if ( !BER_BVISNULL( &valueUID ) ) {
			valueUID.bv_val++;
			valueUID.bv_len = valueDN.bv_len
				- ( valueUID.bv_val - valueDN.bv_val );
1082

1083
1084
			if ( bitStringValidate( NULL, &valueUID ) == LDAP_SUCCESS ) {
				valueDN.bv_len -= valueUID.bv_len + 1;
1085

1086
1087
1088
			} else {
				BER_BVZERO( &valueUID );
			}
1089
1090
1091
1092
		}
	}

	if( valueUID.bv_len && assertedUID.bv_len ) {
1093
1094
1095
1096
1097
1098
		match = valueUID.bv_len - assertedUID.bv_len;
		if ( match ) {
			*matchp = match;
			return LDAP_SUCCESS;
		}

1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
		match = memcmp( valueUID.bv_val, assertedUID.bv_val, valueUID.bv_len );
		if( match ) {
			*matchp = match;
			return LDAP_SUCCESS;
		}
	}

	return dnMatch( matchp, flags, syntax, mr, &valueDN, &assertedDN );
}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
1109
1110
1111
1112
1113
1114
/*
 * Handling boolean syntax and matching is quite rigid.
 * A more flexible approach would be to allow a variety
 * of strings to be normalized and prettied into TRUE
 * and FALSE.
 */
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
static int
booleanValidate(
	Syntax *syntax,
	struct berval *in )
{
	/* very unforgiving validation, requires no normalization
	 * before simplistic matching
	 */

	if( in->bv_len == 4 ) {
1125
		if( bvmatch( in, &slap_true_bv ) ) {
1126
1127
1128
			return LDAP_SUCCESS;
		}
	} else if( in->bv_len == 5 ) {
1129
		if( bvmatch( in, &slap_false_bv ) ) {
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
			return LDAP_SUCCESS;
		}
	}

	return LDAP_INVALID_SYNTAX;
}

static int
booleanMatch(
	int *matchp,
1140
	slap_mask_t flags,
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *value,
	void *assertedValue )
{
	/* simplistic matching allowed by rigid validation */
	struct berval *asserted = (struct berval *) assertedValue;
	*matchp = value->bv_len != asserted->bv_len;
	return LDAP_SUCCESS;
}

1152
1153
1154
1155
1156
/*-------------------------------------------------------------------
LDAP/X.500 string syntax / matching rules have a few oddities.  This
comment attempts to detail how slapd(8) treats them.

Summary:
1157
  StringSyntax		X.500	LDAP	Matching/Comments
1158
1159
  DirectoryString	CHOICE	UTF8	i/e + ignore insignificant spaces
  PrintableString	subset	subset	i/e + ignore insignificant spaces
1160
  PrintableString	subset	subset	i/e + ignore insignificant spaces
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
1161
  NumericString		subset	subset	ignore all spaces
1162
1163
1164
  IA5String			ASCII	ASCII	i/e + ignore insignificant spaces
  TeletexString		T.61	T.61	i/e + ignore insignificant spaces

Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
1165
  TelephoneNumber	subset	subset	i + ignore all spaces and "-"
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175

  See draft-ietf-ldapbis-strpro for details (once published).


Directory String -
  In X.500(93), a directory string can be either a PrintableString,
  a bmpString, or a UniversalString (e.g., UCS (a subset of Unicode)).
  In later versions, more CHOICEs were added.  In all cases the string
  must be non-empty.

1176
  In LDAPv3, a directory string is a UTF-8 encoded UCS string.
1177
  A directory string cannot be zero length.
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223

  For matching, there are both case ignore and exact rules.  Both
  also require that "insignificant" spaces be ignored.
	spaces before the first non-space are ignored;
	spaces after the last non-space are ignored;
	spaces after a space are ignored.
  Note: by these rules (and as clarified in X.520), a string of only
  spaces is to be treated as if held one space, not empty (which
  would be a syntax error).

NumericString
  In ASN.1, numeric string is just a string of digits and spaces
  and could be empty.  However, in X.500, all attribute values of
  numeric string carry a non-empty constraint.  For example:

	internationalISDNNumber ATTRIBUTE ::= {
		WITH SYNTAX InternationalISDNNumber
		EQUALITY MATCHING RULE numericStringMatch
		SUBSTRINGS MATCHING RULE numericStringSubstringsMatch
		ID id-at-internationalISDNNumber }
	InternationalISDNNumber ::=
	    NumericString (SIZE(1..ub-international-isdn-number))

  Unforunately, some assertion values are don't carry the same
  constraint (but its unclear how such an assertion could ever
  be true). In LDAP, there is one syntax (numericString) not two
  (numericString with constraint, numericString without constraint).
  This should be treated as numericString with non-empty constraint.
  Note that while someone may have no ISDN number, there are no ISDN
  numbers which are zero length.

  In matching, spaces are ignored.

PrintableString
  In ASN.1, Printable string is just a string of printable characters
  and can be empty.  In X.500, semantics much like NumericString (see
  serialNumber for a like example) excepting uses insignificant space
  handling instead of ignore all spaces.  

IA5String
  Basically same as PrintableString.  There are no examples in X.500,
  but same logic applies.  So we require them to be non-empty as
  well.

-------------------------------------------------------------------*/

1224
1225
1226
1227
1228
1229
1230
static int
UTF8StringValidate(
	Syntax *syntax,
	struct berval *in )
{
	ber_len_t count;
	int len;
1231
	unsigned char *u = (unsigned char *)in->bv_val;
1232

1233
1234
1235
1236
	if( in->bv_len == 0 && syntax == slap_schema.si_syn_directoryString ) {
		/* directory strings cannot be empty */
		return LDAP_INVALID_SYNTAX;
	}
1237

1238
	for( count = in->bv_len; count > 0; count-=len, u+=len ) {
1239
		/* get the length indicated by the first byte */
1240
		len = LDAP_UTF8_CHARLEN2( u, len );
1241

Kurt Zeilenga's avatar
Kurt Zeilenga committed
1242
1243
1244
		/* very basic checks */
		switch( len ) {
			case 6:
1245
				if( (u[5] & 0xC0) != 0x80 ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1246
1247
1248
					return LDAP_INVALID_SYNTAX;
				}
			case 5:
1249
				if( (u[4] & 0xC0) != 0x80 ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1250
1251
1252
					return LDAP_INVALID_SYNTAX;
				}
			case 4:
1253
				if( (u[3] & 0xC0) != 0x80 ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1254
1255
1256
					return LDAP_INVALID_SYNTAX;
				}
			case 3:
1257
				if( (u[2] & 0xC0 )!= 0x80 ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1258
1259
1260
					return LDAP_INVALID_SYNTAX;
				}
			case 2:
1261
				if( (u[1] & 0xC0) != 0x80 ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1262
1263
1264
					return LDAP_INVALID_SYNTAX;
				}
			case 1:
1265
				/* CHARLEN already validated it */
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1266
1267
1268
1269
				break;
			default:
				return LDAP_INVALID_SYNTAX;
		}
1270
1271
1272

		/* make sure len corresponds with the offset
			to the next character */
1273
		if( LDAP_UTF8_OFFSET( (char *)u ) != len ) return LDAP_INVALID_SYNTAX;
1274
1275
	}

1276
1277
1278
	if( count != 0 ) {
		return LDAP_INVALID_SYNTAX;
	}
1279

1280
	return LDAP_SUCCESS;
1281
1282
}

1283
1284
1285
1286
1287
1288
static int
UTF8StringNormalize(
	slap_mask_t use,
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *val,
Howard Chu's avatar
Howard Chu committed
1289
1290
	struct berval *normalized,
	void *ctx )