xref: /freebsd/contrib/dma/dma.h (revision f4b37ed0f8b307b1f3f0f630ca725d68f1dff30d)
1 /*
2  * Copyright (c) 2008 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Simon 'corecode' Schubert <corecode@fs.ei.tum.de> and
6  * Matthias Schmidt <matthias@dragonflybsd.org>.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the
17  *    distribution.
18  * 3. Neither the name of The DragonFly Project nor the names of its
19  *    contributors may be used to endorse or promote products derived
20  *    from this software without specific, prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
26  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35 
36 #ifndef DMA_H
37 #define DMA_H
38 
39 #include <sys/types.h>
40 #include <sys/queue.h>
41 #include <sys/socket.h>
42 #include <arpa/nameser.h>
43 #include <arpa/inet.h>
44 #include <openssl/ssl.h>
45 #include <netdb.h>
46 
47 #define VERSION	"DragonFly Mail Agent " DMA_VERSION
48 
49 #define BUF_SIZE	2048
50 #define ERRMSG_SIZE	200
51 #define USERNAME_SIZE	50
52 #define MIN_RETRY	300		/* 5 minutes */
53 #define MAX_RETRY	(3*60*60)	/* retry at least every 3 hours */
54 #define MAX_TIMEOUT	(5*24*60*60)	/* give up after 5 days */
55 #define SLEEP_TIMEOUT	30		/* check for queue flush every 30 seconds */
56 #ifndef PATH_MAX
57 #define PATH_MAX	1024		/* Max path len */
58 #endif
59 #define	SMTP_PORT	25		/* Default SMTP port */
60 #define CON_TIMEOUT	(5*60)		/* Connection timeout per RFC5321 */
61 
62 #define STARTTLS	0x002		/* StartTLS support */
63 #define SECURETRANS	0x004		/* SSL/TLS in general */
64 #define NOSSL		0x008		/* Do not use SSL */
65 #define DEFER		0x010		/* Defer mails */
66 #define INSECURE	0x020		/* Allow plain login w/o encryption */
67 #define FULLBOUNCE	0x040		/* Bounce the full message */
68 #define TLS_OPP		0x080		/* Opportunistic STARTTLS */
69 #define NULLCLIENT	0x100		/* Nullclient support */
70 
71 #ifndef CONF_PATH
72 #error Please define CONF_PATH
73 #endif
74 
75 #ifndef LIBEXEC_PATH
76 #error Please define LIBEXEC_PATH
77 #endif
78 
79 #define SPOOL_FLUSHFILE	"flush"
80 
81 #ifndef DMA_ROOT_USER
82 #define DMA_ROOT_USER	"mail"
83 #endif
84 #ifndef DMA_GROUP
85 #define DMA_GROUP	"mail"
86 #endif
87 
88 #ifndef MBOX_STRICT
89 #define MBOX_STRICT	0
90 #endif
91 
92 
93 struct stritem {
94 	SLIST_ENTRY(stritem) next;
95 	char *str;
96 };
97 SLIST_HEAD(strlist, stritem);
98 
99 struct alias {
100 	LIST_ENTRY(alias) next;
101 	char *alias;
102 	struct strlist dests;
103 };
104 LIST_HEAD(aliases, alias);
105 
106 struct qitem {
107 	LIST_ENTRY(qitem) next;
108 	const char *sender;
109 	char *addr;
110 	char *queuefn;
111 	char *mailfn;
112 	char *queueid;
113 	FILE *queuef;
114 	FILE *mailf;
115 	int remote;
116 };
117 LIST_HEAD(queueh, qitem);
118 
119 struct queue {
120 	struct queueh queue;
121 	char *id;
122 	FILE *mailf;
123 	char *tmpf;
124 	const char *sender;
125 };
126 
127 struct config {
128 	const char *smarthost;
129 	int port;
130 	const char *aliases;
131 	const char *spooldir;
132 	const char *authpath;
133 	const char *certfile;
134 	int features;
135 	const char *mailname;
136 	const char *masquerade_host;
137 	const char *masquerade_user;
138 
139 	/* XXX does not belong into config */
140 	SSL *ssl;
141 };
142 
143 
144 struct authuser {
145 	SLIST_ENTRY(authuser) next;
146 	char *login;
147 	char *password;
148 	char *host;
149 };
150 SLIST_HEAD(authusers, authuser);
151 
152 
153 struct mx_hostentry {
154 	char		host[MAXDNAME];
155 	char		addr[INET6_ADDRSTRLEN];
156 	int		pref;
157 	struct addrinfo	ai;
158 	struct sockaddr_storage	sa;
159 };
160 
161 
162 /* global variables */
163 extern struct aliases aliases;
164 extern struct config config;
165 extern struct strlist tmpfs;
166 extern struct authusers authusers;
167 extern char username[USERNAME_SIZE];
168 extern uid_t useruid;
169 extern const char *logident_base;
170 
171 extern char neterr[ERRMSG_SIZE];
172 extern char errmsg[ERRMSG_SIZE];
173 
174 /* aliases_parse.y */
175 int yyparse(void);
176 extern FILE *yyin;
177 
178 /* conf.c */
179 void trim_line(char *);
180 void parse_conf(const char *);
181 void parse_authfile(const char *);
182 
183 /* crypto.c */
184 void hmac_md5(unsigned char *, int, unsigned char *, int, unsigned char *);
185 int smtp_auth_md5(int, char *, char *);
186 int smtp_init_crypto(int, int);
187 
188 /* dns.c */
189 int dns_get_mx_list(const char *, int, struct mx_hostentry **, int);
190 
191 /* net.c */
192 char *ssl_errstr(void);
193 int read_remote(int, int, char *);
194 ssize_t send_remote_command(int, const char*, ...)  __attribute__((__nonnull__(2), __format__ (__printf__, 2, 3)));
195 int deliver_remote(struct qitem *);
196 
197 /* base64.c */
198 int base64_encode(const void *, int, char **);
199 int base64_decode(const char *, void *);
200 
201 /* dma.c */
202 #define EXPAND_ADDR	1
203 #define EXPAND_WILDCARD	2
204 int add_recp(struct queue *, const char *, int);
205 void run_queue(struct queue *);
206 
207 /* spool.c */
208 int newspoolf(struct queue *);
209 int linkspool(struct queue *);
210 int load_queue(struct queue *);
211 void delqueue(struct qitem *);
212 int acquirespool(struct qitem *);
213 void dropspool(struct queue *, struct qitem *);
214 int flushqueue_since(unsigned int);
215 int flushqueue_signal(void);
216 
217 /* local.c */
218 int deliver_local(struct qitem *);
219 
220 /* mail.c */
221 void bounce(struct qitem *, const char *);
222 int readmail(struct queue *, int, int);
223 
224 /* util.c */
225 const char *hostname(void);
226 void setlogident(const char *, ...) __attribute__((__format__ (__printf__, 1, 2)));
227 void errlog(int, const char *, ...) __attribute__((__format__ (__printf__, 2, 3)));
228 void errlogx(int, const char *, ...) __attribute__((__format__ (__printf__, 2, 3)));
229 void set_username(void);
230 void deltmp(void);
231 int do_timeout(int, int);
232 int open_locked(const char *, int, ...);
233 char *rfc822date(void);
234 int strprefixcmp(const char *, const char *);
235 void init_random(void);
236 
237 #endif
238