--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/include/helper.h	Tue Mar 10 13:49:58 2009 +0100
@@ -0,0 +1,129 @@
+/* Distributed Checksum Clearinghouse
+ *
+ * DNS blacklist and external filter definitions
+ *
+ * Copyright (c) 2008 by Rhyolite Software, LLC
+ *
+ * This agreement is not applicable to any entity which sells anti-spam
+ * solutions to others or provides an anti-spam solution as part of a
+ * security solution sold to other entities, or to a private network
+ * which employs the DCC or uses data provided by operation of the DCC
+ * but does not provide corresponding data to other users.
+ *
+ * Permission to use, copy, modify, and distribute this software without
+ * changes for any purpose with or without fee is hereby granted, provided
+ * that the above copyright notice and this permission notice appear in all
+ * copies and any distributed versions or copies are either unchanged
+ * or not called anything similar to "DCC" or "Distributed Checksum
+ * Clearinghouse".
+ *
+ * Parties not eligible to receive a license under this agreement can
+ * obtain a commercial license to use DCC by contacting Rhyolite Software
+ * at sales@rhyolite.com.
+ *
+ * A commercial license would be for Distributed Checksum and Reputation
+ * Clearinghouse software.  That software includes additional features.  This
+ * free license for Distributed ChecksumClearinghouse Software does not in any
+ * way grant permision to use Distributed Checksum and Reputation Clearinghouse
+ * software
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND RHYOLITE SOFTWARE, LLC DISCLAIMS ALL
+ * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL RHYOLITE SOFTWARE, LLC
+ * BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
+ * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+ * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
+ * SOFTWARE.
+ *
+ * Rhyolite Software DCC 1.3.103-1.33 $Revision$
+ */
+
+#ifndef HELPER_H
+#define HELPER_H
+
+#include "dcc_ck.h"
+
+#define HELPER_IDLE_STOP_SECS	(10*60)	/* helpers die of this much boredom */
+#define HELPER_IDLE_RESTART	(HELPER_IDLE_STOP_SECS - 30)
+#define HELPER_AUTO_REAP	(HELPER_IDLE_STOP_SECS / 20)
+
+#define HELPER_PAT "helper=%d,%d,%d"
+
+
+typedef struct {
+    u_int	sn;			/* serial # of parent */
+    u_int	gen;			/* generation of children */
+    u_int	failures;		/* failures in this generation */
+    int		pipe_write;
+    int		pipe_read;
+    /* save the socket and its port number obtained for the first child
+     * to give to later children */
+    SOCKET	soc;
+    DCC_SOCKU	su;
+    int		req_len;
+    int		argc;
+    int		free_args;
+    char const	**argv;
+    pid_t	*pids;
+    int		total_helpers;
+    int		max_helpers;
+    int		idle_helpers;
+    int		slow_helpers;		/* hung or at least slow helpers */
+    int		debug;
+    time_t	idle_restart;		/* restart helpers after then */
+    u_char	is_child;
+} HELPER;
+
+extern HELPER helper;
+
+
+typedef struct {
+    u_int	version;
+    u_int	magic;
+    u_int	sn;
+    struct timeval start;		/* when job started */
+    time_t	avail_us;		/* microseconds available for job */
+    char	id[DCC_MSG_ID_LEN+1];
+} HELPER_REQ_HDR;
+
+typedef struct {
+    u_int	version;
+    u_int	magic;
+    u_int	sn;
+} HELPER_RESP_HDR;
+
+#define HELPER_VERSION	    0x10
+#define HELPER_MAGIC_REQ    0xbeefdead
+#define HELPER_MAGIC_RESP   0xdeadbeef
+
+typedef struct {
+    HELPER_REQ_HDR hdr;
+    DNSBL_FGS	fg;			/* what to look for */
+    DNSBL_UNHIT	unhit;			/* groups of DNSBLs not still yet hit */
+    DNSBL_FGS	fgs[MAX_DNSBL_GROUPS];
+    DNSBL_TGT	tgt;
+} DNSBL_REQ;
+
+typedef struct {
+    DNSBL_FGS	fgs;			/* what was found */
+    int		bl_num;			/* # of DNSBL hit */
+    char	result[DCC_SU2STR_SIZE];    /* IP address found in DNSBL */
+    DNSBL_DOM	tgt;			/* name or address sought in DNSBL */
+    DNSBL_DOM	probe;			/* what was actually looked up */
+} DNSBL_RESP_GROUP;
+typedef struct {
+    HELPER_RESP_HDR hdr;
+    DNSBL_UNHIT	unhit;			/* groups of DNSBLs not yet hit */
+    DNSBL_RESP_GROUP groups[MAX_DNSBL_GROUPS];
+} DNSBL_RESP;
+
+
+extern void NRATTRIB helper_child(SOCKET, int, int);
+extern void reap_helpers(u_char);
+extern u_char ask_helper(DCC_CLNT_CTXT *, void *, time_t,
+			 HELPER_REQ_HDR *, int, HELPER_RESP_HDR *, int);
+
+extern u_char dnsbl_work(const DNSBL_REQ *, DNSBL_RESP *);
+
+#endif /* HELPER_H */