misc.h

   1 /*
   2  * Header for misc.c.
   3  */
   4
   5 #ifndef PUTTY_MISC_H
   6 #define PUTTY_MISC_H
   7
   8 #include "puttymem.h"
   9
  10 #include <stdio.h>                     /* for FILE * */
  11 #include <stdarg.h>                    /* for va_list */
  12 #include <time.h>                      /* for struct tm */
  13
  14 #ifndef FALSE
  15 #define FALSE 0
  16 #endif
  17 #ifndef TRUE
  18 #define TRUE 1
  19 #endif
  20
  21 typedef struct Filename Filename;
  22 typedef struct FontSpec FontSpec;
  23
  24 unsigned long parse_blocksize(const char *bs);
  25 char ctrlparse(char *s, char **next);
  26
  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);
  31
  32 char *dupstr(const char *s);
  33 char *dupcat(const char *s1, ...);
  34 char *dupprintf(const char *fmt, ...)
  35 #ifdef __GNUC__
  36     __attribute__ ((format (printf, 1, 2)))
  37 #endif
  38     ;
  39 char *dupvprintf(const char *fmt, va_list ap);
  40 void burnstr(char *string);
  41
  42 /* String-to-Unicode converters that auto-allocate the destination and
  43  * work around the rather deficient interface of mb_to_wc.
  44  *
  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);
  50
  51 int toint(unsigned);
  52
  53 char *fgetline(FILE *fp);
  54 int strstartswith(const char *s, const char *t);
  55 int strendswith(const char *s, const char *t);
  56
  57 void base64_encode_atom(unsigned char *data, int n, char *out);
  58 int base64_decode_atom(char *atom, unsigned char *out);
  59
  60 struct bufchain_granule;
  61 typedef struct bufchain_tag {
  62     struct bufchain_granule *head, *tail;
  63     int buffersize;                    /* current amount of buffered data */
  64 } bufchain;
  65
  66 void bufchain_init(bufchain *ch);
  67 void bufchain_clear(bufchain *ch);
  68 int bufchain_size(bufchain *ch);
  69 void bufchain_add(bufchain *ch, const void *data, int len);
  70 void bufchain_prefix(bufchain *ch, void **data, int *len);
  71 void bufchain_consume(bufchain *ch, int len);
  72 void bufchain_fetch(bufchain *ch, void *data, int len);
  73
  74 int validate_manual_hostkey(char *key);
  75
  76 struct tm ltime(void);
  77
  78 /* Wipe sensitive data out of memory that's about to be freed. Simpler
  79  * than memset because we don't need the fill char parameter; also
  80  * attempts (by fiddly use of volatile) to inhibit the compiler from
  81  * over-cleverly trying to optimise the memset away because it knows
  82  * the variable is going out of scope. */
  83 void smemclr(void *b, size_t len);
  84
  85 /* Compare two fixed-length chunks of memory for equality, without
  86  * data-dependent control flow (so an attacker with a very accurate
  87  * stopwatch can't try to guess where the first mismatching byte was).
  88  * Returns 0 for mismatch or 1 for equality (unlike memcmp), hinted at
  89  * by the 'eq' in the name. */
  90 int smemeq(const void *av, const void *bv, size_t len);
  91
  92 /*
  93  * Debugging functions.
  94  *
  95  * Output goes to debug.log
  96  *
  97  * debug(()) (note the double brackets) is like printf().
  98  *
  99  * dmemdump() and dmemdumpl() both do memory dumps.  The difference
 100  * is that dmemdumpl() is more suited for when the memory address is
 101  * important (say because you'll be recording pointer values later
 102  * on).  dmemdump() is more concise.
 103  */
 104
 105 #ifdef DEBUG
 106 void debug_printf(char *fmt, ...);
 107 void debug_memdump(void *buf, int len, int L);
 108 #define debug(x) (debug_printf x)
 109 #define dmemdump(buf,len) debug_memdump (buf, len, 0);
 110 #define dmemdumpl(buf,len) debug_memdump (buf, len, 1);
 111 #else
 112 #define debug(x)
 113 #define dmemdump(buf,len)
 114 #define dmemdumpl(buf,len)
 115 #endif
 116
 117 #ifndef lenof
 118 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
 119 #endif
 120
 121 #ifndef min
 122 #define min(x,y) ( (x) < (y) ? (x) : (y) )
 123 #endif
 124 #ifndef max
 125 #define max(x,y) ( (x) > (y) ? (x) : (y) )
 126 #endif
 127
 128 #define GET_32BIT_LSB_FIRST(cp) \
 129   (((unsigned long)(unsigned char)(cp)[0]) | \
 130   ((unsigned long)(unsigned char)(cp)[1] << 8) | \
 131   ((unsigned long)(unsigned char)(cp)[2] << 16) | \
 132   ((unsigned long)(unsigned char)(cp)[3] << 24))
 133
 134 #define PUT_32BIT_LSB_FIRST(cp, value) ( \
 135   (cp)[0] = (unsigned char)(value), \
 136   (cp)[1] = (unsigned char)((value) >> 8), \
 137   (cp)[2] = (unsigned char)((value) >> 16), \
 138   (cp)[3] = (unsigned char)((value) >> 24) )
 139
 140 #define GET_16BIT_LSB_FIRST(cp) \
 141   (((unsigned long)(unsigned char)(cp)[0]) | \
 142   ((unsigned long)(unsigned char)(cp)[1] << 8))
 143
 144 #define PUT_16BIT_LSB_FIRST(cp, value) ( \
 145   (cp)[0] = (unsigned char)(value), \
 146   (cp)[1] = (unsigned char)((value) >> 8) )
 147
 148 #define GET_32BIT_MSB_FIRST(cp) \
 149   (((unsigned long)(unsigned char)(cp)[0] << 24) | \
 150   ((unsigned long)(unsigned char)(cp)[1] << 16) | \
 151   ((unsigned long)(unsigned char)(cp)[2] << 8) | \
 152   ((unsigned long)(unsigned char)(cp)[3]))
 153
 154 #define GET_32BIT(cp) GET_32BIT_MSB_FIRST(cp)
 155
 156 #define PUT_32BIT_MSB_FIRST(cp, value) ( \
 157   (cp)[0] = (unsigned char)((value) >> 24), \
 158   (cp)[1] = (unsigned char)((value) >> 16), \
 159   (cp)[2] = (unsigned char)((value) >> 8), \
 160   (cp)[3] = (unsigned char)(value) )
 161
 162 #define PUT_32BIT(cp, value) PUT_32BIT_MSB_FIRST(cp, value)
 163
 164 #define GET_16BIT_MSB_FIRST(cp) \
 165   (((unsigned long)(unsigned char)(cp)[0] << 8) | \
 166   ((unsigned long)(unsigned char)(cp)[1]))
 167
 168 #define PUT_16BIT_MSB_FIRST(cp, value) ( \
 169   (cp)[0] = (unsigned char)((value) >> 8), \
 170   (cp)[1] = (unsigned char)(value) )
 171
 172 #endif