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.4"
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 buffer_ensure(buf, m_strlen(message) + 64);
108 ssize_t size = array_size(*buf) - array_len(*buf);
109 ssize_t format_size = query_format(array_ptr(*buf, array_len(*buf)),
110 size, message, query);
111 if (format_size == -1) {
112 buffer_addstr(buf, message);
113 } else if (format_size > size) {
114 buffer_ensure(buf, format_size + 1);
115 query_format(array_ptr(*buf, array_len(*buf)),
116 array_size(*buf) - array_len(*buf),
118 array_len(*buf) += format_size;
120 array_len(*buf) += format_size;
122 buffer_addstr(buf, "\n\n");
124 /* Finalize query. */
125 buf = client_input_buffer(pcy);
126 buffer_consume(buf, query->eoq - buf->data);
130 static const filter_t *next_filter(client_t *pcy, const filter_t *filter,
131 const query_t *query, const filter_hook_t *hook, bool *ok) {
132 #define MESSAGE_FORMAT "request client=%s from=<%s> to=<%s> at %s: "
133 #define MESSAGE_PARAMS query->client_name, \
134 query->sender == NULL ? "undefined" : query->sender, \
135 query->recipient == NULL ? "undefined" : query->recipient, \
136 smtp_state_names[query->state]
139 query_context_t *context = client_data(pcy);
140 if (hook->counter >= 0 && hook->counter < MAX_COUNTERS && hook->cost > 0) {
141 context->context.counters[hook->counter] += hook->cost;
142 debug(MESSAGE_FORMAT "added %d to counter %d (now %u)", MESSAGE_PARAMS,
143 hook->cost, hook->counter, context->context.counters[hook->counter]);
147 warn(MESSAGE_FORMAT "aborted", MESSAGE_PARAMS);
150 } else if (hook->async) {
151 debug(MESSAGE_FORMAT "asynchronous filter from filter %s",
152 MESSAGE_PARAMS, filter->name);
155 } else if (hook->postfix) {
156 info(MESSAGE_FORMAT "awswer %s from filter %s: \"%s\"", MESSAGE_PARAMS,
157 htokens[hook->type], filter->name, hook->value);
158 policy_answer(pcy, hook->value);
162 debug(MESSAGE_FORMAT "awswer %s from filter %s: next filter %s",
163 MESSAGE_PARAMS, htokens[hook->type], filter->name,
164 (array_ptr(config->filters, hook->filter_id))->name);
165 return array_ptr(config->filters, hook->filter_id);
167 #undef MESSAGE_PARAMS
168 #undef MESSAGE_FORMAT
171 static bool policy_process(client_t *pcy, const config_t *mconfig)
173 query_context_t *context = client_data(pcy);
174 const query_t* query = &context->query;
175 const filter_t *filter;
176 if (mconfig->entry_points[query->state] == -1) {
177 warn("no filter defined for current protocol_state (%s)", smtp_state_names[query->state]);
180 if (context->context.current_filter != NULL) {
181 filter = context->context.current_filter;
183 filter = array_ptr(mconfig->filters, mconfig->entry_points[query->state]);
185 context->context.current_filter = NULL;
188 const filter_hook_t *hook = filter_run(filter, query, &context->context);
189 filter = next_filter(pcy, filter, query, hook, &ok);
190 if (filter == NULL) {
196 static int policy_run(client_t *pcy, void* vconfig)
198 const config_t *mconfig = vconfig;
200 array_add(busy, pcy);
204 query_context_t *context = client_data(pcy);
205 query_t *query = &context->query;
206 context->client = pcy;
208 buffer_t *buf = client_input_buffer(pcy);
209 int search_offs = MAX(0, (int)(buf->len - 1));
210 int nb = client_read(pcy);
214 if (errno == EAGAIN || errno == EINTR)
221 err("unexpected end of data");
225 if (!(eoq = strstr(buf->data + search_offs, "\n\n"))) {
229 if (!query_parse(query, buf->data)) {
232 query->eoq = eoq + strlen("\n\n");
234 /* The instance changed => reset the static context */
235 if (query->instance == NULL || strcmp(context->context.instance, query->instance) != 0) {
236 filter_context_clean(&context->context);
237 m_strcat(context->context.instance, 64, query->instance);
240 return policy_process(pcy, mconfig) ? 0 : -1;
243 static void policy_async_handler(filter_context_t *context,
244 const filter_hook_t *hook)
247 const filter_t *filter = context->current_filter;
248 query_context_t *qctx = context->data;
249 query_t *query = &qctx->query;
250 client_t *server = qctx->client;
252 context->current_filter = next_filter(server, filter, query, hook, &ok);
253 if (context->current_filter != NULL) {
254 ok = policy_process(server, config);
257 client_release(server);
259 if (refresh && filter_running == 0) {
260 config_refresh(config);
264 static int postlicyd_init(void)
266 filter_async_handler_register(policy_async_handler);
270 static void postlicyd_shutdown(void)
272 array_deep_wipe(busy, client_delete);
274 module_init(postlicyd_init);
275 module_exit(postlicyd_shutdown);
277 /* administrivia {{{ */
281 fputs("usage: "DAEMON_NAME" [options] config\n"
284 " -l <port> port to listen to\n"
285 " -p <pidfile> file to write our pid to\n"
286 " -f stay in foreground\n"
287 " -d grow logging level\n"
288 " -u unsafe mode (don't drop privileges)\n"
295 int main(int argc, char *argv[])
298 const char *pidfile = NULL;
299 bool daemonize = true;
300 int port = DEFAULT_PORT;
301 bool port_from_cli = false;
302 bool check_conf = false;
304 for (int c = 0; (c = getopt(argc, argv, "ufdc" "l:p:")) >= 0; ) {
314 port_from_cli = true;
337 if (argc - optind != 1) {
343 return config_check(argv[optind]) ? EXIT_SUCCESS : EXIT_FAILURE;
345 info("%s v%s...", DAEMON_NAME, DAEMON_VERSION);
347 if (pidfile_open(pidfile) < 0) {
348 crit("unable to write pidfile %s", pidfile);
352 if (drop_privileges(RUNAS_USER, RUNAS_GROUP) < 0) {
353 crit("unable to drop privileges");
357 config = config_read(argv[optind]);
358 if (config == NULL) {
361 if (port_from_cli || config->port == 0) {
365 if (daemonize && daemon_detach() < 0) {
366 crit("unable to fork");
372 if (start_listener(config->port) == NULL) {
375 return server_loop(query_starter, query_stopper,
376 policy_run, config_refresh, config);