imapfilter/imapfilter/imapfilter.h

#ifndef IMAPFILTER_H
#define IMAPFILTER_H


#include <stdio.h>
#include <sys/types.h>

#include "config.h"
#include "account.h"
#include "filter.h"

#ifdef SSL_TLS
#include <openssl/ssl.h>
#endif


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

/* SSL/TLS certificate status for the server. */
#define SSL_CERT_OK                     0
#define SSL_CERT_NONEXISTENT            1
#define SSL_CERT_MISMATCH               2

/* Action to be applied, concerning the SSL/TLS certificate. */
#define SSL_CERT_ACTION_ACCEPT          0
#define SSL_CERT_ACTION_REJECT          1
#define SSL_CERT_ACTION_CONTINUE        0
#define SSL_CERT_ACTION_ABORT           1

/* Flags that control the program's execution options. */
#define OPTION_DEBUG                    0x0001
#define OPTION_ERRORS                   0x0002
#define OPTION_EXPUNGE                  0x0004
#define OPTION_HEADERS                  0x0008
#define OPTION_NAMESPACE                0x0010
#define OPTION_SUBSCRIBE                0x0020
#define OPTION_PASSWORD_EDITOR          0x0040
#define OPTION_DAEMON_MODE              0x0080
#define OPTION_PEEK                     0x0100

/* Other flags. */
#define FLAG_DAEMON_MODE                0x01
#define FLAG_TTY                        0x02
#define FLAG_TTY_MODIFIED               0x04
#define FLAG_BLANK_PASSWORD             0x08
#define FLAG_SIGUSR1_RECEIVED           0x10

/* Capabilities of mail server. */
#define CAPABILITY_NONE                 0x00
#define CAPABILITY_NAMESPACE            0x01
#define CAPABILITY_AUTH_CRAM_MD5        0x02
#define CAPABILITY_STARTTLS             0x04

/* Flags for logger. */
#define LOG_PREAMBLE                    0
#define LOG_ACCOUNT                     1
#define LOG_MAILBOX                     2
#define LOG_FILTER                      3
#define LOG_ACTION                      4
#define LOG_DESTINATION_ACCOUNT         5
#define LOG_DESTINATION_MAILBOX         6
#define LOG_HEADER                      7

/* Store IMAP command type may replace,add or remove flags. */
#define STORE_FLAG_REPLACE              1
#define STORE_FLAG_ADD                  2
#define STORE_FLAG_REMOVE               3

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

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

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

/* Buffer to save flags of the store IMAP command. */
#define STORE_FLAGS_BUF                 64

/* Length of charset for IMAP SEARCH requests. */
#define CHARSET_LEN                     64

/* String lengths of master password and encrypted passwords. */
#define PASSPHRASE_LEN                  256

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


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


/* IMAP connection. */
typedef struct conn {
        int sock;               /* Socket. */
#ifdef SSL_TLS
        SSL *ssl;               /* SSL socket. */
#endif
        unsigned int caps;      /* Capabilities of the mail server. */
        struct {                /* Namespace of the mail server's mailboxes. */
                char prefix[NAMESPACE_PREFIX_LEN];      /* Namespace prefix. */
                char delim;     /* Namespace delimiter. */
        } nsp;
} conn_t;


/*      action.c        */
int apply_action(char *mbox, char *mesgs, unsigned int *type,
    account_t * raccount, char *destmbox, unsigned int *msgflags, char *args);

/*      auth.c          */
#ifdef CRAM_MD5
int auth_cram_md5(conn_t * conn, char *user, char *pass);
#endif

/*      cert.c          */
#ifdef SSL_TLS
int get_cert(conn_t * conn);
#endif

/*      destroy.c       */
void destroy_all(void);
void destroy_unneeded(void);

/*      file.c          */
int create_homedir(void);
int exists_file(char *fname);
int exists_dir(char *fname);
int create_file(char *fname, mode_t mode);
int check_file_perms(char *fname, mode_t mode);
int check_dir_perms(char *dname, mode_t mode);

