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