imapfilter/imapfilter/imapfilter.h

#ifndef IMAPFILTER_H
#define IMAPFILTER_H

#include <stdio.h>
#include <unistd.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <dirent.h>

#ifndef DATA_H
#include "data.h"
#endif

/* Error codes returned by functions. */
#define ERROR_SIGNAL                    1
#define ERROR_TRIVIAL                   2
#define ERROR_FILE_OPEN                 3
#define ERROR_LOCKFILE                  4
#define ERROR_CONFIG_PARSE              5
#define ERROR_MEMORY_ALLOCATION         6
#define ERROR_SETUID                    7
#define ERROR_TERMIO                    8
#define ERROR_NETWORK                   9
#define ERROR_SSL                       10
#define ERROR_PASSPHRASE                11
#define ERROR_ENCRYPT                   12
#define ERROR_DECRYPT                   13
#define ERROR_FORK                      14
#define ERROR_UNDEFINED                 15

/* Flags that control the program's execution options. */
#define OPTION_DETAILS_QUIET            0x01
#define OPTION_DETAILS_NORMAL           0x02
#define OPTION_DETAILS_VERBOSE          0x04
#define OPTION_DETAILS_CLEAR            0xf8
#define OPTION_HEADERS                  0x08
#define OPTION_NAMESPACE                0x10
#define OPTION_PASSWORD_EDITOR          0x20
#define OPTION_DAEMON_MODE              0x40

/* Other flags. */
#define FLAG_TTY_MODIFIED               0x01
#define FLAG_BLANK_PASSWORD             0x02

/* Capabilities of mail server. */
#define CAPABILITY_NONE                 0x00
#define CAPABILITY_NAMESPACE            0x01

/* Flags for logger. */
#define LOG_WRITE                       0
#define LOG_SERVER                      1
#define LOG_USERNAME                    2
#define LOG_MAILBOX                     3
#define LOG_FILTER                      4
#define LOG_ACTION                      5
#define LOG_DESTINATION_MAILBOX         6

/* Buffer size of the IMAP command. */
#define SMALL_CMD                       64
#define MEDIUM_CMD                      512
#define BIG_CMD                         32768

/* Buffer size of server's response. */
#define RESPONSE_BUF                    (4096 + 1)
#define RESULT_BUF                      512

/* Response codes. */
#define RESPONSE_NONE                   -2
#define RESPONSE_BAD                    -1
#define RESPONSE_OK                     0
#define RESPONSE_NO                     1
#define RESPONSE_BYE                    2
#define RESPONSE_PREAUTH                3
#define RESPONSE_READONLY               4
#define RESPONSE_TRYCREATE              5

/* Buffer size of message's headers. */
#define HEADERS_BUF                     16384

/* Length of mailbox namespace prefix. */
#define NAMESPACE_PREFIX_LEN            64

/* Encryption and decryption buffers. */
#define ENCRYPTION_BUF                  1024
#define DECRYPTION_BUF                  4096

/* Maximum passwords the password editor can handle. */
#define EDITOR_PASSWORDS_MAX            64


#define min(A, B)                       ((A) < (B) ? (A) : (B))
#define plural(A)                       ((A) == 1 ? "" : "s")


/* Secure memory information. */
typedef struct secmem {
    void *buf;                  /* Allocated memory buffer. */
    size_t size;                /* Size of the buffer. */
    struct secmem *prev, *next; /* Previous/next node of doubly linked list. */
} secmem_t;


/* Namespace of IMAP mailboxes. */
typedef struct namesp {
    char prefix[NAMESPACE_PREFIX_LEN];
    char delim;
} namesp_t;


/*      file.c          */
int read_config(char *cfg);
int parse_config(FILE * fd);
void set_options(char *line, regmatch_t * match);

int read_passwords(void);
int parse_passwords(FILE * fd);
int store_passwords(account_t * accts[]);

int create_homedir(void);
int exists_file(char *fname);
int exists_dir(char *fname);
int create_file(char *fname, mode_t mode);
#ifdef CHECK_PERMISSIONS
int check_file_perms(char *fname, mode_t mode);
int check_dir_perms(char *dname, mode_t mode);
#endif

/*      imapfilter.c    */
void usage(void);

