1 /* slap.h - stand alone ldap server include file */
12 #include <sys/types.h>
13 #include <ac/syslog.h>
22 #define ldap_debug slap_debug
27 #include "../../libraries/liblber/lber-int.h"
30 #include "ldap_pvt_thread.h"
33 #undef f_next /* name conflict between sys/file.h on SCO and struct filter */
43 #define MAXREMATCHES 10
45 #define DNSEPARATOR(c) ((c) == ',' || (c) == ';')
46 #define SEPARATOR(c) ((c) == ',' || (c) == ';' || (c) == '+')
47 #define SPACE(c) ((c) == ' ' || (c) == '\n')
48 #define NEEDSESCAPE(c) ((c) == '\\' || (c) == '"')
52 extern int slap_debug;
58 * represents an attribute value assertion (i.e., attr=value)
62 struct berval ava_value;
66 * represents a search filter
68 typedef struct filter {
69 unsigned long f_choice; /* values taken from ldap.h */
75 /* equality, lessorequal, greaterorequal, approx */
79 struct filter *f_un_complex;
84 char *f_un_sub_initial;
89 #define f_type f_un.f_un_type
90 #define f_ava f_un.f_un_ava
91 #define f_avtype f_un.f_un_ava.ava_type
92 #define f_avvalue f_un.f_un_ava.ava_value
93 #define f_and f_un.f_un_complex
94 #define f_or f_un.f_un_complex
95 #define f_not f_un.f_un_complex
96 #define f_list f_un.f_un_complex
97 #define f_sub f_un.f_un_sub
98 #define f_sub_type f_un.f_un_sub.f_un_sub_type
99 #define f_sub_initial f_un.f_un_sub.f_un_sub_initial
100 #define f_sub_any f_un.f_un_sub.f_un_sub_any
101 #define f_sub_final f_un.f_un_sub.f_un_sub_final
103 struct filter *f_next;
107 * represents an attribute (type + values + syntax)
109 typedef struct attr {
111 struct berval **a_vals;
117 * the attr_syntax() routine returns one of these values
118 * telling what kind of syntax an attribute supports.
120 #define SYNTAX_CIS 0x01 /* case insensitive string */
121 #define SYNTAX_CES 0x02 /* case sensitive string */
122 #define SYNTAX_BIN 0x04 /* binary data */
123 #define SYNTAX_TEL 0x08 /* telephone number string */
124 #define SYNTAX_DN 0x10 /* dn string */
127 * the id used in the indexes to refer to an entry
129 typedef unsigned long ID;
130 #define NOID ((unsigned long)-1)
133 * represents an entry in core
135 typedef struct entry {
136 char *e_dn; /* DN of this entry */
137 char *e_ndn; /* normalized DN of this entry */
138 Attribute *e_attrs; /* list of attributes + values */
140 ID e_id; /* id of this entry - this should */
141 /* really be private to back-ldbm */
142 char e_state; /* for the cache */
144 ldap_pvt_thread_rdwr_t e_rdwr; /* reader/writer lock */
146 #define ENTRY_STATE_DELETED 1
147 #define ENTRY_STATE_CREATING 2
148 int e_refcnt; /* # threads ref'ing this entry */
149 struct entry *e_lrunext; /* for cache lru list */
150 struct entry *e_lruprev;
154 * represents an access control list
159 #define ACL_NONE 0x01
160 #define ACL_COMPARE 0x02
161 #define ACL_SEARCH 0x04
162 #define ACL_READ 0x08
163 #define ACL_WRITE 0x10
164 #define ACL_SELF 0x40
172 #ifdef SLAPD_ACLGROUPS
174 char *a_objectclassvalue;
175 char *a_groupattrname;
177 struct access *a_next;
182 /* "to" part: the entries this acl applies to */
188 /* "by" part: list of who has what access to the entries */
189 struct access *acl_access;
191 struct acl *acl_next;
197 typedef struct ldapmodlist {
198 struct ldapmod ml_mod;
199 struct ldapmodlist *ml_next;
200 #define ml_op ml_mod.mod_op
201 #define ml_type ml_mod.mod_type
202 #define ml_values ml_mod.mod_values
203 #define ml_bvalues ml_mod.mod_bvalues
207 * represents schema information for a database
214 struct objclass *oc_next;
218 * represents a "database"
221 typedef struct backend Backend;
223 char **be_suffix; /* the DN suffixes of data in this backend */
224 char **be_suffixAlias; /* the DN suffix aliases of data in this backend */
225 char *be_root_dn; /* the magic "root" dn for this db */
226 char *be_root_ndn; /* the magic "root" normalized dn for this db */
227 char *be_root_pw; /* the magic "root" password for this db */
228 int be_readonly; /* 1 => db is in "read only" mode */
229 int be_maxDerefDepth; /* limit for depth of an alias deref */
230 int be_sizelimit; /* size limit for this backend */
231 int be_timelimit; /* time limit for this backend */
232 struct acl *be_acl; /* access control list for this backend */
233 int be_dfltaccess; /* access given if no acl matches */
234 char **be_replica; /* replicas of this backend (in master) */
235 char *be_replogfile; /* replication log file (in master) */
236 char *be_update_ndn; /* allowed to make changes (in replicas) */
237 int be_lastmod; /* keep track of lastmodified{by,time} */
238 char *be_type; /* type of database */
240 void *be_private; /* anything the backend needs */
242 /* backend routines */
243 int (*be_bind) LDAP_P((Backend *be,
244 struct slap_conn *c, struct slap_op *o,
245 char *dn, int method, struct berval *cred, char** edn ));
246 void (*be_unbind) LDAP_P((Backend *be,
247 struct slap_conn *c, struct slap_op *o ));
248 int (*be_search) LDAP_P((Backend *be,
249 struct slap_conn *c, struct slap_op *o,
250 char *base, int scope, int deref, int slimit, int tlimit,
251 Filter *f, char *filterstr, char **attrs, int attrsonly));
252 int (*be_compare)LDAP_P((Backend *be,
253 struct slap_conn *c, struct slap_op *o,
254 char *dn, Ava *ava));
255 int (*be_modify) LDAP_P((Backend *be,
256 struct slap_conn *c, struct slap_op *o,
257 char *dn, LDAPModList *m));
258 int (*be_modrdn) LDAP_P((Backend *be,
259 struct slap_conn *c, struct slap_op *o,
260 char *dn, char *newrdn, int deleteoldrdn ));
261 int (*be_add) LDAP_P((Backend *be,
262 struct slap_conn *c, struct slap_op *o,
264 int (*be_delete) LDAP_P((Backend *be,
265 struct slap_conn *c, struct slap_op *o,
267 /* Bug: be_abandon in unused! */
268 void (*be_abandon)LDAP_P((Backend *be,
269 struct slap_conn *c, struct slap_op *o,
271 void (*be_config) LDAP_P((Backend *be,
272 char *fname, int lineno, int argc, char **argv ));
273 void (*be_init) LDAP_P((Backend *be));
274 void (*be_close) LDAP_P((Backend *be));
276 #ifdef SLAPD_ACLGROUPS
277 int (*be_group) LDAP_P((Backend *be, Entry *e,
278 char *bdn, char *edn,
279 char *objectclassValue, char *groupattrName ));
284 * represents an operation pending from an ldap client
287 typedef struct slap_op {
288 BerElement *o_ber; /* ber of the request */
289 long o_msgid; /* msgid of the request */
290 unsigned long o_tag; /* tag of the request */
291 time_t o_time; /* time op was initiated */
292 char *o_dn; /* dn bound when op was initiated */
293 char *o_ndn; /* normalized dn bound when op was initiated */
294 int o_authtype; /* auth method used to bind dn */
295 /* values taken from ldap.h */
297 int o_opid; /* id of this operation */
298 int o_connid; /* id of conn initiating this op */
299 #ifdef LDAP_CONNECTIONLESS
300 int o_cldap; /* != 0 if this came in via CLDAP */
301 struct sockaddr o_clientaddr; /* client address if via CLDAP */
302 char o_searchbase; /* search base if via CLDAP */
304 struct slap_op *o_next; /* next operation pending */
305 ldap_pvt_thread_t o_tid; /* thread handling this op */
306 int o_abandon; /* signals op has been abandoned */
307 ldap_pvt_thread_mutex_t o_abandonmutex; /* signals op has been abandoned */
309 void *o_private; /* anything the backend needs */
313 * represents a connection from an ldap client
316 typedef struct slap_conn {
317 Sockbuf c_sb; /* ber connection stuff */
318 char *c_cdn; /* DN provided by the client */
319 char *c_dn; /* DN bound to this conn */
320 ldap_pvt_thread_mutex_t c_dnmutex; /* mutex for c_dn field */
321 int c_protocol; /* version of the LDAP protocol used by client */
322 int c_authtype; /* auth method used to bind c_dn */
324 int c_version; /* for compatibility w/2.0, 3.0 */
326 char *c_addr; /* address of client on this conn */
327 char *c_domain; /* domain of client on this conn */
328 Operation *c_ops; /* list of pending operations */
329 ldap_pvt_thread_mutex_t c_opsmutex; /* mutex for c_ops list & stats */
330 ldap_pvt_thread_mutex_t c_pdumutex; /* only one pdu written at a time */
331 ldap_pvt_thread_cond_t c_wcv; /* used to wait for sd write-ready*/
332 int c_gettingber; /* in the middle of ber_get_next */
333 BerElement *c_currentber; /* ber we're getting */
334 int c_writewaiter; /* signals write-ready sd waiter */
335 int c_pduwaiters; /* signals threads waiting 4 pdu */
336 time_t c_starttime; /* when the connection was opened */
337 int c_connid; /* id of this connection for stats*/
338 int c_opsinitiated; /* # ops initiated/next op id */
339 int c_opscompleted; /* # ops completed */
342 #if defined(LDAP_SYSLOG) && defined(LDAP_DEBUG)
343 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 ) \
345 if ( ldap_debug & level ) \
346 fprintf( stderr, fmt, connid, opid, arg1, arg2, arg3 );\
347 if ( 0 && (ldap_syslog & level) ) \
348 syslog( ldap_syslog_level, fmt, connid, opid, arg1, \
352 #define Statslog( level, fmt, connid, opid, arg1, arg2, arg3 )
355 #include "proto-slap.h"
359 #endif /* _slap_h_ */