1 /******************************************************************************/
2 /* pfixtools: a collection of postfix related tools */
4 /* ________________________________________________________________________ */
6 /* Redistribution and use in source and binary forms, with or without */
7 /* modification, are permitted provided that the following conditions */
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 */
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 /******************************************************************************/
33 * Copyright © 2007 Pierre Habouzit
34 * Copyright © 2008 Florent Bruneau
37 #ifndef PFIXTOOLS_QUERY_H
38 #define PFIXTOOLS_QUERY_H
43 #include "policy_tokens.h"
48 SMTP_HELO = SMTP_EHLO,
59 extern const char *smtp_state_names[SMTP_count];
61 /* \see http://www.postfix.org/SMTPD_POLICY_README.html */
62 typedef struct query_t {
66 const char *helo_name;
69 const char *recipient;
70 const char *recipient_count;
71 const char *client_address;
72 const char *client_name;
73 const char *reverse_client_name;
76 /* useful data extracted from previous ones */
77 const char *sender_domain;
78 const char *recipient_domain;
81 const char *sasl_method;
82 const char *sasl_username;
83 const char *sasl_sender;
85 const char *ccert_subject;
86 const char *ccert_issuer;
87 const char *ccert_fingerprint;
90 const char *encryption_protocol;
91 const char *encryption_cipher;
92 const char *encryption_keysize;
93 const char *etrn_domain;
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
106 __attribute__((nonnull(1,2)))
107 bool query_parse(query_t *query, char *p);
109 /** Return the value of the field with the given name.
111 __attribute__((nonnull(1,2)))
112 const char *query_field_for_name(const query_t *query, const char *name);
114 /** Returns the value of the field with the given id.
116 __attribute__((nonnull))
117 const char *query_field_for_id(const query_t *query, postlicyd_token id);
119 /** Formats the given string by replacing ${field_name} with the content
121 * Unknown and empty fields are filled with (null).
123 __attribute__((nonnull(3)))
124 ssize_t query_format(char *dest, size_t len, const char* fmt, const query_t *query);
126 /** Writes a query-formated string in a buffer.
128 __attribute__((nonnull(1,2)))
129 bool query_format_buffer(buffer_t *buf, const char *fmt, const query_t *query);
131 /** Check the query-format string.
133 #define query_format_check(fmt) (query_format(NULL, 0, fmt, NULL) >= 0)