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 address too short
  70  *  hbytes mask-map amend MAP-VAR PREFIX PREFIX-LENGTH DATA
  71  *     a maskmap MAP is [list [list PREFIX PREFIX-LENGTH DATA]]
  72  *     sorted first by descending PREFIX-LENGTH and then by PREFIX
  73  *     each PREFIX is truncated to the shortest number of pairs of
  74  *     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  * SOCKADDR AFUNIX LENGTH              path for AF_UNIX socket too long
  90  * SOCKADDR SYNTAX IPV4                bad IPv4 socket address &/or port
  91  * SOCKADDR SYNTAX OTHER               bad socket addr, couldn't tell what kind
  92  * ULONG BITCOUNT NEGATIVE             -ve bitcount specified where not allowed
  93  * ULONG BITCOUNT OVERRUN              attempt to use more than 32 bits
  94  * ULONG BITCOUNT UNDERRUN             bitfields add up to less than 32
  95  * ULONG VALUE NEGATIVE                attempt convert -ve integers to ulong
  96  * ULONG VALUE OVERFLOW                converted value does not fit in result
  97  * TUNTAP IFNAME LENGTH                tun/tap interface name too long
  98  * TUNTAP MTU OVERRUN                  tun/tap mtu limited to 2^16 bytes
  99  *
 100  * Refs: HMAC: RFC2104
 101  */
 102
 103 #ifndef HBYTES_H
 104 #define HBYTES_H
 105
 106 #include <assert.h>
 107 #include <stdlib.h>
 108 #include <errno.h>
 109 #include <unistd.h>
 110 #include <fcntl.h>
 111 #include <sys/socket.h>
 112 #include <sys/uio.h>
 113 #include <sys/un.h>
 114 #include <arpa/inet.h>
 115
 116 #include <tcl8.3/tcl.h>
 117
 118 typedef unsigned char Byte;
 119
 120 /* from hbytes.c */
 121
 122 int Hbytes_Init(Tcl_Interp *ip); /* called by Tcl's "load" */
 123
 124 /* Internal representation details: */
 125 #define HBYTES_ISEMPTY(hb)    (!(hb)->begin_complex && !(hb)->end_0)
 126 #define HBYTES_ISSENTINEL(hb) (!(hb)->begin_complex && (hb)->end_0)
 127 #define HBYTES_ISSIMPLE(hb)   ((hb)->begin_complex && (hb)->end_0)
 128 #define HBYTES_ISCOMPLEX(hb)  ((hb)->begin_complex && !(hb)->end_0)
 129
 130 typedef struct {
 131   void *begin_complex, *end_0;
 132 } HBytes_Value; /* overlays internalRep */
 133
 134 typedef struct {
 135   Byte *dstart; /* always allocated dynamically */
 136   int prespace, len, avail;
 137   /*
 138    * | SPARE      | USED  | SPARE |
 139    * |<-prespace->|<-len->|       |
 140    * |            |<----avail---->|
 141    *              ^start
 142    */
 143 } HBytes_ComplexValue; /* pointed to from internalRep.otherValuePtr */
 144
 145 /* Public interfaces: */
 146
 147 extern Tcl_ObjType hbytes_type;
 148
 149 int hbytes_len(const HBytes_Value *v);
 150 Byte *hbytes_data(const HBytes_Value *v); /* caller may then modify data! */
 151 int hbytes_issentinel(const HBytes_Value *v);
 152
 153 Byte *hbytes_prepend(HBytes_Value *upd, int el);
 154 Byte *hbytes_append(HBytes_Value *upd, int el);
 155   /* return value is where to put the data */
 156
 157 const Byte *hbytes_unprepend(HBytes_Value *upd, int rl);
 158 const Byte *hbytes_unappend(HBytes_Value *upd, int rl);
 159   /* return value points to the removed data, which remains valid
 160    * until next op on the HBytes_Value.  If original value is
 161    * shorter than rl or negative, returns 0 and does nothing. */
 162
 163 void hbytes_empty(HBytes_Value *returns);
 164 void hbytes_sentinel(HBytes_Value *returns);
 165 void hbytes_array(HBytes_Value *returns, const Byte *array, int l);
 166 Byte *hbytes_arrayspace(HBytes_Value *returns, int l);
 167 void hbytes_free(const HBytes_Value *frees);
 168   /* _empty, _sentinel and _array do not free or read the old value;
 169    * _free it first if needed.  _free leaves it garbage, so you
 170    * have to call _empty to reuse it.  _arrayspace doesn't fill
 171    * the array; you get a pointer and must fill it with data
 172    * yourself. */
 173
 174 /* The value made by hbytes_sentinel should not be passed to
 175  * anything except HBYTES_IS..., and hbytes_free. */
 176
 177 /* from sockaddr.c */
 178
 179 typedef struct {
 180   Byte *begin, *end;
 181 } SockAddr_Value;
 182
 183 extern Tcl_ObjType sockaddr_type;
 184
 185 void sockaddr_clear(SockAddr_Value*);
 186 void sockaddr_create(SockAddr_Value*, const struct sockaddr *addr, int len);
 187 int sockaddr_len(const SockAddr_Value*);
 188 const struct sockaddr *sockaddr_addr(const SockAddr_Value*);
 189 void sockaddr_free(const SockAddr_Value*);
 190
 191 /* from scriptinv.c */
 192
 193 typedef struct { /* semi-opaque - read only, and then only where commented */
 194   Tcl_Interp *ip; /* valid, non-0 and useable if set */
 195   Tcl_Obj *obj; /* non-0 iff set (but only test for 0/non-0) */
 196   int llength;
 197 } ScriptToInvoke;
 198
 199 void scriptinv_init(ScriptToInvoke *si);
 200 int scriptinv_set(ScriptToInvoke *si, Tcl_Interp *ip, Tcl_Obj *newscript);
 201 void scriptinv_cancel(ScriptToInvoke *si); /* then don't invoke */
 202   /* no separate free function - just cancel */
 203
 204 void scriptinv_invoke(ScriptToInvoke *si, int argc, Tcl_Obj **argv);
 205
 206 /* from idtable.c */
 207
 208 typedef struct {
 209   const char *const prefix;
 210   int n;
 211   void **a;
 212 } IdDataTable;
 213
 214 extern Tcl_ObjType tabledataid_nearlytype;
 215 int tabledataid_parse(Tcl_Interp *ip, Tcl_Obj *o, IdDataTable *tab);
 216
 217 /* from dgram.c */
 218
 219 extern IdDataTable dgram_socks;
 220 int newfdposixerr(Tcl_Interp *ip, int fd, const char *m);
 221
 222 /* from tuntap.c */
 223
 224 extern IdDataTable tuntap_socks;
 225
 226 /* from hook.c */
 227
 228 int staticerr(Tcl_Interp *ip, const char *m, const char *ec);
 229 int posixerr(Tcl_Interp *ip, int errnoval, const char *m);
 230 void objfreeir(Tcl_Obj *o);
 231 int get_urandom(Tcl_Interp *ip, Byte *buffer, int l);
 232
 233 void obj_updatestr_array(Tcl_Obj *o, const Byte *array, int l);
 234 void obj_updatestr_array_prefix(Tcl_Obj *o, const Byte *byte,
 235                                 int l, const char *prefix);
 236
 237 void obj_updatestr_vstringls(Tcl_Obj *o, ...);
 238   /* const char*, int, const char*, int, ..., (const char*)0 */
 239 void obj_updatestr_string_len(Tcl_Obj *o, const char *str, int l);
 240 void obj_updatestr_string(Tcl_Obj *o, const char *str);
 241
 242 /* from parse.c */
 243
 244 typedef struct {
 245   Tcl_Obj *obj, *var;
 246   int copied;
 247 } Something_Var;
 248
 249 void init_somethingv(Something_Var *sth);
 250 void fini_somethingv(Tcl_Interp *ip, int rc, Something_Var *sth);
 251 int pat_somethingv(Tcl_Interp *ip, Tcl_Obj *var,
 252                    Something_Var *sth, Tcl_ObjType *type);
 253
 254 typedef struct {
 255   HBytes_Value *hb;
 256   Something_Var sth;
 257 } HBytes_Var;
 258
 259 /* from maskmap.c */
 260
 261 typedef struct MaskMap_Value MaskMap_Value;
 262
 263 typedef struct {
 264   MaskMap_Value *mm;
 265   Something_Var sth;
 266 } MaskMap_Var;
 267
 268 extern Tcl_ObjType maskmap_type;
 269
 270 /* from chop.c */
 271   /* only do_... functions declared in tables.h */
 272
 273 /* from ulong.c */
 274
 275 Tcl_ObjType ulong_type;
 276
 277 /* from enum.c */
 278
 279 extern Tcl_ObjType enum_nearlytype;
 280 extern Tcl_ObjType enum1_nearlytype;
 281
 282 const void *enum_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
 283                                     const void *firstentry, size_t entrysize,
 284                                     const char *what);
 285 #define enum_lookup_cached(ip,o,table,what)                     \
 286     (enum_lookup_cached_func((ip),(o),                          \
 287                              &(table)[0],sizeof((table)[0]),    \
 288                              (what)))
 289   /* table should be a pointer to an array of structs of size
 290    * entrysize, the first member of which should be a const char*.
 291    * The table should finish with a null const char *.
 292    * On error, 0 is returned and the ip->result will have been
 293    * set to the error message.
 294    */
 295
 296 int enum1_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
 297                              const char *opts, const char *what);
 298   /* -1 => error */
 299
 300 /* from crypto.c */
 301
 302 void memxor(Byte *dest, const Byte *src, int l);
 303
 304 typedef struct {
 305   const char *name;
 306   int pad, use_algname;
 307 } PadOp;
 308
 309 extern Tcl_ObjType blockcipherkey_type;
 310
 311 /* from algtables.c */
 312
 313 typedef struct {
 314   const char *name;
 315   int int_offset;
 316 } BlockCipherPropInfo, HashAlgPropInfo;
 317
 318 typedef struct {
 319   const char *name;
 320   int hashsize, blocksize, statesize;
 321   void (*init)(void *state);
 322   void (*update)(void *state, const void *data, int len);
 323   void (*final)(void *state, void *digest);
 324   void (*oneshot)(void *digest, const void *data, int len);
 325 } HashAlgInfo;
 326
 327 extern const HashAlgInfo hashalginfos[];
 328
 329 typedef struct {
 330   void (*make_schedule)(void *schedule, const void *key, int keylen);
 331   void (*crypt)(const void *schedule, const void *in, void *out);
 332      /* in and out may be the same, but if they aren't they may not overlap */
 333      /* in and out for crypt will have been through block_byteswap */
 334 } BlockCipherPerDirectionInfo;
 335
 336 typedef struct {
 337   const char *name;
 338   int blocksize, schedule_size, key_min, key_max;
 339   BlockCipherPerDirectionInfo encrypt, decrypt;
 340 } BlockCipherAlgInfo;
 341
 342 extern const BlockCipherAlgInfo blockcipheralginfos[];
 343
 344 /* from bcmode.c */
 345
 346 typedef struct {
 347   const char *name;
 348   int iv_blocks, buf_blocks, mac_blocks;
 349
 350   /* Each function is allowed to use up to buf_blocks * blocksize
 351    * bytes of space in buf.  data is blocks * blocksize bytes
 352    * long.  data should be modified in place by encrypt and decrypt;
 353    * modes may not change the size of data.  iv is always provided and
 354    * is always of length iv_blocks * blocksize; encrypt and
 355    * decrypt may modify the iv value (in which case the Tcl caller
 356    * will get the modified IV) but this is not recommended.  mac
 357    * should leave the mac, which must be mac_blocks * blocksize
 358    * bytes, in buf.  (Therefore mac_blocks must be at least
 359    * buf_blocks.)
 360    */
 361   const char *(*encrypt)(Byte *data, int nblocks,
 362                          const Byte *iv, Byte *buf,
 363                          const BlockCipherAlgInfo *alg, int encr,
 364                          const void *sch);
 365   const char *(*decrypt)(Byte *data, int nblocks,
 366                          const Byte *iv, Byte *buf,
 367                          const BlockCipherAlgInfo *alg, int encr,
 368                          const void *sch);
 369   const char *(*mac)(const Byte *data, int nblocks,
 370                      const Byte *iv, Byte *buf,
 371                      const BlockCipherAlgInfo *alg,
 372                      const void *sch);
 373 } BlockCipherModeInfo;
 374
 375 extern const BlockCipherModeInfo blockciphermodeinfos[];
 376
 377 /* from misc.c */
 378
 379 int setnonblock(int fd, int isnonblock);
 380
 381 /* useful macros */
 382
 383 #define OBJ_HBYTES(o) ((HBytes_Value*)&(o)->internalRep.twoPtrValue)
 384 #define OBJ_SOCKADDR(o) ((SockAddr_Value*)&(o)->internalRep.twoPtrValue)
 385
 386 #define TALLOC(s) ((void*)Tcl_Alloc((s)))
 387 #define TFREE(f) (Tcl_Free((void*)(f)))
 388
 389 #endif /*HBYTES_H*/