Merge branch 'vendor/TNFTP'
[dragonfly.git] / libexec / dma / dma.h
1 /*
2  * Copyright (c) 2008-2014, Simon Schubert <2@0x2c.org>.
3  * Copyright (c) 2008 The DragonFly Project.  All rights reserved.
4  *
5  * This code is derived from software contributed to The DragonFly Project
6  * by Simon Schubert <2@0x2c.org> and
7  * Matthias Schmidt <matthias@dragonflybsd.org>.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  * 3. Neither the name of The DragonFly Project nor the names of its
20  *    contributors may be used to endorse or promote products derived
21  *    from this software without specific, prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
27  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
31  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
33  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  */
36
37 #ifndef DMA_H
38 #define DMA_H
39
40 #include <sys/types.h>
41 #include <sys/queue.h>
42 #include <sys/socket.h>
43 #include <arpa/nameser.h>
44 #include <arpa/inet.h>
45 #include <openssl/ssl.h>
46 #include <netdb.h>
47
48 #define VERSION "DragonFly Mail Agent " DMA_VERSION
49
50 #define BUF_SIZE        2048
51 #define ERRMSG_SIZE     200
52 #define USERNAME_SIZE   50
53 #define MIN_RETRY       300             /* 5 minutes */
54 #define MAX_RETRY       (3*60*60)       /* retry at least every 3 hours */
55 #define MAX_TIMEOUT     (5*24*60*60)    /* give up after 5 days */
56 #define SLEEP_TIMEOUT   30              /* check for queue flush every 30 seconds */
57 #ifndef PATH_MAX
58 #define PATH_MAX        1024            /* Max path len */
59 #endif
60 #define SMTP_PORT       25              /* Default SMTP port */
61 #define CON_TIMEOUT     (5*60)          /* Connection timeout per RFC5321 */
62
63 #define STARTTLS        0x002           /* StartTLS support */
64 #define SECURETRANS     0x004           /* SSL/TLS in general */
65 #define NOSSL           0x008           /* Do not use SSL */
66 #define DEFER           0x010           /* Defer mails */
67 #define INSECURE        0x020           /* Allow plain login w/o encryption */
68 #define FULLBOUNCE      0x040           /* Bounce the full message */
69 #define TLS_OPP         0x080           /* Opportunistic STARTTLS */
70 #define NULLCLIENT      0x100           /* Nullclient support */
71
72 #ifndef CONF_PATH
73 #error Please define CONF_PATH
74 #endif
75
76 #ifndef LIBEXEC_PATH
77 #error Please define LIBEXEC_PATH
78 #endif
79
80 #define SPOOL_FLUSHFILE "flush"
81
82 #ifndef DMA_ROOT_USER
83 #define DMA_ROOT_USER   "mail"
84 #endif
85 #ifndef DMA_GROUP
86 #define DMA_GROUP       "mail"
87 #endif
88
89 #ifndef MBOX_STRICT
90 #define MBOX_STRICT     0
91 #endif
92
93
94 struct stritem {
95         SLIST_ENTRY(stritem) next;
96         char *str;
97 };
98 SLIST_HEAD(strlist, stritem);
99
100 struct alias {
101         LIST_ENTRY(alias) next;
102         char *alias;
103         struct strlist dests;
104 };
105 LIST_HEAD(aliases, alias);
106
107 struct qitem {
108         LIST_ENTRY(qitem) next;
109         const char *sender;
110         char *addr;
111         char *queuefn;
112         char *mailfn;
113         char *queueid;
114         FILE *queuef;
115         FILE *mailf;
116         int remote;
117 };
118 LIST_HEAD(queueh, qitem);
119
120 struct queue {
121         struct queueh queue;
122         char *id;
123         FILE *mailf;
124         char *tmpf;
125         const char *sender;
126 };
127
128 struct config {
129         const char *smarthost;
130         int port;
131         const char *aliases;
132         const char *spooldir;
133         const char *authpath;
134         const char *certfile;
135         int features;
136         const char *mailname;
137         const char *masquerade_host;
138         const char *masquerade_user;
139
140         /* XXX does not belong into config */
141         SSL *ssl;
142 };
143
144
145 struct authuser {
146         SLIST_ENTRY(authuser) next;
147         char *login;
148         char *password;
149         char *host;
150 };
151 SLIST_HEAD(authusers, authuser);
152
153
154 struct mx_hostentry {
155         char            host[MAXDNAME];
156         char            addr[INET6_ADDRSTRLEN];
157         int             pref;
158         struct addrinfo ai;
159         struct sockaddr_storage sa;
160 };
161
162
163 /* global variables */
164 extern struct aliases aliases;
165 extern struct config config;
166 extern struct strlist tmpfs;
167 extern struct authusers authusers;
168 extern char username[USERNAME_SIZE];
169 extern uid_t useruid;
170 extern const char *logident_base;
171
172 extern char neterr[ERRMSG_SIZE];
173 extern char errmsg[ERRMSG_SIZE];
174
175 /* aliases_parse.y */
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