10 /* log session to file stuff ... */
13 Filename currlogfilename
;
18 static void xlatlognam(Filename
*d
, Filename s
, char *hostname
, struct tm
*tm
);
21 * Log session traffic.
23 void logtraffic(void *handle
, unsigned char c
, int logmode
)
25 struct LogContext
*ctx
= (struct LogContext
*)handle
;
26 if (ctx
->cfg
.logtype
> 0) {
27 if (ctx
->cfg
.logtype
== logmode
) {
28 /* deferred open file from pgm start? */
38 * Flush any open log file.
40 void logflush(void *handle
) {
41 struct LogContext
*ctx
= (struct LogContext
*)handle
;
42 if (ctx
->cfg
.logtype
> 0)
48 * Log an Event Log entry. Used in SSH packet logging mode; this is
49 * also as convenient a place as any to put the output of Event Log
50 * entries to stderr when a command-line tool is in verbose mode.
51 * (In particular, this is a better place to put it than in the
52 * front ends, because it only has to be done once for all
53 * platforms. Platforms which don't have a meaningful stderr can
54 * just avoid defining FLAG_STDERR.
56 void log_eventlog(void *handle
, const char *event
)
58 struct LogContext
*ctx
= (struct LogContext
*)handle
;
59 if ((flags
& FLAG_STDERR
) && (flags
& FLAG_VERBOSE
)) {
60 fprintf(stderr
, "%s\n", event
);
63 if (ctx
->cfg
.logtype
!= LGTYP_PACKETS
)
68 fprintf(ctx
->lgfp
, "Event Log: %s\r\n", event
);
73 * If n_blanks != 0, blank or omit some parts.
74 * Set of blanking areas must be in increasing order.
76 void log_packet(void *handle
, int direction
, int type
,
77 char *texttype
, void *data
, int len
,
78 int n_blanks
, const struct logblank_t
*blanks
)
80 struct LogContext
*ctx
= (struct LogContext
*)handle
;
81 char dumpdata
[80], smalldata
[5];
83 if (ctx
->cfg
.logtype
!= LGTYP_PACKETS
)
88 int p
= 0, b
= 0, omitted
= 0;
89 int output_pos
= 0; /* NZ if pending output in dumpdata */
92 fprintf(ctx
->lgfp
, "%s packet type %d / 0x%02x (%s)\r\n",
93 direction
== PKT_INCOMING ?
"Incoming" : "Outgoing",
94 type
, type
, texttype
);
97 * Output a hex/ASCII dump of the packet body, blanking/omitting
103 /* Move to a current entry in the blanking array. */
104 while ((b
< n_blanks
) &&
105 (p
>= blanks
[b
].offset
+ blanks
[b
].len
))
107 /* Work out what type of blanking to apply to
109 blktype
= PKTLOG_EMIT
; /* default */
110 if ((b
< n_blanks
) &&
111 (p
>= blanks
[b
].offset
) &&
112 (p
< blanks
[b
].offset
+ blanks
[b
].len
))
113 blktype
= blanks
[b
].type
;
115 /* If we're about to stop omitting, it's time to say how
116 * much we omitted. */
117 if ((blktype
!= PKTLOG_OMIT
) && omitted
) {
118 fprintf(ctx
->lgfp
, " (%d byte%s omitted)\r\n",
119 omitted
, (omitted
==1?
"":"s"));
123 /* (Re-)initialise dumpdata as necessary
124 * (start of row, or if we've just stopped omitting) */
125 if (!output_pos
&& !omitted
)
126 sprintf(dumpdata
, " %08x%*s\r\n", p
-(p
%16), 1+3*16+2+16, "");
128 /* Deal with the current byte. */
129 if (blktype
== PKTLOG_OMIT
) {
133 if (blktype
== PKTLOG_BLANK
) {
135 sprintf(smalldata
, "XX");
136 } else { /* PKTLOG_EMIT */
137 c
= ((unsigned char *)data
)[p
];
138 sprintf(smalldata
, "%02x", c
);
140 dumpdata
[10+2+3*(p
%16)] = smalldata
[0];
141 dumpdata
[10+2+3*(p
%16)+1] = smalldata
[1];
142 dumpdata
[10+1+3*16+2+(p
%16)] = (isprint(c
) ? c
: '.');
143 output_pos
= (p
%16) + 1;
148 /* Flush row if necessary */
149 if (((p
% 16) == 0) || (p
== len
) || omitted
) {
151 strcpy(dumpdata
+ 10+1+3*16+2+output_pos
, "\r\n");
152 fputs(dumpdata
, ctx
->lgfp
);
161 fprintf(ctx
->lgfp
, " (%d byte%s omitted)\r\n",
162 omitted
, (omitted
==1?
"":"s"));
167 /* open log file append/overwrite mode */
168 void logfopen(void *handle
)
170 struct LogContext
*ctx
= (struct LogContext
*)handle
;
175 /* Prevent repeat calls */
179 if (!ctx
->cfg
.logtype
)
181 sprintf(writemod
, "wb"); /* default to rewrite */
185 /* substitute special codes in file name */
186 xlatlognam(&ctx
->currlogfilename
, ctx
->cfg
.logfilename
,ctx
->cfg
.host
, &tm
);
188 ctx
->lgfp
= f_open(ctx
->currlogfilename
, "r"); /* file already present? */
192 if (ctx
->cfg
.logxfovr
!= LGXF_ASK
) {
193 i
= ((ctx
->cfg
.logxfovr
== LGXF_OVR
) ?
2 : 1);
195 i
= askappend(ctx
->frontend
, ctx
->currlogfilename
);
197 writemod
[0] = 'a'; /* set append mode */
198 else if (i
== 0) { /* cancelled */
200 ctx
->cfg
.logtype
= 0; /* disable logging */
205 ctx
->lgfp
= f_open(ctx
->currlogfilename
, writemod
);
206 if (ctx
->lgfp
) { /* enter into event log */
207 /* --- write header line into log file */
208 fputs("=~=~=~=~=~=~=~=~=~=~=~= PuTTY log ", ctx
->lgfp
);
209 strftime(buf
, 24, "%Y.%m.%d %H:%M:%S", &tm
);
210 fputs(buf
, ctx
->lgfp
);
211 fputs(" =~=~=~=~=~=~=~=~=~=~=~=\r\n", ctx
->lgfp
);
213 sprintf(buf
, "%s session log (%s mode) to file: ",
214 (writemod
[0] == 'a') ?
"Appending" : "Writing new",
215 (ctx
->cfg
.logtype
== LGTYP_ASCII ?
"ASCII" :
216 ctx
->cfg
.logtype
== LGTYP_DEBUG ?
"raw" :
217 ctx
->cfg
.logtype
== LGTYP_PACKETS ?
"SSH packets" : "<ukwn>"));
218 /* Make sure we do not exceed the output buffer size */
219 strncat(buf
, filename_to_str(&ctx
->currlogfilename
), 128);
220 buf
[strlen(buf
)] = '\0';
221 logevent(ctx
->frontend
, buf
);
225 void logfclose(void *handle
)
227 struct LogContext
*ctx
= (struct LogContext
*)handle
;
234 void *log_init(void *frontend
, Config
*cfg
)
236 struct LogContext
*ctx
= snew(struct LogContext
);
238 ctx
->frontend
= frontend
;
239 ctx
->cfg
= *cfg
; /* STRUCTURE COPY */
243 void log_free(void *handle
)
245 struct LogContext
*ctx
= (struct LogContext
*)handle
;
251 void log_reconfig(void *handle
, Config
*cfg
)
253 struct LogContext
*ctx
= (struct LogContext
*)handle
;
256 if (!filename_equal(ctx
->cfg
.logfilename
, cfg
->logfilename
) ||
257 ctx
->cfg
.logtype
!= cfg
->logtype
)
258 reset_logging
= TRUE
;
260 reset_logging
= FALSE
;
265 ctx
->cfg
= *cfg
; /* STRUCTURE COPY */
272 * translate format codes into time/date strings
273 * and insert them into log file name
275 * "&Y":YYYY "&m":MM "&d":DD "&T":hhmm "&h":<hostname> "&&":&
277 static void xlatlognam(Filename
*dest
, Filename src
,
278 char *hostname
, struct tm
*tm
) {
281 char buffer
[FILENAME_MAX
];
282 int len
= sizeof(buffer
)-1;
287 s
= filename_to_str(&src
);
290 /* Let (bufp, len) be the string to append. */
291 bufp
= buf
; /* don't usually override this */
296 if (*s
) switch (c
= *s
++, tolower(c
)) {
298 size
= strftime(buf
, sizeof(buf
), "%Y", tm
);
301 size
= strftime(buf
, sizeof(buf
), "%m", tm
);
304 size
= strftime(buf
, sizeof(buf
), "%d", tm
);
307 size
= strftime(buf
, sizeof(buf
), "%H%M%S", tm
);
325 memcpy(d
, bufp
, size
);
331 *dest
= filename_from_str(buffer
);