X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=chiark-tcl.git;a=blobdiff_plain;f=hbytes%2Fhbytes.h;h=4a2f394862eb5eb31e5f618738e96d811f84e092;hp=f57b037f649078b6c2661b968f338a1c48ffe893;hb=82f88c53ddb84e42c770c23feb9bb0ee18341188;hpb=476c966037dfec5a0a2b03511dced36c673c2307 diff --git a/hbytes/hbytes.h b/hbytes/hbytes.h index f57b037..4a2f394 100644 --- a/hbytes/hbytes.h +++ b/hbytes/hbytes.h @@ -65,13 +65,31 @@ * uint VARNAME/VALUE (VARNAME if ul2bitfields; * ulong VARNAME/VALUE VALUE if bitfields2ul) * - * hbytes mask-map lookup MAP-VAR ADDRESS [DEFAULT] => DATA - * error on missing default or if address too short - * hbytes mask-map amend MAP-VAR PREFIX PREFIX-LENGTH DATA - * a maskmap MAP is [list [list PREFIX PREFIX-LENGTH DATA]] sorted - * first by descending PREFIX-LENGTH and then by ascending PREFIX - * each PREFIX _in the map_ is truncated to the shortest number of - * pairs of hex digits which can represent it + * Address ranges (addrmap.c): + * + * An address range is a slightly efficient partial mapping from + * addresses to arbitrary data values. An address is a number of + * octets expressed as an hbytes. All the addresses covered by the + * same addrmap should have the same length. + * + * hbytes addr-map lookup MAP-VAR ADDRESS [DEFAULT] => DATA + * Error on missing default or if any prefix longer than ADDRESS. + * + * hbytes addr-map amend-range MAP-VAR START END DATA + * hbytes addr-map amend-mask MAP-VAR PREFIX PREFIX-LENGTH DATA + * Sets all of the addresses in PREFIX/PREFIX-LENGTH to the + * relevant value. + * + * Representation: + * An address map MAP is + * [list BIT-LENGTH \ + * [list START END DATA-VALUE] \ + * [list START' END' DATA-VALUE'] \ + * ... + * ] + * The list is sorted by ascending START and entries do not overlap. + * START and END are both inclusive. BIT-LENGTH is in usual Tcl + * integer notation and must be a multiple of 8. * * Error codes * @@ -86,10 +104,12 @@ * HBYTES LENGTH MISMATCH when blocks must be exactly same length * HBYTES SYNTAX supposed hex block had wrong syntax * HBYTES VALUE OVERFLOW value to be conv'd to hex too big/long - * HBYTES MASKMAP SYNTAX LLENGTH value for mask-map entry not llength==3 - * HBYTES MASKMAP SYNTAX UNDERRUN value for mask-map entry hex too short - * HBYTES MASKMAP SYNTAX OVERRUN actual mask-map entry hex too short - * HBYTES MASKMAP SYNTAX ORDER actual mask-map is disordered + * HBYTES ADDRMAP NOMATCH no addr/mask matches address for lookup + * HBYTES ADDRMAP UNDERRUN addr for lookup or amend is too short + * HBYTES ADDRMAP OVERRUN addr for lookup or amend is too long + * HBYTES ADDRMAP EXCLBITS amend-mask 1-bits outside prefix len + * HBYTES ADDRMAP BADRANGE amend-range start > end + * HBYTES ADDRMAP VALUE addr-map string value is erroneous * SOCKADDR AFUNIX LENGTH path for AF_UNIX socket too long * SOCKADDR SYNTAX IPV4 bad IPv4 socket address &/or port * SOCKADDR SYNTAX OTHER bad socket addr, couldn't tell what kind @@ -101,8 +121,7 @@ * TUNTAP IFNAME LENGTH tun/tap interface name too long * TUNTAP MTU OVERRUN tun/tap mtu limited to 2^16 bytes * - * Refs: HMAC: RFC2104 - */ + * Refs: HMAC: RFC2104 */ #ifndef HBYTES_H #define HBYTES_H @@ -116,10 +135,9 @@ #include #include #include +#include -#include - -typedef unsigned char Byte; +#include "chiark-tcl.h" /* from hbytes.c */ @@ -146,248 +164,74 @@ typedef struct { */ } HBytes_ComplexValue; /* pointed to from internalRep.otherValuePtr */ +void memxor(Byte *dest, const Byte *src, int l); + /* Public interfaces: */ -extern Tcl_ObjType hbytes_type; +extern Tcl_ObjType cht_hbytes_type; -int hbytes_len(const HBytes_Value *v); -Byte *hbytes_data(const HBytes_Value *v); /* caller may then modify data! */ -int hbytes_issentinel(const HBytes_Value *v); +int cht_hb_len(const HBytes_Value *v); +Byte *cht_hb_data(const HBytes_Value *v); /* caller may then modify data! */ +int cht_hb_issentinel(const HBytes_Value *v); -Byte *hbytes_prepend(HBytes_Value *upd, int el); -Byte *hbytes_append(HBytes_Value *upd, int el); +Byte *cht_hb_prepend(HBytes_Value *upd, int el); +Byte *cht_hb_append(HBytes_Value *upd, int el); /* return value is where to put the data */ -const Byte *hbytes_unprepend(HBytes_Value *upd, int rl); -const Byte *hbytes_unappend(HBytes_Value *upd, int rl); +const Byte *cht_hb_unprepend(HBytes_Value *upd, int rl); +const Byte *cht_hb_unappend(HBytes_Value *upd, int rl); /* return value points to the removed data, which remains valid * until next op on the HBytes_Value. If original value is * shorter than rl or negative, returns 0 and does nothing. */ -void hbytes_empty(HBytes_Value *returns); -void hbytes_sentinel(HBytes_Value *returns); -void hbytes_array(HBytes_Value *returns, const Byte *array, int l); -Byte *hbytes_arrayspace(HBytes_Value *returns, int l); -void hbytes_free(const HBytes_Value *frees); +void cht_hb_empty(HBytes_Value *returns); +void cht_hb_sentinel(HBytes_Value *returns); +void cht_hb_array(HBytes_Value *returns, const Byte *array, int l); +Byte *cht_hb_arrayspace(HBytes_Value *returns, int l); +void cht_hb_free(const HBytes_Value *frees); /* _empty, _sentinel and _array do not free or read the old value; * _free it first if needed. _free leaves it garbage, so you * have to call _empty to reuse it. _arrayspace doesn't fill * the array; you get a pointer and must fill it with data * yourself. */ -/* The value made by hbytes_sentinel should not be passed to - * anything except HBYTES_IS..., and hbytes_free. */ - -/* from sockaddr.c */ - -typedef struct { - Byte *begin, *end; -} SockAddr_Value; - -extern Tcl_ObjType sockaddr_type; - -void sockaddr_clear(SockAddr_Value*); -void sockaddr_create(SockAddr_Value*, const struct sockaddr *addr, int len); -int sockaddr_len(const SockAddr_Value*); -const struct sockaddr *sockaddr_addr(const SockAddr_Value*); -void sockaddr_free(const SockAddr_Value*); - -/* from scriptinv.c */ - -typedef struct { /* semi-opaque - read only, and then only where commented */ - Tcl_Interp *ip; /* valid, non-0 and useable if set */ - Tcl_Obj *obj; /* non-0 iff set (but only test for 0/non-0) */ - int llength; -} ScriptToInvoke; - -void scriptinv_init(ScriptToInvoke *si); -int scriptinv_set(ScriptToInvoke *si, Tcl_Interp *ip, Tcl_Obj *newscript); -void scriptinv_cancel(ScriptToInvoke *si); /* then don't invoke */ - /* no separate free function - just cancel */ - -void scriptinv_invoke(ScriptToInvoke *si, int argc, Tcl_Obj **argv); - -/* from idtable.c */ - -typedef struct { - const char *const prefix; - int n; - void **a; -} IdDataTable; - -extern Tcl_ObjType tabledataid_nearlytype; -int tabledataid_parse(Tcl_Interp *ip, Tcl_Obj *o, IdDataTable *tab); - -/* from dgram.c */ - -extern IdDataTable dgram_socks; -int newfdposixerr(Tcl_Interp *ip, int fd, const char *m); - -/* from tuntap.c */ - -extern IdDataTable tuntap_socks; +/* The value made by cht_hb_sentinel should not be passed to + * anything except HBYTES_IS..., and cht_hb_free. */ /* from hook.c */ -int staticerr(Tcl_Interp *ip, const char *m, const char *ec); -int posixerr(Tcl_Interp *ip, int errnoval, const char *m); -void objfreeir(Tcl_Obj *o); -int get_urandom(Tcl_Interp *ip, Byte *buffer, int l); - void obj_updatestr_array(Tcl_Obj *o, const Byte *array, int l); void obj_updatestr_array_prefix(Tcl_Obj *o, const Byte *byte, int l, const char *prefix); -void obj_updatestr_vstringls(Tcl_Obj *o, ...); - /* const char*, int, const char*, int, ..., (const char*)0 */ -void obj_updatestr_string_len(Tcl_Obj *o, const char *str, int l); -void obj_updatestr_string(Tcl_Obj *o, const char *str); - /* from parse.c */ -typedef struct { - Tcl_Obj *obj, *var; - int copied; -} Something_Var; - -void init_somethingv(Something_Var *sth); -void fini_somethingv(Tcl_Interp *ip, int rc, Something_Var *sth); -int pat_somethingv(Tcl_Interp *ip, Tcl_Obj *var, - Something_Var *sth, Tcl_ObjType *type); - typedef struct { HBytes_Value *hb; Something_Var sth; } HBytes_Var; -/* from maskmap.c */ +/* from addrmap.c */ -typedef struct MaskMap_Value MaskMap_Value; +typedef struct AddrMap_Value AddrMap_Value; typedef struct { - MaskMap_Value *mm; + AddrMap_Value *am; Something_Var sth; -} MaskMap_Var; +} AddrMap_Var; -extern Tcl_ObjType maskmap_type; +extern Tcl_ObjType cht_addrmap_type; /* from chop.c */ /* only do_... functions declared in tables.h */ /* from ulong.c */ -Tcl_ObjType ulong_type; - -/* from enum.c */ - -extern Tcl_ObjType enum_nearlytype; -extern Tcl_ObjType enum1_nearlytype; - -const void *enum_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o, - const void *firstentry, size_t entrysize, - const char *what); -#define enum_lookup_cached(ip,o,table,what) \ - (enum_lookup_cached_func((ip),(o), \ - &(table)[0],sizeof((table)[0]), \ - (what))) - /* table should be a pointer to an array of structs of size - * entrysize, the first member of which should be a const char*. - * The table should finish with a null const char *. - * On error, 0 is returned and the ip->result will have been - * set to the error message. - */ - -int enum1_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o, - const char *opts, const char *what); - /* -1 => error */ - -/* from crypto.c */ - -void memxor(Byte *dest, const Byte *src, int l); - -typedef struct { - const char *name; - int pad, use_algname; -} PadOp; - -extern Tcl_ObjType blockcipherkey_type; - -/* from algtables.c */ - -typedef struct { - const char *name; - int int_offset; -} BlockCipherPropInfo, HashAlgPropInfo; - -typedef struct { - const char *name; - int hashsize, blocksize, statesize; - void (*init)(void *state); - void (*update)(void *state, const void *data, int len); - void (*final)(void *state, void *digest); - void (*oneshot)(void *digest, const void *data, int len); -} HashAlgInfo; - -extern const HashAlgInfo hashalginfos[]; - -typedef struct { - void (*make_schedule)(void *schedule, const void *key, int keylen); - void (*crypt)(const void *schedule, const void *in, void *out); - /* in and out may be the same, but if they aren't they may not overlap */ - /* in and out for crypt will have been through block_byteswap */ -} BlockCipherPerDirectionInfo; - -typedef struct { - const char *name; - int blocksize, schedule_size, key_min, key_max; - BlockCipherPerDirectionInfo encrypt, decrypt; -} BlockCipherAlgInfo; - -extern const BlockCipherAlgInfo blockcipheralginfos[]; - -/* from bcmode.c */ - -typedef struct { - const char *name; - int iv_blocks, buf_blocks, mac_blocks; - - /* Each function is allowed to use up to buf_blocks * blocksize - * bytes of space in buf. data is blocks * blocksize bytes - * long. data should be modified in place by encrypt and decrypt; - * modes may not change the size of data. iv is always provided and - * is always of length iv_blocks * blocksize; encrypt and - * decrypt may modify the iv value (in which case the Tcl caller - * will get the modified IV) but this is not recommended. mac - * should leave the mac, which must be mac_blocks * blocksize - * bytes, in buf. (Therefore mac_blocks must be at least - * buf_blocks.) - */ - const char *(*encrypt)(Byte *data, int nblocks, - const Byte *iv, Byte *buf, - const BlockCipherAlgInfo *alg, int encr, - const void *sch); - const char *(*decrypt)(Byte *data, int nblocks, - const Byte *iv, Byte *buf, - const BlockCipherAlgInfo *alg, int encr, - const void *sch); - const char *(*mac)(const Byte *data, int nblocks, - const Byte *iv, Byte *buf, - const BlockCipherAlgInfo *alg, - const void *sch); -} BlockCipherModeInfo; - -extern const BlockCipherModeInfo blockciphermodeinfos[]; - -/* from misc.c */ - -int setnonblock(int fd, int isnonblock); +Tcl_ObjType cht_ulong_type; /* useful macros */ #define OBJ_HBYTES(o) ((HBytes_Value*)&(o)->internalRep.twoPtrValue) #define OBJ_SOCKADDR(o) ((SockAddr_Value*)&(o)->internalRep.twoPtrValue) -#define TALLOC(s) ((void*)Tcl_Alloc((s))) -#define TFREE(f) (Tcl_Free((void*)(f))) - #endif /*HBYTES_H*/