job.h

   1 /******************************************************************************/
   2 /*          postlicyd: a postfix policy daemon with a lot of features         */
   3 /*          ~~~~~~~~~                                                         */
   4 /*  ________________________________________________________________________  */
   5 /*                                                                            */
   6 /*  Redistribution and use in source and binary forms, with or without        */
   7 /*  modification, are permitted provided that the following conditions        */
   8 /*  are met:                                                                  */
   9 /*                                                                            */
  10 /*  1. Redistributions of source code must retain the above copyright         */
  11 /*     notice, this list of conditions and the following disclaimer.          */
  12 /*  2. Redistributions in binary form must reproduce the above copyright      */
  13 /*     notice, this list of conditions and the following disclaimer in the    */
  14 /*     documentation and/or other materials provided with the distribution.   */
  15 /*  3. The names of its contributors may not be used to endorse or promote    */
  16 /*     products derived from this software without specific prior written     */
  17 /*     permission.                                                            */
  18 /*                                                                            */
  19 /*  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND   */
  20 /*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE     */
  21 /*  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR        */
  22 /*  PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS    */
  23 /*  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR    */
  24 /*  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF      */
  25 /*  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS  */
  26 /*  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN   */
  27 /*  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)   */
  28 /*  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF    */
  29 /*  THE POSSIBILITY OF SUCH DAMAGE.                                           */
  30 /******************************************************************************/
  31
  32 /*
  33  * Copyright © 2007 Pierre Habouzit
  34  */
  35
  36 #ifndef POSTLICYD_JOB_H
  37 #define POSTLICYD_JOB_H
  38
  39 #include "buffer.h"
  40
  41 enum job_state {
  42     JOB_IDLE   = 0x00,
  43     JOB_READ   = 0x01,
  44     JOB_WRITE  = 0x02,
  45     JOB_RDWR   = 0x03,
  46     JOB_CONN   = 0x04,
  47     JOB_LISTEN = 0x08,
  48 };
  49
  50 enum smtp_state {
  51     STATE_CONNECT,
  52     STATE_HELO, /* or EHLO */
  53     STATE_MAIL,
  54     STATE_RCPT,
  55     STATE_DATE,
  56     STATE_EOM,
  57     STATE_VRFY,
  58     STATE_ETRN,
  59 };
  60
  61 typedef struct job_t   job_t;
  62 typedef struct jpriv_t jpriv_t;
  63 typedef struct task_t  task_t;
  64 typedef struct tpriv_t tpriv_t;
  65 typedef struct query_t query_t;
  66
  67 struct task_t {
  68     void (*start)(job_t *, query_t *);
  69     void (*stop)(job_t *);
  70     void (*cancel)(job_t *);
  71     void (*process)(job_t *);
  72
  73     tpriv_t *tdata;
  74 };
  75
  76 struct job_t {
  77     unsigned state : 6;
  78     unsigned done  : 1;
  79     unsigned error : 1;
  80
  81     int fd;
  82
  83     task_t  *task;
  84     jpriv_t *jdata;
  85 };
  86
  87 static inline job_t *job_init(job_t *job) {
  88     p_clear(job, 1);
  89     job->fd = -1;
  90     return job;
  91 }
  92 DO_NEW(job_t, job);
  93 void job_release(job_t **job);
  94 void job_update_events(job_t *job);
  95
  96 struct query_t {
  97     unsigned state : 4;
  98     unsigned esmtp : 1;
  99
 100     const char *helo_name;
 101     const char *queue_id;
 102     const char *sender;
 103     const char *recipient;
 104     const char *recipient_count;
 105     const char *client_address;
 106     const char *client_name;
 107     const char *rclient_name;
 108     const char *instance;
 109
 110     /* postfix 2.2+ */
 111     const char *sasl_method;
 112     const char *sasl_username;
 113     const char *sasl_sender;
 114     const char *size;
 115     const char *ccert_subject;
 116     const char *ccert_issuer;
 117     const char *ccsert_fingerprint;
 118
 119     /* postfix 2.3+ */
 120     const char *encryption_protocol;
 121     const char *encryption_cipher;
 122     const char *encryption_keysize;
 123     const char *etrn_domain;
 124
 125     buffer_t data;
 126
 127     job_t *postfix;
 128     job_t *current;
 129 };
 130
 131 static inline query_t *query_init(query_t *rq) {
 132     p_clear(rq, 1);
 133     buffer_init(&rq->data);
 134     return rq;
 135 }
 136 static inline void query_wipe(query_t *rq) {
 137     buffer_wipe(&rq->data);
 138 }
 139 DO_NEW(query_t, query);
 140 DO_DELETE(query_t, query);
 141
 142
 143 job_t *job_accept(job_t *listener, int state);
 144
 145 #endif