1 /* slap.h - stand alone ldap server include file */
11 #include <ac/socket.h>
17 #define ldap_debug slap_debug
26 #include "ldap_schema.h"
28 #include "ldap_pvt_thread.h"
34 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
37 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
39 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
41 * This is a value used internally by the backends. It is needed to allow
42 * adding values that already exist without getting an error as required by
43 * modrdn when the new rdn was already an attribute value itself.
44 * JCG 05/1999 (gomez@engr.sgi.com)
46 #define LDAP_MOD_SOFTADD 0x1000
55 #define MAXREMATCHES 10
57 #define DNSEPARATOR(c) ((c) == ',' || (c) == ';')
58 #define SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
59 #define SPACE(c) ((c) == ' ' || (c) == '\n')
60 #define NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
62 #define SLAP_SCHERR_OUTOFMEM 1
63 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
64 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
65 #define SLAP_SCHERR_DUP_CLASS 4
66 #define SLAP_SCHERR_DUP_ATTR 5
67 #define SLAP_SCHERR_DUP_SYNTAX 6
68 #define SLAP_SCHERR_DUP_RULE 7
69 #define SLAP_SCHERR_NO_NAME 8
70 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
71 #define SLAP_SCHERR_MR_NOT_FOUND 10
72 #define SLAP_SCHERR_SYN_NOT_FOUND 11
73 #define SLAP_SCHERR_MR_INCOMPLETE 12
75 extern int slap_debug;
81 * represents an attribute value assertion (i.e., attr=value)
85 struct berval ava_value;
96 * represents a search filter
98 typedef struct filter {
99 ber_tag_t f_choice; /* values taken from ldap.h */
105 /* equality, lessorequal, greaterorequal, approx */
112 struct filter *f_un_complex;
117 char *f_un_sub_initial;
119 char *f_un_sub_final;
122 #define f_type f_un.f_un_type
123 #define f_ava f_un.f_un_ava
124 #define f_avtype f_un.f_un_ava.ava_type
125 #define f_avvalue f_un.f_un_ava.ava_value
126 #define f_mra f_un.f_un_mra
127 #define f_mrtype f_un.f_un_mra.mra_type
128 #define f_mrvalue f_un.f_un_mra.mra_value
129 #define f_mrdnaddrs f_un.f_un_mra.mra_dnattrs
130 #define f_and f_un.f_un_complex
131 #define f_or f_un.f_un_complex
132 #define f_not f_un.f_un_complex
133 #define f_list f_un.f_un_complex
134 #define f_sub f_un.f_un_sub
135 #define f_sub_type f_un.f_un_sub.f_un_sub_type
136 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
137 #define f_sub_any f_un.f_un_sub.f_un_sub_any
138 #define f_sub_final f_un.f_un_sub.f_un_sub_final
140 struct filter *f_next;
144 * represents an attribute (type + values + syntax)
146 typedef struct attr {
148 struct berval **a_vals;
154 * the attr_syntax() routine returns one of these values
155 * telling what kind of syntax an attribute supports.
157 #define SYNTAX_CIS 0x01 /* case insensitive string */
158 #define SYNTAX_CES 0x02 /* case sensitive string */
159 #define SYNTAX_BIN 0x04 /* binary data */
160 #define SYNTAX_TEL 0x08 /* telephone number string */
161 #define SYNTAX_DN 0x10 /* dn string */
164 * the id used in the indexes to refer to an entry
166 typedef unsigned long ID;
167 #define NOID ((unsigned long)~0)
170 * represents an entry in core
172 typedef struct entry {
174 * The ID field should only be changed before entry is
175 * inserted into a cache. The ID value is backend
180 char *e_dn; /* DN of this entry */
181 char *e_ndn; /* normalized DN of this entry */
182 Attribute *e_attrs; /* list of attributes + values */
184 /* for use by the backend for any purpose */
189 * represents an access control list
195 #define ACL_NONE 0x0001
196 #define ACL_AUTH 0x0004
197 #define ACL_COMPARE 0x0008
198 #define ACL_SEARCH 0x0010
199 #define ACL_READ 0x0020
200 #define ACL_WRITE 0x0040
201 #define ACL_PRIV_MASK 0x00ff
203 #define ACL_SELF 0x4000
204 #define ACL_INVALID (-1)
206 #define ACL_IS(a,lvl) (((a) & (lvl)) == (lvl))
208 #define ACL_IS_NONE(a) ACL_IS((a),ACL_SELF)
209 #define ACL_IS_AUTH(a) ACL_IS((a),ACL_AUTH)
210 #define ACL_IS_COMPARE(a) ACL_IS((a),ACL_COMPARE)
211 #define ACL_IS_SEARCH(a) ACL_IS((a),ACL_SEARCH)
212 #define ACL_IS_READ(a) ACL_IS((a),ACL_READ)
213 #define ACL_IS_WRITE(a) ACL_IS((a),ACL_WRITE)
214 #define ACL_IS_SELF(a) ACL_IS((a),ACL_SELF)
215 #define ACL_IS_INVALID(a) ((a) == ACL_INVALID)
217 #define ACL_CLR(a) ((a) = 0)
218 #define ACL_SET(a,lvl) ((a) |= (lvl))
219 #define ACL_SET_NONE(a) ACL_SET((a),ACL_SELF)
220 #define ACL_SET_AUTH(a) ACL_SET((a),ACL_AUTH)
221 #define ACL_SET_COMPARE(a) ACL_SET((a),ACL_COMPARE)
222 #define ACL_SET_SEARCH(a) ACL_SET((a),ACL_SEARCH)
223 #define ACL_SET_READ(a) ACL_SET((a),ACL_READ)
224 #define ACL_SET_WRITE(a) ACL_SET((a),ACL_WRITE)
225 #define ACL_SET_SELF(a) ACL_SET((a),ACL_SELF)
226 #define ACL_SET_INVALID(a) ((a) = ACL_INVALID)
228 #define ACL_PRIV(a) ((a) & ACL_PRIV_MASK)
229 #define ACL_GRANT(a,lvl) (ACL_PRIV(a) >= (lvl))
243 struct access *a_next;
248 /* "to" part: the entries this acl applies to */
254 /* "by" part: list of who has what access to the entries */
255 struct access *acl_access;
257 struct acl *acl_next;
263 typedef struct ldapmodlist {
264 struct ldapmod ml_mod;
265 struct ldapmodlist *ml_next;
266 #define ml_op ml_mod.mod_op
267 #define ml_type ml_mod.mod_type
268 #define ml_values ml_mod.mod_values
269 #define ml_bvalues ml_mod.mod_bvalues
273 * represents schema information for a database
275 typedef int slap_syntax_check_func LDAP_P((struct berval * val));
277 typedef struct slap_syntax {
278 LDAP_SYNTAX ssyn_syn;
279 slap_syntax_check_func *ssyn_check;
280 struct slap_syntax *ssyn_next;
282 #define ssyn_oid ssyn_syn.syn_oid
283 #define ssyn_desc ssyn_syn.syn_desc
285 typedef int slap_mr_normalize_func LDAP_P((struct berval * val, struct berval **normalized));
286 typedef int slap_mr_compare_func LDAP_P((struct berval * val1, struct berval * val2));
288 typedef struct slap_matching_rule {
289 LDAP_MATCHING_RULE smr_mrule;
290 slap_mr_normalize_func *smr_normalize;
291 slap_mr_compare_func *smr_compare;
293 struct slap_matching_rule *smr_next;
295 #define smr_oid smr_mrule.mr_oid
296 #define smr_names smr_mrule.mr_names
297 #define smr_desc smr_mrule.mr_desc
298 #define smr_obsolete smr_mrule.mr_obsolete
299 #define smr_syntax_oid smr_mrule.mr_syntax_oid
301 typedef struct slap_attribute_type {
302 LDAP_ATTRIBUTE_TYPE sat_atype;
303 struct slap_attribute_type *sat_sup;
304 struct slap_attribute_type **sat_subtypes;
305 MatchingRule *sat_equality;
306 MatchingRule *sat_ordering;
307 MatchingRule *sat_substr;
309 /* The next one is created to help in the transition */
310 int sat_syntax_compat;
311 struct slap_attribute_type *sat_next;
313 #define sat_oid sat_atype.at_oid
314 #define sat_names sat_atype.at_names
315 #define sat_desc sat_atype.at_desc
316 #define sat_obsolete sat_atype.at_obsolete
317 #define sat_sup_oid sat_atype.at_sup_oid
318 #define sat_equality_oid sat_atype.at_equality_oid
319 #define sat_ordering_oid sat_atype.at_ordering_oid
320 #define sat_substr_oid sat_atype.at_substr_oid
321 #define sat_syntax_oid sat_atype.at_syntax_oid
322 #define sat_syntax_len sat_atype.at_syntax_len
323 #define sat_single_value sat_atype.at_single_value
324 #define sat_collective sat_atype.at_collective
325 #define sat_no_user_mods sat_atype.at_no_user_mods
326 #define sat_usage sat_atype.at_usage
328 typedef struct slap_object_class {
329 LDAP_OBJECT_CLASS soc_oclass;
330 struct slap_object_class **soc_sups;
331 AttributeType **soc_required;
332 AttributeType **soc_allowed;
333 struct slap_object_class *soc_next;
335 #define soc_oid soc_oclass.oc_oid
336 #define soc_names soc_oclass.oc_names
337 #define soc_desc soc_oclass.oc_desc
338 #define soc_obsolete soc_oclass.oc_obsolete
339 #define soc_sup_oids soc_oclass.oc_sup_oids
340 #define soc_kind soc_oclass.oc_kind
341 #define soc_at_oids_must soc_oclass.oc_at_oids_must
342 #define soc_at_oids_may soc_oclass.oc_at_oids_may
346 * represents a backend
349 typedef struct backend_info BackendInfo; /* per backend type */
350 typedef struct backend_db BackendDB; /* per backend database */
352 extern int nBackendInfo;
353 extern int nBackendDB;
354 extern BackendInfo *backendInfo;
355 extern BackendDB *backendDB;
358 #define SLAP_UNDEFINED_MODE 0
359 #define SLAP_SERVER_MODE 1
360 #define SLAP_TOOL_MODE 2
362 # define SLAP_TIMEDSERVER_MODE 3
363 # define SLAP_TOOLID_MODE 4
366 /* temporary aliases */
367 typedef BackendDB Backend;
368 #define nbackends nBackendDB
369 #define backends backendDB
372 BackendInfo *bd_info; /* pointer to shared backend info */
374 /* BackendInfo accessors */
375 #define be_config bd_info->bi_db_config
376 #define be_type bd_info->bi_type
378 #define be_bind bd_info->bi_op_bind
379 #define be_unbind bd_info->bi_op_unbind
380 #define be_add bd_info->bi_op_add
381 #define be_compare bd_info->bi_op_compare
382 #define be_delete bd_info->bi_op_delete
383 #define be_modify bd_info->bi_op_modify
384 #define be_modrdn bd_info->bi_op_modrdn
385 #define be_search bd_info->bi_op_search
387 #define be_release bd_info->bi_entry_release_rw
388 #define be_group bd_info->bi_acl_group
390 #define be_connection_init bd_info->bi_connection_init
391 #define be_connection_destroy bd_info->bi_connection_destroy
394 /* these should be renamed from be_ to bd_ */
395 char **be_suffix; /* the DN suffixes of data in this backend */
396 char **be_nsuffix; /* the normalized DN suffixes in this backend */
397 char *be_root_dn; /* the magic "root" dn for this db */
398 char *be_root_ndn; /* the magic "root" normalized dn for this db */
399 char *be_root_pw; /* the magic "root" password for this db */
400 int be_readonly; /* 1 => db is in "read only" mode */
401 unsigned int be_max_deref_depth; /* limit for depth of an alias deref */
402 int be_sizelimit; /* size limit for this backend */
403 int be_timelimit; /* time limit for this backend */
404 struct acl *be_acl; /* access control list for this backend */
405 int be_dfltaccess; /* access given if no acl matches */
406 char **be_replica; /* replicas of this backend (in master) */
407 char *be_replogfile; /* replication log file (in master) */
408 char *be_update_ndn; /* allowed to make changes (in replicas) */
409 struct berval **be_update_refs; /* where to refer modifying clients to */
410 int be_lastmod; /* keep track of lastmodified{by,time} */
414 void *be_private; /* anything the backend database needs */
417 struct backend_info {
418 char *bi_type; /* type of backend */
421 * per backend type routines:
422 * bi_init: called to allocate a backend_info structure,
423 * called once BEFORE configuration file is read.
424 * bi_init() initializes this structure hence is
425 * called directly from be_initialize()
426 * bi_config: called per 'backend' specific option
427 * all such options must before any 'database' options
428 * bi_config() is called only from read_config()
429 * bi_open: called to open each database, called
430 * once AFTER configuration file is read but
431 * BEFORE any bi_db_open() calls.
432 * bi_open() is called from backend_startup()
433 * bi_close: called to close each database, called
434 * once during shutdown after all bi_db_close calls.
435 * bi_close() is called from backend_shutdown()
436 * bi_destroy: called to destroy each database, called
437 * once during shutdown after all bi_db_destroy calls.
438 * bi_destory() is called from backend_destroy()
440 int (*bi_init) LDAP_P((BackendInfo *bi));
441 int (*bi_config) LDAP_P((BackendInfo *bi,
442 char *fname, int lineno, int argc, char **argv ));
443 int (*bi_open) LDAP_P((BackendInfo *bi));
444 int (*bi_close) LDAP_P((BackendInfo *bi));
445 int (*bi_destroy) LDAP_P((BackendInfo *bi));
448 * per database routines:
449 * bi_db_init: called to initialize each database,
450 * called upon reading 'database <type>'
451 * called only from backend_db_init()
452 * bi_db_config: called to configure each database,
453 * called per database to handle per database options
454 * called only from read_config()
455 * bi_db_open: called to open each database
456 * called once per database immediately AFTER bi_open()
457 * calls but before daemon startup.
458 * called only by backend_startup()
459 * bi_db_close: called to close each database
460 * called once per database during shutdown but BEFORE
462 * called only by backend_shutdown()
463 * bi_db_destroy: called to destroy each database
464 * called once per database during shutdown AFTER all
465 * bi_close calls but before bi_destory calls.
466 * called only by backend_destory()
468 int (*bi_db_init) LDAP_P((Backend *bd));
469 int (*bi_db_config) LDAP_P((Backend *bd,
470 char *fname, int lineno, int argc, char **argv ));
471 int (*bi_db_open) LDAP_P((Backend *bd));
472 int (*bi_db_close) LDAP_P((Backend *bd));
473 int (*bi_db_destroy) LDAP_P((Backend *db));
475 /* LDAP Operations Handling Routines */
476 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
477 struct slap_conn *c, struct slap_op *o,
478 char *dn, int method, char* mechanism,
479 struct berval *cred, char** edn ));
480 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
481 struct slap_conn *c, struct slap_op *o ));
482 int (*bi_op_search) LDAP_P((BackendDB *bd,
483 struct slap_conn *c, struct slap_op *o,
484 char *base, int scope, int deref,
485 int slimit, int tlimit,
486 Filter *f, char *filterstr, char **attrs,
488 int (*bi_op_compare)LDAP_P((BackendDB *bd,
489 struct slap_conn *c, struct slap_op *o,
490 char *dn, Ava *ava));
491 int (*bi_op_modify) LDAP_P((BackendDB *bd,
492 struct slap_conn *c, struct slap_op *o,
493 char *dn, LDAPModList *m));
494 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
495 struct slap_conn *c, struct slap_op *o,
496 char *dn, char *newrdn, int deleteoldrdn,
498 int (*bi_op_add) LDAP_P((BackendDB *bd,
499 struct slap_conn *c, struct slap_op *o,
501 int (*bi_op_delete) LDAP_P((BackendDB *bd,
502 struct slap_conn *c, struct slap_op *o,
504 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
505 struct slap_conn *c, struct slap_op *o,
508 /* Auxilary Functions */
509 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
511 int (*bi_acl_group) LDAP_P((Backend *bd,
512 Entry *e, char *bdn, char *edn,
513 char *objectclassValue, char *groupattrName ));
515 int (*bi_connection_init) LDAP_P((BackendDB *bd,
516 struct slap_conn *c));
517 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
518 struct slap_conn *c));
521 unsigned int bi_nDB; /* number of databases of this type */
522 void *bi_private; /* anything the backend type needs */
526 * represents an operation pending from an ldap client
529 typedef struct slap_op {
530 ber_int_t o_opid; /* id of this operation */
531 ber_int_t o_msgid; /* msgid of the request */
533 ldap_pvt_thread_t o_tid; /* thread handling this op */
535 BerElement *o_ber; /* ber of the request */
537 ber_tag_t o_tag; /* tag of the request */
538 time_t o_time; /* time op was initiated */
540 int o_bind_in_progress; /* multi-op bind in progress */
542 char *o_dn; /* dn bound when op was initiated */
543 char *o_ndn; /* normalized dn bound when op was initiated */
544 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
545 ber_tag_t o_authtype; /* auth method used to bind dn */
546 /* values taken from ldap.h */
548 char *o_authmech; /* SASL mechanism used to bind dn */
550 LDAPControl **o_ctrls; /* controls */
552 /* long o_connid; *//* id of conn initiating this op */
554 #ifdef LDAP_CONNECTIONLESS
555 int o_cldap; /* != 0 if this came in via CLDAP */
556 struct sockaddr o_clientaddr; /* client address if via CLDAP */
557 char o_searchbase; /* search base if via CLDAP */
560 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
561 int o_abandon; /* abandon flag */
563 struct slap_op *o_next; /* next operation in list */
564 void *o_private; /* anything the backend needs */
568 * represents a connection from an ldap client
571 typedef struct slap_conn {
572 int c_struct_state; /* structure management state */
573 int c_conn_state; /* connection state */
575 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
576 Sockbuf *c_sb; /* ber connection stuff */
578 /* only can be changed by connect_init */
579 time_t c_starttime; /* when the connection was opened */
580 time_t c_activitytime; /* when the connection was last used */
581 unsigned long c_connid; /* id of this connection for stats*/
582 char *c_client_addr; /* address of client */
583 char *c_client_name; /* name of client */
585 /* only can be changed by binding thread */
586 int c_bind_in_progress; /* multi-op bind in progress */
588 char *c_cdn; /* DN provided by the client */
589 char *c_dn; /* DN bound to this conn */
590 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
591 ber_tag_t c_authtype;/* auth method used to bind c_dn */
592 char *c_authmech; /* SASL mechanism used to bind c_dn */
593 void *c_authstate; /* SASL state data */
595 Operation *c_ops; /* list of operations being processed */
596 Operation *c_pending_ops; /* list of pending operations */
598 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
599 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
601 BerElement *c_currentber; /* ber we're attempting to read */
602 int c_writewaiter; /* true if writer is waiting */
604 long c_n_ops_received; /* num of ops received (next op_id) */
605 long c_n_ops_executing; /* num of ops currently executing */
606 long c_n_ops_pending; /* num of ops pending execution */
607 long c_n_ops_completed; /* num of ops completed */
609 long c_n_get; /* num of get calls */
610 long c_n_read; /* num of read calls */
611 long c_n_write; /* num of write calls */
614 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
615 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
617 if ( ldap_debug & (level) ) \
618 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
619 if ( ldap_syslog & (level) ) \
620 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
624 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
629 #include "proto-slap.h"
631 #endif /* _slap_h_ */