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

Annotation of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.57 - (hide annotations)
Mon May 19 22:38:15 2003 UTC (20 years, 11 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 lefcha 1.9 #ifndef IMAPFILTER_H
2     #define IMAPFILTER_H
3    
4     #include <stdio.h>
5 lefcha 1.25 #include <unistd.h>
6     #include <sys/stat.h>
7     #include <sys/types.h>
8 lefcha 1.29 #include <dirent.h>
9 lefcha 1.9
10 lefcha 1.54 #include "config.h"
11    
12     #ifdef SSL_TLS
13     #include <openssl/ssl.h>
14     #include <openssl/x509.h>
15     #endif
16    
17 lefcha 1.9 #ifndef DATA_H
18     #include "data.h"
19     #endif
20    
21 lefcha 1.43 /* Program's version number. */
22 lefcha 1.56 #define IMAPFILTER_VERSION "0.8.7"
23 lefcha 1.43
24 lefcha 1.11 /* Error codes returned by functions. */
25 lefcha 1.22 #define ERROR_SIGNAL 1
26     #define ERROR_TRIVIAL 2
27     #define ERROR_FILE_OPEN 3
28 lefcha 1.32 #define ERROR_LOCKFILE 4
29 lefcha 1.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 lefcha 1.30 #define ERROR_FORK 14
39     #define ERROR_UNDEFINED 15
40 lefcha 1.9
41 lefcha 1.54 /* 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 lefcha 1.30 /* Flags that control the program's execution options. */
53 lefcha 1.36 #define OPTION_DETAILS_QUIET 0x0001
54     #define OPTION_DETAILS_NORMAL 0x0002
55     #define OPTION_DETAILS_VERBOSE 0x0004
56     #define OPTION_DETAILS_CLEAR 0xfff8
57 lefcha 1.38 #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 lefcha 1.30
66     /* Other flags. */
67 lefcha 1.54 #define FLAG_DAEMON_MODE 0x01
68     #define FLAG_TTY 0x02
69     #define FLAG_TTY_MODIFIED 0x04
70     #define FLAG_BLANK_PASSWORD 0x08
71 lefcha 1.57 #define FLAG_SIGHUP_RECEIVED 0x10
72 lefcha 1.25
73     /* Capabilities of mail server. */
74     #define CAPABILITY_NONE 0x00
75     #define CAPABILITY_NAMESPACE 0x01
76 lefcha 1.9
77 lefcha 1.12 /* Flags for logger. */
78 lefcha 1.55 #define LOG_PREAMBLE 0
79 lefcha 1.49 #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 lefcha 1.12 #define LOG_DESTINATION_MAILBOX 6
85 lefcha 1.55 #define LOG_HEADER 7
86 lefcha 1.12
87 lefcha 1.17 /* Buffer size of the IMAP command. */
88 lefcha 1.9 #define SMALL_CMD 64
89 lefcha 1.32 #define MEDIUM_CMD 512
90     #define BIG_CMD 32768
91 lefcha 1.9
92 lefcha 1.35 /* 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 lefcha 1.9 /* Buffer size of server's response. */
98 lefcha 1.55 #define RESPONSE_BUF 4096
99 lefcha 1.20 #define RESULT_BUF 512
100 lefcha 1.9
101 lefcha 1.16 /* Response codes. */
102 lefcha 1.44 #define RESPONSE_NULLBODY -2
103     #define RESPONSE_NONE -1
104 lefcha 1.16 #define RESPONSE_OK 0
105     #define RESPONSE_NO 1
106 lefcha 1.44 #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 lefcha 1.16
112 lefcha 1.39 /* Size virtual buffer. */
113     #define VIRTUAL_BUF 4096
114 lefcha 1.9
115 lefcha 1.48 /* Authentication mechanisms string. */
116     #define AUTH_MECH_LEN 512
117    
118 lefcha 1.25 /* Length of mailbox namespace prefix. */
119     #define NAMESPACE_PREFIX_LEN 64
120    
121 lefcha 1.26 /* Encryption and decryption buffers. */
122     #define ENCRYPTION_BUF 1024
123     #define DECRYPTION_BUF 4096
124    
125 lefcha 1.35 /* Buffer to save flags of the store IMAP command. */
126     #define STORE_FLAGS_BUF 64
127    
128 lefcha 1.27 /* Maximum passwords the password editor can handle. */
129 lefcha 1.32 #define EDITOR_PASSWORDS_MAX 64
130 lefcha 1.27
131 lefcha 1.47 /* Lenght of charset for IMAP SEARCH requests. */
132     #define CHARSET_LEN 64
133    
134 lefcha 1.1
135     #define min(A, B) ((A) < (B) ? (A) : (B))
136 lefcha 1.15 #define plural(A) ((A) == 1 ? "" : "s")
137 lefcha 1.1
138    
139 lefcha 1.27 /* Secure memory information. */
140     typedef struct secmem {
141 lefcha 1.49 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 lefcha 1.27 } secmem_t;
146    
147    
148 lefcha 1.32 /* Namespace of IMAP mailboxes. */
149     typedef struct namesp {
150 lefcha 1.49 char prefix[NAMESPACE_PREFIX_LEN];
151     char delim;
152 lefcha 1.32 } namesp_t;
153    
154    
155 lefcha 1.9 /* file.c */
156 lefcha 1.27 int read_config(char *cfg);
157     int parse_config(FILE * fd);
158 lefcha 1.57 void reread_config(char *cfg);
159 lefcha 1.27 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 lefcha 1.25 int create_homedir(void);
166 lefcha 1.26 int exists_file(char *fname);
167     int exists_dir(char *fname);
168 lefcha 1.25 int create_file(char *fname, mode_t mode);
169 lefcha 1.49
170 lefcha 1.9 #ifdef CHECK_PERMISSIONS
171 lefcha 1.25 int check_file_perms(char *fname, mode_t mode);
172     int check_dir_perms(char *dname, mode_t mode);
173 lefcha 1.49
174 lefcha 1.9 #endif
175 lefcha 1.1
176 lefcha 1.54 #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 lefcha 1.9 /* imapfilter.c */
186     void usage(void);
187 lefcha 1.43 void version(void);
188 lefcha 1.1
189 lefcha 1.9 /* imap.c */
190 lefcha 1.32 unsigned int send_command(int *sock, char *cmd);
191 lefcha 1.49
192 lefcha 1.9 #ifdef DEBUG
193 lefcha 1.32 int imap_noop(int *sock);
194 lefcha 1.49
195 lefcha 1.9 #endif
196 lefcha 1.32 int imap_capability(int *sock);
197     int imap_namespace(int *sock);
198     int imap_logout(int *sock);
199 lefcha 1.48 int imap_authenticate(int *sock, char *auth);
200 lefcha 1.32 int imap_login(int *sock, char *user, char *pass);
201 lefcha 1.49
202 lefcha 1.32 /* int imap_list(int *sock, char *refer, char *mbox); */
203     int imap_subscribe(int *sock, char *mbox);
204 lefcha 1.54
205     /* int imap_examine(int *sock, char *mbox); */
206 lefcha 1.32 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 lefcha 1.47 int imap_search(int *sock, char *charset, char *search);
210 lefcha 1.32 int imap_fetch(int *sock, char *mesg, char *items);
211 lefcha 1.35 int imap_store(int *sock, char *mesg, unsigned int mode, char *flags);
212 lefcha 1.32 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 lefcha 1.34 int imap_expunge(int *sock);
216 lefcha 1.29
217     /* lock.c */
218     void lockfile_create(void);
219     void lockfile_check(void);
220 lefcha 1.30 pid_t lockfile_pid(void);
221 lefcha 1.29 int lockfile_remove(void);
222 lefcha 1.30 void kill_imapfilter(void);
223 lefcha 1.9
224     /* log.c */
225 lefcha 1.13 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 lefcha 1.22 void catch_signals(void);
230     void signal_handler(int sig);
231 lefcha 1.9 int open_logfile(void);
232     int create_logfile(void);
233     int close_logfile(void);
234 lefcha 1.12 void log_info(int flag, void *ptr);
235 lefcha 1.11 char *get_time(void);
236 lefcha 1.9
237 lefcha 1.13 /* memory.c */
238     void *xmalloc(size_t size);
239 lefcha 1.19 void *xrealloc(void *ptr, size_t size);
240 lefcha 1.26 void xfree(void *ptr);
241 lefcha 1.13 char *xstrdup(const char *s);
242    
243 lefcha 1.27 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 lefcha 1.34 void secmem_append(secmem_t * node);
248 lefcha 1.27 secmem_t *secmem_find(void *ptr);
249 lefcha 1.34 void secmem_remove(secmem_t * node);
250 lefcha 1.27 void secmem_clear(void);
251 lefcha 1.49
252 lefcha 1.41 #ifdef MEMORY_LOCK
253 lefcha 1.30 void secmem_lock(void);
254 lefcha 1.49
255 lefcha 1.41 #endif
256 lefcha 1.27 void corefile_disable(void);
257    
258 lefcha 1.16 /* misc.c */
259     char *strcasestr(const char *haystack, const char *needle);
260     char *ultostr(unsigned long int num, int base);
261 lefcha 1.24 char *xstrncpy(char *dest, const char *src, size_t size);
262 lefcha 1.16
263 lefcha 1.25 /* passwd.c */
264 lefcha 1.26 void get_password(char *passwd, size_t pwlen);
265 lefcha 1.49
266 lefcha 1.26 #ifdef ENCRYPTED_PASSWORDS
267 lefcha 1.34 int encrypt_passwords(FILE * fd, account_t * accts[]);
268     int decrypt_passwords(unsigned char **buf, FILE * fd);
269 lefcha 1.26 void password_editor(void);
270 lefcha 1.49
271 lefcha 1.26 #endif
272 lefcha 1.25
273 lefcha 1.9 /* request.c */
274 lefcha 1.32 int test(int *sock);
275     int check_capabilities(int *sock);
276 lefcha 1.34 int check_namespace(int *sock, namesp_t * nsp);
277 lefcha 1.32 int login(int *sock, char *user, char *pass);
278 lefcha 1.51 int check_mailbox(int *sock, char *mbox);
279 lefcha 1.34 int select_mailbox(int *sock, char *mbox, namesp_t * nsp);
280     int mailbox_status(int *sock, char *mbox, namesp_t * nsp);
281 lefcha 1.32 int close_mailbox(int *sock);
282     int logout(int *sock);
283 lefcha 1.9
284 lefcha 1.53 int apply_filters(char *mbox, filter_t ** filters);
285 lefcha 1.19 int match_filter(filter_t * filter, char **mesgs);
286 lefcha 1.9
287     void empty_fifo(mask_t ** mfifo);
288 lefcha 1.11 void queue_fifo(mask_t ** mfifo, mask_t * mask);
289     mask_t *dequeue_fifo(mask_t ** mfifo);
290 lefcha 1.9
291 lefcha 1.49 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 lefcha 1.9
294 lefcha 1.53 int apply_action(char *mbox, char *mesgs, unsigned int *type, account_t * raccount, char *destmbox, unsigned int *msgflags, char *args);
295 lefcha 1.9 int action_delete(char *mesgs, char *args);
296 lefcha 1.53 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 lefcha 1.35 int action_flag(char *mesgs, unsigned int *type, unsigned int *msgflags, char *args);
301 lefcha 1.11 int action_list(char *mesgs, char *args);
302 lefcha 1.9
303 lefcha 1.32 unsigned int count_messages(char *mesgs);
304 lefcha 1.33 char *convert_messages(char *mesgs);
305 lefcha 1.50 int substitute_date(char *str);
306     void current_date(char *destmbox);
307     void message_date(char *mesg, char *destmbox);
308 lefcha 1.53 void default_variables(char *mbox, char *destmbox);
309 lefcha 1.32
310 lefcha 1.9
311 lefcha 1.11 /* response.c */
312 lefcha 1.32 void receive_response(int *sock, char *buf);
313     int server_response(int *sock, unsigned int tag);
314 lefcha 1.40 void bye_response(char *buf);
315 lefcha 1.32 int greeting_response(int *sock);
316 lefcha 1.39 int logout_response(int *sock, unsigned int tag);
317 lefcha 1.32 int capability_response(int *sock, unsigned int tag);
318 lefcha 1.48 void auth_mechanisms(void);
319 lefcha 1.34 int namespace_response(int *sock, unsigned int tag, namesp_t * nsp);
320 lefcha 1.32 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 lefcha 1.43 int fetch_response(int *sock, unsigned int tag, int reset, char *fetch);
324 lefcha 1.32 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 lefcha 1.55 int analyze_response(int *sock, char *buf);
328 lefcha 1.32 void init_vbuf(void);
329     void reset_vbuf(void);
330     void check_vbuf(size_t n);
331 lefcha 1.25
332     /* socket.c */
333 lefcha 1.49 int init_connection(int *sock, char *serv, unsigned short int port, unsigned int protocol);
334 lefcha 1.54 int init_ssl_connection(int *sock, unsigned int protocol);
335 lefcha 1.32 int close_connection(int *sock);
336     int socket_read(int *sock, char *buf);
337     int socket_write(int *sock, char *data);
338 lefcha 1.25
339     /* tty.c */
340     int tty_store(void);
341     int tty_disable_echo(void);
342     int tty_restore(void);
343 lefcha 1.11
344 lefcha 1.13 #endif /* IMAPFILTER_H */

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26