1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include "ldap_defaults.h"
14 #include <ac/stdlib.h>
16 #include <sys/types.h>
17 #include <ac/syslog.h>
19 #include <ac/socket.h>
26 #define ldap_debug slap_debug
33 #include <ldap_schema.h>
35 #include "ldap_pvt_thread.h"
39 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
40 #define SLAPD_ANONYMOUS "cn=anonymous"
43 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
46 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
48 * This is a value used internally by the backends. It is needed to allow
49 * adding values that already exist without getting an error as required by
50 * modrdn when the new rdn was already an attribute value itself.
51 * JCG 05/1999 (gomez@engr.sgi.com)
53 #define SLAP_MOD_SOFTADD 0x1000
59 #define MAXREMATCHES (10)
61 #define SLAP_MAX_WORKER_THREADS (32)
63 #define SLAP_TEXT_BUFLEN (256)
65 /* psuedo error code indicating abandoned operation */
66 #define SLAPD_ABANDON (-1)
68 /* psuedo error code indicating disconnect */
69 #define SLAPD_DISCONNECT (-2)
72 /* We assume "C" locale, that is US-ASCII */
73 #define ASCII_SPACE(c) ( (c) == ' ' )
74 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
75 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
76 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
77 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
78 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
79 #define ASCII_PRINTABLE(c) ( (c) >= ' ' && (c) <= '~' )
81 #define SLAP_NIBBLE(c) ((c)&0x0f)
82 #define SLAP_ESCAPE_CHAR ('\\')
83 #define SLAP_ESCAPE_LO(c) ( "0123456789ABCDEF"[SLAP_NIBBLE(c)] )
84 #define SLAP_ESCAPE_HI(c) ( SLAP_ESCAPE_LO((c)>>4) )
86 #define FILTER_ESCAPE(c) ( (c) == '*' || (c) == '\\' \
87 || (c) == '(' || (c) == ')' || !ASCII_PRINTABLE(c) )
89 #define DN_ESCAPE(c) ((c) == SLAP_ESCAPE_CHAR)
90 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
91 #define RDN_ATTRTYPEANDVALUE_SEPARATOR(c) ((c) == '+') /* RFC 2253 */
92 #define RDN_SEPARATOR(c) (DN_SEPARATOR(c) || RDN_ATTRTYPEANDVALUE_SEPARATOR(c))
93 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
95 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
96 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
97 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
98 #define OID_SEPARATOR(c) ( (c) == '.' )
99 #define OID_CHAR(c) ( OID_LEADCHAR(c) || OID_SEPARATOR(c) )
101 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
102 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
104 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
105 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
107 #define SLAP_NUMERIC(c) ( ASCII_DIGIT(c) || ASCII_SPACE(c) )
109 #define SLAP_PRINTABLE(c) ( ASCII_ALNUM(c) || (c) == '\'' || \
110 (c) == '(' || (c) == ')' || (c) == '+' || (c) == ',' || \
111 (c) == '-' || (c) == '.' || (c) == '/' || (c) == ':' || \
112 (c) == '?' || (c) == ' ' || (c) == '=' )
113 #define SLAP_PRINTABLES(c) ( SLAP_PRINTABLE(c) || (c) == '$' )
115 /* must match in schema_init.c */
116 #define SLAPD_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
117 #define SLAPD_NAMEUID_SYNTAX "1.3.6.1.4.1.1466.115.121.1.34"
118 #define SLAPD_GROUP_ATTR "member"
119 #define SLAPD_GROUP_CLASS "groupOfNames"
120 #define SLAPD_ROLE_ATTR "roleOccupant"
121 #define SLAPD_ROLE_CLASS "organizationalRole"
123 #define SLAPD_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1"
124 #define SLAPD_ACI_ATTR "OpenLDAPaci"
126 #define SLAPD_OCTETSTRING_SYNTAX "1.3.6.1.4.1.1466.115.121.1.40"
128 /* change this to "OpenLDAPset" */
129 #define SLAPD_ACI_SET_ATTR "template"
131 #define SLAPD_TOP_OID "2.5.6.0"
133 LDAP_SLAPD_V (int) slap_debug;
135 typedef unsigned long slap_mask_t;
137 /* Security Strength Factor */
138 typedef unsigned slap_ssf_t;
140 typedef struct slap_ssf_set {
142 slap_ssf_t sss_transport;
145 slap_ssf_t sss_update_ssf;
146 slap_ssf_t sss_update_transport;
147 slap_ssf_t sss_update_tls;
148 slap_ssf_t sss_update_sasl;
154 #define SLAP_INDEX_TYPE 0x00FFUL
155 #define SLAP_INDEX_UNDEFINED 0x0001UL
156 #define SLAP_INDEX_PRESENT 0x0002UL
157 #define SLAP_INDEX_EQUALITY 0x0004UL
158 #define SLAP_INDEX_APPROX 0x0008UL
159 #define SLAP_INDEX_SUBSTR 0x0010UL
160 #define SLAP_INDEX_EXTENDED 0x0020UL
162 #define SLAP_INDEX_DEFAULT SLAP_INDEX_EQUALITY
164 #define IS_SLAP_INDEX(mask, type) (((mask) & (type)) == (type) )
166 #define SLAP_INDEX_SUBSTR_TYPE 0x0F00UL
168 #define SLAP_INDEX_SUBSTR_INITIAL ( SLAP_INDEX_SUBSTR | 0x0100UL )
169 #define SLAP_INDEX_SUBSTR_ANY ( SLAP_INDEX_SUBSTR | 0x0200UL )
170 #define SLAP_INDEX_SUBSTR_FINAL ( SLAP_INDEX_SUBSTR | 0x0400UL )
171 #define SLAP_INDEX_SUBSTR_DEFAULT \
172 ( SLAP_INDEX_SUBSTR \
173 | SLAP_INDEX_SUBSTR_INITIAL \
174 | SLAP_INDEX_SUBSTR_ANY \
175 | SLAP_INDEX_SUBSTR_FINAL )
177 #define SLAP_INDEX_SUBSTR_MINLEN 2
178 #define SLAP_INDEX_SUBSTR_MAXLEN 4
179 #define SLAP_INDEX_SUBSTR_STEP 2
181 #define SLAP_INDEX_FLAGS 0xF000UL
182 #define SLAP_INDEX_NOSUBTYPES 0x1000UL /* don't use index w/ subtypes */
183 #define SLAP_INDEX_NOLANG 0x2000UL /* don't use index w/ lang */
184 #define SLAP_INDEX_AUTO_SUBTYPES 0x4000UL /* use mask with lang subtypes */
187 * there is a single index for each attribute. these prefixes ensure
188 * that there is no collision among keys.
190 #define SLAP_INDEX_EQUALITY_PREFIX '=' /* prefix for equality keys */
191 #define SLAP_INDEX_APPROX_PREFIX '~' /* prefix for approx keys */
192 #define SLAP_INDEX_SUBSTR_PREFIX '*' /* prefix for substring keys */
193 #define SLAP_INDEX_SUBSTR_INITIAL_PREFIX '^'
194 #define SLAP_INDEX_SUBSTR_FINAL_PREFIX '$'
195 #define SLAP_INDEX_CONT_PREFIX '.' /* prefix for continuation keys */
196 #define SLAP_INDEX_UNKNOWN_PREFIX '?' /* prefix for unknown keys */
198 #define SLAP_SYNTAX_MATCHINGRULES_OID "1.3.6.1.4.1.1466.115.121.1.30"
199 #define SLAP_SYNTAX_ATTRIBUTETYPES_OID "1.3.6.1.4.1.1466.115.121.1.3"
200 #define SLAP_SYNTAX_OBJECTCLASSES_OID "1.3.6.1.4.1.1466.115.121.1.37"
203 * represents schema information for a database
205 #define SLAP_SCHERR_OUTOFMEM 1
206 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
207 #define SLAP_SCHERR_CLASS_BAD_USAGE 3
208 #define SLAP_SCHERR_ATTR_NOT_FOUND 4
209 #define SLAP_SCHERR_ATTR_BAD_USAGE 5
210 #define SLAP_SCHERR_DUP_CLASS 6
211 #define SLAP_SCHERR_DUP_ATTR 7
212 #define SLAP_SCHERR_DUP_SYNTAX 8
213 #define SLAP_SCHERR_DUP_RULE 9
214 #define SLAP_SCHERR_NO_NAME 10
215 #define SLAP_SCHERR_ATTR_INCOMPLETE 11
216 #define SLAP_SCHERR_MR_NOT_FOUND 12
217 #define SLAP_SCHERR_SYN_NOT_FOUND 13
218 #define SLAP_SCHERR_MR_INCOMPLETE 14
219 #define SLAP_SCHERR_NOT_SUPPORTED 15
220 #define SLAP_SCHERR_BAD_DESCR 16
222 typedef union slap_sockaddr {
223 struct sockaddr sa_addr;
224 struct sockaddr_in sa_in_addr;
226 struct sockaddr_in6 sa_in6_addr;
229 struct sockaddr_un sa_un_addr;
233 typedef struct slap_oid_macro {
234 struct berval som_oid;
236 struct slap_oid_macro *som_next;
239 /* forward declarations */
241 struct slap_matching_rule;
243 typedef int slap_syntax_validate_func LDAP_P((
244 struct slap_syntax *syntax,
245 struct berval * in));
247 typedef int slap_syntax_transform_func LDAP_P((
248 struct slap_syntax *syntax,
250 struct berval ** out));
252 typedef struct slap_syntax {
254 #define ssyn_oid ssyn_syn.syn_oid
255 #define ssyn_desc ssyn_syn.syn_desc
256 #define ssyn_extensions ssyn_syn.syn_extensions
260 #define SLAP_SYNTAX_NONE 0x00U
261 #define SLAP_SYNTAX_BLOB 0x01U /* syntax treated as blob (audio) */
262 #define SLAP_SYNTAX_BINARY 0x02U /* binary transfer required (certificate) */
263 #define SLAP_SYNTAX_BER 0x04U /* stored using BER encoding (binary,certificate) */
264 #define SLAP_SYNTAX_HIDE 0x80U /* hide (do not publish) */
266 slap_syntax_validate_func *ssyn_validate;
267 slap_syntax_transform_func *ssyn_normalize;
268 slap_syntax_transform_func *ssyn_pretty;
270 #ifdef SLAPD_BINARY_CONVERSION
271 /* convert to and from binary */
272 slap_syntax_transform_func *ssyn_ber2str;
273 slap_syntax_transform_func *ssyn_str2ber;
276 struct slap_syntax *ssyn_next;
279 #define slap_syntax_is_flag(s,flag) ((int)((s)->ssyn_flags & (flag)) ? 1 : 0)
280 #define slap_syntax_is_blob(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BLOB)
281 #define slap_syntax_is_binary(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BINARY)
282 #define slap_syntax_is_ber(s) slap_syntax_is_flag((s),SLAP_SYNTAX_BER)
283 #define slap_syntax_is_hidden(s) slap_syntax_is_flag((s),SLAP_SYNTAX_HIDE)
285 /* X -> Y Converter */
286 typedef int slap_mr_convert_func LDAP_P((
288 struct berval ** out ));
291 typedef int slap_mr_normalize_func LDAP_P((
293 struct slap_syntax *syntax, /* NULL if in is asserted value */
294 struct slap_matching_rule *mr,
296 struct berval ** out ));
298 /* Match (compare) function */
299 typedef int slap_mr_match_func LDAP_P((
302 struct slap_syntax *syntax, /* syntax of stored value */
303 struct slap_matching_rule *mr,
304 struct berval * value,
305 void * assertValue ));
307 /* Index generation function */
308 typedef int slap_mr_indexer_func LDAP_P((
311 struct slap_syntax *syntax, /* syntax of stored value */
312 struct slap_matching_rule *mr,
313 struct berval *prefix,
314 struct berval **values,
315 struct berval ***keys ));
317 /* Filter index function */
318 typedef int slap_mr_filter_func LDAP_P((
321 struct slap_syntax *syntax, /* syntax of stored value */
322 struct slap_matching_rule *mr,
323 struct berval *prefix,
325 struct berval ***keys ));
327 typedef struct slap_matching_rule {
328 LDAPMatchingRule smr_mrule;
329 slap_mask_t smr_usage;
331 #define SLAP_MR_TYPE_MASK 0xFF00U
332 #define SLAP_MR_SUBTYPE_MASK 0x00F0U
333 #define SLAP_MR_USAGE 0x000FU
335 #define SLAP_MR_NONE 0x0000U
336 #define SLAP_MR_EQUALITY 0x0100U
337 #define SLAP_MR_ORDERING 0x0200U
338 #define SLAP_MR_SUBSTR 0x0400U
339 #define SLAP_MR_EXT 0x0800U
341 #define SLAP_MR_EQUALITY_APPROX ( SLAP_MR_EQUALITY | 0x0010U )
342 #define SLAP_MR_DN_FOLD 0x0008U
344 #define SLAP_MR_SUBSTR_INITIAL ( SLAP_MR_SUBSTR | 0x0010U )
345 #define SLAP_MR_SUBSTR_ANY ( SLAP_MR_SUBSTR | 0x0020U )
346 #define SLAP_MR_SUBSTR_FINAL ( SLAP_MR_SUBSTR | 0x0040U )
349 * normally the provided value is expected to conform to
350 * assertion syntax specified in the matching rule, however
351 * at times (such as during individual value modification),
352 * the provided value is expected to conform to the
353 * attribute's value syntax.
355 #define SLAP_MR_ASSERTION_SYNTAX_MATCH 0x0000U
356 #define SLAP_MR_VALUE_SYNTAX_MATCH 0x0001U
357 #define SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH 0x0003U
359 #define SLAP_IS_MR_ASSERTION_SYNTAX_MATCH( usage ) \
360 (!((usage) & SLAP_MR_VALUE_SYNTAX_MATCH))
361 #define SLAP_IS_MR_VALUE_SYNTAX_MATCH( usage ) \
362 ((usage) & SLAP_MR_VALUE_SYNTAX_MATCH)
364 #define SLAP_IS_MR_VALUE_SYNTAX_CONVERTED_MATCH( usage ) \
365 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
366 == SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH)
367 #define SLAP_IS_MR_VALUE_SYNTAX_NONCONVERTED_MATCH( usage ) \
368 (((usage) & SLAP_MR_VALUE_SYNTAX_CONVERTED_MATCH) \
369 == SLAP_MR_VALUE_SYNTAX_MATCH)
372 slap_mr_convert_func *smr_convert;
373 slap_mr_normalize_func *smr_normalize;
374 slap_mr_match_func *smr_match;
375 slap_mr_indexer_func *smr_indexer;
376 slap_mr_filter_func *smr_filter;
378 struct slap_matching_rule *smr_associated;
379 struct slap_matching_rule *smr_next;
381 #define smr_oid smr_mrule.mr_oid
382 #define smr_names smr_mrule.mr_names
383 #define smr_desc smr_mrule.mr_desc
384 #define smr_obsolete smr_mrule.mr_obsolete
385 #define smr_syntax_oid smr_mrule.mr_syntax_oid
386 #define smr_extensions smr_mrule.mr_extensions
389 struct slap_attr_desc;
391 typedef struct slap_attribute_type {
392 LDAPAttributeType sat_atype;
393 struct berval sat_cname;
394 struct slap_attribute_type *sat_sup;
395 struct slap_attribute_type **sat_subtypes;
396 MatchingRule *sat_equality;
397 MatchingRule *sat_approx;
398 MatchingRule *sat_ordering;
399 MatchingRule *sat_substr;
401 struct slap_attr_desc *sat_ad;
402 struct slap_attribute_type *sat_next;
403 ldap_pvt_thread_mutex_t sat_ad_mutex;
404 #define sat_oid sat_atype.at_oid
405 #define sat_names sat_atype.at_names
406 #define sat_desc sat_atype.at_desc
407 #define sat_obsolete sat_atype.at_obsolete
408 #define sat_sup_oid sat_atype.at_sup_oid
409 #define sat_equality_oid sat_atype.at_equality_oid
410 #define sat_ordering_oid sat_atype.at_ordering_oid
411 #define sat_substr_oid sat_atype.at_substr_oid
412 #define sat_syntax_oid sat_atype.at_syntax_oid
413 #define sat_single_value sat_atype.at_single_value
414 #define sat_collective sat_atype.at_collective
415 #define sat_no_user_mod sat_atype.at_no_user_mod
416 #define sat_usage sat_atype.at_usage
417 #define sat_extensions sat_atype.at_extensions
420 #define is_at_operational(at) ((at)->sat_usage)
421 #define is_at_single_value(at) ((at)->sat_single_value)
422 #define is_at_collective(at) ((at)->sat_collective)
423 #define is_at_obsolete(at) ((at)->sat_obsolete)
424 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
426 typedef struct slap_object_class {
427 LDAPObjectClass soc_oclass;
428 struct slap_object_class **soc_sups;
429 AttributeType **soc_required;
430 AttributeType **soc_allowed;
431 struct slap_object_class *soc_next;
432 #define soc_oid soc_oclass.oc_oid
433 #define soc_names soc_oclass.oc_names
434 #define soc_desc soc_oclass.oc_desc
435 #define soc_obsolete soc_oclass.oc_obsolete
436 #define soc_sup_oids soc_oclass.oc_sup_oids
437 #define soc_kind soc_oclass.oc_kind
438 #define soc_at_oids_must soc_oclass.oc_at_oids_must
439 #define soc_at_oids_may soc_oclass.oc_at_oids_may
440 #define soc_extensions soc_oclass.oc_extensions
445 * represents a recognized attribute description ( type + options )
447 typedef struct slap_attr_desc {
448 struct slap_attr_desc *ad_next;
449 AttributeType *ad_type; /* attribute type, must be specified */
450 struct berval ad_cname; /* canonical name, must be specified */
451 struct berval ad_lang; /* empty if no language tags */
453 #define SLAP_DESC_NONE 0x0U
454 #define SLAP_DESC_BINARY 0x1U
455 } AttributeDescription;
457 #define slap_ad_is_lang(ad) ( (ad)->ad_lang.bv_len != 0 )
458 #define slap_ad_is_binary(ad) ( (int)((ad)->ad_flags & SLAP_DESC_BINARY) ? 1 : 0 )
461 * pointers to schema elements used internally
463 struct slap_internal_schema {
465 ObjectClass *si_oc_top;
466 ObjectClass *si_oc_extensibleObject;
467 ObjectClass *si_oc_alias;
468 ObjectClass *si_oc_referral;
469 ObjectClass *si_oc_subentry;
470 ObjectClass *si_oc_subschema;
471 ObjectClass *si_oc_rootdse;
473 /* objectClass attribute descriptions */
474 AttributeDescription *si_ad_objectClass;
476 /* operational attribute descriptions */
477 AttributeDescription *si_ad_structuralObjectClass;
478 AttributeDescription *si_ad_entryUUID;
479 AttributeDescription *si_ad_entryCSN;
480 AttributeDescription *si_ad_creatorsName;
481 AttributeDescription *si_ad_createTimestamp;
482 AttributeDescription *si_ad_modifiersName;
483 AttributeDescription *si_ad_modifyTimestamp;
484 AttributeDescription *si_ad_hasSubordinates;
485 AttributeDescription *si_ad_subschemaSubentry;
487 /* root DSE attribute descriptions */
488 AttributeDescription *si_ad_namingContexts;
489 AttributeDescription *si_ad_supportedControl;
490 AttributeDescription *si_ad_supportedExtension;
491 AttributeDescription *si_ad_supportedLDAPVersion;
492 AttributeDescription *si_ad_supportedSASLMechanisms;
493 AttributeDescription *si_ad_supportedFeatures;
495 /* subschema subentry attribute descriptions */
496 AttributeDescription *si_ad_objectClasses;
497 AttributeDescription *si_ad_attributeTypes;
498 AttributeDescription *si_ad_ldapSyntaxes;
499 AttributeDescription *si_ad_matchingRules;
500 AttributeDescription *si_ad_matchingRulesUse;
502 /* Aliases & Referrals */
503 AttributeDescription *si_ad_aliasedObjectName;
504 AttributeDescription *si_ad_ref;
506 /* Access Control Internals */
507 AttributeDescription *si_ad_entry;
508 AttributeDescription *si_ad_children;
509 #ifdef SLAPD_ACI_ENABLED
510 AttributeDescription *si_ad_aci;
513 /* Other attributes descriptions */
514 AttributeDescription *si_ad_userPassword;
515 AttributeDescription *si_ad_authPassword;
516 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
517 AttributeDescription *si_ad_krbName;
520 /* Undefined Attribute Type */
521 AttributeType *si_at_undefined;
524 MatchingRule *si_mr_distinguishedNameMatch;
525 MatchingRule *si_mr_integerMatch;
528 Syntax *si_syn_distinguishedName;
529 Syntax *si_syn_integer;
532 typedef struct slap_attr_assertion {
533 AttributeDescription *aa_desc;
534 struct berval *aa_value;
535 } AttributeAssertion;
537 typedef struct slap_ss_assertion {
538 AttributeDescription *sa_desc;
539 struct berval *sa_initial;
540 struct berval **sa_any;
541 struct berval *sa_final;
542 } SubstringsAssertion;
544 typedef struct slap_mr_assertion {
545 MatchingRule *ma_rule; /* optional */
546 char *ma_rule_text; /* optional */
547 AttributeDescription *ma_desc; /* optional */
548 int ma_dnattrs; /* boolean */
549 struct berval *ma_value; /* required */
550 } MatchingRuleAssertion;
553 * represents a search filter
555 typedef struct slap_filter {
556 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
557 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) -1)
558 #define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
559 #define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
562 /* precomputed result */
563 ber_int_t f_un_result;
569 AttributeDescription *f_un_desc;
571 /* simple value assertion */
572 AttributeAssertion *f_un_ava;
574 /* substring assertion */
575 SubstringsAssertion *f_un_ssa;
577 /* matching rule assertion */
578 MatchingRuleAssertion *f_un_mra;
580 #define f_dn f_un.f_un_dn
581 #define f_desc f_un.f_un_desc
582 #define f_ava f_un.f_un_ava
583 #define f_av_desc f_un.f_un_ava->aa_desc
584 #define f_av_value f_un.f_un_ava->aa_value
585 #define f_sub f_un.f_un_ssa
586 #define f_sub_desc f_un.f_un_ssa->sa_desc
587 #define f_sub_initial f_un.f_un_ssa->sa_initial
588 #define f_sub_any f_un.f_un_ssa->sa_any
589 #define f_sub_final f_un.f_un_ssa->sa_final
590 #define f_mra f_un.f_un_mra
591 #define f_mr_rule f_un.f_un_mra->ma_rule
592 #define f_mr_rule_text f_un.f_un_mra->ma_rule_text
593 #define f_mr_desc f_un.f_un_mra->ma_desc
594 #define f_mr_value f_un.f_un_mra->ma_value
595 #define f_mr_dnattrs f_un.f_un_mra->ma_dnattrs
598 struct slap_filter *f_un_complex;
601 #define f_result f_un.f_un_result
602 #define f_and f_un.f_un_complex
603 #define f_or f_un.f_un_complex
604 #define f_not f_un.f_un_complex
605 #define f_list f_un.f_un_complex
607 struct slap_filter *f_next;
610 /* compare routines can return undefined */
611 #define SLAPD_COMPARE_UNDEFINED ((ber_int_t) -1)
614 * represents an attribute (description + values)
616 typedef struct slap_attr {
617 AttributeDescription *a_desc;
618 struct berval **a_vals;
619 struct slap_attr *a_next;
624 * the id used in the indexes to refer to an entry
626 typedef unsigned long ID;
627 #define NOID ((ID)~0)
630 * represents an entry in core
632 typedef struct slap_entry {
634 * The ID field should only be changed before entry is
635 * inserted into a cache. The ID value is backend
640 char *e_dn; /* DN of this entry */
641 char *e_ndn; /* normalized DN of this entry */
642 Attribute *e_attrs; /* list of attributes + values */
644 /* for use by the backend for any purpose */
651 typedef struct slap_mod {
653 AttributeDescription *sm_desc;
654 struct berval **sm_bvalues;
657 typedef struct slap_mod_list {
658 Modification sml_mod;
659 #define sml_op sml_mod.sm_op
660 #define sml_desc sml_mod.sm_desc
661 #define sml_bvalues sml_mod.sm_bvalues
662 struct slap_mod_list *sml_next;
665 typedef struct slap_ldap_modlist {
667 struct slap_ldap_modlist *ml_next;
668 #define ml_op ml_mod.mod_op
669 #define ml_type ml_mod.mod_type
670 #define ml_values ml_mod.mod_values
671 #define ml_bvalues ml_mod.mod_bvalues
675 * represents an access control list
677 typedef enum slap_access_e {
678 ACL_INVALID_ACCESS = -1,
687 typedef enum slap_control_e {
688 ACL_INVALID_CONTROL = 0,
694 typedef enum slap_style_e {
702 /* alternate names */
703 ACL_STYLE_EXACT = ACL_STYLE_BASE
706 typedef struct slap_authz_info {
707 ber_tag_t sai_method; /* LDAP_AUTH_* from <ldap.h> */
708 char * sai_mech; /* SASL Mechanism */
709 struct berval sai_dn; /* DN for reporting purposes */
710 struct berval sai_ndn; /* Normalized DN */
712 /* Security Strength Factors */
713 slap_ssf_t sai_ssf; /* Overall SSF */
714 slap_ssf_t sai_transport_ssf; /* Transport SSF */
715 slap_ssf_t sai_tls_ssf; /* TLS SSF */
716 slap_ssf_t sai_sasl_ssf; /* SASL SSF */
717 } AuthorizationInformation;
720 typedef struct slap_access {
721 slap_control_t a_type;
723 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
725 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
726 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
727 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
728 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
729 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
730 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
732 #define ACL_PRIV_MASK 0x00ffUL
735 #define ACL_PRIV_LEVEL 0x1000UL
736 #define ACL_PRIV_ADDITIVE 0x2000UL
737 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
740 #define ACL_PRIV_INVALID 0x0UL
742 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
743 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
744 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
745 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
747 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
748 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
750 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
752 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
754 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
755 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
756 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
758 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
759 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
760 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
761 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
762 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
763 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
765 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
766 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
767 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
768 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
769 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
770 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
771 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
773 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
774 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
775 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
776 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
777 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
778 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
780 slap_mask_t a_access_mask;
782 AuthorizationInformation a_authz;
783 #define a_dn_pat a_authz.sai_dn
785 slap_style_t a_dn_style;
786 AttributeDescription *a_dn_at;
789 slap_style_t a_peername_style;
790 char *a_peername_pat;
791 slap_style_t a_sockname_style;
792 char *a_sockname_pat;
794 slap_style_t a_domain_style;
796 slap_style_t a_sockurl_style;
798 slap_style_t a_set_style;
799 struct berval a_set_pat;
801 #ifdef SLAPD_ACI_ENABLED
802 AttributeDescription *a_aci_at;
806 slap_style_t a_group_style;
808 ObjectClass *a_group_oc;
809 AttributeDescription *a_group_at;
811 struct slap_access *a_next;
815 typedef struct slap_acl {
816 /* "to" part: the entries this acl applies to */
818 slap_style_t acl_dn_style;
820 struct berval acl_dn_pat;
823 /* "by" part: list of who has what access to the entries */
826 struct slap_acl *acl_next;
830 * replog moddn param structure
832 struct replog_moddn {
840 * represents a backend
843 typedef struct slap_backend_info BackendInfo; /* per backend type */
844 typedef struct slap_backend_db BackendDB; /* per backend database */
846 LDAP_SLAPD_V (int) nBackendInfo;
847 LDAP_SLAPD_V (int) nBackendDB;
848 LDAP_SLAPD_V (BackendInfo *) backendInfo;
849 LDAP_SLAPD_V (BackendDB *) backendDB;
851 LDAP_SLAPD_V (int) slapMode;
852 #define SLAP_UNDEFINED_MODE 0x0000
853 #define SLAP_SERVER_MODE 0x0001
854 #define SLAP_TOOL_MODE 0x0002
855 #define SLAP_MODE 0x0003
857 #define SLAP_TRUNCATE_MODE 0x0100
859 struct slap_replica_info {
860 char *ri_host; /* supersedes be_replica */
861 char **ri_nsuffix; /* array of suffixes this replica accepts */
864 struct slap_limits_set {
876 int lm_type; /* type of pattern */
877 #define SLAP_LIMITS_UNDEFINED 0x0000
878 #define SLAP_LIMITS_EXACT 0x0001
879 #define SLAP_LIMITS_BASE SLAP_LIMITS_EXACT
880 #define SLAP_LIMITS_ONE 0x0002
881 #define SLAP_LIMITS_SUBTREE 0x0003
882 #define SLAP_LIMITS_CHILDREN 0x0004
883 #define SLAP_LIMITS_REGEX 0x0005
884 #define SLAP_LIMITS_ANONYMOUS 0x0006
885 #define SLAP_LIMITS_USERS 0x0007
886 regex_t lm_dn_regex; /* regex data for REGEX */
887 struct berval *lm_dn_pat; /* ndn for EXACT, BASE, ONE, SUBTREE,
888 * CHILDREN; pattern for REGEX; NULL
889 * for ANONYMOUS, USERS */
890 struct slap_limits_set lm_limits;
893 /* temporary aliases */
894 typedef BackendDB Backend;
895 #define nbackends nBackendDB
896 #define backends backendDB
898 struct slap_backend_db {
899 BackendInfo *bd_info; /* pointer to shared backend info */
901 /* BackendInfo accessors */
902 #define be_config bd_info->bi_db_config
903 #define be_type bd_info->bi_type
905 #define be_bind bd_info->bi_op_bind
906 #define be_unbind bd_info->bi_op_unbind
907 #define be_add bd_info->bi_op_add
908 #define be_compare bd_info->bi_op_compare
909 #define be_delete bd_info->bi_op_delete
910 #define be_modify bd_info->bi_op_modify
911 #define be_modrdn bd_info->bi_op_modrdn
912 #define be_search bd_info->bi_op_search
914 #define be_extended bd_info->bi_extended
916 #define be_release bd_info->bi_entry_release_rw
917 #define be_chk_referrals bd_info->bi_chk_referrals
918 #define be_group bd_info->bi_acl_group
919 #define be_attribute bd_info->bi_acl_attribute
920 #define be_operational bd_info->bi_operational
922 #define be_controls bd_info->bi_controls
924 #define be_connection_init bd_info->bi_connection_init
925 #define be_connection_destroy bd_info->bi_connection_destroy
928 #define be_entry_open bd_info->bi_tool_entry_open
929 #define be_entry_close bd_info->bi_tool_entry_close
930 #define be_entry_first bd_info->bi_tool_entry_first
931 #define be_entry_next bd_info->bi_tool_entry_next
932 #define be_entry_reindex bd_info->bi_tool_entry_reindex
933 #define be_entry_get bd_info->bi_tool_entry_get
934 #define be_entry_put bd_info->bi_tool_entry_put
935 #define be_sync bd_info->bi_tool_sync
938 slap_mask_t be_restrictops; /* restriction operations */
939 #define SLAP_RESTRICT_OP_ADD 0x0001U
940 #define SLAP_RESTRICT_OP_BIND 0x0002U
941 #define SLAP_RESTRICT_OP_COMPARE 0x0004U
942 #define SLAP_RESTRICT_OP_DELETE 0x0008U
943 #define SLAP_RESTRICT_OP_EXTENDED 0x0010U
944 #define SLAP_RESTRICT_OP_MODIFY 0x0020U
945 #define SLAP_RESTRICT_OP_RENAME 0x0040U
946 #define SLAP_RESTRICT_OP_SEARCH 0x0080U
948 #define SLAP_RESTRICT_OP_READS \
949 ( SLAP_RESTRICT_OP_COMPARE \
950 | SLAP_RESTRICT_OP_SEARCH )
951 #define SLAP_RESTRICT_OP_WRITES \
952 ( SLAP_RESTRICT_OP_ADD \
953 | SLAP_RESTRICT_OP_DELETE \
954 | SLAP_RESTRICT_OP_MODIFY \
955 | SLAP_RESTRICT_OP_RENAME )
957 #define SLAP_ALLOW_BIND_V2 0x0001U /* LDAPv2 bind */
958 #define SLAP_ALLOW_BIND_ANON_CRED 0x0002U /* cred should be empty */
959 #define SLAP_ALLOW_BIND_ANON_DN 0x0003U /* dn should be empty */
961 #define SLAP_DISALLOW_BIND_ANON 0x0001U /* no anonymous */
962 #define SLAP_DISALLOW_BIND_SIMPLE 0x0002U /* simple authentication */
963 #define SLAP_DISALLOW_BIND_KRBV4 0x0004U /* Kerberos V4 authentication */
965 #define SLAP_DISALLOW_TLS_2_ANON 0x0010U /* StartTLS -> Anonymous */
966 #define SLAP_DISALLOW_TLS_AUTHC 0x0020U /* TLS while authenticated */
968 slap_mask_t be_requires; /* pre-operation requirements */
969 #define SLAP_REQUIRE_BIND 0x0001U /* bind before op */
970 #define SLAP_REQUIRE_LDAP_V3 0x0002U /* LDAPv3 before op */
971 #define SLAP_REQUIRE_AUTHC 0x0004U /* authentication before op */
972 #define SLAP_REQUIRE_SASL 0x0008U /* SASL before op */
973 #define SLAP_REQUIRE_STRONG 0x0010U /* strong authentication before op */
975 /* Required Security Strength Factor */
976 slap_ssf_set_t be_ssf_set;
978 /* these should be renamed from be_ to bd_ */
979 char **be_suffix; /* the DN suffixes of data in this backend */
980 struct berval **be_nsuffix; /* the normalized DN suffixes in this backend */
981 struct berval **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
982 char *be_root_dn; /* the magic "root" dn for this db */
983 char *be_root_ndn; /* the magic "root" normalized dn for this db */
984 struct berval be_root_pw; /* the magic "root" password for this db */
985 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
986 #define be_sizelimit be_def_limit.lms_s_soft
987 #define be_timelimit be_def_limit.lms_t_soft
988 struct slap_limits_set be_def_limit; /* default limits */
989 struct slap_limits **be_limits; /* regex-based size and time limits */
990 AccessControl *be_acl; /* access control list for this backend */
991 slap_access_t be_dfltaccess; /* access given if no acl matches */
992 struct slap_replica_info **be_replica; /* replicas of this backend (in master) */
993 char *be_replogfile; /* replication log file (in master) */
994 char *be_update_ndn; /* allowed to make changes (in replicas) */
995 struct berval **be_update_refs; /* where to refer modifying clients to */
996 int be_lastmod; /* keep track of lastmodified{by,time} */
998 #define SLAP_GLUE_INSTANCE 0x01 /* a glue backend */
999 #define SLAP_GLUE_SUBORDINATE 0x02 /* child of a glue hierarchy */
1000 #define SLAP_GLUE_LINKED 0x04 /* child is connected to parent */
1002 int be_glueflags; /* */
1006 void *be_private; /* anything the backend database needs */
1012 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
1014 struct slap_conn *conn,
1017 struct berval * reqdata,
1019 struct berval ** rspdata,
1020 LDAPControl *** rspctrls,
1022 struct berval *** refs ));
1024 struct slap_backend_info {
1025 char *bi_type; /* type of backend */
1028 * per backend type routines:
1029 * bi_init: called to allocate a backend_info structure,
1030 * called once BEFORE configuration file is read.
1031 * bi_init() initializes this structure hence is
1032 * called directly from be_initialize()
1033 * bi_config: called per 'backend' specific option
1034 * all such options must before any 'database' options
1035 * bi_config() is called only from read_config()
1036 * bi_open: called to open each database, called
1037 * once AFTER configuration file is read but
1038 * BEFORE any bi_db_open() calls.
1039 * bi_open() is called from backend_startup()
1040 * bi_close: called to close each database, called
1041 * once during shutdown after all bi_db_close calls.
1042 * bi_close() is called from backend_shutdown()
1043 * bi_destroy: called to destroy each database, called
1044 * once during shutdown after all bi_db_destroy calls.
1045 * bi_destory() is called from backend_destroy()
1047 int (*bi_init) LDAP_P((BackendInfo *bi));
1048 int (*bi_config) LDAP_P((BackendInfo *bi,
1049 const char *fname, int lineno, int argc, char **argv ));
1050 int (*bi_open) LDAP_P((BackendInfo *bi));
1051 int (*bi_close) LDAP_P((BackendInfo *bi));
1052 int (*bi_destroy) LDAP_P((BackendInfo *bi));
1055 * per database routines:
1056 * bi_db_init: called to initialize each database,
1057 * called upon reading 'database <type>'
1058 * called only from backend_db_init()
1059 * bi_db_config: called to configure each database,
1060 * called per database to handle per database options
1061 * called only from read_config()
1062 * bi_db_open: called to open each database
1063 * called once per database immediately AFTER bi_open()
1064 * calls but before daemon startup.
1065 * called only by backend_startup()
1066 * bi_db_close: called to close each database
1067 * called once per database during shutdown but BEFORE
1068 * any bi_close call.
1069 * called only by backend_shutdown()
1070 * bi_db_destroy: called to destroy each database
1071 * called once per database during shutdown AFTER all
1072 * bi_close calls but before bi_destory calls.
1073 * called only by backend_destory()
1075 int (*bi_db_init) LDAP_P((Backend *bd));
1076 int (*bi_db_config) LDAP_P((Backend *bd,
1077 const char *fname, int lineno, int argc, char **argv ));
1078 int (*bi_db_open) LDAP_P((Backend *bd));
1079 int (*bi_db_close) LDAP_P((Backend *bd));
1080 int (*bi_db_destroy) LDAP_P((Backend *db));
1082 /* LDAP Operations Handling Routines */
1083 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
1084 struct slap_conn *c, struct slap_op *o,
1085 const char *dn, const char *ndn, int method,
1086 struct berval *cred, char** edn ));
1087 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
1088 struct slap_conn *c, struct slap_op *o ));
1089 int (*bi_op_search) LDAP_P((BackendDB *bd,
1090 struct slap_conn *c, struct slap_op *o,
1091 const char *base, const char *nbase,
1092 int scope, int deref,
1093 int slimit, int tlimit,
1094 Filter *f, const char *filterstr,
1095 char **attrs, int attrsonly));
1096 int (*bi_op_compare)LDAP_P((BackendDB *bd,
1097 struct slap_conn *c, struct slap_op *o,
1098 const char *dn, const char *ndn,
1099 AttributeAssertion *ava));
1100 int (*bi_op_modify) LDAP_P((BackendDB *bd,
1101 struct slap_conn *c, struct slap_op *o,
1102 const char *dn, const char *ndn, Modifications *m));
1103 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
1104 struct slap_conn *c, struct slap_op *o,
1105 const char *dn, const char *ndn,
1106 const char *newrdn, int deleteoldrdn,
1107 const char *newSuperior));
1108 int (*bi_op_add) LDAP_P((BackendDB *bd,
1109 struct slap_conn *c, struct slap_op *o,
1111 int (*bi_op_delete) LDAP_P((BackendDB *bd,
1112 struct slap_conn *c, struct slap_op *o,
1113 const char *dn, const char *ndn));
1114 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
1115 struct slap_conn *c, struct slap_op *o,
1118 /* Extended Operations Helper */
1119 SLAP_EXTENDED_FN bi_extended;
1121 /* Auxilary Functions */
1122 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd,
1123 struct slap_conn *c, struct slap_op *o,
1126 int (*bi_chk_referrals) LDAP_P((BackendDB *bd,
1127 struct slap_conn *c, struct slap_op *o,
1128 const char *dn, const char *ndn,
1129 const char **text ));
1131 int (*bi_acl_group) LDAP_P((Backend *bd,
1132 struct slap_conn *c, struct slap_op *o,
1133 Entry *e, const char *bdn, const char *edn,
1134 ObjectClass *group_oc,
1135 AttributeDescription *group_at ));
1136 int (*bi_acl_attribute) LDAP_P((Backend *bd,
1137 struct slap_conn *c, struct slap_op *o,
1138 Entry *e, const char *edn,
1139 AttributeDescription *entry_at,
1140 struct berval ***vals ));
1142 int (*bi_operational) LDAP_P((Backend *bd,
1143 struct slap_conn *c, struct slap_op *o,
1144 Entry *e, char **attrs, int opattrs, Attribute **a ));
1146 int (*bi_connection_init) LDAP_P((BackendDB *bd,
1147 struct slap_conn *c));
1148 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
1149 struct slap_conn *c));
1151 /* hooks for slap tools */
1152 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
1153 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
1154 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
1155 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
1156 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
1157 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
1158 int (*bi_tool_entry_reindex) LDAP_P(( BackendDB *be, ID id ));
1159 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
1161 #define SLAP_INDEX_ADD_OP 0x0001
1162 #define SLAP_INDEX_DELETE_OP 0x0002
1164 char **bi_controls; /* supported controls */
1166 unsigned int bi_nDB; /* number of databases of this type */
1167 void *bi_private; /* anything the backend type needs */
1170 #define c_authtype c_authz.sai_method
1171 #define c_authmech c_authz.sai_mech
1172 #define c_dn c_authz.sai_dn
1173 #define c_ndn c_authz.sai_ndn
1174 #define c_ssf c_authz.sai_ssf
1175 #define c_transport_ssf c_authz.sai_transport_ssf
1176 #define c_tls_ssf c_authz.sai_tls_ssf
1177 #define c_sasl_ssf c_authz.sai_sasl_ssf
1179 #define o_authtype o_authz.sai_method
1180 #define o_authmech o_authz.sai_mech
1181 #define o_dn o_authz.sai_dn
1182 #define o_ndn o_authz.sai_ndn
1183 #define o_ssf o_authz.sai_ssf
1184 #define o_transport_ssf o_authz.sai_transport_ssf
1185 #define o_tls_ssf o_authz.sai_tls_ssf
1186 #define o_sasl_ssf o_authz.sai_sasl_ssf
1191 typedef void (slap_response)(struct slap_conn *, struct slap_op *, ber_tag_t,
1192 ber_int_t, ber_int_t, const char *, const char *, struct berval **,
1193 const char *, struct berval *, struct berval *, LDAPControl **);
1195 typedef void (slap_sresult)(struct slap_conn *, struct slap_op *, ber_int_t,
1196 const char *, const char *, struct berval **, LDAPControl **,
1200 * represents an operation pending from an ldap client
1202 typedef struct slap_op {
1203 ber_int_t o_opid; /* id of this operation */
1204 ber_int_t o_msgid; /* msgid of the request */
1205 #ifdef LDAP_CONNECTIONLESS
1206 Sockaddr o_peeraddr; /* UDP peer address */
1209 ldap_pvt_thread_t o_tid; /* thread handling this op */
1211 BerElement *o_ber; /* ber of the request */
1213 ber_tag_t o_tag; /* tag of the request */
1214 time_t o_time; /* time op was initiated */
1216 AuthorizationInformation o_authz;
1218 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
1220 LDAPControl **o_ctrls; /* controls */
1222 unsigned long o_connid; /* id of conn initiating this op */
1224 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
1225 int o_abandon; /* abandon flag */
1226 slap_response *o_response; /* callback function */
1227 slap_sresult *o_sresult; /* search result callback */
1229 struct slap_op *o_next; /* next operation in list */
1230 void *o_private; /* anything the backend needs */
1231 void *o_glue; /* for the glue backend */
1235 * Caches the result of a backend_group check for ACL evaluation
1237 typedef struct slap_gacl {
1238 struct slap_gacl *next;
1241 AttributeDescription *at;
1248 * represents a connection from an ldap client
1250 typedef struct slap_conn {
1251 int c_struct_state; /* structure management state */
1252 int c_conn_state; /* connection state */
1254 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1255 Sockbuf *c_sb; /* ber connection stuff */
1257 /* only can be changed by connect_init */
1258 time_t c_starttime; /* when the connection was opened */
1259 time_t c_activitytime; /* when the connection was last used */
1260 unsigned long c_connid; /* id of this connection for stats*/
1262 char *c_listener_url; /* listener URL */
1263 char *c_peer_domain; /* DNS name of client */
1264 char *c_peer_name; /* peer name (trans=addr:port) */
1265 char *c_sock_name; /* sock name (trans=addr:port) */
1267 /* only can be changed by binding thread */
1268 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1269 char *c_sasl_bind_mech; /* mech in progress */
1272 /* authentication backend */
1273 Backend *c_authc_backend;
1275 /* authorization backend - normally same as c_authc_backend */
1276 Backend *c_authz_backend;
1278 AuthorizationInformation c_authz;
1279 GroupAssertion *c_groups;
1281 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1283 Operation *c_ops; /* list of operations being processed */
1284 Operation *c_pending_ops; /* list of pending operations */
1286 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1287 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1289 BerElement *c_currentber; /* ber we're attempting to read */
1290 int c_writewaiter; /* true if writer is waiting */
1292 #ifdef LDAP_CONNECTIONLESS
1293 int c_is_udp; /* true if this is (C)LDAP over UDP */
1296 int c_is_tls; /* true if this LDAP over raw TLS */
1297 int c_needs_tls_accept; /* true if SSL_accept should be called */
1299 int c_sasl_layers; /* true if we need to install SASL i/o handlers */
1300 void *c_sasl_context; /* SASL session context */
1301 void *c_sasl_extra; /* SASL session extra stuff */
1303 long c_n_ops_received; /* num of ops received (next op_id) */
1304 long c_n_ops_executing; /* num of ops currently executing */
1305 long c_n_ops_pending; /* num of ops pending execution */
1306 long c_n_ops_completed; /* num of ops completed */
1308 long c_n_get; /* num of get calls */
1309 long c_n_read; /* num of read calls */
1310 long c_n_write; /* num of write calls */
1313 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1314 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1316 if ( ldap_debug & (level) ) \
1317 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1318 if ( ldap_syslog & (level) ) \
1319 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1323 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1327 #define SASLREGEX_REPLACE 10
1328 #define SASL_AUTHZ_SOURCE_ATTR "saslAuthzTo"
1329 #define SASL_AUTHZ_DEST_ATTR "saslAuthzFrom"
1331 typedef struct sasl_regexp {
1332 char *match; /* regexp match pattern */
1333 char *replace; /* regexp replace pattern */
1334 regex_t workspace; /* workspace for regexp engine */
1335 regmatch_t strings[SASLREGEX_REPLACE]; /* strings matching $1,$2 ... */
1336 int offset[SASLREGEX_REPLACE+2]; /* offsets of $1,$2... in *replace */
1339 /* Flags for telling slap_sasl_getdn() what type of identity is being passed */
1340 #define FLAG_GETDN_FINAL 1
1341 #define FLAG_GETDN_AUTHCID 2
1342 #define FLAG_GETDN_AUTHZID 4
1347 #include "proto-slap.h"
1349 #endif /* _SLAP_H_ */