smtpd.h revision 1.254
1/*	$OpenBSD: smtpd.h,v 1.254 2011/11/21 18:57:54 eric Exp $	*/
2
3/*
4 * Copyright (c) 2008 Gilles Chehade <gilles@openbsd.org>
5 * Copyright (c) 2008 Pierre-Yves Ritschard <pyr@openbsd.org>
6 *
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 */
19
20#ifndef nitems
21#define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
22#endif
23
24#include "filter.h"
25
26#define IMSG_SIZE_CHECK(p) do {					\
27		if (IMSG_DATA_SIZE(&imsg) != sizeof(*p))	\
28			fatalx("bad length imsg received");	\
29	} while (0)
30#define IMSG_DATA_SIZE(imsg)	((imsg)->hdr.len - IMSG_HEADER_SIZE)
31
32
33#define CONF_FILE		 "/etc/mail/smtpd.conf"
34#define MAX_LISTEN		 16
35#define PROC_COUNT		 9
36#define MAX_NAME_SIZE		 64
37
38#define MAX_HOPS_COUNT		 100
39
40#define MAX_TAG_SIZE		 32
41/* SYNC WITH filter.h		  */
42//#define MAX_LINE_SIZE		 1024
43//#define MAX_LOCALPART_SIZE	 128
44//#define MAX_DOMAINPART_SIZE	 MAXHOSTNAMELEN
45
46/* return and forward path size */
47#define	MAX_FILTER_NAME		 32
48#define MAX_PATH_SIZE		 256
49#define MAX_RULEBUFFER_LEN	 256
50
51#define SMTPD_QUEUE_INTERVAL	 (15 * 60)
52#define SMTPD_QUEUE_MAXINTERVAL	 (4 * 60 * 60)
53#define SMTPD_QUEUE_EXPIRY	 (4 * 24 * 60 * 60)
54#define SMTPD_USER		 "_smtpd"
55#define SMTPD_FILTER_USER      	 "_smtpmfa"
56#define SMTPD_SOCKET		 "/var/run/smtpd.sock"
57#define SMTPD_BANNER		 "220 %s ESMTP OpenSMTPD"
58#define SMTPD_SESSION_TIMEOUT	 300
59#define SMTPD_BACKLOG		 5
60
61#define	PATH_MAILLOCAL		"/usr/libexec/mail.local"
62#define	PATH_SMTPCTL		"/usr/sbin/smtpctl"
63
64#define	DIRHASH_BUCKETS		 4096
65
66#define PATH_SPOOL		"/var/spool/smtpd"
67#define PATH_OFFLINE		"/offline"
68
69/* number of MX records to lookup */
70#define MAX_MX_COUNT		10
71
72/* max response delay under flood conditions */
73#define MAX_RESPONSE_DELAY	60
74
75/* how many responses per state are undelayed */
76#define FAST_RESPONSES		2
77
78/* max len of any smtp line */
79#define	SMTP_LINE_MAX		1024
80
81#define F_STARTTLS		 0x01
82#define F_SMTPS			 0x02
83#define F_AUTH			 0x04
84#define F_SSL			(F_SMTPS|F_STARTTLS)
85
86#define F_SCERT			0x01
87#define F_CCERT			0x02
88
89#define ADVERTISE_TLS(s) \
90	((s)->s_l->flags & F_STARTTLS && !((s)->s_flags & F_SECURE))
91
92#define ADVERTISE_AUTH(s) \
93	((s)->s_l->flags & F_AUTH && (s)->s_flags & F_SECURE && \
94	 !((s)->s_flags & F_AUTHENTICATED))
95
96
97
98typedef u_int32_t	objid_t;
99
100struct netaddr {
101	struct sockaddr_storage ss;
102	int bits;
103};
104
105struct relayhost {
106	u_int8_t flags;
107	char hostname[MAXHOSTNAMELEN];
108	u_int16_t port;
109	char cert[PATH_MAX];
110	char authmap[MAX_PATH_SIZE];
111};
112
113enum imsg_type {
114	IMSG_NONE,
115	IMSG_CTL_OK,		/* answer to smtpctl requests */
116	IMSG_CTL_FAIL,
117	IMSG_CTL_SHUTDOWN,
118	IMSG_CTL_VERBOSE,
119	IMSG_CONF_START,
120	IMSG_CONF_SSL,
121	IMSG_CONF_LISTENER,
122	IMSG_CONF_MAP,
123	IMSG_CONF_MAP_CONTENT,
124	IMSG_CONF_RULE,
125	IMSG_CONF_RULE_SOURCE,
126	IMSG_CONF_FILTER,
127	IMSG_CONF_END,
128	IMSG_CONF_RELOAD,
129	IMSG_LKA_MAIL,
130	IMSG_LKA_RCPT,
131	IMSG_LKA_SECRET,
132	IMSG_LKA_RULEMATCH,
133	IMSG_MDA_SESS_NEW,
134	IMSG_MDA_DONE,
135
136	IMSG_MFA_HELO,
137	IMSG_MFA_MAIL,
138	IMSG_MFA_RCPT,
139	IMSG_MFA_DATALINE,
140
141	IMSG_QUEUE_CREATE_MESSAGE,
142	IMSG_QUEUE_SUBMIT_ENVELOPE,
143	IMSG_QUEUE_COMMIT_ENVELOPES,
144	IMSG_QUEUE_REMOVE_MESSAGE,
145	IMSG_QUEUE_COMMIT_MESSAGE,
146	IMSG_QUEUE_TEMPFAIL,
147	IMSG_QUEUE_PAUSE_MDA,
148	IMSG_QUEUE_PAUSE_MTA,
149	IMSG_QUEUE_RESUME_MDA,
150	IMSG_QUEUE_RESUME_MTA,
151
152	IMSG_QUEUE_MESSAGE_UPDATE,
153	IMSG_QUEUE_MESSAGE_FD,
154	IMSG_QUEUE_MESSAGE_FILE,
155	IMSG_QUEUE_SCHEDULE,
156	IMSG_QUEUE_REMOVE,
157
158	IMSG_RUNNER_REMOVE,
159	IMSG_RUNNER_SCHEDULE,
160
161	IMSG_BATCH_CREATE,
162	IMSG_BATCH_APPEND,
163	IMSG_BATCH_CLOSE,
164	IMSG_BATCH_DONE,
165
166	IMSG_PARENT_FORWARD_OPEN,
167	IMSG_PARENT_FORK_MDA,
168
169	IMSG_PARENT_AUTHENTICATE,
170	IMSG_PARENT_SEND_CONFIG,
171
172	IMSG_STATS,
173	IMSG_SMTP_ENQUEUE,
174	IMSG_SMTP_PAUSE,
175	IMSG_SMTP_RESUME,
176
177	IMSG_DNS_HOST,
178	IMSG_DNS_HOST_END,
179	IMSG_DNS_MX,
180	IMSG_DNS_PTR
181};
182
183enum blockmodes {
184	BM_NORMAL,
185	BM_NONBLOCK
186};
187
188struct imsgev {
189	struct imsgbuf		 ibuf;
190	void			(*handler)(int, short, void *);
191	struct event		 ev;
192	void			*data;
193	int			 proc;
194	short			 events;
195};
196
197struct ctl_conn {
198	TAILQ_ENTRY(ctl_conn)	 entry;
199	u_int8_t		 flags;
200#define CTL_CONN_NOTIFY		 0x01
201	struct imsgev		 iev;
202};
203TAILQ_HEAD(ctl_connlist, ctl_conn);
204
205struct ctl_id {
206	objid_t		 id;
207	char		 name[MAX_NAME_SIZE];
208};
209
210enum smtp_proc_type {
211	PROC_PARENT = 0,
212	PROC_SMTP,
213	PROC_MFA,
214	PROC_LKA,
215	PROC_QUEUE,
216	PROC_MDA,
217	PROC_MTA,
218	PROC_CONTROL,
219	PROC_RUNNER,
220} smtpd_process;
221
222struct peer {
223	enum smtp_proc_type	 id;
224	void			(*cb)(int, short, void *);
225};
226
227enum map_type {
228	T_SINGLE,
229	T_LIST,
230	T_HASH
231};
232
233enum map_src {
234	S_NONE,
235	S_DYN,
236	S_DNS,
237	S_PLAIN,
238	S_DB,
239	S_EXT
240};
241
242enum map_kind {
243	K_NONE,
244	K_ALIAS,
245	K_VIRTUAL,
246	K_SECRET
247};
248
249enum mapel_type {
250	ME_STRING,
251	ME_NET,
252	ME_NETMASK
253};
254
255struct mapel {
256	TAILQ_ENTRY(mapel)		 me_entry;
257	union mapel_data {
258		char			 med_string[MAX_LINE_SIZE];
259		struct netaddr		 med_addr;
260	}				 me_key;
261	union mapel_data		 me_val;
262};
263
264struct map {
265	TAILQ_ENTRY(map)		 m_entry;
266#define F_USED				 0x01
267#define F_DYNAMIC			 0x02
268	u_int8_t			 m_flags;
269	char				 m_name[MAX_LINE_SIZE];
270	objid_t				 m_id;
271	enum map_type			 m_type;
272	enum mapel_type			 m_eltype;
273	enum map_src			 m_src;
274	char				 m_config[MAXPATHLEN];
275	TAILQ_HEAD(mapel_list, mapel)	 m_contents;
276};
277
278
279struct map_backend {
280	void *(*open)(char *);
281	void (*close)(void *);
282	void *(*lookup)(void *, char *, enum map_kind);
283};
284
285
286enum cond_type {
287	C_ALL,
288	C_NET,
289	C_DOM,
290	C_VDOM
291};
292
293struct cond {
294	TAILQ_ENTRY(cond)		 c_entry;
295	objid_t				 c_map;
296	enum cond_type			 c_type;
297};
298
299enum action_type {
300	A_INVALID,
301	A_RELAY,
302	A_RELAYVIA,
303	A_MAILDIR,
304	A_MBOX,
305	A_FILENAME,
306	A_EXT
307};
308
309#define IS_MAILBOX(x)	((x).r_action == A_MAILDIR || (x).r_action == A_MBOX || (x).r_action == A_FILENAME)
310#define IS_RELAY(x)	((x).r_action == A_RELAY || (x).r_action == A_RELAYVIA)
311#define IS_EXT(x)	((x).r_action == A_EXT)
312
313struct rule {
314	TAILQ_ENTRY(rule)		 r_entry;
315	char				 r_tag[MAX_TAG_SIZE];
316	int				 r_accept;
317	struct map			*r_sources;
318	struct cond			 r_condition;
319	enum action_type		 r_action;
320	union rule_dest {
321		char			 buffer[MAX_RULEBUFFER_LEN];
322		struct relayhost       	 relayhost;
323	}				 r_value;
324
325	char				*r_user;
326	struct mailaddr			*r_as;
327	objid_t				 r_amap;
328	time_t				 r_qexpire;
329};
330
331struct mailaddr {
332	char	user[MAX_LOCALPART_SIZE];
333	char	domain[MAX_DOMAINPART_SIZE];
334};
335
336enum delivery_type {
337	D_INVALID = 0,
338	D_MDA,
339	D_MTA,
340	D_BOUNCE
341};
342
343enum delivery_status {
344	DS_PERMFAILURE	= 0x2,
345	DS_TEMPFAILURE	= 0x4,
346	DS_REJECTED	= 0x8,
347	DS_ACCEPTED	= 0x10
348};
349
350enum delivery_flags {
351	DF_AUTHENTICATED	= 0x1,
352	DF_ENQUEUED		= 0x2,
353	DF_BOUNCE		= 0x4,
354	DF_INTERNAL		= 0x8 /* internal expansion forward */
355};
356
357union delivery_data {
358	char user[MAXLOGNAME];
359	char buffer[MAX_RULEBUFFER_LEN];
360	struct mailaddr mailaddr;
361};
362
363struct delivery_mda {
364	enum action_type	method;
365	union delivery_data	to;
366	char			as_user[MAXLOGNAME];
367};
368
369struct delivery_mta {
370	struct relayhost relay;
371};
372
373enum expand_type {
374	EXPAND_INVALID,
375	EXPAND_USERNAME,
376	EXPAND_FILENAME,
377	EXPAND_FILTER,
378	EXPAND_INCLUDE,
379	EXPAND_ADDRESS
380};
381
382enum expand_flags {
383	F_EXPAND_NONE,
384	F_EXPAND_DONE
385};
386
387struct expandnode {
388	RB_ENTRY(expandnode)	entry;
389	size_t			refcnt;
390	enum expand_flags      	flags;
391	enum expand_type       	type;
392	char			as_user[MAXLOGNAME];
393	union delivery_data    	u;
394};
395
396RB_HEAD(expandtree, expandnode);
397
398#define	SMTPD_ENVELOPE_VERSION		1
399struct envelope {
400	TAILQ_ENTRY(envelope)		entry;
401
402	char				tag[MAX_TAG_SIZE];
403	struct rule			rule;
404
405	u_int64_t			session_id;
406	u_int64_t			batch_id;
407
408//	struct delivery			delivery;
409
410	u_int32_t			version;
411	u_int64_t			id;
412	enum delivery_type		type;
413
414	char				helo[MAXHOSTNAMELEN];
415	char				hostname[MAXHOSTNAMELEN];
416	char				errorline[MAX_LINE_SIZE + 1];
417	struct sockaddr_storage		ss;
418
419	struct mailaddr			sender;
420	struct mailaddr			rcpt;
421	struct mailaddr			dest;
422
423	union delivery_method {
424		struct delivery_mda	mda;
425		struct delivery_mta	mta;
426	} agent;
427
428	time_t				 creation;
429	time_t				 lasttry;
430	time_t				 expire;
431	u_int8_t			 retry;
432	enum delivery_flags		 flags;
433	enum delivery_status		 status;
434
435};
436TAILQ_HEAD(deliverylist, envelope);
437
438
439enum child_type {
440	CHILD_INVALID,
441	CHILD_DAEMON,
442	CHILD_MDA,
443	CHILD_ENQUEUE_OFFLINE,
444};
445
446struct child {
447	SPLAY_ENTRY(child)	 entry;
448	pid_t			 pid;
449	enum child_type		 type;
450	enum smtp_proc_type	 title;
451	int			 mda_out;
452	u_int32_t		 mda_id;
453	char			*path;
454};
455
456enum session_state {
457	S_INVALID = 0,
458	S_INIT,
459	S_GREETED,
460	S_TLS,
461	S_AUTH_INIT,
462	S_AUTH_USERNAME,
463	S_AUTH_PASSWORD,
464	S_AUTH_FINALIZE,
465	S_HELO,
466	S_MAIL_MFA,
467	S_MAIL_QUEUE,
468	S_MAIL,
469	S_RCPT_MFA,
470	S_RCPT,
471	S_DATA,
472	S_DATA_QUEUE,
473	S_DATACONTENT,
474	S_DONE,
475	S_QUIT
476};
477#define STATE_COUNT	18
478
479struct ssl {
480	SPLAY_ENTRY(ssl)	 ssl_nodes;
481	char			 ssl_name[PATH_MAX];
482	char			*ssl_cert;
483	off_t			 ssl_cert_len;
484	char			*ssl_key;
485	off_t			 ssl_key_len;
486	char			*ssl_dhparams;
487	off_t			 ssl_dhparams_len;
488	u_int8_t		 flags;
489};
490
491struct listener {
492	u_int8_t		 flags;
493	int			 fd;
494	struct sockaddr_storage	 ss;
495	in_port_t		 port;
496	struct timeval		 timeout;
497	struct event		 ev;
498	char			 ssl_cert_name[PATH_MAX];
499	struct ssl		*ssl;
500	void			*ssl_ctx;
501	char			 tag[MAX_TAG_SIZE];
502	TAILQ_ENTRY(listener)	 entry;
503};
504
505struct auth {
506	u_int64_t	 id;
507	char		 user[MAXLOGNAME];
508	char		 pass[MAX_LINE_SIZE + 1];
509	int		 success;
510};
511
512enum session_flags {
513	F_EHLO		= 0x1,
514	F_QUIT		= 0x2,
515	F_8BITMIME	= 0x4,
516	F_SECURE	= 0x8,
517	F_AUTHENTICATED	= 0x10,
518	F_PEERHASTLS	= 0x20,
519	F_PEERHASAUTH	= 0x40,
520	F_WRITEONLY	= 0x80
521};
522
523struct session {
524	SPLAY_ENTRY(session)		 s_nodes;
525	u_int64_t			 s_id;
526
527	enum session_flags		 s_flags;
528	enum session_state		 s_state;
529	int				 s_fd;
530	struct sockaddr_storage		 s_ss;
531	char				 s_hostname[MAXHOSTNAMELEN];
532	struct event			 s_ev;
533	struct bufferevent		*s_bev;
534	struct listener			*s_l;
535	void				*s_ssl;
536	u_char				*s_buf;
537	int				 s_buflen;
538	struct timeval			 s_tv;
539	struct envelope			 s_msg;
540	short				 s_nresp[STATE_COUNT];
541	size_t				 rcptcount;
542	long				 s_datalen;
543
544	struct auth			 s_auth;
545
546	FILE				*datafp;
547	int				 mboxfd;
548	int				 messagefd;
549};
550
551
552/* ram-queue structures */
553struct ramqueue_host {
554	RB_ENTRY(ramqueue_host)		hosttree_entry;
555	TAILQ_HEAD(,ramqueue_batch)	batch_queue;
556	u_int64_t			h_id;
557	char				hostname[MAXHOSTNAMELEN];
558};
559struct ramqueue_batch {
560	TAILQ_ENTRY(ramqueue_batch)	batch_entry;
561	TAILQ_HEAD(,ramqueue_envelope)	envelope_queue;
562	enum delivery_type		type;
563	u_int64_t			h_id;
564	u_int64_t			b_id;
565	u_int32_t      			msgid;
566	struct relayhost		relay;
567};
568struct ramqueue_envelope {
569	TAILQ_ENTRY(ramqueue_envelope)	 queue_entry;
570	TAILQ_ENTRY(ramqueue_envelope)	 batchqueue_entry;
571	RB_ENTRY(ramqueue_envelope)	 evptree_entry;
572	struct ramqueue_batch		*rq_batch;
573	struct ramqueue_message		*rq_msg;
574	struct ramqueue_host		*rq_host;
575	u_int64_t      			 evpid;
576	time_t				 sched;
577};
578struct ramqueue_message {
579	RB_ENTRY(ramqueue_message)		msgtree_entry;
580	RB_HEAD(evptree, ramqueue_envelope)	evptree;
581	u_int32_t				msgid;
582};
583struct ramqueue {
584	struct ramqueue_envelope	       *current_evp;
585	RB_HEAD(hosttree, ramqueue_host)	hosttree;
586	RB_HEAD(msgtree, ramqueue_message)	msgtree;
587	TAILQ_HEAD(,ramqueue_envelope)		queue;
588};
589
590
591struct smtpd {
592	char					 sc_conffile[MAXPATHLEN];
593	size_t					 sc_maxsize;
594
595#define SMTPD_OPT_VERBOSE			 0x00000001
596#define SMTPD_OPT_NOACTION			 0x00000002
597	u_int32_t				 sc_opts;
598#define SMTPD_CONFIGURING			 0x00000001
599#define SMTPD_EXITING				 0x00000002
600#define SMTPD_MDA_PAUSED		       	 0x00000004
601#define SMTPD_MTA_PAUSED		       	 0x00000008
602#define SMTPD_SMTP_PAUSED		       	 0x00000010
603	u_int32_t				 sc_flags;
604	struct timeval				 sc_qintval;
605	int					 sc_qexpire;
606	u_int32_t				 sc_maxconn;
607	struct event				 sc_ev;
608	int					 *sc_pipes[PROC_COUNT]
609							[PROC_COUNT];
610	struct imsgev				*sc_ievs[PROC_COUNT];
611	int					 sc_instances[PROC_COUNT];
612	int					 sc_instance;
613	char					*sc_title[PROC_COUNT];
614	struct passwd				*sc_pw;
615	char					 sc_hostname[MAXHOSTNAMELEN];
616	struct ramqueue				 sc_rqueue;
617	struct queue_backend			*sc_queue;
618
619	TAILQ_HEAD(filterlist, filter)		*sc_filters;
620
621	TAILQ_HEAD(listenerlist, listener)	*sc_listeners;
622	TAILQ_HEAD(maplist, map)		*sc_maps, *sc_maps_reload;
623	TAILQ_HEAD(rulelist, rule)		*sc_rules, *sc_rules_reload;
624	SPLAY_HEAD(sessiontree, session)	 sc_sessions;
625	SPLAY_HEAD(ssltree, ssl)		*sc_ssl;
626	SPLAY_HEAD(childtree, child)		 children;
627	SPLAY_HEAD(lkatree, lka_session)	 lka_sessions;
628	SPLAY_HEAD(mfatree, mfa_session)	 mfa_sessions;
629	SPLAY_HEAD(mtatree, mta_session)	 mta_sessions;
630	LIST_HEAD(mdalist, mda_session)		 mda_sessions;
631
632	struct stats				*stats;
633	u_int64_t				 filtermask;
634};
635
636#define	TRACE_VERBOSE	0x01
637#define	TRACE_IMSG	0x02
638
639enum {
640	STATS_SMTP_SESSION = 0,
641	STATS_SMTP_SESSION_INET4,
642	STATS_SMTP_SESSION_INET6,
643	STATS_SMTP_SMTPS,
644	STATS_SMTP_STARTTLS,
645
646	STATS_MTA_SESSION,
647
648	STATS_MDA_SESSION,
649
650	STATS_CONTROL_SESSION,
651
652	STATS_LKA_SESSION,
653	STATS_LKA_SESSION_MX,
654	STATS_LKA_SESSION_HOST,
655	STATS_LKA_SESSION_CNAME,
656	STATS_LKA_FAILURE,
657
658	STATS_RUNNER,
659	STATS_RUNNER_BOUNCES,
660
661	STATS_QUEUE_LOCAL,
662	STATS_QUEUE_REMOTE,
663
664	STATS_RAMQUEUE_ENVELOPE,
665	STATS_RAMQUEUE_MESSAGE,
666	STATS_RAMQUEUE_BATCH,
667	STATS_RAMQUEUE_HOST,
668
669	STATS_MAX,
670};
671
672#define STAT_COUNT	0
673#define STAT_ACTIVE	1
674#define STAT_MAXACTIVE	2
675
676struct	stat_counter {
677	size_t	count;
678	size_t	active;
679	size_t	maxactive;
680};
681
682struct s_parent {
683	time_t		start;
684};
685
686struct s_session {
687	size_t		read_error;
688	size_t		read_timeout;
689	size_t		read_eof;
690	size_t		write_error;
691	size_t		write_timeout;
692	size_t		write_eof;
693	size_t		toofast;
694	size_t		tempfail;
695	size_t		linetoolong;
696	size_t		delays;
697};
698
699struct stats {
700	struct s_parent		 parent;
701	struct s_session	 mta;
702	struct s_session	 smtp;
703
704	struct stat_counter	 counters[STATS_MAX];
705};
706
707struct reload {
708	int			fd;
709	int			ret;
710};
711
712struct submit_status {
713	u_int64_t			 id;
714	int				 code;
715	union submit_path {
716		struct mailaddr		 maddr;
717		u_int32_t		 msgid;
718		u_int64_t		 evpid;
719		char			 errormsg[MAX_LINE_SIZE + 1];
720		char			 dataline[MAX_LINE_SIZE + 1];
721	}				 u;
722	enum delivery_flags		 flags;
723	struct sockaddr_storage		 ss;
724	struct envelope			 envelope;
725};
726
727struct forward_req {
728	u_int64_t			 id;
729	u_int8_t			 status;
730	char				 as_user[MAXLOGNAME];
731	struct envelope			 envelope;
732};
733
734enum dns_status {
735	DNS_OK = 0,
736	DNS_RETRY,
737	DNS_EINVAL,
738	DNS_ENONAME,
739	DNS_ENOTFOUND,
740};
741
742struct dns {
743	u_int64_t		 id;
744	char			 host[MAXHOSTNAMELEN];
745	int			 port;
746	int			 error;
747	int			 type;
748	struct imsgev		*asker;
749	struct sockaddr_storage	 ss;
750	struct dns		*next;
751};
752
753struct secret {
754	u_int64_t		 id;
755	char			 mapname[MAX_PATH_SIZE];
756	char			 host[MAXHOSTNAMELEN];
757	char			 secret[MAX_LINE_SIZE];
758};
759
760struct mda_session {
761	LIST_ENTRY(mda_session)	 entry;
762	struct envelope		 msg;
763	struct msgbuf		 w;
764	struct event		 ev;
765	u_int32_t		 id;
766	FILE			*datafp;
767};
768
769struct deliver {
770	char			to[PATH_MAX];
771	char			user[MAXLOGNAME];
772	short			mode;
773};
774
775struct rulematch {
776	u_int64_t		 id;
777	struct submit_status	 ss;
778};
779
780enum lka_session_flags {
781	F_ERROR		= 0x1
782};
783
784struct lka_session {
785	SPLAY_ENTRY(lka_session)	 nodes;
786	u_int64_t			 id;
787
788	struct deliverylist		 deliverylist;
789	struct expandtree		 expandtree;
790
791	u_int8_t			 iterations;
792	u_int32_t			 pending;
793	enum lka_session_flags		 flags;
794	struct submit_status		 ss;
795};
796
797struct filter {
798	TAILQ_ENTRY(filter)     f_entry;
799	pid_t			pid;
800	struct event		ev;
801	struct imsgbuf		*ibuf;
802	char			name[MAX_FILTER_NAME];
803	char			path[MAXPATHLEN];
804};
805
806struct mfa_session {
807	SPLAY_ENTRY(mfa_session)	 nodes;
808	u_int64_t			 id;
809
810	enum session_state		 state;
811	struct submit_status		 ss;
812	struct filter			*filter;
813	struct filter_msg		 fm;
814};
815
816enum mta_state {
817	MTA_INVALID_STATE,
818	MTA_INIT,
819	MTA_SECRET,
820	MTA_DATA,
821	MTA_MX,
822	MTA_CONNECT,
823	MTA_PTR,
824	MTA_PROTOCOL,
825	MTA_DONE
826};
827
828/* mta session flags */
829#define	MTA_FORCE_ANYSSL	0x01
830#define	MTA_FORCE_SMTPS		0x02
831#define	MTA_ALLOW_PLAIN		0x04
832#define	MTA_USE_AUTH		0x08
833#define	MTA_FORCE_MX		0x10
834
835struct mta_relay {
836	TAILQ_ENTRY(mta_relay)	 entry;
837	struct sockaddr_storage	 sa;
838	char			 fqdn[MAXHOSTNAMELEN];
839	int			 used;
840};
841
842struct mta_session {
843	SPLAY_ENTRY(mta_session) entry;
844	u_int64_t		 id;
845	enum mta_state		 state;
846	char			*host;
847	int			 port;
848	int			 flags;
849	TAILQ_HEAD(,envelope)	 recipients;
850	TAILQ_HEAD(,mta_relay)	 relays;
851	char			*authmap;
852	char			*secret;
853	int			 fd;
854	FILE			*datafp;
855	struct event		 ev;
856	char			*cert;
857	void			*pcb;
858	struct ramqueue_batch	*batch;
859};
860
861
862/* maps return structures */
863struct map_secret {
864	char username[MAX_LINE_SIZE];
865	char password[MAX_LINE_SIZE];
866};
867
868struct map_alias {
869	size_t			nbnodes;
870	struct expandtree	expandtree;
871};
872
873struct map_virtual {
874	size_t			nbnodes;
875	struct expandtree	expandtree;
876};
877
878
879/* queue structures */
880enum queue_type {
881	QT_INVALID=0,
882	QT_FS
883};
884
885enum queue_kind {
886	Q_INVALID=0,
887	Q_INCOMING,
888	Q_QUEUE,
889	Q_PURGE,
890	Q_BOUNCE,
891	Q_CORRUPT
892};
893
894enum queue_op {
895	QOP_INVALID=0,
896	QOP_CREATE,
897	QOP_DELETE,
898	QOP_UPDATE,
899	QOP_COMMIT,
900	QOP_LOAD,
901	QOP_FD_R,
902	QOP_FD_RW,
903	QOP_PURGE,
904	QOP_CORRUPT,
905};
906
907struct queue_backend {
908	enum queue_type	type;
909
910	int (*init)(void);
911	int (*message)(enum queue_kind, enum queue_op, u_int32_t *);
912	int (*envelope)(enum queue_kind, enum queue_op, struct envelope *);
913
914	void *(*qwalk_new)(enum queue_kind, u_int32_t);
915	int   (*qwalk)(void *, u_int64_t *);
916	void  (*qwalk_close)(void *);
917};
918
919
920/* auth structures */
921enum auth_type {
922	AUTH_INVALID=0,
923	AUTH_BSD,
924	AUTH_GETPWNAM,
925};
926
927struct auth_backend {
928	enum auth_type	type;
929	int (*authenticate)(char *, char *);
930};
931
932
933/* user structures */
934enum user_type {
935	USER_INVALID=0,
936	USER_GETPWNAM,
937};
938
939#define	MAXPASSWORDLEN	128
940struct user {
941	char username[MAXLOGNAME];
942	char directory[MAXPATHLEN];
943	char password[MAXPASSWORDLEN];
944	uid_t uid;
945	gid_t gid;
946};
947
948struct user_backend {
949	enum user_type	type;
950	int (*getbyname)(struct user *, char *);
951	int (*getbyuid)(struct user *, uid_t);
952};
953
954
955extern struct smtpd	*env;
956extern void (*imsg_callback)(struct imsgev *, struct imsg *);
957
958
959/* aliases.c */
960int aliases_exist(objid_t, char *);
961int aliases_get(objid_t, struct expandtree *, char *);
962int aliases_vdomain_exists(objid_t, char *);
963int aliases_virtual_exist(objid_t, struct mailaddr *);
964int aliases_virtual_get(objid_t, struct expandtree *, struct mailaddr *);
965int alias_parse(struct expandnode *, char *);
966
967
968/* auth_backend.c */
969struct auth_backend *auth_backend_lookup(enum auth_type);
970
971
972/* bounce.c */
973int bounce_session(int, struct envelope *);
974int bounce_session_switch(FILE *, enum session_state *, char *, struct envelope *);
975void bounce_event(int, short, void *);
976
977
978/* config.c */
979#define PURGE_LISTENERS		0x01
980#define PURGE_MAPS		0x02
981#define PURGE_RULES		0x04
982#define PURGE_SSL		0x08
983#define PURGE_EVERYTHING	0xff
984void purge_config(u_int8_t);
985void unconfigure(void);
986void configure(void);
987void init_pipes(void);
988void config_pipes(struct peer *, u_int);
989void config_peers(struct peer *, u_int);
990
991
992/* control.c */
993pid_t control(void);
994void session_socket_blockmode(int, enum blockmodes);
995void session_socket_no_linger(int);
996int session_socket_error(int);
997
998
999/* dns.c */
1000void dns_query_host(char *, int, u_int64_t);
1001void dns_query_mx(char *, int, u_int64_t);
1002void dns_query_ptr(struct sockaddr_storage *, u_int64_t);
1003void dns_async(struct imsgev *, int, struct dns *);
1004
1005
1006/* enqueue.c */
1007int		 enqueue(int, char **);
1008int		 enqueue_offline(int, char **);
1009
1010
1011/* expand.c */
1012int expand_cmp(struct expandnode *, struct expandnode *);
1013void expandtree_increment_node(struct expandtree *, struct expandnode *);
1014void expandtree_decrement_node(struct expandtree *, struct expandnode *);
1015void expandtree_remove_node(struct expandtree *, struct expandnode *);
1016struct expandnode *expandtree_lookup(struct expandtree *, struct expandnode *);
1017void expandtree_free_nodes(struct expandtree *);
1018RB_PROTOTYPE(expandtree, expandnode, nodes, expand_cmp);
1019
1020
1021/* forward.c */
1022int forwards_get(int, struct expandtree *, char *);
1023
1024
1025/* lka.c */
1026pid_t lka(void);
1027int lka_session_cmp(struct lka_session *, struct lka_session *);
1028SPLAY_PROTOTYPE(lkatree, lka_session, nodes, lka_session_cmp);
1029
1030/* lka_session.c */
1031struct lka_session *lka_session_init(struct submit_status *);
1032void lka_session_fail(struct lka_session *);
1033void lka_session_destroy(struct lka_session *);
1034
1035
1036/* map.c */
1037void *map_lookup(objid_t, char *, enum map_kind);
1038struct map *map_find(objid_t);
1039struct map *map_findbyname(const char *);
1040
1041
1042/* mda.c */
1043pid_t mda(void);
1044
1045
1046/* mfa.c */
1047pid_t mfa(void);
1048int mfa_session_cmp(struct mfa_session *, struct mfa_session *);
1049SPLAY_PROTOTYPE(mfatree, mfa_session, nodes, mfa_session_cmp);
1050
1051/* mta.c */
1052pid_t mta(void);
1053int mta_session_cmp(struct mta_session *, struct mta_session *);
1054SPLAY_PROTOTYPE(mtatree, mta_session, entry, mta_session_cmp);
1055
1056
1057/* parse.y */
1058int parse_config(struct smtpd *, const char *, int);
1059int cmdline_symset(char *);
1060
1061
1062/* queue.c */
1063pid_t queue(void);
1064void queue_submit_envelope(struct envelope *);
1065void queue_commit_envelopes(struct envelope *);
1066
1067
1068/* queue_backend.c */
1069u_int32_t queue_generate_msgid(void);
1070u_int64_t queue_generate_evpid(u_int32_t msgid);
1071struct queue_backend *queue_backend_lookup(enum queue_type);
1072int queue_message_create(enum queue_kind, u_int32_t *);
1073int queue_message_delete(enum queue_kind, u_int32_t);
1074int queue_message_commit(enum queue_kind, u_int32_t);
1075int queue_message_fd_r(enum queue_kind, u_int32_t);
1076int queue_message_fd_rw(enum queue_kind, u_int32_t);
1077int queue_message_purge(enum queue_kind, u_int32_t);
1078int queue_message_corrupt(enum queue_kind, u_int32_t);
1079int queue_envelope_create(enum queue_kind, struct envelope *);
1080int queue_envelope_delete(enum queue_kind, struct envelope *);
1081int queue_envelope_load(enum queue_kind, u_int64_t, struct envelope *);
1082int queue_envelope_update(enum queue_kind, struct envelope *);
1083void *qwalk_new(enum queue_kind, u_int32_t);
1084int   qwalk(void *, u_int64_t *);
1085void  qwalk_close(void *);
1086
1087
1088/* queue_shared.c */
1089void queue_message_update(struct envelope *);
1090int bounce_record_message(struct envelope *, struct envelope *);
1091void show_queue(enum queue_kind, int);
1092
1093
1094/* ramqueue.c */
1095void ramqueue_init(struct ramqueue *);
1096int ramqueue_load(struct ramqueue *, time_t *);
1097int ramqueue_load_offline(struct ramqueue *);
1098int ramqueue_host_cmp(struct ramqueue_host *, struct ramqueue_host *);
1099int ramqueue_msg_cmp(struct ramqueue_message *, struct ramqueue_message *);
1100int ramqueue_evp_cmp(struct ramqueue_envelope *, struct ramqueue_envelope *);
1101int ramqueue_is_empty(struct ramqueue *);
1102int ramqueue_is_empty(struct ramqueue *);
1103int ramqueue_batch_is_empty(struct ramqueue_batch *);
1104int ramqueue_host_is_empty(struct ramqueue_host *);
1105void ramqueue_remove_batch(struct ramqueue_host *, struct ramqueue_batch *);
1106void ramqueue_remove_host(struct ramqueue *, struct ramqueue_host *);
1107struct ramqueue_envelope *ramqueue_envelope_by_id(struct ramqueue *, u_int64_t);
1108struct ramqueue_envelope *ramqueue_first_envelope(struct ramqueue *);
1109struct ramqueue_envelope *ramqueue_next_envelope(struct ramqueue *);
1110struct ramqueue_envelope *ramqueue_batch_first_envelope(struct ramqueue_batch *);
1111void ramqueue_insert(struct ramqueue *, struct envelope *, time_t);
1112int ramqueue_message_is_empty(struct ramqueue_message *);
1113void ramqueue_remove_message(struct ramqueue *, struct ramqueue_message *);
1114
1115struct ramqueue_host *ramqueue_lookup_host(struct ramqueue *, char *);
1116struct ramqueue_message *ramqueue_lookup_message(struct ramqueue *, u_int32_t);
1117struct ramqueue_envelope *ramqueue_lookup_envelope(struct ramqueue *, u_int64_t);
1118
1119void ramqueue_schedule(struct ramqueue *, u_int64_t);
1120void ramqueue_schedule_envelope(struct ramqueue *, struct ramqueue_envelope *);
1121
1122void ramqueue_remove_envelope(struct ramqueue *, struct ramqueue_envelope *);
1123
1124
1125RB_PROTOTYPE(hosttree, ramqueue_host, hosttree_entry, ramqueue_host_cmp);
1126RB_PROTOTYPE(msgtree,  ramqueue_message, msg_entry, ramqueue_msg_cmp);
1127RB_PROTOTYPE(evptree,  ramqueue_envelope, evp_entry, ramqueue_evp_cmp);
1128
1129
1130/* runner.c */
1131pid_t runner(void);
1132void message_reset_flags(struct envelope *);
1133void runner_schedule(struct ramqueue *, u_int64_t);
1134void runner_remove(struct ramqueue *, u_int64_t);
1135void runner_remove_envelope(struct ramqueue *, struct ramqueue_envelope *);
1136
1137
1138/* smtp.c */
1139pid_t smtp(void);
1140void smtp_resume(void);
1141
1142
1143/* smtp_session.c */
1144void session_init(struct listener *, struct session *);
1145int session_cmp(struct session *, struct session *);
1146void session_pickup(struct session *, struct submit_status *);
1147void session_destroy(struct session *);
1148void session_respond(struct session *, char *, ...)
1149	__attribute__ ((format (printf, 2, 3)));
1150void session_bufferevent_new(struct session *);
1151SPLAY_PROTOTYPE(sessiontree, session, s_nodes, session_cmp);
1152
1153
1154/* smtpd.c */
1155int	 child_cmp(struct child *, struct child *);
1156void imsg_event_add(struct imsgev *);
1157void imsg_compose_event(struct imsgev *, u_int16_t, u_int32_t, pid_t,
1158    int, void *, u_int16_t);
1159void imsg_dispatch(int, short, void *);
1160const char * proc_to_str(int);
1161const char * imsg_to_str(int);
1162SPLAY_PROTOTYPE(childtree, child, entry, child_cmp);
1163
1164
1165/* ssl.c */
1166void ssl_init(void);
1167void ssl_transaction(struct session *);
1168void ssl_session_init(struct session *);
1169void ssl_session_destroy(struct session *);
1170int ssl_load_certfile(const char *, u_int8_t);
1171void ssl_setup(struct listener *);
1172int ssl_cmp(struct ssl *, struct ssl *);
1173SPLAY_PROTOTYPE(ssltree, ssl, ssl_nodes, ssl_cmp);
1174
1175
1176/* ssl_privsep.c */
1177int	 ssl_ctx_use_private_key(void *, char *, off_t);
1178int	 ssl_ctx_use_certificate_chain(void *, char *, off_t);
1179
1180/* stats.c */
1181void	stat_init(struct stat_counter *, int);
1182size_t	stat_get(int, int);
1183size_t	stat_increment(int);
1184size_t	stat_decrement(int);
1185
1186
1187/* user_backend.c */
1188struct user_backend *user_backend_lookup(enum user_type);
1189
1190
1191/* util.c */
1192typedef struct arglist arglist;
1193struct arglist {
1194	char    **list;
1195	u_int   num;
1196	u_int   nalloc;
1197};
1198void addargs(arglist *, char *, ...)
1199	__attribute__((format(printf, 2, 3)));
1200int bsnprintf(char *, size_t, const char *, ...)
1201	__attribute__ ((format (printf, 3, 4)));
1202int safe_fclose(FILE *);
1203int hostname_match(char *, char *);
1204int email_to_mailaddr(struct mailaddr *, char *);
1205int valid_localpart(char *);
1206int valid_domainpart(char *);
1207char *ss_to_text(struct sockaddr_storage *);
1208int valid_message_id(char *);
1209int valid_message_uid(char *);
1210char *time_to_text(time_t);
1211int secure_file(int, char *, char *, uid_t, int);
1212void lowercase(char *, char *, size_t);
1213void envelope_set_errormsg(struct envelope *, char *, ...);
1214char *envelope_get_errormsg(struct envelope *);
1215void sa_set_port(struct sockaddr *, int);
1216u_int64_t generate_uid(void);
1217void fdlimit(double);
1218int availdesc(void);
1219u_int32_t evpid_to_msgid(u_int64_t);
1220u_int64_t msgid_to_evpid(u_int32_t);
1221void log_imsg(int, int, struct imsg*);
1222int ckdir(const char *, mode_t, uid_t, gid_t, int);
1223