rule_acticvate function to 'uncomment' rules
[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(DUMP,        "rules in a list")                      \
61   RXPD_CMD(LIST,        "all existing lists")                   \
62   RXPD_CMD(VERSION,     "of this rxpd is "PACKAGE_VERSION)      \
63   RXPD_CMD(HELP,        "is what you see right now")            \
64   RXPD_CMD(SHUTDOWN,    "the daemon")
65
66 #define RXPD_CMD(cmd, _) RXPD_CMD_##cmd,
67 enum rxpd_cmd_e {RXPD_COMMANDS};
68 #undef RXPD_CMD
69
70 /*
71  * characters which are absolutely not allowed in rule filenames
72  * for finer control use policies, note that this are arbitary
73  * decisions also reserving some chars for later extension
74  */
75 #define RXPD_FILE_ILG_CHARS "@&?<>|/: \t\n\r*?\\"
76
77 /*
78  * Call a cooperative pth_yield every this much expensive interations
79  * not implemented yet
80  * A higher number favors throughput, lower number improves latency
81  */
82 #define RXPD_YIELD_EVERY 500
83
84 #define RXPD_PREFIXCMP(str, pfx) (!strncmp (str, (pfx), sizeof (pfx)-1))
85
86 struct rxpd_base;
87 struct rxpd_file;
88 struct rxpd_rule;
89 struct rxpd_socket;
90 struct rxpd_buffer;
91 struct rxpd_connection;
92
93 struct rxpd_base
94 {
95   char* basedir;
96
97   int verbosity;
98   int regflags;
99   int daemonize;
100   const char* locale;
101
102   struct rxpd_file* policy;
103
104   // TODO
105   //FILE* -l log      log hits to logfile
106
107   psplayroot files;
108   llist sockets;
109 };
110
111 struct rxpd_base*
112 rxpd_init (void);
113
114 void
115 rxpd_destroy (void);
116
117 void
118 rxpd_log (struct rxpd_base*, int level, const char* fmt, ...);
119
120 void
121 rxpd_fail (struct rxpd_base*, const char* fmt, ...);
122
123 void
124 rxpd_die (const char* fmt, ...);
125
126 void*
127 rxpd_malloc (size_t size);
128
129 char*
130 rxpd_strdup (const char* str);
131
132 struct rxpd_base*
133 rxpd_set_basedir (struct rxpd_base*, const char* basedir);
134
135 //
136 struct rxpd_rule
137 {
138   llist node;
139   char* string;
140   time_t atime;
141   regex_t rx;
142 };
143
144 struct rxpd_rule*
145 rxpd_rule_new (const char* buf);
146
147 struct rxpd_rule*
148 rxpd_rule_copy (const struct rxpd_rule* src);
149
150 struct rxpd_rule*
151 rxpd_rule_activate (struct rxpd_rule* self);
152
153 struct rxpd_rule*
154 rxpd_rule_comment (struct rxpd_rule* self, const char* comment);
155
156 void
157 rxpd_rule_delete (struct rxpd_rule* self);
158
159
160
161 //
162 struct rxpd_file
163 {
164   psplay node;          // key points to basename part of filename
165   const char* filename; // full filename
166   //TODO later     struct stat last_stat;
167   struct rxpd_base* base;
168   pth_rwlock_t lock;
169   llist rules;
170 };
171
172 struct rxpd_file*
173 rxpd_file_new (struct rxpd_base* base, const char* filename);
174
175 void
176 rxpd_file_delete (struct rxpd_file* file);
177
178 struct rxpd_file*
179 rxpd_file_rules_delete (struct rxpd_file* self);
180
181 int
182 rxpd_file_load (struct rxpd_file* self);
183
184 int
185 rxpd_file_save (struct rxpd_file* self);
186
187 struct rxpd_file*
188 rxpd_file_dump (struct rxpd_file* self, struct rxpd_buffer* out);
189
190 int
191 rxpd_file_cmp (const void* A, const void* B);
192
193
194 //
195
196 struct rxpd_socket
197 {
198   llist node;
199   int fd;
200   struct event ev;
201   struct rxpd_base* base;
202   pth_t accepter;
203   int (*rxpd_socket_addr)(struct rxpd_connection* conn, char* dst, const char* pfx, size_t size);
204 };
205
206
207 struct rxpd_socket*
208 rxpd_socket_new_tcp4 (struct rxpd_base* base, const char* addr, unsigned short port);
209
210 int
211 rxpd_socket_tcp4addr (struct rxpd_connection* conn, char* dst, const char* pfx, size_t size);
212
213 //TODO
214 //struct rxpd_socket*
215 //rxpd_socket_new_unix (struct rxpd_base* base, const char* name);
216
217 void
218 rxpd_socket_delete (struct rxpd_socket* self);
219
220 void *
221 rxpd_socket_accept (void* ptr);
222
223 struct rxpd_socket*
224 rxpd_socket_spawn (struct rxpd_socket* self);
225
226 struct rxpd_socket*
227 rxpd_socket_join (struct rxpd_socket* self);
228
229 struct rxpd_socket*
230 rxpd_socket_cancel (struct rxpd_socket* self);
231
232 //
233
234 enum rxpd_buffer_state_e
235   {
236     RXPD_OK,            // operational
237     RXPD_EOF,           // connection closed
238     RXPD_ERROR          // some other error
239   };
240
241 struct rxpd_buffer
242 {
243   int fd;
244   enum rxpd_buffer_state_e state;
245   char* eol;
246   char* eob;
247   char buffer[4096];
248 };
249
250 struct rxpd_buffer*
251 rxpd_buffer_init (struct rxpd_buffer* self, int fd);
252
253 char*
254 rxpd_buffer_readline (struct rxpd_buffer* self);
255
256 int
257 rxpd_buffer_printf (struct rxpd_buffer* self, const char* fmt, ...);
258
259 inline static enum rxpd_buffer_state_e
260 rxpd_buffer_state (struct rxpd_buffer* self)
261 {
262   return self->state;
263 }
264
265
266 //
267 struct rxpd_connection
268 {
269   int fd;
270   pth_t connecter;
271   struct rxpd_file* file;
272   struct rxpd_socket* socket;
273   char* tmp_str;
274   llist tmp_list;
275
276   struct rxpd_buffer in;
277   struct rxpd_buffer out;
278 };
279
280
281 struct rxpd_connection*
282 rxpd_connection_new (struct rxpd_socket* socket, int fd);
283
284 void
285 rxpd_connection_delete (struct rxpd_connection* self);
286
287 struct rxpd_connection*
288 rxpd_connection_spawn (struct rxpd_connection* self);
289
290 int
291 rxpd_connection_readline (struct rxpd_connection* self);
292
293 int
294 rxpd_connection_check_policy (struct rxpd_connection* self, char* line);
295
296 void*
297 rxpd_connection_parse_cmd (void* ptr);
298
299 /* generate prototypes for each defined command */
300 #define RXPD_CMD(cmd, _) void rxpd_connection_cmd_##cmd (struct rxpd_connection* self);
301 RXPD_COMMANDS
302 #undef RXPD_CMD
303
304
305 #endif