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

Annotation of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.73 - (hide annotations)
Sat Feb 7 23:54:16 2004 UTC (20 years, 1 month ago) by lefcha
Branch: MAIN
Changes since 1.72: +2 -3 lines
File MIME type: text/plain
Removed CHECK_PERMISSIONS compilation option and added variable to control permissions checking.

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.22 #define ERROR_SIGNAL 1
19     #define ERROR_TRIVIAL 2
20     #define ERROR_FILE_OPEN 3
21 lefcha 1.32 #define ERROR_LOCKFILE 4
22 lefcha 1.29 #define ERROR_CONFIG_PARSE 5
23     #define ERROR_MEMORY_ALLOCATION 6
24     #define ERROR_SETUID 7
25     #define ERROR_TERMIO 8
26     #define ERROR_NETWORK 9
27     #define ERROR_SSL 10
28     #define ERROR_PASSPHRASE 11
29     #define ERROR_ENCRYPT 12
30     #define ERROR_DECRYPT 13
31 lefcha 1.30 #define ERROR_FORK 14
32     #define ERROR_UNDEFINED 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.36 #define OPTION_DETAILS_QUIET 0x0001
47     #define OPTION_DETAILS_NORMAL 0x0002
48     #define OPTION_DETAILS_VERBOSE 0x0004
49 lefcha 1.38 #define OPTION_ERRORS 0x0008
50     #define OPTION_EXPUNGE 0x0010
51     #define OPTION_HEADERS 0x0020
52     #define OPTION_NAMESPACE 0x0040
53     #define OPTION_SUBSCRIBE 0x0080
54 lefcha 1.58 #define OPTION_PASSWORD_EDITOR 0x0100
55     #define OPTION_DAEMON_MODE 0x0200
56 lefcha 1.70 #define OPTION_PEEK 0x0400
57 lefcha 1.73 #define OPTION_PERMISSIONS 0x0800
58 lefcha 1.30
59     /* Other flags. */
60 lefcha 1.54 #define FLAG_DAEMON_MODE 0x01
61     #define FLAG_TTY 0x02
62     #define FLAG_TTY_MODIFIED 0x04
63     #define FLAG_BLANK_PASSWORD 0x08
64 lefcha 1.67 #define FLAG_SIGUSR1_RECEIVED 0x10
65 lefcha 1.25
66     /* Capabilities of mail server. */
67     #define CAPABILITY_NONE 0x00
68     #define CAPABILITY_NAMESPACE 0x01
69 lefcha 1.61 #define CAPABILITY_AUTH_CRAM_MD5 0x02
70 lefcha 1.62 #define CAPABILITY_STARTTLS 0x04
71 lefcha 1.9
72 lefcha 1.12 /* Flags for logger. */
73 lefcha 1.55 #define LOG_PREAMBLE 0
74 lefcha 1.49 #define LOG_ACCOUNT 1
75     #define LOG_MAILBOX 2
76     #define LOG_FILTER 3
77     #define LOG_ACTION 4
78     #define LOG_DESTINATION_ACCOUNT 5
79 lefcha 1.12 #define LOG_DESTINATION_MAILBOX 6
80 lefcha 1.55 #define LOG_HEADER 7
81 lefcha 1.12
82 lefcha 1.35 /* Store IMAP command type may replace,add or remove flags. */
83     #define STORE_FLAG_REPLACE 1
84     #define STORE_FLAG_ADD 2
85     #define STORE_FLAG_REMOVE 3
86    
87 lefcha 1.9 /* Buffer size of server's response. */
88 lefcha 1.55 #define RESPONSE_BUF 4096
89 lefcha 1.20 #define RESULT_BUF 512
90 lefcha 1.9
91 lefcha 1.16 /* Response codes. */
92 lefcha 1.44 #define RESPONSE_NULLBODY -2
93     #define RESPONSE_NONE -1
94 lefcha 1.16 #define RESPONSE_OK 0
95     #define RESPONSE_NO 1
96 lefcha 1.44 #define RESPONSE_BAD 2
97     #define RESPONSE_BYE 3
98     #define RESPONSE_PREAUTH 4
99     #define RESPONSE_READONLY 5
100     #define RESPONSE_TRYCREATE 6
101 lefcha 1.16
102 lefcha 1.26 /* Encryption and decryption buffers. */
103     #define ENCRYPTION_BUF 1024
104     #define DECRYPTION_BUF 4096
105    
106 lefcha 1.35 /* Buffer to save flags of the store IMAP command. */
107     #define STORE_FLAGS_BUF 64
108    
109 lefcha 1.69 /* Length of charset for IMAP SEARCH requests. */
110 lefcha 1.47 #define CHARSET_LEN 64
111    
112 lefcha 1.65 /* String lengths of master password and encrypted passwords. */
113     #define PASSPHRASE_LEN 256
114    
115     /* Length of mailbox namespace prefix. */
116     #define NAMESPACE_PREFIX_LEN 64
117    
118 lefcha 1.1
119     #define min(A, B) ((A) < (B) ? (A) : (B))
120 lefcha 1.15 #define plural(A) ((A) == 1 ? "" : "s")
121 lefcha 1.1
122    
123 lefcha 1.64 /* IMAP connection. */
124     typedef struct conn {
125     int sock; /* Socket. */
126     #ifdef SSL_TLS
127     SSL *ssl; /* SSL socket. */
128     #endif
129     unsigned int caps; /* Capabilities of the mail server. */
130 lefcha 1.65 struct { /* Namespace of the mail server's mailboxes. */
131     char prefix[NAMESPACE_PREFIX_LEN]; /* Namespace prefix. */
132     char delim; /* Namespace delimiter. */
133     } nsp;
134 lefcha 1.64 } conn_t;
135    
136    
137 lefcha 1.65 /* action.c */
138     int apply_action(char *mbox, char *mesgs, unsigned int *type, account_t * raccount, char *destmbox, unsigned int *msgflags, char *args);
139    
140 lefcha 1.61 /* auth.c */
141 lefcha 1.62 #ifdef CRAM_MD5
142 lefcha 1.65 int auth_cram_md5(conn_t * conn, char *user, char *pass);
143     #endif
144 lefcha 1.61
145 lefcha 1.65 /* cert.c */
146     #ifdef SSL_TLS
147     int get_cert(conn_t * conn);
148 lefcha 1.62 #endif
149    
150 lefcha 1.65 /* destroy.c */
151     void destroy_all(void);
152     void destroy_unneeded(void);
153 lefcha 1.63
154 lefcha 1.9 /* file.c */
155 lefcha 1.25 int create_homedir(void);
156 lefcha 1.26 int exists_file(char *fname);
157     int exists_dir(char *fname);
158 lefcha 1.25 int create_file(char *fname, mode_t mode);
159     int check_file_perms(char *fname, mode_t mode);
160 lefcha 1.73 /* int check_dir_perms(char *dname, mode_t mode); */
161 lefcha 1.54
162 lefcha 1.9 /* imap.c */
163     #ifdef DEBUG
164 lefcha 1.64 int imap_noop(conn_t * conn);
165 lefcha 1.9 #endif
166 lefcha 1.64 int imap_capability(conn_t * conn);
167     int imap_namespace(conn_t * conn);
168     int imap_logout(conn_t * conn);
169 lefcha 1.62 #ifdef SSL_TLS
170 lefcha 1.64 int imap_starttls(conn_t * conn);
171 lefcha 1.62 #endif
172 lefcha 1.64 int imap_authenticate(conn_t * conn, char *auth, int cont);
173     int imap_login(conn_t * conn, char *user, char *pass);
174     /* int imap_list(conn_t *conn, char *refer, char *mbox); */
175     int imap_subscribe(conn_t * conn, char *mbox);
176     /* int imap_examine(conn_t *conn, char *mbox); */
177     int imap_select(conn_t * conn, char *mbox);
178     int imap_status(conn_t * conn, char *mbox, char *items);
179     int imap_create(conn_t * conn, char *mbox);
180     int imap_search(conn_t * conn, char *charset, char *search);
181     int imap_fetch(conn_t * conn, char *mesg, char *items);
182     int imap_store(conn_t * conn, char *mesg, unsigned int mode, char *flags);
183     int imap_copy(conn_t * conn, char *mesg, char *mbox);
184 lefcha 1.71 int imap_append(conn_t * conn, char *mbox, char *flags, char *date, unsigned int size);
185 lefcha 1.64 int imap_close(conn_t * conn);
186     int imap_expunge(conn_t * conn);
187 lefcha 1.29
188     /* lock.c */
189     void lockfile_create(void);
190     void lockfile_check(void);
191     int lockfile_remove(void);
192 lefcha 1.30 void kill_imapfilter(void);
193 lefcha 1.9
194     /* log.c */
195 lefcha 1.13 void info(const char *info,...);
196     void verbose(const char *info,...);
197     void error(const char *errmsg,...);
198     void fatal(unsigned int errnum, const char *fatal,...);
199 lefcha 1.22 void catch_signals(void);
200 lefcha 1.9 int open_logfile(void);
201     int close_logfile(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     int authenticate_response(conn_t * conn, unsigned int tag, unsigned char **cont);
259     int namespace_response(conn_t * conn, unsigned int tag);
260     int status_response(conn_t * conn, unsigned int tag, char *mbox);
261     int select_response(conn_t * conn, unsigned int tag);
262     int search_response(conn_t * conn, unsigned int tag, char **mesgs);
263     int fetch_response(conn_t * conn, unsigned int tag, int reset, char *fetch);
264 lefcha 1.71 int fetchfast_response(conn_t * conn, char **flags, char **date, unsigned int *size, unsigned int tag);
265 lefcha 1.64 int append_response(conn_t * conn, unsigned int tag);
266     int copy_response(conn_t * conn, unsigned int tag);
267 lefcha 1.25
268     /* socket.c */
269 lefcha 1.64 int init_connection(conn_t * conn, char *serv, unsigned short int port, unsigned int protocol);
270 lefcha 1.62 #ifdef SSL_TLS
271 lefcha 1.65 int init_secure_connection(conn_t * conn, unsigned int protocol);
272 lefcha 1.62 #endif
273 lefcha 1.64 int close_connection(conn_t * conn);
274     int socket_read(conn_t * conn, char *buf);
275     int socket_write(conn_t * conn, char *data);
276 lefcha 1.25
277     /* tty.c */
278     int tty_store(void);
279     int tty_disable_echo(void);
280     int tty_restore(void);
281 lefcha 1.65
282 lefcha 1.11
283 lefcha 1.13 #endif /* IMAPFILTER_H */

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26