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

Annotation of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.55 - (hide annotations)
Fri Mar 28 17:01:29 2003 UTC (21 years ago) by lefcha
Branch: MAIN
Changes since 1.54: +4 -3 lines
File MIME type: text/plain
Corrected bug with long headers and action list.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26