/[imapfilter]/imapfilter/imapfilter.h
ViewVC logotype

Contents of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.57 - (show annotations)
Mon May 19 22:38:15 2003 UTC (20 years, 10 months ago) by lefcha
Branch: MAIN
Changes since 1.56: +2 -0 lines
File MIME type: text/plain
Added support for config file rereading when SIGHUP received.

1 #ifndef IMAPFILTER_H
2 #define IMAPFILTER_H
3
4 #include <stdio.h>
5 #include <unistd.h>
6 #include <sys/stat.h>
7 #include <sys/types.h>
8 #include <dirent.h>
9
10 #include "config.h"
11
12 #ifdef SSL_TLS
13 #include <openssl/ssl.h>
14 #include <openssl/x509.h>
15 #endif
16
17 #ifndef DATA_H
18 #include "data.h"
19 #endif
20
21 /* Program's version number. */
22 #define IMAPFILTER_VERSION "0.8.7"
23
24 /* Error codes returned by functions. */
25 #define ERROR_SIGNAL 1
26 #define ERROR_TRIVIAL 2
27 #define ERROR_FILE_OPEN 3
28 #define ERROR_LOCKFILE 4
29 #define ERROR_CONFIG_PARSE 5
30 #define ERROR_MEMORY_ALLOCATION 6
31 #define ERROR_SETUID 7
32 #define ERROR_TERMIO 8
33 #define ERROR_NETWORK 9
34 #define ERROR_SSL 10
35 #define ERROR_PASSPHRASE 11
36 #define ERROR_ENCRYPT 12
37 #define ERROR_DECRYPT 13
38 #define ERROR_FORK 14
39 #define ERROR_UNDEFINED 15
40
41 /* SSL/TLS certificate status for the server. */
42 #define SSL_CERT_OK 0
43 #define SSL_CERT_NONEXISTENT 1
44 #define SSL_CERT_MISMATCH 2
45
46 /* Action to be applied, concerning the SSL/TLS certificate. */
47 #define SSL_CERT_ACTION_ACCEPT 0
48 #define SSL_CERT_ACTION_REJECT 1
49 #define SSL_CERT_ACTION_CONTINUE 0
50 #define SSL_CERT_ACTION_ABORT 1
51
52 /* Flags that control the program's execution options. */
53 #define OPTION_DETAILS_QUIET 0x0001
54 #define OPTION_DETAILS_NORMAL 0x0002
55 #define OPTION_DETAILS_VERBOSE 0x0004
56 #define OPTION_DETAILS_CLEAR 0xfff8
57 #define OPTION_ERRORS 0x0008
58 #define OPTION_EXPUNGE 0x0010
59 #define OPTION_HEADERS 0x0020
60 #define OPTION_NAMESPACE 0x0040
61 #define OPTION_SUBSCRIBE 0x0080
62 #define OPTION_WARNING 0x0100
63 #define OPTION_PASSWORD_EDITOR 0x0200
64 #define OPTION_DAEMON_MODE 0x0400
65
66 /* Other flags. */
67 #define FLAG_DAEMON_MODE 0x01
68 #define FLAG_TTY 0x02
69 #define FLAG_TTY_MODIFIED 0x04
70 #define FLAG_BLANK_PASSWORD 0x08
71 #define FLAG_SIGHUP_RECEIVED 0x10
72
73 /* Capabilities of mail server. */
74 #define CAPABILITY_NONE 0x00
75 #define CAPABILITY_NAMESPACE 0x01
76
77 /* Flags for logger. */
78 #define LOG_PREAMBLE 0
79 #define LOG_ACCOUNT 1
80 #define LOG_MAILBOX 2
81 #define LOG_FILTER 3
82 #define LOG_ACTION 4
83 #define LOG_DESTINATION_ACCOUNT 5
84 #define LOG_DESTINATION_MAILBOX 6
85 #define LOG_HEADER 7
86
87 /* Buffer size of the IMAP command. */
88 #define SMALL_CMD 64
89 #define MEDIUM_CMD 512
90 #define BIG_CMD 32768
91
92 /* Store IMAP command type may replace,add or remove flags. */
93 #define STORE_FLAG_REPLACE 1
94 #define STORE_FLAG_ADD 2
95 #define STORE_FLAG_REMOVE 3
96
97 /* Buffer size of server's response. */
98 #define RESPONSE_BUF 4096
99 #define RESULT_BUF 512
100
101 /* Response codes. */
102 #define RESPONSE_NULLBODY -2
103 #define RESPONSE_NONE -1
104 #define RESPONSE_OK 0
105 #define RESPONSE_NO 1
106 #define RESPONSE_BAD 2
107 #define RESPONSE_BYE 3
108 #define RESPONSE_PREAUTH 4
109 #define RESPONSE_READONLY 5
110 #define RESPONSE_TRYCREATE 6
111
112 /* Size virtual buffer. */
113 #define VIRTUAL_BUF 4096
114
115 /* Authentication mechanisms string. */
116 #define AUTH_MECH_LEN 512
117
118 /* Length of mailbox namespace prefix. */
119 #define NAMESPACE_PREFIX_LEN 64
120
121 /* Encryption and decryption buffers. */
122 #define ENCRYPTION_BUF 1024
123 #define DECRYPTION_BUF 4096
124
125 /* Buffer to save flags of the store IMAP command. */
126 #define STORE_FLAGS_BUF 64
127
128 /* Maximum passwords the password editor can handle. */
129 #define EDITOR_PASSWORDS_MAX 64
130
131 /* Lenght of charset for IMAP SEARCH requests. */
132 #define CHARSET_LEN 64
133
134
135 #define min(A, B) ((A) < (B) ? (A) : (B))
136 #define plural(A) ((A) == 1 ? "" : "s")
137
138
139 /* Secure memory information. */
140 typedef struct secmem {
141 void *buf; /* Allocated memory buffer. */
142 size_t size; /* Size of the buffer. */
143 struct secmem *prev, *next; /* Previous/next node of doubly linked
144 * list. */
145 } secmem_t;
146
147
148 /* Namespace of IMAP mailboxes. */
149 typedef struct namesp {
150 char prefix[NAMESPACE_PREFIX_LEN];
151 char delim;
152 } namesp_t;
153
154
155 /* file.c */
156 int read_config(char *cfg);
157 int parse_config(FILE * fd);
158 void reread_config(char *cfg);
159 void set_options(char *line, regmatch_t * match);
160
161 int read_passwords(void);
162 int parse_passwords(FILE * fd);
163 int store_passwords(account_t * accts[]);
164
165 int create_homedir(void);
166 int exists_file(char *fname);
167 int exists_dir(char *fname);
168 int create_file(char *fname, mode_t mode);
169
170 #ifdef CHECK_PERMISSIONS
171 int check_file_perms(char *fname, mode_t mode);
172 int check_dir_perms(char *dname, mode_t mode);
173
174 #endif
175
176 #ifdef SSL_TLS
177 int imf_ssl_cert(SSL * ssl);
178 int imf_ssl_check_cert(X509 * pcert, unsigned char *pmd, unsigned int *pmdlen);
179 void imf_ssl_print_cert(X509 * cert, unsigned char *md, unsigned int *mdlen);
180 int imf_ssl_new_cert(X509 * cert);
181 int imf_ssl_cert_mismatch(void);
182
183 #endif
184
185 /* imapfilter.c */
186 void usage(void);
187 void version(void);
188
189 /* imap.c */
190 unsigned int send_command(int *sock, char *cmd);
191
192 #ifdef DEBUG
193 int imap_noop(int *sock);
194
195 #endif
196 int imap_capability(int *sock);
197 int imap_namespace(int *sock);
198 int imap_logout(int *sock);
199 int imap_authenticate(int *sock, char *auth);
200 int imap_login(int *sock, char *user, char *pass);
201
202 /* int imap_list(int *sock, char *refer, char *mbox); */
203 int imap_subscribe(int *sock, char *mbox);
204
205 /* int imap_examine(int *sock, char *mbox); */
206 int imap_select(int *sock, char *mbox);
207 int imap_status(int *sock, char *mbox, char *items);
208 int imap_create(int *sock, char *mbox);
209 int imap_search(int *sock, char *charset, char *search);
210 int imap_fetch(int *sock, char *mesg, char *items);
211 int imap_store(int *sock, char *mesg, unsigned int mode, char *flags);
212 int imap_copy(int *sock, char *mesg, char *mbox);
213 int imap_append(int *sock, char *mbox, unsigned int size);
214 int imap_close(int *sock);
215 int imap_expunge(int *sock);
216
217 /* lock.c */
218 void lockfile_create(void);
219 void lockfile_check(void);
220 pid_t lockfile_pid(void);
221 int lockfile_remove(void);
222 void kill_imapfilter(void);
223
224 /* log.c */
225 void info(const char *info,...);
226 void verbose(const char *info,...);
227 void error(const char *errmsg,...);
228 void fatal(unsigned int errnum, const char *fatal,...);
229 void catch_signals(void);
230 void signal_handler(int sig);
231 int open_logfile(void);
232 int create_logfile(void);
233 int close_logfile(void);
234 void log_info(int flag, void *ptr);
235 char *get_time(void);
236
237 /* memory.c */
238 void *xmalloc(size_t size);
239 void *xrealloc(void *ptr, size_t size);
240 void xfree(void *ptr);
241 char *xstrdup(const char *s);
242
243 void *smalloc(size_t size);
244 void *srealloc(void *ptr, size_t size);
245 void sfree(void *ptr);
246 char *sstrdup(const char *s);
247 void secmem_append(secmem_t * node);
248 secmem_t *secmem_find(void *ptr);
249 void secmem_remove(secmem_t * node);
250 void secmem_clear(void);
251
252 #ifdef MEMORY_LOCK
253 void secmem_lock(void);
254
255 #endif
256 void corefile_disable(void);
257
258 /* misc.c */
259 char *strcasestr(const char *haystack, const char *needle);
260 char *ultostr(unsigned long int num, int base);
261 char *xstrncpy(char *dest, const char *src, size_t size);
262
263 /* passwd.c */
264 void get_password(char *passwd, size_t pwlen);
265
266 #ifdef ENCRYPTED_PASSWORDS
267 int encrypt_passwords(FILE * fd, account_t * accts[]);
268 int decrypt_passwords(unsigned char **buf, FILE * fd);
269 void password_editor(void);
270
271 #endif
272
273 /* request.c */
274 int test(int *sock);
275 int check_capabilities(int *sock);
276 int check_namespace(int *sock, namesp_t * nsp);
277 int login(int *sock, char *user, char *pass);
278 int check_mailbox(int *sock, char *mbox);
279 int select_mailbox(int *sock, char *mbox, namesp_t * nsp);
280 int mailbox_status(int *sock, char *mbox, namesp_t * nsp);
281 int close_mailbox(int *sock);
282 int logout(int *sock);
283
284 int apply_filters(char *mbox, filter_t ** filters);
285 int match_filter(filter_t * filter, char **mesgs);
286
287 void empty_fifo(mask_t ** mfifo);
288 void queue_fifo(mask_t ** mfifo, mask_t * mask);
289 mask_t *dequeue_fifo(mask_t ** mfifo);
290
291 char *generate_filter_and(mask_t * mask, unsigned int masknum, unsigned int masklen);
292 char *generate_filter_or(mask_t * mask, unsigned int masknum, unsigned int masklen);
293
294 int apply_action(char *mbox, char *mesgs, unsigned int *type, account_t * raccount, char *destmbox, unsigned int *msgflags, char *args);
295 int action_delete(char *mesgs, char *args);
296 int action_copy(char *mbox, char *mesgs, char *destmbox, char *args);
297 int action_move(char *mbox, char *mesgs, char *destmbox, char *args);
298 int action_rcopy(char *mbox, char *mesgs, account_t * destacc, char *destmbox, char *args);
299 int action_rmove(char *mbox, char *mesgs, account_t * destacc, char *destmbox, char *args);
300 int action_flag(char *mesgs, unsigned int *type, unsigned int *msgflags, char *args);
301 int action_list(char *mesgs, char *args);
302
303 unsigned int count_messages(char *mesgs);
304 char *convert_messages(char *mesgs);
305 int substitute_date(char *str);
306 void current_date(char *destmbox);
307 void message_date(char *mesg, char *destmbox);
308 void default_variables(char *mbox, char *destmbox);
309
310
311 /* response.c */
312 void receive_response(int *sock, char *buf);
313 int server_response(int *sock, unsigned int tag);
314 void bye_response(char *buf);
315 int greeting_response(int *sock);
316 int logout_response(int *sock, unsigned int tag);
317 int capability_response(int *sock, unsigned int tag);
318 void auth_mechanisms(void);
319 int namespace_response(int *sock, unsigned int tag, namesp_t * nsp);
320 int status_response(int *sock, unsigned int tag, char *mbox);
321 int select_response(int *sock, unsigned int tag);
322 int search_response(int *sock, unsigned int tag, char **mesgs);
323 int fetch_response(int *sock, unsigned int tag, int reset, char *fetch);
324 int fetchsize_response(int *sock, unsigned int *size, unsigned int tag);
325 int append_response(int *sock, unsigned int tag);
326 int copy_response(int *sock, unsigned int tag);
327 int analyze_response(int *sock, char *buf);
328 void init_vbuf(void);
329 void reset_vbuf(void);
330 void check_vbuf(size_t n);
331
332 /* socket.c */
333 int init_connection(int *sock, char *serv, unsigned short int port, unsigned int protocol);
334 int init_ssl_connection(int *sock, unsigned int protocol);
335 int close_connection(int *sock);
336 int socket_read(int *sock, char *buf);
337 int socket_write(int *sock, char *data);
338
339 /* tty.c */
340 int tty_store(void);
341 int tty_disable_echo(void);
342 int tty_restore(void);
343
344 #endif /* IMAPFILTER_H */

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26