chiark / gitweb /
actually clean out unwanted file handlers; docuemtn -reverse options in right place
[chiark-tcl.git] / 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 #include <adns.h>
126
127 typedef unsigned char Byte;
128
129 /* from hbytes.c */
130
131 int Hbytes_Init(Tcl_Interp *ip); /* called by Tcl's "load" */
132
133 /* Internal representation details: */
134 #define HBYTES_ISEMPTY(hb)    (!(hb)->begin_complex && !(hb)->end_0)
135 #define HBYTES_ISSENTINEL(hb) (!(hb)->begin_complex && (hb)->end_0)
136 #define HBYTES_ISSIMPLE(hb)   ((hb)->begin_complex && (hb)->end_0)
137 #define HBYTES_ISCOMPLEX(hb)  ((hb)->begin_complex && !(hb)->end_0)
138
139 typedef struct {
140   void *begin_complex, *end_0;
141 } HBytes_Value; /* overlays internalRep */
142
143 typedef struct {
144   Byte *dstart; /* always allocated dynamically */
145   int prespace, len, avail;
146   /*        
147    * | SPARE      | USED  | SPARE |
148    * |<-prespace->|<-len->|       |
149    * |            |<----avail---->|
150    *              ^start
151    */
152 } HBytes_ComplexValue; /* pointed to from internalRep.otherValuePtr */
153
154 /* Public interfaces: */
155
156 extern Tcl_ObjType hbytes_type;
157
158 int hbytes_len(const HBytes_Value *v);
159 Byte *hbytes_data(const HBytes_Value *v); /* caller may then modify data! */
160 int hbytes_issentinel(const HBytes_Value *v);
161
162 Byte *hbytes_prepend(HBytes_Value *upd, int el);
163 Byte *hbytes_append(HBytes_Value *upd, int el);
164   /* return value is where to put the data */
165
166 const Byte *hbytes_unprepend(HBytes_Value *upd, int rl);
167 const Byte *hbytes_unappend(HBytes_Value *upd, int rl);
168   /* return value points to the removed data, which remains valid
169    * until next op on the HBytes_Value.  If original value is
170    * shorter than rl or negative, returns 0 and does nothing. */
171
172 void hbytes_empty(HBytes_Value *returns);
173 void hbytes_sentinel(HBytes_Value *returns);
174 void hbytes_array(HBytes_Value *returns, const Byte *array, int l);
175 Byte *hbytes_arrayspace(HBytes_Value *returns, int l);
176 void hbytes_free(const HBytes_Value *frees);
177   /* _empty, _sentinel and _array do not free or read the old value;
178    * _free it first if needed.  _free leaves it garbage, so you
179    * have to call _empty to reuse it.  _arrayspace doesn't fill
180    * the array; you get a pointer and must fill it with data
181    * yourself. */
182
183 /* The value made by hbytes_sentinel should not be passed to
184  * anything except HBYTES_IS..., and hbytes_free. */
185
186 /* from sockaddr.c */
187
188 typedef struct {
189   Byte *begin, *end;
190 } SockAddr_Value;
191
192 extern Tcl_ObjType sockaddr_type;
193
194 void sockaddr_clear(SockAddr_Value*);
195 void sockaddr_create(SockAddr_Value*, const struct sockaddr *addr, int len);
196 int sockaddr_len(const SockAddr_Value*);
197 const struct sockaddr *sockaddr_addr(const SockAddr_Value*);
198 void sockaddr_free(const SockAddr_Value*);
199
200 /* from scriptinv.c */
201
202 typedef struct { /* semi-opaque - read only, and then only where commented */
203   Tcl_Interp *ip; /* valid, non-0 and useable if set */
204   Tcl_Obj *obj; /* non-0 iff set (but only test for 0/non-0) */
205   Tcl_Obj *xargs;
206   int llength;
207 } ScriptToInvoke;
208
209 void scriptinv_init(ScriptToInvoke *si);
210 int scriptinv_set(ScriptToInvoke *si, Tcl_Interp *ip,
211                   Tcl_Obj *newscript, Tcl_Obj *xargs);
212 void scriptinv_cancel(ScriptToInvoke *si); /* then don't invoke */
213   /* no separate free function - just cancel */
214
215 void scriptinv_invoke(ScriptToInvoke *si, int argc, Tcl_Obj *const *argv);
216
217 /* from idtable.c */
218
219 typedef struct {
220   const char *valprefix, *assockey;
221   void (*destroyitem)(Tcl_Interp *ip, void *val);
222 } IdDataSpec;
223
224 /* The stored struct must start with a single int, conventionally
225  * named `ix'.  When the struct is returned for the first time ix must
226  * be -1; on subsequent occasions it must be >=0.  ix will be -1 iff
227  * the struct is registered by the iddatatable machinery. */
228
229 extern Tcl_ObjType tabledataid_nearlytype;
230 int tabledataid_parse(Tcl_Interp *ip, Tcl_Obj *o, const IdDataSpec *idds);
231 void tabledataid_disposing(Tcl_Interp *ip, void *val, const IdDataSpec *idds);
232   /* call this when you destroy the struct, to remove its name;
233    * _disposing is idempotent */
234
235 /* from adns.c */
236
237 typedef struct {
238   const char *name;
239   adns_rrtype number;
240 } AdnsTclRRTypeInfo;
241
242 extern const IdDataSpec adnstcl_queries, adnstcl_resolvers;
243
244 /* from dgram.c */
245
246 extern const IdDataSpec dgram_socks;
247 int newfdposixerr(Tcl_Interp *ip, int fd, const char *m);
248
249 /* from tuntap.c */
250
251 extern const IdDataSpec tuntap_socks;
252
253 /* from hook.c */
254
255 int staticerr(Tcl_Interp *ip, const char *m, const char *ec);
256 int posixerr(Tcl_Interp *ip, int errnoval, const char *m);
257 void objfreeir(Tcl_Obj *o);
258 int get_urandom(Tcl_Interp *ip, Byte *buffer, int l);
259
260 void obj_updatestr_array(Tcl_Obj *o, const Byte *array, int l);
261 void obj_updatestr_array_prefix(Tcl_Obj *o, const Byte *byte,
262                                 int l, const char *prefix);
263
264 void obj_updatestr_vstringls(Tcl_Obj *o, ...);
265   /* const char*, int, const char*, int, ..., (const char*)0 */
266 void obj_updatestr_string_len(Tcl_Obj *o, const char *str, int l);
267 void obj_updatestr_string(Tcl_Obj *o, const char *str);
268
269 /* from parse.c */
270
271 typedef struct {
272   Tcl_Obj *obj, *var;
273   int copied;
274 } Something_Var;
275
276 void init_somethingv(Something_Var *sth);
277 void fini_somethingv(Tcl_Interp *ip, int rc, Something_Var *sth);
278 int pat_somethingv(Tcl_Interp *ip, Tcl_Obj *var,
279                    Something_Var *sth, Tcl_ObjType *type);
280
281 typedef struct {
282   HBytes_Value *hb;
283   Something_Var sth;
284 } HBytes_Var;
285
286 /* from maskmap.c */
287
288 typedef struct MaskMap_Value MaskMap_Value;
289
290 typedef struct {
291   MaskMap_Value *mm;
292   Something_Var sth;
293 } MaskMap_Var;
294
295 extern Tcl_ObjType maskmap_type;
296
297 /* from chop.c */
298   /* only do_... functions declared in tables.h */
299
300 /* from ulong.c */
301
302 Tcl_ObjType ulong_type;
303
304 /* from enum.c */
305
306 extern Tcl_ObjType enum_nearlytype;
307 extern Tcl_ObjType enum1_nearlytype;
308
309 const void *enum_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
310                                     const void *firstentry, size_t entrysize,
311                                     const char *what);
312 #define enum_lookup_cached(ip,o,table,what)                     \
313     (enum_lookup_cached_func((ip),(o),                          \
314                              &(table)[0],sizeof((table)[0]),    \
315                              (what)))
316   /* table should be a pointer to an array of structs of size
317    * entrysize, the first member of which should be a const char*.
318    * The table should finish with a null const char *.
319    * On error, 0 is returned and the ip->result will have been
320    * set to the error message.
321    */
322
323 int enum1_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
324                              const char *opts, const char *what);
325   /* -1 => error */
326
327 /* from crypto.c */
328
329 void memxor(Byte *dest, const Byte *src, int l);
330
331 typedef struct {
332   const char *name;
333   int pad, use_algname;
334 } PadOp;
335
336 extern Tcl_ObjType blockcipherkey_type;
337
338 /* from algtables.c */
339
340 typedef struct {
341   const char *name;
342   int int_offset;
343 } BlockCipherPropInfo, HashAlgPropInfo;
344
345 typedef struct {
346   const char *name;
347   int hashsize, blocksize, statesize;
348   void (*init)(void *state);
349   void (*update)(void *state, const void *data, int len);
350   void (*final)(void *state, void *digest);
351   void (*oneshot)(void *digest, const void *data, int len);
352 } HashAlgInfo;
353
354 extern const HashAlgInfo hashalginfos[];
355
356 typedef struct {
357   void (*make_schedule)(void *schedule, const void *key, int keylen);
358   void (*crypt)(const void *schedule, const void *in, void *out);
359      /* in and out may be the same, but if they aren't they may not overlap */
360      /* in and out for crypt will have been through block_byteswap */
361 } BlockCipherPerDirectionInfo;
362
363 typedef struct {
364   const char *name;
365   int blocksize, schedule_size, key_min, key_max;
366   BlockCipherPerDirectionInfo encrypt, decrypt;
367 } BlockCipherAlgInfo;
368
369 extern const BlockCipherAlgInfo blockcipheralginfos[];
370
371 /* from bcmode.c */
372
373 typedef struct {
374   const char *name;
375   int iv_blocks, buf_blocks, mac_blocks;
376
377   /* Each function is allowed to use up to buf_blocks * blocksize
378    * bytes of space in buf.  data is blocks * blocksize bytes
379    * long.  data should be modified in place by encrypt and decrypt;
380    * modes may not change the size of data.  iv is always provided and
381    * is always of length iv_blocks * blocksize; encrypt and
382    * decrypt may modify the iv value (in which case the Tcl caller
383    * will get the modified IV) but this is not recommended.  mac
384    * should leave the mac, which must be mac_blocks * blocksize
385    * bytes, in buf.  (Therefore mac_blocks must be at least
386    * buf_blocks.)
387    */
388   const char *(*encrypt)(Byte *data, int nblocks,
389                          const Byte *iv, Byte *buf,
390                          const BlockCipherAlgInfo *alg, int encr,
391                          const void *sch);
392   const char *(*decrypt)(Byte *data, int nblocks,
393                          const Byte *iv, Byte *buf,
394                          const BlockCipherAlgInfo *alg, int encr,
395                          const void *sch);
396   const char *(*mac)(const Byte *data, int nblocks,
397                      const Byte *iv, Byte *buf,
398                      const BlockCipherAlgInfo *alg,
399                      const void *sch);
400 } BlockCipherModeInfo;
401
402 extern const BlockCipherModeInfo blockciphermodeinfos[];
403
404 /* from misc.c */
405
406 int setnonblock(int fd, int isnonblock);
407
408 /* useful macros */
409
410 #define OBJ_HBYTES(o) ((HBytes_Value*)&(o)->internalRep.twoPtrValue)
411 #define OBJ_SOCKADDR(o) ((SockAddr_Value*)&(o)->internalRep.twoPtrValue)
412
413 #define TALLOC(s) ((void*)Tcl_Alloc((s)))
414 #define TFREE(f) (Tcl_Free((void*)(f)))
415 #define TREALLOC(p,l) ((void*)Tcl_Realloc((void*)(p),(l)))
416
417 #endif /*HBYTES_H*/