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 #include "policy_tokens.h"
  43
  44 enum smtp_state {
  45     SMTP_CONNECT,
  46     SMTP_EHLO,
  47     SMTP_HELO = SMTP_EHLO,
  48     SMTP_MAIL,
  49     SMTP_RCPT,
  50     SMTP_DATA,
  51     SMTP_END_OF_MESSAGE,
  52     SMTP_VRFY,
  53     SMTP_ETRN,
  54     SMTP_count,
  55     SMTP_UNKNOWN,
  56 };
  57
  58 extern const char *smtp_state_names[SMTP_count];
  59
  60 /* \see http://www.postfix.org/SMTPD_POLICY_README.html */
  61 typedef struct query_t {
  62     unsigned state : 4;
  63     unsigned esmtp : 1;
  64
  65     const char *helo_name;
  66     const char *queue_id;
  67     const char *sender;
  68     const char *recipient;
  69     const char *recipient_count;
  70     const char *client_address;
  71     const char *client_name;
  72     const char *reverse_client_name;
  73     const char *instance;
  74
  75     /* useful data extracted from previous ones */
  76     const char *sender_domain;
  77     const char *recipient_domain;
  78
  79     /* postfix 2.2+ */
  80     const char *sasl_method;
  81     const char *sasl_username;
  82     const char *sasl_sender;
  83     const char *size;
  84     const char *ccert_subject;
  85     const char *ccert_issuer;
  86     const char *ccert_fingerprint;
  87
  88     /* postfix 2.3+ */
  89     const char *encryption_protocol;
  90     const char *encryption_cipher;
  91     const char *encryption_keysize;
  92     const char *etrn_domain;
  93
  94     /* postfix 2.5+ */
  95     const char *stress;
  96
  97     const char *eoq;
  98 } query_t;
  99
 100 /** Parse the content of the text to fill the query.
 101  * The text pointed by \p p is segmented (and modified to add
 102  * a \0 at the end of each segment) and used to fill the query
 103  * object.
 104  */
 105 __attribute__((nonnull(1,2)))
 106 bool query_parse(query_t *query, char *p);
 107
 108 /** Return the value of the field with the given name.
 109  */
 110 __attribute__((nonnull(1,2)))
 111 const char *query_field_for_name(const query_t *query, const char *name);
 112
 113 /** Returns the value of the field with the given id.
 114  */
 115 __attribute__((nonnull))
 116 const char *query_field_for_id(const query_t *query, postlicyd_token id);
 117
 118 /** Formats the given string by replacing ${field_name} with the content
 119  * of the query.
 120  * Unknown and empty fields are filled with (null).
 121  */
 122 __attribute__((nonnull(3)))
 123 ssize_t query_format(char *dest, size_t len, const char* fmt, const query_t *query);
 124
 125 #endif