postlicyd/query.h

   1 /******************************************************************************/
   2 /*          pfixtools: a collection of postfix related tools                  */
   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  * Copyright © 2008 Florent Bruneau
  35  */
  36
  37 #ifndef PFIXTOOLS_QUERY_H
  38 #define PFIXTOOLS_QUERY_H
  39
  40 #include "mem.h"
  41 #include "common.h"
  42
  43 enum smtp_state {
  44     SMTP_CONNECT,
  45     SMTP_EHLO,
  46     SMTP_HELO = SMTP_EHLO,
  47     SMTP_MAIL,
  48     SMTP_RCPT,
  49     SMTP_DATA,
  50     SMTP_END_OF_MESSAGE,
  51     SMTP_VRFY,
  52     SMTP_ETRN,
  53     SMTP_count,
  54     SMTP_UNKNOWN,
  55 };
  56
  57 /* \see http://www.postfix.org/SMTPD_POLICY_README.html */
  58 typedef struct query_t {
  59     unsigned state : 4;
  60     unsigned esmtp : 1;
  61
  62     const char *helo_name;
  63     const char *queue_id;
  64     const char *sender;
  65     const char *recipient;
  66     const char *recipient_count;
  67     const char *client_address;
  68     const char *client_name;
  69     const char *reverse_client_name;
  70     const char *instance;
  71
  72     /* useful data extracted from previous ones */
  73     const char *sender_domain;
  74     const char *recipient_domain;
  75
  76     /* postfix 2.2+ */
  77     const char *sasl_method;
  78     const char *sasl_username;
  79     const char *sasl_sender;
  80     const char *size;
  81     const char *ccert_subject;
  82     const char *ccert_issuer;
  83     const char *ccert_fingerprint;
  84
  85     /* postfix 2.3+ */
  86     const char *encryption_protocol;
  87     const char *encryption_cipher;
  88     const char *encryption_keysize;
  89     const char *etrn_domain;
  90
  91     /* postfix 2.5+ */
  92     const char *stress;
  93
  94     const char *eoq;
  95 } query_t;
  96
  97 /** Parse the content of the text to fill the query.
  98  * The text pointed by \p p is segmented (and modified to add
  99  * a \0 at the end of each segment) and used to fill the query
 100  * object.
 101  */
 102 __attribute__((nonnull(1,2)))
 103 bool query_parse(query_t *query, char *p);
 104
 105 #endif