schema_init.c 111 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-2007 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
#ifdef HAVE_LIMITS_H
Kurt Zeilenga's avatar
Kurt Zeilenga committed
21
#include <limits.h>
Kurt Zeilenga's avatar
Kurt Zeilenga committed
22
#endif
23
24

#include <ac/ctype.h>
25
#include <ac/errno.h>
26
27
28
29
#include <ac/string.h>
#include <ac/socket.h>

#include "slap.h"
30

31
32
#include "ldap_utf8.h"

33
#include "lutil.h"
34
35
36
37
38
39
#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)
40

41
42
/* approx matching rules */
#define directoryStringApproxMatchOID	"1.3.6.1.4.1.4203.666.4.4"
43
#define directoryStringApproxMatch		approxMatch
Gary Williams's avatar
Gary Williams committed
44
#define directoryStringApproxIndexer	approxIndexer
45
#define directoryStringApproxFilter		approxFilter
46
#define IA5StringApproxMatchOID			"1.3.6.1.4.1.4203.666.4.5"
Gary Williams's avatar
Gary Williams committed
47
#define IA5StringApproxMatch			approxMatch
48
#define IA5StringApproxIndexer			approxIndexer
Gary Williams's avatar
Gary Williams committed
49
#define IA5StringApproxFilter			approxFilter
50

Howard Chu's avatar
Howard Chu committed
51
52
53
54
55
56
57
/* Change Sequence Number (CSN) - much of this will change */
#define csnValidate				blobValidate
#define csnMatch				octetStringMatch
#define csnOrderingMatch		octetStringOrderingMatch
#define csnIndexer				generalizedTimeIndexer
#define csnFilter				generalizedTimeFilter

58
59
60
/* FIXME: temporary */
#define authzMatch				octetStringMatch

61
62
63
64
65
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;

66
67
68
ldap_pvt_thread_mutex_t	ad_undef_mutex;
ldap_pvt_thread_mutex_t	oc_undef_mutex;

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

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

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

89
90
91
92
93
94
95
96
97
98
99
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;
}

100
/* X.509 certificate validation */
101
102
static int certificateValidate( Syntax *syntax, struct berval *in )
{
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
	BerElementBuffer berbuf;
	BerElement *ber = (BerElement *)&berbuf;
	ber_tag_t tag;
	ber_len_t len;
	ber_int_t i, version = 0;

	ber_init2( ber, in, LBER_USE_DER );
	tag = ber_skip_tag( ber, &len );	/* Signed wrapper */
	if ( tag != LBER_SEQUENCE ) return LDAP_INVALID_SYNTAX;
	tag = ber_skip_tag( ber, &len );	/* Sequence */
	if ( tag != LBER_SEQUENCE ) return LDAP_INVALID_SYNTAX;
	tag = ber_skip_tag( ber, &len );
	if ( tag == 0xa0 ) {	/* Optional version */
		tag = ber_get_int( ber, &version );
		if ( tag != LBER_INTEGER ) return LDAP_INVALID_SYNTAX;
	}
	tag = ber_get_int( ber, &i );	/* Serial */
	if ( tag != LBER_INTEGER ) return LDAP_INVALID_SYNTAX;
	tag = ber_skip_tag( ber, &len );	/* Signature Algorithm */
	if ( tag != LBER_SEQUENCE ) return LDAP_INVALID_SYNTAX;
	ber_skip_data( ber, len );
	tag = ber_skip_tag( ber, &len );	/* Issuer DN */
	if ( tag != LBER_SEQUENCE ) return LDAP_INVALID_SYNTAX;
	ber_skip_data( ber, len );
	tag = ber_skip_tag( ber, &len );	/* Validity */
	if ( tag != LBER_SEQUENCE ) return LDAP_INVALID_SYNTAX;
	ber_skip_data( ber, len );
	tag = ber_skip_tag( ber, &len );	/* Subject DN */
	if ( tag != LBER_SEQUENCE ) return LDAP_INVALID_SYNTAX;
	ber_skip_data( ber, len );
	tag = ber_skip_tag( ber, &len );	/* Subject PublicKeyInfo */
	if ( tag != LBER_SEQUENCE ) return LDAP_INVALID_SYNTAX;
	ber_skip_data( ber, len );
	tag = ber_skip_tag( ber, &len );
	if ( tag == 0xa1 ) {	/* issuerUniqueID */
		if ( version < 1 ) return LDAP_INVALID_SYNTAX;
		ber_skip_data( ber, len );
		tag = ber_skip_tag( ber, &len );
	}
	if ( tag == 0xa2 ) {	/* subjectUniqueID */
		if ( version < 1 ) return LDAP_INVALID_SYNTAX;
		ber_skip_data( ber, len );
		tag = ber_skip_tag( ber, &len );
	}
	if ( tag == 0xa3 ) {	/* Extensions */
		if ( version < 2 ) return LDAP_INVALID_SYNTAX;
		tag = ber_skip_tag( ber, &len );
		if ( tag != LBER_SEQUENCE ) return LDAP_INVALID_SYNTAX;
		ber_skip_data( ber, len );
		tag = ber_skip_tag( ber, &len );
	}
	/* signatureAlgorithm */
	if ( tag != LBER_SEQUENCE ) return LDAP_INVALID_SYNTAX;
	ber_skip_data( ber, len );
	tag = ber_skip_tag( ber, &len );
	/* Signature */
	if ( tag != LBER_BITSTRING ) return LDAP_INVALID_SYNTAX; 
	ber_skip_data( ber, len );
	tag = ber_skip_tag( ber, &len );
	/* Must be at end now */
	if ( len || tag != LBER_DEFAULT ) return LDAP_INVALID_SYNTAX;
164
165
166
	return LDAP_SUCCESS;
}

