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);
44 char *fgetline(FILE *fp);
46 void base64_encode_atom(unsigned char *data, int n, char *out);
47 int base64_decode_atom(char *atom, unsigned char *out);
49 struct bufchain_granule;
50 typedef struct bufchain_tag {
51 struct bufchain_granule *head, *tail;
52 int buffersize; /* current amount of buffered data */
55 void bufchain_init(bufchain *ch);
56 void bufchain_clear(bufchain *ch);
57 int bufchain_size(bufchain *ch);
58 void bufchain_add(bufchain *ch, const void *data, int len);
59 void bufchain_prefix(bufchain *ch, void **data, int *len);
60 void bufchain_consume(bufchain *ch, int len);
61 void bufchain_fetch(bufchain *ch, void *data, int len);
63 int validate_manual_hostkey(char *key);
65 struct tm ltime(void);
67 /* Wipe sensitive data out of memory that's about to be freed. Simpler
68 * than memset because we don't need the fill char parameter; also
69 * attempts (by fiddly use of volatile) to inhibit the compiler from
70 * over-cleverly trying to optimise the memset away because it knows
71 * the variable is going out of scope. */
72 void smemclr(void *b, size_t len);
74 /* Compare two fixed-length chunks of memory for equality, without
75 * data-dependent control flow (so an attacker with a very accurate
76 * stopwatch can't try to guess where the first mismatching byte was).
77 * Returns 0 for mismatch or 1 for equality (unlike memcmp), hinted at
78 * by the 'eq' in the name. */
79 int smemeq(const void *av, const void *bv, size_t len);
81 /* Extracts an SSH-marshalled string from the start of *data. If
82 * successful (*datalen is not too small), advances data/datalen past
83 * the string and returns a pointer to the string itself and its
84 * length in *stringlen. Otherwise does nothing and returns NULL.
86 * Like strchr, this function can discard const from its parameter.
87 * Treat it as if it was a family of two functions, one returning a
88 * non-const string given a non-const pointer, and one taking and
90 void *get_ssh_string(int *datalen, const void **data, int *stringlen);
91 /* Extracts an SSH uint32, similarly. Returns TRUE on success, and
92 * leaves the extracted value in *ret. */
93 int get_ssh_uint32(int *datalen, const void **data, unsigned *ret);
94 /* Given a not-necessarily-zero-terminated string in (length,data)
95 * form, check if it equals an ordinary C zero-terminated string. */
96 int match_ssh_id(int stringlen, const void *string, const char *id);
99 * Debugging functions.
101 * Output goes to debug.log
103 * debug(()) (note the double brackets) is like printf().
105 * dmemdump() and dmemdumpl() both do memory dumps. The difference
106 * is that dmemdumpl() is more suited for when the memory address is
107 * important (say because you'll be recording pointer values later
108 * on). dmemdump() is more concise.
112 void debug_printf(char *fmt, ...);
113 void debug_memdump(void *buf, int len, int L);
114 #define debug(x) (debug_printf x)
115 #define dmemdump(buf,len) debug_memdump (buf, len, 0);
116 #define dmemdumpl(buf,len) debug_memdump (buf, len, 1);
119 #define dmemdump(buf,len)
120 #define dmemdumpl(buf,len)
124 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
128 #define min(x,y) ( (x) < (y) ? (x) : (y) )
131 #define max(x,y) ( (x) > (y) ? (x) : (y) )
134 #define GET_32BIT_LSB_FIRST(cp) \
135 (((unsigned long)(unsigned char)(cp)[0]) | \
136 ((unsigned long)(unsigned char)(cp)[1] << 8) | \
137 ((unsigned long)(unsigned char)(cp)[2] << 16) | \
138 ((unsigned long)(unsigned char)(cp)[3] << 24))
140 #define PUT_32BIT_LSB_FIRST(cp, value) ( \
141 (cp)[0] = (unsigned char)(value), \
142 (cp)[1] = (unsigned char)((value) >> 8), \
143 (cp)[2] = (unsigned char)((value) >> 16), \
144 (cp)[3] = (unsigned char)((value) >> 24) )
146 #define GET_16BIT_LSB_FIRST(cp) \
147 (((unsigned long)(unsigned char)(cp)[0]) | \
148 ((unsigned long)(unsigned char)(cp)[1] << 8))
150 #define PUT_16BIT_LSB_FIRST(cp, value) ( \
151 (cp)[0] = (unsigned char)(value), \
152 (cp)[1] = (unsigned char)((value) >> 8) )
154 #define GET_32BIT_MSB_FIRST(cp) \
155 (((unsigned long)(unsigned char)(cp)[0] << 24) | \
156 ((unsigned long)(unsigned char)(cp)[1] << 16) | \
157 ((unsigned long)(unsigned char)(cp)[2] << 8) | \
158 ((unsigned long)(unsigned char)(cp)[3]))
160 #define GET_32BIT(cp) GET_32BIT_MSB_FIRST(cp)
162 #define PUT_32BIT_MSB_FIRST(cp, value) ( \
163 (cp)[0] = (unsigned char)((value) >> 24), \
164 (cp)[1] = (unsigned char)((value) >> 16), \
165 (cp)[2] = (unsigned char)((value) >> 8), \
166 (cp)[3] = (unsigned char)(value) )
168 #define PUT_32BIT(cp, value) PUT_32BIT_MSB_FIRST(cp, value)
170 #define GET_16BIT_MSB_FIRST(cp) \
171 (((unsigned long)(unsigned char)(cp)[0] << 8) | \
172 ((unsigned long)(unsigned char)(cp)[1]))
174 #define PUT_16BIT_MSB_FIRST(cp, value) ( \
175 (cp)[0] = (unsigned char)((value) >> 8), \
176 (cp)[1] = (unsigned char)(value) )