1 /* slap.h - stand alone ldap server include file */
11 #include <ac/socket.h>
16 #define ldap_debug slap_debug
25 #include "ldap_schema.h"
27 #include "ldap_pvt_thread.h"
33 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
36 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
38 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
40 * This is a value used internally by the backends. It is needed to allow
41 * adding values that already exist without getting an error as required by
42 * modrdn when the new rdn was already an attribute value itself.
43 * JCG 05/1999 (gomez@engr.sgi.com)
45 #define LDAP_MOD_SOFTADD 0x1000
54 #define MAXREMATCHES 10
56 #define DNSEPARATOR(c) ((c) == ',' || (c) == ';')
57 #define SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
58 #define SPACE(c) ((c) == ' ' || (c) == '\n')
59 #define NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
61 #define SLAP_SCHERR_OUTOFMEM 1
62 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
63 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
64 #define SLAP_SCHERR_DUP_CLASS 4
65 #define SLAP_SCHERR_DUP_ATTR 5
66 #define SLAP_SCHERR_DUP_SYNTAX 6
67 #define SLAP_SCHERR_DUP_RULE 7
68 #define SLAP_SCHERR_NO_NAME 8
69 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
70 #define SLAP_SCHERR_MR_NOT_FOUND 10
71 #define SLAP_SCHERR_SYN_NOT_FOUND 11
72 #define SLAP_SCHERR_MR_INCOMPLETE 12
74 extern int slap_debug;
80 * represents an attribute value assertion (i.e., attr=value)
84 struct berval ava_value;
88 * represents a search filter
90 typedef struct filter {
91 ber_tag_t f_choice; /* values taken from ldap.h */
97 /* equality, lessorequal, greaterorequal, approx */
101 struct filter *f_un_complex;
106 char *f_un_sub_initial;
108 char *f_un_sub_final;
111 #define f_type f_un.f_un_type
112 #define f_ava f_un.f_un_ava
113 #define f_avtype f_un.f_un_ava.ava_type
114 #define f_avvalue f_un.f_un_ava.ava_value
115 #define f_and f_un.f_un_complex
116 #define f_or f_un.f_un_complex
117 #define f_not f_un.f_un_complex
118 #define f_list f_un.f_un_complex
119 #define f_sub f_un.f_un_sub
120 #define f_sub_type f_un.f_un_sub.f_un_sub_type
121 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
122 #define f_sub_any f_un.f_un_sub.f_un_sub_any
123 #define f_sub_final f_un.f_un_sub.f_un_sub_final
125 struct filter *f_next;
129 * represents an attribute (type + values + syntax)
131 typedef struct attr {
133 struct berval **a_vals;
139 * the attr_syntax() routine returns one of these values
140 * telling what kind of syntax an attribute supports.
142 #define SYNTAX_CIS 0x01 /* case insensitive string */
143 #define SYNTAX_CES 0x02 /* case sensitive string */
144 #define SYNTAX_BIN 0x04 /* binary data */
145 #define SYNTAX_TEL 0x08 /* telephone number string */
146 #define SYNTAX_DN 0x10 /* dn string */
149 * the id used in the indexes to refer to an entry
151 typedef unsigned long ID;
152 #define NOID ((unsigned long)~0)
155 * represents an entry in core
157 typedef struct entry {
159 * The ID field should only be changed before entry is
160 * inserted into a cache. The ID value is backend
165 char *e_dn; /* DN of this entry */
166 char *e_ndn; /* normalized DN of this entry */
167 Attribute *e_attrs; /* list of attributes + values */
169 /* for use by the backend for any purpose */
174 * represents an access control list
179 #define ACL_NONE 0x01
180 #define ACL_COMPARE 0x02
181 #define ACL_SEARCH 0x04
182 #define ACL_READ 0x08
183 #define ACL_WRITE 0x10
184 #define ACL_SELF 0x40
192 #ifdef SLAPD_ACLGROUPS
194 char *a_objectclassvalue;
195 char *a_groupattrname;
197 struct access *a_next;
202 /* "to" part: the entries this acl applies to */
208 /* "by" part: list of who has what access to the entries */
209 struct access *acl_access;
211 struct acl *acl_next;
217 typedef struct ldapmodlist {
218 struct ldapmod ml_mod;
219 struct ldapmodlist *ml_next;
220 #define ml_op ml_mod.mod_op
221 #define ml_type ml_mod.mod_type
222 #define ml_values ml_mod.mod_values
223 #define ml_bvalues ml_mod.mod_bvalues
227 * represents schema information for a database
229 typedef int slap_syntax_check_func LDAP_P((struct berval * val));
231 typedef struct slap_syntax {
232 LDAP_SYNTAX ssyn_syn;
233 slap_syntax_check_func *ssyn_check;
234 struct slap_syntax *ssyn_next;
236 #define ssyn_oid ssyn_syn.syn_oid
237 #define ssyn_desc ssyn_syn.syn_desc
239 typedef int slap_mr_normalize_func LDAP_P((struct berval * val, struct berval **normalized));
240 typedef int slap_mr_compare_func LDAP_P((struct berval * val1, struct berval * val2));
242 typedef struct slap_matching_rule {
243 LDAP_MATCHING_RULE smr_mrule;
244 slap_mr_normalize_func *smr_normalize;
245 slap_mr_compare_func *smr_compare;
247 struct slap_matching_rule *smr_next;
249 #define smr_oid smr_mrule.mr_oid
250 #define smr_names smr_mrule.mr_names
251 #define smr_desc smr_mrule.mr_desc
252 #define smr_obsolete smr_mrule.mr_obsolete
253 #define smr_syntax_oid smr_mrule.mr_syntax_oid
255 typedef struct slap_attribute_type {
256 LDAP_ATTRIBUTE_TYPE sat_atype;
257 struct slap_attribute_type *sat_sup;
258 struct slap_attribute_type **sat_subtypes;
259 MatchingRule *sat_equality;
260 MatchingRule *sat_ordering;
261 MatchingRule *sat_substr;
263 /* The next one is created to help in the transition */
264 int sat_syntax_compat;
265 struct slap_attribute_type *sat_next;
267 #define sat_oid sat_atype.at_oid
268 #define sat_names sat_atype.at_names
269 #define sat_desc sat_atype.at_desc
270 #define sat_obsolete sat_atype.at_obsolete
271 #define sat_sup_oid sat_atype.at_sup_oid
272 #define sat_equality_oid sat_atype.at_equality_oid
273 #define sat_ordering_oid sat_atype.at_ordering_oid
274 #define sat_substr_oid sat_atype.at_substr_oid
275 #define sat_syntax_oid sat_atype.at_syntax_oid
276 #define sat_syntax_len sat_atype.at_syntax_len
277 #define sat_single_value sat_atype.at_single_value
278 #define sat_collective sat_atype.at_collective
279 #define sat_no_user_mods sat_atype.at_no_user_mods
280 #define sat_usage sat_atype.at_usage
282 typedef struct slap_object_class {
283 LDAP_OBJECT_CLASS soc_oclass;
284 struct slap_object_class **soc_sups;
285 AttributeType **soc_required;
286 AttributeType **soc_allowed;
287 struct slap_object_class *soc_next;
289 #define soc_oid soc_oclass.oc_oid
290 #define soc_names soc_oclass.oc_names
291 #define soc_desc soc_oclass.oc_desc
292 #define soc_obsolete soc_oclass.oc_obsolete
293 #define soc_sup_oids soc_oclass.oc_sup_oids
294 #define soc_kind soc_oclass.oc_kind
295 #define soc_at_oids_must soc_oclass.oc_at_oids_must
296 #define soc_at_oids_may soc_oclass.oc_at_oids_may
300 * represents a backend
303 typedef struct backend_info BackendInfo; /* per backend type */
304 typedef struct backend_db BackendDB; /* per backend database */
306 extern int nBackendInfo;
307 extern int nBackendDB;
308 extern BackendInfo *backendInfo;
309 extern BackendDB *backendDB;
312 #define SLAP_UNDEFINED_MODE 0
313 #define SLAP_SERVER_MODE 1
314 #define SLAP_TOOL_MODE 2
316 # define SLAP_TIMEDSERVER_MODE 3
317 # define SLAP_TOOLID_MODE 4
320 /* temporary aliases */
321 typedef BackendDB Backend;
322 #define nbackends nBackendDB
323 #define backends backendDB
326 BackendInfo *bd_info; /* pointer to shared backend info */
328 /* BackendInfo accessors */
329 #define be_config bd_info->bi_db_config
330 #define be_type bd_info->bi_type
332 #define be_bind bd_info->bi_op_bind
333 #define be_unbind bd_info->bi_op_unbind
334 #define be_add bd_info->bi_op_add
335 #define be_compare bd_info->bi_op_compare
336 #define be_delete bd_info->bi_op_delete
337 #define be_modify bd_info->bi_op_modify
338 #define be_modrdn bd_info->bi_op_modrdn
339 #define be_search bd_info->bi_op_search
341 #define be_release bd_info->bi_entry_release_rw
342 #define be_group bd_info->bi_acl_group
344 #define be_connection_init bd_info->bi_connection_init
345 #define be_connection_destroy bd_info->bi_connection_destroy
348 /* these should be renamed from be_ to bd_ */
349 char **be_suffix; /* the DN suffixes of data in this backend */
350 char **be_nsuffix; /* the normalized DN suffixes in this backend */
351 char **be_suffixAlias; /* the DN suffix aliases of data in this backend */
352 char *be_root_dn; /* the magic "root" dn for this db */
353 char *be_root_ndn; /* the magic "root" normalized dn for this db */
354 char *be_root_pw; /* the magic "root" password for this db */
355 int be_readonly; /* 1 => db is in "read only" mode */
356 int be_maxDerefDepth; /* limit for depth of an alias deref */
357 int be_sizelimit; /* size limit for this backend */
358 int be_timelimit; /* time limit for this backend */
359 struct acl *be_acl; /* access control list for this backend */
360 int be_dfltaccess; /* access given if no acl matches */
361 char **be_replica; /* replicas of this backend (in master) */
362 char *be_replogfile; /* replication log file (in master) */
363 char *be_update_ndn; /* allowed to make changes (in replicas) */
364 int be_lastmod; /* keep track of lastmodified{by,time} */
366 void *be_private; /* anything the backend database needs */
369 struct backend_info {
370 char *bi_type; /* type of backend */
373 * per backend type routines:
374 * bi_init: called to allocate a backend_info structure,
375 * called once BEFORE configuration file is read.
376 * bi_init() initializes this structure hence is
377 * called directly from be_initialize()
378 * bi_config: called per 'backend' specific option
379 * all such options must before any 'database' options
380 * bi_config() is called only from read_config()
381 * bi_open: called to open each database, called
382 * once AFTER configuration file is read but
383 * BEFORE any bi_db_open() calls.
384 * bi_open() is called from backend_startup()
385 * bi_close: called to close each database, called
386 * once during shutdown after all bi_db_close calls.
387 * bi_close() is called from backend_shutdown()
388 * bi_destroy: called to destroy each database, called
389 * once during shutdown after all bi_db_destroy calls.
390 * bi_destory() is called from backend_destroy()
392 int (*bi_init) LDAP_P((BackendInfo *bi));
393 int (*bi_config) LDAP_P((BackendInfo *bi,
394 char *fname, int lineno, int argc, char **argv ));
395 int (*bi_open) LDAP_P((BackendInfo *bi));
396 int (*bi_close) LDAP_P((BackendInfo *bi));
397 int (*bi_destroy) LDAP_P((BackendInfo *bi));
400 * per database routines:
401 * bi_db_init: called to initialize each database,
402 * called upon reading 'database <type>'
403 * called only from backend_db_init()
404 * bi_db_config: called to configure each database,
405 * called per database to handle per database options
406 * called only from read_config()
407 * bi_db_open: called to open each database
408 * called once per database immediately AFTER bi_open()
409 * calls but before daemon startup.
410 * called only by backend_startup()
411 * bi_db_close: called to close each database
412 * called once per database during shutdown but BEFORE
414 * called only by backend_shutdown()
415 * bi_db_destroy: called to destroy each database
416 * called once per database during shutdown AFTER all
417 * bi_close calls but before bi_destory calls.
418 * called only by backend_destory()
420 int (*bi_db_init) LDAP_P((Backend *bd));
421 int (*bi_db_config) LDAP_P((Backend *bd,
422 char *fname, int lineno, int argc, char **argv ));
423 int (*bi_db_open) LDAP_P((Backend *bd));
424 int (*bi_db_close) LDAP_P((Backend *bd));
425 int (*bi_db_destroy) LDAP_P((Backend *db));
427 /* LDAP Operations Handling Routines */
428 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
429 struct slap_conn *c, struct slap_op *o,
430 char *dn, int method, char* mechanism,
431 struct berval *cred, char** edn ));
432 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
433 struct slap_conn *c, struct slap_op *o ));
434 int (*bi_op_search) LDAP_P((BackendDB *bd,
435 struct slap_conn *c, struct slap_op *o,
436 char *base, int scope, int deref,
437 int slimit, int tlimit,
438 Filter *f, char *filterstr, char **attrs,
440 int (*bi_op_compare)LDAP_P((BackendDB *bd,
441 struct slap_conn *c, struct slap_op *o,
442 char *dn, Ava *ava));
443 int (*bi_op_modify) LDAP_P((BackendDB *bd,
444 struct slap_conn *c, struct slap_op *o,
445 char *dn, LDAPModList *m));
446 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
447 struct slap_conn *c, struct slap_op *o,
448 char *dn, char *newrdn, int deleteoldrdn,
450 int (*bi_op_add) LDAP_P((BackendDB *bd,
451 struct slap_conn *c, struct slap_op *o,
453 int (*bi_op_delete) LDAP_P((BackendDB *bd,
454 struct slap_conn *c, struct slap_op *o,
456 /* Bug: be_op_abandon in unused! */
457 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
458 struct slap_conn *c, struct slap_op *o,
461 /* Auxilary Functions */
462 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
463 #ifdef SLAPD_ACLGROUPS
464 int (*bi_acl_group) LDAP_P((Backend *bd,
465 Entry *e, char *bdn, char *edn,
466 char *objectclassValue, char *groupattrName ));
469 int (*bi_connection_init) LDAP_P((BackendDB *bd,
470 struct slap_conn *c));
471 int (*bi_connection_destroy) LDAP_P((BackendDB *bd,
472 struct slap_conn *c));
475 unsigned int bi_nDB; /* number of databases of this type */
476 void *bi_private; /* anything the backend type needs */
480 * represents an operation pending from an ldap client
483 typedef struct slap_op {
484 ber_int_t o_opid; /* id of this operation */
485 ber_int_t o_msgid; /* msgid of the request */
487 ldap_pvt_thread_t o_tid; /* thread handling this op */
489 BerElement *o_ber; /* ber of the request */
491 ber_tag_t o_tag; /* tag of the request */
492 time_t o_time; /* time op was initiated */
494 int o_bind_in_progress; /* multi-op bind in progress */
496 char *o_dn; /* dn bound when op was initiated */
497 char *o_ndn; /* normalized dn bound when op was initiated */
498 ber_int_t o_protocol; /* version of the LDAP protocol used by client */
499 ber_tag_t o_authtype; /* auth method used to bind dn */
500 /* values taken from ldap.h */
502 char *o_authmech; /* SASL mechanism used to bind dn */
504 LDAPControl **o_ctrls; /* controls */
506 /* long o_connid; *//* id of conn initiating this op */
508 #ifdef LDAP_CONNECTIONLESS
509 int o_cldap; /* != 0 if this came in via CLDAP */
510 struct sockaddr o_clientaddr; /* client address if via CLDAP */
511 char o_searchbase; /* search base if via CLDAP */
514 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
515 int o_abandon; /* abandon flag */
517 struct slap_op *o_next; /* next operation in list */
518 void *o_private; /* anything the backend needs */
522 * represents a connection from an ldap client
525 typedef struct slap_conn {
526 int c_struct_state; /* structure management state */
527 int c_conn_state; /* connection state */
529 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
530 Sockbuf *c_sb; /* ber connection stuff */
532 /* only can be changed by connect_init */
533 time_t c_starttime; /* when the connection was opened */
534 time_t c_activitytime; /* when the connection was last used */
535 unsigned long c_connid; /* id of this connection for stats*/
536 char *c_client_addr; /* address of client */
537 char *c_client_name; /* name of client */
539 /* only can be changed by binding thread */
540 int c_bind_in_progress; /* multi-op bind in progress */
542 char *c_cdn; /* DN provided by the client */
543 char *c_dn; /* DN bound to this conn */
544 ber_int_t c_protocol; /* version of the LDAP protocol used by client */
545 ber_tag_t c_authtype; /* auth method used to bind c_dn */
546 char *c_authmech; /* SASL mechanism used to bind c_dn */
548 Operation *c_ops; /* list of operations being processed */
549 Operation *c_pending_ops; /* list of pending operations */
551 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
552 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
554 BerElement *c_currentber; /* ber we're attempting to read */
555 int c_writewaiter; /* true if writer is waiting */
557 long c_n_ops_received; /* num of ops received (next op_id) */
558 long c_n_ops_executing; /* num of ops currently executing */
559 long c_n_ops_pending; /* num of ops pending execution */
560 long c_n_ops_completed; /* num of ops completed */
562 long c_n_get; /* num of get calls */
563 long c_n_read; /* num of read calls */
564 long c_n_write; /* num of write calls */
567 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
568 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
570 if ( ldap_debug & (level) ) \
571 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
572 if ( ldap_syslog & (level) ) \
573 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
577 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
582 #include "proto-slap.h"
584 #endif /* _slap_h_ */