1 /* slap.h - stand alone ldap server include file */
11 #include <ac/socket.h>
12 #include <ldap_schema.h>
17 #define ldap_debug slap_debug
26 #include "ldap_pvt_thread.h"
29 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
32 #define SERVICE_NAME OPENLDAP_PACKAGE "-slapd"
34 /* LDAPMod.mod_op value ===> Must be kept in sync with ldap.h!
36 * This is a value used internally by the backends. It is needed to allow
37 * adding values that already exist without getting an error as required by
38 * modrdn when the new rdn was already an attribute value itself.
39 * JCG 05/1999 (gomez@engr.sgi.com)
41 #define LDAP_MOD_SOFTADD 0x1000
50 #define MAXREMATCHES 10
52 #define DNSEPARATOR(c) ((c) == ',' || (c) == ';')
53 #define SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
54 #define SPACE(c) ((c) == ' ' || (c) == '\n')
55 #define NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
57 #define SLAP_SCHERR_OUTOFMEM 1
58 #define SLAP_SCHERR_CLASS_NOT_FOUND 2
59 #define SLAP_SCHERR_ATTR_NOT_FOUND 3
60 #define SLAP_SCHERR_DUP_CLASS 4
61 #define SLAP_SCHERR_DUP_ATTR 5
62 #define SLAP_SCHERR_DUP_SYNTAX 6
63 #define SLAP_SCHERR_DUP_RULE 7
64 #define SLAP_SCHERR_NO_NAME 8
65 #define SLAP_SCHERR_ATTR_INCOMPLETE 9
66 #define SLAP_SCHERR_MR_NOT_FOUND 10
67 #define SLAP_SCHERR_SYN_NOT_FOUND 11
68 #define SLAP_SCHERR_MR_INCOMPLETE 12
72 extern int slap_debug;
78 * represents an attribute value assertion (i.e., attr=value)
82 struct berval ava_value;
86 * represents a search filter
88 typedef struct filter {
89 unsigned long f_choice; /* values taken from ldap.h */
95 /* equality, lessorequal, greaterorequal, approx */
99 struct filter *f_un_complex;
104 char *f_un_sub_initial;
106 char *f_un_sub_final;
109 #define f_type f_un.f_un_type
110 #define f_ava f_un.f_un_ava
111 #define f_avtype f_un.f_un_ava.ava_type
112 #define f_avvalue f_un.f_un_ava.ava_value
113 #define f_and f_un.f_un_complex
114 #define f_or f_un.f_un_complex
115 #define f_not f_un.f_un_complex
116 #define f_list f_un.f_un_complex
117 #define f_sub f_un.f_un_sub
118 #define f_sub_type f_un.f_un_sub.f_un_sub_type
119 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
120 #define f_sub_any f_un.f_un_sub.f_un_sub_any
121 #define f_sub_final f_un.f_un_sub.f_un_sub_final
123 struct filter *f_next;
127 * represents an attribute (type + values + syntax)
129 typedef struct attr {
131 struct berval **a_vals;
137 * the attr_syntax() routine returns one of these values
138 * telling what kind of syntax an attribute supports.
140 #define SYNTAX_CIS 0x01 /* case insensitive string */
141 #define SYNTAX_CES 0x02 /* case sensitive string */
142 #define SYNTAX_BIN 0x04 /* binary data */
143 #define SYNTAX_TEL 0x08 /* telephone number string */
144 #define SYNTAX_DN 0x10 /* dn string */
147 * the id used in the indexes to refer to an entry
149 typedef unsigned long ID;
150 #define NOID ((unsigned long)-1)
153 * represents an entry in core
155 typedef struct entry {
157 * The ID field should only be changed before entry is
158 * inserted into a cache. The ID value is backend
163 char *e_dn; /* DN of this entry */
164 char *e_ndn; /* normalized DN of this entry */
165 Attribute *e_attrs; /* list of attributes + values */
167 /* for use by the backend for any purpose */
172 * represents an access control list
177 #define ACL_NONE 0x01
178 #define ACL_COMPARE 0x02
179 #define ACL_SEARCH 0x04
180 #define ACL_READ 0x08
181 #define ACL_WRITE 0x10
182 #define ACL_SELF 0x40
190 #ifdef SLAPD_ACLGROUPS
192 char *a_objectclassvalue;
193 char *a_groupattrname;
195 struct access *a_next;
200 /* "to" part: the entries this acl applies to */
206 /* "by" part: list of who has what access to the entries */
207 struct access *acl_access;
209 struct acl *acl_next;
215 typedef struct ldapmodlist {
216 struct ldapmod ml_mod;
217 struct ldapmodlist *ml_next;
218 #define ml_op ml_mod.mod_op
219 #define ml_type ml_mod.mod_type
220 #define ml_values ml_mod.mod_values
221 #define ml_bvalues ml_mod.mod_bvalues
225 * represents schema information for a database
227 typedef int slap_syntax_check_func LDAP_P((struct berval * val));
229 typedef struct slap_syntax {
230 LDAP_SYNTAX ssyn_syn;
231 slap_syntax_check_func *ssyn_check;
232 struct slap_syntax *ssyn_next;
234 #define ssyn_oid ssyn_syn.syn_oid
235 #define ssyn_desc ssyn_syn.syn_desc
237 typedef int slap_mr_normalize_func LDAP_P((struct berval * val, struct berval **normalized));
238 typedef int slap_mr_compare_func LDAP_P((struct berval * val1, struct berval * val2));
240 typedef struct slap_matching_rule {
241 LDAP_MATCHING_RULE smr_mrule;
242 slap_mr_normalize_func *smr_normalize;
243 slap_mr_compare_func *smr_compare;
245 struct slap_matching_rule *smr_next;
247 #define smr_oid smr_mrule.mr_oid
248 #define smr_names smr_mrule.mr_names
249 #define smr_desc smr_mrule.mr_desc
250 #define smr_obsolete smr_mrule.mr_obsolete
251 #define smr_syntax_oid smr_mrule.mr_syntax_oid
253 typedef struct slap_attribute_type {
254 LDAP_ATTRIBUTE_TYPE sat_atype;
255 struct slap_attribute_type *sat_sup;
256 struct slap_attribute_type **sat_subtypes;
257 MatchingRule *sat_equality;
258 MatchingRule *sat_ordering;
259 MatchingRule *sat_substr;
261 /* The next one is created to help in the transition */
262 int sat_syntax_compat;
263 struct slap_attribute_type *sat_next;
265 #define sat_oid sat_atype.at_oid
266 #define sat_names sat_atype.at_names
267 #define sat_desc sat_atype.at_desc
268 #define sat_obsolete sat_atype.at_obsolete
269 #define sat_sup_oid sat_atype.at_sup_oid
270 #define sat_equality_oid sat_atype.at_equality_oid
271 #define sat_ordering_oid sat_atype.at_ordering_oid
272 #define sat_substr_oid sat_atype.at_substr_oid
273 #define sat_syntax_oid sat_atype.at_syntax_oid
274 #define sat_syntax_len sat_atype.at_syntax_len
275 #define sat_single_value sat_atype.at_single_value
276 #define sat_collective sat_atype.at_collective
277 #define sat_no_user_mods sat_atype.at_no_user_mods
278 #define sat_usage sat_atype.at_usage
280 typedef struct slap_object_class {
281 LDAP_OBJECT_CLASS soc_oclass;
282 struct slap_object_class **soc_sups;
283 AttributeType **soc_required;
284 AttributeType **soc_allowed;
285 struct slap_object_class *soc_next;
287 #define soc_oid soc_oclass.oc_oid
288 #define soc_names soc_oclass.oc_names
289 #define soc_desc soc_oclass.oc_desc
290 #define soc_obsolete soc_oclass.oc_obsolete
291 #define soc_sup_oids soc_oclass.oc_sup_oids
292 #define soc_kind soc_oclass.oc_kind
293 #define soc_at_oids_must soc_oclass.oc_at_oids_must
294 #define soc_at_oids_may soc_oclass.oc_at_oids_may
298 * represents a backend
301 typedef struct backend_info BackendInfo; /* per backend type */
302 typedef struct backend_db BackendDB; /* per backend database */
304 extern int nBackendInfo;
305 extern int nBackendDB;
306 extern BackendInfo *backendInfo;
307 extern BackendDB *backendDB;
310 #define SLAP_UNDEFINED_MODE 0
311 #define SLAP_SERVER_MODE 1
312 #define SLAP_TOOL_MODE 2
314 # define SLAP_TIMEDSERVER_MODE 3
315 # define SLAP_TOOLID_MODE 4
318 /* temporary aliases */
319 typedef BackendDB Backend;
320 #define nbackends nBackendDB
321 #define backends backendDB
324 BackendInfo *bd_info; /* pointer to shared backend info */
326 /* BackendInfo accessors */
327 #define be_config bd_info->bi_db_config
328 #define be_type bd_info->bi_type
330 #define be_bind bd_info->bi_op_bind
331 #define be_unbind bd_info->bi_op_unbind
332 #define be_add bd_info->bi_op_add
333 #define be_compare bd_info->bi_op_compare
334 #define be_delete bd_info->bi_op_delete
335 #define be_modify bd_info->bi_op_modify
336 #define be_modrdn bd_info->bi_op_modrdn
337 #define be_search bd_info->bi_op_search
339 #define be_release bd_info->bi_entry_release_rw
340 #define be_group bd_info->bi_acl_group
342 /* these should be renamed from be_ to bd_ */
343 char **be_suffix; /* the DN suffixes of data in this backend */
344 char **be_nsuffix; /* the normalized DN suffixes in this backend */
345 char **be_suffixAlias; /* the DN suffix aliases of data in this backend */
346 char *be_root_dn; /* the magic "root" dn for this db */
347 char *be_root_ndn; /* the magic "root" normalized dn for this db */
348 char *be_root_pw; /* the magic "root" password for this db */
349 int be_readonly; /* 1 => db is in "read only" mode */
350 int be_maxDerefDepth; /* limit for depth of an alias deref */
351 int be_sizelimit; /* size limit for this backend */
352 int be_timelimit; /* time limit for this backend */
353 struct acl *be_acl; /* access control list for this backend */
354 int be_dfltaccess; /* access given if no acl matches */
355 char **be_replica; /* replicas of this backend (in master) */
356 char *be_replogfile; /* replication log file (in master) */
357 char *be_update_ndn; /* allowed to make changes (in replicas) */
358 int be_lastmod; /* keep track of lastmodified{by,time} */
360 void *be_private; /* anything the backend database needs */
363 struct backend_info {
364 char *bi_type; /* type of backend */
367 * per backend type routines:
368 * bi_init: called to allocate a backend_info structure,
369 * called once BEFORE configuration file is read.
370 * bi_init() initializes this structure hence is
371 * called directly from be_initialize()
372 * bi_config: called per 'backend' specific option
373 * all such options must before any 'database' options
374 * bi_config() is called only from read_config()
375 * bi_open: called to open each database, called
376 * once AFTER configuration file is read but
377 * BEFORE any bi_db_open() calls.
378 * bi_open() is called from backend_startup()
379 * bi_close: called to close each database, called
380 * once during shutdown after all bi_db_close calls.
381 * bi_close() is called from backend_shutdown()
382 * bi_destroy: called to destroy each database, called
383 * once during shutdown after all bi_db_destroy calls.
384 * bi_destory() is called from backend_destroy()
386 int (*bi_init) LDAP_P((BackendInfo *bi));
387 int (*bi_config) LDAP_P((BackendInfo *bi,
388 char *fname, int lineno, int argc, char **argv ));
389 int (*bi_open) LDAP_P((BackendInfo *bi));
390 int (*bi_close) LDAP_P((BackendInfo *bi));
391 int (*bi_destroy) LDAP_P((BackendInfo *bi));
394 * per database routines:
395 * bi_db_init: called to initialize each database,
396 * called upon reading 'database <type>'
397 * called only from backend_db_init()
398 * bi_db_config: called to configure each database,
399 * called per database to handle per database options
400 * called only from read_config()
401 * bi_db_open: called to open each database
402 * called once per database immediately AFTER bi_open()
403 * calls but before daemon startup.
404 * called only by backend_startup()
405 * bi_db_close: called to close each database
406 * called once per database during shutdown but BEFORE
408 * called only by backend_shutdown()
409 * bi_db_destroy: called to destroy each database
410 * called once per database during shutdown AFTER all
411 * bi_close calls but before bi_destory calls.
412 * called only by backend_destory()
414 int (*bi_db_init) LDAP_P((Backend *bd));
415 int (*bi_db_config) LDAP_P((Backend *bd,
416 char *fname, int lineno, int argc, char **argv ));
417 int (*bi_db_open) LDAP_P((Backend *bd));
418 int (*bi_db_close) LDAP_P((Backend *bd));
419 int (*bi_db_destroy) LDAP_P((Backend *db));
421 /* LDAP Operations Handling Routines */
422 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
423 struct slap_conn *c, struct slap_op *o,
424 char *dn, int method, struct berval *cred, char** edn ));
425 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
426 struct slap_conn *c, struct slap_op *o ));
427 int (*bi_op_search) LDAP_P((BackendDB *bd,
428 struct slap_conn *c, struct slap_op *o,
429 char *base, int scope, int deref, int slimit, int tlimit,
430 Filter *f, char *filterstr, char **attrs, int attrsonly));
431 int (*bi_op_compare)LDAP_P((BackendDB *bd,
432 struct slap_conn *c, struct slap_op *o,
433 char *dn, Ava *ava));
434 int (*bi_op_modify) LDAP_P((BackendDB *bd,
435 struct slap_conn *c, struct slap_op *o,
436 char *dn, LDAPModList *m));
437 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
438 struct slap_conn *c, struct slap_op *o,
439 char *dn, char *newrdn, int deleteoldrdn,
441 int (*bi_op_add) LDAP_P((BackendDB *bd,
442 struct slap_conn *c, struct slap_op *o,
444 int (*bi_op_delete) LDAP_P((BackendDB *bd,
445 struct slap_conn *c, struct slap_op *o,
447 /* Bug: be_op_abandon in unused! */
448 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
449 struct slap_conn *c, struct slap_op *o,
452 /* Auxilary Functions */
453 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
454 #ifdef SLAPD_ACLGROUPS
455 int (*bi_acl_group) LDAP_P((Backend *bd,
456 Entry *e, char *bdn, char *edn,
457 char *objectclassValue, char *groupattrName ));
460 unsigned int bi_nDB; /* number of databases of this type */
461 void *bi_private; /* anything the backend type needs */
465 * represents an operation pending from an ldap client
468 typedef struct slap_op {
469 long o_opid; /* id of this operation */
470 long o_msgid; /* msgid of the request */
472 ldap_pvt_thread_t o_tid; /* thread handling this op */
474 BerElement *o_ber; /* ber of the request */
476 unsigned long o_tag; /* tag of the request */
477 time_t o_time; /* time op was initiated */
478 char *o_dn; /* dn bound when op was initiated */
479 char *o_ndn; /* normalized dn bound when op was initiated */
480 int o_authtype; /* auth method used to bind dn */
481 /* values taken from ldap.h */
484 /* long o_connid; *//* id of conn initiating this op */
486 #ifdef LDAP_CONNECTIONLESS
487 int o_cldap; /* != 0 if this came in via CLDAP */
488 struct sockaddr o_clientaddr; /* client address if via CLDAP */
489 char o_searchbase; /* search base if via CLDAP */
492 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
493 int o_abandon; /* abandon flag */
495 struct slap_op *o_next; /* next operation in list */
496 void *o_private; /* anything the backend needs */
500 * represents a connection from an ldap client
503 typedef struct slap_conn {
504 int c_struct_state; /* structure management state */
505 int c_conn_state; /* connection state */
507 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
508 Sockbuf *c_sb; /* ber connection stuff */
510 /* only can be changed by connect_init */
511 time_t c_starttime; /* when the connection was opened */
512 time_t c_activitytime; /* when the connection was last used */
513 long c_connid; /* id of this connection for stats*/
514 char *c_client_addr; /* address of client */
515 char *c_client_name; /* name of client */
517 /* only can be changed by binding thread */
518 char *c_cdn; /* DN provided by the client */
519 char *c_dn; /* DN bound to this conn */
520 int c_protocol; /* version of the LDAP protocol used by client */
521 int c_authtype; /* auth method used to bind c_dn */
523 int c_version; /* for compatibility w/ U-Mich 2.0 & 3.0 */
526 Operation *c_ops; /* list of operations being processed */
527 Operation *c_pending_ops; /* list of pending operations */
529 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
530 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
532 BerElement *c_currentber; /* ber we're attempting to read */
533 int c_writewaiter; /* true if writer is waiting */
535 long c_n_ops_received; /* num of ops received (next op_id) */
536 long c_n_ops_executing; /* num of ops currently executing */
537 long c_n_ops_pending; /* num of ops pending execution */
538 long c_n_ops_completed; /* num of ops completed */
541 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
542 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
544 if ( ldap_debug & (level) ) \
545 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
546 if ( ldap_syslog & (level) ) \
547 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
551 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
554 #include "proto-slap.h"
558 #endif /* _slap_h_ */