Add note about reboot before 'make upgrade' step.
[dragonfly.git] / libexec / dma / dma.h
blobd413ca517226e5058a1872be3f4141346932542f
1 /*
2 * Copyright (c) 2008 The DragonFly Project. All rights reserved.
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>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
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.
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.
36 #ifndef DMA_H
37 #define DMA_H
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>
47 #define VERSION "DragonFly Mail Agent " DMA_VERSION
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 #ifndef PATH_MAX
56 #define PATH_MAX 1024 /* Max path len */
57 #endif
58 #define SMTP_PORT 25 /* Default SMTP port */
59 #define CON_TIMEOUT (5*60) /* Connection timeout per RFC5321 */
61 #define STARTTLS 0x002 /* StartTLS support */
62 #define SECURETRANS 0x004 /* SSL/TLS in general */
63 #define NOSSL 0x008 /* Do not use SSL */
64 #define DEFER 0x010 /* Defer mails */
65 #define INSECURE 0x020 /* Allow plain login w/o encryption */
66 #define FULLBOUNCE 0x040 /* Bounce the full message */
67 #define TLS_OPP 0x080 /* Opportunistic STARTTLS */
69 #ifndef CONF_PATH
70 #error Please define CONF_PATH
71 #endif
73 #ifndef LIBEXEC_PATH
74 #error Please define LIBEXEC_PATH
75 #endif
77 #define DMA_ROOT_USER "mail"
78 #define DMA_GROUP "mail"
80 #ifndef MBOX_STRICT
81 #define MBOX_STRICT 0
82 #endif
85 struct stritem {
86 SLIST_ENTRY(stritem) next;
87 char *str;
89 SLIST_HEAD(strlist, stritem);
91 struct alias {
92 LIST_ENTRY(alias) next;
93 char *alias;
94 struct strlist dests;
96 LIST_HEAD(aliases, alias);
98 struct qitem {
99 LIST_ENTRY(qitem) next;
100 const char *sender;
101 char *addr;
102 char *queuefn;
103 char *mailfn;
104 char *queueid;
105 FILE *queuef;
106 FILE *mailf;
107 int remote;
109 LIST_HEAD(queueh, qitem);
111 struct queue {
112 struct queueh queue;
113 char *id;
114 FILE *mailf;
115 char *tmpf;
116 const char *sender;
119 struct config {
120 const char *smarthost;
121 int port;
122 const char *aliases;
123 const char *spooldir;
124 const char *authpath;
125 const char *certfile;
126 int features;
127 const char *mailname;
128 const char *masquerade_host;
129 const char *masquerade_user;
131 /* XXX does not belong into config */
132 SSL *ssl;
136 struct authuser {
137 SLIST_ENTRY(authuser) next;
138 char *login;
139 char *password;
140 char *host;
142 SLIST_HEAD(authusers, authuser);
145 struct mx_hostentry {
146 char host[MAXDNAME];
147 char addr[INET6_ADDRSTRLEN];
148 int pref;
149 struct addrinfo ai;
150 struct sockaddr_storage sa;
154 /* global variables */
155 extern struct aliases aliases;
156 extern struct config config;
157 extern struct strlist tmpfs;
158 extern struct authusers authusers;
159 extern char username[USERNAME_SIZE];
160 extern uid_t useruid;
161 extern const char *logident_base;
163 extern char neterr[ERRMSG_SIZE];
164 extern char errmsg[ERRMSG_SIZE];
166 /* aliases_parse.y */
167 extern FILE *yyin;
169 /* conf.c */
170 void trim_line(char *);
171 void parse_conf(const char *);
172 void parse_authfile(const char *);
174 /* crypto.c */
175 void hmac_md5(unsigned char *, int, unsigned char *, int, unsigned char *);
176 int smtp_auth_md5(int, char *, char *);
177 int smtp_init_crypto(int, int);
179 /* dns.c */
180 int dns_get_mx_list(const char *, int, struct mx_hostentry **, int);
182 /* net.c */
183 char *ssl_errstr(void);
184 int read_remote(int, int, char *);
185 ssize_t send_remote_command(int, const char*, ...) __printflike(2, 3);
186 int deliver_remote(struct qitem *);
188 /* base64.c */
189 int base64_encode(const void *, int, char **);
190 int base64_decode(const char *, void *);
192 /* dma.c */
193 #define EXPAND_ADDR 1
194 #define EXPAND_WILDCARD 2
195 int add_recp(struct queue *, const char *, int);
196 void run_queue(struct queue *);
198 /* spool.c */
199 int newspoolf(struct queue *);
200 int linkspool(struct queue *);
201 int load_queue(struct queue *);
202 void delqueue(struct qitem *);
203 int acquirespool(struct qitem *);
204 void dropspool(struct queue *, struct qitem *);
206 /* local.c */
207 int deliver_local(struct qitem *);
209 /* mail.c */
210 void bounce(struct qitem *, const char *);
211 int readmail(struct queue *, int, int);
213 /* util.c */
214 const char *hostname(void);
215 void setlogident(const char *, ...) __printf0like(1, 2);
216 void errlog(int, const char *, ...) __printf0like(2, 3);
217 void errlogx(int, const char *, ...) __printf0like(2, 3);
218 void set_username(void);
219 void deltmp(void);
220 int do_timeout(int, int);
221 int open_locked(const char *, int, ...);
222 char *rfc822date(void);
223 int strprefixcmp(const char *, const char *);
224 void init_random(void);
226 #endif