/*      imap.c          */
int imap_noop(conn_t * conn);
int imap_capability(conn_t * conn);
int imap_namespace(conn_t * conn);
int imap_logout(conn_t * conn);
#ifdef SSL_TLS
int imap_starttls(conn_t * conn);
#endif
int imap_authenticate(conn_t * conn, char *auth, int cont);
int imap_login(conn_t * conn, char *user, char *pass);
/* int imap_list(conn_t *conn, char *refer, char *mbox); */
int imap_subscribe(conn_t * conn, char *mbox);
/* int imap_examine(conn_t *conn, char *mbox); */
int imap_select(conn_t * conn, char *mbox);
int imap_status(conn_t * conn, char *mbox, char *items);
int imap_create(conn_t * conn, char *mbox);
int imap_search(conn_t * conn, char *charset, char *search);
int imap_fetch(conn_t * conn, char *mesg, char *items);
int imap_store(conn_t * conn, char *mesg, unsigned int mode, char *flags);
int imap_copy(conn_t * conn, char *mesg, char *mbox);
int imap_append(conn_t * conn, char *mbox, char *flags, char *date,
    unsigned int size);
int imap_close(conn_t * conn);
int imap_expunge(conn_t * conn);

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

/*      log.c           */
void info(const char *info,...);
void verbose(const char *info,...);
void debug(const char *debug,...);
void error(const char *errmsg,...);
void fatal(unsigned int errnum, const char *fatal,...);
void catch_signals(void);
int debug_start(void);
int debug_stop(void);
int log_start(void);
int log_stop(void);
void log_info(int flag, void *ptr);

/*      match.c         */
int apply_filters(char *mbox, filter_t ** filters);

/*      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_clear(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);

/*      parse.c         */
int read_config(char *cfg);
void reread_config(char *cfg);
int read_passwords(void);

/*      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(conn_t * conn);
int check_capabilities(conn_t * conn);
int check_namespace(conn_t * conn);
#ifdef SSL_TLS
int negotiate_tls(conn_t * conn);
#endif
int login(conn_t * conn, char *user, char *pass);
int check_mailbox(conn_t * conn, char *mbox);
int select_mailbox(conn_t * conn, char *mbox);
int mailbox_status(conn_t * conn, char *mbox);
int close_mailbox(conn_t * conn);
int logout(conn_t * conn);

/*      response.c      */
int server_response(conn_t * conn, unsigned int tag);
int greeting_response(conn_t * conn);
int logout_response(conn_t * conn, unsigned int tag);
int capability_response(conn_t * conn, unsigned int tag);
int authenticate_response(conn_t * conn, unsigned int tag,
    unsigned char **cont);
int namespace_response(conn_t * conn, unsigned int tag);
int status_response(conn_t * conn, unsigned int tag, char *mbox);
int select_response(conn_t * conn, unsigned int tag);
int search_response(conn_t * conn, unsigned int tag, char **mesgs);
int fetch_response(conn_t * conn, unsigned int tag, int reset, char *fetch);
int fetchfast_response(conn_t * conn, char **flags, char **date,
    unsigned int *size, unsigned int tag);
int append_response(conn_t * conn, unsigned int tag);
int copy_response(conn_t * conn, unsigned int tag);

/*      socket.c        */
int init_connection(conn_t * conn, char *serv, unsigned short int port,
    unsigned int protocol);
