One Level Up Top Level

src/mail/ngx_mail.h - nginx-1.7.10

Data types defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #ifndef _NGX_MAIL_H_INCLUDED_
  9. ‌#define _NGX_MAIL_H_INCLUDED_


  12. #include <ngx_config.h>
  13. #include <ngx_core.h>
  14. #include <ngx_event.h>
  15. #include <ngx_event_connect.h>

  17. #if (NGX_MAIL_SSL)
  18. #include <ngx_mail_ssl_module.h>
  19. #endif



  23. typedef struct {
  24.     void                  **main_conf;
  25.     void                  **srv_conf;
  26. ‌} ngx_mail_conf_ctx_t;


  29. typedef struct {
  30.     u_char                  sockaddr[NGX_SOCKADDRLEN];
  31.     socklen_t               socklen;

  33.     /* server ctx */
  34.     ngx_mail_conf_ctx_t    *ctx;

  36.     unsigned                bind:1;
  37.     unsigned                wildcard:1;
  38. #if (NGX_MAIL_SSL)
  39.     unsigned                ssl:1;
  40. #endif
  41. #if (NGX_HAVE_INET6 && defined IPV6_V6ONLY)
  42.     unsigned                ipv6only:1;
  43. #endif
  44.     unsigned                so_keepalive:2;
  45. #if (NGX_HAVE_KEEPALIVE_TUNABLE)
  46.     int                     tcp_keepidle;
  47.     int                     tcp_keepintvl;
  48.     int                     tcp_keepcnt;
  49. #endif
  50. ‌} ngx_mail_listen_t;


  53. typedef struct {
  54.     ngx_mail_conf_ctx_t    *ctx;
  55.     ngx_str_t               addr_text;
  56. #if (NGX_MAIL_SSL)
  57.     ngx_uint_t              ssl;    /* unsigned   ssl:1; */
  58. #endif
  59. ‌} ngx_mail_addr_conf_t;

  61. typedef struct {
  62.     in_addr_t               addr;
  63.     ngx_mail_addr_conf_t    conf;
  64. ‌} ngx_mail_in_addr_t;


  67. #if (NGX_HAVE_INET6)

  69. typedef struct {
  70.     struct in6_addr         addr6;
  71.     ngx_mail_addr_conf_t    conf;
  72. ‌} ngx_mail_in6_addr_t;

  74. #endif


  77. typedef struct {
  78.     /* ngx_mail_in_addr_t or ngx_mail_in6_addr_t */
  79.     void                   *addrs;
  80.     ngx_uint_t              naddrs;
  81. ‌} ngx_mail_port_t;


  84. typedef struct {
  85.     int                     family;
  86.     in_port_t               port;
  87.     ngx_array_t             addrs;       /* array of ngx_mail_conf_addr_t */
  88. ‌} ngx_mail_conf_port_t;


  91. typedef struct {
  92.     struct sockaddr        *sockaddr;
  93.     socklen_t               socklen;

  95.     ngx_mail_conf_ctx_t    *ctx;

  97.     unsigned                bind:1;
  98.     unsigned                wildcard:1;
  99. #if (NGX_MAIL_SSL)
  100.     unsigned                ssl:1;
  101. #endif
  102. #if (NGX_HAVE_INET6 && defined IPV6_V6ONLY)
  103.     unsigned                ipv6only:1;
  104. #endif
  105.     unsigned                so_keepalive:2;
  106. #if (NGX_HAVE_KEEPALIVE_TUNABLE)
  107.     int                     tcp_keepidle;
  108.     int                     tcp_keepintvl;
  109.     int                     tcp_keepcnt;
  110. #endif
  111. ‌} ngx_mail_conf_addr_t;


  114. typedef struct {
  115.     ngx_array_t             servers;     /* ngx_mail_core_srv_conf_t */
  116.     ngx_array_t             listen;      /* ngx_mail_listen_t */
  117. ‌} ngx_mail_core_main_conf_t;


  120. ‌#define NGX_MAIL_POP3_PROTOCOL  0
  121. ‌#define NGX_MAIL_IMAP_PROTOCOL  1
  122. ‌#define NGX_MAIL_SMTP_PROTOCOL  2


  125. ‌typedef struct ngx_mail_protocol_s  ngx_mail_protocol_t;


  128. typedef struct {
  129.     ngx_mail_protocol_t    *protocol;

  131.     ngx_msec_t              timeout;
  132.     ngx_msec_t              resolver_timeout;

  134.     ngx_flag_t              so_keepalive;

  136.     ngx_str_t               server_name;

  138.     u_char                 *file_name;
  139.     ngx_int_t               line;

  141.     ngx_resolver_t         *resolver;

  143.     /* server ctx */
  144.     ngx_mail_conf_ctx_t    *ctx;
  145. ‌} ngx_mail_core_srv_conf_t;


  148. typedef enum {
  149.     ngx_pop3_start = 0,
  150.     ngx_pop3_user,
  151.     ngx_pop3_passwd,
  152.     ngx_pop3_auth_login_username,
  153.     ngx_pop3_auth_login_password,
  154.     ngx_pop3_auth_plain,
  155.     ngx_pop3_auth_cram_md5
  156. ‌} ngx_pop3_state_e;


  159. typedef enum {
  160.     ngx_imap_start = 0,
  161.     ngx_imap_auth_login_username,
  162.     ngx_imap_auth_login_password,
  163.     ngx_imap_auth_plain,
  164.     ngx_imap_auth_cram_md5,
  165.     ngx_imap_login,
  166.     ngx_imap_user,
  167.     ngx_imap_passwd
  168. ‌} ngx_imap_state_e;


  171. typedef enum {
  172.     ngx_smtp_start = 0,
  173.     ngx_smtp_auth_login_username,
  174.     ngx_smtp_auth_login_password,
  175.     ngx_smtp_auth_plain,
  176.     ngx_smtp_auth_cram_md5,
  177.     ngx_smtp_helo,
  178.     ngx_smtp_helo_xclient,
  179.     ngx_smtp_helo_from,
  180.     ngx_smtp_xclient,
  181.     ngx_smtp_xclient_from,
  182.     ngx_smtp_xclient_helo,
  183.     ngx_smtp_from,
  184.     ngx_smtp_to
  185. ‌} ngx_smtp_state_e;


  188. typedef struct {
  189.     ngx_peer_connection_t   upstream;
  190.     ngx_buf_t              *buffer;
  191. ‌} ngx_mail_proxy_ctx_t;


  194. typedef struct {
  195.     uint32_t                signature;         /* "MAIL" */

  197.     ngx_connection_t       *connection;

  199.     ngx_str_t               out;
  200.     ngx_buf_t              *buffer;

  202.     void                  **ctx;
  203.     void                  **main_conf;
  204.     void                  **srv_conf;

  206.     ngx_resolver_ctx_t     *resolver_ctx;

  208.     ngx_mail_proxy_ctx_t   *proxy;

  210.     ngx_uint_t              mail_state;

  212.     unsigned                protocol:3;
  213.     unsigned                blocked:1;
  214.     unsigned                quit:1;
  215.     unsigned                quoted:1;
  216.     unsigned                backslash:1;
  217.     unsigned                no_sync_literal:1;
  218.     unsigned                starttls:1;
  219.     unsigned                esmtp:1;
  220.     unsigned                auth_method:3;
  221.     unsigned                auth_wait:1;

  223.     ngx_str_t               login;
  224.     ngx_str_t               passwd;

  226.     ngx_str_t               salt;
  227.     ngx_str_t               tag;
  228.     ngx_str_t               tagged_line;
  229.     ngx_str_t               text;

  231.     ngx_str_t              *addr_text;
  232.     ngx_str_t               host;
  233.     ngx_str_t               smtp_helo;
  234.     ngx_str_t               smtp_from;
  235.     ngx_str_t               smtp_to;

  237.     ngx_str_t               cmd;

  239.     ngx_uint_t              command;
  240.     ngx_array_t             args;

  242.     ngx_uint_t              login_attempt;

  244.     /* used to parse POP3/IMAP/SMTP command */

  246.     ngx_uint_t              state;
  247.     u_char                 *cmd_start;
  248.     u_char                 *arg_start;
  249.     u_char                 *arg_end;
  250.     ngx_uint_t              literal_len;
  251. ‌} ngx_mail_session_t;


  254. typedef struct {
  255.     ngx_str_t              *client;
  256.     ngx_mail_session_t     *session;
  257. ‌} ngx_mail_log_ctx_t;


  260. ‌#define NGX_POP3_USER          1
  261. ‌#define NGX_POP3_PASS          2
  262. ‌#define NGX_POP3_CAPA          3
  263. ‌#define NGX_POP3_QUIT          4
  264. ‌#define NGX_POP3_NOOP          5
  265. ‌#define NGX_POP3_STLS          6
  266. ‌#define NGX_POP3_APOP          7
  267. ‌#define NGX_POP3_AUTH          8
  268. ‌#define NGX_POP3_STAT          9
  269. ‌#define NGX_POP3_LIST          10
  270. ‌#define NGX_POP3_RETR          11
  271. ‌#define NGX_POP3_DELE          12
  272. ‌#define NGX_POP3_RSET          13
  273. ‌#define NGX_POP3_TOP           14
  274. ‌#define NGX_POP3_UIDL          15


  277. ‌#define NGX_IMAP_LOGIN         1
  278. ‌#define NGX_IMAP_LOGOUT        2
  279. ‌#define NGX_IMAP_CAPABILITY    3
  280. ‌#define NGX_IMAP_NOOP          4
  281. ‌#define NGX_IMAP_STARTTLS      5

  283. ‌#define NGX_IMAP_NEXT          6

  285. ‌#define NGX_IMAP_AUTHENTICATE  7


  288. ‌#define NGX_SMTP_HELO          1
  289. ‌#define NGX_SMTP_EHLO          2
  290. ‌#define NGX_SMTP_AUTH          3
  291. ‌#define NGX_SMTP_QUIT          4
  292. ‌#define NGX_SMTP_NOOP          5
  293. ‌#define NGX_SMTP_MAIL          6
  294. ‌#define NGX_SMTP_RSET          7
  295. ‌#define NGX_SMTP_RCPT          8
  296. ‌#define NGX_SMTP_DATA          9
  297. ‌#define NGX_SMTP_VRFY          10
  298. ‌#define NGX_SMTP_EXPN          11
  299. ‌#define NGX_SMTP_HELP          12
  300. ‌#define NGX_SMTP_STARTTLS      13


  303. ‌#define NGX_MAIL_AUTH_PLAIN             0
  304. ‌#define NGX_MAIL_AUTH_LOGIN             1
  305. ‌#define NGX_MAIL_AUTH_LOGIN_USERNAME    2
  306. ‌#define NGX_MAIL_AUTH_APOP              3
  307. ‌#define NGX_MAIL_AUTH_CRAM_MD5          4
  308. ‌#define NGX_MAIL_AUTH_NONE              5


  311. ‌#define NGX_MAIL_AUTH_PLAIN_ENABLED     0x0002
  312. ‌#define NGX_MAIL_AUTH_LOGIN_ENABLED     0x0004
  313. ‌#define NGX_MAIL_AUTH_APOP_ENABLED      0x0008
  314. ‌#define NGX_MAIL_AUTH_CRAM_MD5_ENABLED  0x0010
  315. ‌#define NGX_MAIL_AUTH_NONE_ENABLED      0x0020


  318. ‌#define NGX_MAIL_PARSE_INVALID_COMMAND  20


  321. ‌typedef void (*ngx_mail_init_session_pt)(ngx_mail_session_t *s,
  322.     ngx_connection_t *c);
  323. ‌typedef void (*ngx_mail_init_protocol_pt)(ngx_event_t *rev);
  324. ‌typedef void (*ngx_mail_auth_state_pt)(ngx_event_t *rev);
  325. ‌typedef ngx_int_t (*ngx_mail_parse_command_pt)(ngx_mail_session_t *s);


  328. ‌struct ngx_mail_protocol_s {
  329.     ngx_str_t                   name;
  330.     in_port_t                   port[4];
  331.     ngx_uint_t                  type;

  333.     ngx_mail_init_session_pt    init_session;
  334.     ngx_mail_init_protocol_pt   init_protocol;
  335.     ngx_mail_parse_command_pt   parse_command;
  336.     ngx_mail_auth_state_pt      auth_state;

  338.     ngx_str_t                   internal_server_error;
  339. };


  342. typedef struct {
  343.     ngx_mail_protocol_t        *protocol;

  345.     void                       *(*create_main_conf)(ngx_conf_t *cf);
  346.     char                       *(*init_main_conf)(ngx_conf_t *cf, void *conf);

  348.     void                       *(*create_srv_conf)(ngx_conf_t *cf);
  349.     char                       *(*merge_srv_conf)(ngx_conf_t *cf, void *prev,
  350.                                       void *conf);
  351. ‌} ngx_mail_module_t;


  354. ‌#define NGX_MAIL_MODULE         0x4C49414D     /* "MAIL" */

  356. ‌#define NGX_MAIL_MAIN_CONF      0x02000000
  357. ‌#define NGX_MAIL_SRV_CONF       0x04000000


  360. ‌#define NGX_MAIL_MAIN_CONF_OFFSET  offsetof(ngx_mail_conf_ctx_t, main_conf)
  361. ‌#define NGX_MAIL_SRV_CONF_OFFSET   offsetof(ngx_mail_conf_ctx_t, srv_conf)


  364. ‌#define ngx_mail_get_module_ctx(s, module)     (s)->ctx[module.ctx_index]
  365. ‌#define ngx_mail_set_ctx(s, c, module)         s->ctx[module.ctx_index] = c;
  366. ‌#define ngx_mail_delete_ctx(s, module)         s->ctx[module.ctx_index] = NULL;


  369. ‌#define ngx_mail_get_module_main_conf(s, module)                             \
  370.     (s)->main_conf[module.ctx_index]
  371. ‌#define ngx_mail_get_module_srv_conf(s, module)  (s)->srv_conf[module.ctx_index]

  373. ‌#define ngx_mail_conf_get_module_main_conf(cf, module)                       \
  374.     ((ngx_mail_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index]
  375. ‌#define ngx_mail_conf_get_module_srv_conf(cf, module)                        \
  376.     ((ngx_mail_conf_ctx_t *) cf->ctx)->srv_conf[module.ctx_index]


  379. #if (NGX_MAIL_SSL)
  380. void ngx_mail_starttls_handler(ngx_event_t *rev);
  381. ngx_int_t ngx_mail_starttls_only(ngx_mail_session_t *s, ngx_connection_t *c);
  382. #endif


  385. void ngx_mail_init_connection(ngx_connection_t *c);

  387. ngx_int_t ngx_mail_salt(ngx_mail_session_t *s, ngx_connection_t *c,
  388.     ngx_mail_core_srv_conf_t *cscf);
  389. ngx_int_t ngx_mail_auth_plain(ngx_mail_session_t *s, ngx_connection_t *c,
  390.     ngx_uint_t n);
  391. ngx_int_t ngx_mail_auth_login_username(ngx_mail_session_t *s,
  392.     ngx_connection_t *c, ngx_uint_t n);
  393. ngx_int_t ngx_mail_auth_login_password(ngx_mail_session_t *s,
  394.     ngx_connection_t *c);
  395. ngx_int_t ngx_mail_auth_cram_md5_salt(ngx_mail_session_t *s,
  396.     ngx_connection_t *c, char *prefix, size_t len);
  397. ngx_int_t ngx_mail_auth_cram_md5(ngx_mail_session_t *s, ngx_connection_t *c);
  398. ngx_int_t ngx_mail_auth_parse(ngx_mail_session_t *s, ngx_connection_t *c);

  400. void ngx_mail_send(ngx_event_t *wev);
  401. ngx_int_t ngx_mail_read_command(ngx_mail_session_t *s, ngx_connection_t *c);
  402. void ngx_mail_auth(ngx_mail_session_t *s, ngx_connection_t *c);
  403. void ngx_mail_close_connection(ngx_connection_t *c);
  404. void ngx_mail_session_internal_server_error(ngx_mail_session_t *s);
  405. u_char *ngx_mail_log_error(ngx_log_t *log, u_char *buf, size_t len);


  408. char *ngx_mail_capabilities(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);


  411. /* STUB */
  412. void ngx_mail_proxy_init(ngx_mail_session_t *s, ngx_addr_t *peer);
  413. void ngx_mail_auth_http_init(ngx_mail_session_t *s);
  414. /**/


  417. extern ngx_uint_t    ngx_mail_max_module;
  418. extern ngx_module_t  ngx_mail_core_module;


  421. #endif /* _NGX_MAIL_H_INCLUDED_ */

One Level Up Top Level