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

Contents of /imapfilter/imapfilter.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.48 - (show annotations)
Fri Feb 21 18:43:01 2003 UTC (21 years, 1 month ago) by lefcha
Branch: MAIN
Changes since 1.47: +5 -0 lines
File MIME type: text/plain
Added funtion get authentication mechanisms available.

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

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26