/*      imap.c          */
unsigned int send_command(int *sock, char *cmd);
#ifdef DEBUG
int imap_noop(int *sock);
#endif
int imap_capability(int *sock);
int imap_namespace(int *sock);
int imap_logout(int *sock);
int imap_login(int *sock, char *user, char *pass);
/* int imap_list(int *sock, char *refer, char *mbox); */
int imap_subscribe(int *sock, char *mbox);
int imap_examine(int *sock, char *mbox);
int imap_select(int *sock, char *mbox);
int imap_status(int *sock, char *mbox, char *items);
int imap_create(int *sock, char *mbox);
int imap_search(int *sock, char *search);
int imap_fetch(int *sock, char *mesg, char *items);
int imap_store(int *sock, char *mesg, char *flags);
int imap_copy(int *sock, char *mesg, char *mbox);
int imap_append(int *sock, char *mbox, unsigned int size);
int imap_close(int *sock);
/* int imap_expunge(int *sock); */

/*      lock.c          */
void lockfile_create(void);
void lockfile_check(void);
pid_t lockfile_pid(void);
int lockfile_remove(void);
void kill_imapfilter(void);

/*      log.c           */
void info(const char *info,...);
void verbose(const char *info,...);
void error(const char *errmsg,...);
void fatal(unsigned int errnum, const char *fatal,...);
void catch_signals(void);
void signal_handler(int sig);
int open_logfile(void);
int create_logfile(void);
int close_logfile(void);
void log_info(int flag, void *ptr);
char *get_time(void);

/*      memory.c        */
void *xmalloc(size_t size);
void *xrealloc(void *ptr, size_t size);
void xfree(void *ptr);
char *xstrdup(const char *s);

void *smalloc(size_t size);
void *srealloc(void *ptr, size_t size);
void sfree(void *ptr);
char *sstrdup(const char *s);
void secmem_append(secmem_t *node);
secmem_t *secmem_find(void *ptr);
void secmem_remove(secmem_t *node);
void secmem_clear(void);
void secmem_lock(void);

void corefile_disable(void);

/*      misc.c          */
char *strcasestr(const char *haystack, const char *needle);
char *ultostr(unsigned long int num, int base);
char *xstrncpy(char *dest, const char *src, size_t size);

/*      passwd.c        */
void get_password(char *passwd, size_t pwlen);
#ifdef ENCRYPTED_PASSWORDS
int encrypt_passwords(FILE *fd, account_t *accts[]); 
int decrypt_passwords(unsigned char **buf, FILE *fd);
void password_editor(void);
#endif

/*      request.c       */
int test(int *sock);
int check_capabilities(int *sock);
int check_namespace(int *sock, namesp_t *nsp);
int login(int *sock, char *user, char *pass);
int check_mailbox(int *sock, char *mbox, namesp_t *nsp);
int select_mailbox(int *sock, char *mbox, namesp_t *nsp);
int mailbox_status(int *sock, char *mbox, namesp_t *nsp);
int close_mailbox(int *sock);
int logout(int *sock);

int apply_filters(filter_t ** filters);
int match_filter(filter_t * filter, char **mesgs);

void empty_fifo(mask_t ** mfifo);
void queue_fifo(mask_t ** mfifo, mask_t * mask);
mask_t *dequeue_fifo(mask_t ** mfifo);

char *generate_filter_and(mask_t * mask, unsigned int masknum,
                          unsigned int masklen);
char *generate_filter_or(mask_t * mask, unsigned int masknum,
                         unsigned int masklen);

int apply_action(char *mesgs, unsigned int *type, account_t *raccount,
                 char *destmbox, char *args);
int action_delete(char *mesgs, char *args);
int action_copy(char *mesgs, char *destmbox, char *args);
int action_move(char *mesgs, char *destmbox, char *args);
int action_rcopy(char *mesgs, account_t *destacc, char *destmbox, char *args);
int action_rmove(char *mesgs, account_t *destacc, char *destmbox, char *args);
int action_list(char *mesgs, char *args);

unsigned int count_messages(char *mesgs);
char *convert_messages(char *mesgs);


/*      response.c      */
void receive_response(int *sock, char *buf);
int server_response(int *sock, unsigned int tag);
int greeting_response(int *sock);
int capability_response(int *sock, unsigned int tag);
int namespace_response(int *sock, unsigned int tag, namesp_t *nsp);
int status_response(int *sock, unsigned int tag, char *mbox);
int select_response(int *sock, unsigned int tag);
int search_response(int *sock, unsigned int tag, char **mesgs);
int fetch_response(int *sock, int reset, char *fetch, unsigned int tag);
int fetchsize_response(int *sock, unsigned int *size, unsigned int tag);
int append_response(int *sock, unsigned int tag);
int copy_response(int *sock, unsigned int tag);
int analyze_response(char *buf);
void init_vbuf(void);
void reset_vbuf(void);
void check_vbuf(size_t n);

