2 * Platform-independent routines shared between all PuTTY programs.
14 * Parse a string block size specification. This is approximately a
15 * subset of the block size specs supported by GNU fileutils:
19 * All numbers are decimal, and suffixes refer to powers of two.
22 unsigned long parse_blocksize(const char *bs
)
25 unsigned long r
= strtoul(bs
, &suf
, 10);
27 while (*suf
&& isspace((unsigned char)*suf
)) suf
++;
36 r
*= 1024ul * 1024ul * 1024ul;
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
51 * answerback-string parsing code. All sequences start with ^; all except
52 * ^<123> are two characters. The ones that are worth keeping are probably:
56 * <num> specified by number (decimal, 0octal, 0xHEX)
59 char ctrlparse(char *s
, char **next
)
68 } else if (*s
== '<') {
70 c
= (char)strtol(s
, next
, 0);
71 if ((*next
== s
) || (**next
!= '>')) {
76 } else if (*s
>= 'a' && *s
<= 'z') {
79 } else if ((*s
>= '@' && *s
<= '_') || *s
== '?' || (*s
& 0x80)) {
82 } else if (*s
== '~') {
90 prompts_t
*new_prompts(void *frontend
)
92 prompts_t
*p
= snew(prompts_t
);
95 p
->frontend
= frontend
;
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
;
102 void add_prompt(prompts_t
*p
, char *promptstr
, int echo
, size_t len
)
104 prompt_t
*pr
= snew(prompt_t
);
105 char *result
= snewn(len
, char);
106 pr
->prompt
= promptstr
;
109 pr
->result_len
= len
;
111 p
->prompts
= sresize(p
->prompts
, p
->n_prompts
, prompt_t
*);
112 p
->prompts
[p
->n_prompts
-1] = pr
;
114 void free_prompts(prompts_t
*p
)
117 for (i
=0; i
< p
->n_prompts
; i
++) {
118 prompt_t
*pr
= p
->prompts
[i
];
119 memset(pr
->result
, 0, pr
->result_len
); /* burn the evidence */
126 sfree(p
->instruction
);
130 /* ----------------------------------------------------------------------
131 * String handling routines.
134 char *dupstr(const char *s
)
139 p
= snewn(len
+ 1, char);
145 /* Allocate the concatenation of N strings. Terminate arg list with NULL. */
146 char *dupcat(const char *s1
, ...)
155 sn
= va_arg(ap
, char *);
162 p
= snewn(len
+ 1, char);
168 sn
= va_arg(ap
, char *);
180 * Do an sprintf(), but into a custom-allocated buffer.
182 * Currently I'm doing this via vsnprintf. This has worked so far,
183 * but it's not good, because vsnprintf is not available on all
184 * platforms. There's an ifdef to use `_vsnprintf', which seems
185 * to be the local name for it on Windows. Other platforms may
186 * lack it completely, in which case it'll be time to rewrite
187 * this function in a totally different way.
189 * The only `properly' portable solution I can think of is to
190 * implement my own format string scanner, which figures out an
191 * upper bound for the length of each formatting directive,
192 * allocates the buffer as it goes along, and calls sprintf() to
193 * actually process each directive. If I ever need to actually do
194 * this, some caveats:
196 * - It's very hard to find a reliable upper bound for
197 * floating-point values. %f, in particular, when supplied with
198 * a number near to the upper or lower limit of representable
199 * numbers, could easily take several hundred characters. It's
200 * probably feasible to predict this statically using the
201 * constants in <float.h>, or even to predict it dynamically by
202 * looking at the exponent of the specific float provided, but
205 * - Don't forget to _check_, after calling sprintf, that it's
206 * used at most the amount of space we had available.
208 * - Fault any formatting directive we don't fully understand. The
209 * aim here is to _guarantee_ that we never overflow the buffer,
210 * because this is a security-critical function. If we see a
211 * directive we don't know about, we should panic and die rather
214 char *dupprintf(const char *fmt
, ...)
219 ret
= dupvprintf(fmt
, ap
);
223 char *dupvprintf(const char *fmt
, va_list ap
)
228 buf
= snewn(512, char);
233 #define vsnprintf _vsnprintf
236 /* Use the `va_copy' macro mandated by C99, if present.
237 * XXX some environments may have this as __va_copy() */
240 len
= vsnprintf(buf
, size
, fmt
, aq
);
243 /* Ugh. No va_copy macro, so do something nasty.
244 * Technically, you can't reuse a va_list like this: it is left
245 * unspecified whether advancing a va_list pointer modifies its
246 * value or something it points to, so on some platforms calling
247 * vsnprintf twice on the same va_list might fail hideously
248 * (indeed, it has been observed to).
249 * XXX the autoconf manual suggests that using memcpy() will give
250 * "maximum portability". */
251 len
= vsnprintf(buf
, size
, fmt
, ap
);
253 if (len
>= 0 && len
< size
) {
254 /* This is the C99-specified criterion for snprintf to have
255 * been completely successful. */
257 } else if (len
> 0) {
258 /* This is the C99 error condition: the returned length is
259 * the required buffer size not counting the NUL. */
262 /* This is the pre-C99 glibc error condition: <0 means the
263 * buffer wasn't big enough, so we enlarge it a bit and hope. */
266 buf
= sresize(buf
, size
, char);
271 * Read an entire line of text from a file. Return a buffer
272 * malloced to be as big as necessary (caller must free).
274 char *fgetline(FILE *fp
)
276 char *ret
= snewn(512, char);
277 int size
= 512, len
= 0;
278 while (fgets(ret
+ len
, size
- len
, fp
)) {
279 len
+= strlen(ret
+ len
);
280 if (ret
[len
-1] == '\n')
281 break; /* got a newline, we're done */
283 ret
= sresize(ret
, size
, char);
285 if (len
== 0) { /* first fgets returned NULL */
293 /* ----------------------------------------------------------------------
294 * Base64 encoding routine. This is required in public-key writing
295 * but also in HTTP proxy handling, so it's centralised here.
298 void base64_encode_atom(unsigned char *data
, int n
, char *out
)
300 static const char base64_chars
[] =
301 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
305 word
= data
[0] << 16;
307 word
|= data
[1] << 8;
310 out
[0] = base64_chars
[(word
>> 18) & 0x3F];
311 out
[1] = base64_chars
[(word
>> 12) & 0x3F];
313 out
[2] = base64_chars
[(word
>> 6) & 0x3F];
317 out
[3] = base64_chars
[word
& 0x3F];
322 /* ----------------------------------------------------------------------
323 * Generic routines to deal with send buffers: a linked list of
324 * smallish blocks, with the operations
326 * - add an arbitrary amount of data to the end of the list
327 * - remove the first N bytes from the list
328 * - return a (pointer,length) pair giving some initial data in
329 * the list, suitable for passing to a send or write system
331 * - retrieve a larger amount of initial data from the list
332 * - return the current size of the buffer chain in bytes
335 #define BUFFER_GRANULE 512
337 struct bufchain_granule
{
338 struct bufchain_granule
*next
;
340 char buf
[BUFFER_GRANULE
];
343 void bufchain_init(bufchain
*ch
)
345 ch
->head
= ch
->tail
= NULL
;
349 void bufchain_clear(bufchain
*ch
)
351 struct bufchain_granule
*b
;
354 ch
->head
= ch
->head
->next
;
361 int bufchain_size(bufchain
*ch
)
363 return ch
->buffersize
;
366 void bufchain_add(bufchain
*ch
, const void *data
, int len
)
368 const char *buf
= (const char *)data
;
370 if (len
== 0) return;
372 ch
->buffersize
+= len
;
374 if (ch
->tail
&& ch
->tail
->buflen
< BUFFER_GRANULE
) {
375 int copylen
= min(len
, BUFFER_GRANULE
- ch
->tail
->buflen
);
376 memcpy(ch
->tail
->buf
+ ch
->tail
->buflen
, buf
, copylen
);
379 ch
->tail
->buflen
+= copylen
;
382 int grainlen
= min(len
, BUFFER_GRANULE
);
383 struct bufchain_granule
*newbuf
;
384 newbuf
= snew(struct bufchain_granule
);
386 newbuf
->buflen
= grainlen
;
387 memcpy(newbuf
->buf
, buf
, grainlen
);
391 ch
->tail
->next
= newbuf
;
393 ch
->head
= ch
->tail
= newbuf
;
399 void bufchain_consume(bufchain
*ch
, int len
)
401 struct bufchain_granule
*tmp
;
403 assert(ch
->buffersize
>= len
);
406 assert(ch
->head
!= NULL
);
407 if (remlen
>= ch
->head
->buflen
- ch
->head
->bufpos
) {
408 remlen
= ch
->head
->buflen
- ch
->head
->bufpos
;
410 ch
->head
= tmp
->next
;
415 ch
->head
->bufpos
+= remlen
;
416 ch
->buffersize
-= remlen
;
421 void bufchain_prefix(bufchain
*ch
, void **data
, int *len
)
423 *len
= ch
->head
->buflen
- ch
->head
->bufpos
;
424 *data
= ch
->head
->buf
+ ch
->head
->bufpos
;
427 void bufchain_fetch(bufchain
*ch
, void *data
, int len
)
429 struct bufchain_granule
*tmp
;
430 char *data_c
= (char *)data
;
434 assert(ch
->buffersize
>= len
);
439 if (remlen
>= tmp
->buflen
- tmp
->bufpos
)
440 remlen
= tmp
->buflen
- tmp
->bufpos
;
441 memcpy(data_c
, tmp
->buf
+ tmp
->bufpos
, remlen
);
449 /* ----------------------------------------------------------------------
450 * My own versions of malloc, realloc and free. Because I want
451 * malloc and realloc to bomb out and exit the program if they run
452 * out of memory, realloc to reliably call malloc if passed a NULL
453 * pointer, and free to reliably do nothing if passed a NULL
454 * pointer. We can also put trace printouts in, if we need to; and
455 * we can also replace the allocator with an ElectricFence-like
460 void *minefield_c_malloc(size_t size
);
461 void minefield_c_free(void *p
);
462 void *minefield_c_realloc(void *p
, size_t size
);
466 static FILE *fp
= NULL
;
468 static char *mlog_file
= NULL
;
469 static int mlog_line
= 0;
471 void mlog(char *file
, int line
)
476 fp
= fopen("putty_mem.log", "w");
477 setvbuf(fp
, NULL
, _IONBF
, BUFSIZ
);
480 fprintf(fp
, "%s:%d: ", file
, line
);
484 void *safemalloc(size_t n
, size_t size
)
488 if (n
> INT_MAX
/ size
) {
492 if (size
== 0) size
= 1;
494 p
= minefield_c_malloc(size
);
503 sprintf(str
, "Out of memory! (%s:%d, size=%d)",
504 mlog_file
, mlog_line
, size
);
505 fprintf(fp
, "*** %s\n", str
);
508 strcpy(str
, "Out of memory!");
514 fprintf(fp
, "malloc(%d) returns %p\n", size
, p
);
519 void *saferealloc(void *ptr
, size_t n
, size_t size
)
523 if (n
> INT_MAX
/ size
) {
529 p
= minefield_c_malloc(size
);
535 p
= minefield_c_realloc(ptr
, size
);
537 p
= realloc(ptr
, size
);
545 sprintf(str
, "Out of memory! (%s:%d, size=%d)",
546 mlog_file
, mlog_line
, size
);
547 fprintf(fp
, "*** %s\n", str
);
550 strcpy(str
, "Out of memory!");
556 fprintf(fp
, "realloc(%p,%d) returns %p\n", ptr
, size
, p
);
561 void safefree(void *ptr
)
566 fprintf(fp
, "free(%p)\n", ptr
);
569 minefield_c_free(ptr
);
576 fprintf(fp
, "freeing null pointer - no action taken\n");
580 /* ----------------------------------------------------------------------
581 * Debugging routines.
585 extern void dputs(char *); /* defined in per-platform *misc.c */
587 void debug_printf(char *fmt
, ...)
593 buf
= dupvprintf(fmt
, ap
);
600 void debug_memdump(void *buf
, int len
, int L
)
603 unsigned char *p
= buf
;
607 debug_printf("\t%d (0x%x) bytes:\n", len
, len
);
608 delta
= 15 & (unsigned long int) p
;
612 for (; 0 < len
; p
+= 16, len
-= 16) {
615 debug_printf("%p: ", p
);
616 strcpy(foo
, "................"); /* sixteen dots */
617 for (i
= 0; i
< 16 && i
< len
; ++i
) {
618 if (&p
[i
] < (unsigned char *) buf
) {
619 dputs(" "); /* 3 spaces */
622 debug_printf("%c%02.2x",
623 &p
[i
] != (unsigned char *) buf
624 && i
% 4 ?
'.' : ' ', p
[i
]
626 if (p
[i
] >= ' ' && p
[i
] <= '~')
627 foo
[i
] = (char) p
[i
];
631 debug_printf("%*s%s\n", (16 - i
) * 3 + 2, "", foo
);
635 #endif /* def DEBUG */
638 * Determine whether or not a Config structure represents a session
639 * which can sensibly be launched right now.
641 int cfg_launchable(const Config
*cfg
)
643 if (cfg
->protocol
== PROT_SERIAL
)
644 return cfg
->serline
[0] != 0;
646 return cfg
->host
[0] != 0;
649 char const *cfg_dest(const Config
*cfg
)
651 if (cfg
->protocol
== PROT_SERIAL
)