1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
|
/*
* Copyright (c) 1999-2002 Sendmail, Inc. and its suppliers.
* All rights reserved.
*
* By using this file, you agree to the terms and conditions set
* forth in the LICENSE file which can be found at the top level of
* the sendmail distribution.
*
*
* $Id: mfapi.h,v 8.44 2002/06/04 05:06:40 gshapiro Exp $
*/
/*
** MFAPI.H -- Global definitions for mail filter library and mail filters.
*/
#ifndef _LIBMILTER_MFAPI_H
# define _LIBMILTER_MFAPI_H 1
# include <sys/types.h>
# include <sys/socket.h>
# include "libmilter/mfdef.h"
# define LIBMILTER_API extern
#ifndef _SOCK_ADDR
# define _SOCK_ADDR struct sockaddr
#endif /* ! _SOCK_ADDR */
/*
** libmilter functions return one of the following to indicate
** success/failure:
*/
#define MI_SUCCESS 0
#define MI_FAILURE (-1)
/* "forward" declarations */
typedef struct smfi_str SMFICTX;
typedef struct smfi_str *SMFICTX_PTR;
typedef struct smfiDesc smfiDesc_str;
typedef struct smfiDesc *smfiDesc_ptr;
/*
** Type which callbacks should return to indicate message status.
** This may take on one of the SMFIS_* values listed below.
*/
typedef int sfsistat;
#if defined(__linux__) && defined(__GNUC__) && defined(__cplusplus) && __GNUC_MINOR__ >= 8
# define SM__P(X) __PMT(X)
#else /* __linux__ && __GNUC__ && __cplusplus && _GNUC_MINOR__ >= 8 */
# define SM__P(X) __P(X)
#endif /* __linux__ && __GNUC__ && __cplusplus && _GNUC_MINOR__ >= 8 */
/* Some platforms don't define __P -- do it for them here: */
#ifndef __P
# ifdef __STDC__
# define __P(X) X
# else /* __STDC__ */
# define __P(X) ()
# endif /* __STDC__ */
#endif /* __P */
/*
** structure describing one milter
*/
struct smfiDesc
{
char *xxfi_name; /* filter name */
int xxfi_version; /* version code -- do not change */
unsigned long xxfi_flags; /* flags */
/* connection info filter */
sfsistat (*xxfi_connect) SM__P((SMFICTX *, char *, _SOCK_ADDR *));
/* SMTP HELO command filter */
sfsistat (*xxfi_helo) SM__P((SMFICTX *, char *));
/* envelope sender filter */
sfsistat (*xxfi_envfrom) SM__P((SMFICTX *, char **));
/* envelope recipient filter */
sfsistat (*xxfi_envrcpt) SM__P((SMFICTX *, char **));
/* header filter */
sfsistat (*xxfi_header) SM__P((SMFICTX *, char *, char *));
/* end of header */
sfsistat (*xxfi_eoh) SM__P((SMFICTX *));
/* body block */
sfsistat (*xxfi_body) SM__P((SMFICTX *, unsigned char *, size_t));
/* end of message */
sfsistat (*xxfi_eom) SM__P((SMFICTX *));
/* message aborted */
sfsistat (*xxfi_abort) SM__P((SMFICTX *));
/* connection cleanup */
sfsistat (*xxfi_close) SM__P((SMFICTX *));
};
#if _FFR_SMFI_OPENSOCKET
LIBMILTER_API int smfi_opensocket __P((void));
#endif /* _FFR_SMFI_OPENSOCKET */
LIBMILTER_API int smfi_register __P((struct smfiDesc));
LIBMILTER_API int smfi_main __P((void));
LIBMILTER_API int smfi_setbacklog __P((int));
LIBMILTER_API int smfi_setdbg __P((int));
LIBMILTER_API int smfi_settimeout __P((int));
LIBMILTER_API int smfi_setconn __P((char *));
LIBMILTER_API int smfi_stop __P((void));
#define SMFI_VERSION 2 /* version number */
/*
** What the filter might do -- values to be ORed together for
** smfiDesc.xxfi_flags.
*/
#define SMFIF_NONE 0x00000000L /* no flags */
#define SMFIF_ADDHDRS 0x00000001L /* filter may add headers */
#define SMFIF_CHGBODY 0x00000002L /* filter may replace body */
#define SMFIF_MODBODY SMFIF_CHGBODY /* backwards compatible */
#define SMFIF_ADDRCPT 0x00000004L /* filter may add recipients */
#define SMFIF_DELRCPT 0x00000008L /* filter may delete recipients */
#define SMFIF_CHGHDRS 0x00000010L /* filter may change/delete headers */
#if _FFR_QUARANTINE
# define SMFIF_QUARANTINE 0x00000020L /* filter may quarantine envelope */
#endif /* _FFR_QUARANTINE */
/*
** Continue processing message/connection.
*/
#define SMFIS_CONTINUE 0
/*
** Reject the message/connection.
** No further routines will be called for this message
** (or connection, if returned from a connection-oriented routine).
*/
#define SMFIS_REJECT 1
/*
** Accept the message,
** but silently discard the message.
** No further routines will be called for this message.
** This is only meaningful from message-oriented routines.
*/
#define SMFIS_DISCARD 2
/*
** Accept the message/connection.
** No further routines will be called for this message
** (or connection, if returned from a connection-oriented routine;
** in this case, it causes all messages on this connection
** to be accepted without filtering).
*/
#define SMFIS_ACCEPT 3
/*
** Return a temporary failure, i.e.,
** the corresponding SMTP command will return a 4xx status code.
** In some cases this may prevent further routines from
** being called on this message or connection,
** although in other cases (e.g., when processing an envelope
** recipient) processing of the message will continue.
*/
#define SMFIS_TEMPFAIL 4
#if 0
/*
** Filter Routine Details
*/
/* connection info filter */
extern sfsistat xxfi_connect __P((SMFICTX *, char *, _SOCK_ADDR *));
/*
** xxfi_connect(ctx, hostname, hostaddr) Invoked on each connection
**
** char *hostname; Host domain name, as determined by a reverse lookup
** on the host address.
** _SOCK_ADDR *hostaddr; Host address, as determined by a getpeername
** call on the SMTP socket.
*/
/* SMTP HELO command filter */
extern sfsistat xxfi_helo __P((SMFICTX *, char *));
/*
** xxfi_helo(ctx, helohost) Invoked on SMTP HELO/EHLO command
**
** char *helohost; Value passed to HELO/EHLO command, which should be
** the domain name of the sending host (but is, in practice,
** anything the sending host wants to send).
*/
/* envelope sender filter */
extern sfsistat xxfi_envfrom __P((SMFICTX *, char **));
/*
** xxfi_envfrom(ctx, argv) Invoked on envelope from
**
** char **argv; Null-terminated SMTP command arguments;
** argv[0] is guaranteed to be the sender address.
** Later arguments are the ESMTP arguments.
*/
/* envelope recipient filter */
extern sfsistat xxfi_envrcpt __P((SMFICTX *, char **));
/*
** xxfi_envrcpt(ctx, argv) Invoked on each envelope recipient
**
** char **argv; Null-terminated SMTP command arguments;
** argv[0] is guaranteed to be the recipient address.
** Later arguments are the ESMTP arguments.
*/
/* header filter */
extern sfsistat xxfi_header __P((SMFICTX *, char *, char *));
/*
** xxfi_header(ctx, headerf, headerv) Invoked on each message header. The
** content of the header may have folded white space (that is, multiple
** lines with following white space) included.
**
** char *headerf; Header field name
** char *headerv; Header field value
*/
/* end of header */
extern sfsistat xxfi_eoh __P((SMFICTX *));
/*
** xxfi_eoh(ctx) Invoked at end of header
*/
/* body block */
extern sfsistat xxfi_body __P((SMFICTX *, unsigned char *, size_t));
/*
** xxfi_body(ctx, bodyp, bodylen) Invoked for each body chunk. There may
** be multiple body chunks passed to the filter. End-of-lines are
** represented as received from SMTP (normally Carriage-Return/Line-Feed).
**
** unsigned char *bodyp; Pointer to body data
** size_t bodylen; Length of body data
*/
/* end of message */
extern sfsistat xxfi_eom __P((SMFICTX *));
/*
** xxfi_eom(ctx) Invoked at end of message. This routine can perform
** special operations such as modifying the message header, body, or
** envelope.
*/
/* message aborted */
extern sfsistat xxfi_abort __P((SMFICTX *));
/*
** xxfi_abort(ctx) Invoked if message is aborted outside of the control of
** the filter, for example, if the SMTP sender issues an RSET command. If
** xxfi_abort is called, xxfi_eom will not be called and vice versa.
*/
/* connection cleanup */
extern sfsistat xxfi_close __P((SMFICTX *));
/*
** xxfi_close(ctx) Invoked at end of the connection. This is called on
** close even if the previous mail transaction was aborted.
*/
#endif /* 0 */
/*
** Additional information is passed in to the vendor filter routines using
** symbols. Symbols correspond closely to sendmail macros. The symbols
** defined depend on the context. The value of a symbol is accessed using:
*/
/* Return the value of a symbol. */
LIBMILTER_API char * smfi_getsymval __P((SMFICTX *, char *));
/*
** Return the value of a symbol.
**
** SMFICTX *ctx; Opaque context structure
** char *symname; The name of the symbol to access.
*/
/*
** Vendor filter routines that want to pass additional information back to
** the MTA for use in SMTP replies may call smfi_setreply before returning.
*/
LIBMILTER_API int smfi_setreply __P((SMFICTX *, char *, char *, char *));
#if _FFR_MULTILINE
/*
** Alternatively, smfi_setmlreply can be called if a multi-line SMTP reply
** is needed.
*/
LIBMILTER_API int smfi_setmlreply __P((SMFICTX *, const char *, const char *, ...));
#endif /* _FFR_MULTILINE */
/*
** Set the specific reply code to be used in response to the active
** command. If not specified, a generic reply code is used.
**
** SMFICTX *ctx; Opaque context structure
** char *rcode; The three-digit (RFC 821) SMTP reply code to be
** returned, e.g., ``551''.
** char *xcode; The extended (RFC 2034) reply code, e.g., ``5.7.6''.
** char *message; The text part of the SMTP reply.
*/
/*
** The xxfi_eom routine is called at the end of a message (essentially,
** after the final DATA dot). This routine can call some special routines
** to modify the envelope, header, or body of the message before the
** message is enqueued. These routines must not be called from any vendor
** routine other than xxfi_eom.
*/
LIBMILTER_API int smfi_addheader __P((SMFICTX *, char *, char *));
/*
** Add a header to the message. This header is not passed to other
** filters. It is not checked for standards compliance; the mail filter
** must ensure that no protocols are violated as a result of adding this
** header.
**
** SMFICTX *ctx; Opaque context structure
** char *headerf; Header field name
** char *headerv; Header field value
*/
LIBMILTER_API int smfi_chgheader __P((SMFICTX *, char *, int, char *));
/*
** Change/delete a header in the message. It is not checked for standards
** compliance; the mail filter must ensure that no protocols are violated
** as a result of adding this header.
**
** SMFICTX *ctx; Opaque context structure
** char *headerf; Header field name
** int index; The Nth occurence of header field name
** char *headerv; New header field value (empty for delete header)
*/
LIBMILTER_API int smfi_addrcpt __P((SMFICTX *, char *));
/*
** Add a recipient to the envelope
**
** SMFICTX *ctx; Opaque context structure
** char *rcpt; Recipient to be added
*/
LIBMILTER_API int smfi_delrcpt __P((SMFICTX *, char *));
#if _FFR_SMFI_PROGRESS
/*
** Send a "no-op" up to the MTA to tell it we're still alive, so long
** milter-side operations don't time out.
**
** SMFICTX *ctx; Opaque context structure
*/
LIBMILTER_API int smfi_progress __P((SMFICTX *));
#endif /* _FFR_SMFI_PROGRESS */
/*
** Delete a recipient from the envelope
**
** SMFICTX *ctx; Opaque context structure
** char *rcpt; Envelope recipient to be deleted. This should be in
** exactly the form passed to xxfi_envrcpt or the address may
** not be deleted.
*/
LIBMILTER_API int smfi_replacebody __P((SMFICTX *, unsigned char *, int));
/*
** Replace the body of the message. This routine may be called multiple
** times if the body is longer than convenient to send in one call. End of
** line should be represented as Carriage-Return/Line Feed.
**
** char *bodyp; Pointer to block of body information to insert
** int bodylen; Length of data pointed at by bodyp
*/
/*
** If the message is aborted (for example, if the SMTP sender sends the
** envelope but then does a QUIT or RSET before the data is sent),
** xxfi_abort is called. This can be used to reset state.
*/
#if _FFR_QUARANTINE
/*
** Quarantine an envelope
**
** SMFICTX *ctx; Opaque context structure
** char *reason: explanation
*/
LIBMILTER_API int smfi_quarantine __P((SMFICTX *ctx, char *reason));
#endif /* _FFR_QUARANTINE */
/*
** Connection-private data (specific to an SMTP connection) can be
** allocated using the smfi_setpriv routine; routines can access private
** data using smfi_getpriv.
*/
LIBMILTER_API int smfi_setpriv __P((SMFICTX *, void *));
/*
** Set the private data pointer
**
** SMFICTX *ctx; Opaque context structure
** void *privatedata; Pointer to private data area
*/
LIBMILTER_API void *smfi_getpriv __P((SMFICTX *));
#endif /* !_LIBMILTER_MFAPI_H */
|