append given basedir argument with '/' if not given
[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 #include "llist.h"
25 #include "psplay.h"
26
27 #include <errno.h>
28 #include <string.h>
29 #include <stdlib.h>
30 #include <stdarg.h>
31 #include <unistd.h>
32 #include <regex.h>
33 #include <syslog.h>
34 #include <sys/stat.h>
35 #include <sys/time.h>
36 #include <sys/types.h>
37 #include <sys/socket.h>
38 #include <netinet/in.h>
39 #include <arpa/inet.h>
40 #include <event.h>
41 #include <pth.h>
42 #include <time.h>
43 #include <netdb.h>
44
45 #define RXPD_COMMANDS                                           \
46   RXPD_CMD(CHECK,       "data against regular expressions")     \
47   RXPD_CMD(APPEND,      "new rules to a list")                  \
48   RXPD_CMD(PREPEND,     "new rules in front of a list")         \
49   RXPD_CMD(REMOVE,      "rules from a list")                    \
50   RXPD_CMD(REPLACE,     "a rule in a list with new rules")      \
51   RXPD_CMD(DELETE,      "a list from memory")                   \
52   RXPD_CMD(LOAD,        "a list from disk")                     \
53   RXPD_CMD(SAVE,        "a list to disk")                       \
54   RXPD_CMD(FETCH,       "a list from a remote server")          \
55   RXPD_CMD(EXPIRE,      "aged rules from a list")               \
56   RXPD_CMD(DUMP,        "rules in a list")                      \
57   RXPD_CMD(LIST,        "all existing lists")                   \
58   RXPD_CMD(VERSION,     "of this rxpd is "PACKAGE_VERSION)      \
59   RXPD_CMD(HELP,        "is what you see right now")            \
60   RXPD_CMD(SHUTDOWN,    "the daemon")
61
62 #define RXPD_CMD(cmd, _) RXPD_CMD_##cmd,
63 enum rxpd_cmd_e {RXPD_COMMANDS};
64 #undef RXPD_CMD
65
66 /*
67  * characters which are absolutely not allowed in rule filenames
68  * for finer control use policies, note that this are arbitary
69  * decisions also reserving some chars for later extension
70  */
71 #define RXPD_FILE_ILG_CHARS "@&?<>|/: \t\n\r*?\\"
72
73 /*
74  * Call a cooperative pth_yield every this much expensive interations
75  * not implemented yet
76  * A higher number favors throughput, lower number improves latency
77  */
78 #define RXPD_YIELD_EVERY 500
79
80 struct rxpd_base;
81 struct rxpd_file;
82 struct rxpd_rule;
83 struct rxpd_socket;
84 struct rxpd_buffer;
85 struct rxpd_connection;
86
87 struct rxpd_base
88 {
89   char* basedir;
90
91   int verbosity;
92   int regflags;
93   int daemonize;
94
95   struct rxpd_file* policy;
96
97   // TODO
98   //FILE* -l log      log hits to logfile
99
100   psplayroot files;
101   llist sockets;
102 };
103
104 struct rxpd_base*
105 rxpd_init (void);
106
107 void
108 rxpd_destroy (void);
109
110 void
111 rxpd_log (struct rxpd_base*, int level, const char* fmt, ...);
112
113 void
114 rxpd_fail (struct rxpd_base*, const char* fmt, ...);
115
116 void
117 rxpd_die (const char* fmt, ...);
118
119 void*
120 rxpd_malloc (size_t size);
121
122 char*
123 rxpd_strdup (const char* str);
124
125 struct rxpd_base*
126 rxpd_set_basedir (struct rxpd_base*, const char* basedir);
127
128 //
129 struct rxpd_rule
130 {
131   llist node;
132   char* string;
133   time_t atime;
134   regex_t rx;
135 };
136
137 struct rxpd_rule*
138 rxpd_rule_new (const char* buf);
139
140 void
141 rxpd_rule_delete (struct rxpd_rule*);
142
143
144
145 //
146 struct rxpd_file
147 {
148   psplay node;          // key points to basename part of filename
149   const char* filename; // full filename
150   //TODO later     struct stat last_stat;
151   struct rxpd_base* base;
152   llist rules;
153 };
154
155 struct rxpd_file*
156 rxpd_file_new (struct rxpd_base* base, const char* filename);
157
158 void
159 rxpd_file_delete (struct rxpd_file* file);
160
161 struct rxpd_file*
162 rxpd_file_rules_delete (struct rxpd_file* self);
163
164 int
165 rxpd_file_load (struct rxpd_file* self);
166
167 int
168 rxpd_file_save (struct rxpd_file* self);
169
170 int
171 rxpd_file_cmp (const void* A, const void* B);
172
173
174 //
175
176 struct rxpd_socket
177 {
178   llist node;
179   int fd;
180   struct event ev;
181   struct rxpd_base* base;
182   pth_t accepter;
183   int (*rxpd_socket_addr)(struct rxpd_connection* conn, char* dst, const char* pfx, size_t size);
184 };
185
186
187 struct rxpd_socket*
188 rxpd_socket_new_tcp4 (struct rxpd_base* base, const char* addr, unsigned short port);
189
190 int
191 rxpd_socket_tcp4addr (struct rxpd_connection* conn, char* dst, const char* pfx, size_t size);
192
193 //TODO
194 //struct rxpd_socket*
195 //rxpd_socket_new_unix (struct rxpd_base* base, const char* name);
196
197 void
198 rxpd_socket_delete (struct rxpd_socket* self);
199
200 void *
201 rxpd_socket_accept (void* ptr);
202
203 struct rxpd_socket*
204 rxpd_socket_spawn (struct rxpd_socket* self);
205
206 struct rxpd_socket*
207 rxpd_socket_join (struct rxpd_socket* self);
208
209 struct rxpd_socket*
210 rxpd_socket_cancel (struct rxpd_socket* self);
211
212 //
213
214 enum rxpd_buffer_state_e
215   {
216     RXPD_OK,            // operational
217     RXPD_EOF,           // connection closed
218     RXPD_ERROR          // some other error
219   };
220
221 struct rxpd_buffer
222 {
223   struct rxpd_connection* conn;
224   enum rxpd_buffer_state_e state;
225   char* eol;
226   char* eob;
227   char buffer[4096];
228 };
229
230 struct rxpd_buffer*
231 rxpd_buffer_init (struct rxpd_buffer* self, struct rxpd_connection* conn);
232
233 char*
234 rxpd_buffer_readline (struct rxpd_buffer* self);
235
236 int
237 rxpd_buffer_printf (struct rxpd_buffer* self, const char* fmt, ...);
238
239 inline static enum rxpd_buffer_state_e
240 rxpd_buffer_state (struct rxpd_buffer* self)
241 {
242   return self->state;
243 }
244
245
246 //
247 struct rxpd_connection
248 {
249   int fd;
250   pth_t connecter;
251   struct rxpd_file* file;
252   struct rxpd_socket* socket;
253   char* tmp_str;
254   llist tmp_list;
255
256   struct rxpd_buffer in;
257   struct rxpd_buffer out;
258 };
259
260
261 struct rxpd_connection*
262 rxpd_connection_new (struct rxpd_socket* socket, int fd);
263
264 void
265 rxpd_connection_delete (struct rxpd_connection* self);
266
267 struct rxpd_connection*
268 rxpd_connection_spawn (struct rxpd_connection* self);
269
270 int
271 rxpd_connection_readline (struct rxpd_connection* self);
272
273 int
274 rxpd_connection_check_policy (struct rxpd_connection* self, char* line);
275
276 void*
277 rxpd_connection_parse_cmd (void* ptr);
278
279 /* generate prototypes for each defined command */
280 #define RXPD_CMD(cmd, _) void rxpd_connection_cmd_##cmd (struct rxpd_connection* self);
281 RXPD_COMMANDS
282 #undef RXPD_CMD
283
284
285 #endif