69e2889ed81bb67d9ec2c1d5c4207c8e0de7f82d
[rxpd] / src / rxpd.h
1 /*
2     rxpd.h - regex policy daemon
3
4   Copyright (C)
5     2007,               Christian Thaeter <ct@pipapo.org>
6
7   This program is free software; you can redistribute it and/or
8   modify it under the terms of the GNU General Public License as
9   published by the Free Software Foundation; either version 2 of the
10   License, or (at your option) any later version.
11
12   This program is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program; if not, write to the Free Software
19   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21 #ifndef RXPD_H
22 #define RXPD_H
23
24 #define _GNU_SOURCE
25
26 #include "llist.h"
27 #include "psplay.h"
28
29 #include <errno.h>
30 #include <string.h>
31 #include <stdlib.h>
32 #include <stdarg.h>
33 #include <unistd.h>
34 #include <regex.h>
35 #include <syslog.h>
36 #include <sys/stat.h>
37 #include <sys/time.h>
38 #include <sys/types.h>
39 #include <sys/socket.h>
40 #include <netinet/in.h>
41 #include <arpa/inet.h>
42 #include <event.h>
43 #include <pth.h>
44 #include <time.h>
45 #include <netdb.h>
46
47 #define RXPD_COMMANDS                                           \
48   RXPD_CMD(CHECK,       "data against regular expressions")     \
49   RXPD_CMD(APPEND,      "new rules to a list")                  \
50   RXPD_CMD(PREPEND,     "new rules in front of a list")         \
51   RXPD_CMD(REMOVE,      "rules from a list")                    \
52   RXPD_CMD(REPLACE,     "a rule in a list with new rules")      \
53   RXPD_CMD(DELETE,      "a list from memory")                   \
54   RXPD_CMD(LOAD,        "a list from disk")                     \
55   RXPD_CMD(SAVE,        "a list to disk")                       \
56   RXPD_CMD(FETCH,       "a list from a remote server")          \
57   RXPD_CMD(UPDATE,      "atimes from other lists")              \
58   RXPD_CMD(MERGE,       "new rules from from other lists")      \
59   RXPD_CMD(EXPIRE,      "aged rules from a list")               \
60   RXPD_CMD(FILTER,      "rules in a list")                      \
61   RXPD_CMD(DUMP,        "rules in a list")                      \
62   RXPD_CMD(LIST,        "all existing lists")                   \
63   RXPD_CMD(VERSION,     "of this rxpd is "PACKAGE_VERSION)      \
64   RXPD_CMD(HELP,        "is what you see right now")            \
65   RXPD_CMD(SHUTDOWN,    "the daemon")
66
67 #define RXPD_CMD(cmd, _) RXPD_CMD_##cmd,
68 enum rxpd_cmd_e {RXPD_COMMANDS};
69 #undef RXPD_CMD
70
71 /*
72  * characters which are absolutely not allowed in rule filenames
73  * for finer control use policies, note that this are arbitary
74  * decisions also reserving some chars for later extension
75  */
76 #define RXPD_FILE_ILG_CHARS "&?<>|: \t\n\r*?\\"
77
78 /*
79  * Call a cooperative pth_yield every this much expensive interations
80  * not implemented yet
81  * A higher number favors throughput, lower number improves latency
82  */
83 #define RXPD_YIELD_EVERY 500
84
85 #define RXPD_PREFIXCMP(str, pfx) (!strncmp (str, (pfx), sizeof (pfx)-1))
86
87 struct rxpd_base;
88 struct rxpd_file;
89 struct rxpd_rule;
90 struct rxpd_socket;
91 struct rxpd_buffer;
92 struct rxpd_connection;
93
94 struct rxpd_base
95 {
96   char* basedir;
97
98   int verbosity;
99   int regflags;
100   int daemonize;
101   const char* locale;
102
103   struct rxpd_file* policy;
104
105   // TODO
106   //FILE* -l log      log hits to logfile
107
108   psplayroot files;
109   llist sockets;
110 };
111
112 struct rxpd_base*
113 rxpd_init (void);
114
115 void
116 rxpd_destroy (void);
117
118 void
119 rxpd_log (struct rxpd_base*, int level, const char* fmt, ...);
120
121 void
122 rxpd_fail (struct rxpd_base*, const char* fmt, ...);
123
124 void
125 rxpd_die (const char* fmt, ...);
126
127 void*
128 rxpd_malloc (size_t size);
129
130 char*
131 rxpd_strdup (const char* str);
132
133 struct rxpd_base*
134 rxpd_set_basedir (struct rxpd_base*, const char* basedir);
135
136 //
137 struct rxpd_rule
138 {
139   llist node;
140   char* string;
141   time_t atime;
142   regex_t rx;
143 };
144
145 struct rxpd_rule*
146 rxpd_rule_new (const char* buf);
147
148 struct rxpd_rule*
149 rxpd_rule_copy (const struct rxpd_rule* src);
150
151 struct rxpd_rule*
152 rxpd_rule_activate (struct rxpd_rule* self);
153
154 struct rxpd_rule*
155 rxpd_rule_comment (struct rxpd_rule* self, const char* comment);
156
157 void
158 rxpd_rule_delete (struct rxpd_rule* self);
159
160
161
162 //
163 struct rxpd_file
164 {
165   psplay node;          // key points to basename part of filename
166   const char* filename; // full filename
167   //TODO later     struct stat last_stat;
168   struct rxpd_base* base;
169   pth_rwlock_t lock;
170   llist rules;
171 };
172
173 struct rxpd_file*
174 rxpd_file_new (struct rxpd_base* base, const char* filename);
175
176 void
177 rxpd_file_delete (struct rxpd_file* file);
178
179 struct rxpd_file*
180 rxpd_file_rules_delete (struct rxpd_file* self);
181
182 int
183 rxpd_file_load (struct rxpd_file* self);
184
185 int
186 rxpd_file_save (struct rxpd_file* self);
187
188 struct rxpd_file*
189 rxpd_file_dump (struct rxpd_file* self, struct rxpd_buffer* out);
190
191 int
192 rxpd_file_cmp (const void* A, const void* B);
193
194
195 //
196
197 struct rxpd_socket
198 {
199   llist node;
200   int fd;
201   struct event ev;
202   struct rxpd_base* base;
203   pth_t accepter;
204   int (*rxpd_socket_addr)(struct rxpd_connection* conn, char* dst, const char* pfx, size_t size);
205 };
206
207
208 struct rxpd_socket*
209 rxpd_socket_new_tcp4 (struct rxpd_base* base, const char* addr, unsigned short port);
210
211 int
212 rxpd_socket_tcp4addr (struct rxpd_connection* conn, char* dst, const char* pfx, size_t size);
213
214 //TODO
215 //struct rxpd_socket*
216 //rxpd_socket_new_unix (struct rxpd_base* base, const char* name);
217
218 void
219 rxpd_socket_delete (struct rxpd_socket* self);
220
221 void *
222 rxpd_socket_accept (void* ptr);
223
224 struct rxpd_socket*
225 rxpd_socket_spawn (struct rxpd_socket* self);
226
227 struct rxpd_socket*
228 rxpd_socket_join (struct rxpd_socket* self);
229
230 struct rxpd_socket*
231 rxpd_socket_cancel (struct rxpd_socket* self);
232
233 //
234
235 enum rxpd_buffer_state_e
236   {
237     RXPD_OK,            // operational
238     RXPD_EOF,           // connection closed
239     RXPD_ERROR          // some other error
240   };
241
242 struct rxpd_buffer
243 {
244   int fd;
245   enum rxpd_buffer_state_e state;
246   char* eol;
247   char* eob;
248   char buffer[4096];
249 };
250
251 struct rxpd_buffer*
252 rxpd_buffer_init (struct rxpd_buffer* self, int fd);
253
254 char*
255 rxpd_buffer_readline (struct rxpd_buffer* self);
256
257 int
258 rxpd_buffer_printf (struct rxpd_buffer* self, const char* fmt, ...);
259
260 inline static enum rxpd_buffer_state_e
261 rxpd_buffer_state (struct rxpd_buffer* self)
262 {
263   return self->state;
264 }
265
266
267 //
268 struct rxpd_connection
269 {
270   int fd;
271   pth_t connecter;
272   struct rxpd_file* file;
273   struct rxpd_socket* socket;
274   char* tmp_str;
275   llist tmp_list;
276
277   struct rxpd_buffer in;
278   struct rxpd_buffer out;
279 };
280
281
282 struct rxpd_connection*
283 rxpd_connection_new (struct rxpd_socket* socket, int fd);
284
285 void
286 rxpd_connection_delete (struct rxpd_connection* self);
287
288 struct rxpd_connection*
289 rxpd_connection_spawn (struct rxpd_connection* self);
290
291 int
292 rxpd_connection_readline (struct rxpd_connection* self);
293
294 int
295 rxpd_connection_check_policy (struct rxpd_connection* self, char* line);
296
297 void*
298 rxpd_connection_parse_cmd (void* ptr);
299
300 /* generate prototypes for each defined command */
301 #define RXPD_CMD(cmd, _) void rxpd_connection_cmd_##cmd (struct rxpd_connection* self);
302 RXPD_COMMANDS
303 #undef RXPD_CMD
304
305
306 #endif