masqmail
view src/masqmail.h @ 215:08b32edca1d5
added the contents of the old FAQ page
it surely needs an update
| author | meillo@marmaro.de |
|---|---|
| date | Mon, 19 Jul 2010 14:10:14 +0200 |
| parents | 89f951be358f |
| children | 8cddc65765bd |
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 *pipe;
124 gboolean pipe_fromline;
125 gboolean pipe_fromhack;
126 } connect_route;
128 typedef struct _masqmail_conf {
129 gint mail_uid;
130 gint mail_gid;
132 gint orig_uid;
133 gint orig_gid;
135 gboolean run_as_user;
137 gchar *mail_dir;
138 gchar *lock_dir;
139 gchar *spool_dir;
140 gchar *log_dir;
142 gint debug_level;
143 gboolean use_syslog;
144 guint log_max_pri;
146 gchar *host_name;
147 GList *local_hosts;
148 GList *local_addresses;
149 GList *not_local_addresses;
150 GList *local_nets;
151 GList *listen_addresses;
153 /* ANSI C defines unsigned long to be at least 32bit
154 i.e. ca. 4GB max; that should be enough. */
155 gulong max_msg_size;
157 gboolean do_save_envelope_to;
159 gboolean defer_all;
160 gboolean do_relay;
162 GList *ident_trusted_nets;
164 gboolean do_queue;
166 gboolean do_verbose;
168 gchar *mbox_default;
169 GList *mbox_users;
170 GList *mda_users;
172 gchar *mda;
173 gboolean mda_fromline;
174 gboolean mda_fromhack;
176 gboolean pipe_fromline;
177 gboolean pipe_fromhack;
179 gchar *alias_file;
180 int (*alias_local_cmp) (const char *, const char *);
182 GList *local_net_routes;
183 GList *connect_routes; /* list of pairs which point to lists */
185 gchar *online_detect;
186 gchar *online_file;
187 gchar *online_pipe;
189 gchar *errmsg_file;
190 gchar *warnmsg_file;
191 GList *warn_intervals;
192 gint max_defer_time;
194 gchar *log_user;
195 } masqmail_conf;
197 extern masqmail_conf conf;
199 typedef struct _table_pair {
200 gchar *key;
201 gpointer *value;
202 } table_pair;
205 typedef enum _prot_id {
206 PROT_LOCAL = 0,
207 PROT_BSMTP,
208 PROT_SMTP,
209 PROT_ESMTP,
210 PROT_NUM
211 } prot_id;
213 extern gchar *prot_names[];
215 typedef enum _header_id {
216 HEAD_FROM = 0,
217 HEAD_SENDER,
218 HEAD_TO,
219 HEAD_CC,
220 HEAD_BCC,
221 HEAD_DATE,
222 HEAD_MESSAGE_ID,
223 HEAD_REPLY_TO,
224 HEAD_SUBJECT,
225 HEAD_RETURN_PATH,
226 HEAD_ENVELOPE_TO,
227 HEAD_RECEIVED,
228 HEAD_NUM_IDS,
229 HEAD_STATUS,
230 HEAD_UNKNOWN = HEAD_NUM_IDS,
231 HEAD_NONE = -1,
232 } header_id;
234 typedef struct _header_name {
235 gchar *header;
236 header_id id;
237 } header_name;
239 typedef struct _header {
240 header_id id;
241 gchar *header;
242 gchar *value;
243 } header;
246 typedef struct _message {
247 gchar *uid;
249 gchar *received_host;
250 prot_id received_prot;
251 gchar *ident;
252 gint transfer_id; /* for multiple messages per transfer */
254 address *return_path;
255 GList *rcpt_list;
256 GList *non_rcpt_list;
258 GList *hdr_list;
259 GList *data_list;
261 gint data_size;
262 time_t received_time;
263 time_t warned_time;
265 gchar *full_sender_name;
266 } message;
268 typedef struct _msg_out {
269 message *msg;
271 address *return_path;
272 GList *rcpt_list;
274 GList *hdr_list;
275 GList *xtra_hdr_list;
276 } msg_out;
278 typedef struct _msgout_perhost {
279 gchar *host;
280 GList *msgout_list;
281 } msgout_perhost;
283 /* flags for accept() */
284 #define ACC_DEL_RCPTS 0x02 /* -t option, delete rcpts that were given as cmd args */
285 #define ACC_RCPT_FROM_HEAD 0x08 /* -t option, get rcpts from headers */
286 #define ACC_DOT_IGNORE 0x10 /* a dot on a line itself does not end the message (-oi option) */
287 #define ACC_MAIL_FROM_HEAD 0x40 /* get return path from header */
288 #define ACC_NODOT_RELAX 0x80 /* do not be picky if message ist not terminated by a dot on a line */
289 #define ACC_SAVE_ENVELOPE_TO 0x0100 /* save an existent Envelope-to header as X-Orig-Envelope-to */
291 #define DLVR_LOCAL 0x01
292 #define DLVR_LAN 0x02
293 #define DLVR_ONLINE 0x04
294 #define DLVR_ALL (DLVR_LOCAL|DLVR_LAN|DLVR_ONLINE)
296 /* transport flags */
297 #define MSGSTR_FROMLINE 0x01
298 #define MSGSTR_FROMHACK 0x02
300 typedef enum _accept_error {
301 AERR_OK = 0,
302 AERR_TIMEOUT,
303 AERR_EOF,
304 AERR_OVERFLOW,
305 AERR_SYNTAX,
306 AERR_NOSPOOL,
307 AERR_NORCPT,
308 AERR_SIZE, /* max msg size exeeded (SMTP SIZE) */
309 AERR_UNKNOWN
310 } accept_error;
312 #define BUF_LEN 1024
313 #define MAX_ADDRESS 256
314 #define MAX_DATALINE 4096
316 typedef enum _smtp_cmd_id {
317 SMTP_HELO = 0,
318 SMTP_EHLO,
319 SMTP_MAIL_FROM,
320 SMTP_RCPT_TO,
321 SMTP_DATA,
322 SMTP_QUIT,
323 SMTP_RSET,
324 SMTP_NOOP,
325 SMTP_HELP,
326 SMTP_NUM_IDS,
327 SMTP_EOF = -1,
328 SMTP_ERROR = -2,
329 } smtp_cmd_id;
331 typedef struct _smtp_cmd {
332 smtp_cmd_id id;
333 gchar *cmd;
334 } smtp_cmd;
336 typedef struct _smtp_connection {
337 gchar *remote_host;
339 prot_id prot;
340 gint next_id;
342 gboolean helo_seen;
343 gboolean from_seen;
344 gboolean rcpt_seen;
346 message *msg;
347 } smtp_connection;
349 /* alias.c*/
350 gboolean addr_is_local(address * addr);
351 GList *alias_expand(GList * alias_table, GList * rcpt_list, GList * non_rcpt_list);
353 /* child.c */
354 int child(const char *command);
356 /* conf.c */
357 void init_conf();
358 gboolean read_conf(gchar * filename);
359 connect_route *read_route(gchar * filename, gboolean is_local_net);
360 GList *read_route_list(GList * rf_list, gboolean is_local_net);
361 void destroy_route(connect_route * r);
362 void destroy_route_list(GList * list);
363 connect_route *create_local_route();
365 /* expand.c */
366 GList *var_table_rcpt(GList * var_table, address * rcpt);
367 GList *var_table_msg(GList * var_table, message * msg);
368 GList *var_table_conf(GList * var_table);
369 gint expand(GList * var_list, gchar * format, gchar * result, gint result_len);
371 /* message.c */
372 message *create_message(void);
373 void destroy_message(message * msg);
374 void destroy_msg_list(GList * msg_list);
375 void msg_free_data(message * msg);
376 gint msg_calc_size(message * msg, gboolean is_smtp);
378 msg_out *create_msg_out(message * msg);
379 msg_out *clone_msg_out(msg_out * msgout_orig);
380 GList *create_msg_out_list(GList * msg_list);
381 void destroy_msg_out(msg_out * msgout);
382 void destroy_msg_out_list(GList * msgout_list);
384 /* address.c */
385 address *create_address(gchar * path, gboolean is_rfc821);
386 address *create_address_qualified(gchar * path, gboolean is_rfc821, gchar * domain);
387 address *create_address_pipe(gchar * path);
388 void destroy_address(address * addr);
389 address *copy_modify_address(const address * orig, gchar * l_part, gchar * dom);
390 #define copy_address(addr) copy_modify_address(addr, NULL, NULL)
391 gboolean addr_isequal(address * addr1, address * addr2);
392 gboolean addr_isequal_parent(address * addr1, address * addr2);
393 address *addr_find_ancestor(address * addr);
394 gboolean addr_is_delivered_children(address * addr);
395 gboolean addr_is_finished_children(address * addr);
396 gchar *addr_string(address * addr);
397 gint addr_match(address * addr1, address * addr2);
399 /* accept.c */
400 accept_error accept_message(FILE * in, message * msg, guint flags);
401 accept_error accept_message_prepare(message * msg, guint flags);
403 /* header.c */
404 gchar *rec_timestamp();
405 GList *find_header(GList * hdr_list, header_id id, gchar * hdr_str);
406 void header_unfold(header * hdr);
407 void header_fold(header * hdr);
408 header *create_header(header_id id, gchar * fmt, ...);
409 void destroy_header(header * hdr);
410 header *copy_header(header * hdr);
411 header *get_header(gchar * line);
413 /* smtp_in.c */
414 void smtp_in(FILE * in, FILE * out, gchar * remote_host, gchar * ident);
416 /* listen.c */
417 void listen_port(GList * addr_list, gint qival, char *argv[]);
419 /* parse.c */
420 gboolean split_address(const gchar * path, gchar ** local_part, gchar ** domain, gboolean is_rfc821);
421 gboolean parse_address_rfc822(gchar * string, gchar ** local_begin, gchar ** local_end, gchar ** domain_begin, gchar ** domain_end, gchar ** address_end);
422 gboolean parse_address_rfc821(gchar * string, gchar ** local_begin, gchar ** local_end, gchar ** domain_begin, gchar ** domain_end, gchar ** address_end);
423 address *_create_address(gchar * string, gchar ** end, gboolean is_rfc821);
424 address *create_address_rfc821(gchar * string, gchar ** end);
425 address *create_address_rfc822(gchar * string, gchar ** end);
426 GList *addr_list_append_rfc822(GList * addr_list, gchar * string, gchar * domain);
427 gboolean addr_isequal(address * addr1, address * addr2);
429 /* connect.c */
430 mxip_addr *connect_hostlist(int *psockfd, gchar * host, guint port, GList * addr_list);
431 mxip_addr *connect_resolvelist(int *psockfd, gchar * host, guint port, GList * res_funcs);
433 /* deliver.c */
434 void msg_rcptlist_local(GList * rcpt_list, GList **, GList **);
435 gboolean deliver_local(msg_out * msgout);
436 gboolean deliver_msglist_host(connect_route * route, GList * msg_list, gchar * host, GList * res_list);
437 gboolean deliver_route_msgout_list(connect_route * route, GList * msgout_list);
438 gboolean deliver_route_msg_list(connect_route * route, GList * msgout_list);
439 gboolean deliver_finish(msg_out * msgout);
440 gboolean deliver_finish_list(GList * msgout_list);
441 gboolean deliver_msg_list(GList * msg_list, guint flags);
442 gboolean deliver(message * msg);
444 /* fail_msg.c */
445 gboolean fail_msg(message * msg, gchar * template, GList * failed_rcpts, gchar * err_fmt, va_list args);
446 gboolean warn_msg(message * msg, gchar * template, GList * failed_rcpts, gchar * err_fmt, va_list args);
448 /* interface.c */
449 gboolean init_sockaddr(struct sockaddr_in *name, interface * iface);
450 int make_server_socket(interface * iface);
452 /* local.c */
453 gboolean append_file(message * msg, GList * hdr_list, gchar * user);
454 gboolean pipe_out(message * msg, GList * hdr_list, address * rcpt, gchar * cmd, guint flags);
456 /* log.c */
457 gchar *ext_strerror(int err);
458 gboolean logopen(void);
459 void logclose(void);
460 void vlogwrite(int pri, const char *fmt, va_list args);
461 void logwrite(int pri, const char *fmt, ...);
462 void debugf(const char *fmt, ...);
463 void vdebugf(const char *fmt, va_list args);
464 void maillog(const char *fmt, ...);
466 /* spool.c */
467 gboolean spool_read_data(message * msg);
468 gboolean spool_read_data(message * msg);
469 message *msg_spool_read(gchar * uid, gboolean do_readdata);
470 gboolean spool_write(message * msg, gboolean do_writedata);
471 gboolean spool_lock(gchar * uid);
472 gboolean spool_unlock(gchar * uid);
473 gboolean spool_delete_all(message * msg);
475 /* queue.c */
476 GList *read_queue(gboolean do_readdata);
477 gboolean queue_run(void);
478 gboolean queue_run_online(void);
479 void queue_list(void);
480 gboolean queue_delete(gchar * uid);
482 /* online.c */
483 gchar *detect_online();
484 void set_online_name(gchar * name);
486 /* permissions.c */
487 gboolean is_ingroup(uid_t uid, gid_t gid);
488 void set_euidgid(gint uid, gint gid, uid_t * old_uid, gid_t * old_gid);
489 void set_identity(uid_t old_uid, gchar * task_name);
491 /* rewrite.c */
492 gboolean set_address_header_domain(header * hdr, gchar * domain);
493 gboolean map_address_header(header * hdr, GList * table);
495 /* route.c */
496 msgout_perhost *create_msgout_perhost(gchar * host);
497 void destroy_msgout_perhost(msgout_perhost * mo_ph);
498 void rewrite_headers(msg_out * msgout, connect_route * route);
499 void rcptlist_with_one_of_hostlist(GList * rcpt_list, GList * host_list, GList **, GList **);
500 void rcptlist_with_addr_is_local(GList * rcpt_list, GList ** p_rcpt_list, GList ** p_non_rcpt_list);
501 gboolean route_strip_msgout(connect_route * route, msg_out * msgout);
502 msg_out *route_prepare_msgout(connect_route * route, msg_out * msgout);
503 GList *route_msgout_list(connect_route * route, GList * msgout_list);
504 gboolean route_is_allowed_return_path(connect_route * route, address * ret_path);
505 gboolean route_is_allowed_mail_local(connect_route * route, address * ret_path);
506 void msg_rcptlist_route(connect_route * route, GList * rcpt_list, GList ** p_rcpt_list, GList ** p_non_rcpt_list);
508 /* tables.c */
509 table_pair *create_pair(gchar * key, gpointer value);
510 table_pair *create_pair_string(gchar * key, gpointer value);
511 table_pair *parse_table_pair(gchar * line, char delim);
512 gpointer *table_find_func(GList * table_list, gchar * key, int (*cmp_func) (const char *, const char *));
513 gpointer *table_find(GList * table_list, gchar * key);
514 gpointer *table_find_case(GList * table_list, gchar * key);
515 gpointer *table_find_fnmatch(GList * table_list, gchar * key);
516 GList *table_read(gchar * fname, gchar delim);
517 void destroy_table(GList * table);
519 /* timeival.c */
520 gint time_interval(gchar * str, gint * pos);
522 /* permissions.c */
523 gboolean is_privileged_user(uid_t uid);
525 /* other things */
527 #define foreach(list, node)\
528 for((node) = g_list_first(list);\
529 (node);\
530 (node) = g_list_next(node))
532 #ifdef ENABLE_DEBUG
533 #define DEBUG(level) if(level <= conf.debug_level)
534 #else
535 /* hopefully the compiler optmizes this away... */
536 #define DEBUG(level) if(0)
537 #endif
539 #define LOG_VERBOSE 0x100
541 #ifndef HAVE_GETLINE
542 #define getline(buf, size, file) getdelim(buf, size, '\n', file)
543 #endif
545 #ifndef HAVE_FDATASYNC
546 #define fdatasync(fd) fsync(fd)
547 #endif
549 #ifndef CONF_DIR
550 #define CONF_DIR "/etc/masqmail"
551 #endif
553 #define CONF_FILE CONF_DIR"/masqmail.conf"
555 #define PIDFILEDIR "/var/run/masqmail/"
557 #ifndef va_copy
558 #ifdef __va_copy
559 #define va_copy(ap1, ap2) __va_copy(ap1, ap2)
560 #else
561 #define va_copy(ap1, ap2) G_VA_COPY(ap1, ap2)
562 #endif
563 #endif
565 /* *BSD needs this: */
566 extern char **environ;