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

Contents of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.66 - (show annotations)
Sun Aug 3 16:04:44 2003 UTC (20 years, 8 months ago) by lefcha
Branch: MAIN
Changes since 1.65: +0 -8 lines
File MIME type: text/plain
Moved function prototypes to program file.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26