chiark / gitweb /
383eb53582076f6e8f52ef2d5b2e94112843d368
[chiark-tcl.git] / base / chiark-tcl.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  *
21  *  hbytes ushort2h LONG           => LONG must be <2^16, returns as hex
22  *  hbytes h2ushort HEX            => |HEX| must be 2 bytes, returns as ulong
23  *
24  *  hbytes compare A B
25  *      =>  -2   A is lexically earlier than B and not a prefix of B  (A<B)
26  *          -1   A is prefix of B but not equal                       (A<B)
27  *           0   A == B
28  *          +1   A is B plus a nonempty suffix (ie, A has B as a prefix)
29  *          +2   A is lexically later than B and does not have B as a prefix
30  *
31  *  hbytes pkcs5 pa|ua VAR ALG                   => worked?  (always 1 for p)
32  *  hbytes pkcs5 pn|un VAR BLOCKSIZE             => worked?  (always 1 for p)
33  *  hbytes blockcipher d|e VAR ALG KEY MODE [IV] => IV
34  *  hbytes blockcipher mac MSG ALG KEY MODE IV   => final block
35  *
36  *  hbytes hash ALG MESSAGE                      => hash
37  *  hbytes hmac ALG MESSAGE KEY [MACLENGTH]      => mac
38  *
39  *  ulong ul2int ULONG    => INT           can fail if >INT_MAX
40  *  ulong int2ul INT      => ULONG         can fail if <0
41  *  ulong mask A B                         => A & B
42  *  ulong add A B                          => A + B  (mod 2^32)
43  *  ulong subtract A B                     => A - B  (mod 2^32)
44  *  ulong compare A B                      => 0  -1 (A<B)  +1 (A>B)
45  *  ulong shift l|r ULONG BITS             fails if BITS >32
46  *
47  *  ulong ul2bitfields VALUE [SIZE TYPE [TYPE-ARG...] ...]  => 0/1
48  *  ulong bitfields2ul BASE  [SIZE TYPE [TYPE-ARG...] ...]  => ULONG
49  *      goes from left (MSbit) to right (LSbit) where
50  *            SIZE is size in bits
51  *            TYPE [TYPE-ARGS...] is as below
52  *               zero
53  *               ignore
54  *               fixed ULONG-VALUE
55  *               uint VARNAME/VALUE         (VARNAME if ul2bitfields;
56  *               ulong VARNAME/VALUE         VALUE if bitfields2ul)
57  *
58  * Error codes
59  *
60  * HBYTES BLOCKCIPHER CRYPTFAIL CRYPT  block cipher mode failed somehow (!)
61  * HBYTES BLOCKCIPHER CRYPTFAIL MAC    HMAC failed somehow (!)
62  * HBYTES BLOCKCIPHER LENGTH           block cipher input has unsuitable length
63  * HBYTES BLOCKCIPHER PARAMS           key or iv not suitable
64  * HBYTES HMAC PARAMS                  key, input or output size not suitable
65  * HBYTES LENGTH OVERRUN               block too long
66  * HBYTES LENGTH RANGE                 input length or offset is -ve or silly
67  * HBYTES LENGTH UNDERRUN              block too short (or offset too big)
68  * HBYTES SYNTAX                       supposed hex block had wrong syntax
69  * HBYTES VALUE OVERFLOW               value to be conv'd to hex too big/long
70  * SOCKADDR AFUNIX LENGTH              path for AF_UNIX socket too long
71  * SOCKADDR SYNTAX IPV4                bad IPv4 socket address &/or port
72  * SOCKADDR SYNTAX OTHER               bad socket addr, couldn't tell what kind
73  * ULONG BITCOUNT NEGATIVE             -ve bitcount specified where not allowed
74  * ULONG BITCOUNT OVERRUN              attempt to use more than 32 bits
75  * ULONG BITCOUNT UNDERRUN             bitfields add up to less than 32
76  * ULONG VALUE NEGATIVE                attempt convert -ve integers to ulong
77  * ULONG VALUE OVERFLOW                converted value does not fit in result
78  *
79  * Refs: HMAC: RFC2104
80  */
81
82 #ifndef HBYTES_H
83 #define HBYTES_H
84
85 #include <assert.h>
86 #include <stdlib.h>
87 #include <errno.h>
88 #include <unistd.h>
89 #include <fcntl.h>
90 #include <sys/socket.h>
91 #include <sys/uio.h>
92 #include <sys/un.h>
93 #include <arpa/inet.h>
94
95 #include <tcl.h>
96
97 typedef unsigned char Byte;
98
99 /* from hbytes.c */
100
101 int Hbytes_Init(Tcl_Interp *ip); /* called by Tcl's "load" */
102
103 /* Internal representation details: */
104 #define HBYTES_ISEMPTY(hb)    (!(hb)->begin_complex && !(hb)->end_0)
105 #define HBYTES_ISSENTINEL(hb) (!(hb)->begin_complex && (hb)->end_0)
106 #define HBYTES_ISSIMPLE(hb)   ((hb)->begin_complex && (hb)->end_0)
107 #define HBYTES_ISCOMPLEX(hb)  ((hb)->begin_complex && !(hb)->end_0)
108
109 typedef struct {
110   void *begin_complex, *end_0;
111 } HBytes_Value; /* overlays internalRep */
112
113 typedef struct {
114   Byte *dstart; /* always allocated dynamically */
115   int prespace, len, avail;
116   /*        
117    * | SPARE      | USED  | SPARE |
118    * |<-prespace->|<-len->|       |
119    * |            |<----avail---->|
120    *              ^start
121    */
122 } HBytes_ComplexValue; /* pointed to from internalRep.otherValuePtr */
123
124 /* Public interfaces: */
125
126 extern Tcl_ObjType hbytes_type;
127
128 int hbytes_len(const HBytes_Value *v);
129 Byte *hbytes_data(const HBytes_Value *v); /* caller may then modify data! */
130 int hbytes_issentinel(const HBytes_Value *v);
131
132 Byte *hbytes_prepend(HBytes_Value *upd, int el);
133 Byte *hbytes_append(HBytes_Value *upd, int el);
134   /* return value is where to put the data */
135
136 const Byte *hbytes_unprepend(HBytes_Value *upd, int rl);
137 const Byte *hbytes_unappend(HBytes_Value *upd, int rl);
138   /* return value points to the removed data, which remains valid
139    * until next op on the HBytes_Value.  If original value is
140    * shorter than rl or negative, returns 0 and does nothing. */
141
142 void hbytes_empty(HBytes_Value *returns);
143 void hbytes_sentinel(HBytes_Value *returns);
144 void hbytes_array(HBytes_Value *returns, const Byte *array, int l);
145 Byte *hbytes_arrayspace(HBytes_Value *returns, int l);
146 void hbytes_free(const HBytes_Value *frees);
147   /* _empty, _sentinel and _array do not free or read the old value;
148    * _free it first if needed.  _free leaves it garbage, so you
149    * have to call _empty to reuse it.  _arrayspace doesn't fill
150    * the array; you get a pointer and must fill it with data
151    * yourself. */
152
153 /* The value made by hbytes_sentinel should not be passed to
154  * anything except HBYTES_IS..., and hbytes_free. */
155
156 /* from sockaddr.c */
157
158 typedef struct {
159   Byte *begin, *end;
160 } SockAddr_Value;
161
162 extern Tcl_ObjType sockaddr_type;
163
164 void sockaddr_clear(SockAddr_Value*);
165 void sockaddr_create(SockAddr_Value*, const struct sockaddr *addr, int len);
166 int sockaddr_len(const SockAddr_Value*);
167 const struct sockaddr *sockaddr_addr(const SockAddr_Value*);
168 void sockaddr_free(const SockAddr_Value*);
169
170 /* from dgram.c */
171
172 extern Tcl_ObjType dgramsockid_type;
173 typedef struct DgramSocket *DgramSockID;
174
175 /* from hook.c */
176
177 int staticerr(Tcl_Interp *ip, const char *m, const char *ec);
178 int posixerr(Tcl_Interp *ip, int errnoval, const char *m);
179 void objfreeir(Tcl_Obj *o);
180 int get_urandom(Tcl_Interp *ip, Byte *buffer, int l);
181
182 void obj_updatestr_array(Tcl_Obj *o, const Byte *array, int l);
183 void obj_updatestr_array_prefix(Tcl_Obj *o, const Byte *byte,
184                                 int l, const char *prefix);
185
186 void obj_updatestr_vstringls(Tcl_Obj *o, ...);
187   /* const char*, int, const char*, int, ..., (const char*)0 */
188 void obj_updatestr_string_len(Tcl_Obj *o, const char *str, int l);
189 void obj_updatestr_string(Tcl_Obj *o, const char *str);
190
191 /* from parse.c */
192
193 typedef struct {
194   HBytes_Value *hb;
195   Tcl_Obj *obj, *var;
196   int copied;
197 } HBytes_Var;
198
199 void fini_hbv(Tcl_Interp *ip, int rc, HBytes_Var *agg);
200
201 /* from chop.c */
202   /* only do_... functions declared in tables.h */
203
204 /* from ulong.c */
205
206 Tcl_ObjType ulong_type;
207
208 /* from enum.c */
209
210 extern Tcl_ObjType enum_nearlytype;
211 extern Tcl_ObjType enum1_nearlytype;
212
213 const void *enum_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
214                                     const void *firstentry, size_t entrysize,
215                                     const char *what);
216 #define enum_lookup_cached(ip,o,table,what)                     \
217     (enum_lookup_cached_func((ip),(o),                          \
218                              &(table)[0],sizeof((table)[0]),    \
219                              (what)))
220   /* table should be a pointer to an array of structs of size
221    * entrysize, the first member of which should be a const char*.
222    * The table should finish with a null const char *.
223    * On error, 0 is returned and the ip->result will have been
224    * set to the error message.
225    */
226
227 int enum1_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
228                              const char *opts, const char *what);
229   /* -1 => error */
230
231 /* from crypto.c */
232
233 void memxor(Byte *dest, const Byte *src, int l);
234
235 typedef struct {
236   const char *name;
237   int pad, use_algname;
238 } PadMethod;
239
240 extern Tcl_ObjType blockcipherkey_type;
241
242 /* from algtables.c */
243
244 typedef struct {
245   const char *name;
246   int hashsize, blocksize, statesize;
247   void (*init)(void *state);
248   void (*update)(void *state, const void *data, int len);
249   void (*final)(void *state, void *digest);
250   void (*oneshot)(void *digest, const void *data, int len);
251 } HashAlgInfo;
252
253 extern const HashAlgInfo hashalginfos[];
254
255 typedef struct {
256   void (*make_schedule)(void *schedule, const void *key, int keylen);
257   void (*crypt)(const void *schedule, const void *in, void *out);
258      /* in and out may be the same, but if they aren't they may not overlap */
259      /* in and out for crypt will have been through block_byteswap */
260 } BlockCipherPerDirectionInfo;
261
262 typedef struct {
263   const char *name;
264   int blocksize, schedule_size, key_min, key_max;
265   void (*byteswap)(void *block);
266   BlockCipherPerDirectionInfo encrypt, decrypt;
267 } BlockCipherAlgInfo;
268
269 extern const BlockCipherAlgInfo blockcipheralginfos[];
270
271 /* from bcmode.c */
272
273 typedef struct {
274   const char *name;
275   int iv_blocks, buf_blocks, mac_blocks;
276
277   /* Each function is allowed to use up to buf_blocks * blocksize
278    * bytes of space in buf.  data is blocks * blocksize bytes
279    * long.  data should be modified in place by encrypt and decrypt;
280    * modes may not change the size of data.  iv is always provided and
281    * is always of length iv_blocks * blocksize; encrypt and
282    * decrypt may modify the iv value (in which case the Tcl caller
283    * will get the modified IV) but this is not recommended.  mac
284    * should leave the mac, which must be mac_blocks * blocksize
285    * bytes, in buf.  (Therefore mac_blocks must be at least
286    * buf_blocks.)
287    */
288   const char *(*encrypt)(Byte *data, int nblocks,
289                          const Byte *iv, Byte *buf,
290                          const BlockCipherAlgInfo *alg, int encr,
291                          const void *sch);
292   const char *(*decrypt)(Byte *data, int nblocks,
293                          const Byte *iv, Byte *buf,
294                          const BlockCipherAlgInfo *alg, int encr,
295                          const void *sch);
296   const char *(*mac)(const Byte *data, int nblocks,
297                      const Byte *iv, Byte *buf,
298                      const BlockCipherAlgInfo *alg,
299                      const void *sch);
300 } BlockCipherModeInfo;
301
302 extern const BlockCipherModeInfo blockciphermodeinfos[];
303
304 /* from misc.c */
305
306 int setnonblock(int fd, int isnonblock);
307
308 /* useful macros */
309
310 #define OBJ_HBYTES(o) ((HBytes_Value*)&(o)->internalRep.twoPtrValue)
311 #define OBJ_SOCKADDR(o) ((SockAddr_Value*)&(o)->internalRep.twoPtrValue)
312
313 #define TALLOC(s) ((void*)Tcl_Alloc((s)))
314 #define TFREE(f) (Tcl_Free((void*)(f)))
315
316 #endif /*HBYTES_H*/