167
int
168
169
octetStringMatch(
	int *matchp,
170
	slap_mask_t flags,
171
172
173
174
175
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *value,
	void *assertedValue )
{
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
176
177
	struct berval *asserted = (struct berval *) assertedValue;
	int match = value->bv_len - asserted->bv_len;
178
179

	if( match == 0 ) {
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
180
		match = memcmp( value->bv_val, asserted->bv_val, value->bv_len );
181
182
183
184
185
186
	}

	*matchp = match;
	return LDAP_SUCCESS;
}

187
188
189
190
191
192
193
194
195
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
196
	struct berval *asserted = (struct berval *) assertedValue;
197
	ber_len_t v_len  = value->bv_len;
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
198
	ber_len_t av_len = asserted->bv_len;
199

Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
200
	int match = memcmp( value->bv_val, asserted->bv_val,
201
		(v_len < av_len ? v_len : av_len) );
202
203
204

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

205
206
207
208
	*matchp = match;
	return LDAP_SUCCESS;
}

Howard Chu's avatar
Howard Chu committed
209
210
static void
hashPreset(
211
212
213
214
	HASH_CONTEXT *HASHcontext,
	struct berval *prefix,
	char pre,
	Syntax *syntax,
Howard Chu's avatar
Howard Chu committed
215
	MatchingRule *mr)
216
217
218
219
220
221
222
223
224
225
226
227
{
	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);
	return;
}

Howard Chu's avatar
Howard Chu committed
228
229
230
231
232
233
234
235
236
237
238
239
static void
hashIter(
	HASH_CONTEXT *HASHcontext,
	unsigned char *HASHdigest,
	unsigned char *value,
	int len)
{
	HASH_CONTEXT ctx = *HASHcontext;
	HASH_Update( &ctx, value, len );
	HASH_Final( HASHdigest, &ctx );
}

240
/* Index generation function */
241
int octetStringIndexer(
242
243
	slap_mask_t use,
	slap_mask_t flags,
244
245
246
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *prefix,
247
	BerVarray values,
Howard Chu's avatar
Howard Chu committed
248
249
	BerVarray *keysp,
	void *ctx )
