xscript-stream.c
10.5 KB
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
/* GNU Mailutils -- a suite of utilities for electronic mail
Copyright (C) 1999, 2000, 2001, 2002, 2004,
2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 3, or (at your option)
any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with GNU Mailutils. If not, see <http://www.gnu.org/licenses/>. */
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <mailutils/types.h>
#include <mailutils/alloc.h>
#include <mailutils/errno.h>
#include <mailutils/nls.h>
#include <mailutils/stream.h>
#include <mailutils/sys/stream.h>
#include <mailutils/sys/xscript-stream.h>
#include <mailutils/cctype.h>
#include <mailutils/cstr.h>
/* A "transcript stream" transparently writes data to and reads data from
an underlying transport stream, writing each lineful of data to a "log
stream". Writes to log stream are prefixed with a string indicating
direction of the data (read/write). Default prefixes are those used in
RFCs -- "S: ", for data written ("Server"), and "C: ", for data read
("Client"). */
#define TRANS_READ 0x1
#define TRANS_WRITE 0x2
#define TRANS_DISABLED 0x4
#define FLAG_TO_PFX(c) ((c) - 1)
static int
word_match (const char *buf, size_t len, int n, const char *word,
size_t *pos)
{
size_t i = 0;
size_t wl = strlen (word);
for (;; n--)
{
/* Skip whitespace separator */
for (; i < len && mu_isspace (buf[i]); i++)
;
if (n == 0)
break;
/* Skip the argument */
if (buf[i] == '"')
{
for (i++; i < len && buf[i] != '"'; i++)
if (buf[i] == '\'')
i++;
}
else
{
for (; i < len && !mu_isspace (buf[i]); i++)
;
}
}
if (i + wl <= len &&
mu_c_strncasecmp (buf + i, word, wl) == 0 &&
mu_isblank (buf[i + wl]))
{
*pos = i + wl;
return 1;
}
return 0;
}
static void
print_transcript (struct _mu_xscript_stream *str, int flag,
const char *buf, size_t size)
{
while (size)
{
const char *p;
size_t len;
if (str->flags & flag)
{
mu_stream_write (str->logstr,
str->prefix[FLAG_TO_PFX(flag)],
strlen (str->prefix[FLAG_TO_PFX (flag)]),
NULL);
str->flags &= ~(flag | TRANS_DISABLED);
}
if (str->flags & TRANS_DISABLED)
return;
if (str->level == MU_XSCRIPT_PAYLOAD)
{
mu_stream_printf (str->logstr, "(data...)\n");
str->flags |= TRANS_DISABLED;
return;
}
p = memchr (buf, '\n', size);
if (p)
{
len = p - buf;
if (p > buf && p[-1] == '\r')
len--;
if (str->level == MU_XSCRIPT_SECURE)
{
size_t i;
if (word_match (buf, len, 0, "PASS", &i))
mu_stream_printf (str->logstr, "PASS ***");
else if (word_match (buf, len, 1, "LOGIN", &i))
{
/* Skip the whitespace separator */
for (; i < len && mu_isspace (buf[i]); i++)
;
/* Skip the first argument (presumably the user name) */
if (buf[i] == '"')
{
for (i++; i < len && buf[i] != '"'; i++)
if (buf[i] == '\'')
i++;
}
else
{
for (; i < len && !mu_isspace (buf[i]); i++)
;
}
mu_stream_write (str->logstr, buf, i, NULL);
mu_stream_write (str->logstr, " \"***\"", 6, NULL);
}
else
mu_stream_write (str->logstr, buf, len, NULL);
}
else
mu_stream_write (str->logstr, buf, len, NULL);
mu_stream_write (str->logstr, "\n", 1, NULL);
str->flags |= flag;
len = p - buf + 1;
buf = p + 1;
size -= len;
}
else
{
mu_stream_write (str->logstr, buf, size, NULL);
break;
}
}
}
static int
_xscript_read (struct _mu_stream *str, char *buf, size_t bufsize,
size_t *pnread)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
size_t nbytes;
int rc = mu_stream_read (sp->transport, buf, bufsize, &nbytes);
if (rc == 0)
{
print_transcript (sp, TRANS_READ, buf, nbytes);
if (pnread)
*pnread = nbytes;
}
return rc;
}
static int
_xscript_readdelim (struct _mu_stream *str, char *buf, size_t bufsize,
int delim, size_t *pnread)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
size_t nread;
int rc = mu_stream_readdelim (sp->transport, buf, bufsize, delim, &nread);
if (rc == 0)
{
print_transcript (sp, TRANS_READ, buf, nread);
if (pnread)
*pnread = nread;
}
return rc;
}
static int
_xscript_write (struct _mu_stream *str, const char *buf, size_t bufsize,
size_t *pnwrite)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
int rc = mu_stream_write (sp->transport, buf, bufsize, pnwrite);
if (rc == 0)
print_transcript (sp, TRANS_WRITE, buf, pnwrite ? *pnwrite : bufsize);
return rc;
}
static int
_xscript_flush (struct _mu_stream *str)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
return mu_stream_flush (sp->transport);
}
static int
_xscript_open (struct _mu_stream *str)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
return mu_stream_open (sp->transport);
}
static int
_xscript_close (struct _mu_stream *str)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
return mu_stream_close (sp->transport);
}
static void
_xscript_done (struct _mu_stream *str)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
free (sp->prefix[0]);
free (sp->prefix[1]);
mu_stream_unref (sp->transport);
mu_stream_unref (sp->logstr);
}
static int
_xscript_seek (struct _mu_stream *str, mu_off_t off, mu_off_t *ppos)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
return mu_stream_seek (sp->transport, off, MU_SEEK_SET, ppos);
}
static int
_xscript_size (struct _mu_stream *str, mu_off_t *psize)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
return mu_stream_size (sp->transport, psize);
}
static int
_xscript_ctl (struct _mu_stream *str, int op, void *arg)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
mu_transport_t *ptrans;
int status = 0;
switch (op)
{
case MU_IOCTL_GET_TRANSPORT:
if (!arg)
return EINVAL;
ptrans = arg;
ptrans[0] = (mu_transport_t) sp->transport;
ptrans[1] = (mu_transport_t) sp->logstr;
break;
case MU_IOCTL_SET_TRANSPORT:
if (!arg)
return EINVAL;
ptrans = arg;
if (ptrans[0])
sp->transport = (mu_stream_t) ptrans[0];
if (ptrans[1])
sp->logstr = (mu_stream_t) ptrans[1];
break;
case MU_IOCTL_SWAP_STREAM:
if (!arg)
return EINVAL;
if (!sp->transport)
status = ENOSYS;
else
status = mu_stream_ioctl (sp->transport, op, arg);
if (status == EINVAL || status == ENOSYS)
{
mu_stream_t *pstr = arg;
mu_stream_t tmp;
if (pstr[0] != pstr[1])
return EINVAL; /* FIXME */
tmp = pstr[0];
pstr[0] = sp->transport;
pstr[1] = sp->transport;
sp->transport = tmp;
if (!(str->flags & MU_STREAM_AUTOCLOSE))
{
if (pstr[0])
mu_stream_unref (pstr[0]);
if (tmp)
mu_stream_ref (tmp);
}
if (tmp)
mu_stream_ref (tmp);
status = 0;
}
break;
case MU_IOCTL_GET_TRANSPORT_BUFFER:
case MU_IOCTL_SET_TRANSPORT_BUFFER:
{
struct mu_transport_buffer_query *qp = arg;
if (!sp->transport)
return EINVAL;
return mu_stream_ioctl (sp->transport, op, arg);
}
case MU_IOCTL_LEVEL:
if (!arg)
return EINVAL;
else
{
int oldlev = sp->level;
sp->level = *(int*)arg;
sp->flags = TRANS_READ | TRANS_WRITE;
*(int*)arg = oldlev;
}
break;
default:
return mu_stream_ioctl (sp->transport, op, arg);
}
return status;
}
static int
_xscript_wait (struct _mu_stream *str, int *pflags, struct timeval *tvp)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
return mu_stream_wait (sp->transport, pflags, tvp);
}
static int
_xscript_truncate (struct _mu_stream *str, mu_off_t size)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
return mu_stream_truncate (sp->transport, size);
}
static int
_xscript_shutdown (struct _mu_stream *str, int how)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
return mu_stream_shutdown (sp->transport, how);
}
static const char *
_xscript_error_string (struct _mu_stream *str, int rc)
{
struct _mu_xscript_stream *sp = (struct _mu_xscript_stream *)str;
const char *p = mu_stream_strerror (sp->transport, rc);
if (!p)
p = mu_strerror (rc);
return p;
}
const char *default_prefix[2] = {
"C: ", "S: "
};
int
mu_xscript_stream_create(mu_stream_t *pref, mu_stream_t transport,
mu_stream_t logstr,
const char *prefix[])
{
int flags;
struct _mu_xscript_stream *sp;
mu_stream_get_flags (transport, &flags);
sp = (struct _mu_xscript_stream *) _mu_stream_create (sizeof (*sp), flags);
if (!sp)
return ENOMEM;
sp->stream.read = _xscript_read;
sp->stream.readdelim = _xscript_readdelim;
sp->stream.write = _xscript_write;
sp->stream.flush = _xscript_flush;
sp->stream.open = _xscript_open;
sp->stream.close = _xscript_close;
sp->stream.done = _xscript_done;
sp->stream.seek = _xscript_seek;
sp->stream.size = _xscript_size;
sp->stream.ctl = _xscript_ctl;
sp->stream.wait = _xscript_wait;
sp->stream.truncate = _xscript_truncate;
sp->stream.shutdown = _xscript_shutdown;
sp->stream.error_string = _xscript_error_string;
if (!(flags & MU_STREAM_AUTOCLOSE))
{
mu_stream_ref (transport);
mu_stream_ref (logstr);
}
sp->transport = transport;
sp->logstr = logstr;
sp->flags = TRANS_READ | TRANS_WRITE;
if (prefix)
{
sp->prefix[0] = strdup(prefix[0] ? prefix[0] : default_prefix[0]);
sp->prefix[1] = strdup(prefix[1] ? prefix[1] : default_prefix[1]);
}
else
{
sp->prefix[0] = strdup(default_prefix[0]);
sp->prefix[1] = strdup(default_prefix[1]);
}
if (sp->prefix[0] == NULL || sp->prefix[1] == 0)
{
free (sp->prefix[0]);
free (sp->prefix[1]);
free (sp);
return ENOMEM;
}
mu_stream_set_buffer ((mu_stream_t) sp, mu_buffer_line, 1024);
*pref = (mu_stream_t) sp;
return 0;
}