hbytes/hbytes.h

   1 /*
   2  */
   3 /*
   4  *  hbytes raw2h BINARY                          => hex
   5  *  hbytes h2raw HEX                             => binary
   6  *
   7  *  hbytes length VALUE                          => count
   8  *  hbytes prepend VAR [VALUE ...]         = set VAR [concat VALUE ... $VAR]
   9  *  hbytes append VAR [VALUE ...]          = set VAR [concat $VAR VALUE ...]
  10  *  hbytes concat VAR [VALUE ...]          = set VAR [concat VALUE ...]
  11  *  hbytes unprepend VAR PREFIXLENGTH            => prefix (removed from VAR)
  12  *  hbytes unappend VAR SUFFIXLENGTH             => suffix (removed from VAR)
  13  *  hbytes chopto VAR NEWVARLENGTH               => suffix (removed from VAR)
  14  *                                                  (too short? error)
  15  *
  16  *  hbytes range VALUE START SIZE                => substring (or error)
  17  *  hbytes overwrite VAR START VALUE
  18  *  hbytes trimleft VAR                         removes any leading 0 octets
  19  *  hbytes repeat VALUE COUNT                    => COUNT copies of VALUE
  20  *  hbytes zeroes COUNT                          => COUNT zero bytes
  21  *  hbytes random COUNT                          => COUNT random bytes
  22  *  hbytes xor VAR VALUE                         $VAR (+)= VALUE
  23  *
  24  *  hbytes ushort2h LONG           => LONG must be <2^16, returns as hex
  25  *  hbytes h2ushort HEX            => |HEX| must be 2 bytes, returns as ulong
  26  *
  27  *  hbytes compare A B
  28  *      =>  -2   A is lexically earlier than B and not a prefix of B  (A<B)
  29  *          -1   A is prefix of B but not equal                       (A<B)
  30  *           0   A == B
  31  *          +1   A is B plus a nonempty suffix (ie, A has B as a prefix)
  32  *          +2   A is lexically later than B and does not have B as a prefix
  33  *
  34  *  hbytes pad pa|ua VAR ALG METH [METHARGS]       => worked? (always 1 for p)
  35  *  hbytes pad pn|un VAR BS METH [METHARGS]        => worked? (always 1 for p)
  36  *  hbytes pad pa|pn VAR ALG|BS pkcs5              => 1
  37  *  hbytes pad ua|un VAR ALG|BS pkcs5              => worked?
  38  *  hbytes pad pa|pn VAR ALG|BS rfc2406 NXTHDR     => 1
  39  *  hbytes pad ua|un VAR ALG|BS rfc2406 NXTHDRVAR  => worked?
  40  *
  41  *  hbytes blockcipher d|e VAR ALG KEY MODE [IV] => IV
  42  *  hbytes blockcipher mac MSG ALG KEY MODE IV   => final block
  43  *  hbytes blockcipher prop PROPERTY ALG         => property value
  44  *
  45  *  hbytes hash ALG MESSAGE                      => hash
  46  *  hbytes hmac ALG MESSAGE KEY [MACLENGTH]      => mac
  47  *  hbytes hash-prop PROPERTY ALG                => property value
  48  *
  49  *  ulong ul2int ULONG    => INT           can fail if >INT_MAX
  50  *  ulong int2ul INT      => ULONG         can fail if <0
  51  *  ulong mask A B                         => A & B
  52  *  ulong add A B                          => A + B  (mod 2^32)
  53  *  ulong subtract A B                     => A - B  (mod 2^32)
  54  *  ulong compare A B                      => 0  -1 (A<B)  +1 (A>B)
  55  *  ulong shift l|r ULONG BITS             fails if BITS >32
  56  *
  57  *  ulong ul2bitfields VALUE [SIZE TYPE [TYPE-ARG...] ...]  => 0/1
  58  *  ulong bitfields2ul BASE  [SIZE TYPE [TYPE-ARG...] ...]  => ULONG
  59  *      goes from left (MSbit) to right (LSbit) where
  60  *            SIZE is size in bits
  61  *            TYPE [TYPE-ARGS...] is as below
  62  *               zero
  63  *               ignore
  64  *               fixed ULONG-VALUE
  65  *               uint VARNAME/VALUE         (VARNAME if ul2bitfields;
  66  *               ulong VARNAME/VALUE         VALUE if bitfields2ul)
  67  *
  68  *  hbytes mask-map lookup MAP-VAR ADDRESS [DEFAULT]   => DATA
  69  *     error on missing default or if any prefix longer than address
  70  *  hbytes mask-map amend MAP-VAR PREFIX PREFIX-LENGTH DATA
  71  *     a maskmap MAP is [list [list PREFIX PREFIX-LENGTH DATA]] sorted
  72  *     first by descending PREFIX-LENGTH and then by ascending PREFIX
  73  *     each PREFIX _in the map_ is truncated to the shortest number of
  74  *     pairs of hex digits which can represent it
  75  *
  76  * Error codes
  77  *
  78  * HBYTES BLOCKCIPHER CRYPTFAIL CRYPT  block cipher mode failed somehow (!)
  79  * HBYTES BLOCKCIPHER CRYPTFAIL MAC    HMAC failed somehow (!)
  80  * HBYTES BLOCKCIPHER LENGTH           block cipher input has unsuitable length
  81  * HBYTES BLOCKCIPHER PARAMS           key or iv not suitable
  82  * HBYTES HMAC PARAMS                  key, input or output size not suitable
  83  * HBYTES LENGTH OVERRUN               block too long
  84  * HBYTES LENGTH RANGE                 input length or offset is -ve or silly
  85  * HBYTES LENGTH UNDERRUN              block too short (or offset too big)
  86  * HBYTES LENGTH MISMATCH              when blocks must be exactly same length
  87  * HBYTES SYNTAX                       supposed hex block had wrong syntax
  88  * HBYTES VALUE OVERFLOW               value to be conv'd to hex too big/long
  89  * HBYTES MASKMAP NOMATCH              no addr/mask matches address for lookup
  90  * HBYTES MASKMAP UNDERRUN             addr value for lookup is too short
  91  * HBYTES MASKMAP SYNTAX LLENGTH       value for mask-map entry not llength==3
  92  * HBYTES MASKMAP SYNTAX UNDERRUN      value for mask-map entry hex too short
  93  * HBYTES MASKMAP SYNTAX OVERRUN       actual mask-map entry hex too short
  94  * HBYTES MASKMAP SYNTAX ORDER         actual mask-map is disordered
  95  * HBYTES MASKMAP SYNTAX EXCLBITS      mask-map has 1-bits outside prefix len
  96  * SOCKADDR AFUNIX LENGTH              path for AF_UNIX socket too long
  97  * SOCKADDR SYNTAX IPV4                bad IPv4 socket address &/or port
  98  * SOCKADDR SYNTAX OTHER               bad socket addr, couldn't tell what kind
  99  * ULONG BITCOUNT NEGATIVE             -ve bitcount specified where not allowed
 100  * ULONG BITCOUNT OVERRUN              attempt to use more than 32 bits
 101  * ULONG BITCOUNT UNDERRUN             bitfields add up to less than 32
 102  * ULONG VALUE NEGATIVE                attempt convert -ve integers to ulong
 103  * ULONG VALUE OVERFLOW                converted value does not fit in result
 104  * TUNTAP IFNAME LENGTH                tun/tap interface name too long
 105  * TUNTAP MTU OVERRUN                  tun/tap mtu limited to 2^16 bytes
 106  *
 107  * Refs: HMAC: RFC2104
 108  */
 109
 110 #ifndef HBYTES_H
 111 #define HBYTES_H
 112
 113 #include <assert.h>
 114 #include <stdlib.h>
 115 #include <errno.h>
 116 #include <unistd.h>
 117 #include <fcntl.h>
 118 #include <sys/socket.h>
 119 #include <sys/uio.h>
 120 #include <sys/un.h>
 121 #include <arpa/inet.h>
 122
 123 #include <tcl8.3/tcl.h>
 124
 125 typedef unsigned char Byte;
 126
 127 /* from hbytes.c */
 128
 129 int Hbytes_Init(Tcl_Interp *ip); /* called by Tcl's "load" */
 130
 131 /* Internal representation details: */
 132 #define HBYTES_ISEMPTY(hb)    (!(hb)->begin_complex && !(hb)->end_0)
 133 #define HBYTES_ISSENTINEL(hb) (!(hb)->begin_complex && (hb)->end_0)
 134 #define HBYTES_ISSIMPLE(hb)   ((hb)->begin_complex && (hb)->end_0)
 135 #define HBYTES_ISCOMPLEX(hb)  ((hb)->begin_complex && !(hb)->end_0)
 136
 137 typedef struct {
 138   void *begin_complex, *end_0;
 139 } HBytes_Value; /* overlays internalRep */
 140
 141 typedef struct {
 142   Byte *dstart; /* always allocated dynamically */
 143   int prespace, len, avail;
 144   /*
 145    * | SPARE      | USED  | SPARE |
 146    * |<-prespace->|<-len->|       |
 147    * |            |<----avail---->|
 148    *              ^start
 149    */
 150 } HBytes_ComplexValue; /* pointed to from internalRep.otherValuePtr */
 151
 152 /* Public interfaces: */
 153
 154 extern Tcl_ObjType hbytes_type;
 155
 156 int hbytes_len(const HBytes_Value *v);
 157 Byte *hbytes_data(const HBytes_Value *v); /* caller may then modify data! */
 158 int hbytes_issentinel(const HBytes_Value *v);
 159
 160 Byte *hbytes_prepend(HBytes_Value *upd, int el);
 161 Byte *hbytes_append(HBytes_Value *upd, int el);
 162   /* return value is where to put the data */
 163
 164 const Byte *hbytes_unprepend(HBytes_Value *upd, int rl);
 165 const Byte *hbytes_unappend(HBytes_Value *upd, int rl);
 166   /* return value points to the removed data, which remains valid
 167    * until next op on the HBytes_Value.  If original value is
 168    * shorter than rl or negative, returns 0 and does nothing. */
 169
 170 void hbytes_empty(HBytes_Value *returns);
 171 void hbytes_sentinel(HBytes_Value *returns);
 172 void hbytes_array(HBytes_Value *returns, const Byte *array, int l);
 173 Byte *hbytes_arrayspace(HBytes_Value *returns, int l);
 174 void hbytes_free(const HBytes_Value *frees);
 175   /* _empty, _sentinel and _array do not free or read the old value;
 176    * _free it first if needed.  _free leaves it garbage, so you
 177    * have to call _empty to reuse it.  _arrayspace doesn't fill
 178    * the array; you get a pointer and must fill it with data
 179    * yourself. */
 180
 181 /* The value made by hbytes_sentinel should not be passed to
 182  * anything except HBYTES_IS..., and hbytes_free. */
 183
 184 /* from sockaddr.c */
 185
 186 typedef struct {
 187   Byte *begin, *end;
 188 } SockAddr_Value;
 189
 190 extern Tcl_ObjType sockaddr_type;
 191
 192 void sockaddr_clear(SockAddr_Value*);
 193 void sockaddr_create(SockAddr_Value*, const struct sockaddr *addr, int len);
 194 int sockaddr_len(const SockAddr_Value*);
 195 const struct sockaddr *sockaddr_addr(const SockAddr_Value*);
 196 void sockaddr_free(const SockAddr_Value*);
 197
 198 /* from scriptinv.c */
 199
 200 typedef struct { /* semi-opaque - read only, and then only where commented */
 201   Tcl_Interp *ip; /* valid, non-0 and useable if set */
 202   Tcl_Obj *obj; /* non-0 iff set (but only test for 0/non-0) */
 203   int llength;
 204 } ScriptToInvoke;
 205
 206 void scriptinv_init(ScriptToInvoke *si);
 207 int scriptinv_set(ScriptToInvoke *si, Tcl_Interp *ip, Tcl_Obj *newscript);
 208 void scriptinv_cancel(ScriptToInvoke *si); /* then don't invoke */
 209   /* no separate free function - just cancel */
 210
 211 void scriptinv_invoke(ScriptToInvoke *si, int argc, Tcl_Obj **argv);
 212
 213 /* from idtable.c */
 214
 215 typedef struct {
 216   const char *const prefix;
 217   int n;
 218   void **a;
 219 } IdDataTable;
 220
 221 extern Tcl_ObjType tabledataid_nearlytype;
 222 int tabledataid_parse(Tcl_Interp *ip, Tcl_Obj *o, IdDataTable *tab);
 223
 224 /* from dgram.c */
 225
 226 extern IdDataTable dgram_socks;
 227 int newfdposixerr(Tcl_Interp *ip, int fd, const char *m);
 228
 229 /* from tuntap.c */
 230
 231 extern IdDataTable tuntap_socks;
 232
 233 /* from hook.c */
 234
 235 int staticerr(Tcl_Interp *ip, const char *m, const char *ec);
 236 int posixerr(Tcl_Interp *ip, int errnoval, const char *m);
 237 void objfreeir(Tcl_Obj *o);
 238 int get_urandom(Tcl_Interp *ip, Byte *buffer, int l);
 239
 240 void obj_updatestr_array(Tcl_Obj *o, const Byte *array, int l);
 241 void obj_updatestr_array_prefix(Tcl_Obj *o, const Byte *byte,
 242                                 int l, const char *prefix);
 243
 244 void obj_updatestr_vstringls(Tcl_Obj *o, ...);
 245   /* const char*, int, const char*, int, ..., (const char*)0 */
 246 void obj_updatestr_string_len(Tcl_Obj *o, const char *str, int l);
 247 void obj_updatestr_string(Tcl_Obj *o, const char *str);
 248
 249 /* from parse.c */
 250
 251 typedef struct {
 252   Tcl_Obj *obj, *var;
 253   int copied;
 254 } Something_Var;
 255
 256 void init_somethingv(Something_Var *sth);
 257 void fini_somethingv(Tcl_Interp *ip, int rc, Something_Var *sth);
 258 int pat_somethingv(Tcl_Interp *ip, Tcl_Obj *var,
 259                    Something_Var *sth, Tcl_ObjType *type);
 260
 261 typedef struct {
 262   HBytes_Value *hb;
 263   Something_Var sth;
 264 } HBytes_Var;
 265
 266 /* from maskmap.c */
 267
 268 typedef struct MaskMap_Value MaskMap_Value;
 269
 270 typedef struct {
 271   MaskMap_Value *mm;
 272   Something_Var sth;
 273 } MaskMap_Var;
 274
 275 extern Tcl_ObjType maskmap_type;
 276
 277 /* from chop.c */
 278   /* only do_... functions declared in tables.h */
 279
 280 /* from ulong.c */
 281
 282 Tcl_ObjType ulong_type;
 283
 284 /* from enum.c */
 285
 286 extern Tcl_ObjType enum_nearlytype;
 287 extern Tcl_ObjType enum1_nearlytype;
 288
 289 const void *enum_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
 290                                     const void *firstentry, size_t entrysize,
 291                                     const char *what);
 292 #define enum_lookup_cached(ip,o,table,what)                     \
 293     (enum_lookup_cached_func((ip),(o),                          \
 294                              &(table)[0],sizeof((table)[0]),    \
 295                              (what)))
 296   /* table should be a pointer to an array of structs of size
 297    * entrysize, the first member of which should be a const char*.
 298    * The table should finish with a null const char *.
 299    * On error, 0 is returned and the ip->result will have been
 300    * set to the error message.
 301    */
 302
 303 int enum1_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
 304                              const char *opts, const char *what);
 305   /* -1 => error */
 306
 307 /* from crypto.c */
 308
 309 void memxor(Byte *dest, const Byte *src, int l);
 310
 311 typedef struct {
 312   const char *name;
 313   int pad, use_algname;
 314 } PadOp;
 315
 316 extern Tcl_ObjType blockcipherkey_type;
 317
 318 /* from algtables.c */
 319
 320 typedef struct {
 321   const char *name;
 322   int int_offset;
 323 } BlockCipherPropInfo, HashAlgPropInfo;
 324
 325 typedef struct {
 326   const char *name;
 327   int hashsize, blocksize, statesize;
 328   void (*init)(void *state);
 329   void (*update)(void *state, const void *data, int len);
 330   void (*final)(void *state, void *digest);
 331   void (*oneshot)(void *digest, const void *data, int len);
 332 } HashAlgInfo;
 333
 334 extern const HashAlgInfo hashalginfos[];
 335
 336 typedef struct {
 337   void (*make_schedule)(void *schedule, const void *key, int keylen);
 338   void (*crypt)(const void *schedule, const void *in, void *out);
 339      /* in and out may be the same, but if they aren't they may not overlap */
 340      /* in and out for crypt will have been through block_byteswap */
 341 } BlockCipherPerDirectionInfo;
 342
 343 typedef struct {
 344   const char *name;
 345   int blocksize, schedule_size, key_min, key_max;
 346   BlockCipherPerDirectionInfo encrypt, decrypt;
 347 } BlockCipherAlgInfo;
 348
 349 extern const BlockCipherAlgInfo blockcipheralginfos[];
 350
 351 /* from bcmode.c */
 352
 353 typedef struct {
 354   const char *name;
 355   int iv_blocks, buf_blocks, mac_blocks;
 356
 357   /* Each function is allowed to use up to buf_blocks * blocksize
 358    * bytes of space in buf.  data is blocks * blocksize bytes
 359    * long.  data should be modified in place by encrypt and decrypt;
 360    * modes may not change the size of data.  iv is always provided and
 361    * is always of length iv_blocks * blocksize; encrypt and
 362    * decrypt may modify the iv value (in which case the Tcl caller
 363    * will get the modified IV) but this is not recommended.  mac
 364    * should leave the mac, which must be mac_blocks * blocksize
 365    * bytes, in buf.  (Therefore mac_blocks must be at least
 366    * buf_blocks.)
 367    */
 368   const char *(*encrypt)(Byte *data, int nblocks,
 369                          const Byte *iv, Byte *buf,
 370                          const BlockCipherAlgInfo *alg, int encr,
 371                          const void *sch);
 372   const char *(*decrypt)(Byte *data, int nblocks,
 373                          const Byte *iv, Byte *buf,
 374                          const BlockCipherAlgInfo *alg, int encr,
 375                          const void *sch);
 376   const char *(*mac)(const Byte *data, int nblocks,
 377                      const Byte *iv, Byte *buf,
 378                      const BlockCipherAlgInfo *alg,
 379                      const void *sch);
 380 } BlockCipherModeInfo;
 381
 382 extern const BlockCipherModeInfo blockciphermodeinfos[];
 383
 384 /* from misc.c */
 385
 386 int setnonblock(int fd, int isnonblock);
 387
 388 /* useful macros */
 389
 390 #define OBJ_HBYTES(o) ((HBytes_Value*)&(o)->internalRep.twoPtrValue)
 391 #define OBJ_SOCKADDR(o) ((SockAddr_Value*)&(o)->internalRep.twoPtrValue)
 392
 393 #define TALLOC(s) ((void*)Tcl_Alloc((s)))
 394 #define TFREE(f) (Tcl_Free((void*)(f)))
 395 #define TREALLOC(p,l) ((void*)Tcl_Realloc((void*)(p),(l)))
 396
 397 #endif /*HBYTES_H*/