250
251
252
{
	int i;
	size_t slen, mlen;
253
	BerVarray keys;
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
254
255
	HASH_CONTEXT HASHcontext;
	unsigned char HASHdigest[HASH_BYTES];
256
	struct berval digest;
257
	digest.bv_val = (char *)HASHdigest;
258
	digest.bv_len = sizeof(HASHdigest);
259

260
	for( i=0; !BER_BVISNULL( &values[i] ); i++ ) {
261
262
263
		/* just count them */
	}

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

267
	keys = slap_sl_malloc( sizeof( struct berval ) * (i+1), ctx );
268

269
270
	slen = syntax->ssyn_oidlen;
	mlen = mr->smr_oidlen;
271

Howard Chu's avatar
Howard Chu committed
272
	hashPreset( &HASHcontext, prefix, 0, syntax, mr);
273
	for( i=0; !BER_BVISNULL( &values[i] ); i++ ) {
Howard Chu's avatar
Howard Chu committed
274
275
		hashIter( &HASHcontext, HASHdigest,
			(unsigned char *)values[i].bv_val, values[i].bv_len );
Howard Chu's avatar
Howard Chu committed
276
		ber_dupbv_x( &keys[i], &digest, ctx );
277
278
	}

279
	BER_BVZERO( &keys[i] );
280
281
282
283
284
285
286

	*keysp = keys;

	return LDAP_SUCCESS;
}

/* Index generation function */
287
int octetStringFilter(
288
289
	slap_mask_t use,
	slap_mask_t flags,
290
291
292
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *prefix,
293
	void * assertedValue,
Howard Chu's avatar
Howard Chu committed
294
295
	BerVarray *keysp,
	void *ctx )
296
297
{
	size_t slen, mlen;
298
	BerVarray keys;
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
299
300
	HASH_CONTEXT HASHcontext;
	unsigned char HASHdigest[HASH_BYTES];
301
	struct berval *value = (struct berval *) assertedValue;
302
	struct berval digest;
303
	digest.bv_val = (char *)HASHdigest;
304
	digest.bv_len = sizeof(HASHdigest);
305

306
307
	slen = syntax->ssyn_oidlen;
	mlen = mr->smr_oidlen;
308

309
	keys = slap_sl_malloc( sizeof( struct berval ) * 2, ctx );
310

Howard Chu's avatar
Howard Chu committed
311
312
313
	hashPreset( &HASHcontext, prefix, 0, syntax, mr );
	hashIter( &HASHcontext, HASHdigest,
		(unsigned char *)value->bv_val, value->bv_len );
314

Howard Chu's avatar
Howard Chu committed
315
	ber_dupbv_x( keys, &digest, ctx );
316
	BER_BVZERO( &keys[1] );
317
318
319
320
321

	*keysp = keys;

	return LDAP_SUCCESS;
}
322

323
static int
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
324
octetStringSubstringsMatch(
Kurt Zeilenga's avatar
Kurt Zeilenga committed
325
326
	int *matchp,
	slap_mask_t flags,
327
	Syntax *syntax,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
328
329
330
	MatchingRule *mr,
	struct berval *value,
	void *assertedValue )
