1 /* slap.h - stand alone ldap server include file */
4 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include "ldap_defaults.h"
13 #include <ac/stdlib.h>
15 #include <sys/types.h>
16 #include <ac/syslog.h>
18 #include <ac/socket.h>
22 #ifdef HAVE_CYRUS_SASL
29 #define ldap_debug slap_debug
36 #include <ldap_schema.h>
38 #include "ldap_pvt_thread.h"
44 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
47 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
49 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
51 * This is a value used internally by the backends. It is needed to allow
52 * adding values that already exist without getting an error as required by
53 * modrdn when the new rdn was already an attribute value itself.
54 * JCG 05/1999 (gomez@engr.sgi.com)
56 #define SLAP_MOD_SOFTADD 0x1000
57 #undef LDAP_MOD_BVALUES /* we always use BVALUES */
63 #define MAXREMATCHES 10
65 /* psuedo error code indicating disconnect */
66 #define SLAPD_DISCONNECT -1
68 /* psuedo error code indicating abandoned operation */
69 #define SLAPD_ABANDON -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) )
80 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
81 #define RDN_SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
82 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
84 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
85 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
86 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
87 #define OID_CHAR(c) ( ASCII_DIGIT(c) || (c) == '.' )
89 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
90 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
92 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
93 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
95 #define SLAPD_ACI_DEFAULT_ATTR "aci"
97 /* schema needed by slapd */
98 #define SLAPD_OID_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
99 #define SLAPD_OID_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1" /* experimental */
101 LIBSLAPD_F (int) slap_debug;
106 #define SLAP_INDEX_PRESENCE 0x0001U
107 #define SLAP_INDEX_EQUALITY 0x0002U
108 #define SLAP_INDEX_APPROX 0x0004U
109 #define SLAP_INDEX_SUB 0x0008U
110 #define SLAP_INDEX_UNKNOWN 0x0010U
111 #define SLAP_INDEX_FROMINIT 0x8000U /* psuedo type */
115 * represents schema information for a database
117 #define SLAP_SCHERR_OUTOFMEM 1
118 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
119 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
120 #define SLAP_SCHERR_DUP_CLASS 4
121 #define SLAP_SCHERR_DUP_ATTR 5
122 #define SLAP_SCHERR_DUP_SYNTAX 6
123 #define SLAP_SCHERR_DUP_RULE 7
124 #define SLAP_SCHERR_NO_NAME 8
125 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
126 #define SLAP_SCHERR_MR_NOT_FOUND 10
127 #define SLAP_SCHERR_SYN_NOT_FOUND 11
128 #define SLAP_SCHERR_MR_INCOMPLETE 12
130 typedef struct slap_oid_macro {
131 struct berval som_oid;
133 struct slap_oid_macro *som_next;
136 /* forward declarations */
138 struct slap_matching_rule;
140 typedef int slap_syntax_validate_func LDAP_P((
141 struct slap_syntax *syntax,
142 struct berval * in));
144 typedef int slap_syntax_transform_func LDAP_P((
145 struct slap_syntax *syntax,
147 struct berval ** out));
149 typedef struct slap_syntax {
150 LDAP_SYNTAX ssyn_syn;
153 #define SLAP_SYNTAX_NONE 0x0U
154 #define SLAP_SYNTAX_BINARY 0x1U
156 slap_syntax_validate_func *ssyn_validate;
158 /* convert to and from binary */
159 slap_syntax_transform_func *ssyn_ber2str;
160 slap_syntax_transform_func *ssyn_str2ber;
162 struct slap_syntax *ssyn_next;
163 #define ssyn_oid ssyn_syn.syn_oid
164 #define ssyn_desc ssyn_syn.syn_desc
167 /* XXX -> UCS-2 Converter */
168 typedef int slap_mr_convert_func LDAP_P((
170 struct berval ** out ));
173 typedef int slap_mr_normalize_func LDAP_P((
175 struct slap_syntax *syntax, /* NULL if in is asserted value */
176 struct slap_matching_rule *mr,
178 struct berval ** out ));
180 /* Match (compare) function */
181 typedef int slap_mr_match_func LDAP_P((
183 struct slap_syntax *syntax, /* syntax of stored value */
184 struct slap_matching_rule *mr,
185 struct berval * value,
186 void * assertValue ));
188 /* Index generation function */
189 typedef int slap_mr_indexer_func LDAP_P((
191 struct slap_syntax *syntax, /* syntax of stored value */
192 struct slap_matching_rule *mr,
193 struct berval **values,
194 struct berval **keys ));
196 struct slap_filter; /* forward declaration */
198 /* Filter index function */
199 typedef int slap_mr_filter_func LDAP_P((
201 struct slap_syntax *syntax, /* syntax of stored value */
202 struct slap_matching_rule *mr,
203 struct slap_filter *filter,
204 struct berval **keys ));
206 typedef struct slap_matching_rule {
207 LDAP_MATCHING_RULE smr_mrule;
209 #define SLAP_MR_NONE 0x00U
210 #define SLAP_MR_EQUALITY 0x01U
211 #define SLAP_MR_APPROX 0x02U
212 #define SLAP_MR_ORDERING 0x04U
213 #define SLAP_MR_SUBSTR 0x08U
214 #define SLAP_MR_EXT 0x10U
216 slap_mr_convert_func *smr_convert;
217 slap_mr_normalize_func *smr_normalize;
218 slap_mr_match_func *smr_match;
219 slap_mr_indexer_func *smr_indexer;
220 slap_mr_filter_func *smr_filter;
221 struct slap_matching_rule *smr_next;
222 #define smr_oid smr_mrule.mr_oid
223 #define smr_names smr_mrule.mr_names
224 #define smr_desc smr_mrule.mr_desc
225 #define smr_obsolete smr_mrule.mr_obsolete
226 #define smr_syntax_oid smr_mrule.mr_syntax_oid
229 typedef struct slap_attribute_type {
230 #ifdef SLAPD_SCHEMA_NOT_COMPAT
233 LDAP_ATTRIBUTE_TYPE sat_atype;
234 struct slap_attribute_type *sat_sup;
235 struct slap_attribute_type **sat_subtypes;
236 MatchingRule *sat_equality;
237 MatchingRule *sat_ordering;
238 MatchingRule *sat_substr;
240 #ifndef SLAPD_SCHEMA_NOT_COMPAT
241 /* The next one is created to help in the transition */
242 int sat_syntax_compat;
244 struct slap_attribute_type *sat_next;
245 #define sat_oid sat_atype.at_oid
246 #define sat_names sat_atype.at_names
247 #define sat_desc sat_atype.at_desc
248 #define sat_obsolete sat_atype.at_obsolete
249 #define sat_sup_oid sat_atype.at_sup_oid
250 #define sat_equality_oid sat_atype.at_equality_oid
251 #define sat_ordering_oid sat_atype.at_ordering_oid
252 #define sat_substr_oid sat_atype.at_substr_oid
253 #define sat_syntax_oid sat_atype.at_syntax_oid
254 #define sat_single_value sat_atype.at_single_value
255 #define sat_collective sat_atype.at_collective
256 #define sat_no_user_mod sat_atype.at_no_user_mod
257 #define sat_usage sat_atype.at_usage
260 #define is_at_operational(at) ((at)->sat_usage)
261 #define is_at_single_value(at) ((at)->sat_single_value)
262 #define is_at_collective(at) ((at)->sat_collective)
263 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
265 typedef struct slap_object_class {
266 LDAP_OBJECT_CLASS soc_oclass;
267 struct slap_object_class **soc_sups;
268 AttributeType **soc_required;
269 AttributeType **soc_allowed;
270 struct slap_object_class *soc_next;
271 #define soc_oid soc_oclass.oc_oid
272 #define soc_names soc_oclass.oc_names
273 #define soc_desc soc_oclass.oc_desc
274 #define soc_obsolete soc_oclass.oc_obsolete
275 #define soc_sup_oids soc_oclass.oc_sup_oids
276 #define soc_kind soc_oclass.oc_kind
277 #define soc_at_oids_must soc_oclass.oc_at_oids_must
278 #define soc_at_oids_may soc_oclass.oc_at_oids_may
282 #ifdef SLAPD_SCHEMA_NOT_COMPAT
284 * represents a recognized attribute description ( type + options )
286 typedef struct slap_attr_desc {
287 struct berval *ad_cname; /* canonical name */
288 AttributeType *ad_type; /* NULL if unknown */
289 char *ad_lang; /* NULL if no language tags */
291 #define SLAP_DESC_NONE 0x0U
292 #define SLAP_DESC_BINARY 0x1U
293 } AttributeDescription;
295 typedef struct slap_attr_assertion {
296 AttributeDescription *aa_desc;
297 struct berval *aa_value;
298 } AttributeAssertion;
300 typedef struct slap_ss_assertion {
301 AttributeDescription *sa_desc;
302 struct berval *sa_initial;
303 struct berval **sa_any;
304 struct berval *sa_final;
305 } SubstringAssertion;
307 typedef struct slap_mr_assertion {
308 char *ma_rule; /* optional */
309 AttributeDescription *ma_desc; /* optional */
310 int ma_dnattrs; /* boolean */
311 struct berval *ma_value; /* required */
312 } MatchingRuleAssertion;
317 * represents an attribute value assertion (i.e., attr;option=value)
319 typedef struct slap_ava {
320 char *ava_type; /* attribute description */
321 struct berval ava_value;
325 * represents an matching rule assertion
327 typedef struct slap_mra {
328 char *mra_rule; /* optional */
329 char *mra_type; /* attribute description -- optional */
331 struct berval *mra_value;
337 * represents a search filter
340 typedef struct slap_filter {
341 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
342 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) 0x01U)
345 /* precomputed result */
346 ber_int_t f_un_result;
348 #ifdef SLAPD_SCHEMA_NOT_COMPAT
353 AttributeDescription *f_un_desc;
355 /* simple value assertion */
356 AttributeAssertion *f_un_ava;
358 /* substring assertion */
359 SubstringAssertion *f_un_ssa;
361 /* matching rule assertion */
362 MatchingRuleAssertion *f_un_mra;
364 #define f_dn f_un.f_un_dn
365 #define f_desc f_un.f_un_desc
366 #define f_ava f_un.f_un_ava
367 #define f_av_desc f_un.f_un_ava->aa_desc
368 #define f_av_value f_un.f_un_ava->aa_value
369 #define f_sub f_un.f_un_ssa
370 #define f_sub_desc f_un.f_un_ssa->sa_desc
371 #define f_sub_initial f_un.f_un_ssa->sa_initial
372 #define f_sub_any f_un.f_un_ssa->sa_any
373 #define f_sub_final f_un.f_un_ssa->sa_final
374 #define f_mra f_un.f_un_mra
375 #define f_mr_rule f_un.f_un_mra->ma_rule
376 #define f_mr_desc f_un.f_un_mra->ma_desc
377 #define f_mr_value f_un.f_un_mra->ma_value
378 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
383 /* equality, lessorequal, greaterorequal, approx */
393 struct berval *f_un_sub_initial;
394 struct berval **f_un_sub_any;
395 struct berval *f_un_sub_final;
398 #define f_dn f_un.f_un_type /* used for DN indices */
399 #define f_type f_un.f_un_type
400 #define f_ava f_un.f_un_ava
401 #define f_avtype f_un.f_un_ava.ava_type
402 #define f_avvalue f_un.f_un_ava.ava_value
403 #define f_mra f_un.f_un_mra
404 #define f_mrtype f_un.f_un_mra.mra_type
405 #define f_mrvalue f_un.f_un_mra.mra_value
406 #define f_mrdnaddrs f_un.f_un_mra.mra_dnattrs
407 #define f_sub f_un.f_un_sub
408 #define f_sub_type f_un.f_un_sub.f_un_sub_type
409 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
410 #define f_sub_any f_un.f_un_sub.f_un_sub_any
411 #define f_sub_final f_un.f_un_sub.f_un_sub_final
415 struct slap_filter *f_un_complex;
418 #define f_result f_un.f_un_result
419 #define f_and f_un.f_un_complex
420 #define f_or f_un.f_un_complex
421 #define f_not f_un.f_un_complex
422 #define f_list f_un.f_un_complex
424 struct slap_filter *f_next;
427 /* compare routines can return undefined */
428 #define SLAPD_COMPARE_UNDEFINED ((ber_tag_t) -1)
431 * represents an attribute (description + values)
433 typedef struct slap_attr {
434 #ifdef SLAPD_SCHEMA_NOT_COMPAT
435 AttributeDescription *a_desc;
437 char *a_type; /* description */
440 struct berval **a_vals;
441 struct slap_attr *a_next;
444 #ifndef SLAPD_SCHEMA_NOT_COMPAT
446 * the attr_syntax() routine returns one of these values
447 * telling what kind of syntax an attribute supports.
449 #define SYNTAX_CIS 0x01 /* case insensitive string */
450 #define SYNTAX_CES 0x02 /* case sensitive string */
451 #define SYNTAX_BIN 0x04 /* binary data */
452 #define SYNTAX_TEL 0x08 /* telephone number string */
453 #define SYNTAX_DN 0x10 /* dn string */
457 * the id used in the indexes to refer to an entry
459 typedef unsigned long ID;
460 #define NOID ((ID)~0)
463 * represents an entry in core
465 typedef struct slap_entry {
467 * The ID field should only be changed before entry is
468 * inserted into a cache. The ID value is backend
473 char *e_dn; /* DN of this entry */
474 char *e_ndn; /* normalized DN of this entry */
475 Attribute *e_attrs; /* list of attributes + values */
477 /* for use by the backend for any purpose */
484 #ifdef SLAPD_SCHEMA_NOT_COMPAT
485 typedef struct slap_mod {
487 AttributeDescription *sm_desc;
488 struct berval **sm_bvalues;
491 #define Modification LDAPMod
493 #define sm_desc mod_type
494 #define sm_bvalues mod_bvalues
497 typedef struct slap_mod_list {
498 Modification sml_mod;
499 #define sml_op sml_mod.sm_op
500 #define sml_desc sml_mod.sm_desc
501 #define sml_bvalues sml_mod.sm_bvalues
502 #ifndef SLAPD_SCHEMA_NOT_COMPAT
503 #define sml_type sml_mod.sm_desc
505 struct slap_mod_list *sml_next;
508 #ifdef SLAPD_SCHEMA_NOT_COMPAT
509 typedef struct slap_ldap_modlist {
511 struct slap_ldap_modlist *ml_next;
512 #define ml_op ml_mod.mod_op
513 #define ml_type ml_mod.mod_type
514 #define ml_values ml_mod.mod_values
515 #define ml_bvalues ml_mod.mod_bvalues
518 #define LDAPModList Modifications
519 #define ml_mod sml_mod
520 #define ml_op sml_mod.mod_op
521 #define ml_type sml_mod.mod_type
522 #define ml_values sml_mod.mod_values
523 #define ml_bvalues sml_mod.mod_bvalues
524 #define ml_next sml_next
528 * represents an access control list
531 typedef enum slap_access_e {
532 ACL_INVALID_ACCESS = -1,
541 typedef enum slap_control_e {
542 ACL_INVALID_CONTROL = 0,
548 typedef unsigned long slap_access_mask_t;
551 typedef struct slap_access {
552 slap_control_t a_type;
554 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
556 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
557 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
558 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
559 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
560 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
561 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
563 #define ACL_PRIV_MASK 0x00ffUL
566 #define ACL_PRIV_LEVEL 0x1000UL
567 #define ACL_PRIV_ADDITIVE 0x2000UL
568 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
571 #define ACL_PRIV_INVALID 0x0UL
573 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
574 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
575 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
576 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
578 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
579 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
581 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
583 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
585 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
586 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
587 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
589 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
590 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
591 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
592 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
593 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
594 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
596 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
597 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
598 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
599 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
600 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
601 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
602 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
604 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
605 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
606 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
607 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
608 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
609 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
611 slap_access_mask_t a_mask;
614 #ifdef SLAPD_SCHEMA_NOT_COMPAT
615 AttributeDescription *a_dn_at;
621 char *a_peername_pat;
622 char *a_sockname_pat;
627 #ifdef SLAPD_ACI_ENABLED
628 #ifdef SLAPD_SCHEMA_NOT_COMPAT
629 AttributeDescription *a_aci_at;
638 #ifdef SLAPD_SCHEMA_NOT_COMPAT
639 AttributeDescription *a_group_at;
644 struct slap_access *a_next;
648 typedef struct slap_acl {
649 /* "to" part: the entries this acl applies to */
655 /* "by" part: list of who has what access to the entries */
658 struct slap_acl *acl_next;
662 * replog moddn param structure
664 struct replog_moddn {
672 * represents a backend
675 typedef struct slap_backend_info BackendInfo; /* per backend type */
676 typedef struct slap_backend_db BackendDB; /* per backend database */
678 LIBSLAPD_F (int) nBackendInfo;
679 LIBSLAPD_F (int) nBackendDB;
680 LIBSLAPD_F (BackendInfo *) backendInfo;
681 LIBSLAPD_F (BackendDB *) backendDB;
683 LIBSLAPD_F (int) slapMode;
684 #define SLAP_UNDEFINED_MODE 0x0000
685 #define SLAP_SERVER_MODE 0x0001
686 #define SLAP_TOOL_MODE 0x0002
687 #define SLAP_MODE 0x0003
689 #define SLAP_TRUNCATE_MODE 0x0100
691 #define SLAP_TIMED_MODE 0x1000
693 #define SLAP_TOOLID_MODE 4
695 /* temporary aliases */
696 typedef BackendDB Backend;
697 #define nbackends nBackendDB
698 #define backends backendDB
700 struct slap_backend_db {
701 BackendInfo *bd_info; /* pointer to shared backend info */
703 /* BackendInfo accessors */
704 #define be_config bd_info->bi_db_config
705 #define be_type bd_info->bi_type
707 #define be_bind bd_info->bi_op_bind
708 #define be_unbind bd_info->bi_op_unbind
709 #define be_add bd_info->bi_op_add
710 #define be_compare bd_info->bi_op_compare
711 #define be_delete bd_info->bi_op_delete
712 #define be_modify bd_info->bi_op_modify
713 #define be_modrdn bd_info->bi_op_modrdn
714 #define be_search bd_info->bi_op_search
716 #define be_extended bd_info->bi_extended
718 #define be_release bd_info->bi_entry_release_rw
719 #define be_group bd_info->bi_acl_group
721 #define be_controls bd_info->bi_controls
723 #define be_connection_init bd_info->bi_connection_init
724 #define be_connection_destroy bd_info->bi_connection_destroy
727 #define be_entry_open bd_info->bi_tool_entry_open
728 #define be_entry_close bd_info->bi_tool_entry_close
729 #define be_entry_first bd_info->bi_tool_entry_first
730 #define be_entry_next bd_info->bi_tool_entry_next
731 #define be_entry_get bd_info->bi_tool_entry_get
732 #define be_entry_put bd_info->bi_tool_entry_put
733 #define be_index_attr bd_info->bi_tool_index_attr
734 #define be_index_change bd_info->bi_tool_index_change
735 #define be_sync bd_info->bi_tool_sync
738 #ifdef HAVE_CYRUS_SASL
739 #define be_sasl_authorize bd_info->bi_sasl_authorize
740 #define be_sasl_getsecret bd_info->bi_sasl_getsecret
741 #define be_sasl_putsecret bd_info->bi_sasl_putsecret
744 /* these should be renamed from be_ to bd_ */
745 char **be_suffix; /* the DN suffixes of data in this backend */
746 char **be_nsuffix; /* the normalized DN suffixes in this backend */
747 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
748 char *be_root_dn; /* the magic "root" dn for this db */
749 char *be_root_ndn; /* the magic "root" normalized dn for this db */
750 struct berval be_root_pw; /* the magic "root" password for this db */
751 int be_readonly; /* 1 => db is in "read only" mode */
752 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
753 int be_sizelimit; /* size limit for this backend */
754 int be_timelimit; /* time limit for this backend */
755 AccessControl *be_acl; /* access control list for this backend */
756 slap_access_t be_dfltaccess; /* access given if no acl matches */
757 char **be_replica; /* replicas of this backend (in master) */
758 char *be_replogfile; /* replication log file (in master) */
759 char *be_update_ndn; /* allowed to make changes (in replicas) */
760 struct berval **be_update_refs; /* where to refer modifying clients to */
761 int be_lastmod; /* keep track of lastmodified{by,time} */
765 void *be_private; /* anything the backend database needs */
771 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
773 struct slap_conn *conn,
776 struct berval * reqdata,
778 struct berval ** rspdata,
779 LDAPControl *** rspctrls,
781 struct berval *** refs ));
783 struct slap_backend_info {
784 char *bi_type; /* type of backend */
787 * per backend type routines:
788 * bi_init: called to allocate a backend_info structure,
789 * called once BEFORE configuration file is read.
790 * bi_init() initializes this structure hence is
791 * called directly from be_initialize()
792 * bi_config: called per 'backend' specific option
793 * all such options must before any 'database' options
794 * bi_config() is called only from read_config()
795 * bi_open: called to open each database, called
796 * once AFTER configuration file is read but
797 * BEFORE any bi_db_open() calls.
798 * bi_open() is called from backend_startup()
799 * bi_close: called to close each database, called
800 * once during shutdown after all bi_db_close calls.
801 * bi_close() is called from backend_shutdown()
802 * bi_destroy: called to destroy each database, called
803 * once during shutdown after all bi_db_destroy calls.
804 * bi_destory() is called from backend_destroy()
806 int (*bi_init) LDAP_P((BackendInfo *bi));
807 int (*bi_config) LDAP_P((BackendInfo *bi,
808 const char *fname, int lineno, int argc, char **argv ));
809 int (*bi_open) LDAP_P((BackendInfo *bi));
810 int (*bi_close) LDAP_P((BackendInfo *bi));
811 int (*bi_destroy) LDAP_P((BackendInfo *bi));
814 * per database routines:
815 * bi_db_init: called to initialize each database,
816 * called upon reading 'database <type>'
817 * called only from backend_db_init()
818 * bi_db_config: called to configure each database,
819 * called per database to handle per database options
820 * called only from read_config()
821 * bi_db_open: called to open each database
822 * called once per database immediately AFTER bi_open()
823 * calls but before daemon startup.
824 * called only by backend_startup()
825 * bi_db_close: called to close each database
826 * called once per database during shutdown but BEFORE
828 * called only by backend_shutdown()
829 * bi_db_destroy: called to destroy each database
830 * called once per database during shutdown AFTER all
831 * bi_close calls but before bi_destory calls.
832 * called only by backend_destory()
834 int (*bi_db_init) LDAP_P((Backend *bd));
835 int (*bi_db_config) LDAP_P((Backend *bd,
836 const char *fname, int lineno, int argc, char **argv ));
837 int (*bi_db_open) LDAP_P((Backend *bd));
838 int (*bi_db_close) LDAP_P((Backend *bd));
839 int (*bi_db_destroy) LDAP_P((Backend *db));
841 /* LDAP Operations Handling Routines */
842 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
843 struct slap_conn *c, struct slap_op *o,
844 char *dn, char *ndn, int method, char* mechanism,
845 struct berval *cred, char** edn ));
846 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
847 struct slap_conn *c, struct slap_op *o ));
848 int (*bi_op_search) LDAP_P((BackendDB *bd,
849 struct slap_conn *c, struct slap_op *o,
850 char *base, char *nbase, int scope, int deref,
851 int slimit, int tlimit,
852 Filter *f, char *filterstr, char **attrs,
854 #ifdef SLAPD_SCHEMA_NOT_COMPAT
855 int (*bi_op_compare)LDAP_P((BackendDB *bd,
856 struct slap_conn *c, struct slap_op *o,
857 char *dn, char *ndn, AttributeAssertion *ava));
859 int (*bi_op_compare)LDAP_P((BackendDB *bd,
860 struct slap_conn *c, struct slap_op *o,
861 char *dn, char *ndn, Ava *ava));
863 int (*bi_op_modify) LDAP_P((BackendDB *bd,
864 struct slap_conn *c, struct slap_op *o,
865 char *dn, char *ndn, Modifications *m));
866 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
867 struct slap_conn *c, struct slap_op *o,
868 char *dn, char *ndn, char *newrdn, int deleteoldrdn,
870 int (*bi_op_add) LDAP_P((BackendDB *bd,
871 struct slap_conn *c, struct slap_op *o,
873 int (*bi_op_delete) LDAP_P((BackendDB *bd,
874 struct slap_conn *c, struct slap_op *o,
875 char *dn, char *ndn));
876 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
877 struct slap_conn *c, struct slap_op *o,
880 /* Extended Operations Helper */
881 SLAP_EXTENDED_FN bi_extended;
883 /* Auxilary Functions */
884 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
886 #ifdef SLAPD_SCHEMA_NOT_COMPAT
887 int (*bi_acl_group) LDAP_P((Backend *bd,
888 Entry *e, const char *bdn, const char *edn,
889 const char *objectclassValue,
890 AttributeDescription *group_at ));
892 int (*bi_acl_group) LDAP_P((Backend *bd,
893 Entry *e, const char *bdn, const char *edn,
894 const char *objectclassValue,
895 const char *group_at ));
898 int (*bi_connection_init) LDAP_P((BackendDB *bd,
899 struct slap_conn *c));
900 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
901 struct slap_conn *c));
903 /* hooks for slap tools */
904 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
905 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
906 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
907 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
908 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
909 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
910 #ifdef SLAPD_SCHEMA_NOT_COMPAT
911 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
912 AttributeDescription *desc ));
913 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
914 AttributeDescription *desc,
915 struct berval **bv, ID id, int op ));
917 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
919 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
920 char* type, struct berval **bv, ID id, int op ));
922 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
924 #ifdef HAVE_CYRUS_SASL
925 int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
926 const char *authnid, const char *authzid,
927 const char **canon_authzid, const char **errstr ));
928 int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
929 const char *mechanism, const char *authzid,
930 const char *realm, sasl_secret_t **secret ));
931 int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
932 const char *mechanism, const char *auth_identity,
933 const char *realm, const sasl_secret_t *secret ));
934 #endif /* HAVE_CYRUS_SASL */
936 #define SLAP_INDEX_ADD_OP 0x0001
937 #define SLAP_INDEX_DELETE_OP 0x0002
939 char **bi_controls; /* supported controls */
941 unsigned int bi_nDB; /* number of databases of this type */
942 void *bi_private; /* anything the backend type needs */
946 * represents an operation pending from an ldap client
949 typedef struct slap_op {
950 ber_int_t o_opid; /* id of this operation */
951 ber_int_t o_msgid; /* msgid of the request */
953 ldap_pvt_thread_t o_tid; /* thread handling this op */
955 BerElement *o_ber; /* ber of the request */
957 ber_tag_t o_tag; /* tag of the request */
958 time_t o_time; /* time op was initiated */
961 /* should only be used for reporting purposes */
962 char *o_authc_dn; /* authentication DN */
964 /* should be used as the DN of the User */
965 char *o_authz_dn; /* authorization DN */
966 char *o_authz_ndn; /* authorizaiton NDN */
969 char *o_dn; /* dn bound when op was initiated */
970 char *o_ndn; /* normalized dn bound when op was initiated */
973 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
974 ber_tag_t o_authtype; /* auth method used to bind dn */
975 /* values taken from ldap.h */
977 char *o_authmech; /* SASL mechanism used to bind dn */
979 LDAPControl **o_ctrls; /* controls */
981 unsigned long o_connid; /* id of conn initiating this op */
983 #ifdef LDAP_CONNECTIONLESS
984 int o_cldap; /* != 0 if this came in via CLDAP */
985 struct sockaddr o_clientaddr; /* client address if via CLDAP */
986 char o_searchbase; /* search base if via CLDAP */
989 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
990 int o_abandon; /* abandon flag */
992 struct slap_op *o_next; /* next operation in list */
993 void *o_private; /* anything the backend needs */
997 * represents a connection from an ldap client
1000 typedef struct slap_conn {
1001 int c_struct_state; /* structure management state */
1002 int c_conn_state; /* connection state */
1004 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1005 Sockbuf *c_sb; /* ber connection stuff */
1007 /* only can be changed by connect_init */
1008 time_t c_starttime; /* when the connection was opened */
1009 time_t c_activitytime; /* when the connection was last used */
1010 unsigned long c_connid; /* id of this connection for stats*/
1012 char *c_listener_url; /* listener URL */
1013 char *c_peer_domain; /* DNS name of client */
1014 char *c_peer_name; /* peer name (trans=addr:port) */
1015 char *c_sock_name; /* sock name (trans=addr:port) */
1017 /* only can be changed by binding thread */
1018 int c_bind_in_progress; /* multi-op bind in progress */
1019 #ifdef HAVE_CYRUS_SASL
1020 sasl_conn_t *c_sasl_context;
1022 void *c_authstate; /* SASL state data */
1024 /* authentication backend */
1025 Backend *c_authc_backend;
1027 /* authorization backend - normally same as c_authc_backend */
1028 Backend *c_authz_backend;
1031 /* authentication backend */
1032 /* should only be used for reporting purposes */
1033 char *c_authc_dn; /* authentication DN */
1035 /* should be used as the DN of the User */
1036 char *c_authz_dn; /* authorization DN */
1037 char *c_authz_ndn; /* authorization NDN */
1040 char *c_cdn; /* DN provided by the client */
1041 char *c_dn; /* DN bound to this conn */
1044 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1045 ber_tag_t c_authtype;/* auth method used to bind c_dn */
1046 char *c_authmech; /* SASL mechanism used to bind c_dn */
1048 Operation *c_ops; /* list of operations being processed */
1049 Operation *c_pending_ops; /* list of pending operations */
1051 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1052 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1054 BerElement *c_currentber; /* ber we're attempting to read */
1055 int c_writewaiter; /* true if writer is waiting */
1058 int c_is_tls; /* true if this LDAP over raw TLS */
1059 int c_needs_tls_accept; /* true if SSL_accept should be called */
1062 long c_n_ops_received; /* num of ops received (next op_id) */
1063 long c_n_ops_executing; /* num of ops currently executing */
1064 long c_n_ops_pending; /* num of ops pending execution */
1065 long c_n_ops_completed; /* num of ops completed */
1067 long c_n_get; /* num of get calls */
1068 long c_n_read; /* num of read calls */
1069 long c_n_write; /* num of write calls */
1072 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1073 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1075 if ( ldap_debug & (level) ) \
1076 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1077 if ( ldap_syslog & (level) ) \
1078 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1082 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1087 #include "proto-slap.h"
1089 #endif /* _SLAP_H_ */