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 LDAP_MOD_SOFTADD 0x1000
62 #define MAXREMATCHES 10
64 /* psuedo error code to indicating abandoned operation */
65 #define SLAPD_ABANDON -1
67 /* XXYYZ: these macros assume 'x' is an ASCII x */
68 #define DNSEPARATOR(c) ((c) == ',' || (c) == ';')
69 #define SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
70 #define SPACE(c) ((c) == ' ' || (c) == '\n')
72 #define ASCII_LOWER(c) ( (c) >= 'a' && (c) <= 'z' )
73 #define ASCII_UPPER(c) ( (c) >= 'A' && (c) <= 'Z' )
74 #define ASCII_ALPHA(c) ( ASCII_LOWER(c) || ASCII_UPPER(c) )
75 #define ASCII_DIGIT(c) ( (c) >= '0' && (c) <= '9' )
76 #define ASCII_ALNUM(c) ( ASCII_ALPHA(c) || ASCII_DIGIT(c) )
78 #define LEADKEYCHAR(c) ( ASCII_ALPHA(c) )
79 #define KEYCHAR(c) ( ASCII_ALNUM(c) || (c) == '-' )
80 #define LEADOIDCHAR(c) ( ASCII_DIGIT(c) )
81 #define OIDCHAR(c) ( ASCII_DIGIT(c) || (c) == '.' )
83 #define LEADATTRCHAR(c) ( LEADKEYCHAR(c) || LEADOIDCHAR(c) )
84 #define ATTRCHAR(c) ( KEYCHAR((c)) || (c) == '.' )
86 #define NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
88 #define SLAP_SCHERR_OUTOFMEM 1
89 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
90 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
91 #define SLAP_SCHERR_DUP_CLASS 4
92 #define SLAP_SCHERR_DUP_ATTR 5
93 #define SLAP_SCHERR_DUP_SYNTAX 6
94 #define SLAP_SCHERR_DUP_RULE 7
95 #define SLAP_SCHERR_NO_NAME 8
96 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
97 #define SLAP_SCHERR_MR_NOT_FOUND 10
98 #define SLAP_SCHERR_SYN_NOT_FOUND 11
99 #define SLAP_SCHERR_MR_INCOMPLETE 12
101 #define SLAPD_ACI_DEFAULT_ATTR "aci"
103 LIBSLAPD_F (int) slap_debug;
108 struct replog_moddn {
115 * represents an attribute value assertion (i.e., attr=value)
117 typedef struct slap_ava {
118 char *ava_type; /* attribute description */
119 struct berval ava_value;
122 typedef struct slap_mra {
124 char *mra_type; /* attribute description */
130 * represents a search filter
132 typedef struct slap_filter {
133 ber_tag_t f_choice; /* values taken from ldap.h */
139 /* equality, lessorequal, greaterorequal, approx */
146 struct slap_filter *f_un_complex;
151 char *f_un_sub_initial;
153 char *f_un_sub_final;
157 #define f_dn f_un.f_un_type /* used for DN indices */
158 #define f_type f_un.f_un_type
159 #define f_ava f_un.f_un_ava
160 #define f_avtype f_un.f_un_ava.ava_type
161 #define f_avvalue f_un.f_un_ava.ava_value
162 #define f_mra f_un.f_un_mra
163 #define f_mrtype f_un.f_un_mra.mra_type
164 #define f_mrvalue f_un.f_un_mra.mra_value
165 #define f_mrdnaddrs f_un.f_un_mra.mra_dnattrs
166 #define f_and f_un.f_un_complex
167 #define f_or f_un.f_un_complex
168 #define f_not f_un.f_un_complex
169 #define f_list f_un.f_un_complex
170 #define f_sub f_un.f_un_sub
171 #define f_sub_type f_un.f_un_sub.f_un_sub_type
172 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
173 #define f_sub_any f_un.f_un_sub.f_un_sub_any
174 #define f_sub_final f_un.f_un_sub.f_un_sub_final
176 struct slap_filter *f_next;
180 * represents an attribute (type + values + syntax)
182 typedef struct slap_attr {
183 char *a_type; /* description */
184 struct berval **a_vals;
186 struct slap_attr *a_next;
190 * the attr_syntax() routine returns one of these values
191 * telling what kind of syntax an attribute supports.
193 #define SYNTAX_CIS 0x01 /* case insensitive string */
194 #define SYNTAX_CES 0x02 /* case sensitive string */
195 #define SYNTAX_BIN 0x04 /* binary data */
196 #define SYNTAX_TEL 0x08 /* telephone number string */
197 #define SYNTAX_DN 0x10 /* dn string */
200 * the id used in the indexes to refer to an entry
202 typedef unsigned long ID;
203 #define NOID ((ID)~0)
206 * represents an entry in core
208 typedef struct slap_entry {
210 * The ID field should only be changed before entry is
211 * inserted into a cache. The ID value is backend
216 char *e_dn; /* DN of this entry */
217 char *e_ndn; /* normalized DN of this entry */
218 Attribute *e_attrs; /* list of attributes + values */
220 /* for use by the backend for any purpose */
225 * represents an access control list
228 typedef enum slap_access_e {
229 ACL_INVALID_ACCESS = -1,
238 typedef enum slap_control_e {
239 ACL_INVALID_CONTROL = 0,
245 typedef unsigned long slap_access_mask_t;
248 typedef struct slap_access {
249 slap_control_t a_type;
251 #define ACL_ACCESS2PRIV(access) (0x01U << (access))
253 #define ACL_PRIV_NONE ACL_ACCESS2PRIV( ACL_NONE )
254 #define ACL_PRIV_AUTH ACL_ACCESS2PRIV( ACL_AUTH )
255 #define ACL_PRIV_COMPARE ACL_ACCESS2PRIV( ACL_COMPARE )
256 #define ACL_PRIV_SEARCH ACL_ACCESS2PRIV( ACL_SEARCH )
257 #define ACL_PRIV_READ ACL_ACCESS2PRIV( ACL_READ )
258 #define ACL_PRIV_WRITE ACL_ACCESS2PRIV( ACL_WRITE )
260 #define ACL_PRIV_MASK 0x00ffUL
263 #define ACL_PRIV_LEVEL 0x1000UL
264 #define ACL_PRIV_ADDITIVE 0x2000UL
265 #define ACL_PRIV_SUBSTRACTIVE 0x4000UL
268 #define ACL_PRIV_INVALID 0x0UL
270 #define ACL_PRIV_ISSET(m,p) (((m) & (p)) == (p))
271 #define ACL_PRIV_ASSIGN(m,p) do { (m) = (p); } while(0)
272 #define ACL_PRIV_SET(m,p) do { (m) |= (p); } while(0)
273 #define ACL_PRIV_CLR(m,p) do { (m) &= ~(p); } while(0)
275 #define ACL_INIT(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_NONE)
276 #define ACL_INVALIDATE(m) ACL_PRIV_ASSIGN(m, ACL_PRIV_INVALID)
278 #define ACL_GRANT(m,a) ACL_PRIV_ISSET((m),ACL_ACCESS2PRIV(a))
280 #define ACL_IS_INVALID(m) ((m) == ACL_PRIV_INVALID)
282 #define ACL_IS_LEVEL(m) ACL_PRIV_ISSET((m),ACL_PRIV_LEVEL)
283 #define ACL_IS_ADDITIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_ADDITIVE)
284 #define ACL_IS_SUBTRACTIVE(m) ACL_PRIV_ISSET((m),ACL_PRIV_SUBSTRACTIVE)
286 #define ACL_LVL_NONE (ACL_PRIV_NONE|ACL_PRIV_LEVEL)
287 #define ACL_LVL_AUTH (ACL_PRIV_AUTH|ACL_LVL_NONE)
288 #define ACL_LVL_COMPARE (ACL_PRIV_COMPARE|ACL_LVL_AUTH)
289 #define ACL_LVL_SEARCH (ACL_PRIV_SEARCH|ACL_LVL_COMPARE)
290 #define ACL_LVL_READ (ACL_PRIV_READ|ACL_LVL_SEARCH)
291 #define ACL_LVL_WRITE (ACL_PRIV_WRITE|ACL_LVL_READ)
293 #define ACL_LVL(m,l) (((m)&ACL_PRIV_MASK) == ((l)&ACL_PRIV_MASK))
294 #define ACL_LVL_IS_NONE(m) ACL_LVL((m),ACL_LVL_NONE)
295 #define ACL_LVL_IS_AUTH(m) ACL_LVL((m),ACL_LVL_AUTH)
296 #define ACL_LVL_IS_COMPARE(m) ACL_LVL((m),ACL_LVL_COMPARE)
297 #define ACL_LVL_IS_SEARCH(m) ACL_LVL((m),ACL_LVL_SEARCH)
298 #define ACL_LVL_IS_READ(m) ACL_LVL((m),ACL_LVL_READ)
299 #define ACL_LVL_IS_WRITE(m) ACL_LVL((m),ACL_LVL_WRITE)
301 #define ACL_LVL_ASSIGN_NONE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_NONE)
302 #define ACL_LVL_ASSIGN_AUTH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_AUTH)
303 #define ACL_LVL_ASSIGN_COMPARE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_COMPARE)
304 #define ACL_LVL_ASSIGN_SEARCH(m) ACL_PRIV_ASSIGN((m),ACL_LVL_SEARCH)
305 #define ACL_LVL_ASSIGN_READ(m) ACL_PRIV_ASSIGN((m),ACL_LVL_READ)
306 #define ACL_LVL_ASSIGN_WRITE(m) ACL_PRIV_ASSIGN((m),ACL_LVL_WRITE)
308 slap_access_mask_t a_mask;
314 char *a_peername_pat;
315 char *a_sockname_pat;
320 #ifdef SLAPD_ACI_ENABLED
329 struct slap_access *a_next;
333 typedef struct slap_acl {
334 /* "to" part: the entries this acl applies to */
340 /* "by" part: list of who has what access to the entries */
343 struct slap_acl *acl_next;
349 typedef struct ldapmodlist {
350 struct ldapmod ml_mod;
351 struct ldapmodlist *ml_next;
352 #define ml_op ml_mod.mod_op
353 #define ml_type ml_mod.mod_type
354 #define ml_values ml_mod.mod_values
355 #define ml_bvalues ml_mod.mod_bvalues
359 * represents schema information for a database
361 typedef struct slap_oid_macro {
362 struct slap_oid_macro *next;
368 typedef int slap_syntax_validate_func LDAP_P((
369 struct berval * in));
371 typedef int slap_syntax_normalize_func LDAP_P((
373 struct berval ** out));
375 typedef struct slap_syntax {
376 LDAP_SYNTAX ssyn_syn;
377 slap_syntax_validate_func *ssyn_validate;
378 slap_syntax_normalize_func *ssyn_normalize;
379 struct slap_syntax *ssyn_next;
380 #define ssyn_oid ssyn_syn.syn_oid
381 #define ssyn_desc ssyn_syn.syn_desc
384 typedef int slap_mr_match_func LDAP_P((
385 struct berval * atval,
386 struct berval * matchval));
388 typedef struct slap_matching_rule {
389 LDAP_MATCHING_RULE smr_mrule;
390 slap_mr_match_func *smr_match;
392 struct slap_matching_rule *smr_next;
393 #define smr_oid smr_mrule.mr_oid
394 #define smr_names smr_mrule.mr_names
395 #define smr_desc smr_mrule.mr_desc
396 #define smr_obsolete smr_mrule.mr_obsolete
397 #define smr_syntax_oid smr_mrule.mr_syntax_oid
400 typedef struct slap_attribute_type {
401 LDAP_ATTRIBUTE_TYPE sat_atype;
402 struct slap_attribute_type *sat_sup;
403 struct slap_attribute_type **sat_subtypes;
404 MatchingRule *sat_equality;
405 MatchingRule *sat_ordering;
406 MatchingRule *sat_substr;
408 /* The next one is created to help in the transition */
409 int sat_syntax_compat;
410 struct slap_attribute_type *sat_next;
411 #define sat_oid sat_atype.at_oid
412 #define sat_names sat_atype.at_names
413 #define sat_desc sat_atype.at_desc
414 #define sat_obsolete sat_atype.at_obsolete
415 #define sat_sup_oid sat_atype.at_sup_oid
416 #define sat_equality_oid sat_atype.at_equality_oid
417 #define sat_ordering_oid sat_atype.at_ordering_oid
418 #define sat_substr_oid sat_atype.at_substr_oid
419 #define sat_syntax_oid sat_atype.at_syntax_oid
420 #define sat_single_value sat_atype.at_single_value
421 #define sat_collective sat_atype.at_collective
422 #define sat_no_user_mods sat_atype.at_no_user_mods
423 #define sat_usage sat_atype.at_usage
426 typedef struct slap_object_class {
427 LDAP_OBJECT_CLASS 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
444 * represents a backend
447 typedef struct slap_backend_info BackendInfo; /* per backend type */
448 typedef struct slap_backend_db BackendDB; /* per backend database */
450 LIBSLAPD_F (int) nBackendInfo;
451 LIBSLAPD_F (int) nBackendDB;
452 LIBSLAPD_F (BackendInfo *) backendInfo;
453 LIBSLAPD_F (BackendDB *) backendDB;
455 LIBSLAPD_F (int) slapMode;
456 #define SLAP_UNDEFINED_MODE 0x0000
457 #define SLAP_SERVER_MODE 0x0001
458 #define SLAP_TOOL_MODE 0x0002
459 #define SLAP_MODE 0x0003
461 #define SLAP_TRUNCATE_MODE 0x0100
463 #define SLAP_TIMED_MODE 0x1000
465 #define SLAP_TOOLID_MODE 4
467 /* temporary aliases */
468 typedef BackendDB Backend;
469 #define nbackends nBackendDB
470 #define backends backendDB
472 struct slap_backend_db {
473 BackendInfo *bd_info; /* pointer to shared backend info */
475 /* BackendInfo accessors */
476 #define be_config bd_info->bi_db_config
477 #define be_type bd_info->bi_type
479 #define be_bind bd_info->bi_op_bind
480 #define be_unbind bd_info->bi_op_unbind
481 #define be_add bd_info->bi_op_add
482 #define be_compare bd_info->bi_op_compare
483 #define be_delete bd_info->bi_op_delete
484 #define be_modify bd_info->bi_op_modify
485 #define be_modrdn bd_info->bi_op_modrdn
486 #define be_search bd_info->bi_op_search
488 #define be_extended bd_info->bi_extended
490 #define be_release bd_info->bi_entry_release_rw
491 #define be_group bd_info->bi_acl_group
493 #define be_controls bd_info->bi_controls
495 #define be_connection_init bd_info->bi_connection_init
496 #define be_connection_destroy bd_info->bi_connection_destroy
499 #define be_entry_open bd_info->bi_tool_entry_open
500 #define be_entry_close bd_info->bi_tool_entry_close
501 #define be_entry_first bd_info->bi_tool_entry_first
502 #define be_entry_next bd_info->bi_tool_entry_next
503 #define be_entry_get bd_info->bi_tool_entry_get
504 #define be_entry_put bd_info->bi_tool_entry_put
505 #define be_index_attr bd_info->bi_tool_index_attr
506 #define be_index_change bd_info->bi_tool_index_change
507 #define be_sync bd_info->bi_tool_sync
510 #ifdef HAVE_CYRUS_SASL
511 #define be_sasl_authorize bd_info->bi_sasl_authorize
512 #define be_sasl_getsecret bd_info->bi_sasl_getsecret
513 #define be_sasl_putsecret bd_info->bi_sasl_putsecret
516 /* these should be renamed from be_ to bd_ */
517 char **be_suffix; /* the DN suffixes of data in this backend */
518 char **be_nsuffix; /* the normalized DN suffixes in this backend */
519 char **be_suffixAlias; /* pairs of DN suffix aliases and deref values */
520 char *be_root_dn; /* the magic "root" dn for this db */
521 char *be_root_ndn; /* the magic "root" normalized dn for this db */
522 struct berval be_root_pw; /* the magic "root" password for this db */
523 int be_readonly; /* 1 => db is in "read only" mode */
524 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
525 int be_sizelimit; /* size limit for this backend */
526 int be_timelimit; /* time limit for this backend */
527 AccessControl *be_acl; /* access control list for this backend */
528 slap_access_t be_dfltaccess; /* access given if no acl matches */
529 char **be_replica; /* replicas of this backend (in master) */
530 char *be_replogfile; /* replication log file (in master) */
531 char *be_update_ndn; /* allowed to make changes (in replicas) */
532 struct berval **be_update_refs; /* where to refer modifying clients to */
533 int be_lastmod; /* keep track of lastmodified{by,time} */
537 void *be_private; /* anything the backend database needs */
540 typedef int (*SLAP_EXTENDED_FN) LDAP_P((
542 struct slap_conn *conn,
545 struct berval * reqdata,
547 struct berval ** rspdata,
548 LDAPControl *** rspctrls,
550 struct berval *** refs ));
552 struct slap_backend_info {
553 char *bi_type; /* type of backend */
556 * per backend type routines:
557 * bi_init: called to allocate a backend_info structure,
558 * called once BEFORE configuration file is read.
559 * bi_init() initializes this structure hence is
560 * called directly from be_initialize()
561 * bi_config: called per 'backend' specific option
562 * all such options must before any 'database' options
563 * bi_config() is called only from read_config()
564 * bi_open: called to open each database, called
565 * once AFTER configuration file is read but
566 * BEFORE any bi_db_open() calls.
567 * bi_open() is called from backend_startup()
568 * bi_close: called to close each database, called
569 * once during shutdown after all bi_db_close calls.
570 * bi_close() is called from backend_shutdown()
571 * bi_destroy: called to destroy each database, called
572 * once during shutdown after all bi_db_destroy calls.
573 * bi_destory() is called from backend_destroy()
575 int (*bi_init) LDAP_P((BackendInfo *bi));
576 int (*bi_config) LDAP_P((BackendInfo *bi,
577 const char *fname, int lineno, int argc, char **argv ));
578 int (*bi_open) LDAP_P((BackendInfo *bi));
579 int (*bi_close) LDAP_P((BackendInfo *bi));
580 int (*bi_destroy) LDAP_P((BackendInfo *bi));
583 * per database routines:
584 * bi_db_init: called to initialize each database,
585 * called upon reading 'database <type>'
586 * called only from backend_db_init()
587 * bi_db_config: called to configure each database,
588 * called per database to handle per database options
589 * called only from read_config()
590 * bi_db_open: called to open each database
591 * called once per database immediately AFTER bi_open()
592 * calls but before daemon startup.
593 * called only by backend_startup()
594 * bi_db_close: called to close each database
595 * called once per database during shutdown but BEFORE
597 * called only by backend_shutdown()
598 * bi_db_destroy: called to destroy each database
599 * called once per database during shutdown AFTER all
600 * bi_close calls but before bi_destory calls.
601 * called only by backend_destory()
603 int (*bi_db_init) LDAP_P((Backend *bd));
604 int (*bi_db_config) LDAP_P((Backend *bd,
605 const char *fname, int lineno, int argc, char **argv ));
606 int (*bi_db_open) LDAP_P((Backend *bd));
607 int (*bi_db_close) LDAP_P((Backend *bd));
608 int (*bi_db_destroy) LDAP_P((Backend *db));
610 /* LDAP Operations Handling Routines */
611 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
612 struct slap_conn *c, struct slap_op *o,
613 char *dn, char *ndn, int method, char* mechanism,
614 struct berval *cred, char** edn ));
615 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
616 struct slap_conn *c, struct slap_op *o ));
617 int (*bi_op_search) LDAP_P((BackendDB *bd,
618 struct slap_conn *c, struct slap_op *o,
619 char *base, char *nbase, int scope, int deref,
620 int slimit, int tlimit,
621 Filter *f, char *filterstr, char **attrs,
623 int (*bi_op_compare)LDAP_P((BackendDB *bd,
624 struct slap_conn *c, struct slap_op *o,
625 char *dn, char *ndn, Ava *ava));
626 int (*bi_op_modify) LDAP_P((BackendDB *bd,
627 struct slap_conn *c, struct slap_op *o,
628 char *dn, char *ndn, LDAPModList *m));
629 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
630 struct slap_conn *c, struct slap_op *o,
631 char *dn, char *ndn, char *newrdn, int deleteoldrdn,
633 int (*bi_op_add) LDAP_P((BackendDB *bd,
634 struct slap_conn *c, struct slap_op *o,
636 int (*bi_op_delete) LDAP_P((BackendDB *bd,
637 struct slap_conn *c, struct slap_op *o,
638 char *dn, char *ndn));
639 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
640 struct slap_conn *c, struct slap_op *o,
643 /* Extended Operations Helper */
644 SLAP_EXTENDED_FN bi_extended;
646 /* Auxilary Functions */
647 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
649 int (*bi_acl_group) LDAP_P((Backend *bd,
650 Entry *e, const char *bdn, const char *edn,
651 const char *objectclassValue, const char *groupattrName ));
653 int (*bi_connection_init) LDAP_P((BackendDB *bd,
654 struct slap_conn *c));
655 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
656 struct slap_conn *c));
658 /* hooks for slap tools */
659 int (*bi_tool_entry_open) LDAP_P(( BackendDB *be, int mode ));
660 int (*bi_tool_entry_close) LDAP_P(( BackendDB *be ));
661 ID (*bi_tool_entry_first) LDAP_P(( BackendDB *be ));
662 ID (*bi_tool_entry_next) LDAP_P(( BackendDB *be ));
663 Entry* (*bi_tool_entry_get) LDAP_P(( BackendDB *be, ID id ));
664 ID (*bi_tool_entry_put) LDAP_P(( BackendDB *be, Entry *e ));
665 int (*bi_tool_index_attr) LDAP_P(( BackendDB *be, char* type ));
666 int (*bi_tool_index_change) LDAP_P(( BackendDB *be, char* type,
667 struct berval **bv, ID id, int op ));
668 int (*bi_tool_sync) LDAP_P(( BackendDB *be ));
670 #ifdef HAVE_CYRUS_SASL
671 int (*bi_sasl_authorize) LDAP_P(( BackendDB *be,
672 const char *authnid, const char *authzid,
673 const char **canon_authzid, const char **errstr ));
674 int (*bi_sasl_getsecret) LDAP_P(( BackendDB *be,
675 const char *mechanism, const char *authzid,
676 const char *realm, sasl_secret_t **secret ));
677 int (*bi_sasl_putsecret) LDAP_P(( BackendDB *be,
678 const char *mechanism, const char *auth_identity,
679 const char *realm, const sasl_secret_t *secret ));
680 #endif /* HAVE_CYRUS_SASL */
682 #define SLAP_INDEX_ADD_OP 0x0001
683 #define SLAP_INDEX_DELETE_OP 0x0002
685 char **bi_controls; /* supported controls */
687 unsigned int bi_nDB; /* number of databases of this type */
688 void *bi_private; /* anything the backend type needs */
692 * represents an operation pending from an ldap client
695 typedef struct slap_op {
696 ber_int_t o_opid; /* id of this operation */
697 ber_int_t o_msgid; /* msgid of the request */
699 ldap_pvt_thread_t o_tid; /* thread handling this op */
701 BerElement *o_ber; /* ber of the request */
703 ber_tag_t o_tag; /* tag of the request */
704 time_t o_time; /* time op was initiated */
706 int o_bind_in_progress; /* multi-step bind in progress */
708 /* should only be used for reporting purposes */
709 char *o_authc_dn; /* authentication DN */
711 /* should be used as the DN of the User */
712 char *o_authz_dn; /* authorization DN */
713 char *o_authz_ndn; /* authorizaiton NDN */
716 char *o_dn; /* dn bound when op was initiated */
717 char *o_ndn; /* normalized dn bound when op was initiated */
720 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
721 ber_tag_t o_authtype; /* auth method used to bind dn */
722 /* values taken from ldap.h */
724 char *o_authmech; /* SASL mechanism used to bind dn */
726 LDAPControl **o_ctrls; /* controls */
728 unsigned long o_connid; /* id of conn initiating this op */
730 #ifdef LDAP_CONNECTIONLESS
731 int o_cldap; /* != 0 if this came in via CLDAP */
732 struct sockaddr o_clientaddr; /* client address if via CLDAP */
733 char o_searchbase; /* search base if via CLDAP */
736 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
737 int o_abandon; /* abandon flag */
739 struct slap_op *o_next; /* next operation in list */
740 void *o_private; /* anything the backend needs */
744 * represents a connection from an ldap client
747 typedef struct slap_conn {
748 int c_struct_state; /* structure management state */
749 int c_conn_state; /* connection state */
751 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
752 Sockbuf *c_sb; /* ber connection stuff */
754 /* only can be changed by connect_init */
755 time_t c_starttime; /* when the connection was opened */
756 time_t c_activitytime; /* when the connection was last used */
757 unsigned long c_connid; /* id of this connection for stats*/
759 char *c_listener_url; /* listener URL */
760 char *c_peer_domain; /* DNS name of client */
761 char *c_peer_name; /* peer name (trans=addr:port) */
762 char *c_sock_name; /* sock name (trans=addr:port) */
764 /* only can be changed by binding thread */
765 int c_bind_in_progress; /* multi-op bind in progress */
766 #ifdef HAVE_CYRUS_SASL
767 sasl_conn_t *c_sasl_context;
769 void *c_authstate; /* SASL state data */
771 Backend *c_authc_backend;
773 /* authorization backend */
774 Backend *c_authz_backend;
777 /* authentication backend */
778 /* should only be used for reporting purposes */
779 char *c_authc_dn; /* authentication DN */
781 /* should be used as the DN of the User */
782 char *c_authz_dn; /* authorization DN */
783 char *c_authz_ndn; /* authorization NDN */
786 char *c_cdn; /* DN provided by the client */
787 char *c_dn; /* DN bound to this conn */
790 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
791 ber_tag_t c_authtype;/* auth method used to bind c_dn */
792 char *c_authmech; /* SASL mechanism used to bind c_dn */
794 Operation *c_ops; /* list of operations being processed */
795 Operation *c_pending_ops; /* list of pending operations */
797 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
798 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
800 BerElement *c_currentber; /* ber we're attempting to read */
801 int c_writewaiter; /* true if writer is waiting */
804 int c_is_tls; /* true if this LDAP over raw TLS */
805 int c_needs_tls_accept; /* true if SSL_accept should be called */
808 long c_n_ops_received; /* num of ops received (next op_id) */
809 long c_n_ops_executing; /* num of ops currently executing */
810 long c_n_ops_pending; /* num of ops pending execution */
811 long c_n_ops_completed; /* num of ops completed */
813 long c_n_get; /* num of get calls */
814 long c_n_read; /* num of read calls */
815 long c_n_write; /* num of write calls */
818 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
819 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
821 if ( ldap_debug & (level) ) \
822 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
823 if ( ldap_syslog & (level) ) \
824 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
828 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
833 #include "proto-slap.h"
835 #endif /* _slap_h_ */