3 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1996 Regents of the University of Michigan.
10 * Redistribution and use in source and binary forms are permitted
11 * provided that this notice is preserved and that due credit is given
12 * to the University of Michigan at Ann Arbor. The name of the University
13 * may not be used to endorse or promote products derived from this
14 * software without specific prior written permission. This software
15 * is provided ``as is'' without express or implied warranty.
18 /* slurp.h - Standalone Ldap Update Replication Daemon (slurpd) */
23 #if !defined(HAVE_WINSOCK) && !defined(LDAP_SYSLOG)
29 #include <ac/signal.h>
30 #include <ac/syslog.h>
33 #include <sys/types.h>
38 #define ldap_debug slurp_debug
41 #include "ldap_pvt_thread.h"
42 #include "ldap_defaults.h"
46 #define ftruncate(a,b) _chsize(a,b)
47 #define truncate(a,b) _lclose( _lcreat(a, 0))
53 #define SERVICE_NAME OPENLDAP_PACKAGE "-slurpd"
55 /* Default directory for slurpd's private copy of replication logs */
56 #define DEFAULT_SLURPD_REPLICA_DIR LDAP_RUNDIR LDAP_DIRSEP "openldap-slurp"
58 /* Default name for slurpd's private copy of the replication log */
59 #define DEFAULT_SLURPD_REPLOGFILE "slurpd.replog"
61 /* Name of file which stores saved slurpd state info, for restarting */
62 #define DEFAULT_SLURPD_STATUS_FILE "slurpd.status"
64 /* slurpd dump file - contents of rq struct are written here (debugging) */
65 #define SLURPD_DUMPFILE LDAP_TMPDIR LDAP_DIRSEP "slurpd.dump"
67 /* default srvtab file. Can be overridden */
68 #define SRVTAB "/etc/srvtab"
70 /* Amount of time to sleep if no more work to do */
71 #define DEFAULT_NO_WORK_INTERVAL 3
73 /* The time we wait between checks to see if the replog file needs trimming */
74 #define TRIMCHECK_INTERVAL ( 60 * 5 )
76 /* Only try to trim slurpd replica files larger than this size */
77 #define MIN_TRIM_FILESIZE ( 10L * 1024L )
79 /* Maximum line length we can read from replication log */
80 #define REPLBUFLEN 256
85 #define TLS_CRITICAL 2
87 /* We support simple (plaintext password) and SASL authentication */
89 #define AUTH_KERBEROS 2
92 /* Rejection records are prefaced with this string */
93 #define ERROR_STR "ERROR"
95 /* Strings found in replication entries */
96 #define T_CHANGETYPESTR "changetype"
97 #define T_CHANGETYPE 1
98 #define T_TIMESTR "time"
103 #define T_ADDCTSTR "add"
105 #define T_MODIFYCTSTR "modify"
107 #define T_DELETECTSTR "delete"
109 #define T_MODRDNCTSTR "modrdn"
110 #define T_MODDNCTSTR "moddn"
111 #define T_RENAMECTSTR "rename"
114 #define T_MODOPADDSTR "add"
116 #define T_MODOPREPLACESTR "replace"
117 #define T_MODOPREPLACE 9
118 #define T_MODOPDELETESTR "delete"
119 #define T_MODOPDELETE 10
120 #define T_MODSEPSTR "-"
123 #define T_NEWRDNSTR "newrdn"
124 #define T_DELOLDRDNSTR "deleteoldrdn"
125 #define T_NEWSUPSTR "newsuperior"
129 /* Config file keywords */
130 #define HOSTSTR "host"
132 #define ATTRSTR "attr"
133 #define SUFFIXSTR "suffix"
134 #define BINDDNSTR "binddn"
135 #define BINDMETHSTR "bindmethod"
136 #define KERBEROSSTR "kerberos"
137 #define SIMPLESTR "simple"
138 #define SASLSTR "sasl"
139 #define CREDSTR "credentials"
140 #define OLDAUTHCSTR "bindprincipal"
141 #define AUTHCSTR "authcID"
142 #define AUTHZSTR "authzID"
143 #define SRVTABSTR "srvtab"
144 #define SASLMECHSTR "saslmech"
145 #define REALMSTR "realm"
146 #define SECPROPSSTR "secprops"
147 #define STARTTLSSTR "starttls"
149 #define CRITICALSTR "critical"
151 #define REPLICA_SLEEP_TIME ( 10 )
153 /* Enumeration of various types of bind failures */
155 #define BIND_ERR_BADLDP 1
156 #define BIND_ERR_OPEN 2
157 #define BIND_ERR_BAD_ATYPE 3
158 #define BIND_ERR_SIMPLE_FAILED 4
159 #define BIND_ERR_KERBEROS_FAILED 5
160 #define BIND_ERR_BADRI 6
161 #define BIND_ERR_VERSION 7
162 #define BIND_ERR_REFERRALS 8
163 #define BIND_ERR_MANAGEDSAIT 9
164 #define BIND_ERR_SASL_FAILED 10
165 #define BIND_ERR_TLS_FAILED 11
167 /* Return codes for do_ldap() */
169 #define DO_LDAP_ERR_RETRYABLE 1
170 #define DO_LDAP_ERR_FATAL 2
173 * Types of counts one can request from the Rq rq_getcount()
177 #define RQ_COUNT_ALL 1
178 /* all elements with nonzero refcnt */
179 #define RQ_COUNT_NZRC 2
181 /* Amount of time, in seconds, for a thread to sleep when it encounters
182 * a retryable error in do_ldap().
184 #define RETRY_SLEEP_TIME 60
190 * ****************************************************************************
191 * Data types for replication queue and queue elements.
192 * ****************************************************************************
197 * Replica host information. An Ri struct will contain an array of these,
198 * with one entry for each replica. The end of the array is signaled
199 * by a NULL value in the rh_hostname field.
202 char *rh_hostname; /* replica hostname */
203 int rh_port; /* replica port */
208 * Per-replica information.
211 * - Private data should not be manipulated expect by Ri member functions.
213 typedef struct ri Ri;
216 char *ri_hostname; /* canonical hostname of replica */
217 int ri_port; /* port where slave slapd running */
218 char *ri_uri; /* e.g. "ldaps://ldap-1.example.com:636" */
219 LDAP *ri_ldp; /* LDAP struct for this replica */
220 int ri_tls; /* TLS: 0=no, 1=yes, 2=critical */
221 int ri_bind_method; /* AUTH_SIMPLE or AUTH_KERBEROS */
222 char *ri_bind_dn; /* DN to bind as when replicating */
223 char *ri_password; /* Password for any method */
224 char *ri_secprops; /* SASL security properties */
225 char *ri_realm; /* realm for any mechanism */
226 char *ri_authcId; /* authentication ID for any mechanism */
227 char *ri_authzId; /* authorization ID for any mechanism */
228 char *ri_srvtab; /* srvtab file for kerberos bind */
229 char *ri_saslmech; /* SASL mechanism to use */
230 struct re *ri_curr; /* current repl entry being processed */
231 struct stel *ri_stel; /* pointer to Stel for this replica */
233 ri_seq; /* seq number of last repl */
234 ldap_pvt_thread_t ri_tid; /* ID of thread for this replica */
236 /* Member functions */
237 int (*ri_process) LDAP_P(( Ri * )); /* process the next repl entry */
238 void (*ri_wake) LDAP_P(( Ri * )); /* wake up a sleeping thread */
245 * Information about one particular modification to make. This data should
246 * be considered private to routines in re.c, and to routines in ri.c.
251 char *mi_type; /* attr or type */
252 char *mi_val; /* value */
253 int mi_len; /* length of mi_val */
260 * Information about one particular replication entry. Only routines in
261 * re.c and rq.c should touch the private data. Other routines should
262 * only use member functions.
264 typedef struct re Re;
268 ldap_pvt_thread_mutex_t
269 re_mutex; /* mutex for this Re */
270 int re_refcnt; /* ref count, 0 = done */
271 time_t re_timestamp; /* timestamp of this re */
272 int re_seq; /* sequence number */
273 Rh *re_replicas; /* array of replica info */
274 char *re_dn; /* dn of entry being modified */
275 int re_changetype; /* type of modification */
276 Mi *re_mods; /* array of modifications to make */
277 struct re *re_next; /* pointer to next element */
279 /* Public functions */
280 int (*re_free) LDAP_P(( Re * )); /* free an re struct */
281 Re *(*re_getnext) LDAP_P(( Re * )); /* return next Re in linked list */
282 int (*re_parse) LDAP_P(( Re *, char * )); /* parse replication log entry */
283 int (*re_write) LDAP_P(( Ri *, Re *, FILE * )); /* write repl. log entry */
284 void (*re_dump) LDAP_P(( Re *, FILE * )); /* debugging - print contents */
285 int (*re_lock) LDAP_P(( Re * )); /* lock this re */
286 int (*re_unlock) LDAP_P(( Re * )); /* unlock this re */
287 int (*re_decrefcnt) LDAP_P(( Re * )); /* decrement the refcnt */
288 int (*re_getrefcnt) LDAP_P(( Re * )); /* get the refcnt */
295 * Definition for the queue of replica information. Private data is
296 * private to rq.c. Other routines should only touch public data or
297 * use member functions. Note that although we have a member function
298 * for locking the queue's mutex, we need to expose the rq_mutex
299 * variable so routines in ri.c can use it as a mutex for the
300 * rq_more condition variable.
302 typedef struct rq Rq;
306 Re *rq_head; /* pointer to head */
307 Re *rq_tail; /* pointer to tail */
308 int rq_nre; /* total number of Re's in queue */
309 int rq_ndel; /* number of deleted Re's in queue */
310 time_t rq_lasttrim; /* Last time we trimmed file */
313 ldap_pvt_thread_mutex_t
314 rq_mutex; /* mutex for whole queue */
315 ldap_pvt_thread_cond_t
316 rq_more; /* condition var - more work added */
318 /* Member functions */
319 Re * (*rq_gethead) LDAP_P(( Rq * )); /* get the element at head */
320 Re * (*rq_getnext) LDAP_P(( Re * )); /* get the next element */
321 int (*rq_delhead) LDAP_P(( Rq * )); /* delete the element at head */
322 int (*rq_add) LDAP_P(( Rq *, char * )); /* add at tail */
323 void (*rq_gc) LDAP_P(( Rq * )); /* garbage-collect queue */
324 int (*rq_lock) LDAP_P(( Rq * )); /* lock the queue */
325 int (*rq_unlock) LDAP_P(( Rq * )); /* unlock the queue */
326 int (*rq_needtrim) LDAP_P(( Rq * )); /* see if queue needs trimming */
327 int (*rq_write) LDAP_P(( Rq *, FILE * )); /*write Rq contents to file*/
328 int (*rq_getcount) LDAP_P(( Rq *, int )); /* return queue counts */
329 void (*rq_dump) LDAP_P(( Rq * )); /* debugging - print contents */
334 * An Stel (status element) contains information about one replica.
335 * Stel structs are associated with the St (status) struct, defined
338 typedef struct stel {
339 char *hostname; /* host name of replica */
340 int port; /* port number of replica */
341 time_t last; /* timestamp of last successful repl */
342 int seq; /* Sequence number of last repl */
347 * An St struct in an in-core structure which contains the current
348 * slurpd state. Most importantly, it contains an array of Stel
349 * structs which contain the timestamp and sequence number of the last
350 * successful replication for each replica. The st_write() member
351 * function is called periodically to flush status information to
352 * disk. At startup time, slurpd checks for the status file, and
353 * if present, uses the timestamps to avoid "replaying" replications
354 * which have already been sent to a given replica.
356 typedef struct st St;
359 ldap_pvt_thread_mutex_t
360 st_mutex; /* mutex to serialize access */
361 Stel **st_data; /* array of pointers to Stel structs */
362 int st_nreplicas; /* number of repl hosts */
363 int st_err_logged; /* 1 if fopen err logged */
364 FILE *st_fp; /* st file kept open */
365 FILE *st_lfp; /* lockfile fp */
367 /* Public member functions */
368 int (*st_update) LDAP_P(( St *, Stel*, Re* ));/*update entry for a host*/
369 Stel*(*st_add) LDAP_P(( St *, Ri * )); /*add a new repl host*/
370 int (*st_write) LDAP_P(( St * )); /* write status to disk */
371 int (*st_read) LDAP_P(( St * )); /* read status info from disk */
372 int (*st_lock) LDAP_P(( St * )); /* read status info from disk */
373 int (*st_unlock) LDAP_P(( St * )); /* read status info from disk */
376 #if defined( HAVE_LWP )
378 thread_t tl_tid; /* thread being managed */
379 time_t tl_wake; /* time thread should be resumed */
380 struct tl *tl_next; /* next node in list */
387 #endif /* HAVE_LWP */
390 * Public functions used to instantiate and initialize queue objects.
392 extern int Ri_init LDAP_P(( Ri **ri ));
393 extern int Rq_init LDAP_P(( Rq **rq ));
394 extern int Re_init LDAP_P(( Re **re ));
396 #include "proto-slurp.h"
400 #endif /* _SLURPD_H_ */