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 int toint(unsigned);
  43
  44 char *fgetline(FILE *fp);
  45
  46 void base64_encode_atom(unsigned char *data, int n, char *out);
  47 int base64_decode_atom(char *atom, unsigned char *out);
  48
  49 struct bufchain_granule;
  50 typedef struct bufchain_tag {
  51     struct bufchain_granule *head, *tail;
  52     int buffersize;                    /* current amount of buffered data */
  53 } bufchain;
  54
  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);
  62
  63 int validate_manual_hostkey(char *key);
  64
  65 struct tm ltime(void);
  66
  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);
  73
  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);
  80
  81 /*
  82  * Debugging functions.
  83  *
  84  * Output goes to debug.log
  85  *
  86  * debug(()) (note the double brackets) is like printf().
  87  *
  88  * dmemdump() and dmemdumpl() both do memory dumps.  The difference
  89  * is that dmemdumpl() is more suited for when the memory address is
  90  * important (say because you'll be recording pointer values later
  91  * on).  dmemdump() is more concise.
  92  */
  93
  94 #ifdef DEBUG
  95 void debug_printf(char *fmt, ...);
  96 void debug_memdump(void *buf, int len, int L);
  97 #define debug(x) (debug_printf x)
  98 #define dmemdump(buf,len) debug_memdump (buf, len, 0);
  99 #define dmemdumpl(buf,len) debug_memdump (buf, len, 1);
 100 #else
 101 #define debug(x)
 102 #define dmemdump(buf,len)
 103 #define dmemdumpl(buf,len)
 104 #endif
 105
 106 #ifndef lenof
 107 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
 108 #endif
 109
 110 #ifndef min
 111 #define min(x,y) ( (x) < (y) ? (x) : (y) )
 112 #endif
 113 #ifndef max
 114 #define max(x,y) ( (x) > (y) ? (x) : (y) )
 115 #endif
 116
 117 #define GET_32BIT_LSB_FIRST(cp) \
 118   (((unsigned long)(unsigned char)(cp)[0]) | \
 119   ((unsigned long)(unsigned char)(cp)[1] << 8) | \
 120   ((unsigned long)(unsigned char)(cp)[2] << 16) | \
 121   ((unsigned long)(unsigned char)(cp)[3] << 24))
 122
 123 #define PUT_32BIT_LSB_FIRST(cp, value) ( \
 124   (cp)[0] = (unsigned char)(value), \
 125   (cp)[1] = (unsigned char)((value) >> 8), \
 126   (cp)[2] = (unsigned char)((value) >> 16), \
 127   (cp)[3] = (unsigned char)((value) >> 24) )
 128
 129 #define GET_16BIT_LSB_FIRST(cp) \
 130   (((unsigned long)(unsigned char)(cp)[0]) | \
 131   ((unsigned long)(unsigned char)(cp)[1] << 8))
 132
 133 #define PUT_16BIT_LSB_FIRST(cp, value) ( \
 134   (cp)[0] = (unsigned char)(value), \
 135   (cp)[1] = (unsigned char)((value) >> 8) )
 136
 137 #define GET_32BIT_MSB_FIRST(cp) \
 138   (((unsigned long)(unsigned char)(cp)[0] << 24) | \
 139   ((unsigned long)(unsigned char)(cp)[1] << 16) | \
 140   ((unsigned long)(unsigned char)(cp)[2] << 8) | \
 141   ((unsigned long)(unsigned char)(cp)[3]))
 142
 143 #define GET_32BIT(cp) GET_32BIT_MSB_FIRST(cp)
 144
 145 #define PUT_32BIT_MSB_FIRST(cp, value) ( \
 146   (cp)[0] = (unsigned char)((value) >> 24), \
 147   (cp)[1] = (unsigned char)((value) >> 16), \
 148   (cp)[2] = (unsigned char)((value) >> 8), \
 149   (cp)[3] = (unsigned char)(value) )
 150
 151 #define PUT_32BIT(cp, value) PUT_32BIT_MSB_FIRST(cp, value)
 152
 153 #define GET_16BIT_MSB_FIRST(cp) \
 154   (((unsigned long)(unsigned char)(cp)[0] << 8) | \
 155   ((unsigned long)(unsigned char)(cp)[1]))
 156
 157 #define PUT_16BIT_MSB_FIRST(cp, value) ( \
 158   (cp)[0] = (unsigned char)((value) >> 8), \
 159   (cp)[1] = (unsigned char)(value) )
 160
 161 #endif