#ifdef SSL_TLS
int init_secure_connection(conn_t * conn, unsigned int protocol);
#endif
int close_connection(conn_t * conn);
int socket_read(conn_t * conn, char *buf);
int socket_write(conn_t * conn, 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
5	lefcha	1.68	#include <stdio.h>
6			#include <sys/types.h>
7
8	lefcha	1.54	#include "config.h"
9	lefcha	1.65	#include "account.h"
10			#include "filter.h"
11	lefcha	1.54
12			#ifdef SSL_TLS
13			#include <openssl/ssl.h>
14			#endif
15
16	lefcha	1.43
17	lefcha	1.11	/* Error codes returned by functions. */
18	lefcha	1.77	#define ERROR_UNDEFINED 1
19			#define ERROR_SIGNAL 2
20			#define ERROR_TRIVIAL 3
21			#define ERROR_FILE_OPEN 4
22			#define ERROR_LOCKFILE 5
23			#define ERROR_CONFIG_PARSE 6
24			#define ERROR_MEMORY_ALLOCATION 7
25			#define ERROR_SETUID 8
26			#define ERROR_TERMIO 9
27			#define ERROR_NETWORK 10
28			#define ERROR_SSL 11
29			#define ERROR_PASSPHRASE 12
30			#define ERROR_ENCRYPT 13
31			#define ERROR_DECRYPT 14
32			#define ERROR_FORK 15
33	lefcha	1.9
34	lefcha	1.54	/* SSL/TLS certificate status for the server. */
35			#define SSL_CERT_OK 0
36			#define SSL_CERT_NONEXISTENT 1
37			#define SSL_CERT_MISMATCH 2
38
39			/* Action to be applied, concerning the SSL/TLS certificate. */
40			#define SSL_CERT_ACTION_ACCEPT 0
41			#define SSL_CERT_ACTION_REJECT 1
42			#define SSL_CERT_ACTION_CONTINUE 0
43			#define SSL_CERT_ACTION_ABORT 1
44
45	lefcha	1.30	/* Flags that control the program's execution options. */
46	lefcha	1.76	#define OPTION_DEBUG 0x0001
47			#define OPTION_ERRORS 0x0002
48			#define OPTION_EXPUNGE 0x0004
49			#define OPTION_HEADERS 0x0008
50			#define OPTION_NAMESPACE 0x0010
51			#define OPTION_SUBSCRIBE 0x0020
52			#define OPTION_PASSWORD_EDITOR 0x0040
53			#define OPTION_DAEMON_MODE 0x0080
54			#define OPTION_PEEK 0x0100
55	lefcha	1.30
56			/* Other flags. */
57	lefcha	1.54	#define FLAG_DAEMON_MODE 0x01
58			#define FLAG_TTY 0x02
59			#define FLAG_TTY_MODIFIED 0x04
60			#define FLAG_BLANK_PASSWORD 0x08
61	lefcha	1.67	#define FLAG_SIGUSR1_RECEIVED 0x10
62	lefcha	1.25
63			/* Capabilities of mail server. */
64			#define CAPABILITY_NONE 0x00
65			#define CAPABILITY_NAMESPACE 0x01
66	lefcha	1.61	#define CAPABILITY_AUTH_CRAM_MD5 0x02
67	lefcha	1.62	#define CAPABILITY_STARTTLS 0x04
68	lefcha	1.9
69	lefcha	1.12	/* Flags for logger. */
70	lefcha	1.55	#define LOG_PREAMBLE 0
71	lefcha	1.49	#define LOG_ACCOUNT 1
72			#define LOG_MAILBOX 2
73			#define LOG_FILTER 3
74			#define LOG_ACTION 4
75			#define LOG_DESTINATION_ACCOUNT 5
76	lefcha	1.12	#define LOG_DESTINATION_MAILBOX 6
77	lefcha	1.55	#define LOG_HEADER 7
78	lefcha	1.12
79	lefcha	1.35	/* Store IMAP command type may replace,add or remove flags. */
80			#define STORE_FLAG_REPLACE 1
81			#define STORE_FLAG_ADD 2
82			#define STORE_FLAG_REMOVE 3
83
84	lefcha	1.9	/* Buffer size of server's response. */
85	lefcha	1.55	#define RESPONSE_BUF 4096
86	lefcha	1.20	#define RESULT_BUF 512
87	lefcha	1.9
88	lefcha	1.16	/* Response codes. */
89	lefcha	1.44	#define RESPONSE_NULLBODY -2
90			#define RESPONSE_NONE -1
91	lefcha	1.16	#define RESPONSE_OK 0
92			#define RESPONSE_NO 1
93	lefcha	1.44	#define RESPONSE_BAD 2
94			#define RESPONSE_BYE 3
95			#define RESPONSE_PREAUTH 4
96			#define RESPONSE_READONLY 5
97			#define RESPONSE_TRYCREATE 6
98	lefcha	1.16
99	lefcha	1.26	/* Encryption and decryption buffers. */
100			#define ENCRYPTION_BUF 1024
101			#define DECRYPTION_BUF 4096
102
103	lefcha	1.35	/* Buffer to save flags of the store IMAP command. */
104			#define STORE_FLAGS_BUF 64
105
106	lefcha	1.69	/* Length of charset for IMAP SEARCH requests. */
107	lefcha	1.47	#define CHARSET_LEN 64
108
109	lefcha	1.65	/* String lengths of master password and encrypted passwords. */
110			#define PASSPHRASE_LEN 256
111
112			/* Length of mailbox namespace prefix. */
113			#define NAMESPACE_PREFIX_LEN 64
114
115	lefcha	1.1
116			#define min(A, B) ((A) < (B) ? (A) : (B))
117	lefcha	1.15	#define plural(A) ((A) == 1 ? "" : "s")
118	lefcha	1.1
119
120	lefcha	1.64	/* IMAP connection. */
121			typedef struct conn {
122			int sock; /* Socket. */
123			#ifdef SSL_TLS
124			SSL ssl; / SSL socket. */
125			#endif
126			unsigned int caps; /* Capabilities of the mail server. */
127	lefcha	1.65	struct { /* Namespace of the mail server's mailboxes. */
128			char prefix[NAMESPACE_PREFIX_LEN]; /* Namespace prefix. */
129			char delim; /* Namespace delimiter. */
130			} nsp;
131	lefcha	1.64	} conn_t;
132
133
134	lefcha	1.65	/* action.c */
135	lefcha	1.78	int apply_action(char mbox, char mesgs, unsigned int *type,
136			account_t * raccount, char destmbox, unsigned int msgflags, char *args);
137	lefcha	1.65
138	lefcha	1.61	/* auth.c */
139	lefcha	1.62	#ifdef CRAM_MD5
140	lefcha	1.65	int auth_cram_md5(conn_t * conn, char user, char pass);
141			#endif
142	lefcha	1.61
143	lefcha	1.65	/* cert.c */
144			#ifdef SSL_TLS
145			int get_cert(conn_t * conn);
146	lefcha	1.62	#endif
147
148	lefcha	1.65	/* destroy.c */
149			void destroy_all(void);
150			void destroy_unneeded(void);
151	lefcha	1.63
152	lefcha	1.9	/* file.c */
153	lefcha	1.25	int create_homedir(void);
154	lefcha	1.26	int exists_file(char *fname);
155			int exists_dir(char *fname);
156	lefcha	1.25	int create_file(char *fname, mode_t mode);
157			int check_file_perms(char *fname, mode_t mode);
158	lefcha	1.75	int check_dir_perms(char *dname, mode_t mode);
159	lefcha	1.54
160	lefcha	1.9	/* imap.c */
161	lefcha	1.64	int imap_noop(conn_t * conn);
162			int imap_capability(conn_t * conn);
163			int imap_namespace(conn_t * conn);
164			int imap_logout(conn_t * conn);
165	lefcha	1.62	#ifdef SSL_TLS
166	lefcha	1.64	int imap_starttls(conn_t * conn);
167	lefcha	1.62	#endif
168	lefcha	1.64	int imap_authenticate(conn_t * conn, char *auth, int cont);
169			int imap_login(conn_t * conn, char user, char pass);
170			/* int imap_list(conn_t conn, char refer, char mbox); /
171			int imap_subscribe(conn_t * conn, char *mbox);
172			/* int imap_examine(conn_t conn, char mbox); */
173			int imap_select(conn_t * conn, char *mbox);
174			int imap_status(conn_t * conn, char mbox, char items);
175			int imap_create(conn_t * conn, char *mbox);
176			int imap_search(conn_t * conn, char charset, char search);
177			int imap_fetch(conn_t * conn, char mesg, char items);
178			int imap_store(conn_t * conn, char mesg, unsigned int mode, char flags);
179			int imap_copy(conn_t * conn, char mesg, char mbox);
180	lefcha	1.78	int imap_append(conn_t * conn, char mbox, char flags, char *date,
181			unsigned int size);
182	lefcha	1.64	int imap_close(conn_t * conn);
183			int imap_expunge(conn_t * conn);
184	lefcha	1.29
185			/* lock.c */
186			void lockfile_create(void);
187			void lockfile_check(void);
188			int lockfile_remove(void);
189	lefcha	1.30	void kill_imapfilter(void);
190	lefcha	1.9
191			/* log.c */
192	lefcha	1.13	void info(const char *info,...);
193			void verbose(const char *info,...);
194	lefcha	1.74	void debug(const char *debug,...);
195	lefcha	1.13	void error(const char *errmsg,...);
196			void fatal(unsigned int errnum, const char *fatal,...);
197	lefcha	1.22	void catch_signals(void);
198	lefcha	1.74	int debug_start(void);
199			int debug_stop(void);
200			int log_start(void);
201			int log_stop(void);
202	lefcha	1.12	void log_info(int flag, void *ptr);
203	lefcha	1.65
204			/* match.c */
205			int apply_filters(char mbox, filter_t * filters);
206	lefcha	1.9
207	lefcha	1.13	/* memory.c */
208			void *xmalloc(size_t size);
209	lefcha	1.19	void xrealloc(void ptr, size_t size);
210	lefcha	1.26	void xfree(void *ptr);
211	lefcha	1.13	char xstrdup(const char s);
212
213	lefcha	1.27	void *smalloc(size_t size);
214			void srealloc(void ptr, size_t size);
215			void sfree(void *ptr);
216			char sstrdup(const char s);
217			void secmem_clear(void);
218	lefcha	1.49
219	lefcha	1.27	void corefile_disable(void);
220
221	lefcha	1.16	/* misc.c */
222			char strcasestr(const char haystack, const char *needle);
223			char *ultostr(unsigned long int num, int base);
224	lefcha	1.24	char xstrncpy(char dest, const char *src, size_t size);
225	lefcha	1.16
226	lefcha	1.65	/* parse.c */
227			int read_config(char *cfg);
228			void reread_config(char *cfg);
229			int read_passwords(void);
230
231	lefcha	1.25	/* passwd.c */
232	lefcha	1.26	void get_password(char *passwd, size_t pwlen);
233			#ifdef ENCRYPTED_PASSWORDS
234	lefcha	1.60	int encrypt_passwords(FILE * fd, account_t ** accts);
235	lefcha	1.34	int decrypt_passwords(unsigned char *buf, FILE fd);
236	lefcha	1.26	void password_editor(void);
237			#endif
238	lefcha	1.25
239	lefcha	1.9	/* request.c */
240	lefcha	1.64	int test(conn_t * conn);
241			int check_capabilities(conn_t * conn);
242			int check_namespace(conn_t * conn);
243	lefcha	1.62	#ifdef SSL_TLS
244	lefcha	1.65	int negotiate_tls(conn_t * conn);
245	lefcha	1.62	#endif
246	lefcha	1.64	int login(conn_t * conn, char user, char pass);
247			int check_mailbox(conn_t * conn, char *mbox);
248			int select_mailbox(conn_t * conn, char *mbox);
249			int mailbox_status(conn_t * conn, char *mbox);
250			int close_mailbox(conn_t * conn);
251			int logout(conn_t * conn);
252	lefcha	1.9
253	lefcha	1.65	/* response.c */
254	lefcha	1.64	int server_response(conn_t * conn, unsigned int tag);
255			int greeting_response(conn_t * conn);
256			int logout_response(conn_t * conn, unsigned int tag);
257			int capability_response(conn_t * conn, unsigned int tag);
258	lefcha	1.78	int authenticate_response(conn_t * conn, unsigned int tag,
259			unsigned char **cont);
260	lefcha	1.64	int namespace_response(conn_t * conn, unsigned int tag);
261			int status_response(conn_t * conn, unsigned int tag, char *mbox);
262			int select_response(conn_t * conn, unsigned int tag);
263			int search_response(conn_t * conn, unsigned int tag, char **mesgs);
264			int fetch_response(conn_t * conn, unsigned int tag, int reset, char *fetch);
265	lefcha	1.78	int fetchfast_response(conn_t * conn, char flags, char date,
266			unsigned int *size, unsigned int tag);
267	lefcha	1.64	int append_response(conn_t * conn, unsigned int tag);
268			int copy_response(conn_t * conn, unsigned int tag);
269	lefcha	1.25
270			/* socket.c */
271	lefcha	1.78	int init_connection(conn_t * conn, char *serv, unsigned short int port,
272			unsigned int protocol);
273	lefcha	1.62	#ifdef SSL_TLS
274	lefcha	1.65	int init_secure_connection(conn_t * conn, unsigned int protocol);
275	lefcha	1.62	#endif
276	lefcha	1.64	int close_connection(conn_t * conn);
277			int socket_read(conn_t * conn, char *buf);
278			int socket_write(conn_t * conn, char *data);
279	lefcha	1.25
280			/* tty.c */
281			int tty_store(void);
282			int tty_disable_echo(void);
283			int tty_restore(void);
284	lefcha	1.65
285	lefcha	1.11
286	lefcha	1.13	#endif /* IMAPFILTER_H */