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

Contents of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.62 - (show annotations)
Sun Jul 27 10:08:42 2003 UTC (20 years, 8 months ago) by lefcha
Branch: MAIN
Changes since 1.61: +19 -4 lines
File MIME type: text/plain
Added STARTTLS support.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26