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
62 #define MAXREMATCHES 10
64 /* psuedo error code indicating disconnect */
65 #define SLAPD_DISCONNECT -1
67 /* psuedo error code indicating abandoned operation */
68 #define SLAPD_ABANDON -2
71 /* We assume "C" locale, that is US-ASCII */
72 #define ASCII_SPACE(c) ( (c) == ' ' )
73 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
74 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
75 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
76 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
77 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
79 #define DN_SEPARATOR(c) ((c) == ',' || (c) == ';')
80 #define RDN_SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
81 #define RDN_NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
83 #define DESC_LEADCHAR(c) ( ASCII_ALPHA(c) )
84 #define DESC_CHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
85 #define OID_LEADCHAR(c) ( ASCII_DIGIT(c) )
86 #define OID_CHAR(c) ( ASCII_DIGIT(c) || (c) == '.' )
88 #define ATTR_LEADCHAR(c) ( DESC_LEADCHAR(c) || OID_LEADCHAR(c) )
89 #define ATTR_CHAR(c) ( DESC_CHAR((c)) || (c) == '.' )
91 #define AD_LEADCHAR(c) ( ATTR_CHAR(c) )
92 #define AD_CHAR(c) ( ATTR_CHAR(c) || (c) == ';' )
94 #define SLAPD_ACI_DEFAULT_ATTR "aci"
96 /* schema needed by slapd */
97 #define SLAPD_OID_DN_SYNTAX "1.3.6.1.4.1.1466.115.121.1.12"
98 #define SLAPD_OID_ACI_SYNTAX "1.3.6.1.4.1.4203.666.2.1" /* experimental */
100 LIBSLAPD_F (int) slap_debug;
105 #define SLAP_INDEX_PRESENCE 0x0001U
106 #define SLAP_INDEX_EQUALITY 0x0002U
107 #define SLAP_INDEX_APPROX 0x0004U
108 #define SLAP_INDEX_SUB 0x0008U
109 #define SLAP_INDEX_UNKNOWN 0x0010U
110 #define SLAP_INDEX_FROMINIT 0x8000U /* psuedo type */
114 * represents schema information for a database
116 #define SLAP_SCHERR_OUTOFMEM 1
117 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
118 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
119 #define SLAP_SCHERR_DUP_CLASS 4
120 #define SLAP_SCHERR_DUP_ATTR 5
121 #define SLAP_SCHERR_DUP_SYNTAX 6
122 #define SLAP_SCHERR_DUP_RULE 7
123 #define SLAP_SCHERR_NO_NAME 8
124 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
125 #define SLAP_SCHERR_MR_NOT_FOUND 10
126 #define SLAP_SCHERR_SYN_NOT_FOUND 11
127 #define SLAP_SCHERR_MR_INCOMPLETE 12
129 typedef struct slap_oid_macro {
130 struct berval som_oid;
132 struct slap_oid_macro *som_next;
135 /* forward declarations */
137 struct slap_matching_rule;
139 typedef int slap_syntax_validate_func LDAP_P((
140 struct slap_syntax *syntax,
141 struct berval * in));
143 typedef int slap_syntax_transform_func LDAP_P((
144 struct slap_syntax *syntax,
146 struct berval ** out));
148 typedef struct slap_syntax {
149 LDAP_SYNTAX ssyn_syn;
152 #define SLAP_SYNTAX_NONE 0x0U
153 #define SLAP_SYNTAX_BINARY 0x1U
155 slap_syntax_validate_func *ssyn_validate;
157 /* convert to and from binary */
158 slap_syntax_transform_func *ssyn_ber2str;
159 slap_syntax_transform_func *ssyn_str2ber;
161 struct slap_syntax *ssyn_next;
162 #define ssyn_oid ssyn_syn.syn_oid
163 #define ssyn_desc ssyn_syn.syn_desc
166 /* XXX -> UCS-2 Converter */
167 typedef int slap_mr_convert_func LDAP_P((
169 struct berval ** out ));
172 typedef int slap_mr_normalize_func LDAP_P((
174 struct slap_syntax *syntax, /* NULL if in is asserted value */
175 struct slap_matching_rule *mr,
177 struct berval ** out ));
179 /* Match (compare) function */
180 typedef int slap_mr_match_func LDAP_P((
182 struct slap_syntax *syntax, /* syntax of stored value */
183 struct slap_matching_rule *mr,
184 struct berval * value,
185 void * assertValue ));
187 /* Index generation function */
188 typedef int slap_mr_indexer_func LDAP_P((
190 struct slap_syntax *syntax, /* syntax of stored value */
191 struct slap_matching_rule *mr,
192 struct berval **values,
193 struct berval **keys ));
195 struct slap_filter; /* forward declaration */
197 /* Filter index function */
198 typedef int slap_mr_filter_func LDAP_P((
200 struct slap_syntax *syntax, /* syntax of stored value */
201 struct slap_matching_rule *mr,
202 struct slap_filter *filter,
203 struct berval **keys ));
205 typedef struct slap_matching_rule {
206 LDAP_MATCHING_RULE smr_mrule;
208 #define SLAP_MR_NONE 0x00U
209 #define SLAP_MR_EQUALITY 0x01U
210 #define SLAP_MR_APPROX 0x02U
211 #define SLAP_MR_ORDERING 0x04U
212 #define SLAP_MR_SUBSTR 0x08U
213 #define SLAP_MR_EXT 0x10U
215 slap_mr_convert_func *smr_convert;
216 slap_mr_normalize_func *smr_normalize;
217 slap_mr_match_func *smr_match;
218 slap_mr_indexer_func *smr_indexer;
219 slap_mr_filter_func *smr_filter;
220 struct slap_matching_rule *smr_next;
221 #define smr_oid smr_mrule.mr_oid
222 #define smr_names smr_mrule.mr_names
223 #define smr_desc smr_mrule.mr_desc
224 #define smr_obsolete smr_mrule.mr_obsolete
225 #define smr_syntax_oid smr_mrule.mr_syntax_oid
228 typedef struct slap_attribute_type {
229 #ifdef SLAPD_SCHEMA_NOT_COMPAT
232 LDAP_ATTRIBUTE_TYPE sat_atype;
233 struct slap_attribute_type *sat_sup;
234 struct slap_attribute_type **sat_subtypes;
235 MatchingRule *sat_equality;
236 MatchingRule *sat_ordering;
237 MatchingRule *sat_substr;
239 #ifndef SLAPD_SCHEMA_NOT_COMPAT
240 /* The next one is created to help in the transition */
241 int sat_syntax_compat;
243 struct slap_attribute_type *sat_next;
244 #define sat_oid sat_atype.at_oid
245 #define sat_names sat_atype.at_names
246 #define sat_desc sat_atype.at_desc
247 #define sat_obsolete sat_atype.at_obsolete
248 #define sat_sup_oid sat_atype.at_sup_oid
249 #define sat_equality_oid sat_atype.at_equality_oid
250 #define sat_ordering_oid sat_atype.at_ordering_oid
251 #define sat_substr_oid sat_atype.at_substr_oid
252 #define sat_syntax_oid sat_atype.at_syntax_oid
253 #define sat_single_value sat_atype.at_single_value
254 #define sat_collective sat_atype.at_collective
255 #define sat_no_user_mod sat_atype.at_no_user_mod
256 #define sat_usage sat_atype.at_usage
259 #define is_at_operational(at) ((at)->sat_usage)
260 #define is_at_single_value(at) ((at)->sat_single_value)
261 #define is_at_collective(at) ((at)->sat_collective)
262 #define is_at_no_user_mod(at) ((at)->sat_no_user_mod)
264 typedef struct slap_object_class {
265 LDAP_OBJECT_CLASS soc_oclass;
266 struct slap_object_class **soc_sups;
267 AttributeType **soc_required;
268 AttributeType **soc_allowed;
269 struct slap_object_class *soc_next;
270 #define soc_oid soc_oclass.oc_oid
271 #define soc_names soc_oclass.oc_names
272 #define soc_desc soc_oclass.oc_desc
273 #define soc_obsolete soc_oclass.oc_obsolete
274 #define soc_sup_oids soc_oclass.oc_sup_oids
275 #define soc_kind soc_oclass.oc_kind
276 #define soc_at_oids_must soc_oclass.oc_at_oids_must
277 #define soc_at_oids_may soc_oclass.oc_at_oids_may
281 #ifdef SLAPD_SCHEMA_NOT_COMPAT
283 * represents a recognized attribute description ( type + options )
285 typedef struct slap_attr_desc {
286 struct berval *ad_cname; /* canonical name */
287 AttributeType *ad_type; /* NULL if unknown */
288 char *ad_lang; /* NULL if no language tags */
290 #define SLAP_DESC_NONE 0x0U
291 #define SLAP_DESC_BINARY 0x1U
292 } AttributeDescription;
294 typedef struct slap_attr_assertion {
295 AttributeDescription *aa_desc;
296 struct berval *aa_value;
297 } AttributeAssertion;
299 typedef struct slap_ss_assertion {
300 AttributeDescription *sa_desc;
301 struct berval *sa_initial;
302 struct berval **sa_any;
303 struct berval *sa_final;
304 } SubstringAssertion;
306 typedef struct slap_mr_assertion {
307 char *ma_rule; /* optional */
308 AttributeDescription *ma_desc; /* optional */
309 int ma_dnattrs; /* boolean */
310 struct berval *ma_value; /* required */
311 } MatchingRuleAssertion;
316 * represents an attribute value assertion (i.e., attr;option=value)
318 typedef struct slap_ava {
319 char *ava_type; /* attribute description */
320 struct berval ava_value;
324 * represents an matching rule assertion
326 typedef struct slap_mra {
327 char *mra_rule; /* optional */
328 char *mra_type; /* attribute description -- optional */
330 struct berval *mra_value;
336 * represents a search filter
339 typedef struct slap_filter {
340 ber_tag_t f_choice; /* values taken from ldap.h, plus: */
341 #define SLAPD_FILTER_COMPUTED ((ber_tag_t) 0x01U)
344 /* precomputed result */
345 ber_int_t f_un_result;
347 #ifdef SLAPD_SCHEMA_NOT_COMPAT
352 AttributeDescription *f_un_desc;
354 /* simple value assertion */
355 AttributeAssertion *f_un_ava;
357 /* substring assertion */
358 SubstringAssertion *f_un_ssa;
360 /* matching rule assertion */
361 MatchingRuleAssertion *f_un_mra;
363 #define f_dn f_un.f_un_dn
364 #define f_desc f_un.f_un_desc
365 #define f_ava f_un.f_un_ava
366 #define f_av_desc f_un.f_un_ava->aa_desc
367 #define f_av_value f_un.f_un_ava->aa_value
368 #define f_sub f_un.f_un_ssa
369 #define f_sub_desc f_un.f_un_ssa->sa_desc
370 #define f_sub_initial f_un.f_un_ssa->sa_initial
371 #define f_sub_any f_un.f_un_ssa->sa_any
372 #define f_sub_final f_un.f_un_ssa->sa_final
373 #define f_mra f_un.f_un_mra
374 #define f_mr_rule f_un.f_un_mra->ma_rule
375 #define f_mr_desc f_un.f_un_mra->ma_desc
376 #define f_mr_value f_un.f_un_mra->ma_value
377 #define f_mr_dnaddrs f_un.f_un_mra->ma_dnattrs
382 /* equality, lessorequal, greaterorequal, approx */
392 struct berval *f_un_sub_initial;
393 struct berval **f_un_sub_any;
394 struct berval *f_un_sub_final;
397 #define f_dn f_un.f_un_type /* used for DN indices */
398 #define f_type f_un.f_un_type
399 #define f_ava f_un.f_un_ava
400 #define f_avtype f_un.f_un_ava.ava_type
401 #define f_avvalue f_un.f_un_ava.ava_value
402 #define f_mra f_un.f_un_mra
403 #define f_mrtype f_un.f_un_mra.mra_type
404 #define f_mrvalue f_un.f_un_mra.mra_value
405 #define f_mrdnaddrs f_un.f_un_mra.mra_dnattrs
406 #define f_sub f_un.f_un_sub
407 #define f_sub_type f_un.f_un_sub.f_un_sub_type
408 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
409 #define f_sub_any f_un.f_un_sub.f_un_sub_any
410 #define f_sub_final f_un.f_un_sub.f_un_sub_final
414 struct slap_filter *f_un_complex;
417 #define f_result f_un.f_un_result
418 #define f_and f_un.f_un_complex
419 #define f_or f_un.f_un_complex
420 #define f_not f_un.f_un_complex
421 #define f_list f_un.f_un_complex
423 struct slap_filter *f_next;
426 /* compare routines can return undefined */
427 #define SLAPD_COMPARE_UNDEFINED ((ber_tag_t) -1)
430 * represents an attribute (description + values)
432 typedef struct slap_attr {
433 #ifdef SLAPD_SCHEMA_NOT_COMPAT
434 AttributeDescription *a_desc;
436 char *a_type; /* description */
439 struct berval **a_vals;
440 struct slap_attr *a_next;
443 #ifndef SLAPD_SCHEMA_NOT_COMPAT
445 * the attr_syntax() routine returns one of these values
446 * telling what kind of syntax an attribute supports.
448 #define SYNTAX_CIS 0x01 /* case insensitive string */
449 #define SYNTAX_CES 0x02 /* case sensitive string */
450 #define SYNTAX_BIN 0x04 /* binary data */
451 #define SYNTAX_TEL 0x08 /* telephone number string */
452 #define SYNTAX_DN 0x10 /* dn string */
456 * the id used in the indexes to refer to an entry
458 typedef unsigned long ID;
459 #define NOID ((ID)~0)
462 * represents an entry in core
464 typedef struct slap_entry {
466 * The ID field should only be changed before entry is
467 * inserted into a cache. The ID value is backend
472 char *e_dn; /* DN of this entry */
473 char *e_ndn; /* normalized DN of this entry */
474 Attribute *e_attrs; /* list of attributes + values */
476 /* for use by the backend for any purpose */
483 #ifdef SLAPD_SCHEMA_NOT_COMPAT
484 typedef struct slap_mod {
486 AttributeDescription *sm_desc;
487 struct berval **sm_bvalues;
490 #define Modification LDAPMod
492 #define sm_desc mod_type
493 #define sm_bvalues mod_bvalues
496 typedef struct slap_mod_list {
497 Modification sml_mod;
498 #define sml_op sml_mod.sm_op
499 #define sml_desc sml_mod.sm_desc
500 #define sml_bvalues sml_mod.sm_bvalues
501 #ifndef SLAPD_SCHEMA_NOT_COMPAT
502 #define sml_type sml_mod.sm_desc
504 struct slap_mod_list *sml_next;
507 #ifdef SLAPD_SCHEMA_NOT_COMPAT
508 typedef struct slap_ldap_modlist {
510 struct slap_ldap_modlist *ml_next;
511 #define ml_op ml_mod.mod_op
512 #define ml_type ml_mod.mod_type
513 #define ml_values ml_mod.mod_values
514 #define ml_bvalues ml_mod.mod_bvalues
517 #define LDAPModList Modifications
518 #define ml_mod sml_mod
519 #define ml_op sml_mod.mod_op
520 #define ml_type sml_mod.mod_type
521 #define ml_values sml_mod.mod_values
522 #define ml_bvalues sml_mod.mod_bvalues
523 #define ml_next sml_next
527 * represents an access control list
530 typedef enum slap_access_e {
531 ACL_INVALID_ACCESS = -1,
540 typedef enum slap_control_e {
541 ACL_INVALID_CONTROL = 0,
547 typedef unsigned long slap_access_mask_t;
550 typedef struct slap_access {
551 slap_control_t a_type;
553 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
555 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
556 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
557 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
558 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
559 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
560 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
562 #define ACL_PRIV_MASK 0x00ffUL
565 #define ACL_PRIV_LEVEL 0x1000UL
566 #define ACL_PRIV_ADDITIVE 0x2000UL
567 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
570 #define ACL_PRIV_INVALID 0x0UL
572 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
573 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
574 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
575 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
577 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
578 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
580 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
582 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
584 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
585 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
586 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
588 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
589 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
590 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
591 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
592 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
593 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
595 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
596 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
597 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
598 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
599 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
600 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
601 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
603 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
604 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
605 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
606 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
607 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
608 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
610 slap_access_mask_t a_mask;
613 #ifdef SLAPD_SCHEMA_NOT_COMPAT
614 AttributeDescription *a_dn_at;
620 char *a_peername_pat;
621 char *a_sockname_pat;
626 #ifdef SLAPD_ACI_ENABLED
627 #ifdef SLAPD_SCHEMA_NOT_COMPAT
628 AttributeDescription *a_aci_at;
637 #ifdef SLAPD_SCHEMA_NOT_COMPAT
638 AttributeDescription *a_group_at;
643 struct slap_access *a_next;
647 typedef struct slap_acl {
648 /* "to" part: the entries this acl applies to */
654 /* "by" part: list of who has what access to the entries */
657 struct slap_acl *acl_next;
661 * replog moddn param structure
663 struct replog_moddn {
671 * represents a backend
674 typedef struct slap_backend_info BackendInfo; /* per backend type */
675 typedef struct slap_backend_db BackendDB; /* per backend database */
677 LIBSLAPD_F (int) nBackendInfo;
678 LIBSLAPD_F (int) nBackendDB;
679 LIBSLAPD_F (BackendInfo *) backendInfo;
680 LIBSLAPD_F (BackendDB *) backendDB;
682 LIBSLAPD_F (int) slapMode;
683 #define SLAP_UNDEFINED_MODE 0x0000
684 #define SLAP_SERVER_MODE 0x0001
685 #define SLAP_TOOL_MODE 0x0002
686 #define SLAP_MODE 0x0003
688 #define SLAP_TRUNCATE_MODE 0x0100
690 #define SLAP_TIMED_MODE 0x1000
692 #define SLAP_TOOLID_MODE 4
694 /* temporary aliases */
695 typedef BackendDB Backend;
696 #define nbackends nBackendDB
697 #define backends backendDB
699 struct slap_backend_db {
700 BackendInfo *bd_info; /* pointer to shared backend info */
702 /* BackendInfo accessors */
703 #define be_config bd_info->bi_db_config
704 #define be_type bd_info->bi_type
706 #define be_bind bd_info->bi_op_bind
707 #define be_unbind bd_info->bi_op_unbind
708 #define be_add bd_info->bi_op_add
709 #define be_compare bd_info->bi_op_compare
710 #define be_delete bd_info->bi_op_delete
711 #define be_modify bd_info->bi_op_modify
712 #define be_modrdn bd_info->bi_op_modrdn
713 #define be_search bd_info->bi_op_search
715 #define be_extended bd_info->bi_extended
717 #define be_release bd_info->bi_entry_release_rw
718 #define be_group bd_info->bi_acl_group
720 #define be_controls bd_info->bi_controls
722 #define be_connection_init bd_info->bi_connection_init
723 #define be_connection_destroy bd_info->bi_connection_destroy
726 #define be_entry_open bd_info->bi_tool_entry_open
727 #define be_entry_close bd_info->bi_tool_entry_close
728 #define be_entry_first bd_info->bi_tool_entry_first
729 #define be_entry_next bd_info->bi_tool_entry_next
730 #define be_entry_get bd_info->bi_tool_entry_get
731 #define be_entry_put bd_info->bi_tool_entry_put
732 #define be_index_attr bd_info->bi_tool_index_attr
733 #define be_index_change bd_info->bi_tool_index_change
734 #define be_sync bd_info->bi_tool_sync
737 #ifdef HAVE_CYRUS_SASL
738 #define be_sasl_authorize bd_info->bi_sasl_authorize
739 #define be_sasl_getsecret bd_info->bi_sasl_getsecret
740 #define be_sasl_putsecret bd_info->bi_sasl_putsecret
743 /* these should be renamed from be_ to bd_ */
744 char **be_suffix; /* the DN suffixes of data in this backend */
745 char **be_nsuffix; /* the normalized DN suffixes in this backend */
746 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
747 char *be_root_dn; /* the magic "root" dn for this db */
748 char *be_root_ndn; /* the magic "root" normalized dn for this db */
749 struct berval be_root_pw; /* the magic "root" password for this db */
750 int be_readonly; /* 1 => db is in "read only" mode */
751 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
752 int be_sizelimit; /* size limit for this backend */
753 int be_timelimit; /* time limit for this backend */
754 AccessControl *be_acl; /* access control list for this backend */
755 slap_access_t be_dfltaccess; /* access given if no acl matches */
756 char **be_replica; /* replicas of this backend (in master) */
757 char *be_replogfile; /* replication log file (in master) */
758 char *be_update_ndn; /* allowed to make changes (in replicas) */
759 struct berval **be_update_refs; /* where to refer modifying clients to */
760 int be_lastmod; /* keep track of lastmodified{by,time} */
764 void *be_private; /* anything the backend database needs */
770 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
772 struct slap_conn *conn,
775 struct berval * reqdata,
777 struct berval ** rspdata,
778 LDAPControl *** rspctrls,
780 struct berval *** refs ));
782 struct slap_backend_info {
783 char *bi_type; /* type of backend */
786 * per backend type routines:
787 * bi_init: called to allocate a backend_info structure,
788 * called once BEFORE configuration file is read.
789 * bi_init() initializes this structure hence is
790 * called directly from be_initialize()
791 * bi_config: called per 'backend' specific option
792 * all such options must before any 'database' options
793 * bi_config() is called only from read_config()
794 * bi_open: called to open each database, called
795 * once AFTER configuration file is read but
796 * BEFORE any bi_db_open() calls.
797 * bi_open() is called from backend_startup()
798 * bi_close: called to close each database, called
799 * once during shutdown after all bi_db_close calls.
800 * bi_close() is called from backend_shutdown()
801 * bi_destroy: called to destroy each database, called
802 * once during shutdown after all bi_db_destroy calls.
803 * bi_destory() is called from backend_destroy()
805 int (*bi_init) LDAP_P((BackendInfo *bi));
806 int (*bi_config) LDAP_P((BackendInfo *bi,
807 const char *fname, int lineno, int argc, char **argv ));
808 int (*bi_open) LDAP_P((BackendInfo *bi));
809 int (*bi_close) LDAP_P((BackendInfo *bi));
810 int (*bi_destroy) LDAP_P((BackendInfo *bi));
813 * per database routines:
814 * bi_db_init: called to initialize each database,
815 * called upon reading 'database <type>'
816 * called only from backend_db_init()
817 * bi_db_config: called to configure each database,
818 * called per database to handle per database options
819 * called only from read_config()
820 * bi_db_open: called to open each database
821 * called once per database immediately AFTER bi_open()
822 * calls but before daemon startup.
823 * called only by backend_startup()
824 * bi_db_close: called to close each database
825 * called once per database during shutdown but BEFORE
827 * called only by backend_shutdown()
828 * bi_db_destroy: called to destroy each database
829 * called once per database during shutdown AFTER all
830 * bi_close calls but before bi_destory calls.
831 * called only by backend_destory()
833 int (*bi_db_init) LDAP_P((Backend *bd));
834 int (*bi_db_config) LDAP_P((Backend *bd,
835 const char *fname, int lineno, int argc, char **argv ));
836 int (*bi_db_open) LDAP_P((Backend *bd));
837 int (*bi_db_close) LDAP_P((Backend *bd));
838 int (*bi_db_destroy) LDAP_P((Backend *db));
840 /* LDAP Operations Handling Routines */
841 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
842 struct slap_conn *c, struct slap_op *o,
843 char *dn, char *ndn, int method, char* mechanism,
844 struct berval *cred, char** edn ));
845 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
846 struct slap_conn *c, struct slap_op *o ));
847 int (*bi_op_search) LDAP_P((BackendDB *bd,
848 struct slap_conn *c, struct slap_op *o,
849 char *base, char *nbase, int scope, int deref,
850 int slimit, int tlimit,
851 Filter *f, char *filterstr, char **attrs,
853 #ifdef SLAPD_SCHEMA_NOT_COMPAT
854 int (*bi_op_compare)LDAP_P((BackendDB *bd,
855 struct slap_conn *c, struct slap_op *o,
856 char *dn, char *ndn, AttributeAssertion *ava));
858 int (*bi_op_compare)LDAP_P((BackendDB *bd,
859 struct slap_conn *c, struct slap_op *o,
860 char *dn, char *ndn, Ava *ava));
862 int (*bi_op_modify) LDAP_P((BackendDB *bd,
863 struct slap_conn *c, struct slap_op *o,
864 char *dn, char *ndn, Modifications *m));
865 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
866 struct slap_conn *c, struct slap_op *o,
867 char *dn, char *ndn, char *newrdn, int deleteoldrdn,
869 int (*bi_op_add) LDAP_P((BackendDB *bd,
870 struct slap_conn *c, struct slap_op *o,
872 int (*bi_op_delete) LDAP_P((BackendDB *bd,
873 struct slap_conn *c, struct slap_op *o,
874 char *dn, char *ndn));
875 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
876 struct slap_conn *c, struct slap_op *o,
879 /* Extended Operations Helper */
880 SLAP_EXTENDED_FN bi_extended;
882 /* Auxilary Functions */
883 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
885 #ifdef SLAPD_SCHEMA_NOT_COMPAT
886 int (*bi_acl_group) LDAP_P((Backend *bd,
887 Entry *e, const char *bdn, const char *edn,
888 const char *objectclassValue,
889 AttributeDescription *group_at ));
891 int (*bi_acl_group) LDAP_P((Backend *bd,
892 Entry *e, const char *bdn, const char *edn,
893 const char *objectclassValue,
894 const char *group_at ));
897 int (*bi_connection_init) LDAP_P((BackendDB *bd,
898 struct slap_conn *c));
899 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
900 struct slap_conn *c));
902 /* hooks for slap tools */
903 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
904 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
905 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
906 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
907 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
908 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
909 #ifdef SLAPD_SCHEMA_NOT_COMPAT
910 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
911 AttributeDescription *desc ));
912 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
913 AttributeDescription *desc,
914 struct berval **bv, ID id, int op ));
916 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be,
918 int (*bi_tool_index_change) LDAP_P(( BackendDB *be,
919 char* type, struct berval **bv, ID id, int op ));
921 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
923 #ifdef HAVE_CYRUS_SASL
924 int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
925 const char *authnid, const char *authzid,
926 const char **canon_authzid, const char **errstr ));
927 int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
928 const char *mechanism, const char *authzid,
929 const char *realm, sasl_secret_t **secret ));
930 int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
931 const char *mechanism, const char *auth_identity,
932 const char *realm, const sasl_secret_t *secret ));
933 #endif /* HAVE_CYRUS_SASL */
935 #define SLAP_INDEX_ADD_OP 0x0001
936 #define SLAP_INDEX_DELETE_OP 0x0002
938 char **bi_controls; /* supported controls */
940 unsigned int bi_nDB; /* number of databases of this type */
941 void *bi_private; /* anything the backend type needs */
945 * represents an operation pending from an ldap client
948 typedef struct slap_op {
949 ber_int_t o_opid; /* id of this operation */
950 ber_int_t o_msgid; /* msgid of the request */
952 ldap_pvt_thread_t o_tid; /* thread handling this op */
954 BerElement *o_ber; /* ber of the request */
956 ber_tag_t o_tag; /* tag of the request */
957 time_t o_time; /* time op was initiated */
960 /* should only be used for reporting purposes */
961 char *o_authc_dn; /* authentication DN */
963 /* should be used as the DN of the User */
964 char *o_authz_dn; /* authorization DN */
965 char *o_authz_ndn; /* authorizaiton NDN */
968 char *o_dn; /* dn bound when op was initiated */
969 char *o_ndn; /* normalized dn bound when op was initiated */
972 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
973 ber_tag_t o_authtype; /* auth method used to bind dn */
974 /* values taken from ldap.h */
976 char *o_authmech; /* SASL mechanism used to bind dn */
978 LDAPControl **o_ctrls; /* controls */
980 unsigned long o_connid; /* id of conn initiating this op */
982 #ifdef LDAP_CONNECTIONLESS
983 int o_cldap; /* != 0 if this came in via CLDAP */
984 struct sockaddr o_clientaddr; /* client address if via CLDAP */
985 char o_searchbase; /* search base if via CLDAP */
988 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
989 int o_abandon; /* abandon flag */
991 struct slap_op *o_next; /* next operation in list */
992 void *o_private; /* anything the backend needs */
996 * represents a connection from an ldap client
999 typedef struct slap_conn {
1000 int c_struct_state; /* structure management state */
1001 int c_conn_state; /* connection state */
1003 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
1004 Sockbuf *c_sb; /* ber connection stuff */
1006 /* only can be changed by connect_init */
1007 time_t c_starttime; /* when the connection was opened */
1008 time_t c_activitytime; /* when the connection was last used */
1009 unsigned long c_connid; /* id of this connection for stats*/
1011 char *c_listener_url; /* listener URL */
1012 char *c_peer_domain; /* DNS name of client */
1013 char *c_peer_name; /* peer name (trans=addr:port) */
1014 char *c_sock_name; /* sock name (trans=addr:port) */
1016 /* only can be changed by binding thread */
1017 int c_sasl_bind_in_progress; /* multi-op bind in progress */
1018 char *c_sasl_bind_mech; /* mech in progress */
1019 #ifdef HAVE_CYRUS_SASL
1020 sasl_conn_t *c_sasl_bind_context; /* Cyrus SASL state data */
1023 /* authentication backend */
1024 Backend *c_authc_backend;
1026 /* authorization backend - normally same as c_authc_backend */
1027 Backend *c_authz_backend;
1030 /* authentication backend */
1031 /* should only be used for reporting purposes */
1032 char *c_authc_dn; /* authentication DN */
1034 /* should be used as the DN of the User */
1035 char *c_authz_dn; /* authorization DN */
1036 char *c_authz_ndn; /* authorization NDN */
1039 char *c_cdn; /* DN provided by the client */
1040 char *c_dn; /* DN bound to this conn */
1043 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
1044 ber_tag_t c_authtype;/* auth method used to bind c_dn */
1045 char *c_authmech; /* SASL mechanism used to bind c_dn */
1047 Operation *c_ops; /* list of operations being processed */
1048 Operation *c_pending_ops; /* list of pending operations */
1050 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
1051 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
1053 BerElement *c_currentber; /* ber we're attempting to read */
1054 int c_writewaiter; /* true if writer is waiting */
1057 int c_is_tls; /* true if this LDAP over raw TLS */
1058 int c_needs_tls_accept; /* true if SSL_accept should be called */
1061 long c_n_ops_received; /* num of ops received (next op_id) */
1062 long c_n_ops_executing; /* num of ops currently executing */
1063 long c_n_ops_pending; /* num of ops pending execution */
1064 long c_n_ops_completed; /* num of ops completed */
1066 long c_n_get; /* num of get calls */
1067 long c_n_read; /* num of read calls */
1068 long c_n_write; /* num of write calls */
1071 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
1072 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
1074 if ( ldap_debug & (level) ) \
1075 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
1076 if ( ldap_syslog & (level) ) \
1077 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
1081 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
1086 #include "proto-slap.h"
1088 #endif /* _SLAP_H_ */