1 /******************************************************************************/
2 /* pfixtools: a collection of postfix related tools */
4 /* ________________________________________________________________________ */
6 /* Redistribution and use in source and binary forms, with or without */
7 /* modification, are permitted provided that the following conditions */
10 /* 1. Redistributions of source code must retain the above copyright */
11 /* notice, this list of conditions and the following disclaimer. */
12 /* 2. Redistributions in binary form must reproduce the above copyright */
13 /* notice, this list of conditions and the following disclaimer in the */
14 /* documentation and/or other materials provided with the distribution. */
15 /* 3. The names of its contributors may not be used to endorse or promote */
16 /* products derived from this software without specific prior written */
19 /* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND */
20 /* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE */
21 /* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR */
22 /* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS */
23 /* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR */
24 /* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF */
25 /* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS */
26 /* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN */
27 /* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) */
28 /* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF */
29 /* THE POSSIBILITY OF SUCH DAMAGE. */
30 /******************************************************************************/
33 * Copyright © 2006-2007 Pierre Habouzit
34 * Copyright © 2008 Florent Bruneau
41 #include "policy_tokens.h"
46 #define DAEMON_NAME "postlicyd"
47 #define DAEMON_VERSION "0.5"
48 #define DEFAULT_PORT 10000
49 #define RUNAS_USER "nobody"
50 #define RUNAS_GROUP "nogroup"
54 typedef struct query_context_t {
56 filter_context_t context;
60 static config_t *config = NULL;
61 static bool refresh = false;
62 static PA(client_t) busy = ARRAY_INIT;
64 static void *query_starter(listener_t* server)
66 query_context_t *context = p_new(query_context_t, 1);
67 filter_context_prepare(&context->context, context);
71 static void query_stopper(void *data)
73 query_context_t **context = data;
75 filter_context_wipe(&(*context)->context);
80 static bool config_refresh(void *mconfig)
83 if (filter_running > 0) {
86 log_state = "refreshing ";
87 info("reloading configuration");
88 bool ret = config_reload(mconfig);
90 foreach (client_t **server, busy) {
91 client_io_ro(*server);
98 static void policy_answer(client_t *pcy, const char *message)
100 query_context_t *context = client_data(pcy);
101 const query_t* query = &context->query;
102 buffer_t *buf = client_output_buffer(pcy);
104 /* Write reply "action=ACTION [text]" */
105 buffer_addstr(buf, "action=");
106 if (!query_format_buffer(buf, message, query)) {
107 buffer_addstr(buf, message);
109 buffer_addstr(buf, "\n\n");
111 /* Finalize query. */
112 buf = client_input_buffer(pcy);
113 buffer_consume(buf, query->eoq - buf->data);
117 static const filter_t *next_filter(client_t *pcy, const filter_t *filter,
118 const query_t *query, const filter_hook_t *hook, bool *ok) {
119 char log_prefix[BUFSIZ];
120 log_prefix[0] = '\0';
122 #define log_reply(Level, Msg, ...) \
123 if (log_level >= LOG_ ## Level) { \
124 if (log_prefix[0] == '\0') { \
125 query_format(log_prefix, BUFSIZ, \
126 config->log_format && config->log_format[0] ? \
127 config->log_format : DEFAULT_LOG_FORMAT, query); \
129 __log(LOG_ ## Level, "%s: " Msg, log_prefix, ##__VA_ARGS__); \
133 query_context_t *context = client_data(pcy);
134 if (hook->counter >= 0 && hook->counter < MAX_COUNTERS && hook->cost > 0) {
135 context->context.counters[hook->counter] += hook->cost;
136 log_reply(DEBUG, "added %d to counter %d (now %u)",
137 hook->cost, hook->counter,
138 context->context.counters[hook->counter]);
142 log_reply(WARNING, "aborted");
145 } else if (hook->async) {
146 log_reply(WARNING, "asynchronous filter from filter %s", filter->name);
149 } else if (hook->postfix) {
150 log_reply(INFO, "awswer %s from filter %s: \"%s\"",
151 htokens[hook->type], filter->name, hook->value);
152 policy_answer(pcy, hook->value);
156 log_reply(DEBUG, "awswer %s from filter %s: next filter %s",
157 htokens[hook->type], filter->name,
158 (array_ptr(config->filters, hook->filter_id))->name);
159 return array_ptr(config->filters, hook->filter_id);
164 static bool policy_process(client_t *pcy, const config_t *mconfig)
166 query_context_t *context = client_data(pcy);
167 const query_t* query = &context->query;
168 const filter_t *filter;
169 if (mconfig->entry_points[query->state] == -1) {
170 warn("no filter defined for current protocol_state (%s)", smtp_state_names[query->state].str);
173 if (context->context.current_filter != NULL) {
174 filter = context->context.current_filter;
176 filter = array_ptr(mconfig->filters, mconfig->entry_points[query->state]);
178 context->context.current_filter = NULL;
181 const filter_hook_t *hook = filter_run(filter, query, &context->context);
182 filter = next_filter(pcy, filter, query, hook, &ok);
183 if (filter == NULL) {
189 static int policy_run(client_t *pcy, void* vconfig)
191 const config_t *mconfig = vconfig;
193 array_add(busy, pcy);
197 query_context_t *context = client_data(pcy);
198 query_t *query = &context->query;
199 context->client = pcy;
201 buffer_t *buf = client_input_buffer(pcy);
202 int search_offs = MAX(0, (int)(buf->len - 1));
203 int nb = client_read(pcy);
207 if (errno == EAGAIN || errno == EINTR)
214 err("unexpected end of data");
218 if (!(eoq = strstr(buf->data + search_offs, "\n\n"))) {
222 if (!query_parse(query, buf->data)) {
225 query->eoq = eoq + strlen("\n\n");
227 /* The instance changed => reset the static context */
228 if (query->instance.str == NULL || query->instance.len == 0
229 || strcmp(context->context.instance, query->instance.str) != 0) {
230 filter_context_clean(&context->context);
231 m_strcat(context->context.instance, 64, query->instance.str);
234 return policy_process(pcy, mconfig) ? 0 : -1;
237 static void policy_async_handler(filter_context_t *context,
238 const filter_hook_t *hook)
241 const filter_t *filter = context->current_filter;
242 query_context_t *qctx = context->data;
243 query_t *query = &qctx->query;
244 client_t *server = qctx->client;
246 context->current_filter = next_filter(server, filter, query, hook, &ok);
247 if (context->current_filter != NULL) {
248 ok = policy_process(server, config);
251 client_release(server);
253 if (refresh && filter_running == 0) {
254 config_refresh(config);
258 static int postlicyd_init(void)
260 filter_async_handler_register(policy_async_handler);
264 static void postlicyd_shutdown(void)
266 array_deep_wipe(busy, client_delete);
268 module_init(postlicyd_init);
269 module_exit(postlicyd_shutdown);
271 /* administrivia {{{ */
275 fputs("usage: "DAEMON_NAME" [options] config\n"
278 " -l <port> port to listen to\n"
279 " -p <pidfile> file to write our pid to\n"
280 " -f stay in foreground\n"
281 " -d grow logging level\n"
282 " -u unsafe mode (don't drop privileges)\n"
289 int main(int argc, char *argv[])
292 const char *pidfile = NULL;
293 bool daemonize = true;
294 int port = DEFAULT_PORT;
295 bool port_from_cli = false;
296 bool check_conf = false;
298 for (int c = 0; (c = getopt(argc, argv, "ufdc" "l:p:")) >= 0; ) {
308 port_from_cli = true;
331 if (argc - optind != 1) {
337 return config_check(argv[optind]) ? EXIT_SUCCESS : EXIT_FAILURE;
339 info("%s v%s...", DAEMON_NAME, DAEMON_VERSION);
341 if (pidfile_open(pidfile) < 0) {
342 crit("unable to write pidfile %s", pidfile);
346 if (drop_privileges(RUNAS_USER, RUNAS_GROUP) < 0) {
347 crit("unable to drop privileges");
351 config = config_read(argv[optind]);
352 if (config == NULL) {
355 if (port_from_cli || config->port == 0) {
359 if (daemonize && daemon_detach() < 0) {
360 crit("unable to fork");
366 if (start_listener(config->port) == NULL) {
369 return server_loop(query_starter, query_stopper,
370 policy_run, config_refresh, config);