|
76
|
1
|
|
|
2 /*
|
|
|
3 * Copyright (C) Igor Sysoev
|
|
|
4 */
|
|
|
5
|
|
|
6
|
|
|
7 #ifndef _NGX_IMAP_H_INCLUDED_
|
|
|
8 #define _NGX_IMAP_H_INCLUDED_
|
|
|
9
|
|
|
10
|
|
|
11 #include <ngx_config.h>
|
|
|
12 #include <ngx_core.h>
|
|
|
13 #include <ngx_event.h>
|
|
|
14 #include <ngx_event_connect.h>
|
|
|
15
|
|
88
|
16 #if (NGX_IMAP_SSL)
|
|
|
17 #include <ngx_imap_ssl_module.h>
|
|
|
18 #endif
|
|
|
19
|
|
|
20
|
|
76
|
21
|
|
|
22 typedef struct {
|
|
132
|
23 void **main_conf;
|
|
|
24 void **srv_conf;
|
|
76
|
25 } ngx_imap_conf_ctx_t;
|
|
|
26
|
|
|
27
|
|
|
28 typedef struct {
|
|
190
|
29 in_addr_t addr;
|
|
|
30 in_port_t port;
|
|
|
31 int family;
|
|
|
32
|
|
|
33 /* server ctx */
|
|
|
34 ngx_imap_conf_ctx_t *ctx;
|
|
|
35
|
|
|
36 unsigned bind:1;
|
|
|
37 } ngx_imap_listen_t;
|
|
|
38
|
|
|
39
|
|
|
40 typedef struct {
|
|
|
41 in_addr_t addr;
|
|
|
42 ngx_imap_conf_ctx_t *ctx;
|
|
|
43 ngx_str_t addr_text;
|
|
|
44 } ngx_imap_in_addr_t;
|
|
|
45
|
|
|
46
|
|
|
47 typedef struct {
|
|
|
48 ngx_imap_in_addr_t *addrs; /* array of ngx_imap_in_addr_t */
|
|
|
49 ngx_uint_t naddrs;
|
|
|
50 } ngx_imap_in_port_t;
|
|
|
51
|
|
|
52
|
|
|
53 typedef struct {
|
|
|
54 in_port_t port;
|
|
|
55 ngx_array_t addrs; /* array of ngx_imap_conf_in_addr_t */
|
|
|
56 } ngx_imap_conf_in_port_t;
|
|
|
57
|
|
|
58
|
|
|
59 typedef struct {
|
|
|
60 in_addr_t addr;
|
|
|
61 ngx_imap_conf_ctx_t *ctx;
|
|
|
62 unsigned bind:1;
|
|
|
63 } ngx_imap_conf_in_addr_t;
|
|
|
64
|
|
|
65
|
|
|
66 typedef struct {
|
|
|
67 ngx_array_t servers; /* ngx_imap_core_srv_conf_t */
|
|
|
68 ngx_array_t listen; /* ngx_imap_listen_t */
|
|
76
|
69 } ngx_imap_core_main_conf_t;
|
|
|
70
|
|
|
71
|
|
|
72 #define NGX_IMAP_POP3_PROTOCOL 0
|
|
|
73 #define NGX_IMAP_IMAP_PROTOCOL 1
|
|
|
74
|
|
|
75 typedef struct {
|
|
132
|
76 ngx_msec_t timeout;
|
|
76
|
77
|
|
132
|
78 size_t imap_client_buffer_size;
|
|
76
|
79
|
|
132
|
80 ngx_uint_t protocol;
|
|
76
|
81
|
|
136
|
82 ngx_flag_t so_keepalive;
|
|
|
83
|
|
132
|
84 ngx_str_t pop3_capability;
|
|
|
85 ngx_str_t pop3_starttls_capability;
|
|
252
|
86 ngx_str_t pop3_auth_capability;
|
|
|
87
|
|
132
|
88 ngx_str_t imap_capability;
|
|
|
89 ngx_str_t imap_starttls_capability;
|
|
|
90 ngx_str_t imap_starttls_only_capability;
|
|
76
|
91
|
|
250
|
92 ngx_str_t server_name;
|
|
|
93
|
|
|
94 ngx_uint_t auth_methods;
|
|
|
95
|
|
132
|
96 ngx_array_t pop3_capabilities;
|
|
|
97 ngx_array_t imap_capabilities;
|
|
76
|
98
|
|
|
99 /* server ctx */
|
|
190
|
100 ngx_imap_conf_ctx_t *ctx;
|
|
76
|
101 } ngx_imap_core_srv_conf_t;
|
|
|
102
|
|
|
103
|
|
|
104 typedef struct {
|
|
132
|
105 void *(*create_main_conf)(ngx_conf_t *cf);
|
|
|
106 char *(*init_main_conf)(ngx_conf_t *cf, void *conf);
|
|
76
|
107
|
|
132
|
108 void *(*create_srv_conf)(ngx_conf_t *cf);
|
|
|
109 char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev,
|
|
|
110 void *conf);
|
|
76
|
111 } ngx_imap_module_t;
|
|
|
112
|
|
|
113
|
|
|
114 typedef enum {
|
|
|
115 ngx_imap_start = 0,
|
|
|
116 ngx_imap_login,
|
|
|
117 ngx_imap_user,
|
|
212
|
118 ngx_imap_passwd
|
|
76
|
119 } ngx_imap_state_e;
|
|
|
120
|
|
|
121
|
|
|
122 typedef enum {
|
|
|
123 ngx_pop3_start = 0,
|
|
|
124 ngx_pop3_user,
|
|
252
|
125 ngx_pop3_passwd,
|
|
|
126 ngx_pop3_auth_login_username,
|
|
|
127 ngx_pop3_auth_login_password,
|
|
|
128 ngx_pop3_auth_plain,
|
|
|
129 ngx_pop3_auth_cram_md5
|
|
76
|
130 } ngx_po3_state_e;
|
|
|
131
|
|
|
132
|
|
|
133 typedef struct {
|
|
|
134 ngx_peer_connection_t upstream;
|
|
|
135 ngx_buf_t *buffer;
|
|
|
136 } ngx_imap_proxy_ctx_t;
|
|
|
137
|
|
|
138
|
|
|
139 typedef struct {
|
|
|
140 uint32_t signature; /* "IMAP" */
|
|
|
141
|
|
|
142 ngx_connection_t *connection;
|
|
|
143
|
|
88
|
144 ngx_str_t out;
|
|
76
|
145 ngx_buf_t *buffer;
|
|
|
146
|
|
|
147 void **ctx;
|
|
|
148 void **main_conf;
|
|
|
149 void **srv_conf;
|
|
|
150
|
|
|
151 ngx_imap_proxy_ctx_t *proxy;
|
|
|
152
|
|
|
153 ngx_uint_t imap_state;
|
|
|
154
|
|
88
|
155 unsigned blocked:1;
|
|
|
156 unsigned quit:1;
|
|
76
|
157 unsigned protocol:1;
|
|
|
158 unsigned quoted:1;
|
|
92
|
159 unsigned backslash:1;
|
|
|
160 unsigned no_sync_literal:1;
|
|
190
|
161 unsigned starttls:1;
|
|
252
|
162 unsigned auth_method:2;
|
|
260
|
163 unsigned auth_wait:1;
|
|
76
|
164
|
|
|
165 ngx_str_t login;
|
|
|
166 ngx_str_t passwd;
|
|
|
167
|
|
250
|
168 ngx_str_t salt;
|
|
76
|
169 ngx_str_t tag;
|
|
88
|
170 ngx_str_t tagged_line;
|
|
76
|
171
|
|
190
|
172 ngx_str_t *addr_text;
|
|
|
173
|
|
76
|
174 ngx_uint_t command;
|
|
|
175 ngx_array_t args;
|
|
|
176
|
|
|
177 ngx_uint_t login_attempt;
|
|
|
178
|
|
|
179 /* used to parse IMAP/POP3 command */
|
|
|
180
|
|
|
181 ngx_uint_t state;
|
|
|
182 u_char *cmd_start;
|
|
|
183 u_char *arg_start;
|
|
|
184 u_char *arg_end;
|
|
|
185 ngx_uint_t literal_len;
|
|
|
186 } ngx_imap_session_t;
|
|
|
187
|
|
|
188
|
|
90
|
189 typedef struct {
|
|
132
|
190 ngx_str_t *client;
|
|
|
191 ngx_imap_session_t *session;
|
|
90
|
192 } ngx_imap_log_ctx_t;
|
|
|
193
|
|
|
194
|
|
250
|
195 #define NGX_POP3_USER 1
|
|
|
196 #define NGX_POP3_PASS 2
|
|
|
197 #define NGX_POP3_CAPA 3
|
|
|
198 #define NGX_POP3_QUIT 4
|
|
|
199 #define NGX_POP3_NOOP 5
|
|
|
200 #define NGX_POP3_STLS 6
|
|
|
201 #define NGX_POP3_APOP 7
|
|
252
|
202 #define NGX_POP3_AUTH 8
|
|
|
203 #define NGX_POP3_STAT 9
|
|
|
204 #define NGX_POP3_LIST 10
|
|
|
205 #define NGX_POP3_RETR 11
|
|
|
206 #define NGX_POP3_DELE 12
|
|
|
207 #define NGX_POP3_RSET 13
|
|
|
208 #define NGX_POP3_TOP 14
|
|
|
209 #define NGX_POP3_UIDL 15
|
|
76
|
210
|
|
|
211
|
|
250
|
212 #define NGX_IMAP_LOGIN 1
|
|
|
213 #define NGX_IMAP_LOGOUT 2
|
|
|
214 #define NGX_IMAP_CAPABILITY 3
|
|
|
215 #define NGX_IMAP_NOOP 4
|
|
|
216 #define NGX_IMAP_STARTTLS 5
|
|
|
217
|
|
|
218 #define NGX_IMAP_NEXT 6
|
|
76
|
219
|
|
250
|
220
|
|
252
|
221 #define NGX_IMAP_AUTH_PLAIN 0
|
|
|
222 #define NGX_IMAP_AUTH_APOP 1
|
|
|
223 #define NGX_IMAP_AUTH_CRAM_MD5 2
|
|
250
|
224
|
|
|
225
|
|
252
|
226 #define NGX_IMAP_AUTH_PLAIN_ENABLED 0x0002
|
|
|
227 #define NGX_IMAP_AUTH_APOP_ENABLED 0x0004
|
|
|
228 #define NGX_IMAP_AUTH_CRAM_MD5_ENABLED 0x0008
|
|
76
|
229
|
|
|
230
|
|
|
231 #define NGX_IMAP_PARSE_INVALID_COMMAND 20
|
|
|
232
|
|
|
233
|
|
|
234 #define NGX_IMAP_MODULE 0x50414D49 /* "IMAP" */
|
|
|
235
|
|
|
236 #define NGX_IMAP_MAIN_CONF 0x02000000
|
|
|
237 #define NGX_IMAP_SRV_CONF 0x04000000
|
|
|
238
|
|
|
239
|
|
|
240 #define NGX_IMAP_MAIN_CONF_OFFSET offsetof(ngx_imap_conf_ctx_t, main_conf)
|
|
|
241 #define NGX_IMAP_SRV_CONF_OFFSET offsetof(ngx_imap_conf_ctx_t, srv_conf)
|
|
|
242
|
|
|
243
|
|
|
244 #define ngx_imap_get_module_ctx(s, module) (s)->ctx[module.ctx_index]
|
|
|
245 #define ngx_imap_set_ctx(s, c, module) s->ctx[module.ctx_index] = c;
|
|
|
246 #define ngx_imap_delete_ctx(s, module) s->ctx[module.ctx_index] = NULL;
|
|
|
247
|
|
|
248
|
|
|
249 #define ngx_imap_get_module_main_conf(s, module) \
|
|
|
250 (s)->main_conf[module.ctx_index]
|
|
|
251 #define ngx_imap_get_module_srv_conf(s, module) (s)->srv_conf[module.ctx_index]
|
|
|
252
|
|
190
|
253 #define ngx_imap_conf_get_module_main_conf(cf, module) \
|
|
|
254 ((ngx_imap_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index]
|
|
|
255
|
|
76
|
256
|
|
|
257 void ngx_imap_init_connection(ngx_connection_t *c);
|
|
88
|
258 void ngx_imap_send(ngx_event_t *wev);
|
|
76
|
259 void ngx_imap_auth_state(ngx_event_t *rev);
|
|
|
260 void ngx_pop3_auth_state(ngx_event_t *rev);
|
|
|
261 void ngx_imap_close_connection(ngx_connection_t *c);
|
|
|
262 void ngx_imap_session_internal_server_error(ngx_imap_session_t *s);
|
|
|
263
|
|
|
264 ngx_int_t ngx_imap_parse_command(ngx_imap_session_t *s);
|
|
|
265 ngx_int_t ngx_pop3_parse_command(ngx_imap_session_t *s);
|
|
|
266
|
|
|
267
|
|
|
268 /* STUB */
|
|
260
|
269 void ngx_imap_proxy_init(ngx_imap_session_t *s, ngx_peer_addr_t *peer);
|
|
76
|
270 void ngx_imap_auth_http_init(ngx_imap_session_t *s);
|
|
|
271 /**/
|
|
|
272
|
|
|
273
|
|
|
274 extern ngx_uint_t ngx_imap_max_module;
|
|
|
275 extern ngx_module_t ngx_imap_core_module;
|
|
|
276
|
|
|
277
|
|
|
278 #endif /* _NGX_IMAP_H_INCLUDED_ */
|
