10 #include <stdio.h> /* for FILE * */
11 #include <stdarg.h> /* for va_list */
12 #include <time.h> /* for struct tm */
21 typedef struct Filename Filename;
22 typedef struct FontSpec FontSpec;
24 unsigned long parse_blocksize(const char *bs);
25 char ctrlparse(char *s, char **next);
27 size_t host_strcspn(const char *s, const char *set);
28 char *host_strchr(const char *s, int c);
29 char *host_strrchr(const char *s, int c);
30 char *host_strduptrim(const char *s);
32 char *dupstr(const char *s);
33 char *dupcat(const char *s1, ...);
34 char *dupprintf(const char *fmt, ...)
36 __attribute__ ((format (printf, 1, 2)))
39 char *dupvprintf(const char *fmt, va_list ap);
40 void burnstr(char *string);
42 /* String-to-Unicode converters that auto-allocate the destination and
43 * work around the rather deficient interface of mb_to_wc.
45 * These actually live in miscucs.c, not misc.c (the distinction being
46 * that the former is only linked into tools that also have the main
47 * Unicode support). */
48 wchar_t *dup_mb_to_wc_c(int codepage, int flags, const char *string, int len);
49 wchar_t *dup_mb_to_wc(int codepage, int flags, const char *string);
53 char *fgetline(FILE *fp);
54 char *chomp(char *str);
55 int strstartswith(const char *s, const char *t);
56 int strendswith(const char *s, const char *t);
58 void base64_encode_atom(const unsigned char *data, int n, char *out);
59 int base64_decode_atom(const char *atom, unsigned char *out);
61 struct bufchain_granule;
62 typedef struct bufchain_tag {
63 struct bufchain_granule *head, *tail;
64 int buffersize; /* current amount of buffered data */
67 void bufchain_init(bufchain *ch);
68 void bufchain_clear(bufchain *ch);
69 int bufchain_size(bufchain *ch);
70 void bufchain_add(bufchain *ch, const void *data, int len);
71 void bufchain_prefix(bufchain *ch, void **data, int *len);
72 void bufchain_consume(bufchain *ch, int len);
73 void bufchain_fetch(bufchain *ch, void *data, int len);
75 int validate_manual_hostkey(char *key);
77 struct tm ltime(void);
79 /* Wipe sensitive data out of memory that's about to be freed. Simpler
80 * than memset because we don't need the fill char parameter; also
81 * attempts (by fiddly use of volatile) to inhibit the compiler from
82 * over-cleverly trying to optimise the memset away because it knows
83 * the variable is going out of scope. */
84 void smemclr(void *b, size_t len);
86 /* Compare two fixed-length chunks of memory for equality, without
87 * data-dependent control flow (so an attacker with a very accurate
88 * stopwatch can't try to guess where the first mismatching byte was).
89 * Returns 0 for mismatch or 1 for equality (unlike memcmp), hinted at
90 * by the 'eq' in the name. */
91 int smemeq(const void *av, const void *bv, size_t len);
93 /* Extracts an SSH-marshalled string from the start of *data. If
94 * successful (*datalen is not too small), advances data/datalen past
95 * the string and returns a pointer to the string itself and its
96 * length in *stringlen. Otherwise does nothing and returns NULL.
98 * Like strchr, this function can discard const from its parameter.
99 * Treat it as if it was a family of two functions, one returning a
100 * non-const string given a non-const pointer, and one taking and
101 * returning const. */
102 void *get_ssh_string(int *datalen, const void **data, int *stringlen);
103 /* Extracts an SSH uint32, similarly. Returns TRUE on success, and
104 * leaves the extracted value in *ret. */
105 int get_ssh_uint32(int *datalen, const void **data, unsigned *ret);
106 /* Given a not-necessarily-zero-terminated string in (length,data)
107 * form, check if it equals an ordinary C zero-terminated string. */
108 int match_ssh_id(int stringlen, const void *string, const char *id);
111 * Debugging functions.
113 * Output goes to debug.log
115 * debug(()) (note the double brackets) is like printf().
117 * dmemdump() and dmemdumpl() both do memory dumps. The difference
118 * is that dmemdumpl() is more suited for when the memory address is
119 * important (say because you'll be recording pointer values later
120 * on). dmemdump() is more concise.
124 void debug_printf(const char *fmt, ...);
125 void debug_memdump(const void *buf, int len, int L);
126 #define debug(x) (debug_printf x)
127 #define dmemdump(buf,len) debug_memdump (buf, len, 0);
128 #define dmemdumpl(buf,len) debug_memdump (buf, len, 1);
131 #define dmemdump(buf,len)
132 #define dmemdumpl(buf,len)
136 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
140 #define min(x,y) ( (x) < (y) ? (x) : (y) )
143 #define max(x,y) ( (x) > (y) ? (x) : (y) )
146 #define GET_32BIT_LSB_FIRST(cp) \
147 (((unsigned long)(unsigned char)(cp)[0]) | \
148 ((unsigned long)(unsigned char)(cp)[1] << 8) | \
149 ((unsigned long)(unsigned char)(cp)[2] << 16) | \
150 ((unsigned long)(unsigned char)(cp)[3] << 24))
152 #define PUT_32BIT_LSB_FIRST(cp, value) ( \
153 (cp)[0] = (unsigned char)(value), \
154 (cp)[1] = (unsigned char)((value) >> 8), \
155 (cp)[2] = (unsigned char)((value) >> 16), \
156 (cp)[3] = (unsigned char)((value) >> 24) )
158 #define GET_16BIT_LSB_FIRST(cp) \
159 (((unsigned long)(unsigned char)(cp)[0]) | \
160 ((unsigned long)(unsigned char)(cp)[1] << 8))
162 #define PUT_16BIT_LSB_FIRST(cp, value) ( \
163 (cp)[0] = (unsigned char)(value), \
164 (cp)[1] = (unsigned char)((value) >> 8) )
166 #define GET_32BIT_MSB_FIRST(cp) \
167 (((unsigned long)(unsigned char)(cp)[0] << 24) | \
168 ((unsigned long)(unsigned char)(cp)[1] << 16) | \
169 ((unsigned long)(unsigned char)(cp)[2] << 8) | \
170 ((unsigned long)(unsigned char)(cp)[3]))
172 #define GET_32BIT(cp) GET_32BIT_MSB_FIRST(cp)
174 #define PUT_32BIT_MSB_FIRST(cp, value) ( \
175 (cp)[0] = (unsigned char)((value) >> 24), \
176 (cp)[1] = (unsigned char)((value) >> 16), \
177 (cp)[2] = (unsigned char)((value) >> 8), \
178 (cp)[3] = (unsigned char)(value) )
180 #define PUT_32BIT(cp, value) PUT_32BIT_MSB_FIRST(cp, value)
182 #define GET_16BIT_MSB_FIRST(cp) \
183 (((unsigned long)(unsigned char)(cp)[0] << 8) | \
184 ((unsigned long)(unsigned char)(cp)[1]))
186 #define PUT_16BIT_MSB_FIRST(cp, value) ( \
187 (cp)[0] = (unsigned char)((value) >> 8), \
188 (cp)[1] = (unsigned char)(value) )
190 /* Replace NULL with the empty string, permitting an idiom in which we
191 * get a string (pointer,length) pair that might be NULL,0 and can
192 * then safely say things like printf("%.*s", length, NULLTOEMPTY(ptr)) */
193 #define NULLTOEMPTY(s) ((s)?(s):"")