/*      socket.c        */
int init_connection(int *sock, char *serv, unsigned short int port,
                    unsigned int protocol);
int ssl_init(int *sock, unsigned int protocol);
int close_connection(int *sock);
int socket_read(int *sock, char *buf);
int socket_write(int *sock, char *data);

/*      tty.c           */
int tty_store(void);
int tty_disable_echo(void);
int tty_restore(void);

#endif                          /* IMAPFILTER_H */
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			#ifndef DATA_H
11			#include "data.h"
12			#endif
13
14	lefcha	1.11	/* Error codes returned by functions. */
15	lefcha	1.22	#define ERROR_SIGNAL 1
16			#define ERROR_TRIVIAL 2
17			#define ERROR_FILE_OPEN 3
18	lefcha	1.32	#define ERROR_LOCKFILE 4
19	lefcha	1.29	#define ERROR_CONFIG_PARSE 5
20			#define ERROR_MEMORY_ALLOCATION 6
21			#define ERROR_SETUID 7
22			#define ERROR_TERMIO 8
23			#define ERROR_NETWORK 9
24			#define ERROR_SSL 10
25			#define ERROR_PASSPHRASE 11
26			#define ERROR_ENCRYPT 12
27			#define ERROR_DECRYPT 13
28	lefcha	1.30	#define ERROR_FORK 14
29			#define ERROR_UNDEFINED 15
30	lefcha	1.9
31	lefcha	1.30	/* Flags that control the program's execution options. */
32	lefcha	1.16	#define OPTION_DETAILS_QUIET 0x01
33	lefcha	1.9	#define OPTION_DETAILS_NORMAL 0x02
34			#define OPTION_DETAILS_VERBOSE 0x04
35			#define OPTION_DETAILS_CLEAR 0xf8
36	lefcha	1.14	#define OPTION_HEADERS 0x08
37	lefcha	1.25	#define OPTION_NAMESPACE 0x10
38	lefcha	1.26	#define OPTION_PASSWORD_EDITOR 0x20
39	lefcha	1.30	#define OPTION_DAEMON_MODE 0x40
40
41			/* Other flags. */
42	lefcha	1.32	#define FLAG_TTY_MODIFIED 0x01
43			#define FLAG_BLANK_PASSWORD 0x02
44	lefcha	1.25
45			/* Capabilities of mail server. */
46			#define CAPABILITY_NONE 0x00
47			#define CAPABILITY_NAMESPACE 0x01
48	lefcha	1.9
49	lefcha	1.12	/* Flags for logger. */
50			#define LOG_WRITE 0
51			#define LOG_SERVER 1
52			#define LOG_USERNAME 2
53			#define LOG_MAILBOX 3
54			#define LOG_FILTER 4
55			#define LOG_ACTION 5
56			#define LOG_DESTINATION_MAILBOX 6
57
58	lefcha	1.17	/* Buffer size of the IMAP command. */
59	lefcha	1.9	#define SMALL_CMD 64
60	lefcha	1.32	#define MEDIUM_CMD 512
61			#define BIG_CMD 32768
62	lefcha	1.9
63			/* Buffer size of server's response. */
64	lefcha	1.21	#define RESPONSE_BUF (4096 + 1)
65	lefcha	1.20	#define RESULT_BUF 512
66	lefcha	1.9
67	lefcha	1.16	/* Response codes. */
68	lefcha	1.32	#define RESPONSE_NONE -2
69	lefcha	1.16	#define RESPONSE_BAD -1
70			#define RESPONSE_OK 0
71			#define RESPONSE_NO 1
72			#define RESPONSE_BYE 2
73	lefcha	1.20	#define RESPONSE_PREAUTH 3
74			#define RESPONSE_READONLY 4
75			#define RESPONSE_TRYCREATE 5
76	lefcha	1.16
77	lefcha	1.9	/* Buffer size of message's headers. */
78	lefcha	1.19	#define HEADERS_BUF 16384
79	lefcha	1.9
80	lefcha	1.25	/* Length of mailbox namespace prefix. */
81			#define NAMESPACE_PREFIX_LEN 64
82
83	lefcha	1.26	/* Encryption and decryption buffers. */
84			#define ENCRYPTION_BUF 1024
85			#define DECRYPTION_BUF 4096
86
87	lefcha	1.27	/* Maximum passwords the password editor can handle. */
88	lefcha	1.32	#define EDITOR_PASSWORDS_MAX 64
89	lefcha	1.27
90	lefcha	1.1
91			#define min(A, B) ((A) < (B) ? (A) : (B))
92	lefcha	1.15	#define plural(A) ((A) == 1 ? "" : "s")
93	lefcha	1.1
94
95	lefcha	1.27	/* Secure memory information. */
96			typedef struct secmem {
97			void buf; / Allocated memory buffer. */
98			size_t size; /* Size of the buffer. */
99			struct secmem prev, next; /* Previous/next node of doubly linked list. */
100			} secmem_t;
101
102
103	lefcha	1.32	/* Namespace of IMAP mailboxes. */
104			typedef struct namesp {
105			char prefix[NAMESPACE_PREFIX_LEN];
106			char delim;
107			} namesp_t;
108
109
110	lefcha	1.9	/* file.c */
111	lefcha	1.27	int read_config(char *cfg);
112			int parse_config(FILE * fd);
113			void set_options(char line, regmatch_t match);
114
115			int read_passwords(void);
116			int parse_passwords(FILE * fd);
117			int store_passwords(account_t * accts[]);
118
119	lefcha	1.25	int create_homedir(void);
120	lefcha	1.26	int exists_file(char *fname);
121			int exists_dir(char *fname);
122	lefcha	1.25	int create_file(char *fname, mode_t mode);
123	lefcha	1.9	#ifdef CHECK_PERMISSIONS
124	lefcha	1.25	int check_file_perms(char *fname, mode_t mode);
125			int check_dir_perms(char *dname, mode_t mode);
126	lefcha	1.9	#endif
127	lefcha	1.1
128	lefcha	1.9	/* imapfilter.c */
129			void usage(void);
130	lefcha	1.1
131	lefcha	1.9	/* imap.c */
132	lefcha	1.32	unsigned int send_command(int sock, char cmd);
133	lefcha	1.9	#ifdef DEBUG
134	lefcha	1.32	int imap_noop(int *sock);
135	lefcha	1.9	#endif
136	lefcha	1.32	int imap_capability(int *sock);
137			int imap_namespace(int *sock);
138			int imap_logout(int *sock);
139			int imap_login(int sock, char user, char *pass);
140			/* int imap_list(int sock, char refer, char mbox); /
141			int imap_subscribe(int sock, char mbox);
142			int imap_examine(int sock, char mbox);
143			int imap_select(int sock, char mbox);
144			int imap_status(int sock, char mbox, char *items);
145			int imap_create(int sock, char mbox);
146			int imap_search(int sock, char search);
147			int imap_fetch(int sock, char mesg, char *items);
148			int imap_store(int sock, char mesg, char *flags);
149			int imap_copy(int sock, char mesg, char *mbox);
150			int imap_append(int sock, char mbox, unsigned int size);
151			int imap_close(int *sock);
152			/* int imap_expunge(int sock); /
153	lefcha	1.29
154			/* lock.c */
155			void lockfile_create(void);
156			void lockfile_check(void);
157	lefcha	1.30	pid_t lockfile_pid(void);
158	lefcha	1.29	int lockfile_remove(void);
159	lefcha	1.30	void kill_imapfilter(void);
160	lefcha	1.9
161			/* log.c */
162	lefcha	1.13	void info(const char *info,...);
163			void verbose(const char *info,...);
164			void error(const char *errmsg,...);
165			void fatal(unsigned int errnum, const char *fatal,...);
166	lefcha	1.22	void catch_signals(void);
167			void signal_handler(int sig);
168	lefcha	1.9	int open_logfile(void);
169			int create_logfile(void);
170			int close_logfile(void);
171	lefcha	1.12	void log_info(int flag, void *ptr);
172	lefcha	1.11	char *get_time(void);
173	lefcha	1.9
174	lefcha	1.13	/* memory.c */
175			void *xmalloc(size_t size);
176	lefcha	1.19	void xrealloc(void ptr, size_t size);
177	lefcha	1.26	void xfree(void *ptr);
178	lefcha	1.13	char xstrdup(const char s);
179
180	lefcha	1.27	void *smalloc(size_t size);
181			void srealloc(void ptr, size_t size);
182			void sfree(void *ptr);
183			char sstrdup(const char s);
184			void secmem_append(secmem_t *node);
185			secmem_t secmem_find(void ptr);
186			void secmem_remove(secmem_t *node);
187			void secmem_clear(void);
188	lefcha	1.30	void secmem_lock(void);
189	lefcha	1.27
190			void corefile_disable(void);
191
192	lefcha	1.16	/* misc.c */
193			char strcasestr(const char haystack, const char *needle);
194			char *ultostr(unsigned long int num, int base);
195	lefcha	1.24	char xstrncpy(char dest, const char *src, size_t size);
196	lefcha	1.16
197	lefcha	1.25	/* passwd.c */
198	lefcha	1.26	void get_password(char *passwd, size_t pwlen);
199			#ifdef ENCRYPTED_PASSWORDS
200			int encrypt_passwords(FILE fd, account_t accts[]);
201	lefcha	1.27	int decrypt_passwords(unsigned char *buf, FILE fd);
202	lefcha	1.26	void password_editor(void);
203			#endif
204	lefcha	1.25
205	lefcha	1.9	/* request.c */
206	lefcha	1.32	int test(int *sock);
207			int check_capabilities(int *sock);
208			int check_namespace(int sock, namesp_t nsp);
209			int login(int sock, char user, char *pass);
210			int check_mailbox(int sock, char mbox, namesp_t *nsp);
211			int select_mailbox(int sock, char mbox, namesp_t *nsp);
212			int mailbox_status(int sock, char mbox, namesp_t *nsp);
213			int close_mailbox(int *sock);
214			int logout(int *sock);
215	lefcha	1.9
216	lefcha	1.16	int apply_filters(filter_t ** filters);
217	lefcha	1.19	int match_filter(filter_t * filter, char **mesgs);
218	lefcha	1.9
219			void empty_fifo(mask_t ** mfifo);
220	lefcha	1.11	void queue_fifo(mask_t ** mfifo, mask_t * mask);
221			mask_t dequeue_fifo(mask_t * mfifo);
222	lefcha	1.9
223	lefcha	1.32	char generate_filter_and(mask_t mask, unsigned int masknum,
224			unsigned int masklen);
225			char generate_filter_or(mask_t mask, unsigned int masknum,
226			unsigned int masklen);
227	lefcha	1.9
228	lefcha	1.32	int apply_action(char mesgs, unsigned int type, account_t *raccount,
229			char destmbox, char args);
230	lefcha	1.9	int action_delete(char mesgs, char args);
231	lefcha	1.11	int action_copy(char mesgs, char destmbox, char *args);
232			int action_move(char mesgs, char destmbox, char *args);
233	lefcha	1.32	int action_rcopy(char mesgs, account_t destacc, char destmbox, char args);
234			int action_rmove(char mesgs, account_t destacc, char destmbox, char args);
235	lefcha	1.11	int action_list(char mesgs, char args);
236	lefcha	1.9
237	lefcha	1.32	unsigned int count_messages(char *mesgs);
238	lefcha	1.33	char convert_messages(char mesgs);
239	lefcha	1.32
240	lefcha	1.9
241	lefcha	1.11	/* response.c */
242	lefcha	1.32	void receive_response(int sock, char buf);
243			int server_response(int *sock, unsigned int tag);
244			int greeting_response(int *sock);
245			int capability_response(int *sock, unsigned int tag);
246			int namespace_response(int sock, unsigned int tag, namesp_t nsp);
247			int status_response(int sock, unsigned int tag, char mbox);
248			int select_response(int *sock, unsigned int tag);
249			int search_response(int sock, unsigned int tag, char *mesgs);
250			int fetch_response(int sock, int reset, char fetch, unsigned int tag);
251			int fetchsize_response(int sock, unsigned int size, unsigned int tag);
252			int append_response(int *sock, unsigned int tag);
253			int copy_response(int *sock, unsigned int tag);
254	lefcha	1.20	int analyze_response(char *buf);
255	lefcha	1.32	void init_vbuf(void);
256			void reset_vbuf(void);
257			void check_vbuf(size_t n);
258	lefcha	1.25
259			/* socket.c */
260	lefcha	1.32	int init_connection(int sock, char serv, unsigned short int port,
261	lefcha	1.31	unsigned int protocol);
262	lefcha	1.32	int ssl_init(int *sock, unsigned int protocol);
263			int close_connection(int *sock);
264			int socket_read(int sock, char buf);
265			int socket_write(int sock, char data);
266	lefcha	1.25
267			/* tty.c */
268			int tty_store(void);
269			int tty_disable_echo(void);
270			int tty_restore(void);
271	lefcha	1.11
272	lefcha	1.13	#endif /* IMAPFILTER_H */