masqmail
view src/masqmail.h @ 179:3190e6864452
added comments to deliver.c (stuff to check)
| author | meillo@marmaro.de |
|---|---|
| date | Wed, 14 Jul 2010 17:02:08 +0200 |
| parents | 5b621742b2e7 |
| children | dc89737b27aa |
line source
1 /* MasqMail
2 Copyright (C) 1999-2001 Oliver Kurth
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 */
18 #include <config.h>
20 #include <stdio.h>
21 #include <stdarg.h>
22 #include <errno.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <ctype.h>
26 #include <unistd.h>
27 #include <pwd.h>
28 #include <sys/types.h>
29 #include <sys/socket.h>
30 #include <netinet/in.h>
31 #include <time.h>
32 #include <sys/time.h>
33 #include <netinet/in.h>
34 #include <arpa/inet.h>
35 #include <netdb.h>
36 #include <syslog.h>
37 #include <signal.h>
38 #include <fcntl.h>
40 #include <glib.h>
42 #ifdef ENABLE_IDENT
43 #include "libident/ident.h"
44 #endif
46 #include "lookup.h"
48 typedef struct _interface {
49 gchar *address;
50 gint port;
51 } interface;
53 #define ADDR_FLAG_DELIVERED 0x01
54 #define ADDR_FLAG_DEFERED 0x02
55 #define ADDR_FLAG_FAILED 0x04
56 #define ADDR_FLAG_LAST_ROUTE 0x40
57 #define ADDR_FLAG_NOEXPAND 0x80
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 gchar *protocol;
86 gboolean is_local_net;
87 gboolean last_route;
89 GList *allowed_return_paths;
90 GList *not_allowed_return_paths;
91 GList *allowed_mail_locals;
92 GList *not_allowed_mail_locals;
93 GList *allowed_rcpt_domains;
94 GList *not_allowed_rcpt_domains;
96 interface *mail_host;
97 gchar *wrapper;
98 gboolean connect_error_fail;
100 gchar *helo_name;
101 gboolean do_correct_helo;
102 gboolean do_pipelining;
104 gchar *set_h_from_domain;
105 gchar *set_h_reply_to_domain;
106 gchar *set_return_path_domain;
108 GList *map_h_from_addresses;
109 GList *map_h_reply_to_addresses;
110 GList *map_h_mail_followup_to_addresses;
111 GList *map_return_path_addresses;
113 gboolean expand_h_sender_domain;
114 gboolean expand_h_sender_address;
116 GList *resolve_list;
118 gchar *auth_name;
119 gchar *auth_login;
120 gchar *auth_secret;
122 gchar *pop3_login;
124 gchar *pipe;
126 gboolean pipe_fromline;
127 gboolean pipe_fromhack;
128 } connect_route;
130 typedef struct _get_conf {
131 gchar *protocol;
132 gchar *server_name;
133 guint server_port;
134 gchar *wrapper;
135 gchar *login_user;
136 gchar *login_pass;
137 address *address;
138 address *return_path;
139 gboolean do_keep;
140 gboolean do_uidl;
141 gboolean do_uidl_dele;
142 gint max_size;
143 gboolean max_size_delete;
144 gint max_count;
146 GList *resolve_list;
148 } get_conf;
150 typedef struct _masqmail_conf {
151 gint mail_uid;
152 gint mail_gid;
154 gint orig_uid;
155 gint orig_gid;
157 gboolean run_as_user;
159 gchar *mail_dir;
160 gchar *lock_dir;
161 gchar *spool_dir;
162 gchar *log_dir;
164 gint debug_level;
165 gboolean use_syslog;
166 guint log_max_pri;
168 gchar *host_name;
169 GList *local_hosts;
170 GList *local_addresses;
171 GList *not_local_addresses;
172 GList *local_nets;
173 GList *listen_addresses;
175 /* ANSI C defines unsigned long to be at least 32bit
176 i.e. ca. 4GB max; that should be enough. */
177 gulong max_msg_size;
179 gboolean do_save_envelope_to;
181 gboolean defer_all;
182 gboolean do_relay;
184 GList *ident_trusted_nets;
186 gboolean do_queue;
188 gboolean do_verbose;
190 gchar *mbox_default;
191 GList *mbox_users;
192 GList *mda_users;
193 GList *maildir_users;
195 gchar *mda;
196 gboolean mda_fromline;
197 gboolean mda_fromhack;
199 gboolean pipe_fromline;
200 gboolean pipe_fromhack;
202 gchar *alias_file;
203 int (*alias_local_cmp) (const char *, const char *);
205 GList *local_net_routes;
206 GList *connect_routes; /* list of pairs which point to lists */
208 gchar *online_detect;
209 gchar *online_file;
210 gchar *online_pipe;
212 GList *get_names;
213 GList *online_gets; /* list of pairs which point to lists */
215 gchar *errmsg_file;
216 gchar *warnmsg_file;
217 GList *warn_intervals;
218 gint max_defer_time;
220 gchar *log_user;
221 } masqmail_conf;
223 extern masqmail_conf conf;
225 typedef struct _table_pair {
226 gchar *key;
227 gpointer *value;
228 } table_pair;
231 typedef enum _prot_id {
232 PROT_LOCAL = 0,
233 PROT_BSMTP,
234 PROT_SMTP,
235 PROT_ESMTP,
236 PROT_POP3,
237 PROT_APOP,
238 PROT_NUM
239 } prot_id;
241 extern gchar *prot_names[];
243 typedef enum _header_id {
244 HEAD_FROM = 0,
245 HEAD_SENDER,
246 HEAD_TO,
247 HEAD_CC,
248 HEAD_BCC,
249 HEAD_DATE,
250 HEAD_MESSAGE_ID,
251 HEAD_REPLY_TO,
252 HEAD_SUBJECT,
253 HEAD_RETURN_PATH,
254 HEAD_ENVELOPE_TO,
255 HEAD_RECEIVED,
256 HEAD_NUM_IDS,
257 HEAD_STATUS,
258 HEAD_UNKNOWN = HEAD_NUM_IDS,
259 HEAD_NONE = -1,
260 } header_id;
262 typedef struct _header_name {
263 gchar *header;
264 header_id id;
265 } header_name;
267 typedef struct _header {
268 header_id id;
269 gchar *header;
270 gchar *value;
271 } header;
274 typedef struct _message {
275 gchar *uid;
277 gchar *received_host;
278 prot_id received_prot;
279 gchar *ident;
280 gint transfer_id; /* for multiple messages per transfer */
282 address *return_path;
283 GList *rcpt_list;
284 GList *non_rcpt_list;
286 GList *hdr_list;
287 GList *data_list;
289 gint data_size;
290 time_t received_time;
291 time_t warned_time;
293 gchar *full_sender_name;
294 } message;
296 typedef struct _msg_out {
297 message *msg;
299 address *return_path;
300 GList *rcpt_list;
302 GList *hdr_list;
303 GList *xtra_hdr_list;
304 } msg_out;
306 typedef struct _msgout_perhost {
307 gchar *host;
308 GList *msgout_list;
309 } msgout_perhost;
311 /* flags for accept() */
312 #define ACC_DEL_RCPTS 0x02 /* -t option, delete rcpts that were given as cmd args */
313 #define ACC_RCPT_FROM_HEAD 0x08 /* -t option, get rcpts from headers */
314 #define ACC_DOT_IGNORE 0x10 /* a dot on a line itself does not end the message (-oi option) */
315 #define ACC_MAIL_FROM_HEAD 0x40 /* get return path from header */
316 #define ACC_NODOT_RELAX 0x80 /* do not be picky if message ist not terminated by a dot on a line */
317 #define ACC_SAVE_ENVELOPE_TO 0x0100 /* save an existent Envelope-to header as X-Orig-Envelope-to */
319 #define DLVR_LOCAL 0x01
320 #define DLVR_LAN 0x02
321 #define DLVR_ONLINE 0x04
322 #define DLVR_ALL (DLVR_LOCAL|DLVR_LAN|DLVR_ONLINE)
324 /* transport flags */
325 #define MSGSTR_FROMLINE 0x01
326 #define MSGSTR_FROMHACK 0x02
328 typedef enum _accept_error {
329 AERR_OK = 0,
330 AERR_TIMEOUT,
331 AERR_EOF,
332 AERR_OVERFLOW,
333 AERR_SYNTAX,
334 AERR_NOSPOOL,
335 AERR_NORCPT,
336 AERR_SIZE, /* max msg size exeeded (SMTP SIZE) */
337 AERR_UNKNOWN
338 } accept_error;
340 #define BUF_LEN 1024
341 #define MAX_ADDRESS 256
342 #define MAX_DATALINE 4096
344 typedef enum _smtp_cmd_id {
345 SMTP_HELO = 0,
346 SMTP_EHLO,
347 SMTP_MAIL_FROM,
348 SMTP_RCPT_TO,
349 SMTP_DATA,
350 SMTP_QUIT,
351 SMTP_RSET,
352 SMTP_NOOP,
353 SMTP_HELP,
354 SMTP_NUM_IDS,
355 SMTP_EOF = -1,
356 SMTP_ERROR = -2,
357 } smtp_cmd_id;
359 typedef struct _smtp_cmd {
360 smtp_cmd_id id;
361 gchar *cmd;
362 } smtp_cmd;
364 typedef struct _smtp_connection {
365 gchar *remote_host;
367 prot_id prot;
368 gint next_id;
370 gboolean helo_seen;
371 gboolean from_seen;
372 gboolean rcpt_seen;
374 message *msg;
375 } smtp_connection;
377 /* alias.c*/
378 gboolean addr_is_local(address * addr);
379 GList *alias_expand(GList * alias_table, GList * rcpt_list, GList * non_rcpt_list);
381 /* child.c */
382 int child(const char *command);
384 /* conf.c */
385 void init_conf();
386 gboolean read_conf(gchar * filename);
387 connect_route *read_route(gchar * filename, gboolean is_local_net);
388 GList *read_route_list(GList * rf_list, gboolean is_local_net);
389 void destroy_route(connect_route * r);
390 void destroy_route_list(GList * list);
391 get_conf *read_get_conf(gchar * filename);
392 void destroy_get_conf(get_conf * gc);
393 connect_route *create_local_route();
395 /* expand.c */
396 GList *var_table_rcpt(GList * var_table, address * rcpt);
397 GList *var_table_msg(GList * var_table, message * msg);
398 GList *var_table_conf(GList * var_table);
399 gint expand(GList * var_list, gchar * format, gchar * result, gint result_len);
401 /* message.c */
402 message *create_message(void);
403 void destroy_message(message * msg);
404 void destroy_msg_list(GList * msg_list);
405 void msg_free_data(message * msg);
406 gint msg_calc_size(message * msg, gboolean is_smtp);
408 msg_out *create_msg_out(message * msg);
409 msg_out *clone_msg_out(msg_out * msgout_orig);
410 GList *create_msg_out_list(GList * msg_list);
411 void destroy_msg_out(msg_out * msgout);
412 void destroy_msg_out_list(GList * msgout_list);
414 /* address.c */
415 address *create_address(gchar * path, gboolean is_rfc821);
416 address *create_address_qualified(gchar * path, gboolean is_rfc821, gchar * domain);
417 address *create_address_pipe(gchar * path);
418 void destroy_address(address * addr);
419 address *copy_modify_address(const address * orig, gchar * l_part, gchar * dom);
420 #define copy_address(addr) copy_modify_address(addr, NULL, NULL)
421 gboolean addr_isequal(address * addr1, address * addr2);
422 gboolean addr_isequal_parent(address * addr1, address * addr2);
423 address *addr_find_ancestor(address * addr);
424 gboolean addr_is_delivered_children(address * addr);
425 gboolean addr_is_finished_children(address * addr);
426 gchar *addr_string(address * addr);
427 gint addr_match(address * addr1, address * addr2);
429 /* accept.c */
430 accept_error accept_message(FILE * in, message * msg, guint flags);
431 accept_error accept_message_prepare(message * msg, guint flags);
433 /* header.c */
434 gchar *rec_timestamp();
435 GList *find_header(GList * hdr_list, header_id id, gchar * hdr_str);
436 void header_unfold(header * hdr);
437 void header_fold(header * hdr);
438 header *create_header(header_id id, gchar * fmt, ...);
439 void destroy_header(header * hdr);
440 header *copy_header(header * hdr);
441 header *get_header(gchar * line);
443 /* smtp_in.c */
444 void smtp_in(FILE * in, FILE * out, gchar * remote_host, gchar * ident);
446 /* listen.c */
447 void listen_port(GList * addr_list, gint qival, char *argv[]);
449 /* parse.c */
450 gboolean split_address(const gchar * path, gchar ** local_part, gchar ** domain, gboolean is_rfc821);
451 gboolean parse_address_rfc822(gchar * string, gchar ** local_begin, gchar ** local_end, gchar ** domain_begin, gchar ** domain_end, gchar ** address_end);
452 gboolean parse_address_rfc821(gchar * string, gchar ** local_begin, gchar ** local_end, gchar ** domain_begin, gchar ** domain_end, gchar ** address_end);
453 address *_create_address(gchar * string, gchar ** end, gboolean is_rfc821);
454 address *create_address_rfc821(gchar * string, gchar ** end);
455 address *create_address_rfc822(gchar * string, gchar ** end);
456 GList *addr_list_append_rfc822(GList * addr_list, gchar * string, gchar * domain);
457 gboolean addr_isequal(address * addr1, address * addr2);
459 /* connect.c */
460 mxip_addr *connect_hostlist(int *psockfd, gchar * host, guint port, GList * addr_list);
461 mxip_addr *connect_resolvelist(int *psockfd, gchar * host, guint port, GList * res_funcs);
463 /* deliver.c */
464 void msg_rcptlist_local(GList * rcpt_list, GList **, GList **);
465 gboolean deliver_local(msg_out * msgout);
466 gboolean deliver_msglist_host(connect_route * route, GList * msg_list, gchar * host, GList * res_list);
467 gboolean deliver_route_msgout_list(connect_route * route, GList * msgout_list);
468 gboolean deliver_route_msg_list(connect_route * route, GList * msgout_list);
469 gboolean deliver_finish(msg_out * msgout);
470 gboolean deliver_finish_list(GList * msgout_list);
471 gboolean deliver_msg_list(GList * msg_list, guint flags);
472 gboolean deliver(message * msg);
474 /* fail_msg.c */
475 gboolean fail_msg(message * msg, gchar * template, GList * failed_rcpts, gchar * err_fmt, va_list args);
476 gboolean warn_msg(message * msg, gchar * template, GList * failed_rcpts, gchar * err_fmt, va_list args);
478 /* get.c */
479 gboolean get_from_file(gchar * fname);
480 gboolean get_from_name(gchar * name);
481 gboolean get_all(void);
482 void get_online(void);
483 void get_daemon(gint gival, char *argv[]);
484 gboolean pop_before_smtp(gchar * fname);
486 /* interface.c */
487 gboolean init_sockaddr(struct sockaddr_in *name, interface * iface);
488 int make_server_socket(interface * iface);
490 /* local.c */
491 gboolean append_file(message * msg, GList * hdr_list, gchar * user);
492 gboolean maildir_out(message * msg, GList * hdr_list, gchar * user, guint flags);
493 gboolean pipe_out(message * msg, GList * hdr_list, address * rcpt, gchar * cmd, guint flags);
495 /* log.c */
496 gchar *ext_strerror(int err);
497 gboolean logopen(void);
498 void logclose(void);
499 void vlogwrite(int pri, const char *fmt, va_list args);
500 void logwrite(int pri, const char *fmt, ...);
501 void debugf(const char *fmt, ...);
502 void vdebugf(const char *fmt, va_list args);
503 void maillog(const char *fmt, ...);
505 /* spool.c */
506 gboolean spool_read_data(message * msg);
507 gboolean spool_read_data(message * msg);
508 message *msg_spool_read(gchar * uid, gboolean do_readdata);
509 gboolean spool_write(message * msg, gboolean do_writedata);
510 gboolean spool_lock(gchar * uid);
511 gboolean spool_unlock(gchar * uid);
512 gboolean spool_delete_all(message * msg);
514 /* queue.c */
515 GList *read_queue(gboolean do_readdata);
516 gboolean queue_run(void);
517 gboolean queue_run_online(void);
518 void queue_list(void);
519 gboolean queue_delete(gchar * uid);
521 /* online.c */
522 gchar *detect_online();
523 void set_online_name(gchar * name);
525 /* permissions.c */
526 gboolean is_ingroup(uid_t uid, gid_t gid);
527 void set_euidgid(gint uid, gint gid, uid_t * old_uid, gid_t * old_gid);
528 void set_identity(uid_t old_uid, gchar * task_name);
530 /* rewrite.c */
531 gboolean set_address_header_domain(header * hdr, gchar * domain);
532 gboolean map_address_header(header * hdr, GList * table);
534 /* route.c */
535 msgout_perhost *create_msgout_perhost(gchar * host);
536 void destroy_msgout_perhost(msgout_perhost * mo_ph);
537 void rewrite_headers(msg_out * msgout, connect_route * route);
538 void rcptlist_with_one_of_hostlist(GList * rcpt_list, GList * host_list, GList **, GList **);
539 void rcptlist_with_addr_is_local(GList * rcpt_list, GList ** p_rcpt_list, GList ** p_non_rcpt_list);
540 gboolean route_strip_msgout(connect_route * route, msg_out * msgout);
541 msg_out *route_prepare_msgout(connect_route * route, msg_out * msgout);
542 GList *route_msgout_list(connect_route * route, GList * msgout_list);
543 gboolean route_is_allowed_return_path(connect_route * route, address * ret_path);
544 gboolean route_is_allowed_mail_local(connect_route * route, address * ret_path);
545 void msg_rcptlist_route(connect_route * route, GList * rcpt_list, GList ** p_rcpt_list, GList ** p_non_rcpt_list);
547 /* tables.c */
548 table_pair *create_pair(gchar * key, gpointer value);
549 table_pair *create_pair_string(gchar * key, gpointer value);
550 table_pair *parse_table_pair(gchar * line, char delim);
551 gpointer *table_find_func(GList * table_list, gchar * key, int (*cmp_func) (const char *, const char *));
552 gpointer *table_find(GList * table_list, gchar * key);
553 gpointer *table_find_case(GList * table_list, gchar * key);
554 gpointer *table_find_fnmatch(GList * table_list, gchar * key);
555 GList *table_read(gchar * fname, gchar delim);
556 void destroy_table(GList * table);
558 /* timeival.c */
559 gint time_interval(gchar * str, gint * pos);
561 /* permissions.c */
562 gboolean is_privileged_user(uid_t uid);
564 /* other things */
566 #define foreach(list, node)\
567 for((node) = g_list_first(list);\
568 (node);\
569 (node) = g_list_next(node))
571 #ifdef ENABLE_DEBUG
572 #define DEBUG(level) if(level <= conf.debug_level)
573 #else
574 /* hopefully the compiler optmizes this away... */
575 #define DEBUG(level) if(0)
576 #endif
578 #define LOG_VERBOSE 0x100
580 #ifndef HAVE_GETLINE
581 #define getline(buf, size, file) getdelim(buf, size, '\n', file)
582 #endif
584 #ifndef HAVE_FDATASYNC
585 #define fdatasync(fd) fsync(fd)
586 #endif
588 #ifndef CONF_DIR
589 #define CONF_DIR "/etc/masqmail"
590 #endif
592 #define CONF_FILE CONF_DIR"/masqmail.conf"
594 #define PIDFILEDIR "/var/run/masqmail/"
596 #ifndef va_copy
597 #ifdef __va_copy
598 #define va_copy(ap1, ap2) __va_copy(ap1, ap2)
599 #else
600 #define va_copy(ap1, ap2) G_VA_COPY(ap1, ap2)
601 #endif
602 #endif
604 /* *BSD needs this: */
605 extern char **environ;