00db133f |
1 | #include <stdio.h> |
2 | #include <stdlib.h> |
3 | #include <ctype.h> |
4 | |
5 | #include <time.h> |
6 | #include <assert.h> |
7 | |
8 | #include "putty.h" |
9 | |
10 | /* log session to file stuff ... */ |
a8327734 |
11 | struct LogContext { |
12 | FILE *lgfp; |
9a30e26b |
13 | Filename currlogfilename; |
a8327734 |
14 | void *frontend; |
c229ef97 |
15 | Config cfg; |
a8327734 |
16 | }; |
00db133f |
17 | |
9a30e26b |
18 | static void xlatlognam(Filename *d, Filename s, char *hostname, struct tm *tm); |
00db133f |
19 | |
20 | /* |
21 | * Log session traffic. |
22 | */ |
a8327734 |
23 | void logtraffic(void *handle, unsigned char c, int logmode) |
00db133f |
24 | { |
a8327734 |
25 | struct LogContext *ctx = (struct LogContext *)handle; |
c229ef97 |
26 | if (ctx->cfg.logtype > 0) { |
27 | if (ctx->cfg.logtype == logmode) { |
00db133f |
28 | /* deferred open file from pgm start? */ |
a8327734 |
29 | if (!ctx->lgfp) |
30 | logfopen(ctx); |
31 | if (ctx->lgfp) |
32 | fputc(c, ctx->lgfp); |
00db133f |
33 | } |
34 | } |
35 | } |
36 | |
37 | /* |
382908ad |
38 | * Log an Event Log entry. Used in SSH packet logging mode; this is |
39 | * also as convenient a place as any to put the output of Event Log |
40 | * entries to stderr when a command-line tool is in verbose mode. |
41 | * (In particular, this is a better place to put it than in the |
42 | * front ends, because it only has to be done once for all |
43 | * platforms. Platforms which don't have a meaningful stderr can |
44 | * just avoid defining FLAG_STDERR. |
fb89f7ff |
45 | */ |
a8327734 |
46 | void log_eventlog(void *handle, char *event) |
fb89f7ff |
47 | { |
a8327734 |
48 | struct LogContext *ctx = (struct LogContext *)handle; |
382908ad |
49 | if ((flags & FLAG_STDERR) && (flags & FLAG_VERBOSE)) { |
50 | fprintf(stderr, "%s\n", event); |
51 | fflush(stderr); |
52 | } |
c229ef97 |
53 | if (ctx->cfg.logtype != LGTYP_PACKETS) |
fb89f7ff |
54 | return; |
a8327734 |
55 | if (!ctx->lgfp) |
56 | logfopen(ctx); |
57 | if (ctx->lgfp) |
fa76f4a3 |
58 | fprintf(ctx->lgfp, "Event Log: %s\r\n", event); |
fb89f7ff |
59 | } |
60 | |
61 | /* |
00db133f |
62 | * Log an SSH packet. |
63 | */ |
a8327734 |
64 | void log_packet(void *handle, int direction, int type, |
65 | char *texttype, void *data, int len) |
00db133f |
66 | { |
a8327734 |
67 | struct LogContext *ctx = (struct LogContext *)handle; |
fb89f7ff |
68 | int i, j; |
00db133f |
69 | char dumpdata[80], smalldata[5]; |
70 | |
c229ef97 |
71 | if (ctx->cfg.logtype != LGTYP_PACKETS) |
00db133f |
72 | return; |
a8327734 |
73 | if (!ctx->lgfp) |
74 | logfopen(ctx); |
75 | if (ctx->lgfp) { |
fa76f4a3 |
76 | fprintf(ctx->lgfp, "%s packet type %d / 0x%02x (%s)\r\n", |
00db133f |
77 | direction == PKT_INCOMING ? "Incoming" : "Outgoing", |
78 | type, type, texttype); |
79 | for (i = 0; i < len; i += 16) { |
fa76f4a3 |
80 | sprintf(dumpdata, " %08x%*s\r\n", i, 1+3*16+2+16, ""); |
00db133f |
81 | for (j = 0; j < 16 && i+j < len; j++) { |
82 | int c = ((unsigned char *)data)[i+j]; |
83 | sprintf(smalldata, "%02x", c); |
84 | dumpdata[10+2+3*j] = smalldata[0]; |
85 | dumpdata[10+2+3*j+1] = smalldata[1]; |
86 | dumpdata[10+1+3*16+2+j] = (isprint(c) ? c : '.'); |
87 | } |
fa76f4a3 |
88 | strcpy(dumpdata + 10+1+3*16+2+j, "\r\n"); |
a8327734 |
89 | fputs(dumpdata, ctx->lgfp); |
00db133f |
90 | } |
a8327734 |
91 | fflush(ctx->lgfp); |
00db133f |
92 | } |
93 | } |
94 | |
95 | /* open log file append/overwrite mode */ |
a8327734 |
96 | void logfopen(void *handle) |
00db133f |
97 | { |
a8327734 |
98 | struct LogContext *ctx = (struct LogContext *)handle; |
00db133f |
99 | char buf[256]; |
100 | time_t t; |
101 | struct tm tm; |
102 | char writemod[4]; |
103 | |
fb89f7ff |
104 | /* Prevent repeat calls */ |
a8327734 |
105 | if (ctx->lgfp) |
fb89f7ff |
106 | return; |
107 | |
c229ef97 |
108 | if (!ctx->cfg.logtype) |
00db133f |
109 | return; |
fa76f4a3 |
110 | sprintf(writemod, "wb"); /* default to rewrite */ |
00db133f |
111 | |
112 | time(&t); |
113 | tm = *localtime(&t); |
114 | |
115 | /* substitute special codes in file name */ |
9a30e26b |
116 | xlatlognam(&ctx->currlogfilename, ctx->cfg.logfilename,ctx->cfg.host, &tm); |
00db133f |
117 | |
9a30e26b |
118 | ctx->lgfp = f_open(ctx->currlogfilename, "r"); /* file already present? */ |
a8327734 |
119 | if (ctx->lgfp) { |
00db133f |
120 | int i; |
a8327734 |
121 | fclose(ctx->lgfp); |
c229ef97 |
122 | if (ctx->cfg.logxfovr != LGXF_ASK) { |
123 | i = ((ctx->cfg.logxfovr == LGXF_OVR) ? 2 : 1); |
bf61b566 |
124 | } else |
125 | i = askappend(ctx->frontend, ctx->currlogfilename); |
00db133f |
126 | if (i == 1) |
127 | writemod[0] = 'a'; /* set append mode */ |
128 | else if (i == 0) { /* cancelled */ |
a8327734 |
129 | ctx->lgfp = NULL; |
c229ef97 |
130 | ctx->cfg.logtype = 0; /* disable logging */ |
00db133f |
131 | return; |
132 | } |
133 | } |
134 | |
9a30e26b |
135 | ctx->lgfp = f_open(ctx->currlogfilename, writemod); |
a8327734 |
136 | if (ctx->lgfp) { /* enter into event log */ |
fb89f7ff |
137 | /* --- write header line into log file */ |
a8327734 |
138 | fputs("=~=~=~=~=~=~=~=~=~=~=~= PuTTY log ", ctx->lgfp); |
fb89f7ff |
139 | strftime(buf, 24, "%Y.%m.%d %H:%M:%S", &tm); |
a8327734 |
140 | fputs(buf, ctx->lgfp); |
fa76f4a3 |
141 | fputs(" =~=~=~=~=~=~=~=~=~=~=~=\r\n", ctx->lgfp); |
fb89f7ff |
142 | |
143 | sprintf(buf, "%s session log (%s mode) to file: ", |
00db133f |
144 | (writemod[0] == 'a') ? "Appending" : "Writing new", |
c229ef97 |
145 | (ctx->cfg.logtype == LGTYP_ASCII ? "ASCII" : |
146 | ctx->cfg.logtype == LGTYP_DEBUG ? "raw" : |
147 | ctx->cfg.logtype == LGTYP_PACKETS ? "SSH packets" : "<ukwn>")); |
00db133f |
148 | /* Make sure we do not exceed the output buffer size */ |
9fab77dc |
149 | strncat(buf, filename_to_str(&ctx->currlogfilename), 128); |
00db133f |
150 | buf[strlen(buf)] = '\0'; |
a8327734 |
151 | logevent(ctx->frontend, buf); |
00db133f |
152 | } |
153 | } |
154 | |
a8327734 |
155 | void logfclose(void *handle) |
00db133f |
156 | { |
a8327734 |
157 | struct LogContext *ctx = (struct LogContext *)handle; |
158 | if (ctx->lgfp) { |
159 | fclose(ctx->lgfp); |
160 | ctx->lgfp = NULL; |
00db133f |
161 | } |
162 | } |
163 | |
c229ef97 |
164 | void *log_init(void *frontend, Config *cfg) |
a8327734 |
165 | { |
166 | struct LogContext *ctx = smalloc(sizeof(struct LogContext)); |
167 | ctx->lgfp = NULL; |
168 | ctx->frontend = frontend; |
c229ef97 |
169 | ctx->cfg = *cfg; /* STRUCTURE COPY */ |
a8327734 |
170 | return ctx; |
171 | } |
172 | |
fabd1805 |
173 | void log_free(void *handle) |
174 | { |
175 | struct LogContext *ctx = (struct LogContext *)handle; |
176 | |
177 | logfclose(ctx); |
178 | sfree(ctx); |
179 | } |
180 | |
c229ef97 |
181 | void log_reconfig(void *handle, Config *cfg) |
182 | { |
183 | struct LogContext *ctx = (struct LogContext *)handle; |
184 | int reset_logging; |
185 | |
9a30e26b |
186 | if (!filename_equal(ctx->cfg.logfilename, cfg->logfilename) || |
c229ef97 |
187 | ctx->cfg.logtype != cfg->logtype) |
188 | reset_logging = TRUE; |
189 | else |
190 | reset_logging = FALSE; |
191 | |
192 | if (reset_logging) |
4512d432 |
193 | logfclose(ctx); |
c229ef97 |
194 | |
195 | ctx->cfg = *cfg; /* STRUCTURE COPY */ |
196 | |
197 | if (reset_logging) |
4512d432 |
198 | logfopen(ctx); |
c229ef97 |
199 | } |
200 | |
00db133f |
201 | /* |
202 | * translate format codes into time/date strings |
203 | * and insert them into log file name |
204 | * |
205 | * "&Y":YYYY "&m":MM "&d":DD "&T":hhmm "&h":<hostname> "&&":& |
206 | */ |
9a30e26b |
207 | static void xlatlognam(Filename *dest, Filename src, |
208 | char *hostname, struct tm *tm) { |
00db133f |
209 | char buf[10], *bufp; |
210 | int size; |
9a30e26b |
211 | char buffer[FILENAME_MAX]; |
212 | int len = sizeof(buffer)-1; |
9fab77dc |
213 | char *d; |
214 | const char *s; |
9a30e26b |
215 | |
216 | d = buffer; |
9fab77dc |
217 | s = filename_to_str(&src); |
00db133f |
218 | |
219 | while (*s) { |
220 | /* Let (bufp, len) be the string to append. */ |
221 | bufp = buf; /* don't usually override this */ |
222 | if (*s == '&') { |
223 | char c; |
224 | s++; |
1709795f |
225 | size = 0; |
00db133f |
226 | if (*s) switch (c = *s++, tolower(c)) { |
227 | case 'y': |
228 | size = strftime(buf, sizeof(buf), "%Y", tm); |
229 | break; |
230 | case 'm': |
231 | size = strftime(buf, sizeof(buf), "%m", tm); |
232 | break; |
233 | case 'd': |
234 | size = strftime(buf, sizeof(buf), "%d", tm); |
235 | break; |
236 | case 't': |
237 | size = strftime(buf, sizeof(buf), "%H%M%S", tm); |
238 | break; |
239 | case 'h': |
240 | bufp = hostname; |
241 | size = strlen(bufp); |
242 | break; |
243 | default: |
244 | buf[0] = '&'; |
245 | size = 1; |
246 | if (c != '&') |
247 | buf[size++] = c; |
248 | } |
249 | } else { |
250 | buf[0] = *s++; |
251 | size = 1; |
252 | } |
253 | if (size > len) |
254 | size = len; |
255 | memcpy(d, bufp, size); |
256 | d += size; |
257 | len -= size; |
258 | } |
259 | *d = '\0'; |
9a30e26b |
260 | |
9fab77dc |
261 | *dest = filename_from_str(d); |
00db133f |
262 | } |