One Level Up Top Level

src/mail/ngx_mail.h - nginx

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.     struct sockaddr        *sockaddr;
  31.     socklen_t               socklen;
  32.     ngx_str_t               addr_text;

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

  37.     unsigned                bind:1;
  38.     unsigned                wildcard:1;
  39.     unsigned                ssl:1;
  40. #if (NGX_HAVE_INET6)
  41.     unsigned                ipv6only:1;
  42. #endif
  43.     unsigned                so_keepalive:2;
  44.     unsigned                proxy_protocol:1;
  45. #if (NGX_HAVE_KEEPALIVE_TUNABLE)
  46.     int                     tcp_keepidle;
  47.     int                     tcp_keepintvl;
  48.     int                     tcp_keepcnt;
  49. #endif
  50.     int                     protocol;
  51.     int                     backlog;
  52.     int                     rcvbuf;
  53.     int                     sndbuf;
  54. ‌} ngx_mail_listen_t;


  57. ‌typedef struct {
  58.     ngx_mail_conf_ctx_t    *ctx;
  59.     ngx_str_t               addr_text;
  60.     unsigned                ssl:1;
  61.     unsigned                proxy_protocol:1;
  62. ‌} ngx_mail_addr_conf_t;

  64. ‌typedef struct {
  65.     in_addr_t               addr;
  66.     ngx_mail_addr_conf_t    conf;
  67. ‌} ngx_mail_in_addr_t;


  70. #if (NGX_HAVE_INET6)

  72. ‌typedef struct {
  73.     struct in6_addr         addr6;
  74.     ngx_mail_addr_conf_t    conf;
  75. ‌} ngx_mail_in6_addr_t;

  77. #endif


  80. ‌typedef struct {
  81.     /* ngx_mail_in_addr_t or ngx_mail_in6_addr_t */
  82.     void                   *addrs;
  83.     ngx_uint_t              naddrs;
  84. ‌} ngx_mail_port_t;


  87. ‌typedef struct {
  88.     int                     family;
  89.     in_port_t               port;
  90.     ngx_array_t             addrs;       /* array of ngx_mail_conf_addr_t */
  91. ‌} ngx_mail_conf_port_t;


  94. ‌typedef struct {
  95.     ngx_mail_listen_t       opt;
  96. ‌} ngx_mail_conf_addr_t;


  99. ‌typedef struct {
  100.     ngx_array_t             servers;     /* ngx_mail_core_srv_conf_t */
  101.     ngx_array_t             listen;      /* ngx_mail_listen_t */
  102. ‌} ngx_mail_core_main_conf_t;


  105. ‌#define NGX_MAIL_POP3_PROTOCOL  0
  106. ‌#define NGX_MAIL_IMAP_PROTOCOL  1
  107. ‌#define NGX_MAIL_SMTP_PROTOCOL  2


  110. ‌typedef struct ngx_mail_protocol_s  ngx_mail_protocol_t;


  113. ‌typedef struct {
  114.     ngx_mail_protocol_t    *protocol;

  116.     ngx_msec_t              timeout;
  117.     ngx_msec_t              resolver_timeout;

  119.     ngx_uint_t              max_errors;

  121.     ngx_str_t               server_name;

  123.     u_char                 *file_name;
  124.     ngx_uint_t              line;

  126.     ngx_resolver_t         *resolver;
  127.     ngx_log_t              *error_log;

  129.     /* server ctx */
  130.     ngx_mail_conf_ctx_t    *ctx;

  132.     ngx_uint_t              listen;  /* unsigned  listen:1; */
  133. ‌} ngx_mail_core_srv_conf_t;


  136. ‌typedef enum {
  137.     ngx_pop3_start = 0,
  138.     ngx_pop3_user,
  139.     ngx_pop3_passwd,
  140.     ngx_pop3_auth_login_username,
  141.     ngx_pop3_auth_login_password,
  142.     ngx_pop3_auth_plain,
  143.     ngx_pop3_auth_cram_md5,
  144.     ngx_pop3_auth_external
  145. ‌} ngx_pop3_state_e;


  148. ‌typedef enum {
  149.     ngx_imap_start = 0,
  150.     ngx_imap_auth_login_username,
  151.     ngx_imap_auth_login_password,
  152.     ngx_imap_auth_plain,
  153.     ngx_imap_auth_cram_md5,
  154.     ngx_imap_auth_external,
  155.     ngx_imap_login,
  156.     ngx_imap_user,
  157.     ngx_imap_passwd
  158. ‌} ngx_imap_state_e;


  161. ‌typedef enum {
  162.     ngx_smtp_start = 0,
  163.     ngx_smtp_auth_login_username,
  164.     ngx_smtp_auth_login_password,
  165.     ngx_smtp_auth_plain,
  166.     ngx_smtp_auth_cram_md5,
  167.     ngx_smtp_auth_external,
  168.     ngx_smtp_helo,
  169.     ngx_smtp_helo_xclient,
  170.     ngx_smtp_helo_auth,
  171.     ngx_smtp_helo_from,
  172.     ngx_smtp_xclient,
  173.     ngx_smtp_xclient_from,
  174.     ngx_smtp_xclient_helo,
  175.     ngx_smtp_xclient_auth,
  176.     ngx_smtp_from,
  177.     ngx_smtp_to
  178. ‌} ngx_smtp_state_e;


  181. ‌typedef struct {
  182.     ngx_peer_connection_t   upstream;
  183.     ngx_buf_t              *buffer;
  184.     ngx_uint_t              proxy_protocol;  /* unsigned  proxy_protocol:1; */
  185. ‌} ngx_mail_proxy_ctx_t;


  188. ‌typedef struct {
  189.     uint32_t                signature;         /* "MAIL" */

  191.     ngx_connection_t       *connection;

  193.     ngx_str_t               out;
  194.     ngx_buf_t              *buffer;

  196.     void                  **ctx;
  197.     void                  **main_conf;
  198.     void                  **srv_conf;

  200.     ngx_resolver_ctx_t     *resolver_ctx;

  202.     ngx_mail_proxy_ctx_t   *proxy;

  204.     ngx_uint_t              mail_state;

  206.     unsigned                ssl:1;
  207.     unsigned                protocol:3;
  208.     unsigned                blocked:1;
  209.     unsigned                quit:1;
  210.     unsigned                quoted:1;
  211.     unsigned                backslash:1;
  212.     unsigned                no_sync_literal:1;
  213.     unsigned                starttls:1;
  214.     unsigned                esmtp:1;
  215.     unsigned                auth_method:3;
  216.     unsigned                auth_wait:1;

  218.     ngx_str_t               login;
  219.     ngx_str_t               passwd;

  221.     ngx_str_t               salt;
  222.     ngx_str_t               tag;
  223.     ngx_str_t               tagged_line;
  224.     ngx_str_t               text;

  226.     ngx_str_t              *addr_text;
  227.     ngx_str_t               host;
  228.     ngx_str_t               smtp_helo;
  229.     ngx_str_t               smtp_from;
  230.     ngx_str_t               smtp_to;

  232.     ngx_str_t               cmd;

  234.     ngx_uint_t              command;
  235.     ngx_array_t             args;

  237.     ngx_uint_t              errors;
  238.     ngx_uint_t              login_attempt;

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

  242.     ngx_uint_t              state;
  243.     u_char                 *tag_start;
  244.     u_char                 *cmd_start;
  245.     u_char                 *arg_start;
  246.     ngx_uint_t              literal_len;
  247. ‌} ngx_mail_session_t;


  250. ‌typedef struct {
  251.     ngx_str_t              *client;
  252.     ngx_mail_session_t     *session;
  253. ‌} ngx_mail_log_ctx_t;


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


  273. ‌#define NGX_IMAP_LOGIN         1
  274. ‌#define NGX_IMAP_LOGOUT        2
  275. ‌#define NGX_IMAP_CAPABILITY    3
  276. ‌#define NGX_IMAP_NOOP          4
  277. ‌#define NGX_IMAP_STARTTLS      5

  279. ‌#define NGX_IMAP_NEXT          6

  281. ‌#define NGX_IMAP_AUTHENTICATE  7


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


  299. ‌#define NGX_MAIL_AUTH_PLAIN             0
  300. ‌#define NGX_MAIL_AUTH_LOGIN             1
  301. ‌#define NGX_MAIL_AUTH_LOGIN_USERNAME    2
  302. ‌#define NGX_MAIL_AUTH_APOP              3
  303. ‌#define NGX_MAIL_AUTH_CRAM_MD5          4
  304. ‌#define NGX_MAIL_AUTH_EXTERNAL          5
  305. ‌#define NGX_MAIL_AUTH_NONE              6


  308. ‌#define NGX_MAIL_AUTH_PLAIN_ENABLED     0x0002
  309. ‌#define NGX_MAIL_AUTH_LOGIN_ENABLED     0x0004
  310. ‌#define NGX_MAIL_AUTH_APOP_ENABLED      0x0008
  311. ‌#define NGX_MAIL_AUTH_CRAM_MD5_ENABLED  0x0010
  312. ‌#define NGX_MAIL_AUTH_EXTERNAL_ENABLED  0x0020
  313. ‌#define NGX_MAIL_AUTH_NONE_ENABLED      0x0040


  316. ‌#define NGX_MAIL_PARSE_INVALID_COMMAND  20


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


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

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

  337.     ngx_str_t                   internal_server_error;
  338.     ngx_str_t                   cert_error;
  339.     ngx_str_t                   no_cert;
  340. };


  343. ‌typedef struct {
  344.     ngx_mail_protocol_t        *protocol;

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

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


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

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


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


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


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

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


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


  386. void ngx_mail_init_connection(ngx_connection_t *c);

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

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


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


  414. /* STUB */
  415. void ngx_mail_proxy_init(ngx_mail_session_t *s, ngx_addr_t *peer);
  416. void ngx_mail_auth_http_init(ngx_mail_session_t *s);
  417. ngx_int_t ngx_mail_realip_handler(ngx_mail_session_t *s);
  418. /**/


  421. extern ngx_uint_t    ngx_mail_max_module;
  422. extern ngx_module_t  ngx_mail_core_module;


  425. #endif /* _NGX_MAIL_H_INCLUDED_ */

One Level Up Top Level