xref: /netbsd-src/external/bsd/openldap/dist/servers/slapd/syntax.c (revision 549b59ed3ccf0d36d3097190a0db27b770f3a839)
1 /*	$NetBSD: syntax.c,v 1.3 2021/08/14 16:14:58 christos Exp $	*/
2 
3 /* syntax.c - routines to manage syntax definitions */
4 /* $OpenLDAP$ */
5 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
6  *
7  * Copyright 1998-2021 The OpenLDAP Foundation.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted only as authorized by the OpenLDAP
12  * Public License.
13  *
14  * A copy of this license is available in the file LICENSE in the
15  * top-level directory of the distribution or, alternatively, at
16  * <http://www.OpenLDAP.org/license.html>.
17  */
18 
19 #include <sys/cdefs.h>
20 __RCSID("$NetBSD: syntax.c,v 1.3 2021/08/14 16:14:58 christos Exp $");
21 
22 #include "portable.h"
23 
24 #include <stdio.h>
25 
26 #include <ac/ctype.h>
27 #include <ac/string.h>
28 #include <ac/socket.h>
29 
30 #include "slap.h"
31 
32 struct sindexrec {
33 	char		*sir_name;
34 	Syntax		*sir_syn;
35 };
36 
37 static Avlnode	*syn_index = NULL;
38 static LDAP_STAILQ_HEAD(SyntaxList, Syntax) syn_list
39 	= LDAP_STAILQ_HEAD_INITIALIZER(syn_list);
40 
41 /* Last hardcoded attribute registered */
42 Syntax *syn_sys_tail;
43 
44 static int
syn_index_cmp(const void * v_sir1,const void * v_sir2)45 syn_index_cmp(
46 	const void *v_sir1,
47 	const void *v_sir2
48 )
49 {
50 	const struct sindexrec *sir1 = v_sir1, *sir2 = v_sir2;
51 	return (strcmp( sir1->sir_name, sir2->sir_name ));
52 }
53 
54 static int
syn_index_name_cmp(const void * name,const void * sir)55 syn_index_name_cmp(
56 	const void *name,
57 	const void *sir
58 )
59 {
60 	return (strcmp( name, ((const struct sindexrec *)sir)->sir_name ));
61 }
62 
63 Syntax *
syn_find(const char * synname)64 syn_find( const char *synname )
65 {
66 	struct sindexrec	*sir = NULL;
67 
68 	if ( (sir = ldap_avl_find( syn_index, synname, syn_index_name_cmp )) != NULL ) {
69 		return( sir->sir_syn );
70 	}
71 	return( NULL );
72 }
73 
74 Syntax *
syn_find_desc(const char * syndesc,int * len)75 syn_find_desc( const char *syndesc, int *len )
76 {
77 	Syntax		*synp;
78 
79 	LDAP_STAILQ_FOREACH(synp, &syn_list, ssyn_next) {
80 		if ((*len = dscompare( synp->ssyn_syn.syn_desc, syndesc, '{' /*'}'*/ ))) {
81 			return synp;
82 		}
83 	}
84 	return( NULL );
85 }
86 
87 int
syn_is_sup(Syntax * syn,Syntax * sup)88 syn_is_sup( Syntax *syn, Syntax *sup )
89 {
90 	int	i;
91 
92 	assert( syn != NULL );
93 	assert( sup != NULL );
94 
95 	if ( syn == sup ) {
96 		return 1;
97 	}
98 
99 	if ( syn->ssyn_sups == NULL ) {
100 		return 0;
101 	}
102 
103 	for ( i = 0; syn->ssyn_sups[i]; i++ ) {
104 		if ( syn->ssyn_sups[i] == sup ) {
105 			return 1;
106 		}
107 
108 		if ( syn_is_sup( syn->ssyn_sups[i], sup ) ) {
109 			return 1;
110 		}
111 	}
112 
113 	return 0;
114 }
115 
116 void
syn_destroy(void)117 syn_destroy( void )
118 {
119 	Syntax	*s;
120 
121 	ldap_avl_free( syn_index, ldap_memfree );
122 	while( !LDAP_STAILQ_EMPTY( &syn_list ) ) {
123 		s = LDAP_STAILQ_FIRST( &syn_list );
124 		LDAP_STAILQ_REMOVE_HEAD( &syn_list, ssyn_next );
125 		if ( s->ssyn_sups ) {
126 			SLAP_FREE( s->ssyn_sups );
127 		}
128 		ldap_syntax_free( (LDAPSyntax *)s );
129 	}
130 }
131 
132 static int
syn_insert(Syntax * ssyn,Syntax * prev,const char ** err)133 syn_insert(
134 	Syntax		*ssyn,
135 	Syntax		*prev,
136 	const char	**err )
137 {
138 	struct sindexrec	*sir;
139 
140 	LDAP_STAILQ_NEXT( ssyn, ssyn_next ) = NULL;
141 
142 	if ( ssyn->ssyn_oid ) {
143 		sir = (struct sindexrec *)
144 			SLAP_CALLOC( 1, sizeof(struct sindexrec) );
145 		if( sir == NULL ) {
146 			Debug( LDAP_DEBUG_ANY, "SLAP_CALLOC Error\n" );
147 			return LDAP_OTHER;
148 		}
149 		sir->sir_name = ssyn->ssyn_oid;
150 		sir->sir_syn = ssyn;
151 		if ( ldap_avl_insert( &syn_index, (caddr_t) sir,
152 		                 syn_index_cmp, ldap_avl_dup_error ) ) {
153 			*err = ssyn->ssyn_oid;
154 			ldap_memfree(sir);
155 			return SLAP_SCHERR_SYN_DUP;
156 		}
157 		/* FIX: temporal consistency check */
158 		syn_find(sir->sir_name);
159 	}
160 
161 	if ( ssyn->ssyn_flags & SLAP_AT_HARDCODE ) {
162 		prev = syn_sys_tail;
163 		syn_sys_tail = ssyn;
164 	}
165 
166 	if ( prev ) {
167 		LDAP_STAILQ_INSERT_AFTER( &syn_list, prev, ssyn, ssyn_next );
168 	} else {
169 		LDAP_STAILQ_INSERT_TAIL( &syn_list, ssyn, ssyn_next );
170 	}
171 	return 0;
172 }
173 
174 int
syn_add(LDAPSyntax * syn,int user,slap_syntax_defs_rec * def,Syntax ** ssynp,Syntax * prev,const char ** err)175 syn_add(
176 	LDAPSyntax		*syn,
177 	int			user,
178 	slap_syntax_defs_rec	*def,
179 	Syntax			**ssynp,
180 	Syntax			*prev,
181 	const char		**err )
182 {
183 	Syntax		*ssyn;
184 	int		code = 0;
185 
186 	if ( ssynp != NULL ) {
187 		*ssynp = NULL;
188 	}
189 
190 	ssyn = (Syntax *) SLAP_CALLOC( 1, sizeof(Syntax) );
191 	if ( ssyn == NULL ) {
192 		Debug( LDAP_DEBUG_ANY, "SLAP_CALLOC Error\n" );
193 		return SLAP_SCHERR_OUTOFMEM;
194 	}
195 
196 	AC_MEMCPY( &ssyn->ssyn_syn, syn, sizeof(LDAPSyntax) );
197 
198 	LDAP_STAILQ_NEXT(ssyn,ssyn_next) = NULL;
199 
200 	/*
201 	 * note: ssyn_bvoid uses the same memory of ssyn_syn.syn_oid;
202 	 * ssyn_oidlen is #defined as ssyn_bvoid.bv_len
203 	 */
204 	ssyn->ssyn_bvoid.bv_val = ssyn->ssyn_syn.syn_oid;
205 	ssyn->ssyn_oidlen = strlen(syn->syn_oid);
206 	ssyn->ssyn_flags = def->sd_flags;
207 	ssyn->ssyn_validate = def->sd_validate;
208 	ssyn->ssyn_pretty = def->sd_pretty;
209 
210 	ssyn->ssyn_sups = NULL;
211 
212 #ifdef SLAPD_BINARY_CONVERSION
213 	ssyn->ssyn_ber2str = def->sd_ber2str;
214 	ssyn->ssyn_str2ber = def->sd_str2ber;
215 #endif
216 
217 	if ( def->sd_validate == NULL && def->sd_pretty == NULL && syn->syn_extensions != NULL ) {
218 		LDAPSchemaExtensionItem **lsei;
219 		Syntax *subst = NULL;
220 
221 		for ( lsei = syn->syn_extensions; *lsei != NULL; lsei++) {
222 			if ( strcmp( (*lsei)->lsei_name, "X-SUBST" ) != 0 ) {
223 				continue;
224 			}
225 
226 			assert( (*lsei)->lsei_values != NULL );
227 			if ( (*lsei)->lsei_values[0] == NULL
228 				|| (*lsei)->lsei_values[1] != NULL )
229 			{
230 				Debug( LDAP_DEBUG_ANY, "syn_add(%s): exactly one substitute syntax must be present\n",
231 					ssyn->ssyn_syn.syn_oid );
232 				SLAP_FREE( ssyn );
233 				return SLAP_SCHERR_SYN_SUBST_NOT_SPECIFIED;
234 			}
235 
236 			subst = syn_find( (*lsei)->lsei_values[0] );
237 			if ( subst == NULL ) {
238 				Debug( LDAP_DEBUG_ANY, "syn_add(%s): substitute syntax %s not found\n",
239 					ssyn->ssyn_syn.syn_oid, (*lsei)->lsei_values[0] );
240 				SLAP_FREE( ssyn );
241 				return SLAP_SCHERR_SYN_SUBST_NOT_FOUND;
242 			}
243 			break;
244 		}
245 
246 		if ( subst != NULL ) {
247 			ssyn->ssyn_flags = subst->ssyn_flags;
248 			ssyn->ssyn_validate = subst->ssyn_validate;
249 			ssyn->ssyn_pretty = subst->ssyn_pretty;
250 
251 			ssyn->ssyn_sups = NULL;
252 
253 #ifdef SLAPD_BINARY_CONVERSION
254 			ssyn->ssyn_ber2str = subst->ssyn_ber2str;
255 			ssyn->ssyn_str2ber = subst->ssyn_str2ber;
256 #endif
257 		}
258 	}
259 
260 	if ( def->sd_sups != NULL ) {
261 		int	cnt;
262 
263 		for ( cnt = 0; def->sd_sups[cnt] != NULL; cnt++ )
264 			;
265 
266 		ssyn->ssyn_sups = (Syntax **)SLAP_CALLOC( cnt + 1,
267 			sizeof( Syntax * ) );
268 		if ( ssyn->ssyn_sups == NULL ) {
269 			Debug( LDAP_DEBUG_ANY, "SLAP_CALLOC Error\n" );
270 			code = SLAP_SCHERR_OUTOFMEM;
271 
272 		} else {
273 			for ( cnt = 0; def->sd_sups[cnt] != NULL; cnt++ ) {
274 				ssyn->ssyn_sups[cnt] = syn_find( def->sd_sups[cnt] );
275 				if ( ssyn->ssyn_sups[cnt] == NULL ) {
276 					*err = def->sd_sups[cnt];
277 					code = SLAP_SCHERR_SYN_SUP_NOT_FOUND;
278 				}
279 			}
280 		}
281 	}
282 
283 	if ( !user )
284 		ssyn->ssyn_flags |= SLAP_SYNTAX_HARDCODE;
285 
286 	if ( code == 0 ) {
287 		code = syn_insert( ssyn, prev, err );
288 	}
289 
290 	if ( code != 0 && ssyn != NULL ) {
291 		if ( ssyn->ssyn_sups != NULL ) {
292 			SLAP_FREE( ssyn->ssyn_sups );
293 		}
294 		SLAP_FREE( ssyn );
295 		ssyn = NULL;
296 	}
297 
298 	if (ssynp ) {
299 		*ssynp = ssyn;
300 	}
301 
302 	return code;
303 }
304 
305 int
register_syntax(slap_syntax_defs_rec * def)306 register_syntax(
307 	slap_syntax_defs_rec *def )
308 {
309 	LDAPSyntax	*syn;
310 	int		code;
311 	const char	*err;
312 
313 	syn = ldap_str2syntax( def->sd_desc, &code, &err, LDAP_SCHEMA_ALLOW_ALL);
314 	if ( !syn ) {
315 		Debug( LDAP_DEBUG_ANY, "Error in register_syntax: %s before %s in %s\n",
316 		    ldap_scherr2str(code), err, def->sd_desc );
317 
318 		return( -1 );
319 	}
320 
321 	code = syn_add( syn, 0, def, NULL, NULL, &err );
322 
323 	if ( code ) {
324 		Debug( LDAP_DEBUG_ANY, "Error in register_syntax: %s %s in %s\n",
325 		    scherr2str(code), err, def->sd_desc );
326 		ldap_syntax_free( syn );
327 
328 		return( -1 );
329 	}
330 
331 	ldap_memfree( syn );
332 
333 	return( 0 );
334 }
335 
336 int
syn_schema_info(Entry * e)337 syn_schema_info( Entry *e )
338 {
339 	AttributeDescription *ad_ldapSyntaxes = slap_schema.si_ad_ldapSyntaxes;
340 	Syntax		*syn;
341 	struct berval	val;
342 	struct berval	nval;
343 
344 	LDAP_STAILQ_FOREACH(syn, &syn_list, ssyn_next ) {
345 		if ( ! syn->ssyn_validate ) {
346 			/* skip syntaxes without validators */
347 			continue;
348 		}
349 		if ( syn->ssyn_flags & SLAP_SYNTAX_HIDE ) {
350 			/* hide syntaxes */
351 			continue;
352 		}
353 
354 		if ( ldap_syntax2bv( &syn->ssyn_syn, &val ) == NULL ) {
355 			return -1;
356 		}
357 #if 0
358 		Debug( LDAP_DEBUG_TRACE, "Merging syn [%ld] %s\n",
359 	       (long) val.bv_len, val.bv_val );
360 #endif
361 
362 		nval.bv_val = syn->ssyn_oid;
363 		nval.bv_len = strlen(syn->ssyn_oid);
364 
365 		if( attr_merge_one( e, ad_ldapSyntaxes, &val, &nval ) )
366 		{
367 			return -1;
368 		}
369 		ldap_memfree( val.bv_val );
370 	}
371 	return 0;
372 }
373 
374 void
syn_delete(Syntax * syn)375 syn_delete( Syntax *syn )
376 {
377 	LDAP_STAILQ_REMOVE(&syn_list, syn, Syntax, ssyn_next);
378 }
379 
380 int
syn_start(Syntax ** syn)381 syn_start( Syntax **syn )
382 {
383 	assert( syn != NULL );
384 
385 	*syn = LDAP_STAILQ_FIRST(&syn_list);
386 
387 	return (*syn != NULL);
388 }
389 
390 int
syn_next(Syntax ** syn)391 syn_next( Syntax **syn )
392 {
393 	assert( syn != NULL );
394 
395 #if 0	/* pedantic check: don't use this */
396 	{
397 		Syntax *tmp = NULL;
398 
399 		LDAP_STAILQ_FOREACH(tmp,&syn_list,ssyn_next) {
400 			if ( tmp == *syn ) {
401 				break;
402 			}
403 		}
404 
405 		assert( tmp != NULL );
406 	}
407 #endif
408 
409 	*syn = LDAP_STAILQ_NEXT(*syn,ssyn_next);
410 
411 	return (*syn != NULL);
412 }
413 
414 void
syn_unparse(BerVarray * res,Syntax * start,Syntax * end,int sys)415 syn_unparse( BerVarray *res, Syntax *start, Syntax *end, int sys )
416 {
417 	Syntax *syn;
418 	int i, num;
419 	struct berval bv, *bva = NULL, idx;
420 	char ibuf[32];
421 
422 	if ( !start )
423 		start = LDAP_STAILQ_FIRST( &syn_list );
424 
425 	/* count the result size */
426 	i = 0;
427 	for ( syn = start; syn; syn = LDAP_STAILQ_NEXT( syn, ssyn_next ) ) {
428 		if ( sys && !( syn->ssyn_flags & SLAP_SYNTAX_HARDCODE ) ) break;
429 		i++;
430 		if ( syn == end ) break;
431 	}
432 	if ( !i ) return;
433 
434 	num = i;
435 	bva = ch_malloc( (num+1) * sizeof(struct berval) );
436 	BER_BVZERO( bva );
437 	idx.bv_val = ibuf;
438 	if ( sys ) {
439 		idx.bv_len = 0;
440 		ibuf[0] = '\0';
441 	}
442 	i = 0;
443 	for ( syn = start; syn; syn = LDAP_STAILQ_NEXT( syn, ssyn_next ) ) {
444 		if ( sys && !( syn->ssyn_flags & SLAP_SYNTAX_HARDCODE ) ) break;
445 		if ( ldap_syntax2bv( &syn->ssyn_syn, &bv ) == NULL ) {
446 			ber_bvarray_free( bva );
447 		}
448 		if ( !sys ) {
449 			idx.bv_len = sprintf(idx.bv_val, "{%d}", i);
450 		}
451 		bva[i].bv_len = idx.bv_len + bv.bv_len;
452 		bva[i].bv_val = ch_malloc( bva[i].bv_len + 1 );
453 		strcpy( bva[i].bv_val, ibuf );
454 		strcpy( bva[i].bv_val + idx.bv_len, bv.bv_val );
455 		i++;
456 		bva[i].bv_val = NULL;
457 		ldap_memfree( bv.bv_val );
458 		if ( syn == end ) break;
459 	}
460 	*res = bva;
461 }
462 
463