1 /* slap.h - stand alone ldap server include file */
11 #include <ac/socket.h> /* needed by LDAP_CONNECTIONLESS */
16 #define ldap_debug slap_debug
25 #include "ldap_pvt_thread.h"
28 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
38 #define MAXREMATCHES 10
40 #define DNSEPARATOR(c) ((c) == ',' || (c) == ';')
41 #define SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
42 #define SPACE(c) ((c) == ' ' || (c) == '\n')
43 #define NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
47 extern int slap_debug;
53 * represents an attribute value assertion (i.e., attr=value)
57 struct berval ava_value;
61 * represents a search filter
63 typedef struct filter {
64 unsigned long f_choice; /* values taken from ldap.h */
70 /* equality, lessorequal, greaterorequal, approx */
74 struct filter *f_un_complex;
79 char *f_un_sub_initial;
84 #define f_type f_un.f_un_type
85 #define f_ava f_un.f_un_ava
86 #define f_avtype f_un.f_un_ava.ava_type
87 #define f_avvalue f_un.f_un_ava.ava_value
88 #define f_and f_un.f_un_complex
89 #define f_or f_un.f_un_complex
90 #define f_not f_un.f_un_complex
91 #define f_list f_un.f_un_complex
92 #define f_sub f_un.f_un_sub
93 #define f_sub_type f_un.f_un_sub.f_un_sub_type
94 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
95 #define f_sub_any f_un.f_un_sub.f_un_sub_any
96 #define f_sub_final f_un.f_un_sub.f_un_sub_final
98 struct filter *f_next;
102 * represents an attribute (type + values + syntax)
104 typedef struct attr {
106 struct berval **a_vals;
112 * the attr_syntax() routine returns one of these values
113 * telling what kind of syntax an attribute supports.
115 #define SYNTAX_CIS 0x01 /* case insensitive string */
116 #define SYNTAX_CES 0x02 /* case sensitive string */
117 #define SYNTAX_BIN 0x04 /* binary data */
118 #define SYNTAX_TEL 0x08 /* telephone number string */
119 #define SYNTAX_DN 0x10 /* dn string */
122 * the id used in the indexes to refer to an entry
124 typedef unsigned long ID;
125 #define NOID ((unsigned long)-1)
128 * represents an entry in core
130 typedef struct entry {
132 * The ID field should only be changed before entry is
133 * inserted into a cache. The ID value is backend
138 char *e_dn; /* DN of this entry */
139 char *e_ndn; /* normalized DN of this entry */
140 Attribute *e_attrs; /* list of attributes + values */
142 /* for use by the backend for any purpose */
147 * represents an access control list
152 #define ACL_NONE 0x01
153 #define ACL_COMPARE 0x02
154 #define ACL_SEARCH 0x04
155 #define ACL_READ 0x08
156 #define ACL_WRITE 0x10
157 #define ACL_SELF 0x40
165 #ifdef SLAPD_ACLGROUPS
167 char *a_objectclassvalue;
168 char *a_groupattrname;
170 struct access *a_next;
175 /* "to" part: the entries this acl applies to */
181 /* "by" part: list of who has what access to the entries */
182 struct access *acl_access;
184 struct acl *acl_next;
190 typedef struct ldapmodlist {
191 struct ldapmod ml_mod;
192 struct ldapmodlist *ml_next;
193 #define ml_op ml_mod.mod_op
194 #define ml_type ml_mod.mod_type
195 #define ml_values ml_mod.mod_values
196 #define ml_bvalues ml_mod.mod_bvalues
200 * represents schema information for a database
207 struct objclass *oc_next;
212 * represents a backend
215 typedef struct backend_info BackendInfo; /* per backend type */
216 typedef struct backend_db BackendDB; /* per backend database */
218 extern int nBackendInfo;
219 extern int nBackendDB;
220 extern BackendInfo *backendInfo;
221 extern BackendDB *backendDB;
224 #define SLAP_UNDEFINED_MODE 0
225 #define SLAP_SERVER_MODE 1
226 #define SLAP_TOOL_MODE 2
228 # define SLAP_TIMEDSERVER_MODE 3
229 # define SLAP_TOOLID_MODE 4
232 /* temporary aliases */
233 typedef BackendDB Backend;
234 #define nbackends nBackendDB
235 #define backends backendDB
238 BackendInfo *bd_info; /* pointer to shared backend info */
240 /* BackendInfo accessors */
241 #define be_config bd_info->bi_db_config
242 #define be_type bd_info->bi_type
244 #define be_bind bd_info->bi_op_bind
245 #define be_unbind bd_info->bi_op_unbind
246 #define be_add bd_info->bi_op_add
247 #define be_compare bd_info->bi_op_compare
248 #define be_delete bd_info->bi_op_delete
249 #define be_modify bd_info->bi_op_modify
250 #define be_modrdn bd_info->bi_op_modrdn
251 #define be_search bd_info->bi_op_search
253 #define be_release bd_info->bi_entry_release_rw
254 #define be_group bd_info->bi_acl_group
256 /* these should be renamed from be_ to bd_ */
257 char **be_suffix; /* the DN suffixes of data in this backend */
258 char **be_nsuffix; /* the normalized DN suffixes in this backend */
259 char **be_suffixAlias; /* the DN suffix aliases of data in this backend */
260 char *be_root_dn; /* the magic "root" dn for this db */
261 char *be_root_ndn; /* the magic "root" normalized dn for this db */
262 char *be_root_pw; /* the magic "root" password for this db */
263 int be_readonly; /* 1 => db is in "read only" mode */
264 int be_maxDerefDepth; /* limit for depth of an alias deref */
265 int be_sizelimit; /* size limit for this backend */
266 int be_timelimit; /* time limit for this backend */
267 struct acl *be_acl; /* access control list for this backend */
268 int be_dfltaccess; /* access given if no acl matches */
269 char **be_replica; /* replicas of this backend (in master) */
270 char *be_replogfile; /* replication log file (in master) */
271 char *be_update_ndn; /* allowed to make changes (in replicas) */
272 int be_lastmod; /* keep track of lastmodified{by,time} */
274 void *be_private; /* anything the backend database needs */
277 struct backend_info {
278 char *bi_type; /* type of backend */
281 * per backend type routines:
282 * bi_init: called to allocate a backend_info structure,
283 * called once BEFORE configuration file is read.
284 * bi_init() initializes this structure hence is
285 * called directly from be_initialize()
286 * bi_config: called per 'backend' specific option
287 * all such options must before any 'database' options
288 * bi_config() is called only from read_config()
289 * bi_open: called to open each database, called
290 * once AFTER configuration file is read but
291 * BEFORE any bi_db_open() calls.
292 * bi_open() is called from backend_startup()
293 * bi_close: called to close each database, called
294 * once during shutdown after all bi_db_close calls.
295 * bi_close() is called from backend_shutdown()
296 * bi_destroy: called to destroy each database, called
297 * once during shutdown after all bi_db_destroy calls.
298 * bi_destory() is called from backend_destroy()
300 int (*bi_init) LDAP_P((BackendInfo *bi));
301 int (*bi_config) LDAP_P((BackendInfo *bi,
302 char *fname, int lineno, int argc, char **argv ));
303 int (*bi_open) LDAP_P((BackendInfo *bi));
304 int (*bi_close) LDAP_P((BackendInfo *bi));
305 int (*bi_destroy) LDAP_P((BackendInfo *bi));
308 * per database routines:
309 * bi_db_init: called to initialize each database,
310 * called upon reading 'database <type>'
311 * called only from backend_db_init()
312 * bi_db_config: called to configure each database,
313 * called per database to handle per database options
314 * called only from read_config()
315 * bi_db_open: called to open each database
316 * called once per database immediately AFTER bi_open()
317 * calls but before daemon startup.
318 * called only by backend_startup()
319 * bi_db_close: called to close each database
320 * called once per database during shutdown but BEFORE
322 * called only by backend_shutdown()
323 * bi_db_destroy: called to destroy each database
324 * called once per database during shutdown AFTER all
325 * bi_close calls but before bi_destory calls.
326 * called only by backend_destory()
328 int (*bi_db_init) LDAP_P((Backend *bd));
329 int (*bi_db_config) LDAP_P((Backend *bd,
330 char *fname, int lineno, int argc, char **argv ));
331 int (*bi_db_open) LDAP_P((Backend *bd));
332 int (*bi_db_close) LDAP_P((Backend *bd));
333 int (*bi_db_destroy) LDAP_P((Backend *db));
335 /* LDAP Operations Handling Routines */
336 int (*bi_op_bind) LDAP_P(( BackendDB *bd,
337 struct slap_conn *c, struct slap_op *o,
338 char *dn, int method, struct berval *cred, char** edn ));
339 int (*bi_op_unbind) LDAP_P((BackendDB *bd,
340 struct slap_conn *c, struct slap_op *o ));
341 int (*bi_op_search) LDAP_P((BackendDB *bd,
342 struct slap_conn *c, struct slap_op *o,
343 char *base, int scope, int deref, int slimit, int tlimit,
344 Filter *f, char *filterstr, char **attrs, int attrsonly));
345 int (*bi_op_compare)LDAP_P((BackendDB *bd,
346 struct slap_conn *c, struct slap_op *o,
347 char *dn, Ava *ava));
348 int (*bi_op_modify) LDAP_P((BackendDB *bd,
349 struct slap_conn *c, struct slap_op *o,
350 char *dn, LDAPModList *m));
351 int (*bi_op_modrdn) LDAP_P((BackendDB *bd,
352 struct slap_conn *c, struct slap_op *o,
353 char *dn, char *newrdn, int deleteoldrdn,
355 int (*bi_op_add) LDAP_P((BackendDB *bd,
356 struct slap_conn *c, struct slap_op *o,
358 int (*bi_op_delete) LDAP_P((BackendDB *bd,
359 struct slap_conn *c, struct slap_op *o,
361 /* Bug: be_op_abandon in unused! */
362 int (*bi_op_abandon) LDAP_P((BackendDB *bd,
363 struct slap_conn *c, struct slap_op *o,
366 /* Auxilary Functions */
367 int (*bi_entry_release_rw) LDAP_P((BackendDB *bd, Entry *e, int rw));
368 #ifdef SLAPD_ACLGROUPS
369 int (*bi_acl_group) LDAP_P((Backend *bd,
370 Entry *e, char *bdn, char *edn,
371 char *objectclassValue, char *groupattrName ));
374 unsigned int bi_nDB; /* number of databases of this type */
375 void *bi_private; /* anything the backend type needs */
379 * represents an operation pending from an ldap client
382 typedef struct slap_op {
383 long o_opid; /* id of this operation */
384 long o_msgid; /* msgid of the request */
386 ldap_pvt_thread_t o_tid; /* thread handling this op */
388 BerElement *o_ber; /* ber of the request */
390 unsigned long o_tag; /* tag of the request */
391 time_t o_time; /* time op was initiated */
392 char *o_dn; /* dn bound when op was initiated */
393 char *o_ndn; /* normalized dn bound when op was initiated */
394 int o_authtype; /* auth method used to bind dn */
395 /* values taken from ldap.h */
398 /* long o_connid; *//* id of conn initiating this op */
400 #ifdef LDAP_CONNECTIONLESS
401 int o_cldap; /* != 0 if this came in via CLDAP */
402 struct sockaddr o_clientaddr; /* client address if via CLDAP */
403 char o_searchbase; /* search base if via CLDAP */
406 ldap_pvt_thread_mutex_t o_abandonmutex; /* protects o_abandon */
407 int o_abandon; /* abandon flag */
409 struct slap_op *o_next; /* next operation in list */
410 void *o_private; /* anything the backend needs */
414 * represents a connection from an ldap client
417 typedef struct slap_conn {
418 int c_struct_state; /* structure management state */
419 int c_conn_state; /* connection state */
421 ldap_pvt_thread_mutex_t c_mutex; /* protect the connection */
422 Sockbuf *c_sb; /* ber connection stuff */
424 /* only can be changed by connect_init */
425 time_t c_starttime; /* when the connection was opened */
426 long c_connid; /* id of this connection for stats*/
427 char *c_client_addr; /* address of client */
428 char *c_client_name; /* name of client */
430 /* only can be changed by binding thread */
431 char *c_cdn; /* DN provided by the client */
432 char *c_dn; /* DN bound to this conn */
433 int c_protocol; /* version of the LDAP protocol used by client */
434 int c_authtype; /* auth method used to bind c_dn */
436 int c_version; /* for compatibility w/ U-Mich 2.0 & 3.0 */
439 Operation *c_ops; /* list of operations being processed */
440 Operation *c_pending_ops; /* list of pending operations */
442 ldap_pvt_thread_mutex_t c_write_mutex; /* only one pdu written at a time */
443 ldap_pvt_thread_cond_t c_write_cv; /* used to wait for sd write-ready*/
445 BerElement *c_currentber; /* ber we're attempting to read */
446 int c_writewaiter; /* true if writer is waiting */
448 long c_n_ops_received; /* num of ops received (next op_id) */
449 long c_n_ops_executing; /* num of ops currently executing */
450 long c_n_ops_pending; /* num of ops pending execution */
451 long c_n_ops_completed; /* num of ops completed */
454 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
455 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
457 if ( ldap_debug & (level) ) \
458 fprintf( stderr, (fmt), (connid), (opid), (arg1), (arg2), (arg3) );\
459 if ( ldap_syslog & (level) ) \
460 syslog( ldap_syslog_level, (fmt), (connid), (opid), (arg1), \
464 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
467 #include "proto-slap.h"
471 #endif /* _slap_h_ */