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

Contents of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.59 - (show annotations)
Sun May 25 12:11:10 2003 UTC (20 years, 10 months ago) by lefcha
Branch: MAIN
Changes since 1.58: +1 -1 lines
File MIME type: text/plain
Updated for 0.8.8.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26