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

Annotation of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.64 - (hide annotations)
Sun Jul 27 17:39:45 2003 UTC (20 years, 8 months ago) by lefcha
Branch: MAIN
Changes since 1.63: +65 -57 lines
File MIME type: text/plain
New structure to hold information about connection's socket, ssl socket, capabilities, namespace.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26