14 /* log session to file stuff ... */
17 enum { L_CLOSED, L_OPENING, L_OPEN, L_ERROR } state;
19 Filename *currlogfilename;
22 int logtype; /* cached out of conf */
25 static Filename *xlatlognam(Filename *s, char *hostname, int port,
29 * Internal wrapper function which must be called for _all_ output
30 * to the log file. It takes care of opening the log file if it
31 * isn't open, buffering data if it's in the process of being
32 * opened asynchronously, etc.
34 static void logwrite(struct LogContext *ctx, void *data, int len)
37 * In state L_CLOSED, we call logfopen, which will set the state
38 * to one of L_OPENING, L_OPEN or L_ERROR. Hence we process all of
39 * those three _after_ processing L_CLOSED.
41 if (ctx->state == L_CLOSED)
44 if (ctx->state == L_OPENING) {
45 bufchain_add(&ctx->queue, data, len);
46 } else if (ctx->state == L_OPEN) {
48 if (fwrite(data, 1, len, ctx->lgfp) < (size_t)len) {
51 /* Log state is L_ERROR so this won't cause a loop */
52 logevent(ctx->frontend,
53 "Disabled writing session log due to error while writing");
55 } /* else L_ERROR, so ignore the write */
59 * Convenience wrapper on logwrite() which printf-formats the
62 static void logprintf(struct LogContext *ctx, const char *fmt, ...)
68 data = dupvprintf(fmt, ap);
71 logwrite(ctx, data, strlen(data));
76 * Flush any open log file.
78 void logflush(void *handle) {
79 struct LogContext *ctx = (struct LogContext *)handle;
81 if (ctx->state == L_OPEN)
85 static void logfopen_callback(void *handle, int mode)
87 struct LogContext *ctx = (struct LogContext *)handle;
88 char buf[256], *event;
94 ctx->state = L_ERROR; /* disable logging */
96 fmode = (mode == 1 ? "ab" : "wb");
97 ctx->lgfp = f_open(ctx->currlogfilename, fmode, FALSE);
101 ctx->state = L_ERROR;
106 if (ctx->state == L_OPEN) {
107 /* Write header line into log file. */
109 strftime(buf, 24, "%Y.%m.%d %H:%M:%S", &tm);
110 logprintf(ctx, "=~=~=~=~=~=~=~=~=~=~=~= PuTTY log %s"
111 " =~=~=~=~=~=~=~=~=~=~=~=\r\n", buf);
114 event = dupprintf("%s session log (%s mode) to file: %s",
115 ctx->state == L_ERROR ?
116 (mode == 0 ? "Disabled writing" : "Error writing") :
117 (mode == 1 ? "Appending" : "Writing new"),
118 (ctx->logtype == LGTYP_ASCII ? "ASCII" :
119 ctx->logtype == LGTYP_DEBUG ? "raw" :
120 ctx->logtype == LGTYP_PACKETS ? "SSH packets" :
121 ctx->logtype == LGTYP_SSHRAW ? "SSH raw data" :
123 filename_to_str(ctx->currlogfilename));
124 logevent(ctx->frontend, event);
127 * If we failed to open the log file due to filesystem error
128 * (as opposed to user action such as clicking Cancel in the
129 * askappend box), we should log it more prominently. We do
130 * this by sending it to the same place that stderr output
131 * from the main session goes (so, either a console tool's
132 * actual stderr, or a terminal window).
134 * Of course this is one case in which that policy won't cause
135 * it to turn up embarrassingly in a log file of real server
136 * output, because the whole point is that we haven't managed
137 * to open any such log file :-)
139 from_backend(ctx->frontend, 1, event, strlen(event));
140 from_backend(ctx->frontend, 1, "\r\n", 2);
145 * Having either succeeded or failed in opening the log file,
146 * we should write any queued data out.
148 assert(ctx->state != L_OPENING); /* make _sure_ it won't be requeued */
149 while (bufchain_size(&ctx->queue)) {
152 bufchain_prefix(&ctx->queue, &data, &len);
153 logwrite(ctx, data, len);
154 bufchain_consume(&ctx->queue, len);
159 * Open the log file. Takes care of detecting an already-existing
160 * file and asking the user whether they want to append, overwrite
163 void logfopen(void *handle)
165 struct LogContext *ctx = (struct LogContext *)handle;
169 /* Prevent repeat calls */
170 if (ctx->state != L_CLOSED)
178 /* substitute special codes in file name */
179 if (ctx->currlogfilename)
180 filename_free(ctx->currlogfilename);
181 ctx->currlogfilename =
182 xlatlognam(conf_get_filename(ctx->conf, CONF_logfilename),
183 conf_get_str(ctx->conf, CONF_host),
184 conf_get_int(ctx->conf, CONF_port), &tm);
186 ctx->lgfp = f_open(ctx->currlogfilename, "r", FALSE); /* file already present? */
188 int logxfovr = conf_get_int(ctx->conf, CONF_logxfovr);
190 if (logxfovr != LGXF_ASK) {
191 mode = ((logxfovr == LGXF_OVR) ? 2 : 1);
193 mode = askappend(ctx->frontend, ctx->currlogfilename,
194 logfopen_callback, ctx);
196 mode = 2; /* create == overwrite */
199 ctx->state = L_OPENING;
201 logfopen_callback(ctx, mode); /* open the file */
204 void logfclose(void *handle)
206 struct LogContext *ctx = (struct LogContext *)handle;
211 ctx->state = L_CLOSED;
215 * Log session traffic.
217 void logtraffic(void *handle, unsigned char c, int logmode)
219 struct LogContext *ctx = (struct LogContext *)handle;
220 if (ctx->logtype > 0) {
221 if (ctx->logtype == logmode)
222 logwrite(ctx, &c, 1);
227 * Log an Event Log entry. Used in SSH packet logging mode; this is
228 * also as convenient a place as any to put the output of Event Log
229 * entries to stderr when a command-line tool is in verbose mode.
230 * (In particular, this is a better place to put it than in the
231 * front ends, because it only has to be done once for all
232 * platforms. Platforms which don't have a meaningful stderr can
233 * just avoid defining FLAG_STDERR.
235 void log_eventlog(void *handle, const char *event)
237 struct LogContext *ctx = (struct LogContext *)handle;
238 if ((flags & FLAG_STDERR) && (flags & FLAG_VERBOSE)) {
239 fprintf(stderr, "%s\n", event);
242 /* If we don't have a context yet (eg winnet.c init) then skip entirely */
245 if (ctx->logtype != LGTYP_PACKETS &&
246 ctx->logtype != LGTYP_SSHRAW)
248 logprintf(ctx, "Event Log: %s\r\n", event);
254 * If n_blanks != 0, blank or omit some parts.
255 * Set of blanking areas must be in increasing order.
257 void log_packet(void *handle, int direction, int type,
258 const char *texttype, const void *data, int len,
259 int n_blanks, const struct logblank_t *blanks,
260 const unsigned long *seq,
261 unsigned downstream_id, const char *additional_log_text)
263 struct LogContext *ctx = (struct LogContext *)handle;
264 char dumpdata[80], smalldata[5];
265 int p = 0, b = 0, omitted = 0;
266 int output_pos = 0; /* NZ if pending output in dumpdata */
268 if (!(ctx->logtype == LGTYP_SSHRAW ||
269 (ctx->logtype == LGTYP_PACKETS && texttype)))
274 logprintf(ctx, "%s packet ",
275 direction == PKT_INCOMING ? "Incoming" : "Outgoing");
278 logprintf(ctx, "#0x%lx, ", *seq);
280 logprintf(ctx, "type %d / 0x%02x (%s)", type, type, texttype);
283 logprintf(ctx, " on behalf of downstream #%u", downstream_id);
284 if (additional_log_text)
285 logprintf(ctx, " (%s)", additional_log_text);
288 logprintf(ctx, "\r\n");
291 * Raw data is logged with a timestamp, so that it's possible
292 * to determine whether a mysterious delay occurred at the
293 * client or server end. (Timestamping the raw data avoids
294 * cluttering the normal case of only logging decrypted SSH
295 * messages, and also adds conceptual rigour in the case where
296 * an SSH message arrives in several pieces.)
301 strftime(buf, 24, "%Y-%m-%d %H:%M:%S", &tm);
302 logprintf(ctx, "%s raw data at %s\r\n",
303 direction == PKT_INCOMING ? "Incoming" : "Outgoing",
308 * Output a hex/ASCII dump of the packet body, blanking/omitting
309 * parts as specified.
314 /* Move to a current entry in the blanking array. */
315 while ((b < n_blanks) &&
316 (p >= blanks[b].offset + blanks[b].len))
318 /* Work out what type of blanking to apply to
320 blktype = PKTLOG_EMIT; /* default */
321 if ((b < n_blanks) &&
322 (p >= blanks[b].offset) &&
323 (p < blanks[b].offset + blanks[b].len))
324 blktype = blanks[b].type;
326 /* If we're about to stop omitting, it's time to say how
327 * much we omitted. */
328 if ((blktype != PKTLOG_OMIT) && omitted) {
329 logprintf(ctx, " (%d byte%s omitted)\r\n",
330 omitted, (omitted==1?"":"s"));
334 /* (Re-)initialise dumpdata as necessary
335 * (start of row, or if we've just stopped omitting) */
336 if (!output_pos && !omitted)
337 sprintf(dumpdata, " %08x%*s\r\n", p-(p%16), 1+3*16+2+16, "");
339 /* Deal with the current byte. */
340 if (blktype == PKTLOG_OMIT) {
344 if (blktype == PKTLOG_BLANK) {
346 sprintf(smalldata, "XX");
347 } else { /* PKTLOG_EMIT */
348 c = ((unsigned char *)data)[p];
349 sprintf(smalldata, "%02x", c);
351 dumpdata[10+2+3*(p%16)] = smalldata[0];
352 dumpdata[10+2+3*(p%16)+1] = smalldata[1];
353 dumpdata[10+1+3*16+2+(p%16)] = (isprint(c) ? c : '.');
354 output_pos = (p%16) + 1;
359 /* Flush row if necessary */
360 if (((p % 16) == 0) || (p == len) || omitted) {
362 strcpy(dumpdata + 10+1+3*16+2+output_pos, "\r\n");
363 logwrite(ctx, dumpdata, strlen(dumpdata));
372 logprintf(ctx, " (%d byte%s omitted)\r\n",
373 omitted, (omitted==1?"":"s"));
377 void *log_init(void *frontend, Conf *conf)
379 struct LogContext *ctx = snew(struct LogContext);
381 ctx->state = L_CLOSED;
382 ctx->frontend = frontend;
383 ctx->conf = conf_copy(conf);
384 ctx->logtype = conf_get_int(ctx->conf, CONF_logtype);
385 ctx->currlogfilename = NULL;
386 bufchain_init(&ctx->queue);
390 void log_free(void *handle)
392 struct LogContext *ctx = (struct LogContext *)handle;
395 bufchain_clear(&ctx->queue);
396 if (ctx->currlogfilename)
397 filename_free(ctx->currlogfilename);
398 conf_free(ctx->conf);
402 void log_reconfig(void *handle, Conf *conf)
404 struct LogContext *ctx = (struct LogContext *)handle;
407 if (!filename_equal(conf_get_filename(ctx->conf, CONF_logfilename),
408 conf_get_filename(conf, CONF_logfilename)) ||
409 conf_get_int(ctx->conf, CONF_logtype) !=
410 conf_get_int(conf, CONF_logtype))
411 reset_logging = TRUE;
413 reset_logging = FALSE;
418 conf_free(ctx->conf);
419 ctx->conf = conf_copy(conf);
421 ctx->logtype = conf_get_int(ctx->conf, CONF_logtype);
428 * translate format codes into time/date strings
429 * and insert them into log file name
431 * "&Y":YYYY "&m":MM "&d":DD "&T":hhmmss "&h":<hostname> "&&":&
433 static Filename *xlatlognam(Filename *src, char *hostname, int port,
443 bufsize = FILENAME_MAX;
444 buffer = snewn(bufsize, char);
446 s = filename_to_str(src);
449 int sanitise = FALSE;
450 /* Let (bufp, len) be the string to append. */
451 bufp = buf; /* don't usually override this */
456 if (*s) switch (c = *s++, tolower((unsigned char)c)) {
458 size = strftime(buf, sizeof(buf), "%Y", tm);
461 size = strftime(buf, sizeof(buf), "%m", tm);
464 size = strftime(buf, sizeof(buf), "%d", tm);
467 size = strftime(buf, sizeof(buf), "%H%M%S", tm);
474 size = sprintf(buf, "%d", port);
482 /* Never allow path separators - or any other illegal
483 * filename character - to come out of any of these
484 * auto-format directives. E.g. 'hostname' can contain
485 * colons, if it's an IPv6 address, and colons aren't
486 * legal in filenames on Windows. */
492 if (bufsize <= buflen + size) {
493 bufsize = (buflen + size) * 5 / 4 + 512;
494 buffer = sresize(buffer, bufsize, char);
499 c = filename_char_sanitise(c);
500 buffer[buflen++] = c;
503 buffer[buflen] = '\0';
505 ret = filename_from_str(buffer);