1 /* $NetBSD: milter.h,v 1.2 2017/02/14 01:16:45 christos Exp $ */ 2 3 #ifndef _MILTER_H_INCLUDED_ 4 #define _MILTER_H_INCLUDED_ 5 6 /*++ 7 /* NAME 8 /* milter 3h 9 /* SUMMARY 10 /* smtp server 11 /* SYNOPSIS 12 /* Postfix MTA-side Milter implementation 13 /* DESCRIPTION 14 /* .nf 15 16 /* 17 * Utility library. 18 */ 19 #include <vstring.h> 20 #include <vstream.h> 21 #include <argv.h> 22 23 /* 24 * Global library. 25 */ 26 #include <attr.h> 27 28 /* 29 * Each Milter handle is an element of a null-terminated linked list. The 30 * functions are virtual so that we can support multiple MTA-side Milter 31 * implementations. The Sendmail 8 and Sendmail X Milter-side APIs are too 32 * different to implement the MTA side as a single hybrid. 33 */ 34 typedef struct MILTER { 35 char *name; /* full name including transport */ 36 int flags; /* see below */ 37 struct MILTER *next; /* linkage */ 38 struct MILTERS *parent; /* parent information */ 39 struct MILTER_MACROS *macros; /* private macros */ 40 const char *(*conn_event) (struct MILTER *, const char *, const char *, const char *, unsigned, ARGV *); 41 const char *(*helo_event) (struct MILTER *, const char *, int, ARGV *); 42 const char *(*mail_event) (struct MILTER *, const char **, ARGV *); 43 const char *(*rcpt_event) (struct MILTER *, const char **, ARGV *); 44 const char *(*data_event) (struct MILTER *, ARGV *); 45 const char *(*message) (struct MILTER *, VSTREAM *, off_t, ARGV *, ARGV *, ARGV *); 46 const char *(*unknown_event) (struct MILTER *, const char *, ARGV *); 47 const char *(*other_event) (struct MILTER *); 48 void (*abort) (struct MILTER *); 49 void (*disc_event) (struct MILTER *); 50 int (*active) (struct MILTER *); 51 int (*send) (struct MILTER *, VSTREAM *); 52 void (*free) (struct MILTER *); 53 } MILTER; 54 55 #define MILTER_FLAG_NONE (0) 56 #define MILTER_FLAG_WANT_RCPT_REJ (1<<0) /* see S8_RCPT_MAILER_ERROR */ 57 58 extern MILTER *milter8_create(const char *, int, int, int, const char *, const char *, struct MILTERS *); 59 extern MILTER *milter8_receive(VSTREAM *, struct MILTERS *); 60 61 /* 62 * As of Sendmail 8.14 each milter can override the default macro list. If a 63 * Milter has its own macro list, a null member means use the global 64 * definition. 65 */ 66 typedef struct MILTER_MACROS { 67 char *conn_macros; /* macros for connect event */ 68 char *helo_macros; /* macros for HELO/EHLO command */ 69 char *mail_macros; /* macros for MAIL FROM command */ 70 char *rcpt_macros; /* macros for RCPT TO command */ 71 char *data_macros; /* macros for DATA command */ 72 char *eoh_macros; /* macros for end-of-headers */ 73 char *eod_macros; /* macros for END-OF-DATA command */ 74 char *unk_macros; /* macros for unknown command */ 75 } MILTER_MACROS; 76 77 extern MILTER_MACROS *milter_macros_create(const char *, const char *, 78 const char *, const char *, 79 const char *, const char *, 80 const char *, const char *); 81 extern MILTER_MACROS *milter_macros_alloc(int); 82 extern void milter_macros_free(MILTER_MACROS *); 83 extern int milter_macros_print(ATTR_PRINT_MASTER_FN, VSTREAM *, int, void *); 84 extern int milter_macros_scan(ATTR_SCAN_MASTER_FN, VSTREAM *, int, void *); 85 86 #define MILTER_MACROS_ALLOC_ZERO 1 /* null pointer */ 87 #define MILTER_MACROS_ALLOC_EMPTY 2 /* mystrdup(""); */ 88 89 /* 90 * Helper to parse list of name=value default macro settings. 91 */ 92 extern struct HTABLE *milter_macro_defaults_create(const char *); 93 94 /* 95 * A bunch of Milters. 96 */ 97 typedef const char *(*MILTER_MAC_LOOKUP_FN) (const char *, void *); 98 typedef const char *(*MILTER_ADD_HEADER_FN) (void *, const char *, const char *, const char *); 99 typedef const char *(*MILTER_EDIT_HEADER_FN) (void *, ssize_t, const char *, const char *, const char *); 100 typedef const char *(*MILTER_DEL_HEADER_FN) (void *, ssize_t, const char *); 101 typedef const char *(*MILTER_EDIT_FROM_FN) (void *, const char *, const char *); 102 typedef const char *(*MILTER_EDIT_RCPT_FN) (void *, const char *); 103 typedef const char *(*MILTER_EDIT_RCPT_PAR_FN) (void *, const char *, const char *); 104 typedef const char *(*MILTER_EDIT_BODY_FN) (void *, int, VSTRING *); 105 106 typedef struct MILTERS { 107 MILTER *milter_list; /* linked list of Milters */ 108 MILTER_MAC_LOOKUP_FN mac_lookup; 109 void *mac_context; /* macro lookup context */ 110 struct MILTER_MACROS *macros; 111 struct HTABLE *macro_defaults; 112 void *chg_context; /* context for queue file changes */ 113 MILTER_ADD_HEADER_FN add_header; 114 MILTER_EDIT_HEADER_FN upd_header; 115 MILTER_DEL_HEADER_FN del_header; 116 MILTER_EDIT_HEADER_FN ins_header; 117 MILTER_EDIT_FROM_FN chg_from; 118 MILTER_EDIT_RCPT_FN add_rcpt; 119 MILTER_EDIT_RCPT_PAR_FN add_rcpt_par; 120 MILTER_EDIT_RCPT_FN del_rcpt; 121 MILTER_EDIT_BODY_FN repl_body; 122 } MILTERS; 123 124 #define milter_create(milter_names, conn_timeout, cmd_timeout, msg_timeout, \ 125 protocol, def_action, conn_macros, helo_macros, \ 126 mail_macros, rcpt_macros, data_macros, eoh_macros, \ 127 eod_macros, unk_macros, macro_deflts) \ 128 milter_new(milter_names, conn_timeout, cmd_timeout, msg_timeout, \ 129 protocol, def_action, milter_macros_create(conn_macros, \ 130 helo_macros, mail_macros, rcpt_macros, data_macros, \ 131 eoh_macros, eod_macros, unk_macros), \ 132 milter_macro_defaults_create(macro_deflts)) 133 134 extern MILTERS *milter_new(const char *, int, int, int, const char *, 135 const char *, MILTER_MACROS *, 136 struct HTABLE *); 137 extern void milter_macro_callback(MILTERS *, MILTER_MAC_LOOKUP_FN, void *); 138 extern void milter_edit_callback(MILTERS *milters, MILTER_ADD_HEADER_FN, 139 MILTER_EDIT_HEADER_FN, MILTER_EDIT_HEADER_FN, 140 MILTER_DEL_HEADER_FN, MILTER_EDIT_FROM_FN, 141 MILTER_EDIT_RCPT_FN, MILTER_EDIT_RCPT_PAR_FN, 142 MILTER_EDIT_RCPT_FN, MILTER_EDIT_BODY_FN, 143 void *); 144 extern const char *milter_conn_event(MILTERS *, const char *, const char *, const char *, unsigned); 145 extern const char *milter_helo_event(MILTERS *, const char *, int); 146 extern const char *milter_mail_event(MILTERS *, const char **); 147 extern const char *milter_rcpt_event(MILTERS *, int, const char **); 148 extern const char *milter_data_event(MILTERS *); 149 extern const char *milter_message(MILTERS *, VSTREAM *, off_t, ARGV *); 150 extern const char *milter_unknown_event(MILTERS *, const char *); 151 extern const char *milter_other_event(MILTERS *); 152 extern void milter_abort(MILTERS *); 153 extern void milter_disc_event(MILTERS *); 154 extern int milter_dummy(MILTERS *, VSTREAM *); 155 extern int milter_send(MILTERS *, VSTREAM *); 156 extern MILTERS *milter_receive(VSTREAM *, int); 157 extern void milter_free(MILTERS *); 158 159 /* 160 * Milter body edit commands. 161 */ 162 #define MILTER_BODY_START 1 /* start message body */ 163 #define MILTER_BODY_LINE 2 /* message body line */ 164 #define MILTER_BODY_END 3 /* end message body */ 165 166 /* 167 * Sendmail 8 macro names. We support forms with and without the {}. 168 */ 169 #define S8_MAC__ "{_}" /* sender resolve */ 170 #define S8_MAC_J "{j}" /* myhostname */ 171 #define S8_MAC_V "{v}" /* mail_name + mail_version */ 172 173 #define S8_MAC_DAEMON_NAME "{daemon_name}" 174 #define S8_MAC_IF_NAME "{if_name}" 175 #define S8_MAC_IF_ADDR "{if_addr}" 176 177 #define S8_MAC_CLIENT_ADDR "{client_addr}" 178 #define S8_MAC_CLIENT_CONN "{client_connections}" 179 #define S8_MAC_CLIENT_NAME "{client_name}" 180 #define S8_MAC_CLIENT_PORT "{client_port}" 181 #define S8_MAC_CLIENT_PTR "{client_ptr}" 182 #define S8_MAC_CLIENT_RES "{client_resolve}" 183 184 #define S8_MAC_TLS_VERSION "{tls_version}" 185 #define S8_MAC_CIPHER "{cipher}" 186 #define S8_MAC_CIPHER_BITS "{cipher_bits}" 187 #define S8_MAC_CERT_SUBJECT "{cert_subject}" 188 #define S8_MAC_CERT_ISSUER "{cert_issuer}" 189 190 #define S8_MAC_I "{i}" /* queue ID */ 191 #define S8_MAC_AUTH_TYPE "{auth_type}" /* SASL method */ 192 #define S8_MAC_AUTH_AUTHEN "{auth_authen}" /* SASL username */ 193 #define S8_MAC_AUTH_AUTHOR "{auth_author}" /* SASL sender */ 194 195 #define S8_MAC_MAIL_MAILER "{mail_mailer}" /* sender transport */ 196 #define S8_MAC_MAIL_HOST "{mail_host}" /* sender nexthop */ 197 #define S8_MAC_MAIL_ADDR "{mail_addr}" /* sender address */ 198 199 #define S8_MAC_RCPT_MAILER "{rcpt_mailer}" /* recip transport */ 200 #define S8_MAC_RCPT_HOST "{rcpt_host}" /* recip nexthop */ 201 #define S8_MAC_RCPT_ADDR "{rcpt_addr}" /* recip address */ 202 203 #define S8_RCPT_MAILER_ERROR "error" /* see MILTER_FLAG_WANT_RCPT_REJ */ 204 205 /* LICENSE 206 /* .ad 207 /* .fi 208 /* The Secure Mailer license must be distributed with this software. 209 /* AUTHOR(S) 210 /* Wietse Venema 211 /* IBM T.J. Watson Research 212 /* P.O. Box 704 213 /* Yorktown Heights, NY 10598, USA 214 /* 215 /* Wietse Venema 216 /* Google, Inc. 217 /* 111 8th Avenue 218 /* New York, NY 10011, USA 219 /*--*/ 220 221 #endif 222