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

Contents of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.78 - (show annotations)
Mon Feb 9 20:49:01 2004 UTC (20 years, 1 month ago) by lefcha
Branch: MAIN
Changes since 1.77: +10 -5 lines
File MIME type: text/plain
Wrap some long >80 lines.

1 #ifndef IMAPFILTER_H
2 #define IMAPFILTER_H
3
4
5 #include <stdio.h>
6 #include <sys/types.h>
7
8 #include "config.h"
9 #include "account.h"
10 #include "filter.h"
11
12 #ifdef SSL_TLS
13 #include <openssl/ssl.h>
14 #endif
15
16
17 /* Error codes returned by functions. */
18 #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
34 /* 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 /* Flags that control the program's execution options. */
46 #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
56 /* Other flags. */
57 #define FLAG_DAEMON_MODE 0x01
58 #define FLAG_TTY 0x02
59 #define FLAG_TTY_MODIFIED 0x04
60 #define FLAG_BLANK_PASSWORD 0x08
61 #define FLAG_SIGUSR1_RECEIVED 0x10
62
63 /* Capabilities of mail server. */
64 #define CAPABILITY_NONE 0x00
65 #define CAPABILITY_NAMESPACE 0x01
66 #define CAPABILITY_AUTH_CRAM_MD5 0x02
67 #define CAPABILITY_STARTTLS 0x04
68
69 /* Flags for logger. */
70 #define LOG_PREAMBLE 0
71 #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 #define LOG_DESTINATION_MAILBOX 6
77 #define LOG_HEADER 7
78
79 /* 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 /* Buffer size of server's response. */
85 #define RESPONSE_BUF 4096
86 #define RESULT_BUF 512
87
88 /* Response codes. */
89 #define RESPONSE_NULLBODY -2
90 #define RESPONSE_NONE -1
91 #define RESPONSE_OK 0
92 #define RESPONSE_NO 1
93 #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
99 /* Encryption and decryption buffers. */
100 #define ENCRYPTION_BUF 1024
101 #define DECRYPTION_BUF 4096
102
103 /* Buffer to save flags of the store IMAP command. */
104 #define STORE_FLAGS_BUF 64
105
106 /* Length of charset for IMAP SEARCH requests. */
107 #define CHARSET_LEN 64
108
109 /* 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
116 #define min(A, B) ((A) < (B) ? (A) : (B))
117 #define plural(A) ((A) == 1 ? "" : "s")
118
119
120 /* 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 struct { /* Namespace of the mail server's mailboxes. */
128 char prefix[NAMESPACE_PREFIX_LEN]; /* Namespace prefix. */
129 char delim; /* Namespace delimiter. */
130 } nsp;
131 } conn_t;
132
133
134 /* action.c */
135 int apply_action(char *mbox, char *mesgs, unsigned int *type,
136 account_t * raccount, char *destmbox, unsigned int *msgflags, char *args);
137
138 /* auth.c */
139 #ifdef CRAM_MD5
140 int auth_cram_md5(conn_t * conn, char *user, char *pass);
141 #endif
142
143 /* cert.c */
144 #ifdef SSL_TLS
145 int get_cert(conn_t * conn);
146 #endif
147
148 /* destroy.c */
149 void destroy_all(void);
150 void destroy_unneeded(void);
151
152 /* file.c */
153 int create_homedir(void);
154 int exists_file(char *fname);
155 int exists_dir(char *fname);
156 int create_file(char *fname, mode_t mode);
157 int check_file_perms(char *fname, mode_t mode);
158 int check_dir_perms(char *dname, mode_t mode);
159
160 /* imap.c */
161 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 #ifdef SSL_TLS
166 int imap_starttls(conn_t * conn);
167 #endif
168 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 int imap_append(conn_t * conn, char *mbox, char *flags, char *date,
181 unsigned int size);
182 int imap_close(conn_t * conn);
183 int imap_expunge(conn_t * conn);
184
185 /* lock.c */
186 void lockfile_create(void);
187 void lockfile_check(void);
188 int lockfile_remove(void);
189 void kill_imapfilter(void);
190
191 /* log.c */
192 void info(const char *info,...);
193 void verbose(const char *info,...);
194 void debug(const char *debug,...);
195 void error(const char *errmsg,...);
196 void fatal(unsigned int errnum, const char *fatal,...);
197 void catch_signals(void);
198 int debug_start(void);
199 int debug_stop(void);
200 int log_start(void);
201 int log_stop(void);
202 void log_info(int flag, void *ptr);
203
204 /* match.c */
205 int apply_filters(char *mbox, filter_t ** filters);
206
207 /* memory.c */
208 void *xmalloc(size_t size);
209 void *xrealloc(void *ptr, size_t size);
210 void xfree(void *ptr);
211 char *xstrdup(const char *s);
212
213 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
219 void corefile_disable(void);
220
221 /* misc.c */
222 char *strcasestr(const char *haystack, const char *needle);
223 char *ultostr(unsigned long int num, int base);
224 char *xstrncpy(char *dest, const char *src, size_t size);
225
226 /* parse.c */
227 int read_config(char *cfg);
228 void reread_config(char *cfg);
229 int read_passwords(void);
230
231 /* passwd.c */
232 void get_password(char *passwd, size_t pwlen);
233 #ifdef ENCRYPTED_PASSWORDS
234 int encrypt_passwords(FILE * fd, account_t ** accts);
235 int decrypt_passwords(unsigned char **buf, FILE * fd);
236 void password_editor(void);
237 #endif
238
239 /* request.c */
240 int test(conn_t * conn);
241 int check_capabilities(conn_t * conn);
242 int check_namespace(conn_t * conn);
243 #ifdef SSL_TLS
244 int negotiate_tls(conn_t * conn);
245 #endif
246 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
253 /* response.c */
254 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 int authenticate_response(conn_t * conn, unsigned int tag,
259 unsigned char **cont);
260 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 int fetchfast_response(conn_t * conn, char **flags, char **date,
266 unsigned int *size, unsigned int tag);
267 int append_response(conn_t * conn, unsigned int tag);
268 int copy_response(conn_t * conn, unsigned int tag);
269
270 /* socket.c */
271 int init_connection(conn_t * conn, char *serv, unsigned short int port,
272 unsigned int protocol);
273 #ifdef SSL_TLS
274 int init_secure_connection(conn_t * conn, unsigned int protocol);
275 #endif
276 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
280 /* tty.c */
281 int tty_store(void);
282 int tty_disable_echo(void);
283 int tty_restore(void);
284
285
286 #endif /* IMAPFILTER_H */

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26