331
{
Kurt Zeilenga's avatar
Kurt Zeilenga committed
332
333
334
335
	int match = 0;
	SubstringsAssertion *sub = assertedValue;
	struct berval left = *value;
	int i;
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
336
	ber_len_t inlen = 0;
337

Kurt Zeilenga's avatar
Kurt Zeilenga committed
338
	/* Add up asserted input length */
339
	if ( !BER_BVISNULL( &sub->sa_initial ) ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
340
		inlen += sub->sa_initial.bv_len;
341
	}
342
343
	if ( sub->sa_any ) {
		for ( i = 0; !BER_BVISNULL( &sub->sa_any[i] ); i++ ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
344
345
346
			inlen += sub->sa_any[i].bv_len;
		}
	}
347
	if ( !BER_BVISNULL( &sub->sa_final ) ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
348
		inlen += sub->sa_final.bv_len;
349
350
	}

351
352
	if ( !BER_BVISNULL( &sub->sa_initial ) ) {
		if ( inlen > left.bv_len ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
353
354
			match = 1;
			goto done;
355
356
		}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
357
358
		match = memcmp( sub->sa_initial.bv_val, left.bv_val,
			sub->sa_initial.bv_len );
359

360
		if ( match != 0 ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
361
362
			goto done;
		}
363

Kurt Zeilenga's avatar
Kurt Zeilenga committed
364
365
366
367
		left.bv_val += sub->sa_initial.bv_len;
		left.bv_len -= sub->sa_initial.bv_len;
		inlen -= sub->sa_initial.bv_len;
	}
368

369
370
	if ( !BER_BVISNULL( &sub->sa_final ) ) {
		if ( inlen > left.bv_len ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
371
372
373
			match = 1;
			goto done;
		}
374

Kurt Zeilenga's avatar
Kurt Zeilenga committed
375
376
377
		match = memcmp( sub->sa_final.bv_val,
			&left.bv_val[left.bv_len - sub->sa_final.bv_len],
			sub->sa_final.bv_len );
378

379
		if ( match != 0 ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
380
			goto done;
381
382
		}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
383
384
		left.bv_len -= sub->sa_final.bv_len;
		inlen -= sub->sa_final.bv_len;
385
386
	}

387
388
	if ( sub->sa_any ) {
		for ( i = 0; !BER_BVISNULL( &sub->sa_any[i] ); i++ ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
389
390
			ber_len_t idx;
			char *p;
391

Kurt Zeilenga's avatar
Kurt Zeilenga committed
392
retry:
393
			if ( inlen > left.bv_len ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
394
395
396
397
				/* not enough length */
				match = 1;
				goto done;
			}
398

399
			if ( BER_BVISEMPTY( &sub->sa_any[i] ) ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
400
401
				continue;
			}
402

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

Kurt Zeilenga's avatar
Kurt Zeilenga committed
405
406
407
			if( p == NULL ) {
				match = 1;
				goto done;
408
409
			}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
410
			idx = p - left.bv_val;
411

412
			if ( idx >= left.bv_len ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
413
414
415
				/* this shouldn't happen */
				return LDAP_OTHER;
			}
416

Kurt Zeilenga's avatar
Kurt Zeilenga committed
417
418
			left.bv_val = p;
			left.bv_len -= idx;
419

420
			if ( sub->sa_any[i].bv_len > left.bv_len ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
421
422
423
424
				/* not enough left */
				match = 1;
				goto done;
			}
425

Kurt Zeilenga's avatar
Kurt Zeilenga committed
426
427
428
			match = memcmp( left.bv_val,
				sub->sa_any[i].bv_val,
				sub->sa_any[i].bv_len );
429

430
			if ( match != 0 ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
431
432
433
434
				left.bv_val++;
				left.bv_len--;
				goto retry;
			}
435

Kurt Zeilenga's avatar
Kurt Zeilenga committed
436
437
438
			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;
439
440
441
		}
	}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
442
443
done:
	*matchp = match;
444
445
446
	return LDAP_SUCCESS;
}

Kurt Zeilenga's avatar
Kurt Zeilenga committed
447
448
/* Substrings Index generation function */
static int
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
449
octetStringSubstringsIndexer(
Kurt Zeilenga's avatar
Kurt Zeilenga committed
450
451
452
453
454
455
	slap_mask_t use,
	slap_mask_t flags,
	Syntax *syntax,
	MatchingRule *mr,
	struct berval *prefix,
	BerVarray values,
Howard Chu's avatar
Howard Chu committed
456
457
	BerVarray *keysp,
	void *ctx )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
