4 * hbytes raw2h BINARY => hex
5 * hbytes h2raw HEX => binary
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)
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
24 * hbytes ushort2h LONG => LONG must be <2^16, returns as hex
25 * hbytes h2ushort HEX => |HEX| must be 2 bytes, returns as ulong
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)
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
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?
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
45 * hbytes hash ALG MESSAGE => hash
46 * hbytes hmac ALG MESSAGE KEY [MACLENGTH] => mac
47 * hbytes hash-prop PROPERTY ALG => property value
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
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
65 * uint VARNAME/VALUE (VARNAME if ul2bitfields;
66 * ulong VARNAME/VALUE VALUE if bitfields2ul)
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]] 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
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 SYNTAX LLENGTH value for mask-map entry not llength==3
90 * HBYTES MASKMAP SYNTAX UNDERRUN value for mask-map entry hex too short
91 * HBYTES MASKMAP SYNTAX OVERRUN actual mask-map entry hex too short
92 * HBYTES MASKMAP SYNTAX ORDER actual mask-map is disordered
93 * SOCKADDR AFUNIX LENGTH path for AF_UNIX socket too long
94 * SOCKADDR SYNTAX IPV4 bad IPv4 socket address &/or port
95 * SOCKADDR SYNTAX OTHER bad socket addr, couldn't tell what kind
96 * ULONG BITCOUNT NEGATIVE -ve bitcount specified where not allowed
97 * ULONG BITCOUNT OVERRUN attempt to use more than 32 bits
98 * ULONG BITCOUNT UNDERRUN bitfields add up to less than 32
99 * ULONG VALUE NEGATIVE attempt convert -ve integers to ulong
100 * ULONG VALUE OVERFLOW converted value does not fit in result
101 * TUNTAP IFNAME LENGTH tun/tap interface name too long
102 * TUNTAP MTU OVERRUN tun/tap mtu limited to 2^16 bytes
104 * Refs: HMAC: RFC2104
115 #include <sys/socket.h>
118 #include <arpa/inet.h>
120 #include <tcl8.3/tcl.h>
122 typedef unsigned char Byte;
126 int Hbytes_Init(Tcl_Interp *ip); /* called by Tcl's "load" */
128 /* Internal representation details: */
129 #define HBYTES_ISEMPTY(hb) (!(hb)->begin_complex && !(hb)->end_0)
130 #define HBYTES_ISSENTINEL(hb) (!(hb)->begin_complex && (hb)->end_0)
131 #define HBYTES_ISSIMPLE(hb) ((hb)->begin_complex && (hb)->end_0)
132 #define HBYTES_ISCOMPLEX(hb) ((hb)->begin_complex && !(hb)->end_0)
135 void *begin_complex, *end_0;
136 } HBytes_Value; /* overlays internalRep */
139 Byte *dstart; /* always allocated dynamically */
140 int prespace, len, avail;
142 * | SPARE | USED | SPARE |
143 * |<-prespace->|<-len->| |
144 * | |<----avail---->|
147 } HBytes_ComplexValue; /* pointed to from internalRep.otherValuePtr */
149 /* Public interfaces: */
151 extern Tcl_ObjType hbytes_type;
153 int hbytes_len(const HBytes_Value *v);
154 Byte *hbytes_data(const HBytes_Value *v); /* caller may then modify data! */
155 int hbytes_issentinel(const HBytes_Value *v);
157 Byte *hbytes_prepend(HBytes_Value *upd, int el);
158 Byte *hbytes_append(HBytes_Value *upd, int el);
159 /* return value is where to put the data */
161 const Byte *hbytes_unprepend(HBytes_Value *upd, int rl);
162 const Byte *hbytes_unappend(HBytes_Value *upd, int rl);
163 /* return value points to the removed data, which remains valid
164 * until next op on the HBytes_Value. If original value is
165 * shorter than rl or negative, returns 0 and does nothing. */
167 void hbytes_empty(HBytes_Value *returns);
168 void hbytes_sentinel(HBytes_Value *returns);
169 void hbytes_array(HBytes_Value *returns, const Byte *array, int l);
170 Byte *hbytes_arrayspace(HBytes_Value *returns, int l);
171 void hbytes_free(const HBytes_Value *frees);
172 /* _empty, _sentinel and _array do not free or read the old value;
173 * _free it first if needed. _free leaves it garbage, so you
174 * have to call _empty to reuse it. _arrayspace doesn't fill
175 * the array; you get a pointer and must fill it with data
178 /* The value made by hbytes_sentinel should not be passed to
179 * anything except HBYTES_IS..., and hbytes_free. */
181 /* from sockaddr.c */
187 extern Tcl_ObjType sockaddr_type;
189 void sockaddr_clear(SockAddr_Value*);
190 void sockaddr_create(SockAddr_Value*, const struct sockaddr *addr, int len);
191 int sockaddr_len(const SockAddr_Value*);
192 const struct sockaddr *sockaddr_addr(const SockAddr_Value*);
193 void sockaddr_free(const SockAddr_Value*);
195 /* from scriptinv.c */
197 typedef struct { /* semi-opaque - read only, and then only where commented */
198 Tcl_Interp *ip; /* valid, non-0 and useable if set */
199 Tcl_Obj *obj; /* non-0 iff set (but only test for 0/non-0) */
203 void scriptinv_init(ScriptToInvoke *si);
204 int scriptinv_set(ScriptToInvoke *si, Tcl_Interp *ip, Tcl_Obj *newscript);
205 void scriptinv_cancel(ScriptToInvoke *si); /* then don't invoke */
206 /* no separate free function - just cancel */
208 void scriptinv_invoke(ScriptToInvoke *si, int argc, Tcl_Obj **argv);
213 const char *const prefix;
218 extern Tcl_ObjType tabledataid_nearlytype;
219 int tabledataid_parse(Tcl_Interp *ip, Tcl_Obj *o, IdDataTable *tab);
223 extern IdDataTable dgram_socks;
224 int newfdposixerr(Tcl_Interp *ip, int fd, const char *m);
228 extern IdDataTable tuntap_socks;
232 int staticerr(Tcl_Interp *ip, const char *m, const char *ec);
233 int posixerr(Tcl_Interp *ip, int errnoval, const char *m);
234 void objfreeir(Tcl_Obj *o);
235 int get_urandom(Tcl_Interp *ip, Byte *buffer, int l);
237 void obj_updatestr_array(Tcl_Obj *o, const Byte *array, int l);
238 void obj_updatestr_array_prefix(Tcl_Obj *o, const Byte *byte,
239 int l, const char *prefix);
241 void obj_updatestr_vstringls(Tcl_Obj *o, ...);
242 /* const char*, int, const char*, int, ..., (const char*)0 */
243 void obj_updatestr_string_len(Tcl_Obj *o, const char *str, int l);
244 void obj_updatestr_string(Tcl_Obj *o, const char *str);
253 void init_somethingv(Something_Var *sth);
254 void fini_somethingv(Tcl_Interp *ip, int rc, Something_Var *sth);
255 int pat_somethingv(Tcl_Interp *ip, Tcl_Obj *var,
256 Something_Var *sth, Tcl_ObjType *type);
265 typedef struct MaskMap_Value MaskMap_Value;
272 extern Tcl_ObjType maskmap_type;
275 /* only do_... functions declared in tables.h */
279 Tcl_ObjType ulong_type;
283 extern Tcl_ObjType enum_nearlytype;
284 extern Tcl_ObjType enum1_nearlytype;
286 const void *enum_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
287 const void *firstentry, size_t entrysize,
289 #define enum_lookup_cached(ip,o,table,what) \
290 (enum_lookup_cached_func((ip),(o), \
291 &(table)[0],sizeof((table)[0]), \
293 /* table should be a pointer to an array of structs of size
294 * entrysize, the first member of which should be a const char*.
295 * The table should finish with a null const char *.
296 * On error, 0 is returned and the ip->result will have been
297 * set to the error message.
300 int enum1_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
301 const char *opts, const char *what);
306 void memxor(Byte *dest, const Byte *src, int l);
310 int pad, use_algname;
313 extern Tcl_ObjType blockcipherkey_type;
315 /* from algtables.c */
320 } BlockCipherPropInfo, HashAlgPropInfo;
324 int hashsize, blocksize, statesize;
325 void (*init)(void *state);
326 void (*update)(void *state, const void *data, int len);
327 void (*final)(void *state, void *digest);
328 void (*oneshot)(void *digest, const void *data, int len);
331 extern const HashAlgInfo hashalginfos[];
334 void (*make_schedule)(void *schedule, const void *key, int keylen);
335 void (*crypt)(const void *schedule, const void *in, void *out);
336 /* in and out may be the same, but if they aren't they may not overlap */
337 /* in and out for crypt will have been through block_byteswap */
338 } BlockCipherPerDirectionInfo;
342 int blocksize, schedule_size, key_min, key_max;
343 BlockCipherPerDirectionInfo encrypt, decrypt;
344 } BlockCipherAlgInfo;
346 extern const BlockCipherAlgInfo blockcipheralginfos[];
352 int iv_blocks, buf_blocks, mac_blocks;
354 /* Each function is allowed to use up to buf_blocks * blocksize
355 * bytes of space in buf. data is blocks * blocksize bytes
356 * long. data should be modified in place by encrypt and decrypt;
357 * modes may not change the size of data. iv is always provided and
358 * is always of length iv_blocks * blocksize; encrypt and
359 * decrypt may modify the iv value (in which case the Tcl caller
360 * will get the modified IV) but this is not recommended. mac
361 * should leave the mac, which must be mac_blocks * blocksize
362 * bytes, in buf. (Therefore mac_blocks must be at least
365 const char *(*encrypt)(Byte *data, int nblocks,
366 const Byte *iv, Byte *buf,
367 const BlockCipherAlgInfo *alg, int encr,
369 const char *(*decrypt)(Byte *data, int nblocks,
370 const Byte *iv, Byte *buf,
371 const BlockCipherAlgInfo *alg, int encr,
373 const char *(*mac)(const Byte *data, int nblocks,
374 const Byte *iv, Byte *buf,
375 const BlockCipherAlgInfo *alg,
377 } BlockCipherModeInfo;
379 extern const BlockCipherModeInfo blockciphermodeinfos[];
383 int setnonblock(int fd, int isnonblock);
387 #define OBJ_HBYTES(o) ((HBytes_Value*)&(o)->internalRep.twoPtrValue)
388 #define OBJ_SOCKADDR(o) ((SockAddr_Value*)&(o)->internalRep.twoPtrValue)
390 #define TALLOC(s) ((void*)Tcl_Alloc((s)))
391 #define TFREE(f) (Tcl_Free((void*)(f)))