|
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;
|
|
|
86 ngx_str_t imap_capability;
|
|
|
87 ngx_str_t imap_starttls_capability;
|
|
|
88 ngx_str_t imap_starttls_only_capability;
|
|
76
|
89
|
|
250
|
90 ngx_str_t server_name;
|
|
|
91
|
|
|
92 ngx_uint_t auth_methods;
|
|
|
93
|
|
132
|
94 ngx_array_t pop3_capabilities;
|
|
|
95 ngx_array_t imap_capabilities;
|
|
76
|
96
|
|
|
97 /* server ctx */
|
|
190
|
98 ngx_imap_conf_ctx_t *ctx;
|
|
76
|
99 } ngx_imap_core_srv_conf_t;
|
|
|
100
|
|
|
101
|
|
|
102 typedef struct {
|
|
132
|
103 void *(*create_main_conf)(ngx_conf_t *cf);
|
|
|
104 char *(*init_main_conf)(ngx_conf_t *cf, void *conf);
|
|
76
|
105
|
|
132
|
106 void *(*create_srv_conf)(ngx_conf_t *cf);
|
|
|
107 char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev,
|
|
|
108 void *conf);
|
|
76
|
109 } ngx_imap_module_t;
|
|
|
110
|
|
|
111
|
|
|
112 typedef enum {
|
|
|
113 ngx_imap_start = 0,
|
|
|
114 ngx_imap_login,
|
|
|
115 ngx_imap_user,
|
|
212
|
116 ngx_imap_passwd
|
|
76
|
117 } ngx_imap_state_e;
|
|
|
118
|
|
|
119
|
|
|
120 typedef enum {
|
|
|
121 ngx_pop3_start = 0,
|
|
|
122 ngx_pop3_user,
|
|
|
123 ngx_pop3_passwd
|
|
|
124 } ngx_po3_state_e;
|
|
|
125
|
|
|
126
|
|
|
127 typedef struct {
|
|
|
128 ngx_peer_connection_t upstream;
|
|
|
129 ngx_buf_t *buffer;
|
|
|
130 } ngx_imap_proxy_ctx_t;
|
|
|
131
|
|
|
132
|
|
|
133 typedef struct {
|
|
|
134 uint32_t signature; /* "IMAP" */
|
|
|
135
|
|
|
136 ngx_connection_t *connection;
|
|
|
137
|
|
88
|
138 ngx_str_t out;
|
|
76
|
139 ngx_buf_t *buffer;
|
|
|
140
|
|
|
141 void **ctx;
|
|
|
142 void **main_conf;
|
|
|
143 void **srv_conf;
|
|
|
144
|
|
|
145 ngx_imap_proxy_ctx_t *proxy;
|
|
|
146
|
|
|
147 ngx_uint_t imap_state;
|
|
|
148
|
|
88
|
149 unsigned blocked:1;
|
|
|
150 unsigned quit:1;
|
|
76
|
151 unsigned protocol:1;
|
|
|
152 unsigned quoted:1;
|
|
92
|
153 unsigned backslash:1;
|
|
|
154 unsigned no_sync_literal:1;
|
|
190
|
155 unsigned starttls:1;
|
|
250
|
156 unsigned auth_method:1;
|
|
76
|
157
|
|
|
158 ngx_str_t login;
|
|
|
159 ngx_str_t passwd;
|
|
|
160
|
|
250
|
161 ngx_str_t salt;
|
|
76
|
162 ngx_str_t tag;
|
|
88
|
163 ngx_str_t tagged_line;
|
|
76
|
164
|
|
190
|
165 ngx_str_t *addr_text;
|
|
|
166
|
|
76
|
167 ngx_uint_t command;
|
|
|
168 ngx_array_t args;
|
|
|
169
|
|
|
170 ngx_uint_t login_attempt;
|
|
|
171
|
|
|
172 /* used to parse IMAP/POP3 command */
|
|
|
173
|
|
|
174 ngx_uint_t state;
|
|
|
175 u_char *cmd_start;
|
|
|
176 u_char *arg_start;
|
|
|
177 u_char *arg_end;
|
|
|
178 ngx_uint_t literal_len;
|
|
|
179 } ngx_imap_session_t;
|
|
|
180
|
|
|
181
|
|
90
|
182 typedef struct {
|
|
132
|
183 ngx_str_t *client;
|
|
|
184 ngx_imap_session_t *session;
|
|
90
|
185 } ngx_imap_log_ctx_t;
|
|
|
186
|
|
|
187
|
|
250
|
188 #define NGX_POP3_USER 1
|
|
|
189 #define NGX_POP3_PASS 2
|
|
|
190 #define NGX_POP3_CAPA 3
|
|
|
191 #define NGX_POP3_QUIT 4
|
|
|
192 #define NGX_POP3_NOOP 5
|
|
|
193 #define NGX_POP3_STLS 6
|
|
|
194 #define NGX_POP3_APOP 7
|
|
|
195 #define NGX_POP3_STAT 8
|
|
|
196 #define NGX_POP3_LIST 9
|
|
|
197 #define NGX_POP3_RETR 10
|
|
|
198 #define NGX_POP3_DELE 11
|
|
|
199 #define NGX_POP3_RSET 12
|
|
|
200 #define NGX_POP3_TOP 13
|
|
|
201 #define NGX_POP3_UIDL 14
|
|
76
|
202
|
|
|
203
|
|
250
|
204 #define NGX_IMAP_LOGIN 1
|
|
|
205 #define NGX_IMAP_LOGOUT 2
|
|
|
206 #define NGX_IMAP_CAPABILITY 3
|
|
|
207 #define NGX_IMAP_NOOP 4
|
|
|
208 #define NGX_IMAP_STARTTLS 5
|
|
|
209
|
|
|
210 #define NGX_IMAP_NEXT 6
|
|
76
|
211
|
|
250
|
212
|
|
|
213 #define NGX_IMAP_AUTH_PLAIN 0
|
|
|
214 #define NGX_IMAP_AUTH_APOP 1
|
|
|
215
|
|
|
216
|
|
|
217 #define NGX_IMAP_AUTH_PLAIN_ENABLED 0x0002
|
|
|
218 #define NGX_IMAP_AUTH_APOP_ENABLED 0x0004
|
|
76
|
219
|
|
|
220
|
|
|
221 #define NGX_IMAP_PARSE_INVALID_COMMAND 20
|
|
|
222
|
|
|
223
|
|
|
224 #define NGX_IMAP_MODULE 0x50414D49 /* "IMAP" */
|
|
|
225
|
|
|
226 #define NGX_IMAP_MAIN_CONF 0x02000000
|
|
|
227 #define NGX_IMAP_SRV_CONF 0x04000000
|
|
|
228
|
|
|
229
|
|
|
230 #define NGX_IMAP_MAIN_CONF_OFFSET offsetof(ngx_imap_conf_ctx_t, main_conf)
|
|
|
231 #define NGX_IMAP_SRV_CONF_OFFSET offsetof(ngx_imap_conf_ctx_t, srv_conf)
|
|
|
232
|
|
|
233
|
|
|
234 #define ngx_imap_get_module_ctx(s, module) (s)->ctx[module.ctx_index]
|
|
|
235 #define ngx_imap_set_ctx(s, c, module) s->ctx[module.ctx_index] = c;
|
|
|
236 #define ngx_imap_delete_ctx(s, module) s->ctx[module.ctx_index] = NULL;
|
|
|
237
|
|
|
238
|
|
|
239 #define ngx_imap_get_module_main_conf(s, module) \
|
|
|
240 (s)->main_conf[module.ctx_index]
|
|
|
241 #define ngx_imap_get_module_srv_conf(s, module) (s)->srv_conf[module.ctx_index]
|
|
|
242
|
|
190
|
243 #define ngx_imap_conf_get_module_main_conf(cf, module) \
|
|
|
244 ((ngx_imap_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index]
|
|
|
245
|
|
76
|
246
|
|
|
247 void ngx_imap_init_connection(ngx_connection_t *c);
|
|
88
|
248 void ngx_imap_send(ngx_event_t *wev);
|
|
76
|
249 void ngx_imap_auth_state(ngx_event_t *rev);
|
|
|
250 void ngx_pop3_auth_state(ngx_event_t *rev);
|
|
|
251 void ngx_imap_close_connection(ngx_connection_t *c);
|
|
|
252 void ngx_imap_session_internal_server_error(ngx_imap_session_t *s);
|
|
|
253
|
|
|
254 ngx_int_t ngx_imap_parse_command(ngx_imap_session_t *s);
|
|
|
255 ngx_int_t ngx_pop3_parse_command(ngx_imap_session_t *s);
|
|
|
256
|
|
|
257
|
|
|
258 /* STUB */
|
|
|
259 void ngx_imap_proxy_init(ngx_imap_session_t *s, ngx_peers_t *peers);
|
|
|
260 void ngx_imap_auth_http_init(ngx_imap_session_t *s);
|
|
|
261 /**/
|
|
|
262
|
|
|
263
|
|
|
264 extern ngx_uint_t ngx_imap_max_module;
|
|
|
265 extern ngx_module_t ngx_imap_core_module;
|
|
|
266
|
|
|
267
|
|
|
268 #endif /* _NGX_IMAP_H_INCLUDED_ */
|