458
{
Howard Chu's avatar
Howard Chu committed
459
	ber_len_t i, nkeys;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
460
461
462
	size_t slen, mlen;
	BerVarray keys;

Howard Chu's avatar
Howard Chu committed
463
	HASH_CONTEXT HCany, HCini, HCfin;
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
464
	unsigned char HASHdigest[HASH_BYTES];
Kurt Zeilenga's avatar
Kurt Zeilenga committed
465
	struct berval digest;
466
	digest.bv_val = (char *)HASHdigest;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
467
468
	digest.bv_len = sizeof(HASHdigest);

469
	nkeys = 0;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
470

471
	for ( i = 0; !BER_BVISNULL( &values[i] ); i++ ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
472
473
		/* count number of indices to generate */
		if( flags & SLAP_INDEX_SUBSTR_INITIAL ) {
474
475
476
477
478
			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
479
480
481
482
			}
		}

		if( flags & SLAP_INDEX_SUBSTR_ANY ) {
483
484
			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
485
486
487
488
			}
		}

		if( flags & SLAP_INDEX_SUBSTR_FINAL ) {
489
490
491
492
493
			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
494
495
496
497
498
499
500
501
502
503
			}
		}
	}

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

504
	keys = slap_sl_malloc( sizeof( struct berval ) * (nkeys+1), ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
505
506
507
508

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

Howard Chu's avatar
Howard Chu committed
509
510
511
512
513
514
515
	if ( flags & SLAP_INDEX_SUBSTR_ANY )
		hashPreset( &HCany, prefix, SLAP_INDEX_SUBSTR_PREFIX, syntax, mr );
	if( flags & SLAP_INDEX_SUBSTR_INITIAL )
		hashPreset( &HCini, prefix, SLAP_INDEX_SUBSTR_INITIAL_PREFIX, syntax, mr );
	if( flags & SLAP_INDEX_SUBSTR_FINAL )
		hashPreset( &HCfin, prefix, SLAP_INDEX_SUBSTR_FINAL_PREFIX, syntax, mr );

516
517
	nkeys = 0;
	for ( i = 0; !BER_BVISNULL( &values[i] ); i++ ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
518
519
520
		ber_len_t j,max;

		if( ( flags & SLAP_INDEX_SUBSTR_ANY ) &&
521
			( values[i].bv_len >= index_substr_any_len ) )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
522
		{
523
			max = values[i].bv_len - (index_substr_any_len - 1);
Kurt Zeilenga's avatar
Kurt Zeilenga committed
524
525

			for( j=0; j<max; j++ ) {
Howard Chu's avatar
Howard Chu committed
526
527
528
				hashIter( &HCany, HASHdigest,
					(unsigned char *)&values[i].bv_val[j],
					index_substr_any_len );
Howard Chu's avatar
Howard Chu committed
529
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
530
531
532
			}
		}

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

536
537
		max = index_substr_if_maxlen < values[i].bv_len
			? index_substr_if_maxlen : values[i].bv_len;
538

539
		for( j=index_substr_if_minlen; j<=max; j++ ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
540
541

			if( flags & SLAP_INDEX_SUBSTR_INITIAL ) {
Howard Chu's avatar
Howard Chu committed
542
543
				hashIter( &HCini, HASHdigest,
					(unsigned char *)values[i].bv_val, j );
Howard Chu's avatar
Howard Chu committed
544
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
545
546
547
			}

			if( flags & SLAP_INDEX_SUBSTR_FINAL ) {
Howard Chu's avatar
Howard Chu committed
548
549
				hashIter( &HCfin, HASHdigest,
					(unsigned char *)&values[i].bv_val[values[i].bv_len-j], j );
Howard Chu's avatar
Howard Chu committed
550
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
551
552
553
554
555
556
			}

		}
	}

	if( nkeys > 0 ) {
557
		BER_BVZERO( &keys[nkeys] );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
		*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
575
576
	BerVarray *keysp,
	void *ctx)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
577
578
579
{
	SubstringsAssertion *sa;
	char pre;
Howard Chu's avatar
Howard Chu committed
580
	ber_len_t nkeys = 0;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
581
582
	size_t slen, mlen, klen;
	BerVarray keys;
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
583
584
	HASH_CONTEXT HASHcontext;
	unsigned char HASHdigest[HASH_BYTES];
Kurt Zeilenga's avatar
Kurt Zeilenga committed
585
586
587
588
589
	struct berval *value;
	struct berval digest;

	sa = (SubstringsAssertion *) assertedValue;

590
	if( flags & SLAP_INDEX_SUBSTR_INITIAL &&
591
		!BER_BVISNULL( &sa->sa_initial ) &&
592
		sa->sa_initial.bv_len >= index_substr_if_minlen )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
593
594
	{
		nkeys++;
595
		if ( sa->sa_initial.bv_len > index_substr_if_maxlen &&
596
597
			( flags & SLAP_INDEX_SUBSTR_ANY ))
		{
598
			nkeys += 1 + (sa->sa_initial.bv_len - index_substr_if_maxlen) / index_substr_any_step;
599
		}
Kurt Zeilenga's avatar
Kurt Zeilenga committed
600
601
	}

602
	if ( flags & SLAP_INDEX_SUBSTR_ANY && sa->sa_any != NULL ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
603
		ber_len_t i;
604
		for( i=0; !BER_BVISNULL( &sa->sa_any[i] ); i++ ) {
605
			if( sa->sa_any[i].bv_len >= index_substr_any_len ) {
606
				/* don't bother accounting with stepping */
Kurt Zeilenga's avatar
Kurt Zeilenga committed
607
				nkeys += sa->sa_any[i].bv_len -
608
					( index_substr_any_len - 1 );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
609
610
611
612
			}
		}
	}

613
	if( flags & SLAP_INDEX_SUBSTR_FINAL &&
614
		!BER_BVISNULL( &sa->sa_final ) &&
615
		sa->sa_final.bv_len >= index_substr_if_minlen )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
616
617
	{
		nkeys++;
618
		if ( sa->sa_final.bv_len > index_substr_if_maxlen &&
619
620
			( flags & SLAP_INDEX_SUBSTR_ANY ))
		{
621
			nkeys += 1 + (sa->sa_final.bv_len - index_substr_if_maxlen) / index_substr_any_step;
622
		}
Kurt Zeilenga's avatar
Kurt Zeilenga committed
623
624
625
626
627
628
629
	}

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

630
	digest.bv_val = (char *)HASHdigest;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
631
632
633
634
635
	digest.bv_len = sizeof(HASHdigest);

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

636
	keys = slap_sl_malloc( sizeof( struct berval ) * (nkeys+1), ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
637
638
	nkeys = 0;

639
	if( flags & SLAP_INDEX_SUBSTR_INITIAL &&
640
		!BER_BVISNULL( &sa->sa_initial ) &&
641
		sa->sa_initial.bv_len >= index_substr_if_minlen )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
642
643
644
645
	{
		pre = SLAP_INDEX_SUBSTR_INITIAL_PREFIX;
		value = &sa->sa_initial;

646
647
		klen = index_substr_if_maxlen < value->bv_len
			? index_substr_if_maxlen : value->bv_len;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
648

Howard Chu's avatar
Howard Chu committed
649
650
651
		hashPreset( &HASHcontext, prefix, pre, syntax, mr );
		hashIter( &HASHcontext, HASHdigest,
			(unsigned char *)value->bv_val, klen );
Howard Chu's avatar
Howard Chu committed
652
		ber_dupbv_x( &keys[nkeys++], &digest, ctx );
653
654
655
656

		/* If initial is too long and we have subany indexed, use it
		 * to match the excess...
		 */
657
		if (value->bv_len > index_substr_if_maxlen && (flags & SLAP_INDEX_SUBSTR_ANY))
658
659
660
		{
			ber_len_t j;
			pre = SLAP_INDEX_SUBSTR_PREFIX;
Howard Chu's avatar
Howard Chu committed
661
			hashPreset( &HASHcontext, prefix, pre, syntax, mr);
662
			for ( j=index_substr_if_maxlen-1; j <= value->bv_len - index_substr_any_len; j+=index_substr_any_step )
663
			{
Howard Chu's avatar
Howard Chu committed
664
665
				hashIter( &HASHcontext, HASHdigest,
					(unsigned char *)&value->bv_val[j], index_substr_any_len );
666
667
668
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
			}
		}
Kurt Zeilenga's avatar
Kurt Zeilenga committed
669
670
671
672
673
	}

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

676
		for( i=0; !BER_BVISNULL( &sa->sa_any[i] ); i++ ) {
677
			if( sa->sa_any[i].bv_len < index_substr_any_len ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
678
679
680
681
682
				continue;
			}

			value = &sa->sa_any[i];

Howard Chu's avatar
Howard Chu committed
683
			hashPreset( &HASHcontext, prefix, pre, syntax, mr);
Kurt Zeilenga's avatar
Kurt Zeilenga committed
684
			for(j=0;
685
686
				j <= value->bv_len - index_substr_any_len;
				j += index_substr_any_step )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
687
			{
Howard Chu's avatar
Howard Chu committed
688
689
				hashIter( &HASHcontext, HASHdigest,
					(unsigned char *)&value->bv_val[j], klen ); 
Howard Chu's avatar
Howard Chu committed
690
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
691
692
693
694
			}
		}
	}

695
	if( flags & SLAP_INDEX_SUBSTR_FINAL &&
696
		!BER_BVISNULL( &sa->sa_final ) &&
697
		sa->sa_final.bv_len >= index_substr_if_minlen )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
698
699
700
701
	{
		pre = SLAP_INDEX_SUBSTR_FINAL_PREFIX;
		value = &sa->sa_final;

702
703
		klen = index_substr_if_maxlen < value->bv_len
			? index_substr_if_maxlen : value->bv_len;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
704

Howard Chu's avatar
Howard Chu committed
705
706
707
		hashPreset( &HASHcontext, prefix, pre, syntax, mr );
		hashIter( &HASHcontext, HASHdigest,
			(unsigned char *)&value->bv_val[value->bv_len-klen], klen );
Howard Chu's avatar
Howard Chu committed
708
		ber_dupbv_x( &keys[nkeys++], &digest, ctx );
709
710
711
712

		/* If final is too long and we have subany indexed, use it
		 * to match the excess...
		 */
713
		if (value->bv_len > index_substr_if_maxlen && (flags & SLAP_INDEX_SUBSTR_ANY))
714
715
716
		{
			ber_len_t j;
			pre = SLAP_INDEX_SUBSTR_PREFIX;
Howard Chu's avatar
Howard Chu committed
717
			hashPreset( &HASHcontext, prefix, pre, syntax, mr);
718
			for ( j=0; j <= value->bv_len - index_substr_if_maxlen; j+=index_substr_any_step )
719
			{
Howard Chu's avatar
Howard Chu committed
720
721
				hashIter( &HASHcontext, HASHdigest,
					(unsigned char *)&value->bv_val[j], index_substr_any_len );
722
723
724
				ber_dupbv_x( &keys[nkeys++], &digest, ctx );
			}
		}
Kurt Zeilenga's avatar
Kurt Zeilenga committed
725
726
727
	}

	if( nkeys > 0 ) {
728
		BER_BVZERO( &keys[nkeys] );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
		*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
Kurt Zeilenga committed
752
753
754
755
756
757
758
759
	/* RFC 4517 Section 3.3.2 Bit String:
     *	BitString    = SQUOTE *binary-digit SQUOTE "B"
     *	binary-digit = "0" / "1"
	 *
	 * where SQUOTE [RFC4512] is
	 *	SQUOTE  = %x27 ; single quote ("'")
	 *
	 * Example: '0101111101'B
Kurt Zeilenga's avatar
Kurt Zeilenga committed
760
761
762
	 */
	
	if( in->bv_val[0] != '\'' ||
763
764
		in->bv_val[in->bv_len - 2] != '\'' ||
		in->bv_val[in->bv_len - 1] != 'B' )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
765
766
767
768
	{
		return LDAP_INVALID_SYNTAX;
	}

769
	for( i = in->bv_len - 3; i > 0; i-- ) {
Kurt Zeilenga's avatar
Kurt Zeilenga committed
770
771
772
773
774
775
776
777
		if( in->bv_val[i] != '0' && in->bv_val[i] != '1' ) {
			return LDAP_INVALID_SYNTAX;
		}
	}

	return LDAP_SUCCESS;
}

778
/*
Kurt Zeilenga's avatar
Kurt Zeilenga committed
779
 * Syntaxes from RFC 4517
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
 *

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].

 *
Kurt Zeilenga's avatar
Kurt Zeilenga committed
837
 * RFC 4512 says:
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
 *

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
 * 
Kurt Zeilenga's avatar
Kurt Zeilenga committed
855
856
857
858
859
 * RFC 4514 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.
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 *
 * 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
886
887
888
889
890
891
static int
nameUIDValidate(
	Syntax *syntax,
	struct berval *in )
{
	int rc;
892
	struct berval dn, uid;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
893

894
	if( BER_BVISEMPTY( in ) ) return LDAP_SUCCESS;
Kurt Zeilenga's avatar
Kurt Zeilenga committed
895
896
897
898

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

899
900
	/* if there's a "#", try bitStringValidate()... */
	uid.bv_val = strrchr( dn.bv_val, '#' );
901
	if ( !BER_BVISNULL( &uid ) ) {
902
903
904
905
906
907
908
909
910
		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
911
912
913
914
915
916
917
918
919
		}
	}

	rc = dnValidate( NULL, &dn );

	ber_memfree( dn.bv_val );
	return rc;
}

