f4ff9455 |
1 | /* |
2 | * Platform-independent routines shared between all PuTTY programs. |
3 | */ |
4 | |
374330e2 |
5 | #include <stdio.h> |
6 | #include <stdlib.h> |
1709795f |
7 | #include <stdarg.h> |
46cfeac8 |
8 | #include <limits.h> |
57356d63 |
9 | #include <ctype.h> |
5471d09a |
10 | #include <assert.h> |
374330e2 |
11 | #include "putty.h" |
12 | |
d57f70af |
13 | /* |
14 | * Parse a string block size specification. This is approximately a |
15 | * subset of the block size specs supported by GNU fileutils: |
16 | * "nk" = n kilobytes |
17 | * "nM" = n megabytes |
18 | * "nG" = n gigabytes |
19 | * All numbers are decimal, and suffixes refer to powers of two. |
20 | * Case-insensitive. |
21 | */ |
22 | unsigned long parse_blocksize(const char *bs) |
23 | { |
24 | char *suf; |
25 | unsigned long r = strtoul(bs, &suf, 10); |
26 | if (*suf != '\0') { |
0d119367 |
27 | while (*suf && isspace((unsigned char)*suf)) suf++; |
d57f70af |
28 | switch (*suf) { |
29 | case 'k': case 'K': |
30 | r *= 1024ul; |
31 | break; |
32 | case 'm': case 'M': |
33 | r *= 1024ul * 1024ul; |
34 | break; |
35 | case 'g': case 'G': |
36 | r *= 1024ul * 1024ul * 1024ul; |
37 | break; |
38 | case '\0': |
39 | default: |
40 | break; |
41 | } |
42 | } |
43 | return r; |
44 | } |
45 | |
d45d4c07 |
46 | /* |
47 | * Parse a ^C style character specification. |
48 | * Returns NULL in `next' if we didn't recognise it as a control character, |
49 | * in which case `c' should be ignored. |
50 | * The precise current parsing is an oddity inherited from the terminal |
447940b3 |
51 | * answerback-string parsing code. All sequences start with ^; all except |
52 | * ^<123> are two characters. The ones that are worth keeping are probably: |
d45d4c07 |
53 | * ^? 127 |
54 | * ^@A-Z[\]^_ 0-31 |
55 | * a-z 1-26 |
447940b3 |
56 | * <num> specified by number (decimal, 0octal, 0xHEX) |
d45d4c07 |
57 | * ~ ^ escape |
58 | */ |
59 | char ctrlparse(char *s, char **next) |
60 | { |
61 | char c = 0; |
62 | if (*s != '^') { |
63 | *next = NULL; |
d45d4c07 |
64 | } else { |
65 | s++; |
66 | if (*s == '\0') { |
67 | *next = NULL; |
447940b3 |
68 | } else if (*s == '<') { |
69 | s++; |
70 | c = (char)strtol(s, next, 0); |
71 | if ((*next == s) || (**next != '>')) { |
72 | c = 0; |
73 | *next = NULL; |
74 | } else |
75 | (*next)++; |
d45d4c07 |
76 | } else if (*s >= 'a' && *s <= 'z') { |
77 | c = (*s - ('a' - 1)); |
447940b3 |
78 | *next = s+1; |
d45d4c07 |
79 | } else if ((*s >= '@' && *s <= '_') || *s == '?' || (*s & 0x80)) { |
80 | c = ('@' ^ *s); |
447940b3 |
81 | *next = s+1; |
d45d4c07 |
82 | } else if (*s == '~') { |
83 | c = '^'; |
447940b3 |
84 | *next = s+1; |
d45d4c07 |
85 | } |
d45d4c07 |
86 | } |
447940b3 |
87 | return c; |
d45d4c07 |
88 | } |
89 | |
edd0cb8a |
90 | prompts_t *new_prompts(void *frontend) |
91 | { |
92 | prompts_t *p = snew(prompts_t); |
93 | p->prompts = NULL; |
94 | p->n_prompts = 0; |
95 | p->frontend = frontend; |
96 | p->data = NULL; |
97 | p->to_server = TRUE; /* to be on the safe side */ |
98 | p->name = p->instruction = NULL; |
99 | p->name_reqd = p->instr_reqd = FALSE; |
100 | return p; |
101 | } |
b61f81bc |
102 | void add_prompt(prompts_t *p, char *promptstr, int echo) |
edd0cb8a |
103 | { |
104 | prompt_t *pr = snew(prompt_t); |
edd0cb8a |
105 | pr->prompt = promptstr; |
106 | pr->echo = echo; |
b61f81bc |
107 | pr->result = NULL; |
108 | pr->resultsize = 0; |
edd0cb8a |
109 | p->n_prompts++; |
110 | p->prompts = sresize(p->prompts, p->n_prompts, prompt_t *); |
111 | p->prompts[p->n_prompts-1] = pr; |
112 | } |
b61f81bc |
113 | void prompt_ensure_result_size(prompt_t *pr, int newlen) |
114 | { |
115 | if ((int)pr->resultsize < newlen) { |
116 | char *newbuf; |
117 | newlen = newlen * 5 / 4 + 512; /* avoid too many small allocs */ |
118 | |
119 | /* |
120 | * We don't use sresize / realloc here, because we will be |
121 | * storing sensitive stuff like passwords in here, and we want |
122 | * to make sure that the data doesn't get copied around in |
123 | * memory without the old copy being destroyed. |
124 | */ |
125 | newbuf = snewn(newlen, char); |
126 | memcpy(newbuf, pr->result, pr->resultsize); |
dfb88efd |
127 | smemclr(pr->result, pr->resultsize); |
b61f81bc |
128 | sfree(pr->result); |
129 | pr->result = newbuf; |
130 | pr->resultsize = newlen; |
131 | } |
132 | } |
133 | void prompt_set_result(prompt_t *pr, const char *newstr) |
134 | { |
135 | prompt_ensure_result_size(pr, strlen(newstr) + 1); |
136 | strcpy(pr->result, newstr); |
137 | } |
edd0cb8a |
138 | void free_prompts(prompts_t *p) |
139 | { |
140 | size_t i; |
141 | for (i=0; i < p->n_prompts; i++) { |
142 | prompt_t *pr = p->prompts[i]; |
dfb88efd |
143 | smemclr(pr->result, pr->resultsize); /* burn the evidence */ |
edd0cb8a |
144 | sfree(pr->result); |
145 | sfree(pr->prompt); |
146 | sfree(pr); |
147 | } |
148 | sfree(p->prompts); |
149 | sfree(p->name); |
150 | sfree(p->instruction); |
151 | sfree(p); |
152 | } |
153 | |
03f64569 |
154 | /* ---------------------------------------------------------------------- |
155 | * String handling routines. |
156 | */ |
157 | |
57356d63 |
158 | char *dupstr(const char *s) |
03f64569 |
159 | { |
6d113886 |
160 | char *p = NULL; |
161 | if (s) { |
162 | int len = strlen(s); |
163 | p = snewn(len + 1, char); |
164 | strcpy(p, s); |
165 | } |
03f64569 |
166 | return p; |
167 | } |
168 | |
169 | /* Allocate the concatenation of N strings. Terminate arg list with NULL. */ |
57356d63 |
170 | char *dupcat(const char *s1, ...) |
03f64569 |
171 | { |
172 | int len; |
173 | char *p, *q, *sn; |
174 | va_list ap; |
175 | |
176 | len = strlen(s1); |
177 | va_start(ap, s1); |
178 | while (1) { |
179 | sn = va_arg(ap, char *); |
180 | if (!sn) |
181 | break; |
182 | len += strlen(sn); |
183 | } |
184 | va_end(ap); |
185 | |
3d88e64d |
186 | p = snewn(len + 1, char); |
03f64569 |
187 | strcpy(p, s1); |
188 | q = p + strlen(p); |
189 | |
190 | va_start(ap, s1); |
191 | while (1) { |
192 | sn = va_arg(ap, char *); |
193 | if (!sn) |
194 | break; |
195 | strcpy(q, sn); |
196 | q += strlen(q); |
197 | } |
198 | va_end(ap); |
199 | |
200 | return p; |
201 | } |
202 | |
12b9e82d |
203 | void burnstr(char *string) /* sfree(str), only clear it first */ |
204 | { |
205 | if (string) { |
dfb88efd |
206 | smemclr(string, strlen(string)); |
12b9e82d |
207 | sfree(string); |
208 | } |
209 | } |
210 | |
57356d63 |
211 | /* |
212 | * Do an sprintf(), but into a custom-allocated buffer. |
213 | * |
28da9e3d |
214 | * Currently I'm doing this via vsnprintf. This has worked so far, |
e1ef3c29 |
215 | * but it's not good, because vsnprintf is not available on all |
216 | * platforms. There's an ifdef to use `_vsnprintf', which seems |
217 | * to be the local name for it on Windows. Other platforms may |
218 | * lack it completely, in which case it'll be time to rewrite |
219 | * this function in a totally different way. |
28da9e3d |
220 | * |
221 | * The only `properly' portable solution I can think of is to |
222 | * implement my own format string scanner, which figures out an |
223 | * upper bound for the length of each formatting directive, |
224 | * allocates the buffer as it goes along, and calls sprintf() to |
225 | * actually process each directive. If I ever need to actually do |
226 | * this, some caveats: |
227 | * |
228 | * - It's very hard to find a reliable upper bound for |
229 | * floating-point values. %f, in particular, when supplied with |
230 | * a number near to the upper or lower limit of representable |
231 | * numbers, could easily take several hundred characters. It's |
232 | * probably feasible to predict this statically using the |
233 | * constants in <float.h>, or even to predict it dynamically by |
234 | * looking at the exponent of the specific float provided, but |
235 | * it won't be fun. |
236 | * |
237 | * - Don't forget to _check_, after calling sprintf, that it's |
238 | * used at most the amount of space we had available. |
239 | * |
240 | * - Fault any formatting directive we don't fully understand. The |
241 | * aim here is to _guarantee_ that we never overflow the buffer, |
242 | * because this is a security-critical function. If we see a |
243 | * directive we don't know about, we should panic and die rather |
244 | * than run any risk. |
57356d63 |
245 | */ |
246 | char *dupprintf(const char *fmt, ...) |
247 | { |
248 | char *ret; |
249 | va_list ap; |
250 | va_start(ap, fmt); |
251 | ret = dupvprintf(fmt, ap); |
252 | va_end(ap); |
253 | return ret; |
254 | } |
255 | char *dupvprintf(const char *fmt, va_list ap) |
256 | { |
257 | char *buf; |
258 | int len, size; |
259 | |
3d88e64d |
260 | buf = snewn(512, char); |
57356d63 |
261 | size = 512; |
262 | |
263 | while (1) { |
264 | #ifdef _WINDOWS |
265 | #define vsnprintf _vsnprintf |
266 | #endif |
e1ef3c29 |
267 | #ifdef va_copy |
268 | /* Use the `va_copy' macro mandated by C99, if present. |
269 | * XXX some environments may have this as __va_copy() */ |
270 | va_list aq; |
271 | va_copy(aq, ap); |
272 | len = vsnprintf(buf, size, fmt, aq); |
273 | va_end(aq); |
274 | #else |
275 | /* Ugh. No va_copy macro, so do something nasty. |
276 | * Technically, you can't reuse a va_list like this: it is left |
277 | * unspecified whether advancing a va_list pointer modifies its |
278 | * value or something it points to, so on some platforms calling |
279 | * vsnprintf twice on the same va_list might fail hideously |
280 | * (indeed, it has been observed to). |
281 | * XXX the autoconf manual suggests that using memcpy() will give |
282 | * "maximum portability". */ |
57356d63 |
283 | len = vsnprintf(buf, size, fmt, ap); |
e1ef3c29 |
284 | #endif |
57356d63 |
285 | if (len >= 0 && len < size) { |
286 | /* This is the C99-specified criterion for snprintf to have |
287 | * been completely successful. */ |
288 | return buf; |
289 | } else if (len > 0) { |
290 | /* This is the C99 error condition: the returned length is |
291 | * the required buffer size not counting the NUL. */ |
292 | size = len + 1; |
293 | } else { |
294 | /* This is the pre-C99 glibc error condition: <0 means the |
295 | * buffer wasn't big enough, so we enlarge it a bit and hope. */ |
296 | size += 512; |
297 | } |
3d88e64d |
298 | buf = sresize(buf, size, char); |
57356d63 |
299 | } |
300 | } |
301 | |
39934deb |
302 | /* |
303 | * Read an entire line of text from a file. Return a buffer |
304 | * malloced to be as big as necessary (caller must free). |
305 | */ |
306 | char *fgetline(FILE *fp) |
307 | { |
308 | char *ret = snewn(512, char); |
309 | int size = 512, len = 0; |
310 | while (fgets(ret + len, size - len, fp)) { |
311 | len += strlen(ret + len); |
312 | if (ret[len-1] == '\n') |
313 | break; /* got a newline, we're done */ |
314 | size = len + 512; |
315 | ret = sresize(ret, size, char); |
316 | } |
317 | if (len == 0) { /* first fgets returned NULL */ |
318 | sfree(ret); |
319 | return NULL; |
320 | } |
321 | ret[len] = '\0'; |
322 | return ret; |
323 | } |
324 | |
03f64569 |
325 | /* ---------------------------------------------------------------------- |
1549e076 |
326 | * Base64 encoding routine. This is required in public-key writing |
327 | * but also in HTTP proxy handling, so it's centralised here. |
328 | */ |
329 | |
330 | void base64_encode_atom(unsigned char *data, int n, char *out) |
331 | { |
332 | static const char base64_chars[] = |
333 | "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"; |
334 | |
335 | unsigned word; |
336 | |
337 | word = data[0] << 16; |
338 | if (n > 1) |
339 | word |= data[1] << 8; |
340 | if (n > 2) |
341 | word |= data[2]; |
342 | out[0] = base64_chars[(word >> 18) & 0x3F]; |
343 | out[1] = base64_chars[(word >> 12) & 0x3F]; |
344 | if (n > 1) |
345 | out[2] = base64_chars[(word >> 6) & 0x3F]; |
346 | else |
347 | out[2] = '='; |
348 | if (n > 2) |
349 | out[3] = base64_chars[word & 0x3F]; |
350 | else |
351 | out[3] = '='; |
352 | } |
353 | |
354 | /* ---------------------------------------------------------------------- |
5471d09a |
355 | * Generic routines to deal with send buffers: a linked list of |
356 | * smallish blocks, with the operations |
357 | * |
358 | * - add an arbitrary amount of data to the end of the list |
359 | * - remove the first N bytes from the list |
360 | * - return a (pointer,length) pair giving some initial data in |
361 | * the list, suitable for passing to a send or write system |
362 | * call |
7983f47e |
363 | * - retrieve a larger amount of initial data from the list |
5471d09a |
364 | * - return the current size of the buffer chain in bytes |
365 | */ |
366 | |
c780e7e1 |
367 | #define BUFFER_MIN_GRANULE 512 |
5471d09a |
368 | |
369 | struct bufchain_granule { |
370 | struct bufchain_granule *next; |
c780e7e1 |
371 | char *bufpos, *bufend, *bufmax; |
5471d09a |
372 | }; |
373 | |
374 | void bufchain_init(bufchain *ch) |
375 | { |
376 | ch->head = ch->tail = NULL; |
377 | ch->buffersize = 0; |
378 | } |
379 | |
380 | void bufchain_clear(bufchain *ch) |
381 | { |
382 | struct bufchain_granule *b; |
383 | while (ch->head) { |
384 | b = ch->head; |
385 | ch->head = ch->head->next; |
386 | sfree(b); |
387 | } |
388 | ch->tail = NULL; |
389 | ch->buffersize = 0; |
390 | } |
391 | |
392 | int bufchain_size(bufchain *ch) |
393 | { |
394 | return ch->buffersize; |
395 | } |
396 | |
e0e7dff8 |
397 | void bufchain_add(bufchain *ch, const void *data, int len) |
5471d09a |
398 | { |
e0e7dff8 |
399 | const char *buf = (const char *)data; |
5471d09a |
400 | |
bfa5400d |
401 | if (len == 0) return; |
402 | |
5471d09a |
403 | ch->buffersize += len; |
404 | |
5471d09a |
405 | while (len > 0) { |
c780e7e1 |
406 | if (ch->tail && ch->tail->bufend < ch->tail->bufmax) { |
407 | int copylen = min(len, ch->tail->bufmax - ch->tail->bufend); |
408 | memcpy(ch->tail->bufend, buf, copylen); |
409 | buf += copylen; |
410 | len -= copylen; |
411 | ch->tail->bufend += copylen; |
412 | } |
413 | if (len > 0) { |
414 | int grainlen = |
415 | max(sizeof(struct bufchain_granule) + len, BUFFER_MIN_GRANULE); |
416 | struct bufchain_granule *newbuf; |
417 | newbuf = smalloc(grainlen); |
418 | newbuf->bufpos = newbuf->bufend = |
419 | (char *)newbuf + sizeof(struct bufchain_granule); |
420 | newbuf->bufmax = (char *)newbuf + grainlen; |
421 | newbuf->next = NULL; |
422 | if (ch->tail) |
423 | ch->tail->next = newbuf; |
424 | else |
425 | ch->head = newbuf; |
426 | ch->tail = newbuf; |
427 | } |
5471d09a |
428 | } |
429 | } |
430 | |
431 | void bufchain_consume(bufchain *ch, int len) |
432 | { |
7983f47e |
433 | struct bufchain_granule *tmp; |
434 | |
5471d09a |
435 | assert(ch->buffersize >= len); |
7983f47e |
436 | while (len > 0) { |
437 | int remlen = len; |
438 | assert(ch->head != NULL); |
c780e7e1 |
439 | if (remlen >= ch->head->bufend - ch->head->bufpos) { |
440 | remlen = ch->head->bufend - ch->head->bufpos; |
7983f47e |
441 | tmp = ch->head; |
442 | ch->head = tmp->next; |
7983f47e |
443 | if (!ch->head) |
444 | ch->tail = NULL; |
c780e7e1 |
445 | sfree(tmp); |
7983f47e |
446 | } else |
447 | ch->head->bufpos += remlen; |
448 | ch->buffersize -= remlen; |
449 | len -= remlen; |
5471d09a |
450 | } |
451 | } |
452 | |
453 | void bufchain_prefix(bufchain *ch, void **data, int *len) |
454 | { |
c780e7e1 |
455 | *len = ch->head->bufend - ch->head->bufpos; |
456 | *data = ch->head->bufpos; |
5471d09a |
457 | } |
458 | |
7983f47e |
459 | void bufchain_fetch(bufchain *ch, void *data, int len) |
460 | { |
461 | struct bufchain_granule *tmp; |
462 | char *data_c = (char *)data; |
463 | |
464 | tmp = ch->head; |
465 | |
466 | assert(ch->buffersize >= len); |
467 | while (len > 0) { |
468 | int remlen = len; |
469 | |
470 | assert(tmp != NULL); |
c780e7e1 |
471 | if (remlen >= tmp->bufend - tmp->bufpos) |
472 | remlen = tmp->bufend - tmp->bufpos; |
473 | memcpy(data_c, tmp->bufpos, remlen); |
7983f47e |
474 | |
475 | tmp = tmp->next; |
476 | len -= remlen; |
477 | data_c += remlen; |
478 | } |
479 | } |
480 | |
03f64569 |
481 | /* ---------------------------------------------------------------------- |
b191636d |
482 | * My own versions of malloc, realloc and free. Because I want |
483 | * malloc and realloc to bomb out and exit the program if they run |
484 | * out of memory, realloc to reliably call malloc if passed a NULL |
485 | * pointer, and free to reliably do nothing if passed a NULL |
486 | * pointer. We can also put trace printouts in, if we need to; and |
487 | * we can also replace the allocator with an ElectricFence-like |
488 | * one. |
489 | */ |
490 | |
491 | #ifdef MINEFIELD |
d0912d1f |
492 | void *minefield_c_malloc(size_t size); |
493 | void minefield_c_free(void *p); |
494 | void *minefield_c_realloc(void *p, size_t size); |
495 | #endif |
374330e2 |
496 | |
497 | #ifdef MALLOC_LOG |
498 | static FILE *fp = NULL; |
499 | |
d7da76ca |
500 | static char *mlog_file = NULL; |
501 | static int mlog_line = 0; |
502 | |
32874aea |
503 | void mlog(char *file, int line) |
504 | { |
d7da76ca |
505 | mlog_file = file; |
506 | mlog_line = line; |
c662dbc0 |
507 | if (!fp) { |
374330e2 |
508 | fp = fopen("putty_mem.log", "w"); |
c662dbc0 |
509 | setvbuf(fp, NULL, _IONBF, BUFSIZ); |
510 | } |
374330e2 |
511 | if (fp) |
32874aea |
512 | fprintf(fp, "%s:%d: ", file, line); |
374330e2 |
513 | } |
514 | #endif |
515 | |
46cfeac8 |
516 | void *safemalloc(size_t n, size_t size) |
32874aea |
517 | { |
b191636d |
518 | void *p; |
46cfeac8 |
519 | |
520 | if (n > INT_MAX / size) { |
521 | p = NULL; |
522 | } else { |
523 | size *= n; |
66ab14c7 |
524 | if (size == 0) size = 1; |
b191636d |
525 | #ifdef MINEFIELD |
46cfeac8 |
526 | p = minefield_c_malloc(size); |
b191636d |
527 | #else |
46cfeac8 |
528 | p = malloc(size); |
b191636d |
529 | #endif |
46cfeac8 |
530 | } |
531 | |
374330e2 |
532 | if (!p) { |
d7da76ca |
533 | char str[200]; |
534 | #ifdef MALLOC_LOG |
535 | sprintf(str, "Out of memory! (%s:%d, size=%d)", |
536 | mlog_file, mlog_line, size); |
1b2ef365 |
537 | fprintf(fp, "*** %s\n", str); |
538 | fclose(fp); |
d7da76ca |
539 | #else |
540 | strcpy(str, "Out of memory!"); |
541 | #endif |
1709795f |
542 | modalfatalbox(str); |
374330e2 |
543 | } |
544 | #ifdef MALLOC_LOG |
545 | if (fp) |
546 | fprintf(fp, "malloc(%d) returns %p\n", size, p); |
547 | #endif |
548 | return p; |
549 | } |
550 | |
46cfeac8 |
551 | void *saferealloc(void *ptr, size_t n, size_t size) |
32874aea |
552 | { |
374330e2 |
553 | void *p; |
46cfeac8 |
554 | |
555 | if (n > INT_MAX / size) { |
556 | p = NULL; |
557 | } else { |
558 | size *= n; |
559 | if (!ptr) { |
b191636d |
560 | #ifdef MINEFIELD |
46cfeac8 |
561 | p = minefield_c_malloc(size); |
b191636d |
562 | #else |
46cfeac8 |
563 | p = malloc(size); |
b191636d |
564 | #endif |
46cfeac8 |
565 | } else { |
b191636d |
566 | #ifdef MINEFIELD |
46cfeac8 |
567 | p = minefield_c_realloc(ptr, size); |
b191636d |
568 | #else |
46cfeac8 |
569 | p = realloc(ptr, size); |
b191636d |
570 | #endif |
46cfeac8 |
571 | } |
b191636d |
572 | } |
46cfeac8 |
573 | |
374330e2 |
574 | if (!p) { |
d7da76ca |
575 | char str[200]; |
576 | #ifdef MALLOC_LOG |
577 | sprintf(str, "Out of memory! (%s:%d, size=%d)", |
578 | mlog_file, mlog_line, size); |
1b2ef365 |
579 | fprintf(fp, "*** %s\n", str); |
580 | fclose(fp); |
d7da76ca |
581 | #else |
582 | strcpy(str, "Out of memory!"); |
583 | #endif |
1709795f |
584 | modalfatalbox(str); |
374330e2 |
585 | } |
586 | #ifdef MALLOC_LOG |
587 | if (fp) |
588 | fprintf(fp, "realloc(%p,%d) returns %p\n", ptr, size, p); |
589 | #endif |
590 | return p; |
591 | } |
592 | |
32874aea |
593 | void safefree(void *ptr) |
594 | { |
374330e2 |
595 | if (ptr) { |
596 | #ifdef MALLOC_LOG |
597 | if (fp) |
598 | fprintf(fp, "free(%p)\n", ptr); |
599 | #endif |
b191636d |
600 | #ifdef MINEFIELD |
32874aea |
601 | minefield_c_free(ptr); |
b191636d |
602 | #else |
32874aea |
603 | free(ptr); |
b191636d |
604 | #endif |
374330e2 |
605 | } |
606 | #ifdef MALLOC_LOG |
607 | else if (fp) |
608 | fprintf(fp, "freeing null pointer - no action taken\n"); |
609 | #endif |
610 | } |
c82bda52 |
611 | |
03f64569 |
612 | /* ---------------------------------------------------------------------- |
613 | * Debugging routines. |
614 | */ |
615 | |
c82bda52 |
616 | #ifdef DEBUG |
d0912d1f |
617 | extern void dputs(char *); /* defined in per-platform *misc.c */ |
db9c0f86 |
618 | |
d0912d1f |
619 | void debug_printf(char *fmt, ...) |
32874aea |
620 | { |
57356d63 |
621 | char *buf; |
db9c0f86 |
622 | va_list ap; |
623 | |
624 | va_start(ap, fmt); |
57356d63 |
625 | buf = dupvprintf(fmt, ap); |
32874aea |
626 | dputs(buf); |
57356d63 |
627 | sfree(buf); |
c82bda52 |
628 | va_end(ap); |
629 | } |
db9c0f86 |
630 | |
631 | |
32874aea |
632 | void debug_memdump(void *buf, int len, int L) |
633 | { |
db9c0f86 |
634 | int i; |
635 | unsigned char *p = buf; |
765c4200 |
636 | char foo[17]; |
db9c0f86 |
637 | if (L) { |
638 | int delta; |
d0912d1f |
639 | debug_printf("\t%d (0x%x) bytes:\n", len, len); |
cc0966fa |
640 | delta = 15 & (unsigned long int) p; |
db9c0f86 |
641 | p -= delta; |
642 | len += delta; |
643 | } |
644 | for (; 0 < len; p += 16, len -= 16) { |
32874aea |
645 | dputs(" "); |
646 | if (L) |
d0912d1f |
647 | debug_printf("%p: ", p); |
32874aea |
648 | strcpy(foo, "................"); /* sixteen dots */ |
db9c0f86 |
649 | for (i = 0; i < 16 && i < len; ++i) { |
650 | if (&p[i] < (unsigned char *) buf) { |
32874aea |
651 | dputs(" "); /* 3 spaces */ |
765c4200 |
652 | foo[i] = ' '; |
db9c0f86 |
653 | } else { |
d0912d1f |
654 | debug_printf("%c%02.2x", |
32874aea |
655 | &p[i] != (unsigned char *) buf |
656 | && i % 4 ? '.' : ' ', p[i] |
657 | ); |
765c4200 |
658 | if (p[i] >= ' ' && p[i] <= '~') |
32874aea |
659 | foo[i] = (char) p[i]; |
db9c0f86 |
660 | } |
661 | } |
765c4200 |
662 | foo[i] = '\0'; |
d0912d1f |
663 | debug_printf("%*s%s\n", (16 - i) * 3 + 2, "", foo); |
db9c0f86 |
664 | } |
665 | } |
666 | |
32874aea |
667 | #endif /* def DEBUG */ |
7374c779 |
668 | |
669 | /* |
4a693cfc |
670 | * Determine whether or not a Conf represents a session which can |
671 | * sensibly be launched right now. |
7374c779 |
672 | */ |
4a693cfc |
673 | int conf_launchable(Conf *conf) |
7374c779 |
674 | { |
4a693cfc |
675 | if (conf_get_int(conf, CONF_protocol) == PROT_SERIAL) |
676 | return conf_get_str(conf, CONF_serline)[0] != 0; |
7374c779 |
677 | else |
4a693cfc |
678 | return conf_get_str(conf, CONF_host)[0] != 0; |
7374c779 |
679 | } |
680 | |
4a693cfc |
681 | char const *conf_dest(Conf *conf) |
7374c779 |
682 | { |
4a693cfc |
683 | if (conf_get_int(conf, CONF_protocol) == PROT_SERIAL) |
684 | return conf_get_str(conf, CONF_serline); |
7374c779 |
685 | else |
4a693cfc |
686 | return conf_get_str(conf, CONF_host); |
7374c779 |
687 | } |
dfb88efd |
688 | |
689 | #ifndef PLATFORM_HAS_SMEMCLR |
690 | /* |
691 | * Securely wipe memory. |
692 | * |
693 | * The actual wiping is no different from what memset would do: the |
694 | * point of 'securely' is to try to be sure over-clever compilers |
695 | * won't optimise away memsets on variables that are about to be freed |
696 | * or go out of scope. See |
697 | * https://buildsecurityin.us-cert.gov/bsi-rules/home/g1/771-BSI.html |
698 | * |
699 | * Some platforms (e.g. Windows) may provide their own version of this |
700 | * function. |
701 | */ |
702 | void smemclr(void *b, size_t n) { |
703 | volatile char *vp; |
704 | |
705 | if (b && n > 0) { |
706 | /* |
707 | * Zero out the memory. |
708 | */ |
709 | memset(b, 0, n); |
710 | |
711 | /* |
712 | * Perform a volatile access to the object, forcing the |
713 | * compiler to admit that the previous memset was important. |
714 | * |
715 | * This while loop should in practice run for zero iterations |
716 | * (since we know we just zeroed the object out), but in |
717 | * theory (as far as the compiler knows) it might range over |
718 | * the whole object. (If we had just written, say, '*vp = |
719 | * *vp;', a compiler could in principle have 'helpfully' |
720 | * optimised the memset into only zeroing out the first byte. |
721 | * This should be robust.) |
722 | */ |
723 | vp = b; |
724 | while (*vp) vp++; |
725 | } |
726 | } |
727 | #endif |