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
|
/*++
/* NAME
/* cleanup_api 3
/* SUMMARY
/* cleanup callable interface, message processing
/* SYNOPSIS
/* #include "cleanup.h"
/*
/* CLEANUP_STATE *cleanup_open()
/*
/* void cleanup_control(state, flags)
/* CLEANUP_STATE *state;
/* int flags;
/*
/* void CLEANUP_RECORD(state, type, buf, len)
/* CLEANUP_STATE *state;
/* int type;
/* char *buf;
/* int len;
/*
/* int cleanup_flush(state)
/* CLEANUP_STATE *state;
/*
/* int cleanup_free(state)
/* CLEANUP_STATE *state;
/* DESCRIPTION
/* This module implements a callable interface to the cleanup service
/* for processing one message and for writing it to queue file.
/* For a description of the cleanup service, see cleanup(8).
/*
/* cleanup_open() creates a new queue file and performs other
/* per-message initialization. The result is a handle that should be
/* given to the cleanup_control(), cleanup_record(), cleanup_flush()
/* and cleanup_free() routines. The name of the queue file is in the
/* queue_id result structure member.
/*
/* cleanup_control() processes per-message flags specified by the caller.
/* These flags control the handling of data errors, and must be set
/* before processing the first message record.
/* .IP CLEANUP_FLAG_BOUNCE
/* The cleanup server is responsible for returning undeliverable
/* mail (too many hops, message too large) to the sender.
/* .IP CLEANUP_FLAG_FILTER
/* Enable header/body filtering. This should be enabled only with mail
/* that enters Postfix, not with locally forwarded mail or with bounce
/* messages.
/* .IP CLEANUP_FLAG_EXTRACT
/* Extract recipients from message headers when no recipients are
/* provided in the message envelope records.
/* .PP
/* CLEANUP_RECORD() is a macro that processes one message record,
/* that copies the result to the queue file, and that maintains a
/* little state machine. The last record in a valid message has type
/* REC_TYPE_END. In order to find out if a message is corrupted,
/* the caller is encouraged to test the CLEANUP_OUT_OK(state) macro.
/* The result is false when further message processing is futile.
/* In that case, it is safe to call cleanup_flush() immediately.
/*
/* cleanup_flush() closes a queue file. In case of any errors,
/* the file is removed. The result value is non-zero in case of
/* problems. In some cases a human-readable text can be found in
/* the state->reason member. In all other cases, use cleanup_strerror()
/* to translate the result into human-readable text.
/*
/* cleanup_free() destroys its argument.
/* DIAGNOSTICS
/* Problems and transactions are logged to \fBsyslogd\fR(8).
/* SEE ALSO
/* cleanup(8) cleanup service description.
/* cleanup_init(8) cleanup callable interface, initialization
/* LICENSE
/* .ad
/* .fi
/* The Secure Mailer license must be distributed with this software.
/* AUTHOR(S)
/* Wietse Venema
/* IBM T.J. Watson Research
/* P.O. Box 704
/* Yorktown Heights, NY 10598, USA
/*--*/
/* System library. */
#include <sys_defs.h>
#include <errno.h>
/* Utility library. */
#include <msg.h>
#include <vstring.h>
#include <mymalloc.h>
/* Global library. */
#include <cleanup_user.h>
#include <mail_queue.h>
#include <mail_proto.h>
#include <bounce.h>
#include <mail_params.h>
#include <mail_stream.h>
#include <hold_message.h>
/* Application-specific. */
#include "cleanup.h"
/* cleanup_open - open queue file and initialize */
CLEANUP_STATE *cleanup_open(void)
{
CLEANUP_STATE *state;
static char *log_queues[] = {
MAIL_QUEUE_DEFER,
MAIL_QUEUE_BOUNCE,
0,
};
char **cpp;
/*
* Initialize private state.
*/
state = cleanup_state_alloc();
/*
* Open the queue file. Save the queue file name in a global variable, so
* that the runtime error handler can clean up in case of problems.
*
* XXX For now, a lot of detail is frozen that could be more useful if it
* were made configurable.
*/
state->queue_name = mystrdup(MAIL_QUEUE_INCOMING);
state->handle = mail_stream_file(state->queue_name,
MAIL_CLASS_PUBLIC, var_queue_service, 0);
state->dst = state->handle->stream;
cleanup_path = mystrdup(VSTREAM_PATH(state->dst));
state->queue_id = mystrdup(state->handle->id);
if (msg_verbose)
msg_info("cleanup_open: open %s", cleanup_path);
/*
* If there is a time to get rid of spurious bounce/defer log files, this
* is it. The down side is that this costs performance for every message,
* while the probability of spurious bounce/defer log files is quite low.
* Perhaps we should put the queue file ID inside the defer and bounce
* files, so that the bounce and defer daemons can figure out if a file
* is a left-over from a previous message instance. For now, we play safe
* and check each time a new queue file is created.
*/
for (cpp = log_queues; *cpp; cpp++) {
if (mail_queue_remove(*cpp, state->queue_id) == 0)
msg_warn("%s: removed spurious %s log", *cpp, state->queue_id);
else if (errno != ENOENT)
msg_fatal("%s: remove %s log: %m", *cpp, state->queue_id);
}
return (state);
}
/* cleanup_control - process client options */
void cleanup_control(CLEANUP_STATE *state, int flags)
{
/*
* If the client requests us to do the bouncing in case of problems,
* throw away the input only in case of real show-stopper errors, such as
* unrecognizable data (which should never happen) or insufficient space
* for the queue file (which will happen occasionally). Otherwise,
* discard input after any lethal error. See the CLEANUP_OUT_OK() macro
* definition.
*/
if ((state->flags = flags) & CLEANUP_FLAG_BOUNCE) {
state->err_mask = CLEANUP_STAT_MASK_INCOMPLETE;
} else {
state->err_mask = ~CLEANUP_STAT_MASK_EXTRACT_RCPT;
}
}
/* cleanup_flush - finish queue file */
int cleanup_flush(CLEANUP_STATE *state)
{
char *junk;
int status;
char *encoding;
/*
* Ignore recipient extraction alarms if (a) we did (not need to) extract
* recipients, or (b) we did not examine all queue file records.
*/
if (state->recip != 0 || CLEANUP_OUT_OK(state) == 0)
state->errs &= ~CLEANUP_STAT_MASK_EXTRACT_RCPT;
/*
* Raise these errors only if we examined all queue file records.
*/
if (CLEANUP_OUT_OK(state)) {
if (state->recip == 0)
state->errs |= CLEANUP_STAT_RCPT;
if (state->end_seen == 0)
state->errs |= CLEANUP_STAT_BAD;
}
/*
* If there are no errors, be very picky about queue file write errors
* because we are about to tell the sender that it can throw away its
* copy of the message.
*
* Optionally, place the message on hold, but only if the message was
* received successfully. This involves renaming the queue file before
* "finishing" it (or else the queue manager would open it for delivery)
* and updating our own idea of the queue file name for error recovery
* and for error reporting purposes.
*/
if (state->errs == 0 && (state->flags & CLEANUP_FLAG_DISCARD) == 0) {
if ((state->flags & CLEANUP_FLAG_HOLD) != 0) {
if (hold_message(state->temp1, state->queue_name, state->queue_id) < 0)
msg_fatal("%s: problem putting message on hold: %m",
state->queue_id);
junk = cleanup_path;
cleanup_path = mystrdup(vstring_str(state->temp1));
myfree(junk);
vstream_control(state->handle->stream,
VSTREAM_CTL_PATH, cleanup_path,
VSTREAM_CTL_END);
}
state->errs = mail_stream_finish(state->handle, (VSTRING *) 0);
} else {
mail_stream_cleanup(state->handle);
if ((state->flags & CLEANUP_FLAG_DISCARD) != 0)
state->errs = 0;
}
state->handle = 0;
state->dst = 0;
/*
* If there was an error, remove the queue file, after optionally
* bouncing it. An incomplete message should never be bounced: it was
* canceled by the client, and may not even have an address to bounce to.
* That last test is redundant but we keep it just for robustness.
*
* If we are responsible for bouncing a message, we must must report success
* to the client unless the bounce message file could not be written
* (which is just as bad as not being able to write the message queue
* file in the first place).
*
* Do not log the arrival of a message that will be bounced by the client.
*
* XXX When bouncing, should log sender because qmgr won't be able to.
*/
#define CAN_BOUNCE() \
((state->errs & CLEANUP_STAT_MASK_CANT_BOUNCE) == 0 \
&& state->sender != 0 \
&& (state->flags & CLEANUP_FLAG_BOUNCE) != 0)
if (state->errs != 0) {
if (CAN_BOUNCE()) {
if (bounce_append(BOUNCE_FLAG_CLEAN, state->queue_id,
state->recip ? state->recip : "unknown",
state->recip ? state->recip : "unknown",
"cleanup", state->time,
"%s", state->reason ? state->reason :
cleanup_strerror(state->errs)) == 0
&& bounce_flush(BOUNCE_FLAG_CLEAN, state->queue_name,
state->queue_id,
(encoding = nvtable_find(state->attr, MAIL_ATTR_ENCODING)) ?
encoding : MAIL_ATTR_ENC_NONE,
state->sender) == 0) {
state->errs = 0;
} else {
if (var_soft_bounce == 0) {
msg_warn("%s: bounce message failure", state->queue_id);
state->errs = CLEANUP_STAT_WRITE;
}
}
}
if (REMOVE(cleanup_path))
msg_warn("remove %s: %m", cleanup_path);
} else if ((state->flags & CLEANUP_FLAG_DISCARD) != 0) {
if (REMOVE(cleanup_path))
msg_warn("remove %s: %m", cleanup_path);
}
/*
* Make sure that our queue file will not be deleted by the error handler
* AFTER we have taken responsibility for delivery. Better to deliver
* twice than to lose mail.
*/
junk = cleanup_path;
cleanup_path = 0; /* don't delete upon error */
myfree(junk);
/*
* Cleanup internal state. This is simply complementary to the
* initializations at the beginning of cleanup_open().
*/
if (msg_verbose)
msg_info("cleanup_flush: status %d", state->errs);
status = state->errs;
return (status);
}
/* cleanup_free - pay the last respects */
void cleanup_free(CLEANUP_STATE *state)
{
cleanup_state_free(state);
}
|