?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Sync usage with man page.
[netbsd-mini2440.git] / external / bsd / openldap / dist / servers / slapd / slap.h
blobd44d0336206b0f3d1b6ca25d8060638f162a419d
1 /* slap.h - stand alone ldap server include file */
2 /* $OpenLDAP: pkg/ldap/servers/slapd/slap.h,v 1.764.2.29 2008/07/08 19:25:39 quanah Exp $ */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 *
5 * Copyright 1998-2008 The OpenLDAP Foundation.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
10 * Public License.
11 *
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
15 */
16 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
17 * All rights reserved.
18 *
19 * Redistribution and use in source and binary forms are permitted
20 * provided that this notice is preserved and that due credit is given
21 * to the University of Michigan at Ann Arbor. The name of the University
22 * may not be used to endorse or promote products derived from this
23 * software without specific prior written permission. This software
24 * is provided ``as is'' without express or implied warranty.
25 */
26
27 #ifndef _SLAP_H_
28 #define _SLAP_H_
29
30 #include "ldap_defaults.h"
31
32 #include <stdio.h>
33 #include <ac/stdlib.h>
34
35 #include <sys/types.h>
36 #include <ac/syslog.h>
37 #include <ac/regex.h>
38 #include <ac/signal.h>
39 #include <ac/socket.h>
40 #include <ac/time.h>
41 #include <ac/param.h>
42
43 #include "avl.h"
44
45 #ifndef ldap_debug
46 #define ldap_debug slap_debug
47 #endif
48
49 #include "ldap_log.h"
50
51 #include <ldap.h>
52 #include <ldap_schema.h>
53
54 #include "lber_pvt.h"
55 #include "ldap_pvt.h"
56 #include "ldap_pvt_thread.h"
57 #include "ldap_queue.h"
58
59 LDAP_BEGIN_DECL
60
61 #ifdef LDAP_DEVEL
62 #define LDAP_COLLECTIVE_ATTRIBUTES
63 #define LDAP_COMP_MATCH
64 #define LDAP_SYNC_TIMESTAMP
65 #define SLAP_CONTROL_X_SORTEDRESULTS
66 #define SLAP_CONTROL_X_SESSION_TRACKING
67 #define SLAP_CONFIG_DELETE
68 #endif
69
70 #define LDAP_DYNAMIC_OBJECTS
71 #define SLAP_CONTROL_X_TREE_DELETE LDAP_CONTROL_X_TREE_DELETE
72 #define SLAP_DISTPROC
73
74 #ifdef ENABLE_REWRITE
75 #define SLAP_AUTH_REWRITE 1 /* use librewrite for sasl-regexp */
76 #endif
77
78 /*
79 * SLAPD Memory allocation macros
80 *
81 * Unlike ch_*() routines, these routines do not assert() upon
82 * allocation error. They are intended to be used instead of
83 * ch_*() routines where the caller has implemented proper
84 * checking for and handling of allocation errors.
85 *
86 * Patches to convert ch_*() calls to SLAP_*() calls welcomed.
87 */
88 #define SLAP_MALLOC(s) ber_memalloc((s))
89 #define SLAP_CALLOC(n,s) ber_memcalloc((n),(s))
90 #define SLAP_REALLOC(p,s) ber_memrealloc((p),(s))
91 #define SLAP_FREE(p) ber_memfree((p))
92 #define SLAP_VFREE(v) ber_memvfree((void**)(v))
93 #define SLAP_STRDUP(s) ber_strdup((s))
94 #define SLAP_STRNDUP(s,l) ber_strndup((s),(l))
95
96 #ifdef f_next
97 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
98 #endif
99
100 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
101 #define SLAPD_ANONYMOUS ""
102
103 #ifdef HAVE_TCPD
104 # include <tcpd.h>
105 # define SLAP_STRING_UNKNOWN STRING_UNKNOWN
106 #else /* ! TCP Wrappers */
107 # define SLAP_STRING_UNKNOWN "unknown"
108 #endif /* ! TCP Wrappers */
109
110 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
111 * This is a value used internally by the backends. It is needed to allow
112 * adding values that already exist without getting an error as required by
113 * modrdn when the new rdn was already an attribute value itself.
114 */
115 #define SLAP_MOD_SOFTADD 0x1000
116
117 #define MAXREMATCHES (100)
118
119 #define SLAP_MAX_WORKER_THREADS (16)
120
121 #define SLAP_SB_MAX_INCOMING_DEFAULT ((1<<18) - 1)
122 #define SLAP_SB_MAX_INCOMING_AUTH ((1<<24) - 1)
123
124 #define SLAP_CONN_MAX_PENDING_DEFAULT 100
125 #define SLAP_CONN_MAX_PENDING_AUTH 1000
126
127 #define SLAP_TEXT_BUFLEN (256)
128
129 /* psuedo error code indicating abandoned operation */
130 #define SLAPD_ABANDON (-1024)
131
132 /* psuedo error code indicating disconnect */
133 #define SLAPD_DISCONNECT (-1025)
134
135 /* unknown config file directive */
136 #define SLAP_CONF_UNKNOWN (-1026)
137
138 /* We assume "C" locale, that is US-ASCII */
139 #define ASCII_SPACE(c) ( (c) == ' ' )
140 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
141 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
142 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
143 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
144 #define ASCII_HEXLOWER(c) ( (c) >= 'a' && (c) <= 'f' )
145 #define ASCII_HEXUPPER(c) ( (c) >= 'A' && (c) <= 'F' )
146 #define ASCII_HEX(c) ( ASCII_DIGIT(c) || \
147 ASCII_HEXLOWER(c) || ASCII_HEXUPPER(c) )
148 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
149 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
150
151 #define SLAP_NIBBLE(c) ((c)&0x0f)
152 #define SLAP_ESCAPE_CHAR ('\\')
153 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
154 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
155
156 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
157 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
158
159 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
160 /* NOTE: for consistency, this macro must only operate
161 * on normalized/pretty DN, such that ';' is never used
162 * as RDN separator, and all occurrences of ';' must be escaped */
163 #define DN_SEPARATOR(c) ((c) == ',')
164 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 4514 */
165 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
166 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
167
168 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
169 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
170 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
171 #define OID_SEPARATOR(c) ( (c) == '.' )
172 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
173
174 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
175 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || OID_SEPARATOR(c) )
176
177 #define AD_LEADCHAR(c) ( ATTR_LEADCHAR(c) )
178 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
179
180 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
181
182 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
183 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
184 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
185 (c) == '?' || (c) == ' ' || (c) == '=' )
186 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
187
188 /* must match in schema_init.c */
189 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
190 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
191 #define SLAPD_INTEGER_SYNTAX "1.3.6.1.4.1.1466.115.121.1.27"
192 #define SLAPD_GROUP_ATTR "member"
193 #define SLAPD_GROUP_CLASS "groupOfNames"
194 #define SLAPD_ROLE_ATTR "roleOccupant"
195 #define SLAPD_ROLE_CLASS "organizationalRole"
196
197 #define SLAPD_TOP_OID "2.5.6.0"
198
199 LDAP_SLAPD_V (int) slap_debug;
200
201 typedef unsigned long slap_mask_t;
202
203 /* Security Strength Factor */
204 typedef unsigned slap_ssf_t;
205
206 typedef struct slap_ssf_set {
207 slap_ssf_t sss_ssf;
208 slap_ssf_t sss_transport;
209 slap_ssf_t sss_tls;
210 slap_ssf_t sss_sasl;
211 slap_ssf_t sss_update_ssf;
212 slap_ssf_t sss_update_transport;
213 slap_ssf_t sss_update_tls;
214 slap_ssf_t sss_update_sasl;
215 slap_ssf_t sss_simple_bind;
216 } slap_ssf_set_t;
217
218 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
219 #define SLAP_GETDN_AUTHCID 2
220 #define SLAP_GETDN_AUTHZID 4
221
222 /*
223 * Index types
224 */
225 #define SLAP_INDEX_TYPE 0x00FFUL
226 #define SLAP_INDEX_UNDEFINED 0x0001UL
227 #define SLAP_INDEX_PRESENT 0x0002UL
228 #define SLAP_INDEX_EQUALITY 0x0004UL
229 #define SLAP_INDEX_APPROX 0x0008UL
230 #define SLAP_INDEX_SUBSTR 0x0010UL
231 #define SLAP_INDEX_EXTENDED 0x0020UL
232
233 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
234
235 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type))
236
237 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
238
239 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
240 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
241 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
242 #define SLAP_INDEX_SUBSTR_DEFAULT \
243 ( SLAP_INDEX_SUBSTR \
244 | SLAP_INDEX_SUBSTR_INITIAL \
245 | SLAP_INDEX_SUBSTR_ANY \
246 | SLAP_INDEX_SUBSTR_FINAL )
247
248 /* defaults for initial/final substring indices */
249 #define SLAP_INDEX_SUBSTR_IF_MINLEN_DEFAULT 2
250 #define SLAP_INDEX_SUBSTR_IF_MAXLEN_DEFAULT 4
251
252 /* defaults for any substring indices */
253 #define SLAP_INDEX_SUBSTR_ANY_LEN_DEFAULT 4
254 #define SLAP_INDEX_SUBSTR_ANY_STEP_DEFAULT 2
255
256 /* default for ordered integer index keys */
257 #define SLAP_INDEX_INTLEN_DEFAULT 4
258
259 #define SLAP_INDEX_FLAGS 0xF000UL
260 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
261 #define SLAP_INDEX_NOTAGS 0x2000UL /* don't use index w/ tags */
262
263 /*
264 * there is a single index for each attribute. these prefixes ensure
265 * that there is no collision among keys.
266 */
267 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
268 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
269 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
270 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
271 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
272 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
273
274 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
275 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
276 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
277 #define SLAP_SYNTAX_MATCHINGRULEUSES_OID "1.3.6.1.4.1.1466.115.121.1.31"
278 #define SLAP_SYNTAX_CONTENTRULE_OID "1.3.6.1.4.1.1466.115.121.1.16"
279
280 /*
281 * represents schema information for a database
282 */
283 enum {
284 SLAP_SCHERR_OUTOFMEM = 1,
285 SLAP_SCHERR_CLASS_NOT_FOUND,
286 SLAP_SCHERR_CLASS_BAD_USAGE,
287 SLAP_SCHERR_CLASS_BAD_SUP,
288 SLAP_SCHERR_CLASS_DUP,
289 SLAP_SCHERR_CLASS_INCONSISTENT,
290 SLAP_SCHERR_ATTR_NOT_FOUND,
291 SLAP_SCHERR_ATTR_BAD_MR,
292 SLAP_SCHERR_ATTR_BAD_USAGE,
293 SLAP_SCHERR_ATTR_BAD_SUP,
294 SLAP_SCHERR_ATTR_INCOMPLETE,
295 SLAP_SCHERR_ATTR_DUP,
296 SLAP_SCHERR_ATTR_INCONSISTENT,
297 SLAP_SCHERR_MR_NOT_FOUND,
298 SLAP_SCHERR_MR_INCOMPLETE,
299 SLAP_SCHERR_MR_DUP,
300 SLAP_SCHERR_SYN_NOT_FOUND,
301 SLAP_SCHERR_SYN_DUP,
302 SLAP_SCHERR_SYN_SUP_NOT_FOUND,
303 SLAP_SCHERR_NO_NAME,
304 SLAP_SCHERR_NOT_SUPPORTED,
305 SLAP_SCHERR_BAD_DESCR,
306 SLAP_SCHERR_OIDM,
307 SLAP_SCHERR_CR_DUP,
308 SLAP_SCHERR_CR_BAD_STRUCT,
309 SLAP_SCHERR_CR_BAD_AUX,
310 SLAP_SCHERR_CR_BAD_AT,
311
312 SLAP_SCHERR_LAST
313 };
314
315 /* forward declarations */
316 typedef struct Syntax Syntax;
317 typedef struct MatchingRule MatchingRule;
318 typedef struct MatchingRuleUse MatchingRuleUse;
319 typedef struct MatchingRuleAssertion MatchingRuleAssertion;
320 typedef struct OidMacro OidMacro;
321 typedef struct ObjectClass ObjectClass;
322 typedef struct AttributeType AttributeType;
323 typedef struct AttributeDescription AttributeDescription;
324 typedef struct AttributeName AttributeName;
325 typedef struct ContentRule ContentRule;
326
327 typedef struct AttributeAssertion AttributeAssertion;
328 typedef struct SubstringsAssertion SubstringsAssertion;
329 typedef struct Filter Filter;
330 typedef struct ValuesReturnFilter ValuesReturnFilter;
331 typedef struct Attribute Attribute;
332 #ifdef LDAP_COMP_MATCH
333 typedef struct ComponentData ComponentData;
334 typedef struct ComponentFilter ComponentFilter;
335 #endif
336
337 typedef struct Entry Entry;
338 typedef struct Modification Modification;
339 typedef struct Modifications Modifications;
340 typedef struct LDAPModList LDAPModList;
341
342 typedef struct BackendInfo BackendInfo; /* per backend type */
343 typedef struct BackendDB BackendDB; /* per backend database */
344
345 typedef struct Connection Connection;
346 typedef struct Operation Operation;
347 typedef struct SlapReply SlapReply;
348 /* end of forward declarations */
349
350 typedef union Sockaddr {
351 struct sockaddr sa_addr;
352 struct sockaddr_in sa_in_addr;
353 #ifdef LDAP_PF_INET6
354 struct sockaddr_storage sa_storage;
355 struct sockaddr_in6 sa_in6_addr;
356 #endif
357 #ifdef LDAP_PF_LOCAL
358 struct sockaddr_un sa_un_addr;
359 #endif
360 } Sockaddr;
361
362 #ifdef LDAP_PF_INET6
363 extern int slap_inet4or6;
364 #endif
365
366 struct OidMacro {
367 struct berval som_oid;
368 BerVarray som_names;
369 BerVarray som_subs;
370 #define SLAP_OM_HARDCODE 0x10000U /* This is hardcoded schema */
371 int som_flags;
372 LDAP_STAILQ_ENTRY(OidMacro) som_next;
373 };
374
375 typedef int slap_syntax_validate_func LDAP_P((
376 Syntax *syntax,
377 struct berval * in));
378
379 typedef int slap_syntax_transform_func LDAP_P((
380 Syntax *syntax,
381 struct berval * in,
382 struct berval * out,
383 void *memctx));
384
385 #ifdef LDAP_COMP_MATCH
386 typedef void* slap_component_transform_func LDAP_P((
387 struct berval * in ));
388 struct ComponentDesc;
389 #endif
390
391 struct Syntax {
392 LDAPSyntax ssyn_syn;
393 #define ssyn_oid ssyn_syn.syn_oid
394 #define ssyn_desc ssyn_syn.syn_desc
395 #define ssyn_extensions ssyn_syn.syn_extensions
396 /*
397 * Note: the former
398 ber_len_t ssyn_oidlen;
399 * has been replaced by a struct berval that uses the value
400 * provided by ssyn_syn.syn_oid; a macro that expands to
401 * the bv_len field of the berval is provided for backward
402 * compatibility. CAUTION: NEVER FREE THE BERVAL
403 */
404 struct berval ssyn_bvoid;
405 #define ssyn_oidlen ssyn_bvoid.bv_len
406
407 unsigned int ssyn_flags;
408
409 #define SLAP_SYNTAX_NONE 0x0000U
410 #define SLAP_SYNTAX_BLOB 0x0001U /* syntax treated as blob (audio) */
411 #define SLAP_SYNTAX_BINARY 0x0002U /* binary transfer required (certificate) */
412 #define SLAP_SYNTAX_BER 0x0004U /* stored in BER encoding (certificate) */
413 #ifdef LDAP_DEVEL
414 #define SLAP_SYNTAX_HIDE 0x0000U /* publish everything */
415 #else
416 #define SLAP_SYNTAX_HIDE 0x8000U /* hide (do not publish) */
417 #endif
418
419 Syntax **ssyn_sups;
420
421 slap_syntax_validate_func *ssyn_validate;
422 slap_syntax_transform_func *ssyn_pretty;
423
424 #ifdef SLAPD_BINARY_CONVERSION
425 /* convert to and from binary */
426 slap_syntax_transform_func *ssyn_ber2str;
427 slap_syntax_transform_func *ssyn_str2ber;
428 #endif
429 #ifdef LDAP_COMP_MATCH
430 slap_component_transform_func *ssyn_attr2comp;
431 struct ComponentDesc* ssync_comp_syntax;
432 #endif
433
434 LDAP_SLIST_ENTRY(Syntax) ssyn_next;
435 };
436
437 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
438 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
439 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
440 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
441 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
442
443 typedef struct slap_syntax_defs_rec {
444 char *sd_desc;
445 int sd_flags;
446 char **sd_sups;
447 slap_syntax_validate_func *sd_validate;
448 slap_syntax_transform_func *sd_pretty;
449 #ifdef SLAPD_BINARY_CONVERSION
450 slap_syntax_transform_func *sd_ber2str;
451 slap_syntax_transform_func *sd_str2ber;
452 #endif
453 } slap_syntax_defs_rec;
454
455 /* X -> Y Converter */
456 typedef int slap_mr_convert_func LDAP_P((
457 struct berval * in,
458 struct berval * out,
459 void *memctx ));
460
461 /* Normalizer */
462 typedef int slap_mr_normalize_func LDAP_P((
463 slap_mask_t use,
464 Syntax *syntax, /* NULL if in is asserted value */
465 MatchingRule *mr,
466 struct berval *in,
467 struct berval *out,
468 void *memctx ));
469
470 /* Match (compare) function */
471 typedef int slap_mr_match_func LDAP_P((
472 int *match,
473 slap_mask_t use,
474 Syntax *syntax, /* syntax of stored value */
475 MatchingRule *mr,
476 struct berval *value,
477 void *assertValue ));
478
479 /* Index generation function */
480 typedef int slap_mr_indexer_func LDAP_P((
481 slap_mask_t use,
482 slap_mask_t mask,
483 Syntax *syntax, /* syntax of stored value */
484 MatchingRule *mr,
485 struct berval *prefix,
486 BerVarray values,
487 BerVarray *keys,
488 void *memctx ));
489
490 /* Filter index function */
491 typedef int slap_mr_filter_func LDAP_P((
492 slap_mask_t use,
493 slap_mask_t mask,
494 Syntax *syntax, /* syntax of stored value */
495 MatchingRule *mr,
496 struct berval *prefix,
497 void *assertValue,
498 BerVarray *keys,
499 void *memctx ));
500
501 struct MatchingRule {
502 LDAPMatchingRule smr_mrule;
503 MatchingRuleUse *smr_mru;
504 /* RFC 4512 string representation */
505 struct berval smr_str;
506 /*
507 * Note: the former
508 * ber_len_t smr_oidlen;
509 * has been replaced by a struct berval that uses the value
510 * provided by smr_mrule.mr_oid; a macro that expands to
511 * the bv_len field of the berval is provided for backward
512 * compatibility. CAUTION: NEVER FREE THE BERVAL
513 */
514 struct berval smr_bvoid;
515 #define smr_oidlen smr_bvoid.bv_len
516
517 slap_mask_t smr_usage;
518
519 #ifdef LDAP_DEVEL
520 #define SLAP_MR_HIDE 0x0000U
521 #else
522 #define SLAP_MR_HIDE 0x8000U
523 #endif
524
525 #define SLAP_MR_MUTATION_NORMALIZER 0x4000U
526
527 #define SLAP_MR_TYPE_MASK 0x0F00U
528 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
529 #define SLAP_MR_USAGE 0x000FU
530
531 #define SLAP_MR_NONE 0x0000U
532 #define SLAP_MR_EQUALITY 0x0100U
533 #define SLAP_MR_ORDERING 0x0200U
534 #define SLAP_MR_SUBSTR 0x0400U
535 #define SLAP_MR_EXT 0x0800U /* implicitly extensible */
536 #define SLAP_MR_ORDERED_INDEX 0x1000U
537 #ifdef LDAP_COMP_MATCH
538 #define SLAP_MR_COMPONENT 0x2000U
539 #endif
540
541 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
542
543 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
544 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
545 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
546
547
548 /*
549 * The asserted value, depending on the particular usage,
550 * is expected to conform to either the assertion syntax
551 * or the attribute syntax. In some cases, the syntax of
552 * the value is known. If so, these flags indicate which
553 * syntax the value is expected to conform to. If not,
554 * neither of these flags is set (until the syntax of the
555 * provided value is determined). If the value is of the
556 * attribute syntax, the flag is changed once a value of
557 * the assertion syntax is derived from the provided value.
558 */
559 #define SLAP_MR_VALUE_OF_ASSERTION_SYNTAX 0x0001U
560 #define SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX 0x0002U
561 #define SLAP_MR_VALUE_OF_SYNTAX (SLAP_MR_VALUE_OF_ASSERTION_SYNTAX|SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX)
562 #define SLAP_MR_DENORMALIZE (SLAP_MR_MUTATION_NORMALIZER)
563
564 #define SLAP_MR_IS_VALUE_OF_ATTRIBUTE_SYNTAX( usage ) \
565 ((usage) & SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX )
566 #define SLAP_MR_IS_VALUE_OF_ASSERTION_SYNTAX( usage ) \
567 ((usage) & SLAP_MR_VALUE_OF_ASSERTION_SYNTAX )
568 #ifdef LDAP_DEBUG
569 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) \
570 ((usage) & SLAP_MR_VALUE_OF_SYNTAX)
571 #else
572 #define SLAP_MR_IS_VALUE_OF_SYNTAX( usage ) (1)
573 #endif
574 #define SLAP_MR_IS_DENORMALIZE( usage ) \
575 ((usage) & SLAP_MR_DENORMALIZE )
576
577 /* either or both the asserted value or attribute value
578 * may be provided in normalized form
579 */
580 #define SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH 0x0004U
581 #define SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH 0x0008U
582
583 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
584 (!((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH))
585 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_MATCH( usage ) \
586 ((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
587
588 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH( usage ) \
589 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
590 == SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH)
591 #define SLAP_IS_MR_ATTRIBUTE_SYNTAX_NONCONVERTED_MATCH( usage ) \
592 (((usage) & SLAP_MR_ATTRIBUTE_SYNTAX_CONVERTED_MATCH) \
593 == SLAP_MR_ATTRIBUTE_SYNTAX_MATCH)
594
595 #define SLAP_IS_MR_ASSERTED_VALUE_NORMALIZED_MATCH( usage ) \
596 ((usage) & SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH )
597 #define SLAP_IS_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH( usage ) \
598 ((usage) & SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH )
599
600 Syntax *smr_syntax;
601 slap_mr_convert_func *smr_convert;
602 slap_mr_normalize_func *smr_normalize;
603 slap_mr_match_func *smr_match;
604 slap_mr_indexer_func *smr_indexer;
605 slap_mr_filter_func *smr_filter;
606
607 /*
608 * null terminated array of syntaxes compatible with this syntax
609 * note: when MS_EXT is set, this MUST NOT contain the assertion
610 * syntax of the rule. When MS_EXT is not set, it MAY.
611 */
612 Syntax **smr_compat_syntaxes;
613
614 /*
615 * For equality rules, refers to an associated approximate rule.
616 * For non-equality rules, refers to an associated equality rule.
617 */
618 MatchingRule *smr_associated;
619
620 #define SLAP_MR_ASSOCIATED(mr,amr) \
621 (((mr) == (amr)) || ((mr)->smr_associated == (amr)))
622
623 LDAP_SLIST_ENTRY(MatchingRule) smr_next;
624
625 #define smr_oid smr_mrule.mr_oid
626 #define smr_names smr_mrule.mr_names
627 #define smr_desc smr_mrule.mr_desc
628 #define smr_obsolete smr_mrule.mr_obsolete
629 #define smr_syntax_oid smr_mrule.mr_syntax_oid
630 #define smr_extensions smr_mrule.mr_extensions
631 };
632
633 struct MatchingRuleUse {
634 LDAPMatchingRuleUse smru_mruleuse;
635 MatchingRule *smru_mr;
636 /* RFC 4512 string representation */
637 struct berval smru_str;
638
639 LDAP_SLIST_ENTRY(MatchingRuleUse) smru_next;
640
641 #define smru_oid smru_mruleuse.mru_oid
642 #define smru_names smru_mruleuse.mru_names
643 #define smru_desc smru_mruleuse.mru_desc
644 #define smru_obsolete smru_mruleuse.mru_obsolete
645 #define smru_applies_oids smru_mruleuse.mru_applies_oids
646
647 #define smru_usage smru_mr->smr_usage
648 } /* MatchingRuleUse */ ;
649
650 typedef struct slap_mrule_defs_rec {
651 char * mrd_desc;
652 slap_mask_t mrd_usage;
653 char ** mrd_compat_syntaxes;
654 slap_mr_convert_func * mrd_convert;
655 slap_mr_normalize_func * mrd_normalize;
656 slap_mr_match_func * mrd_match;
657 slap_mr_indexer_func * mrd_indexer;
658 slap_mr_filter_func * mrd_filter;
659
660 /* For equality rule, this may refer to an associated approximate rule */
661 /* For non-equality rule, this may refer to an associated equality rule */
662 char * mrd_associated;
663 } slap_mrule_defs_rec;
664
665 typedef int (AttributeTypeSchemaCheckFN)(
666 BackendDB *be,
667 Entry *e,
668 Attribute *attr,
669 const char** text,
670 char *textbuf, size_t textlen );
671
672 struct AttributeType {
673 LDAPAttributeType sat_atype;
674 struct berval sat_cname;
675 AttributeType *sat_sup;
676 AttributeType **sat_subtypes;
677 MatchingRule *sat_equality;
678 MatchingRule *sat_approx;
679 MatchingRule *sat_ordering;
680 MatchingRule *sat_substr;
681 Syntax *sat_syntax;
682
683 AttributeTypeSchemaCheckFN *sat_check;
684 char *sat_oidmacro; /* attribute OID */
685 char *sat_soidmacro; /* syntax OID */
686
687 #define SLAP_AT_NONE 0x0000U
688 #define SLAP_AT_ABSTRACT 0x0100U /* cannot be instantiated */
689 #define SLAP_AT_FINAL 0x0200U /* cannot be subtyped */
690 #ifdef LDAP_DEVEL
691 #define SLAP_AT_HIDE 0x0000U /* publish everything */
692 #else
693 #define SLAP_AT_HIDE 0x8000U /* hide attribute */
694 #endif
695 #define SLAP_AT_DYNAMIC 0x0400U /* dynamically generated */
696
697 #define SLAP_AT_MANAGEABLE 0x0800U /* no-user-mod can be by-passed */
698
699 /* Note: ORDERED values have an ordering specifically set by the
700 * user, denoted by the {x} ordering prefix on the values.
701 *
702 * SORTED values are simply sorted by memcmp. SORTED values can
703 * be efficiently located by binary search. ORDERED values have no
704 * such advantage. An attribute cannot have both properties.
705 */
706 #define SLAP_AT_ORDERED_VAL 0x0001U /* values are ordered */
707 #define SLAP_AT_ORDERED_SIB 0x0002U /* siblings are ordered */
708 #define SLAP_AT_ORDERED 0x0003U /* value has order index */
709
710 #define SLAP_AT_SORTED_VAL 0x0010U /* values should be sorted */
711
712 #define SLAP_AT_HARDCODE 0x10000U /* hardcoded schema */
713 #define SLAP_AT_DELETED 0x20000U
714
715 slap_mask_t sat_flags;
716
717 LDAP_STAILQ_ENTRY(AttributeType) sat_next;
718
719 #define sat_oid sat_atype.at_oid
720 #define sat_names sat_atype.at_names
721 #define sat_desc sat_atype.at_desc
722 #define sat_obsolete sat_atype.at_obsolete
723 #define sat_sup_oid sat_atype.at_sup_oid
724 #define sat_equality_oid sat_atype.at_equality_oid
725 #define sat_ordering_oid sat_atype.at_ordering_oid
726 #define sat_substr_oid sat_atype.at_substr_oid
727 #define sat_syntax_oid sat_atype.at_syntax_oid
728 #define sat_single_value sat_atype.at_single_value
729 #define sat_collective sat_atype.at_collective
730 #define sat_no_user_mod sat_atype.at_no_user_mod
731 #define sat_usage sat_atype.at_usage
732 #define sat_extensions sat_atype.at_extensions
733
734 AttributeDescription *sat_ad;
735 ldap_pvt_thread_mutex_t sat_ad_mutex;
736 };
737
738 #define is_at_operational(at) ((at)->sat_usage)
739 #define is_at_single_value(at) ((at)->sat_single_value)
740 #define is_at_collective(at) ((at)->sat_collective)
741 #define is_at_obsolete(at) ((at)->sat_obsolete)
742 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
743
744 typedef int (ObjectClassSchemaCheckFN)(
745 BackendDB *be,
746 Entry *e,
747 ObjectClass *oc,
748 const char** text,
749 char *textbuf, size_t textlen );
750
751 struct ObjectClass {
752 LDAPObjectClass soc_oclass;
753 struct berval soc_cname;
754 ObjectClass **soc_sups;
755 AttributeType **soc_required;
756 AttributeType **soc_allowed;
757 ObjectClassSchemaCheckFN *soc_check;
758 char *soc_oidmacro;
759 slap_mask_t soc_flags;
760 #define soc_oid soc_oclass.oc_oid
761 #define soc_names soc_oclass.oc_names
762 #define soc_desc soc_oclass.oc_desc
763 #define soc_obsolete soc_oclass.oc_obsolete
764 #define soc_sup_oids soc_oclass.oc_sup_oids
765 #define soc_kind soc_oclass.oc_kind
766 #define soc_at_oids_must soc_oclass.oc_at_oids_must
767 #define soc_at_oids_may soc_oclass.oc_at_oids_may
768 #define soc_extensions soc_oclass.oc_extensions
769
770 LDAP_STAILQ_ENTRY(ObjectClass) soc_next;
771 };
772
773 #define SLAP_OCF_SET_FLAGS 0x1
774 #define SLAP_OCF_CHECK_SUP 0x2
775 #define SLAP_OCF_MASK (SLAP_OCF_SET_FLAGS|SLAP_OCF_CHECK_SUP)
776
777 #define SLAP_OC_ALIAS 0x0001
778 #define SLAP_OC_REFERRAL 0x0002
779 #define SLAP_OC_SUBENTRY 0x0004
780 #define SLAP_OC_DYNAMICOBJECT 0x0008
781 #define SLAP_OC_COLLECTIVEATTRIBUTESUBENTRY 0x0010
782 #define SLAP_OC_GLUE 0x0020
783 #define SLAP_OC_SYNCPROVIDERSUBENTRY 0x0040
784 #define SLAP_OC_SYNCCONSUMERSUBENTRY 0x0080
785 #define SLAP_OC__MASK 0x00FF
786 #define SLAP_OC__END 0x0100
787 #define SLAP_OC_OPERATIONAL 0x4000
788 #ifdef LDAP_DEVEL
789 #define SLAP_OC_HIDE 0x0000
790 #else
791 #define SLAP_OC_HIDE 0x8000
792 #endif
793 #define SLAP_OC_HARDCODE 0x10000U /* This is hardcoded schema */
794 #define SLAP_OC_DELETED 0x20000U
795
796 /*
797 * DIT content rule
798 */
799 struct ContentRule {
800 LDAPContentRule scr_crule;
801 ObjectClass *scr_sclass;
802 ObjectClass **scr_auxiliaries; /* optional */
803 AttributeType **scr_required; /* optional */
804 AttributeType **scr_allowed; /* optional */
805 AttributeType **scr_precluded; /* optional */
806 #define scr_oid scr_crule.cr_oid
807 #define scr_names scr_crule.cr_names
808 #define scr_desc scr_crule.cr_desc
809 #define scr_obsolete scr_crule.cr_obsolete
810 #define scr_oc_oids_aux scr_crule.cr_oc_oids_aux
811 #define scr_at_oids_must scr_crule.cr_at_oids_must
812 #define scr_at_oids_may scr_crule.cr_at_oids_may
813 #define scr_at_oids_not scr_crule.cr_at_oids_not
814
815 char *scr_oidmacro;
816 #define SLAP_CR_HARDCODE 0x10000U
817 int scr_flags;
818
819 LDAP_STAILQ_ENTRY( ContentRule ) scr_next;
820 };
821
822 /* Represents a recognized attribute description ( type + options ). */
823 struct AttributeDescription {
824 AttributeDescription *ad_next;
825 AttributeType *ad_type; /* attribute type, must be specified */
826 struct berval ad_cname; /* canonical name, must be specified */
827 struct berval ad_tags; /* empty if no tagging options */
828 unsigned ad_flags;
829 #define SLAP_DESC_NONE 0x00U
830 #define SLAP_DESC_BINARY 0x01U
831 #define SLAP_DESC_TAG_RANGE 0x80U
832 #define SLAP_DESC_TEMPORARY 0x1000U
833 };
834
835 /* flags to slap_*2undef_ad to register undefined (0, the default)
836 * or proxied (SLAP_AD_PROXIED) AttributeDescriptions; the additional
837 * SLAP_AD_NOINSERT is to lookup without insert */
838 #define SLAP_AD_UNDEF 0x00U
839 #define SLAP_AD_PROXIED 0x01U
840 #define SLAP_AD_NOINSERT 0x02U
841
842 struct AttributeName {
843 struct berval an_name;
844 AttributeDescription *an_desc;
845 int an_oc_exclude;
846 ObjectClass *an_oc;
847 };
848
849 #define slap_ad_is_tagged(ad) ( (ad)->ad_tags.bv_len != 0 )
850 #define slap_ad_is_tag_range(ad) \
851 ( ((ad)->ad_flags & SLAP_DESC_TAG_RANGE) ? 1 : 0 )
852 #define slap_ad_is_binary(ad) \
853 ( ((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
854
855 /*
856 * pointers to schema elements used internally
857 */
858 struct slap_internal_schema {
859 /* objectClass */
860 ObjectClass *si_oc_top;
861 ObjectClass *si_oc_extensibleObject;
862 ObjectClass *si_oc_alias;
863 ObjectClass *si_oc_referral;
864 ObjectClass *si_oc_rootdse;
865 ObjectClass *si_oc_subentry;
866 ObjectClass *si_oc_subschema;
867 ObjectClass *si_oc_collectiveAttributeSubentry;
868 ObjectClass *si_oc_dynamicObject;
869
870 ObjectClass *si_oc_glue;
871 ObjectClass *si_oc_syncConsumerSubentry;
872 ObjectClass *si_oc_syncProviderSubentry;
873
874 /* objectClass attribute descriptions */
875 AttributeDescription *si_ad_objectClass;
876
877 /* operational attribute descriptions */
878 AttributeDescription *si_ad_structuralObjectClass;
879 AttributeDescription *si_ad_creatorsName;
880 AttributeDescription *si_ad_createTimestamp;
881 AttributeDescription *si_ad_modifiersName;
882 AttributeDescription *si_ad_modifyTimestamp;
883 AttributeDescription *si_ad_hasSubordinates;
884 AttributeDescription *si_ad_subschemaSubentry;
885 AttributeDescription *si_ad_collectiveSubentries;
886 AttributeDescription *si_ad_collectiveExclusions;
887 AttributeDescription *si_ad_entryDN;
888 AttributeDescription *si_ad_entryUUID;
889 AttributeDescription *si_ad_entryCSN;
890 AttributeDescription *si_ad_namingCSN;
891
892 AttributeDescription *si_ad_dseType;
893 AttributeDescription *si_ad_syncreplCookie;
894 AttributeDescription *si_ad_syncTimestamp;
895 AttributeDescription *si_ad_contextCSN;
896
897 /* root DSE attribute descriptions */
898 AttributeDescription *si_ad_altServer;
899 AttributeDescription *si_ad_namingContexts;
900 AttributeDescription *si_ad_supportedControl;
901 AttributeDescription *si_ad_supportedExtension;
902 AttributeDescription *si_ad_supportedLDAPVersion;
903 AttributeDescription *si_ad_supportedSASLMechanisms;
904 AttributeDescription *si_ad_supportedFeatures;
905 AttributeDescription *si_ad_monitorContext;
906 AttributeDescription *si_ad_vendorName;
907 AttributeDescription *si_ad_vendorVersion;
908 AttributeDescription *si_ad_configContext;
909
910 /* subentry attribute descriptions */
911 AttributeDescription *si_ad_administrativeRole;
912 AttributeDescription *si_ad_subtreeSpecification;
913
914 /* subschema subentry attribute descriptions */
915 AttributeDescription *si_ad_attributeTypes;
916 AttributeDescription *si_ad_ditContentRules;
917 AttributeDescription *si_ad_ditStructureRules;
918 AttributeDescription *si_ad_ldapSyntaxes;
919 AttributeDescription *si_ad_matchingRules;
920 AttributeDescription *si_ad_matchingRuleUse;
921 AttributeDescription *si_ad_nameForms;
922 AttributeDescription *si_ad_objectClasses;
923
924 /* Aliases & Referrals */
925 AttributeDescription *si_ad_aliasedObjectName;
926 AttributeDescription *si_ad_ref;
927
928 /* Access Control Internals */
929 AttributeDescription *si_ad_entry;
930 AttributeDescription *si_ad_children;
931 AttributeDescription *si_ad_saslAuthzTo;
932 AttributeDescription *si_ad_saslAuthzFrom;
933
934 /* dynamic entries */
935 AttributeDescription *si_ad_entryTtl;
936 AttributeDescription *si_ad_dynamicSubtrees;
937
938 /* Other attributes descriptions */
939 AttributeDescription *si_ad_distinguishedName;
940 AttributeDescription *si_ad_name;
941 AttributeDescription *si_ad_cn;
942 AttributeDescription *si_ad_uid;
943 AttributeDescription *si_ad_uidNumber;
944 AttributeDescription *si_ad_gidNumber;
945 AttributeDescription *si_ad_userPassword;
946 AttributeDescription *si_ad_labeledURI;
947 #ifdef SLAPD_AUTHPASSWD
948 AttributeDescription *si_ad_authPassword;
949 AttributeDescription *si_ad_authPasswordSchemes;
950 #endif
951 AttributeDescription *si_ad_description;
952 AttributeDescription *si_ad_seeAlso;
953
954 /* Undefined Attribute Type */
955 AttributeType *si_at_undefined;
956
957 /* "Proxied" Attribute Type */
958 AttributeType *si_at_proxied;
959
960 /* Matching Rules */
961 MatchingRule *si_mr_distinguishedNameMatch;
962 MatchingRule *si_mr_dnSubtreeMatch;
963 MatchingRule *si_mr_dnOneLevelMatch;
964 MatchingRule *si_mr_dnSubordinateMatch;
965 MatchingRule *si_mr_dnSuperiorMatch;
966 MatchingRule *si_mr_caseExactMatch;
967 MatchingRule *si_mr_caseExactSubstringsMatch;
968 MatchingRule *si_mr_caseExactIA5Match;
969 MatchingRule *si_mr_integerMatch;
970 MatchingRule *si_mr_integerFirstComponentMatch;
971 MatchingRule *si_mr_objectIdentifierFirstComponentMatch;
972
973 /* Syntaxes */
974 Syntax *si_syn_directoryString;
975 Syntax *si_syn_distinguishedName;
976 Syntax *si_syn_integer;
977 Syntax *si_syn_octetString;
978
979 /* Schema Syntaxes */
980 Syntax *si_syn_attributeTypeDesc;
981 Syntax *si_syn_ditContentRuleDesc;
982 Syntax *si_syn_ditStructureRuleDesc;
983 Syntax *si_syn_ldapSyntaxDesc;
984 Syntax *si_syn_matchingRuleDesc;
985 Syntax *si_syn_matchingRuleUseDesc;
986 Syntax *si_syn_nameFormDesc;
987 Syntax *si_syn_objectClassDesc;
988 };
989
990 struct AttributeAssertion {
991 AttributeDescription *aa_desc;
992 struct berval aa_value;
993 #ifdef LDAP_COMP_MATCH
994 ComponentFilter *aa_cf; /* for attribute aliasing */
995 #endif
996 };
997 #ifdef LDAP_COMP_MATCH
998 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL, NULL }
999 #else
1000 #define ATTRIBUTEASSERTION_INIT { NULL, BER_BVNULL }
1001 #endif
1002
1003 struct SubstringsAssertion {
1004 AttributeDescription *sa_desc;
1005 struct berval sa_initial;
1006 struct berval *sa_any;
1007 struct berval sa_final;
1008 };
1009
1010 struct MatchingRuleAssertion {
1011 AttributeDescription *ma_desc; /* optional */
1012 struct berval ma_value; /* required */
1013 MatchingRule *ma_rule; /* optional */
1014 struct berval ma_rule_text; /* optional */
1015 int ma_dnattrs; /* boolean */
1016 #ifdef LDAP_COMP_MATCH
1017 ComponentFilter *ma_cf; /* component filter */
1018 #endif
1019 };
1020
1021 /*
1022 * represents a search filter
1023 */
1024 struct Filter {
1025 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
1026 #define SLAPD_FILTER_COMPUTED 0
1027 #define SLAPD_FILTER_MASK 0x7fff
1028 #define SLAPD_FILTER_UNDEFINED 0x8000
1029
1030 union f_un_u {
1031 /* precomputed result */
1032 ber_int_t f_un_result;
1033
1034 /* present */
1035 AttributeDescription *f_un_desc;
1036
1037 /* simple value assertion */
1038 AttributeAssertion *f_un_ava;
1039
1040 /* substring assertion */
1041 SubstringsAssertion *f_un_ssa;
1042
1043 /* matching rule assertion */
1044 MatchingRuleAssertion *f_un_mra;
1045
1046 #define f_desc f_un.f_un_desc
1047 #define f_ava f_un.f_un_ava
1048 #define f_av_desc f_un.f_un_ava->aa_desc
1049 #define f_av_value f_un.f_un_ava->aa_value
1050 #define f_sub f_un.f_un_ssa
1051 #define f_sub_desc f_un.f_un_ssa->sa_desc
1052 #define f_sub_initial f_un.f_un_ssa->sa_initial
1053 #define f_sub_any f_un.f_un_ssa->sa_any
1054 #define f_sub_final f_un.f_un_ssa->sa_final
1055 #define f_mra f_un.f_un_mra
1056 #define f_mr_rule f_un.f_un_mra->ma_rule
1057 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
1058 #define f_mr_desc f_un.f_un_mra->ma_desc
1059 #define f_mr_value f_un.f_un_mra->ma_value
1060 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
1061
1062 /* and, or, not */
1063 Filter *f_un_complex;
1064 } f_un;
1065
1066 #define f_result f_un.f_un_result
1067 #define f_and f_un.f_un_complex
1068 #define f_or f_un.f_un_complex
1069 #define f_not f_un.f_un_complex
1070 #define f_list f_un.f_un_complex
1071
1072 Filter *f_next;
1073 };
1074
1075 /* compare routines can return undefined */
1076 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
1077
1078 struct ValuesReturnFilter {
1079 ber_tag_t vrf_choice;
1080
1081 union vrf_un_u {
1082 /* precomputed result */
1083 ber_int_t vrf_un_result;
1084
1085 /* DN */
1086 char *vrf_un_dn;
1087
1088 /* present */
1089 AttributeDescription *vrf_un_desc;
1090
1091 /* simple value assertion */
1092 AttributeAssertion *vrf_un_ava;
1093
1094 /* substring assertion */
1095 SubstringsAssertion *vrf_un_ssa;
1096
1097 /* matching rule assertion */
1098 MatchingRuleAssertion *vrf_un_mra;
1099
1100 #define vrf_result vrf_un.vrf_un_result
1101 #define vrf_dn vrf_un.vrf_un_dn
1102 #define vrf_desc vrf_un.vrf_un_desc
1103 #define vrf_ava vrf_un.vrf_un_ava
1104 #define vrf_av_desc vrf_un.vrf_un_ava->aa_desc
1105 #define vrf_av_value vrf_un.vrf_un_ava->aa_value
1106 #define vrf_ssa vrf_un.vrf_un_ssa
1107 #define vrf_sub vrf_un.vrf_un_ssa
1108 #define vrf_sub_desc vrf_un.vrf_un_ssa->sa_desc
1109 #define vrf_sub_initial vrf_un.vrf_un_ssa->sa_initial
1110 #define vrf_sub_any vrf_un.vrf_un_ssa->sa_any
1111 #define vrf_sub_final vrf_un.vrf_un_ssa->sa_final
1112 #define vrf_mra vrf_un.vrf_un_mra
1113 #define vrf_mr_rule vrf_un.vrf_un_mra->ma_rule
1114 #define vrf_mr_rule_text vrf_un.vrf_un_mra->ma_rule_text
1115 #define vrf_mr_desc vrf_un.vrf_un_mra->ma_desc
1116 #define vrf_mr_value vrf_un.vrf_un_mra->ma_value
1117 #define vrf_mr_dnattrs vrf_un.vrf_un_mra->ma_dnattrs
1118
1119
1120 } vrf_un;
1121
1122 ValuesReturnFilter *vrf_next;
1123 };
1124
1125 /*
1126 * represents an attribute (description + values)
1127 * desc, vals, nvals, numvals fields must align with Modification
1128 */
1129 struct Attribute {
1130 AttributeDescription *a_desc;
1131 BerVarray a_vals; /* preserved values */
1132 BerVarray a_nvals; /* normalized values */
1133 unsigned a_numvals; /* number of vals */
1134 unsigned a_flags;
1135 #define SLAP_ATTR_IXADD 0x1U
1136 #define SLAP_ATTR_IXDEL 0x2U
1137 #define SLAP_ATTR_DONT_FREE_DATA 0x4U
1138 #define SLAP_ATTR_DONT_FREE_VALS 0x8U
1139 #define SLAP_ATTR_SORTED_VALS 0x10U /* values are sorted */
1140
1141 /* These flags persist across an attr_dup() */
1142 #define SLAP_ATTR_PERSISTENT_FLAGS \
1143 SLAP_ATTR_SORTED_VALS
1144
1145 Attribute *a_next;
1146 #ifdef LDAP_COMP_MATCH
1147 ComponentData *a_comp_data; /* component values */
1148 #endif
1149 };
1150
1151
1152 /*
1153 * the id used in the indexes to refer to an entry
1154 */
1155 typedef unsigned long ID;
1156 #define NOID ((ID)~0)
1157
1158 typedef struct EntryHeader {
1159 struct berval bv;
1160 char *data;
1161 int nattrs;
1162 int nvals;
1163 } EntryHeader;
1164
1165 /*
1166 * represents an entry in core
1167 */
1168 struct Entry {
1169 /*
1170 * The ID field should only be changed before entry is
1171 * inserted into a cache. The ID value is backend
1172 * specific.
1173 */
1174 ID e_id;
1175
1176 struct berval e_name; /* name (DN) of this entry */
1177 struct berval e_nname; /* normalized name (DN) of this entry */
1178
1179 /* for migration purposes */
1180 #define e_dn e_name.bv_val
1181 #define e_ndn e_nname.bv_val
1182
1183 Attribute *e_attrs; /* list of attributes + values */
1184
1185 slap_mask_t e_ocflags;
1186
1187 struct berval e_bv; /* For entry_encode/entry_decode */
1188
1189 /* for use by the backend for any purpose */
1190 void* e_private;
1191 };
1192
1193 /*
1194 * A list of LDAPMods
1195 * desc, values, nvalues, numvals must align with Attribute
1196 */
1197 struct Modification {
1198 AttributeDescription *sm_desc;
1199 BerVarray sm_values;
1200 BerVarray sm_nvalues;
1201 unsigned sm_numvals;
1202 short sm_op;
1203 short sm_flags;
1204 /* Set for internal mods, will bypass ACL checks. Only needed when
1205 * running as non-root user, for user modifiable attributes.
1206 */
1207 #define SLAP_MOD_INTERNAL 0x01
1208 #define SLAP_MOD_MANAGING 0x02
1209 struct berval sm_type;
1210 };
1211
1212 struct Modifications {
1213 Modification sml_mod;
1214 #define sml_op sml_mod.sm_op
1215 #define sml_flags sml_mod.sm_flags
1216 #define sml_desc sml_mod.sm_desc
1217 #define sml_type sml_mod.sm_type
1218 #define sml_values sml_mod.sm_values
1219 #define sml_nvalues sml_mod.sm_nvalues
1220 #define sml_numvals sml_mod.sm_numvals
1221 Modifications *sml_next;
1222 };
1223
1224 /*
1225 * represents an access control list
1226 */
1227 typedef enum slap_access_t {
1228 ACL_INVALID_ACCESS = -1,
1229 ACL_NONE = 0,
1230 ACL_DISCLOSE,
1231 ACL_AUTH,
1232 ACL_COMPARE,
1233 ACL_SEARCH,
1234 ACL_READ,
1235 ACL_WRITE_,
1236 ACL_MANAGE,
1237
1238 /* always leave at end of levels but not greater than ACL_LEVEL_MASK */
1239 ACL_LAST,
1240
1241 /* ACL level mask and modifiers */
1242 ACL_LEVEL_MASK = 0x000f,
1243 ACL_QUALIFIER1 = 0x0100,
1244 ACL_QUALIFIER2 = 0x0200,
1245 ACL_QUALIFIER3 = 0x0400,
1246 ACL_QUALIFIER4 = 0x0800,
1247 ACL_QUALIFIER_MASK = 0x0f00,
1248
1249 /* write granularity */
1250 ACL_WADD = ACL_WRITE_|ACL_QUALIFIER1,
1251 ACL_WDEL = ACL_WRITE_|ACL_QUALIFIER2,
1252
1253 ACL_WRITE = ACL_WADD|ACL_WDEL
1254 } slap_access_t;
1255
1256 typedef enum slap_control_e {
1257 ACL_INVALID_CONTROL = 0,
1258 ACL_STOP,
1259 ACL_CONTINUE,
1260 ACL_BREAK
1261 } slap_control_t;
1262
1263 typedef enum slap_style_e {
1264 ACL_STYLE_REGEX = 0,
1265 ACL_STYLE_EXPAND,
1266 ACL_STYLE_BASE,
1267 ACL_STYLE_ONE,
1268 ACL_STYLE_SUBTREE,
1269 ACL_STYLE_CHILDREN,
1270 ACL_STYLE_LEVEL,
1271 ACL_STYLE_ATTROF,
1272 ACL_STYLE_ANONYMOUS,
1273 ACL_STYLE_USERS,
1274 ACL_STYLE_SELF,
1275 ACL_STYLE_IP,
1276 ACL_STYLE_IPV6,
1277 ACL_STYLE_PATH
1278 } slap_style_t;
1279
1280 typedef struct AuthorizationInformation {
1281 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
1282 struct berval sai_mech; /* SASL Mechanism */
1283 struct berval sai_dn; /* DN for reporting purposes */
1284 struct berval sai_ndn; /* Normalized DN */
1285
1286 /* Security Strength Factors */
1287 slap_ssf_t sai_ssf; /* Overall SSF */
1288 slap_ssf_t sai_transport_ssf; /* Transport SSF */
1289 slap_ssf_t sai_tls_ssf; /* TLS SSF */
1290 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
1291 } AuthorizationInformation;
1292
1293 #ifdef SLAP_DYNACL
1294
1295 /*
1296 * "dynamic" ACL infrastructure (for ACIs and more)
1297 */
1298 typedef int (slap_dynacl_parse) LDAP_P(( const char *fname, int lineno,
1299 const char *opts, slap_style_t, const char *, void **privp ));
1300 typedef int (slap_dynacl_unparse) LDAP_P(( void *priv, struct berval *bv ));
1301 typedef int (slap_dynacl_mask) LDAP_P((
1302 void *priv,
1303 Operation *op,
1304 Entry *e,
1305 AttributeDescription *desc,
1306 struct berval *val,
1307 int nmatch,
1308 regmatch_t *matches,
1309 slap_access_t *grant,
1310 slap_access_t *deny ));
1311 typedef int (slap_dynacl_destroy) LDAP_P(( void *priv ));
1312
1313 typedef struct slap_dynacl_t {
1314 char *da_name;
1315 slap_dynacl_parse *da_parse;
1316 slap_dynacl_unparse *da_unparse;
1317 slap_dynacl_mask *da_mask;
1318 slap_dynacl_destroy *da_destroy;
1319
1320 void *da_private;
1321 struct slap_dynacl_t *da_next;
1322 } slap_dynacl_t;
1323 #endif /* SLAP_DYNACL */
1324
1325 /* the DN portion of the "by" part */
1326 typedef struct slap_dn_access {
1327 /* DN pattern */
1328 AuthorizationInformation a_dnauthz;
1329 #define a_pat a_dnauthz.sai_dn
1330
1331 slap_style_t a_style;
1332 int a_level;
1333 int a_self_level;
1334 AttributeDescription *a_at;
1335 int a_self;
1336 int a_expand;
1337 } slap_dn_access;
1338
1339 /* the "by" part */
1340 typedef struct Access {
1341 slap_control_t a_type;
1342
1343 /* strip qualifiers */
1344 #define ACL_LEVEL(p) ((p) & ACL_LEVEL_MASK)
1345 #define ACL_QUALIFIERS(p) ((p) & ~ACL_LEVEL_MASK)
1346
1347 #define ACL_ACCESS2PRIV(access) ((0x01U << ACL_LEVEL((access))) | ACL_QUALIFIERS((access)))
1348
1349 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
1350 #define ACL_PRIV_DISCLOSE ACL_ACCESS2PRIV( ACL_DISCLOSE )
1351 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
1352 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
1353 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
1354 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
1355 #define ACL_PRIV_WADD ACL_ACCESS2PRIV( ACL_WADD )
1356 #define ACL_PRIV_WDEL ACL_ACCESS2PRIV( ACL_WDEL )
1357 #define ACL_PRIV_WRITE ( ACL_PRIV_WADD | ACL_PRIV_WDEL )
1358 #define ACL_PRIV_MANAGE ACL_ACCESS2PRIV( ACL_MANAGE )
1359
1360 /* NOTE: always use the highest level; current: 0x00ffUL */
1361 #define ACL_PRIV_MASK ((ACL_ACCESS2PRIV(ACL_LAST) - 1) | ACL_QUALIFIER_MASK)
1362
1363 /* priv flags */
1364 #define ACL_PRIV_LEVEL 0x1000UL
1365 #define ACL_PRIV_ADDITIVE 0x2000UL
1366 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
1367
1368 /* invalid privs */
1369 #define ACL_PRIV_INVALID 0x0UL
1370
1371 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
1372 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
1373 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
1374 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
1375
1376 #define ACL_INIT(m) ACL_PRIV_ASSIGN((m), ACL_PRIV_NONE)
1377 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN((m), ACL_PRIV_INVALID)
1378
1379 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
1380
1381 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
1382
1383 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
1384 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
1385 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
1386
1387 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
1388 #define ACL_LVL_DISCLOSE (ACL_PRIV_DISCLOSE|ACL_LVL_NONE)
1389 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_DISCLOSE)
1390 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
1391 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
1392 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
1393 #define ACL_LVL_WADD (ACL_PRIV_WADD|ACL_LVL_READ)
1394 #define ACL_LVL_WDEL (ACL_PRIV_WDEL|ACL_LVL_READ)
1395 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
1396 #define ACL_LVL_MANAGE (ACL_PRIV_MANAGE|ACL_LVL_WRITE)
1397
1398 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
1399 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
1400 #define ACL_LVL_IS_DISCLOSE(m) ACL_LVL((m),ACL_LVL_DISCLOSE)
1401 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
1402 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
1403 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
1404 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
1405 #define ACL_LVL_IS_WADD(m) ACL_LVL((m),ACL_LVL_WADD)
1406 #define ACL_LVL_IS_WDEL(m) ACL_LVL((m),ACL_LVL_WDEL)
1407 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
1408 #define ACL_LVL_IS_MANAGE(m) ACL_LVL((m),ACL_LVL_MANAGE)
1409
1410 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
1411 #define ACL_LVL_ASSIGN_DISCLOSE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_DISCLOSE)
1412 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
1413 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
1414 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
1415 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
1416 #define ACL_LVL_ASSIGN_WADD(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WADD)
1417 #define ACL_LVL_ASSIGN_WDEL(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WDEL)
1418 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
1419 #define ACL_LVL_ASSIGN_MANAGE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_MANAGE)
1420
1421 slap_mask_t a_access_mask;
1422
1423 /* DN pattern */
1424 slap_dn_access a_dn;
1425 #define a_dn_pat a_dn.a_dnauthz.sai_dn
1426 #define a_dn_at a_dn.a_at
1427 #define a_dn_self a_dn.a_self
1428
1429 /* real DN pattern */
1430 slap_dn_access a_realdn;
1431 #define a_realdn_pat a_realdn.a_dnauthz.sai_dn
1432 #define a_realdn_at a_realdn.a_at
1433 #define a_realdn_self a_realdn.a_self
1434
1435 /* used for ssf stuff
1436 * NOTE: the ssf stuff in a_realdn is ignored */
1437 #define a_authz a_dn.a_dnauthz
1438
1439 /* connection related stuff */
1440 slap_style_t a_peername_style;
1441 struct berval a_peername_pat;
1442 #ifdef LDAP_PF_INET6
1443 union {
1444 struct in6_addr ax6;
1445 unsigned long ax;
1446 } ax_peername_addr,
1447 ax_peername_mask;
1448 #define a_peername_addr6 ax_peername_addr.ax6
1449 #define a_peername_addr ax_peername_addr.ax
1450 #define a_peername_mask6 ax_peername_mask.ax6
1451 #define a_peername_mask ax_peername_mask.ax
1452 /* apparently, only s6_addr is portable;
1453 * define a portable address mask comparison */
1454 #define slap_addr6_mask(val, msk, asr) ( \
1455 (((val)->s6_addr[0] & (msk)->s6_addr[0]) == (asr)->s6_addr[0]) \
1456 && (((val)->s6_addr[1] & (msk)->s6_addr[1]) == (asr)->s6_addr[1]) \
1457 && (((val)->s6_addr[2] & (msk)->s6_addr[2]) == (asr)->s6_addr[2]) \
1458 && (((val)->s6_addr[3] & (msk)->s6_addr[3]) == (asr)->s6_addr[3]) \
1459 && (((val)->s6_addr[4] & (msk)->s6_addr[4]) == (asr)->s6_addr[4]) \
1460 && (((val)->s6_addr[5] & (msk)->s6_addr[5]) == (asr)->s6_addr[5]) \
1461 && (((val)->s6_addr[6] & (msk)->s6_addr[6]) == (asr)->s6_addr[6]) \
1462 && (((val)->s6_addr[7] & (msk)->s6_addr[7]) == (asr)->s6_addr[7]) \
1463 && (((val)->s6_addr[8] & (msk)->s6_addr[8]) == (asr)->s6_addr[8]) \
1464 && (((val)->s6_addr[9] & (msk)->s6_addr[9]) == (asr)->s6_addr[9]) \
1465 && (((val)->s6_addr[10] & (msk)->s6_addr[10]) == (asr)->s6_addr[10]) \
1466 && (((val)->s6_addr[11] & (msk)->s6_addr[11]) == (asr)->s6_addr[11]) \
1467 && (((val)->s6_addr[12] & (msk)->s6_addr[12]) == (asr)->s6_addr[12]) \
1468 && (((val)->s6_addr[13] & (msk)->s6_addr[13]) == (asr)->s6_addr[13]) \
1469 && (((val)->s6_addr[14] & (msk)->s6_addr[14]) == (asr)->s6_addr[14]) \
1470 && (((val)->s6_addr[15] & (msk)->s6_addr[15]) == (asr)->s6_addr[15]) \
1471 )
1472 #else /* ! LDAP_PF_INET6 */
1473 unsigned long a_peername_addr,
1474 a_peername_mask;
1475 #endif /* ! LDAP_PF_INET6 */
1476 int a_peername_port;
1477
1478 slap_style_t a_sockname_style;
1479 struct berval a_sockname_pat;
1480
1481 slap_style_t a_domain_style;
1482 struct berval a_domain_pat;
1483 int a_domain_expand;
1484
1485 slap_style_t a_sockurl_style;
1486 struct berval a_sockurl_pat;
1487 slap_style_t a_set_style;
1488 struct berval a_set_pat;
1489
1490 #ifdef SLAP_DYNACL
1491 slap_dynacl_t *a_dynacl;
1492 #endif /* SLAP_DYNACL */
1493
1494 /* ACL Groups */
1495 slap_style_t a_group_style;
1496 struct berval a_group_pat;
1497 ObjectClass *a_group_oc;
1498 AttributeDescription *a_group_at;
1499
1500 struct Access *a_next;
1501 } Access;
1502
1503 /* the "to" part */
1504 typedef struct AccessControl {
1505 /* "to" part: the entries this acl applies to */
1506 Filter *acl_filter;
1507 slap_style_t acl_dn_style;
1508 regex_t acl_dn_re;
1509 struct berval acl_dn_pat;
1510 AttributeName *acl_attrs;
1511 MatchingRule *acl_attrval_mr;
1512 slap_style_t acl_attrval_style;
1513 regex_t acl_attrval_re;
1514 struct berval acl_attrval;
1515
1516 /* "by" part: list of who has what access to the entries */
1517 Access *acl_access;
1518
1519 struct AccessControl *acl_next;
1520 } AccessControl;
1521
1522 typedef enum {
1523 ACL_STATE_NOT_RECORDED = 0x0,
1524 ACL_STATE_RECORDED_VD = 0x1,
1525 ACL_STATE_RECORDED_NV = 0x2,
1526 ACL_STATE_RECORDED = ( ACL_STATE_RECORDED_VD | ACL_STATE_RECORDED_NV )
1527 } slap_acl_state_t;
1528
1529 typedef struct AccessControlState {
1530 /* Access state */
1531 AccessControl *as_vi_acl;
1532 AccessControl *as_vd_acl;
1533 AttributeDescription *as_vd_ad;
1534
1535
1536 slap_acl_state_t as_recorded;
1537 int as_vd_acl_count;
1538 int as_result;
1539 } AccessControlState;
1540 #define ACL_STATE_INIT { NULL, NULL, NULL, \
1541 ACL_STATE_NOT_RECORDED, 0, 0 }
1542
1543 /*
1544 * Backend-info
1545 * represents a backend
1546 */
1547
1548 typedef LDAP_STAILQ_HEAD(BeI, BackendInfo) slap_bi_head;
1549 typedef LDAP_STAILQ_HEAD(BeDB, BackendDB) slap_be_head;
1550
1551 LDAP_SLAPD_V (int) nBackendInfo;
1552 LDAP_SLAPD_V (int) nBackendDB;
1553 LDAP_SLAPD_V (slap_bi_head) backendInfo;
1554 LDAP_SLAPD_V (slap_be_head) backendDB;
1555 LDAP_SLAPD_V (BackendDB *) frontendDB;
1556
1557 LDAP_SLAPD_V (int) slapMode;
1558 #define SLAP_UNDEFINED_MODE 0x0000
1559 #define SLAP_SERVER_MODE 0x0001
1560 #define SLAP_TOOL_MODE 0x0002
1561 #define SLAP_MODE 0x0003
1562
1563 #define SLAP_TRUNCATE_MODE 0x0100
1564 #define SLAP_TOOL_READMAIN 0x0200
1565 #define SLAP_TOOL_READONLY 0x0400
1566 #define SLAP_TOOL_QUICK 0x0800
1567 #define SLAP_TOOL_NO_SCHEMA_CHECK 0x1000
1568
1569 #define SB_TLS_DEFAULT (-1)
1570 #define SB_TLS_OFF 0
1571 #define SB_TLS_ON 1
1572 #define SB_TLS_CRITICAL 2
1573
1574 typedef struct slap_bindconf {
1575 struct berval sb_uri;
1576 int sb_version;
1577 int sb_tls;
1578 int sb_method;
1579 int sb_timeout_api;
1580 int sb_timeout_net;
1581 struct berval sb_binddn;
1582 struct berval sb_cred;
1583 struct berval sb_saslmech;
1584 char *sb_secprops;
1585 struct berval sb_realm;
1586 struct berval sb_authcId;
1587 struct berval sb_authzId;
1588 #ifdef HAVE_TLS
1589 void *sb_tls_ctx;
1590 char *sb_tls_cert;
1591 char *sb_tls_key;
1592 char *sb_tls_cacert;
1593 char *sb_tls_cacertdir;
1594 char *sb_tls_reqcert;
1595 char *sb_tls_cipher_suite;
1596 #ifdef HAVE_OPENSSL_CRL
1597 char *sb_tls_crlcheck;
1598 #endif
1599 int sb_tls_do_init;
1600 #endif
1601 } slap_bindconf;
1602
1603 typedef struct slap_verbmasks {
1604 struct berval word;
1605 const slap_mask_t mask;
1606 } slap_verbmasks;
1607
1608 typedef struct slap_cf_aux_table {
1609 struct berval key;
1610 int off;
1611 char type;
1612 char quote;
1613 void *aux;
1614 } slap_cf_aux_table;
1615
1616 #define SLAP_LIMIT_TIME 1
1617 #define SLAP_LIMIT_SIZE 2
1618
1619 struct slap_limits_set {
1620 /* time limits */
1621 int lms_t_soft;
1622 int lms_t_hard;
1623
1624 /* size limits */
1625 int lms_s_soft;
1626 int lms_s_hard;
1627 int lms_s_unchecked;
1628 int lms_s_pr;
1629 int lms_s_pr_hide;
1630 int lms_s_pr_total;
1631 };
1632
1633 /* Note: this is different from LDAP_NO_LIMIT (0); slapd internal use only */
1634 #define SLAP_NO_LIMIT -1
1635 #define SLAP_MAX_LIMIT 2147483647
1636
1637 struct slap_limits {
1638 unsigned lm_flags; /* type of pattern */
1639 #define SLAP_LIMITS_UNDEFINED 0x0000U
1640 #define SLAP_LIMITS_EXACT 0x0001U
1641 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
1642 #define SLAP_LIMITS_ONE 0x0002U
1643 #define SLAP_LIMITS_SUBTREE 0x0003U
1644 #define SLAP_LIMITS_CHILDREN 0x0004U
1645 #define SLAP_LIMITS_REGEX 0x0005U
1646 #define SLAP_LIMITS_ANONYMOUS 0x0006U
1647 #define SLAP_LIMITS_USERS 0x0007U
1648 #define SLAP_LIMITS_ANY 0x0008U
1649 #define SLAP_LIMITS_MASK 0x000FU
1650
1651 #define SLAP_LIMITS_TYPE_DN 0x0000U
1652 #define SLAP_LIMITS_TYPE_GROUP 0x0010U
1653 #define SLAP_LIMITS_TYPE_MASK 0x00F0U
1654
1655 regex_t lm_regex; /* regex data for REGEX */
1656
1657 /*
1658 * normalized DN for EXACT, BASE, ONE, SUBTREE, CHILDREN;
1659 * pattern for REGEX; NULL for ANONYMOUS, USERS
1660 */
1661 struct berval lm_pat;
1662
1663 /* if lm_flags & SLAP_LIMITS_TYPE_MASK == SLAP_LIMITS_GROUP,
1664 * lm_group_oc is objectClass and lm_group_at is attributeType
1665 * of member in oc for match; then lm_flags & SLAP_LIMITS_MASK
1666 * can only be SLAP_LIMITS_EXACT */
1667 ObjectClass *lm_group_oc;
1668 AttributeDescription *lm_group_ad;
1669
1670 struct slap_limits_set lm_limits;
1671 };
1672
1673 /* temporary aliases */
1674 typedef BackendDB Backend;
1675 #define nbackends nBackendDB
1676 #define backends backendDB
1677
1678 /*
1679 * syncinfo structure for syncrepl
1680 */
1681
1682 struct syncinfo_s;
1683
1684 #define SLAP_SYNC_RID_MAX 999
1685 #define SLAP_SYNC_SID_MAX 4095 /* based on liblutil/csn.c field width */
1686 #define SLAP_SYNCUUID_SET_SIZE 256
1687
1688 #define SLAP_SYNC_UPDATE_MSGID 1
1689
1690 struct sync_cookie {
1691 struct berval *ctxcsn;
1692 struct berval octet_str;
1693 int rid;
1694 int sid;
1695 int numcsns;
1696 int *sids;
1697 LDAP_STAILQ_ENTRY(sync_cookie) sc_next;
1698 };
1699
1700 LDAP_STAILQ_HEAD( slap_sync_cookie_s, sync_cookie );
1701
1702 LDAP_TAILQ_HEAD( be_pcl, slap_csn_entry );
1703
1704 #ifndef SLAP_MAX_CIDS
1705 #define SLAP_MAX_CIDS 32 /* Maximum number of supported controls */
1706 #endif
1707
1708 struct ConfigOCs; /* config.h */
1709
1710 struct BackendDB {
1711 BackendInfo *bd_info; /* pointer to shared backend info */
1712 BackendDB *bd_self; /* pointer to this struct */
1713
1714 /* fields in this structure (and routines acting on this structure)
1715 should be renamed from be_ to bd_ */
1716
1717 /* BackendInfo accessors */
1718 #define be_config bd_info->bi_db_config
1719 #define be_type bd_info->bi_type
1720
1721 #define be_bind bd_info->bi_op_bind
1722 #define be_unbind bd_info->bi_op_unbind
1723 #define be_add bd_info->bi_op_add
1724 #define be_compare bd_info->bi_op_compare
1725 #define be_delete bd_info->bi_op_delete
1726 #define be_modify bd_info->bi_op_modify
1727 #define be_modrdn bd_info->bi_op_modrdn
1728 #define be_search bd_info->bi_op_search
1729 #define be_abandon bd_info->bi_op_abandon
1730
1731 #define be_extended bd_info->bi_extended
1732 #define be_cancel bd_info->bi_op_cancel
1733
1734 #define be_chk_referrals bd_info->bi_chk_referrals
1735 #define be_chk_controls bd_info->bi_chk_controls
1736 #define be_fetch bd_info->bi_entry_get_rw
1737 #define be_release bd_info->bi_entry_release_rw
1738 #define be_group bd_info->bi_acl_group
1739 #define be_attribute bd_info->bi_acl_attribute
1740 #define be_operational bd_info->bi_operational
1741
1742 /*
1743 * define to honor hasSubordinates operational attribute in search filters
1744 * (in previous use there was a flaw with back-bdb; now it is fixed).
1745 */
1746 #define be_has_subordinates bd_info->bi_has_subordinates
1747
1748 #define be_connection_init bd_info->bi_connection_init
1749 #define be_connection_destroy bd_info->bi_connection_destroy
1750
1751 #ifdef SLAPD_TOOLS
1752 #define be_entry_open bd_info->bi_tool_entry_open
1753 #define be_entry_close bd_info->bi_tool_entry_close
1754 #define be_entry_first bd_info->bi_tool_entry_first
1755 #define be_entry_next bd_info->bi_tool_entry_next
1756 #define be_entry_reindex bd_info->bi_tool_entry_reindex
1757 #define be_entry_get bd_info->bi_tool_entry_get
1758 #define be_entry_put bd_info->bi_tool_entry_put
1759 #define be_sync bd_info->bi_tool_sync
1760 #define be_dn2id_get bd_info->bi_tool_dn2id_get
1761 #define be_entry_modify bd_info->bi_tool_entry_modify
1762 #endif
1763
1764 /* supported controls */
1765 /* note: set to 0 if the database does not support the control;
1766 * be_ctrls[SLAP_MAX_CIDS] is set to 1 if initialized */
1767 char be_ctrls[SLAP_MAX_CIDS + 1];
1768
1769 /* Database flags */
1770 #define SLAP_DBFLAG_NOLASTMOD 0x0001U
1771 #define SLAP_DBFLAG_NO_SCHEMA_CHECK 0x0002U
1772 #define SLAP_DBFLAG_HIDDEN 0x0004U
1773 #define SLAP_DBFLAG_ONE_SUFFIX 0x0008U
1774 #define SLAP_DBFLAG_GLUE_INSTANCE 0x0010U /* a glue backend */
1775 #define SLAP_DBFLAG_GLUE_SUBORDINATE 0x0020U /* child of a glue hierarchy */
1776 #define SLAP_DBFLAG_GLUE_LINKED 0x0040U /* child is connected to parent */
1777 #define SLAP_DBFLAG_GLUE_ADVERTISE 0x0080U /* advertise in rootDSE */
1778 #define SLAP_DBFLAG_OVERLAY 0x0100U /* this db struct is an overlay */
1779 #define SLAP_DBFLAG_GLOBAL_OVERLAY 0x0200U /* this db struct is a global overlay */
1780 #define SLAP_DBFLAG_DYNAMIC 0x0400U /* this db allows dynamicObjects */
1781 #define SLAP_DBFLAG_MONITORING 0x0800U /* custom monitoring enabled */
1782 #define SLAP_DBFLAG_SHADOW 0x8000U /* a shadow */
1783 #define SLAP_DBFLAG_SINGLE_SHADOW 0x4000U /* a single-master shadow */
1784 #define SLAP_DBFLAG_SYNC_SHADOW 0x1000U /* a sync shadow */
1785 #define SLAP_DBFLAG_SLURP_SHADOW 0x2000U /* a slurp shadow */
1786 slap_mask_t be_flags;
1787 #define SLAP_DBFLAGS(be) ((be)->be_flags)
1788 #define SLAP_NOLASTMOD(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NOLASTMOD)
1789 #define SLAP_LASTMOD(be) (!SLAP_NOLASTMOD(be))
1790 #define SLAP_DBHIDDEN(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_HIDDEN)
1791 #define SLAP_DB_ONE_SUFFIX(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_ONE_SUFFIX)
1792 #define SLAP_ISOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_OVERLAY)
1793 #define SLAP_ISGLOBALOVERLAY(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLOBAL_OVERLAY)
1794 #define SLAP_DBMONITORING(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_MONITORING)
1795 #define SLAP_NO_SCHEMA_CHECK(be) \
1796 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_NO_SCHEMA_CHECK)
1797 #define SLAP_GLUE_INSTANCE(be) \
1798 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_INSTANCE)
1799 #define SLAP_GLUE_SUBORDINATE(be) \
1800 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_SUBORDINATE)
1801 #define SLAP_GLUE_LINKED(be) \
1802 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_LINKED)
1803 #define SLAP_GLUE_ADVERTISE(be) \
1804 (SLAP_DBFLAGS(be) & SLAP_DBFLAG_GLUE_ADVERTISE)
1805 #define SLAP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SHADOW)
1806 #define SLAP_SYNC_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SYNC_SHADOW)
1807 #define SLAP_SLURP_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SLURP_SHADOW)
1808 #define SLAP_SINGLE_SHADOW(be) (SLAP_DBFLAGS(be) & SLAP_DBFLAG_SINGLE_SHADOW)
1809 #define SLAP_MULTIMASTER(be) (!SLAP_SINGLE_SHADOW(be))
1810
1811 slap_mask_t be_restrictops; /* restriction operations */
1812 #define SLAP_RESTRICT_OP_ADD 0x0001U
1813 #define SLAP_RESTRICT_OP_BIND 0x0002U
1814 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
1815 #define SLAP_RESTRICT_OP_DELETE 0x0008U
1816 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
1817 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
1818 #define SLAP_RESTRICT_OP_RENAME 0x0040U
1819 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
1820 #define SLAP_RESTRICT_OP_MASK 0x00FFU
1821
1822 #define SLAP_RESTRICT_READONLY 0x80000000U
1823
1824 #define SLAP_RESTRICT_EXOP_START_TLS 0x0100U
1825 #define SLAP_RESTRICT_EXOP_MODIFY_PASSWD 0x0200U
1826 #define SLAP_RESTRICT_EXOP_WHOAMI 0x0400U
1827 #define SLAP_RESTRICT_EXOP_CANCEL 0x0800U
1828 #define SLAP_RESTRICT_EXOP_MASK 0xFF00U
1829
1830 #define SLAP_RESTRICT_OP_READS \
1831 ( SLAP_RESTRICT_OP_COMPARE \
1832 | SLAP_RESTRICT_OP_SEARCH )
1833 #define SLAP_RESTRICT_OP_WRITES \
1834 ( SLAP_RESTRICT_OP_ADD \
1835 | SLAP_RESTRICT_OP_DELETE \
1836 | SLAP_RESTRICT_OP_MODIFY \
1837 | SLAP_RESTRICT_OP_RENAME )
1838 #define SLAP_RESTRICT_OP_ALL \
1839 ( SLAP_RESTRICT_OP_READS \
1840 | SLAP_RESTRICT_OP_WRITES \
1841 | SLAP_RESTRICT_OP_BIND \
1842 | SLAP_RESTRICT_OP_EXTENDED )
1843
1844 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
1845 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
1846 #define SLAP_ALLOW_BIND_ANON_DN 0x0004U /* dn should be empty */
1847
1848 #define SLAP_ALLOW_UPDATE_ANON 0x0008U /* allow anonymous updates */
1849 #define SLAP_ALLOW_PROXY_AUTHZ_ANON 0x0010U /* allow anonymous proxyAuthz */
1850
1851 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
1852 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
1853
1854 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
1855 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
1856
1857 #define SLAP_DISALLOW_AUX_WO_CR 0x4000U
1858
1859 slap_mask_t be_requires; /* pre-operation requirements */
1860 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
1861 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
1862 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
1863 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
1864 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
1865
1866 /* Required Security Strength Factor */
1867 slap_ssf_set_t be_ssf_set;
1868
1869 BerVarray be_suffix; /* the DN suffixes of data in this backend */
1870 BerVarray be_nsuffix; /* the normalized DN suffixes in this backend */
1871 struct berval be_schemadn; /* per-backend subschema subentry DN */
1872 struct berval be_schemandn; /* normalized subschema DN */
1873 struct berval be_rootdn; /* the magic "root" name (DN) for this db */
1874 struct berval be_rootndn; /* the magic "root" normalized name (DN) for this db */
1875 struct berval be_rootpw; /* the magic "root" password for this db */
1876 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
1877 #define be_sizelimit be_def_limit.lms_s_soft
1878 #define be_timelimit be_def_limit.lms_t_soft
1879 struct slap_limits_set be_def_limit; /* default limits */
1880 struct slap_limits **be_limits; /* regex-based size and time limits */
1881 AccessControl *be_acl; /* access control list for this backend */
1882 slap_access_t be_dfltaccess; /* access given if no acl matches */
1883
1884 /* Replica Information */
1885 struct berval be_update_ndn; /* allowed to make changes (in replicas) */
1886 BerVarray be_update_refs; /* where to refer modifying clients to */
1887 struct be_pcl *be_pending_csn_list;
1888 ldap_pvt_thread_mutex_t be_pcl_mutex;
1889 ldap_pvt_thread_mutex_t *be_pcl_mutexp;
1890 struct syncinfo_s *be_syncinfo; /* For syncrepl */
1891
1892 void *be_pb; /* Netscape plugin */
1893 struct ConfigOCs *be_cf_ocs;
1894
1895 void *be_private; /* anything the backend database needs */
1896 LDAP_STAILQ_ENTRY(BackendDB) be_next;
1897 };
1898
1899 /* Backend function typedefs */
1900 typedef int (BI_bi_func) LDAP_P((BackendInfo *bi));
1901 typedef BI_bi_func BI_init;
1902 typedef BI_bi_func BI_open;
1903 typedef BI_bi_func BI_close;
1904 typedef BI_bi_func BI_destroy;
1905 typedef int (BI_config) LDAP_P((BackendInfo *bi,
1906 const char *fname, int lineno,
1907 int argc, char **argv));
1908
1909 typedef struct config_reply_s ConfigReply; /* config.h */
1910 typedef int (BI_db_func) LDAP_P((Backend *bd, ConfigReply *cr));
1911 typedef BI_db_func BI_db_init;
1912 typedef BI_db_func BI_db_open;
1913 typedef BI_db_func BI_db_close;
1914 typedef BI_db_func BI_db_destroy;
1915 typedef int (BI_db_config) LDAP_P((Backend *bd,
1916 const char *fname, int lineno,
1917 int argc, char **argv));
1918
1919 typedef struct req_bind_s {
1920 int rb_method;
1921 struct berval rb_cred;
1922 struct berval rb_edn;
1923 slap_ssf_t rb_ssf;
1924 struct berval rb_mech;
1925 } req_bind_s;
1926
1927 typedef struct req_search_s {
1928 int rs_scope;
1929 int rs_deref;
1930 int rs_slimit;
1931 int rs_tlimit;
1932 /* NULL means be_isroot evaluated to TRUE */
1933 struct slap_limits_set *rs_limit;
1934 int rs_attrsonly;
1935 AttributeName *rs_attrs;
1936 Filter *rs_filter;
1937 struct berval rs_filterstr;
1938 } req_search_s;
1939
1940 typedef struct req_compare_s {
1941 AttributeAssertion *rs_ava;
1942 } req_compare_s;
1943
1944 typedef struct req_modifications_s {
1945 Modifications *rs_modlist;
1946 char rs_no_opattrs; /* don't att modify operational attrs */
1947 } req_modifications_s;
1948
1949 typedef struct req_modify_s {
1950 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */
1951 int rs_increment;
1952 } req_modify_s;
1953
1954 typedef struct req_modrdn_s {
1955 req_modifications_s rs_mods; /* NOTE: must be first in req_modify_s & req_modrdn_s */
1956 int rs_deleteoldrdn;
1957 struct berval rs_newrdn;
1958 struct berval rs_nnewrdn;
1959 struct berval *rs_newSup;
1960 struct berval *rs_nnewSup;
1961 } req_modrdn_s;
1962
1963 typedef struct req_add_s {
1964 Modifications *rs_modlist;
1965 Entry *rs_e;
1966 } req_add_s;
1967
1968 typedef struct req_abandon_s {
1969 ber_int_t rs_msgid;
1970 } req_abandon_s;
1971
1972 #ifdef LDAP_DEVEL
1973 #define SLAP_EXOP_HIDE 0x0000
1974 #else
1975 #define SLAP_EXOP_HIDE 0x8000
1976 #endif
1977 #define SLAP_EXOP_WRITES 0x0001 /* Exop does writes */
1978
1979 typedef struct req_extended_s {
1980 struct berval rs_reqoid;
1981 int rs_flags;
1982 struct berval *rs_reqdata;
1983 } req_extended_s;
1984
1985 typedef struct req_pwdexop_s {
1986 struct req_extended_s rs_extended;
1987 struct berval rs_old;
1988 struct berval rs_new;
1989 Modifications *rs_mods;
1990 Modifications **rs_modtail;
1991 } req_pwdexop_s;
1992
1993 typedef enum slap_reply_e {
1994 REP_RESULT,
1995 REP_SASL,
1996 REP_EXTENDED,
1997 REP_SEARCH,
1998 REP_SEARCHREF,
1999 REP_INTERMEDIATE,
2000 REP_GLUE_RESULT
2001 } slap_reply_t;
2002
2003 typedef struct rep_sasl_s {
2004 struct berval *r_sasldata;
2005 } rep_sasl_s;
2006
2007 typedef struct rep_extended_s {
2008 const char *r_rspoid;
2009 struct berval *r_rspdata;
2010 } rep_extended_s;
2011
2012 typedef struct rep_search_s {
2013 Entry *r_entry;
2014 slap_mask_t r_attr_flags;
2015 #define SLAP_ATTRS_UNDEFINED (0x00U)
2016 #define SLAP_OPATTRS_NO (0x01U)
2017 #define SLAP_OPATTRS_YES (0x02U)
2018 #define SLAP_USERATTRS_NO (0x10U)
2019 #define SLAP_USERATTRS_YES (0x20U)
2020 #define SLAP_OPATTRS_MASK(f) ((f) & (SLAP_OPATTRS_NO|SLAP_OPATTRS_YES))
2021 #define SLAP_OPATTRS(f) (((f) & SLAP_OPATTRS_YES) == SLAP_OPATTRS_YES)
2022 #define SLAP_USERATTRS_MASK(f) ((f) & (SLAP_USERATTRS_NO|SLAP_USERATTRS_YES))
2023 #define SLAP_USERATTRS(f) \
2024 (((f) & SLAP_USERATTRS_YES) == SLAP_USERATTRS_YES)
2025
2026 Attribute *r_operational_attrs;
2027 AttributeName *r_attrs;
2028 int r_nentries;
2029 BerVarray r_v2ref;
2030 } rep_search_s;
2031
2032 struct SlapReply {
2033 slap_reply_t sr_type;
2034 ber_tag_t sr_tag;
2035 ber_int_t sr_msgid;
2036 ber_int_t sr_err;
2037 const char *sr_matched;
2038 const char *sr_text;
2039 BerVarray sr_ref;
2040 LDAPControl **sr_ctrls;
2041 union sr_u {
2042 rep_sasl_s sru_sasl;
2043 rep_extended_s sru_extended;
2044 rep_search_s sru_search;
2045 } sr_un;
2046 slap_mask_t sr_flags;
2047 #define REP_ENTRY_MODIFIABLE 0x0001U
2048 #define REP_ENTRY_MUSTBEFREED 0x0002U
2049 #define REP_ENTRY_MUSTRELEASE 0x0004U
2050 #define REP_ENTRY_MASK (REP_ENTRY_MODIFIABLE|REP_ENTRY_MUSTBEFREED|REP_ENTRY_MUSTRELEASE)
2051
2052 #define REP_MATCHED_MUSTBEFREED 0x0010U
2053 #define REP_MATCHED_MASK (REP_MATCHED_MUSTBEFREED)
2054
2055 #define REP_REF_MUSTBEFREED 0x0020U
2056 #define REP_REF_MASK (REP_REF_MUSTBEFREED)
2057
2058 #define REP_NO_ENTRYDN 0x1000U
2059 #define REP_NO_SUBSCHEMA 0x2000U
2060 #define REP_NO_OPERATIONALS (REP_NO_ENTRYDN|REP_NO_SUBSCHEMA)
2061 };
2062
2063 /* short hands for response members */
2064 #define sr_attrs sr_un.sru_search.r_attrs
2065 #define sr_entry sr_un.sru_search.r_entry
2066 #define sr_operational_attrs sr_un.sru_search.r_operational_attrs
2067 #define sr_attr_flags sr_un.sru_search.r_attr_flags
2068 #define sr_v2ref sr_un.sru_search.r_v2ref
2069 #define sr_nentries sr_un.sru_search.r_nentries
2070 #define sr_rspoid sr_un.sru_extended.r_rspoid
2071 #define sr_rspdata sr_un.sru_extended.r_rspdata
2072 #define sr_sasldata sr_un.sru_sasl.r_sasldata
2073
2074 typedef int (BI_op_func) LDAP_P(( Operation *op, SlapReply *rs ));
2075 typedef BI_op_func BI_op_bind;
2076 typedef BI_op_func BI_op_unbind;
2077 typedef BI_op_func BI_op_search;
2078 typedef BI_op_func BI_op_compare;
2079 typedef BI_op_func BI_op_modify;
2080 typedef BI_op_func BI_op_modrdn;
2081 typedef BI_op_func BI_op_add;
2082 typedef BI_op_func BI_op_delete;
2083 typedef BI_op_func BI_op_abandon;
2084 typedef BI_op_func BI_op_extended;
2085 typedef BI_op_func BI_op_cancel;
2086 typedef BI_op_func BI_chk_referrals;
2087 typedef BI_op_func BI_chk_controls;
2088 typedef int (BI_entry_release_rw)
2089 LDAP_P(( Operation *op, Entry *e, int rw ));
2090 typedef int (BI_entry_get_rw) LDAP_P(( Operation *op, struct berval *ndn,
2091 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e ));
2092 typedef int (BI_operational) LDAP_P(( Operation *op, SlapReply *rs ));
2093 typedef int (BI_has_subordinates) LDAP_P(( Operation *op,
2094 Entry *e, int *hasSubs ));
2095 typedef int (BI_access_allowed) LDAP_P(( Operation *op, Entry *e,
2096 AttributeDescription *desc, struct berval *val, slap_access_t access,
2097 AccessControlState *state, slap_mask_t *maskp ));
2098 typedef int (BI_acl_group) LDAP_P(( Operation *op, Entry *target,
2099 struct berval *gr_ndn, struct berval *op_ndn,
2100 ObjectClass *group_oc, AttributeDescription *group_at ));
2101 typedef int (BI_acl_attribute) LDAP_P(( Operation *op, Entry *target,
2102 struct berval *entry_ndn, AttributeDescription *entry_at,
2103 BerVarray *vals, slap_access_t access ));
2104
2105 typedef int (BI_conn_func) LDAP_P(( BackendDB *bd, Connection *c ));
2106 typedef BI_conn_func BI_connection_init;
2107 typedef BI_conn_func BI_connection_destroy;
2108
2109 typedef int (BI_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
2110 typedef int (BI_tool_entry_close) LDAP_P(( BackendDB *be ));
2111 typedef ID (BI_tool_entry_first) LDAP_P(( BackendDB *be ));
2112 typedef ID (BI_tool_entry_next) LDAP_P(( BackendDB *be ));
2113 typedef Entry* (BI_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
2114 typedef ID (BI_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e,
2115 struct berval *text ));
2116 typedef int (BI_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id, AttributeDescription **adv ));
2117 typedef int (BI_tool_sync) LDAP_P(( BackendDB *be ));
2118 typedef ID (BI_tool_dn2id_get) LDAP_P(( BackendDB *be, struct berval *dn ));
2119 typedef ID (BI_tool_entry_modify) LDAP_P(( BackendDB *be, Entry *e,
2120 struct berval *text ));
2121
2122 struct BackendInfo {
2123 char *bi_type; /* type of backend */
2124
2125 /*
2126 * per backend type routines:
2127 * bi_init: called to allocate a backend_info structure,
2128 * called once BEFORE configuration file is read.
2129 * bi_init() initializes this structure hence is
2130 * called directly from be_initialize()
2131 * bi_config: called per 'backend' specific option
2132 * all such options must before any 'database' options
2133 * bi_config() is called only from read_config()
2134 * bi_open: called to open each database, called
2135 * once AFTER configuration file is read but
2136 * BEFORE any bi_db_open() calls.
2137 * bi_open() is called from backend_startup()
2138 * bi_close: called to close each database, called
2139 * once during shutdown after all bi_db_close calls.
2140 * bi_close() is called from backend_shutdown()
2141 * bi_destroy: called to destroy each database, called
2142 * once during shutdown after all bi_db_destroy calls.
2143 * bi_destory() is called from backend_destroy()
2144 */
2145 BI_init *bi_init;
2146 BI_config *bi_config;
2147 BI_open *bi_open;
2148 BI_close *bi_close;
2149 BI_destroy *bi_destroy;
2150
2151 /*
2152 * per database routines:
2153 * bi_db_init: called to initialize each database,
2154 * called upon reading 'database <type>'
2155 * called only from backend_db_init()
2156 * bi_db_config: called to configure each database,
2157 * called per database to handle per database options
2158 * called only from read_config()
2159 * bi_db_open: called to open each database
2160 * called once per database immediately AFTER bi_open()
2161 * calls but before daemon startup.
2162 * called only by backend_startup()
2163 * bi_db_close: called to close each database
2164 * called once per database during shutdown but BEFORE
2165 * any bi_close call.
2166 * called only by backend_shutdown()
2167 * bi_db_destroy: called to destroy each database
2168 * called once per database during shutdown AFTER all
2169 * bi_close calls but before bi_destory calls.
2170 * called only by backend_destory()
2171 */
2172 BI_db_init *bi_db_init;
2173 BI_db_config *bi_db_config;
2174 BI_db_open *bi_db_open;
2175 BI_db_close *bi_db_close;
2176 BI_db_destroy *bi_db_destroy;
2177
2178 /* LDAP Operations Handling Routines */
2179 BI_op_bind *bi_op_bind;
2180 BI_op_unbind *bi_op_unbind;
2181 BI_op_search *bi_op_search;
2182 BI_op_compare *bi_op_compare;
2183 BI_op_modify *bi_op_modify;
2184 BI_op_modrdn *bi_op_modrdn;
2185 BI_op_add *bi_op_add;
2186 BI_op_delete *bi_op_delete;
2187 BI_op_abandon *bi_op_abandon;
2188
2189 /* Extended Operations Helper */
2190 BI_op_extended *bi_extended;
2191 BI_op_cancel *bi_op_cancel;
2192
2193 /* Auxilary Functions */
2194 BI_operational *bi_operational;
2195 BI_chk_referrals *bi_chk_referrals;
2196 BI_chk_controls *bi_chk_controls;
2197 BI_entry_get_rw *bi_entry_get_rw;
2198 BI_entry_release_rw *bi_entry_release_rw;
2199
2200 BI_has_subordinates *bi_has_subordinates;
2201 BI_access_allowed *bi_access_allowed;
2202 BI_acl_group *bi_acl_group;
2203 BI_acl_attribute *bi_acl_attribute;
2204
2205 BI_connection_init *bi_connection_init;
2206 BI_connection_destroy *bi_connection_destroy;
2207
2208 /* hooks for slap tools */
2209 BI_tool_entry_open *bi_tool_entry_open;
2210 BI_tool_entry_close *bi_tool_entry_close;
2211 BI_tool_entry_first *bi_tool_entry_first;
2212 BI_tool_entry_next *bi_tool_entry_next;
2213 BI_tool_entry_get *bi_tool_entry_get;
2214 BI_tool_entry_put *bi_tool_entry_put;
2215 BI_tool_entry_reindex *bi_tool_entry_reindex;
2216 BI_tool_sync *bi_tool_sync;
2217 BI_tool_dn2id_get *bi_tool_dn2id_get;
2218 BI_tool_entry_modify *bi_tool_entry_modify;
2219
2220 #define SLAP_INDEX_ADD_OP 0x0001
2221 #define SLAP_INDEX_DELETE_OP 0x0002
2222
2223 slap_mask_t bi_flags; /* backend flags */
2224 #define SLAP_BFLAG_MONITOR 0x0001U /* a monitor backend */
2225 #define SLAP_BFLAG_CONFIG 0x0002U /* a config backend */
2226 #define SLAP_BFLAG_FRONTEND 0x0004U /* the frontendDB */
2227 #define SLAP_BFLAG_NOLASTMODCMD 0x0010U
2228 #define SLAP_BFLAG_INCREMENT 0x0100U
2229 #define SLAP_BFLAG_ALIASES 0x1000U
2230 #define SLAP_BFLAG_REFERRALS 0x2000U
2231 #define SLAP_BFLAG_SUBENTRIES 0x4000U
2232 #define SLAP_BFLAG_DYNAMIC 0x8000U
2233
2234 /* overlay specific */
2235 #define SLAPO_BFLAG_SINGLE 0x01000000U
2236 #define SLAPO_BFLAG_DBONLY 0x02000000U
2237 #define SLAPO_BFLAG_GLOBONLY 0x04000000U
2238 #define SLAPO_BFLAG_MASK 0xFF000000U
2239
2240 #define SLAP_BFLAGS(be) ((be)->bd_info->bi_flags)
2241 #define SLAP_MONITOR(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_MONITOR)
2242 #define SLAP_CONFIG(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_CONFIG)
2243 #define SLAP_FRONTEND(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_FRONTEND)
2244 #define SLAP_INCREMENT(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_INCREMENT)
2245 #define SLAP_ALIASES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_ALIASES)
2246 #define SLAP_REFERRALS(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_REFERRALS)
2247 #define SLAP_SUBENTRIES(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_SUBENTRIES)
2248 #define SLAP_DYNAMIC(be) ((SLAP_BFLAGS(be) & SLAP_BFLAG_DYNAMIC) || (SLAP_DBFLAGS(be) & SLAP_DBFLAG_DYNAMIC))
2249 #define SLAP_NOLASTMODCMD(be) (SLAP_BFLAGS(be) & SLAP_BFLAG_NOLASTMODCMD)
2250 #define SLAP_LASTMODCMD(be) (!SLAP_NOLASTMODCMD(be))
2251
2252 /* overlay specific */
2253 #define SLAPO_SINGLE(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_SINGLE)
2254 #define SLAPO_DBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_DBONLY)
2255 #define SLAPO_GLOBONLY(be) (SLAP_BFLAGS(be) & SLAPO_BFLAG_GLOBONLY)
2256
2257 char **bi_controls; /* supported controls */
2258 char bi_ctrls[SLAP_MAX_CIDS + 1];
2259
2260 unsigned int bi_nDB; /* number of databases of this type */
2261 struct ConfigOCs *bi_cf_ocs;
2262 char **bi_obsolete_names;
2263 void *bi_extra; /* backend type-specific APIs */
2264 void *bi_private; /* backend type-specific config data */
2265 LDAP_STAILQ_ENTRY(BackendInfo) bi_next ;
2266 };
2267
2268 #define c_authtype c_authz.sai_method
2269 #define c_authmech c_authz.sai_mech
2270 #define c_dn c_authz.sai_dn
2271 #define c_ndn c_authz.sai_ndn
2272 #define c_ssf c_authz.sai_ssf
2273 #define c_transport_ssf c_authz.sai_transport_ssf
2274 #define c_tls_ssf c_authz.sai_tls_ssf
2275 #define c_sasl_ssf c_authz.sai_sasl_ssf
2276
2277 #define o_authtype o_authz.sai_method
2278 #define o_authmech o_authz.sai_mech
2279 #define o_dn o_authz.sai_dn
2280 #define o_ndn o_authz.sai_ndn
2281 #define o_ssf o_authz.sai_ssf
2282 #define o_transport_ssf o_authz.sai_transport_ssf
2283 #define o_tls_ssf o_authz.sai_tls_ssf
2284 #define o_sasl_ssf o_authz.sai_sasl_ssf
2285
2286 typedef int (slap_response)( Operation *, SlapReply * );
2287
2288 typedef struct slap_callback {
2289 struct slap_callback *sc_next;
2290 slap_response *sc_response;
2291 slap_response *sc_cleanup;
2292 void *sc_private;
2293 } slap_callback;
2294
2295 struct slap_overinfo;
2296
2297 typedef enum slap_operation_e {
2298 op_bind = 0,
2299 op_unbind,
2300 op_search,
2301 op_compare,
2302 op_modify,
2303 op_modrdn,
2304 op_add,
2305 op_delete,
2306 op_abandon,
2307 op_extended,
2308 op_cancel,
2309 op_aux_operational,
2310 op_aux_chk_referrals,
2311 op_aux_chk_controls,
2312 op_last
2313 } slap_operation_t;
2314
2315 typedef struct slap_overinst {
2316 BackendInfo on_bi;
2317 slap_response *on_response;
2318 struct slap_overinfo *on_info;
2319 struct slap_overinst *on_next;
2320 } slap_overinst;
2321
2322 typedef struct slap_overinfo {
2323 BackendInfo oi_bi;
2324 BackendInfo *oi_orig;
2325 BackendDB *oi_origdb;
2326 struct slap_overinst *oi_list;
2327 } slap_overinfo;
2328
2329 /* Should successive callbacks in a chain be processed? */
2330 #define SLAP_CB_FREEME 0x04000
2331 #define SLAP_CB_BYPASS 0x08800
2332 #define SLAP_CB_CONTINUE 0x08000
2333
2334 /*
2335 * Paged Results state
2336 */
2337 typedef unsigned long PagedResultsCookie;
2338 typedef struct PagedResultsState {
2339 Backend *ps_be;
2340 ber_int_t ps_size;
2341 int ps_count;
2342 PagedResultsCookie ps_cookie;
2343 struct berval ps_cookieval;
2344 } PagedResultsState;
2345
2346 struct slap_csn_entry {
2347 struct berval ce_csn;
2348 unsigned long ce_opid;
2349 unsigned long ce_connid;
2350 #define SLAP_CSN_PENDING 1
2351 #define SLAP_CSN_COMMIT 2
2352 long ce_state;
2353 LDAP_TAILQ_ENTRY (slap_csn_entry) ce_csn_link;
2354 };
2355
2356 /*
2357 * Caches the result of a backend_group check for ACL evaluation
2358 */
2359 typedef struct GroupAssertion {
2360 struct GroupAssertion *ga_next;
2361 Backend *ga_be;
2362 ObjectClass *ga_oc;
2363 AttributeDescription *ga_at;
2364 int ga_res;
2365 ber_len_t ga_len;
2366 char ga_ndn[1];
2367 } GroupAssertion;
2368
2369 struct slap_control_ids {
2370 int sc_LDAPsync;
2371 int sc_assert;
2372 int sc_domainScope;
2373 int sc_dontUseCopy;
2374 int sc_manageDSAit;
2375 int sc_modifyIncrement;
2376 int sc_noOp;
2377 int sc_pagedResults;
2378 int sc_permissiveModify;
2379 int sc_postRead;
2380 int sc_preRead;
2381 int sc_proxyAuthz;
2382 int sc_relax;
2383 int sc_searchOptions;
2384 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2385 int sc_sortedResults;
2386 #endif
2387 int sc_subentries;
2388 #ifdef SLAP_CONTROL_X_TREE_DELETE
2389 int sc_treeDelete;
2390 #endif
2391 #ifdef LDAP_X_TXN
2392 int sc_txnSpec;
2393 #endif
2394 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2395 int sc_sessionTracking;
2396 #endif
2397 int sc_valuesReturnFilter;
2398 };
2399
2400 /*
2401 * Operation indices
2402 */
2403 typedef enum {
2404 SLAP_OP_BIND = 0,
2405 SLAP_OP_UNBIND,
2406 SLAP_OP_SEARCH,
2407 SLAP_OP_COMPARE,
2408 SLAP_OP_MODIFY,
2409 SLAP_OP_MODRDN,
2410 SLAP_OP_ADD,
2411 SLAP_OP_DELETE,
2412 SLAP_OP_ABANDON,
2413 SLAP_OP_EXTENDED,
2414 SLAP_OP_LAST
2415 } slap_op_t;
2416
2417 typedef struct slap_counters_t {
2418 struct slap_counters_t *sc_next;
2419 ldap_pvt_thread_mutex_t sc_mutex;
2420 ldap_pvt_mp_t sc_bytes;
2421 ldap_pvt_mp_t sc_pdu;
2422 ldap_pvt_mp_t sc_entries;
2423 ldap_pvt_mp_t sc_refs;
2424
2425 ldap_pvt_mp_t sc_ops_completed;
2426 ldap_pvt_mp_t sc_ops_initiated;
2427 #ifdef SLAPD_MONITOR
2428 ldap_pvt_mp_t sc_ops_completed_[SLAP_OP_LAST];
2429 ldap_pvt_mp_t sc_ops_initiated_[SLAP_OP_LAST];
2430 #endif /* SLAPD_MONITOR */
2431 } slap_counters_t;
2432
2433 /*
2434 * represents an operation pending from an ldap client
2435 */
2436 typedef struct Opheader {
2437 unsigned long oh_opid; /* id of this operation */
2438 unsigned long oh_connid; /* id of conn initiating this op */
2439 Connection *oh_conn; /* connection spawning this op */
2440
2441 ber_int_t oh_msgid; /* msgid of the request */
2442 ber_int_t oh_protocol; /* version of the LDAP protocol used by client */
2443
2444 ldap_pvt_thread_t oh_tid; /* thread handling this op */
2445
2446 void *oh_threadctx; /* thread pool thread context */
2447 void *oh_tmpmemctx; /* slab malloc context */
2448 BerMemoryFunctions *oh_tmpmfuncs;
2449
2450 slap_counters_t *oh_counters;
2451
2452 char oh_log_prefix[ /* sizeof("conn= op=") + 2*LDAP_PVT_INTTYPE_CHARS(unsigned long) */ SLAP_TEXT_BUFLEN ];
2453
2454 #ifdef LDAP_SLAPI
2455 void *oh_extensions; /* NS-SLAPI plugin */
2456 #endif
2457 } Opheader;
2458
2459 typedef union OpRequest {
2460 req_add_s oq_add;
2461 req_bind_s oq_bind;
2462 req_compare_s oq_compare;
2463 req_modify_s oq_modify;
2464 req_modrdn_s oq_modrdn;
2465 req_search_s oq_search;
2466 req_abandon_s oq_abandon;
2467 req_abandon_s oq_cancel;
2468 req_extended_s oq_extended;
2469 req_pwdexop_s oq_pwdexop;
2470 } OpRequest;
2471
2472 /* This is only a header. Actual users should define their own
2473 * structs with the oe_next / oe_key fields at the top and
2474 * whatever else they need following.
2475 */
2476 typedef struct OpExtra {
2477 LDAP_SLIST_ENTRY(OpExtra) oe_next;
2478 void *oe_key;
2479 } OpExtra;
2480
2481 typedef struct OpExtraDB {
2482 OpExtra oe;
2483 BackendDB *oe_db;
2484 } OpExtraDB;
2485
2486 struct Operation {
2487 Opheader *o_hdr;
2488
2489 #define o_opid o_hdr->oh_opid
2490 #define o_connid o_hdr->oh_connid
2491 #define o_conn o_hdr->oh_conn
2492 #define o_msgid o_hdr->oh_msgid
2493 #define o_protocol o_hdr->oh_protocol
2494 #define o_tid o_hdr->oh_tid
2495 #define o_threadctx o_hdr->oh_threadctx
2496 #define o_tmpmemctx o_hdr->oh_tmpmemctx
2497 #define o_tmpmfuncs o_hdr->oh_tmpmfuncs
2498 #define o_counters o_hdr->oh_counters
2499
2500 #define o_tmpalloc o_tmpmfuncs->bmf_malloc
2501 #define o_tmpcalloc o_tmpmfuncs->bmf_calloc
2502 #define o_tmprealloc o_tmpmfuncs->bmf_realloc
2503 #define o_tmpfree o_tmpmfuncs->bmf_free
2504
2505 #define o_log_prefix o_hdr->oh_log_prefix
2506
2507 ber_tag_t o_tag; /* tag of the request */
2508 time_t o_time; /* time op was initiated */
2509 int o_tincr; /* counter for multiple ops with same o_time */
2510
2511 BackendDB *o_bd; /* backend DB processing this op */
2512 struct berval o_req_dn; /* DN of target of request */
2513 struct berval o_req_ndn;
2514
2515 OpRequest o_request;
2516
2517 /* short hands for union members */
2518 #define oq_add o_request.oq_add
2519 #define oq_bind o_request.oq_bind
2520 #define oq_compare o_request.oq_compare
2521 #define oq_modify o_request.oq_modify
2522 #define oq_modrdn o_request.oq_modrdn
2523 #define oq_search o_request.oq_search
2524 #define oq_abandon o_request.oq_abandon
2525 #define oq_cancel o_request.oq_cancel
2526 #define oq_extended o_request.oq_extended
2527 #define oq_pwdexop o_request.oq_pwdexop
2528
2529 /* short hands for inner request members */
2530 #define orb_method oq_bind.rb_method
2531 #define orb_cred oq_bind.rb_cred
2532 #define orb_edn oq_bind.rb_edn
2533 #define orb_ssf oq_bind.rb_ssf
2534 #define orb_mech oq_bind.rb_mech
2535
2536 #define ors_scope oq_search.rs_scope
2537 #define ors_deref oq_search.rs_deref
2538 #define ors_slimit oq_search.rs_slimit
2539 #define ors_tlimit oq_search.rs_tlimit
2540 #define ors_limit oq_search.rs_limit
2541 #define ors_attrsonly oq_search.rs_attrsonly
2542 #define ors_attrs oq_search.rs_attrs
2543 #define ors_filter oq_search.rs_filter
2544 #define ors_filterstr oq_search.rs_filterstr
2545
2546 #define orr_modlist oq_modrdn.rs_mods.rs_modlist
2547 #define orr_no_opattrs oq_modrdn.rs_mods.rs_no_opattrs
2548 #define orr_deleteoldrdn oq_modrdn.rs_deleteoldrdn
2549 #define orr_newrdn oq_modrdn.rs_newrdn
2550 #define orr_nnewrdn oq_modrdn.rs_nnewrdn
2551 #define orr_newSup oq_modrdn.rs_newSup
2552 #define orr_nnewSup oq_modrdn.rs_nnewSup
2553
2554 #define orc_ava oq_compare.rs_ava
2555
2556 #define ora_e oq_add.rs_e
2557 #define ora_modlist oq_add.rs_modlist
2558
2559 #define orn_msgid oq_abandon.rs_msgid
2560
2561 #define orm_modlist oq_modify.rs_mods.rs_modlist
2562 #define orm_no_opattrs oq_modify.rs_mods.rs_no_opattrs
2563 #define orm_increment oq_modify.rs_increment
2564
2565 #define ore_reqoid oq_extended.rs_reqoid
2566 #define ore_flags oq_extended.rs_flags
2567 #define ore_reqdata oq_extended.rs_reqdata
2568 volatile sig_atomic_t o_abandon; /* abandon flag */
2569 volatile sig_atomic_t o_cancel; /* cancel flag */
2570 #define SLAP_CANCEL_NONE 0x00
2571 #define SLAP_CANCEL_REQ 0x01
2572 #define SLAP_CANCEL_ACK 0x02
2573 #define SLAP_CANCEL_DONE 0x03
2574
2575 GroupAssertion *o_groups;
2576 char o_do_not_cache; /* don't cache groups from this op */
2577 char o_is_auth_check; /* authorization in progress */
2578 slap_access_t o_acl_priv;
2579
2580 char o_nocaching;
2581 char o_delete_glue_parent;
2582 char o_no_schema_check;
2583 #define get_no_schema_check(op) ((op)->o_no_schema_check)
2584 char o_no_subordinate_glue;
2585 #define get_no_subordinate_glue(op) ((op)->o_no_subordinate_glue)
2586
2587 #define SLAP_CONTROL_NONE 0
2588 #define SLAP_CONTROL_IGNORED 1
2589 #define SLAP_CONTROL_NONCRITICAL 2
2590 #define SLAP_CONTROL_CRITICAL 3
2591 #define SLAP_CONTROL_MASK 3
2592
2593 /* spare bits for simple flags */
2594 #define SLAP_CONTROL_SHIFT 4 /* shift to reach data bits */
2595 #define SLAP_CONTROL_DATA0 0x10
2596 #define SLAP_CONTROL_DATA1 0x20
2597 #define SLAP_CONTROL_DATA2 0x40
2598 #define SLAP_CONTROL_DATA3 0x80
2599
2600 #define _SCM(x) ((x) & SLAP_CONTROL_MASK)
2601
2602 char o_ctrlflag[SLAP_MAX_CIDS]; /* per-control flags */
2603 void **o_controls; /* per-control state */
2604
2605 #define o_dontUseCopy o_ctrlflag[slap_cids.sc_dontUseCopy]
2606 #define get_dontUseCopy(op) _SCM((op)->o_dontUseCopy)
2607
2608 #define o_relax o_ctrlflag[slap_cids.sc_relax]
2609 #define get_relax(op) _SCM((op)->o_relax)
2610
2611 #define o_managedsait o_ctrlflag[slap_cids.sc_manageDSAit]
2612 #define get_manageDSAit(op) _SCM((op)->o_managedsait)
2613
2614 #define o_noop o_ctrlflag[slap_cids.sc_noOp]
2615 #define o_proxy_authz o_ctrlflag[slap_cids.sc_proxyAuthz]
2616 #define o_subentries o_ctrlflag[slap_cids.sc_subentries]
2617
2618 #define get_subentries(op) _SCM((op)->o_subentries)
2619 #define o_subentries_visibility o_ctrlflag[slap_cids.sc_subentries]
2620
2621 #define set_subentries_visibility(op) ((op)->o_subentries |= SLAP_CONTROL_DATA0)
2622 #define get_subentries_visibility(op) (((op)->o_subentries & SLAP_CONTROL_DATA0) != 0)
2623
2624 #define o_assert o_ctrlflag[slap_cids.sc_assert]
2625 #define get_assert(op) ((int)(op)->o_assert)
2626 #define o_assertion o_controls[slap_cids.sc_assert]
2627 #define get_assertion(op) ((op)->o_assertion)
2628
2629 #define o_valuesreturnfilter o_ctrlflag[slap_cids.sc_valuesReturnFilter]
2630 #define o_vrFilter o_controls[slap_cids.sc_valuesReturnFilter]
2631
2632 #define o_permissive_modify o_ctrlflag[slap_cids.sc_permissiveModify]
2633 #define get_permissiveModify(op) ((int)(op)->o_permissive_modify)
2634
2635 #define o_domain_scope o_ctrlflag[slap_cids.sc_domainScope]
2636 #define get_domainScope(op) ((int)(op)->o_domain_scope)
2637
2638 #ifdef SLAP_CONTROL_X_TREE_DELETE
2639 #define o_tree_delete o_ctrlflag[slap_cids.sc_treeDelete]
2640 #define get_treeDelete(op) ((int)(op)->o_tree_delete)
2641 #endif
2642
2643 #define o_preread o_ctrlflag[slap_cids.sc_preRead]
2644 #define o_postread o_ctrlflag[slap_cids.sc_postRead]
2645
2646 #define o_preread_attrs o_controls[slap_cids.sc_preRead]
2647 #define o_postread_attrs o_controls[slap_cids.sc_postRead]
2648
2649 #define o_pagedresults o_ctrlflag[slap_cids.sc_pagedResults]
2650 #define o_pagedresults_state o_controls[slap_cids.sc_pagedResults]
2651 #define get_pagedresults(op) ((int)(op)->o_pagedresults)
2652
2653 #ifdef SLAP_CONTROL_X_SORTEDRESULTS
2654 #define o_sortedresults o_ctrlflag[slap_cids.sc_sortedResults]
2655 #endif
2656
2657 #ifdef LDAP_X_TXN
2658 #define o_txnSpec o_ctrlflag[slap_cids.sc_txnSpec]
2659 #endif
2660
2661 #ifdef SLAP_CONTROL_X_SESSION_TRACKING
2662 #define o_session_tracking o_ctrlflag[slap_cids.sc_sessionTracking]
2663 #define o_tracked_sessions o_controls[slap_cids.sc_sessionTracking]
2664 #define get_sessionTracking(op) ((int)(op)->o_session_tracking)
2665 #endif
2666
2667 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
2668
2669 AuthorizationInformation o_authz;
2670
2671 BerElement *o_ber; /* ber of the request */
2672 BerElement *o_res_ber; /* ber of the CLDAP reply or readback control */
2673 slap_callback *o_callback; /* callback pointers */
2674 LDAPControl **o_ctrls; /* controls */
2675 struct berval o_csn;
2676
2677 /* DEPRECATE o_private - use o_extra instead */
2678 void *o_private; /* anything the backend needs */
2679 LDAP_SLIST_HEAD(o_e, OpExtra) o_extra; /* anything the backend needs */
2680
2681 LDAP_STAILQ_ENTRY(Operation) o_next; /* next operation in list */
2682 };
2683
2684 typedef struct OperationBuffer {
2685 Operation ob_op;
2686 Opheader ob_hdr;
2687 void *ob_controls[SLAP_MAX_CIDS];
2688 } OperationBuffer;
2689
2690 #define send_ldap_error( op, rs, err, text ) do { \
2691 (rs)->sr_err = err; (rs)->sr_text = text; \
2692 ((op)->o_conn->c_send_ldap_result)( op, rs ); \
2693 } while (0)
2694 #define send_ldap_discon( op, rs, err, text ) do { \
2695 (rs)->sr_err = err; (rs)->sr_text = text; \
2696 send_ldap_disconnect( op, rs ); \
2697 } while (0)
2698
2699 typedef void (SEND_LDAP_RESULT)(
2700 Operation *op, SlapReply *rs);
2701 typedef int (SEND_SEARCH_ENTRY)(
2702 Operation *op, SlapReply *rs);
2703 typedef int (SEND_SEARCH_REFERENCE)(
2704 Operation *op, SlapReply *rs);
2705 typedef void (SEND_LDAP_EXTENDED)(
2706 Operation *op, SlapReply *rs);
2707 typedef void (SEND_LDAP_INTERMEDIATE)(
2708 Operation *op, SlapReply *rs);
2709
2710 #define send_ldap_result( op, rs ) \
2711 ((op)->o_conn->c_send_ldap_result)( op, rs )
2712 #define send_search_entry( op, rs ) \
2713 ((op)->o_conn->c_send_search_entry)( op, rs )
2714 #define send_search_reference( op, rs ) \
2715 ((op)->o_conn->c_send_search_reference)( op, rs )
2716 #define send_ldap_extended( op, rs ) \
2717 ((op)->o_conn->c_send_ldap_extended)( op, rs )
2718 #define send_ldap_intermediate( op, rs ) \
2719 ((op)->o_conn->c_send_ldap_intermediate)( op, rs )
2720
2721 typedef struct slap_listener Listener;
2722
2723 /*
2724 * represents a connection from an ldap client
2725 */
2726 struct Connection {
2727 int c_struct_state; /* structure management state */
2728 int c_conn_state; /* connection state */
2729 int c_conn_idx; /* slot in connections array */
2730 ber_socket_t c_sd;
2731 const char *c_close_reason; /* why connection is closing */
2732
2733 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
2734 Sockbuf *c_sb; /* ber connection stuff */
2735
2736 /* only can be changed by connect_init */
2737 time_t c_starttime; /* when the connection was opened */
2738 time_t c_activitytime; /* when the connection was last used */
2739 unsigned long c_connid; /* id of this connection for stats*/
2740
2741 struct berval c_peer_domain; /* DNS name of client */
2742 struct berval c_peer_name; /* peer name (trans=addr:port) */
2743 Listener *c_listener;
2744 #define c_listener_url c_listener->sl_url /* listener URL */
2745 #define c_sock_name c_listener->sl_name /* sock name (trans=addr:port) */
2746
2747 /* only can be changed by binding thread */
2748 struct berval c_sasl_bind_mech; /* mech in progress */
2749 struct berval c_sasl_dn; /* temporary storage */
2750 struct berval c_sasl_authz_dn; /* SASL proxy authz */
2751
2752 /* authorization backend */
2753 Backend *c_authz_backend;
2754 void *c_authz_cookie;
2755 #define SLAP_IS_AUTHZ_BACKEND( op ) \
2756 ( (op)->o_bd != NULL \
2757 && (op)->o_bd->be_private != NULL \
2758 && (op)->o_conn != NULL \
2759 && (op)->o_conn->c_authz_backend != NULL \
2760 && ( (op)->o_bd->be_private == (op)->o_conn->c_authz_backend->be_private \
2761 || (op)->o_bd->be_private == (op)->o_conn->c_authz_cookie ) )
2762
2763 AuthorizationInformation c_authz;
2764
2765 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
2766
2767 LDAP_STAILQ_HEAD(c_o, Operation) c_ops; /* list of operations being processed */
2768 LDAP_STAILQ_HEAD(c_po, Operation) c_pending_ops; /* list of pending operations */
2769
2770 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
2771 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
2772
2773 BerElement *c_currentber; /* ber we're attempting to read */
2774
2775 char c_sasl_bind_in_progress; /* multi-op bind in progress */
2776
2777 char c_writewaiter; /* true if writer is waiting */
2778
2779 #define CONN_IS_TLS 1
2780 #define CONN_IS_UDP 2
2781 #define CONN_IS_CLIENT 4
2782 #define CONN_IS_IPC 8
2783
2784 #ifdef LDAP_CONNECTIONLESS
2785 char c_is_udp; /* true if this is (C)LDAP over UDP */
2786 #endif
2787 #ifdef HAVE_TLS
2788 char c_is_tls; /* true if this LDAP over raw TLS */
2789 char c_needs_tls_accept; /* true if SSL_accept should be called */
2790 #endif
2791 char c_sasl_layers; /* true if we need to install SASL i/o handlers */
2792 char c_sasl_done; /* SASL completed once */
2793 void *c_sasl_authctx; /* SASL authentication context */
2794 void *c_sasl_sockctx; /* SASL security layer context */
2795 void *c_sasl_extra; /* SASL session extra stuff */
2796 Operation *c_sasl_bindop; /* set to current op if it's a bind */
2797
2798 #ifdef LDAP_X_TXN
2799 #define CONN_TXN_INACTIVE 0
2800 #define CONN_TXN_SPECIFY 1
2801 #define CONN_TXN_SETTLE -1
2802 int c_txn;
2803
2804 Backend *c_txn_backend;
2805 LDAP_STAILQ_HEAD(c_to, Operation) c_txn_ops; /* list of operations in txn */
2806 #endif
2807
2808 PagedResultsState c_pagedresults_state; /* paged result state */
2809
2810 long c_n_ops_received; /* num of ops received (next op_id) */
2811 long c_n_ops_executing; /* num of ops currently executing */
2812 long c_n_ops_pending; /* num of ops pending execution */
2813 long c_n_ops_completed; /* num of ops completed */
2814
2815 long c_n_get; /* num of get calls */
2816 long c_n_read; /* num of read calls */
2817 long c_n_write; /* num of write calls */
2818
2819 void *c_extensions; /* Netscape plugin */
2820
2821 /*
2822 * Client connection handling
2823 */
2824 ldap_pvt_thread_start_t *c_clientfunc;
2825 void *c_clientarg;
2826
2827 /*
2828 * These are the "callbacks" that are available for back-ends to
2829 * supply data back to connected clients that are connected
2830 * through the "front-end".
2831 */
2832 SEND_LDAP_RESULT *c_send_ldap_result;
2833 SEND_SEARCH_ENTRY *c_send_search_entry;
2834 SEND_SEARCH_REFERENCE *c_send_search_reference;
2835 SEND_LDAP_EXTENDED *c_send_ldap_extended;
2836 SEND_LDAP_INTERMEDIATE *c_send_ldap_intermediate;
2837 };
2838
2839 #ifdef LDAP_DEBUG
2840 #ifdef LDAP_SYSLOG
2841 #ifdef LOG_LOCAL4
2842 #define SLAP_DEFAULT_SYSLOG_USER LOG_LOCAL4
2843 #endif /* LOG_LOCAL4 */
2844
2845 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2846 Log5( (level), ldap_syslog_level, (fmt), (connid), (opid), (arg1), (arg2), (arg3) )
2847 #define StatslogTest( level ) ((ldap_debug | ldap_syslog) & (level))
2848 #else /* !LDAP_SYSLOG */
2849 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
2850 do { \
2851 if ( ldap_debug & (level) ) \
2852 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
2853 } while (0)
2854 #define StatslogTest( level ) (ldap_debug & (level))
2855 #endif /* !LDAP_SYSLOG */
2856 #else /* !LDAP_DEBUG */
2857 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) ((void) 0)
2858 #define StatslogTest( level ) (0)
2859 #endif /* !LDAP_DEBUG */
2860
2861 /*
2862 * listener; need to access it from monitor backend
2863 */
2864 struct slap_listener {
2865 struct berval sl_url;
2866 struct berval sl_name;
2867 mode_t sl_perms;
2868 #ifdef HAVE_TLS
2869 int sl_is_tls;
2870 #endif
2871 #ifdef LDAP_CONNECTIONLESS
2872 int sl_is_udp; /* UDP listener is also data port */
2873 #endif
2874 int sl_mute; /* Listener is temporarily disabled due to emfile */
2875 int sl_busy; /* Listener is busy (accept thread activated) */
2876 ber_socket_t sl_sd;
2877 Sockaddr sl_sa;
2878 #define sl_addr sl_sa.sa_in_addr
2879 };
2880
2881 /*
2882 * Better know these all around slapd
2883 */
2884 #define SLAP_LDAPDN_PRETTY 0x1
2885 #define SLAP_LDAPDN_MAXLEN 8192
2886
2887 /* number of response controls supported */
2888 #define SLAP_MAX_RESPONSE_CONTROLS 6
2889
2890 #ifdef LDAP_DEVEL
2891 #define SLAP_CTRL_HIDE 0x00000000U
2892 #else
2893 #define SLAP_CTRL_HIDE 0x80000000U
2894 #endif
2895
2896 #define SLAP_CTRL_REQUIRES_ROOT 0x40000000U /* for Relax */
2897
2898 #define SLAP_CTRL_GLOBAL 0x00800000U
2899 #define SLAP_CTRL_GLOBAL_SEARCH 0x00010000U /* for NOOP */
2900
2901 #define SLAP_CTRL_OPFLAGS 0x0000FFFFU
2902 #define SLAP_CTRL_ABANDON 0x00000001U
2903 #define SLAP_CTRL_ADD 0x00002002U
2904 #define SLAP_CTRL_BIND 0x00000004U
2905 #define SLAP_CTRL_COMPARE 0x00001008U
2906 #define SLAP_CTRL_DELETE 0x00002010U
2907 #define SLAP_CTRL_MODIFY 0x00002020U
2908 #define SLAP_CTRL_RENAME 0x00002040U
2909 #define SLAP_CTRL_SEARCH 0x00001080U
2910 #define SLAP_CTRL_UNBIND 0x00000100U
2911
2912 #define SLAP_CTRL_INTROGATE (SLAP_CTRL_COMPARE|SLAP_CTRL_SEARCH)
2913 #define SLAP_CTRL_UPDATE \
2914 (SLAP_CTRL_ADD|SLAP_CTRL_DELETE|SLAP_CTRL_MODIFY|SLAP_CTRL_RENAME)
2915 #define SLAP_CTRL_ACCESS (SLAP_CTRL_INTROGATE|SLAP_CTRL_UPDATE)
2916
2917 typedef int (SLAP_CTRL_PARSE_FN) LDAP_P((
2918 Operation *op,
2919 SlapReply *rs,
2920 LDAPControl *ctrl ));
2921
2922 typedef int (*SLAP_ENTRY_INFO_FN) LDAP_P(( void *arg, Entry *e ));
2923
2924 #define SLAP_SLAB_SIZE (1024*1024)
2925 #define SLAP_SLAB_STACK 1
2926 #define SLAP_SLAB_SOBLOCK 64
2927
2928 #define SLAP_ZONE_ALLOC 1
2929 #undef SLAP_ZONE_ALLOC
2930
2931 #ifdef LDAP_COMP_MATCH
2932 /*
2933 * Extensible Filter Definition
2934 *
2935 * MatchingRuleAssertion := SEQUENCE {
2936 * matchingRule [1] MatchingRuleId OPTIONAL,
2937 * type [2] AttributeDescription OPTIONAL,
2938 * matchValue [3] AssertionValue,
2939 * dnAttributes [4] BOOLEAN DEFAULT FALSE }
2940 *
2941 * Following ComponentFilter is contained in matchValue
2942 *
2943 * ComponentAssertion ::= SEQUENCE {
2944 * component ComponentReference (SIZE(1..MAX)) OPTIONAL
2945 * useDefaultValues BOOLEAN DEFAULT TRUE,
2946 * rule MATCHING-RULE.&id,
2947 * value MATCHING-RULE.&AssertionType }
2948 *
2949 * ComponentFilter ::= CHOICE {
2950 * item [0] ComponentAssertion,
2951 * and [1] SEQUENCE OF ComponentFilter,
2952 * or [2] SEQUENCE OF ComponentFilter,
2953 * not [3] ComponentFilter }
2954 */
2955
2956 #define LDAP_COMPREF_IDENTIFIER ((ber_tag_t) 0x80U)
2957 #define LDAP_COMPREF_FROM_BEGINNING ((ber_tag_t) 0x81U)
2958 #define LDAP_COMPREF_COUNT ((ber_tag_t) 0x82U)
2959 #define LDAP_COMPREF_FROM_END ((ber_tag_t) 0x83U)
2960 #define LDAP_COMPREF_CONTENT ((ber_tag_t) 0x84U)
2961 #define LDAP_COMPREF_SELECT ((ber_tag_t) 0x85U)
2962 #define LDAP_COMPREF_ALL ((ber_tag_t) 0x86U)
2963 #define LDAP_COMPREF_DEFINED ((ber_tag_t) 0x87U)
2964 #define LDAP_COMPREF_UNDEFINED ((ber_tag_t) 0x88U)
2965
2966 #define LDAP_COMP_FILTER_AND ((ber_tag_t) 0xa0U)
2967 #define LDAP_COMP_FILTER_OR ((ber_tag_t) 0xa1U)
2968 #define LDAP_COMP_FILTER_NOT ((ber_tag_t) 0xa2U)
2969 #define LDAP_COMP_FILTER_ITEM ((ber_tag_t) 0xa3U)
2970 #define LDAP_COMP_FILTER_UNDEFINED ((ber_tag_t) 0xa4U)
2971
2972 typedef struct ComponentId ComponentId;
2973 typedef struct ComponentReference ComponentReference;
2974 typedef struct ComponentAssertion ComponentAssertion;
2975 typedef struct ComponentAssertionValue ComponentAssertionValue;
2976 typedef struct ComponentSyntaxInfo ComponentSyntaxInfo;
2977 typedef struct ComponentDesc ComponentDesc;
2978
2979 struct ComponentData {
2980 void *cd_mem_op; /* nibble memory handler */
2981 ComponentSyntaxInfo** cd_tree; /* component tree */
2982 };
2983
2984 struct ComponentId {
2985 int ci_type;
2986 ComponentId *ci_next;
2987
2988 union comp_id_value{
2989 BerValue ci_identifier;
2990 ber_int_t ci_from_beginning;
2991 ber_int_t ci_count;
2992 ber_int_t ci_from_end;
2993 ber_int_t ci_content;
2994 BerValue ci_select_value;
2995 char ci_all;
2996 } ci_val;
2997 };
2998
2999 struct ComponentReference {
3000 ComponentId *cr_list;
3001 ComponentId *cr_curr;
3002 struct berval cr_string;
3003 int cr_len;
3004 /* Component Indexing */
3005 int cr_asn_type_id;
3006 slap_mask_t cr_indexmask;
3007 AttributeDescription* cr_ad;
3008 BerVarray cr_nvals;
3009 ComponentReference* cr_next;
3010 };
3011
3012 struct ComponentAssertion {
3013 ComponentReference *ca_comp_ref;
3014 ber_int_t ca_use_def;
3015 MatchingRule *ca_ma_rule;
3016 struct berval ca_ma_value;
3017 ComponentData ca_comp_data; /* componentized assertion */
3018 ComponentFilter *ca_cf;
3019 MatchingRuleAssertion *ca_mra;
3020 };
3021
3022 struct ComponentFilter {
3023 ber_tag_t cf_choice;
3024 union cf_un_u {
3025 ber_int_t cf_un_result;
3026 ComponentAssertion *cf_un_ca;
3027 ComponentFilter *cf_un_complex;
3028 } cf_un;
3029
3030 #define cf_ca cf_un.cf_un_ca
3031 #define cf_result cf_un.cf_un_result
3032 #define cf_and cf_un.cf_un_complex
3033 #define cf_or cf_un.cf_un_complex
3034 #define cf_not cf_un.cf_un_complex
3035 #define cf_any cf_un.cf_un_complex
3036
3037 ComponentFilter *cf_next;
3038 };
3039
3040 struct ComponentAssertionValue {
3041 char* cav_buf;
3042 char* cav_ptr;
3043 char* cav_end;
3044 };
3045
3046 typedef int encoder_func LDAP_P((
3047 void* b,
3048 void* comp));
3049
3050 typedef int gser_decoder_func LDAP_P((
3051 void* mem_op,
3052 void* b,
3053 ComponentSyntaxInfo** comp_syn_info,
3054 int* len,
3055 int mode));
3056
3057 typedef int comp_free_func LDAP_P((
3058 void* b));
3059
3060 typedef int ber_decoder_func LDAP_P((
3061 void* mem_op,
3062 void* b,
3063 int tag,
3064 int elmtLen,
3065 ComponentSyntaxInfo* comp_syn_info,
3066 int* len,
3067 int mode));
3068
3069 typedef int ber_tag_decoder_func LDAP_P((
3070 void* mem_op,
3071 void* b,
3072 ComponentSyntaxInfo* comp_syn_info,
3073 int* len,
3074 int mode));
3075
3076 typedef void* extract_component_from_id_func LDAP_P((
3077 void* mem_op,
3078 ComponentReference* cr,
3079 void* comp ));
3080
3081 typedef void* convert_attr_to_comp_func LDAP_P ((
3082 Attribute* a,
3083 Syntax* syn,
3084 struct berval* bv ));
3085
3086 typedef void* alloc_nibble_func LDAP_P ((
3087 int initial_size,
3088 int increment_size ));
3089
3090 typedef void free_nibble_func LDAP_P ((
3091 void* nm ));
3092
3093 typedef void convert_assert_to_comp_func LDAP_P ((
3094 void *mem_op,
3095 ComponentSyntaxInfo* csi_attr,
3096 struct berval* bv,
3097 ComponentSyntaxInfo** csi,
3098 int* len,
3099 int mode ));
3100
3101 typedef int convert_asn_to_ldap_func LDAP_P ((
3102 ComponentSyntaxInfo* csi,
3103 struct berval *bv ));
3104
3105 typedef void free_component_func LDAP_P ((
3106 void* mem_op));
3107
3108 typedef int test_component_func LDAP_P ((
3109 void* attr_mem_op,
3110 void* assert_mem_op,
3111 ComponentSyntaxInfo* csi,
3112 ComponentAssertion* ca));
3113
3114 typedef void* test_membership_func LDAP_P ((
3115 void* in ));
3116
3117 typedef void* get_component_info_func LDAP_P ((
3118 int in ));
3119
3120 typedef int component_encoder_func LDAP_P ((
3121 void* mem_op,
3122 ComponentSyntaxInfo* csi,
3123 struct berval* nvals ));
3124
3125 typedef int allcomponent_matching_func LDAP_P((
3126 char* oid,
3127 ComponentSyntaxInfo* comp1,
3128 ComponentSyntaxInfo* comp));
3129
3130 struct ComponentDesc {
3131 /* Don't change the order of following four fields */
3132 int cd_tag;
3133 AttributeType *cd_comp_type;
3134 struct berval cd_ad_type; /* ad_type, ad_cname */
3135 struct berval cd_ad_cname; /* ad_type, ad_cname */
3136 unsigned cd_flags; /* ad_flags */
3137 int cd_type;
3138 int cd_type_id;
3139 encoder_func *cd_ldap_encoder;
3140 encoder_func *cd_gser_encoder;
3141 encoder_func *cd_ber_encoder;
3142 gser_decoder_func *cd_gser_decoder;
3143 ber_decoder_func *cd_ber_decoder;
3144 comp_free_func *cd_free;
3145 extract_component_from_id_func* cd_extract_i;
3146 allcomponent_matching_func *cd_all_match;
3147 };
3148
3149 struct ComponentSyntaxInfo {
3150 Syntax *csi_syntax;
3151 ComponentDesc *csi_comp_desc;
3152 };
3153
3154 #endif /* LDAP_COMP_MATCH */
3155
3156 /* slab heap data structures */
3157
3158 struct slab_object {
3159 void *so_ptr;
3160 int so_blockhead;
3161 LDAP_LIST_ENTRY(slab_object) so_link;
3162 };
3163
3164 struct slab_heap {
3165 void *sh_base;
3166 void *sh_last;
3167 void *sh_end;
3168 int sh_stack;
3169 int sh_maxorder;
3170 unsigned char **sh_map;
3171 LDAP_LIST_HEAD( sh_freelist, slab_object ) *sh_free;
3172 LDAP_LIST_HEAD( sh_so, slab_object ) sh_sopool;
3173 };
3174
3175 #ifdef SLAP_ZONE_ALLOC
3176 #define SLAP_ZONE_SIZE 0x80000 /* 512KB */
3177 #define SLAP_ZONE_SHIFT 19
3178 #define SLAP_ZONE_INITSIZE 0x800000 /* 8MB */
3179 #define SLAP_ZONE_MAXSIZE 0x80000000/* 2GB */
3180 #define SLAP_ZONE_DELTA 0x800000 /* 8MB */
3181 #define SLAP_ZONE_ZOBLOCK 256
3182
3183 struct zone_object {
3184 void *zo_ptr;
3185 int zo_siz;
3186 int zo_idx;
3187 int zo_blockhead;
3188 LDAP_LIST_ENTRY(zone_object) zo_link;
3189 };
3190
3191 struct zone_latency_history {
3192 double zlh_latency;
3193 LDAP_STAILQ_ENTRY(zone_latency_history) zlh_next;
3194 };
3195
3196 struct zone_heap {
3197 int zh_fd;
3198 int zh_zonesize;
3199 int zh_zoneorder;
3200 int zh_numzones;
3201 int zh_maxzones;
3202 int zh_deltazones;
3203 void **zh_zones;
3204 ldap_pvt_thread_rdwr_t *zh_znlock;
3205 Avlnode *zh_zonetree;
3206 unsigned char ***zh_maps;
3207 int *zh_seqno;
3208 LDAP_LIST_HEAD( zh_freelist, zone_object ) *zh_free;
3209 LDAP_LIST_HEAD( zh_so, zone_object ) zh_zopool;
3210 ldap_pvt_thread_mutex_t zh_mutex;
3211 ldap_pvt_thread_rdwr_t zh_lock;
3212 double zh_ema_latency;
3213 unsigned long zh_ema_samples;
3214 LDAP_STAILQ_HEAD( zh_latency_history, zone_latency_history )
3215 zh_latency_history_queue;
3216 int zh_latency_history_qlen;
3217 int zh_latency_jump;
3218 int zh_swapping;
3219 };
3220 #endif
3221
3222 #define SLAP_BACKEND_INIT_MODULE(b) \
3223 static BackendInfo bi; \
3224 int \
3225 init_module( int argc, char *argv[] ) \
3226 { \
3227 bi.bi_type = #b ; \
3228 bi.bi_init = b ## _back_initialize; \
3229 backend_add( &bi ); \
3230 return 0; \
3231 }
3232
3233 typedef int (OV_init)(void);
3234 typedef struct slap_oinit_t {
3235 const char *ov_type;
3236 OV_init *ov_init;
3237 } OverlayInit;
3238
3239 LDAP_END_DECL
3240
3241 #include "proto-slap.h"
3242
3243 #endif /* _SLAP_H_ */
NetBSD on the FriendlyARM MINI2440