ff81f62cea3da5570e33482fed4d9835bd2374d6
[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
126 //
127 struct rxpd_rule
128 {
129   llist node;
130   char* string;
131   time_t atime;
132   regex_t rx;
133 };
134
135 struct rxpd_rule*
136 rxpd_rule_new (const char* buf);
137
138 void
139 rxpd_rule_delete (struct rxpd_rule*);
140
141
142
143 //
144 struct rxpd_file
145 {
146   psplay node;          // key points to basename part of filename
147   const char* filename; // full filename
148   //TODO later     struct stat last_stat;
149   struct rxpd_base* base;
150   llist rules;
151 };
152
153 struct rxpd_file*
154 rxpd_file_new (struct rxpd_base* base, const char* filename);
155
156 void
157 rxpd_file_delete (struct rxpd_file* file);
158
159 struct rxpd_file*
160 rxpd_file_rules_delete (struct rxpd_file* self);
161
162 int
163 rxpd_file_load (struct rxpd_file* self);
164
165 int
166 rxpd_file_save (struct rxpd_file* self);
167
168 int
169 rxpd_file_cmp (const void* A, const void* B);
170
171
172 //
173
174 struct rxpd_socket
175 {
176   llist node;
177   int fd;
178   struct event ev;
179   struct rxpd_base* base;
180   pth_t accepter;
181   int (*rxpd_socket_addr)(struct rxpd_connection* conn, char* dst, const char* pfx, size_t size);
182 };
183
184
185 struct rxpd_socket*
186 rxpd_socket_new_tcp4 (struct rxpd_base* base, const char* addr, unsigned short port);
187
188 int
189 rxpd_socket_tcp4addr (struct rxpd_connection* conn, char* dst, const char* pfx, size_t size);
190
191 //TODO
192 //struct rxpd_socket*
193 //rxpd_socket_new_unix (struct rxpd_base* base, const char* name);
194
195 void
196 rxpd_socket_delete (struct rxpd_socket* self);
197
198 void *
199 rxpd_socket_accept (void* ptr);
200
201 struct rxpd_socket*
202 rxpd_socket_spawn (struct rxpd_socket* self);
203
204 struct rxpd_socket*
205 rxpd_socket_join (struct rxpd_socket* self);
206
207 struct rxpd_socket*
208 rxpd_socket_cancel (struct rxpd_socket* self);
209
210 //
211
212 enum rxpd_buffer_state_e
213   {
214     RXPD_OK,            // operational
215     RXPD_EOF,           // connection closed
216     RXPD_ERROR          // some other error
217   };
218
219 struct rxpd_buffer
220 {
221   struct rxpd_connection* conn;
222   enum rxpd_buffer_state_e state;
223   char* eol;
224   char* eob;
225   char buffer[4096];
226 };
227
228 struct rxpd_buffer*
229 rxpd_buffer_init (struct rxpd_buffer* self, struct rxpd_connection* conn);
230
231 char*
232 rxpd_buffer_readline (struct rxpd_buffer* self);
233
234 int
235 rxpd_buffer_printf (struct rxpd_buffer* self, const char* fmt, ...);
236
237 inline static enum rxpd_buffer_state_e
238 rxpd_buffer_state (struct rxpd_buffer* self)
239 {
240   return self->state;
241 }
242
243
244 //
245 struct rxpd_connection
246 {
247   int fd;
248   pth_t connecter;
249   struct rxpd_file* file;
250   struct rxpd_socket* socket;
251   char* tmp_str;
252   llist tmp_list;
253
254   struct rxpd_buffer in;
255   struct rxpd_buffer out;
256 };
257
258
259 struct rxpd_connection*
260 rxpd_connection_new (struct rxpd_socket* socket, int fd);
261
262 void
263 rxpd_connection_delete (struct rxpd_connection* self);
264
265 struct rxpd_connection*
266 rxpd_connection_spawn (struct rxpd_connection* self);
267
268 int
269 rxpd_connection_readline (struct rxpd_connection* self);
270
271 int
272 rxpd_connection_check_policy (struct rxpd_connection* self, char* line);
273
274 void*
275 rxpd_connection_parse_cmd (void* ptr);
276
277 /* generate prototypes for each defined command */
278 #define RXPD_CMD(cmd, _) void rxpd_connection_cmd_##cmd (struct rxpd_connection* self);
279 RXPD_COMMANDS
280 #undef RXPD_CMD
281
282
283 #endif