masqmail

view src/masqmail.h @ 366:41958685480d

Switched to `type *name' style Andrew Koenig's ``C Traps and Pitfalls'' (Ch.2.1) convinced me that it is best to go with the way C had been designed. The ``declaration reflects use'' concept conflicts with a ``type* name'' notation. Hence I switched.
author markus schnalke <meillo@marmaro.de>
date Thu, 22 Sep 2011 15:07:40 +0200
parents f4ba4ed28848
children b27f66555ba8
line source
1 /* MasqMail
2 Copyright (C) 1999-2001 Oliver Kurth
3 Copyright (C) 2010 markus schnalke <meillo@marmaro.de>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 */
19 #include <config.h>
21 #include <stdio.h>
22 #include <stdarg.h>
23 #include <errno.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <ctype.h>
27 #include <unistd.h>
28 #include <pwd.h>
29 #include <sys/types.h>
30 #include <sys/socket.h>
31 #include <netinet/in.h>
32 #include <time.h>
33 #include <sys/time.h>
34 #include <netinet/in.h>
35 #include <arpa/inet.h>
36 #include <netdb.h>
37 #include <syslog.h>
38 #include <signal.h>
39 #include <fcntl.h>
41 #include <glib.h>
43 #ifdef ENABLE_IDENT
44 #include "libident/ident.h"
45 #endif
47 #include "lookup.h"
49 typedef struct _interface {
50 gchar *address;
51 gint port;
52 } interface;
54 #define ADDR_FLAG_DELIVERED 0x01
55 #define ADDR_FLAG_DEFERED 0x02
56 #define ADDR_FLAG_FAILED 0x04
57 #define ADDR_FLAG_LAST_ROUTE 0x40
59 typedef struct _address {
60 gchar *address;
61 gchar *local_part;
62 gchar *domain;
63 gint flags;
64 GList *children;
65 struct _address *parent;
66 } address;
68 #define addr_mark_delivered(addr) { addr->flags |= ADDR_FLAG_DELIVERED; }
69 #define addr_unmark_delivered(addr) { addr->flags &= ~ADDR_FLAG_DELIVERED; }
70 #define addr_is_delivered(addr) ((addr->flags & ADDR_FLAG_DELIVERED) != 0 )
72 #define addr_mark_defered(addr) { addr->flags |= ADDR_FLAG_DEFERED; }
73 #define addr_unmark_defered(addr) { addr->flags &= ~ADDR_FLAG_DEFERED; }
74 #define addr_is_defered(addr) ((addr->flags & ADDR_FLAG_DEFERED) != 0 )
76 #define addr_mark_failed(addr) { addr->flags |= ADDR_FLAG_FAILED; }
77 #define addr_unmark_failed(addr) { addr->flags &= ~ADDR_FLAG_FAILED; }
78 #define addr_is_failed(addr) ((addr->flags & ADDR_FLAG_FAILED) != 0 )
80 typedef struct _connect_route {
81 gchar *name;
82 gchar *filename;
84 gboolean is_perma;
85 gboolean last_route;
87 GList *allowed_senders;
88 GList *denied_senders;
89 GList *allowed_recipients;
90 GList *denied_recipients;
92 interface *mail_host;
93 gboolean connect_error_fail;
94 GList *resolve_list;
95 gchar *helo_name;
96 gboolean do_correct_helo;
97 gboolean instant_helo;
98 gboolean do_pipelining;
99 gchar *auth_name;
100 gchar *auth_login;
101 gchar *auth_secret;
102 gchar *wrapper;
104 gchar *set_h_from_domain;
105 gchar *set_h_reply_to_domain;
106 gchar *set_return_path_domain;
107 GList *map_h_from_addresses;
108 GList *map_h_reply_to_addresses;
109 GList *map_h_mail_followup_to_addresses;
110 GList *map_return_path_addresses;
111 gboolean expand_h_sender_domain;
112 gboolean expand_h_sender_address;
114 gchar *pipe;
115 gboolean pipe_fromline;
116 gboolean pipe_fromhack;
117 } connect_route;
119 typedef struct _masqmail_conf {
120 gint mail_uid;
121 gint mail_gid;
123 gint orig_uid;
124 gint orig_gid;
126 gboolean run_as_user;
128 gchar *mail_dir;
129 gchar *lock_dir;
130 gchar *spool_dir;
131 gchar *log_dir;
133 gint debug_level;
134 gboolean use_syslog;
135 guint log_max_pri;
137 gchar *host_name;
138 GList *local_hosts;
139 GList *local_addresses;
140 GList *not_local_addresses;
141 GList *listen_addresses;
143 /* ANSI C defines unsigned long to be at least 32bit
144 i.e. ca. 4GB max; that should be enough. */
145 gulong max_msg_size;
147 gboolean do_save_envelope_to;
149 gboolean defer_all;
150 gboolean do_relay;
152 GList *ident_trusted_nets;
154 gboolean do_queue;
156 gboolean do_verbose;
158 gchar *mbox_default;
159 GList *mbox_users;
160 GList *mda_users;
162 gchar *mda;
163 gboolean mda_fromline;
164 gboolean mda_fromhack;
166 gboolean pipe_fromline;
167 gboolean pipe_fromhack;
169 gchar *alias_file;
170 int (*localpartcmp) (const char *, const char *);
172 GList *perma_routes;
173 GList *query_routes; /* list of pairs which point to lists */
175 gchar *online_query;
177 gchar *errmsg_file;
178 gchar *warnmsg_file;
179 GList *warn_intervals;
180 gint max_defer_time;
182 gchar *log_user;
183 } masqmail_conf;
185 extern masqmail_conf conf;
187 typedef struct _table_pair {
188 gchar *key;
189 gpointer *value;
190 } table_pair;
193 /* must match the contents of prot_names[] in accept.c */
194 typedef enum _prot_id {
195 PROT_LOCAL = 0,
196 PROT_SMTP,
197 PROT_ESMTP,
198 PROT_NUM
199 } prot_id;
201 extern gchar *prot_names[];
203 typedef enum _header_id {
204 HEAD_FROM = 0,
205 HEAD_SENDER,
206 HEAD_TO,
207 HEAD_CC,
208 HEAD_BCC,
209 HEAD_DATE,
210 HEAD_MESSAGE_ID,
211 HEAD_REPLY_TO,
212 HEAD_SUBJECT,
213 HEAD_RETURN_PATH,
214 HEAD_ENVELOPE_TO,
215 HEAD_RECEIVED,
216 HEAD_NUM_IDS,
217 HEAD_STATUS,
218 HEAD_UNKNOWN = HEAD_NUM_IDS,
219 HEAD_NONE = -1,
220 } header_id;
222 typedef struct _header_name {
223 gchar *header;
224 header_id id;
225 } header_name;
227 typedef struct _header {
228 header_id id;
229 gchar *header;
230 gchar *value;
231 } header;
234 typedef struct _message {
235 gchar *uid;
237 gchar *received_host;
238 prot_id received_prot;
239 gchar *ident;
240 gint transfer_id; /* for multiple messages per transfer */
242 address *return_path;
243 GList *rcpt_list;
244 GList *non_rcpt_list;
246 GList *hdr_list;
247 GList *data_list;
249 gint data_size;
250 time_t received_time;
251 time_t warned_time;
253 gchar *full_sender_name;
254 } message;
256 typedef struct _msg_out {
257 message *msg;
259 address *return_path;
260 GList *rcpt_list;
262 GList *hdr_list;
263 GList *xtra_hdr_list; /* rewritten headers */
264 } msg_out;
266 typedef struct _msgout_perhost {
267 gchar *host;
268 GList *msgout_list;
269 } msgout_perhost;
271 /* flags for accept() */
272 #define ACC_RCPT_FROM_HEAD 0x08 /* -t option, get rcpts from headers */
273 #define ACC_DOT_IGNORE 0x10 /* a dot on a line itself does not end the message (-oi option) */
274 #define ACC_MAIL_FROM_HEAD 0x40 /* get return path from header */
275 #define ACC_NODOT_RELAX 0x80 /* do not be picky if message ist not terminated by a dot on a line */
276 #define ACC_SAVE_ENVELOPE_TO 0x0100 /* save an existent Envelope-to header as X-Orig-Envelope-to */
278 #define DLVR_LOCAL 0x01
279 #define DLVR_ONLINE 0x02
280 #define DLVR_ALL (DLVR_LOCAL|DLVR_ONLINE)
282 /* transport flags */
283 #define MSGSTR_FROMLINE 0x01
284 #define MSGSTR_FROMHACK 0x02
286 typedef enum _accept_error {
287 AERR_OK = 0,
288 AERR_TIMEOUT,
289 AERR_EOF,
290 AERR_OVERFLOW,
291 AERR_SYNTAX,
292 AERR_NOSPOOL,
293 AERR_NORCPT,
294 AERR_SIZE, /* max msg size exeeded (SMTP SIZE) */
295 AERR_UNKNOWN
296 } accept_error;
298 #define BUF_LEN 1024
299 #define MAX_ADDRESS 256
300 #define MAX_DATALINE 4096
302 typedef enum _smtp_cmd_id {
303 SMTP_HELO = 0,
304 SMTP_EHLO,
305 SMTP_MAIL_FROM,
306 SMTP_RCPT_TO,
307 SMTP_DATA,
308 SMTP_QUIT,
309 SMTP_RSET,
310 SMTP_NOOP,
311 SMTP_HELP,
312 SMTP_NUM_IDS,
313 SMTP_EOF = -1,
314 SMTP_ERROR = -2,
315 } smtp_cmd_id;
317 typedef struct _smtp_cmd {
318 smtp_cmd_id id;
319 gchar *cmd;
320 } smtp_cmd;
322 typedef struct _smtp_connection {
323 gchar *remote_host;
325 prot_id prot;
326 gint next_id;
328 gboolean helo_seen;
329 gboolean from_seen;
330 gboolean rcpt_seen;
332 message *msg;
333 } smtp_connection;
335 /* alias.c*/
336 gboolean addr_is_local(address *addr);
337 GList *alias_expand(GList *alias_table, GList *rcpt_list, GList *non_rcpt_list);
339 /* child.c */
340 int child(const char *command);
342 /* conf.c */
343 void init_conf();
344 gboolean read_conf(gchar *filename);
345 connect_route *read_route(gchar *filename, gboolean is_perma);
346 GList *read_route_list(GList *rf_list, gboolean is_perma);
347 void destroy_route(connect_route *r);
348 void destroy_route_list(GList *list);
350 /* expand.c */
351 GList *var_table_rcpt(GList *var_table, address *rcpt);
352 GList *var_table_msg(GList *var_table, message *msg);
353 GList *var_table_conf(GList *var_table);
354 gint expand(GList *var_list, gchar *format, gchar *result, gint result_len);
356 /* message.c */
357 message *create_message(void);
358 void destroy_message(message *msg);
359 void destroy_msg_list(GList *msg_list);
360 void msg_free_data(message *msg);
361 gint msg_calc_size(message *msg, gboolean is_smtp);
363 msg_out *create_msg_out(message *msg);
364 msg_out *clone_msg_out(msg_out *msgout_orig);
365 void destroy_msg_out(msg_out *msgout);
366 void destroy_msg_out_list(GList *msgout_list);
368 /* address.c */
369 address *create_address(gchar *path, gboolean is_rfc821);
370 address *create_address_qualified(gchar *path, gboolean is_rfc821, gchar *domain);
371 address *create_address_pipe(gchar *path);
372 void destroy_address(address *addr);
373 address *copy_modify_address(const address *orig, gchar *l_part, gchar *dom);
374 #define copy_address(addr) copy_modify_address(addr, NULL, NULL)
375 gboolean addr_isequal(address *addr1, address *addr2, int (*cmpfunc) (const char*, const char*));
376 gboolean addr_isequal_parent(address *addr1, address *addr2, int (*cmpfunc) (const char*, const char*));
377 address *addr_find_ancestor(address *addr);
378 gboolean addr_is_delivered_children(address *addr);
379 gboolean addr_is_finished_children(address *addr);
380 gchar *addr_string(address *addr);
382 /* accept.c */
383 accept_error accept_message(FILE *in, message *msg, guint flags);
384 accept_error accept_message_prepare(message *msg, guint flags);
386 /* header.c */
387 gchar *rec_timestamp();
388 GList *find_header(GList *hdr_list, header_id id, gchar *hdr_str);
389 void header_unfold(header *hdr);
390 void header_fold(header *hdr, unsigned int maxlen);
391 header *create_header(header_id id, gchar *fmt, ...);
392 void destroy_header(header *hdr);
393 header *copy_header(header *hdr);
394 header *get_header(gchar *line);
396 /* smtp_in.c */
397 void smtp_in(FILE *in, FILE *out, gchar *remote_host, gchar *ident);
399 /* listen.c */
400 void listen_port(GList *addr_list, gint qival, char *argv[]);
402 /* parse.c */
403 gboolean split_address(const gchar *path, gchar **local_part, gchar **domain, gboolean is_rfc821);
404 gboolean parse_address_rfc822(gchar *string, gchar **local_begin, gchar **local_end, gchar **domain_begin, gchar **domain_end, gchar **address_end);
405 gboolean parse_address_rfc821(gchar *string, gchar **local_begin, gchar **local_end, gchar **domain_begin, gchar **domain_end, gchar **address_end);
406 address *_create_address(gchar *string, gchar **end, gboolean is_rfc821);
407 address *create_address_rfc821(gchar *string, gchar **end);
408 address *create_address_rfc822(gchar *string, gchar **end);
409 GList *addr_list_append_rfc822(GList *addr_list, gchar *string, gchar *domain);
411 /* connect.c */
412 mxip_addr *connect_hostlist(int *psockfd, gchar *host, guint port, GList *addr_list);
413 mxip_addr *connect_resolvelist(int *psockfd, gchar *host, guint port, GList *res_funcs);
415 /* deliver.c */
416 void msg_rcptlist_local(GList *rcpt_list, GList **, GList **);
417 gboolean deliver_local(msg_out *msgout);
418 gboolean deliver_msglist_host(connect_route *route, GList *msg_list, gchar *host, GList *res_list);
419 gboolean deliver_route_msgout_list(connect_route *route, GList *msgout_list);
420 gboolean deliver_route_msg_list(connect_route *route, GList *msgout_list);
421 gboolean deliver_finish(msg_out *msgout);
422 gboolean deliver_msg_list(GList *msg_list, guint flags);
423 gboolean deliver(message *msg);
425 /* fail_msg.c */
426 gboolean fail_msg(message *msg, gchar *template, GList *failed_rcpts, gchar *err_fmt, va_list args);
427 gboolean warn_msg(message *msg, gchar *template, GList *failed_rcpts, gchar *err_fmt, va_list args);
429 /* interface.c */
430 gboolean init_sockaddr(struct sockaddr_in *name, interface *iface);
431 int make_server_socket(interface *iface);
433 /* local.c */
434 gboolean append_file(message *msg, GList *hdr_list, gchar *user);
435 gboolean pipe_out(message *msg, GList *hdr_list, address *rcpt, gchar *cmd, guint flags);
437 /* log.c */
438 gchar *ext_strerror(int err);
439 gboolean logopen(void);
440 void logclose(void);
441 void vlogwrite(int pri, const char *fmt, va_list args);
442 void logwrite(int pri, const char *fmt, ...);
443 void debugf(const char *fmt, ...);
444 void vdebugf(const char *fmt, va_list args);
445 void maillog(const char *fmt, ...);
447 /* spool.c */
448 gboolean spool_read_data(message *msg);
449 message *msg_spool_read(gchar *uid);
450 gboolean spool_write(message *msg, gboolean do_writedata);
451 gboolean spool_lock(gchar *uid);
452 gboolean spool_unlock(gchar *uid);
453 gboolean spool_delete_all(message *msg);
455 /* queue.c */
456 GList *read_queue(void);
457 gboolean queue_run(void);
458 gboolean queue_run_online(void);
459 void queue_list(void);
460 gboolean queue_delete(gchar *uid);
462 /* online.c */
463 gchar *online_query();
465 /* permissions.c */
466 gboolean is_ingroup(uid_t uid, gid_t gid);
467 void set_euidgid(gint uid, gint gid, uid_t *old_uid, gid_t *old_gid);
468 void set_identity(uid_t old_uid, gchar *task_name);
470 /* rewrite.c */
471 gboolean set_address_header_domain(header *hdr, gchar *domain);
472 gboolean map_address_header(header *hdr, GList *table);
474 /* route.c */
475 msgout_perhost *create_msgout_perhost(gchar *host);
476 void destroy_msgout_perhost(msgout_perhost *mo_ph);
477 void rewrite_headers(msg_out *msgout, connect_route *route);
478 void split_rcpts(GList *rcpt_list, GList *localnets, GList **rl_local, GList **rl_localnet, GList **rl_others);
479 GList *local_rcpts(GList *rcpt_list);
480 GList *remote_rcpts(GList *rcpt_list);
481 gboolean route_strip_msgout(connect_route *route, msg_out *msgout);
482 msg_out *route_prepare_msgout(connect_route *route, msg_out *msgout);
483 GList *route_msgout_list(connect_route *route, GList *msgout_list);
484 gboolean route_sender_is_allowed(connect_route *route, address *ret_path);
485 void route_split_rcpts(connect_route *route, GList *rcpt_list, GList **p_rcpt_list, GList **p_non_rcpt_list);
487 /* tables.c */
488 table_pair *create_pair(gchar *key, gpointer value);
489 table_pair *create_pair_string(gchar *key, gpointer value);
490 table_pair *parse_table_pair(gchar *line, char delim);
491 gpointer *table_find_func(GList *table_list, gchar *key, int (*cmp_func) (const char *, const char *));
492 gpointer *table_find(GList *table_list, gchar *key);
493 gpointer *table_find_case(GList *table_list, gchar *key);
494 gpointer *table_find_fnmatch(GList *table_list, gchar *key);
495 GList *table_read(gchar *fname, gchar delim);
496 void destroy_table(GList *table);
498 /* timeival.c */
499 gint time_interval(gchar *str);
501 /* permissions.c */
502 gboolean is_privileged_user(uid_t uid);
504 /* other things */
506 #define foreach(list, node)\
507 for((node) = g_list_first(list);\
508 (node);\
509 (node) = g_list_next(node))
511 #ifdef ENABLE_DEBUG
512 #define DEBUG(level) if(level <= conf.debug_level)
513 #else
514 /* hopefully the compiler optmizes this away... */
515 #define DEBUG(level) if(0)
516 #endif
518 #define LOG_VERBOSE 0x100
520 #ifndef HAVE_GETLINE
521 #define getline(buf, size, file) getdelim(buf, size, '\n', file)
522 #endif
524 #ifndef HAVE_FDATASYNC
525 #define fdatasync(fd) fsync(fd)
526 #endif
528 #ifndef CONF_DIR
529 #define CONF_DIR "/etc/masqmail"
530 #endif
532 #define CONF_FILE CONF_DIR"/masqmail.conf"
534 #define PIDFILEDIR "/var/run/masqmail/"
536 #ifndef va_copy
537 #ifdef __va_copy
538 #define va_copy(ap1, ap2) __va_copy(ap1, ap2)
539 #else
540 #define va_copy(ap1, ap2) G_VA_COPY(ap1, ap2)
541 #endif
542 #endif
544 /* *BSD needs this: */
545 extern char **environ;