920
921
922
923
924
925
926
int
nameUIDPretty(
	Syntax *syntax,
	struct berval *val,
	struct berval *out,
	void *ctx )
{
927
928
	assert( val != NULL );
	assert( out != NULL );
929
930
931
932


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

933
	if( BER_BVISEMPTY( val ) ) {
934
935
936
937
938
939
		ber_dupbv_x( out, val, ctx );

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

	} else {
940
941
942
		int		rc;
		struct berval	dnval = *val;
		struct berval	uidval = BER_BVNULL;
943

944
		uidval.bv_val = strrchr( val->bv_val, '#' );
945
		if ( !BER_BVISNULL( &uidval ) ) {
946
947
			uidval.bv_val++;
			uidval.bv_len = val->bv_len - ( uidval.bv_val - val->bv_val );
948

949
			rc = bitStringValidate( NULL, &uidval );
950

951
952
953
954
			if ( rc == LDAP_SUCCESS ) {
				ber_dupbv_x( &dnval, val, ctx );
				dnval.bv_len -= uidval.bv_len + 1;
				dnval.bv_val[dnval.bv_len] = '\0';
955

956
			} else {
957
				BER_BVZERO( &uidval );
958
			}
959
960
961
		}

		rc = dnPretty( syntax, &dnval, out, ctx );
962
963
964
965
966
967
		if ( dnval.bv_val != val->bv_val ) {
			slap_sl_free( dnval.bv_val, ctx );
		}
		if( rc != LDAP_SUCCESS ) {
			return rc;
		}
968

969
		if( !BER_BVISNULL( &uidval ) ) {
970
971
972
			int	i, c, got1;
			char	*tmp;

973
974
			tmp = slap_sl_realloc( out->bv_val, out->bv_len 
				+ STRLENOF( "#" ) + uidval.bv_len + 1,
Kurt Zeilenga's avatar
cleanup    
Kurt Zeilenga committed
975
				ctx );
976
977
978
979
			if( tmp == NULL ) {
				ber_memfree_x( out->bv_val, ctx );
				return LDAP_OTHER;
			}
980
			out->bv_val = tmp;
981
			out->bv_val[out->bv_len++] = '#';
982
			out->bv_val[out->bv_len++] = '\'';
983
984

			got1 = uidval.bv_len < sizeof("'0'B"); 
985
			for( i = 1; i < uidval.bv_len - 2; i++ ) {
986
987
988
989
990
991
992
993
				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;
994
						break;
995
996
997
				}
			}

998
999
			out->bv_val[out->bv_len++] = '\'';
			out->bv_val[out->bv_len++] = 'B';
1000
			out->bv_val[out->bv_len] = '\0';