does modexps, makes signatures, needs sane hexstring handling

[chiark-tcl.git] / hbytes / hbytes.h

diff --git a/hbytes/hbytes.h b/hbytes/hbytes.h
index 86b2dba6dec3c3b550b6252258f45eef4c6f69dc..f482cc57f0e99ee63593eb271f5eca266aed0ea1 100644 (file)
--- a/hbytes/hbytes.h
+++ b/hbytes/hbytes.h
@@ -13,6 +13,38 @@
  *  hbytes chopto VAR NEWVARLENGTH               => suffix (removed from VAR)
  *                                                  (too short? error)
  *
+ *  hbytes range VALUE START SIZE                => substring (or error)
+ *  hbytes overwrite VAR START VALUE
+ *  hbytes trimleft VALUE                        removes any leading 0 octets
+ *  hbytes repeat VALUE COUNT                    => COUNT copies of VALUE
+ *
+ *  hbytes h2ulong HEX                           => ulong  (HEX len must be 4)
+ *  hbytes ulong2h UL                            => hex
+ *
+ *  ulong ul2bitfields VALUE [SIZE TYPE [TYPE-ARG...] ...]  => 0/1
+ *  ulong bitfields2ul BASE  [SIZE TYPE [TYPE-ARG...] ...]  => ULONG
+ *      goes from left (MSbit) to right (LSbit) where
+ *            SIZE is size in bits
+ *            TYPE [TYPE-ARGS...] is as below
+ *               zero
+ *               ignore
+ *               fixed ULONG-VALUE
+ *               uint VARNAME/VALUE         (VARNAME if ul2bitfields;
+ *               ulong VARNAME/VALUE         VALUE if bitfields2ul)
+ *
+ *  ulong ul2int ULONG    => INT            can fail if >INT_MAX
+ *  ulong int2ul INT      => ULONG          can fail if <0
+ *
+ *  hbytes shift l|r ULONG BITS             fails if BITS >32
+ *  hbytes mask A B                         => A & B
+ *
+ *  hbytes compare A B
+ *      =>  -2   A is lexically earlier than B and not a prefix of B  (A<B)
+ *          -1   A is prefix of B but not equal                       (A<B)
+ *           0   A == B
+ *          +1   A is B plus a nonempty suffix (ie, A has B as a prefix)
+ *          +2   A is lexically later than B and does not have B as a prefix
+ *
  *  hbytes pkcs5 pa|ua VAR ALG                   => worked?  (always 1 for p)
  *  hbytes pkcs5 pn|un VAR BLOCKSIZE             => worked?  (always 1 for p)
  *  hbytes blockcipher d|e VAR ALG KEY MODE [IV] => IV
@@ -28,6 +60,13 @@
 
 #include <assert.h>
 #include <stdlib.h>
+#include <errno.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <sys/socket.h>
+#include <sys/uio.h>
+#include <sys/un.h>
+#include <arpa/inet.h>
 
 #include <tcl.h>
 
@@ -35,6 +74,8 @@ typedef unsigned char Byte;
 
 /* from hbytes.c */
 
+int Hbytes_Init(Tcl_Interp *ip); /* called by Tcl's "load" */
+
 /* Internal representation details: */
 #define HBYTES_ISEMPTY(hb)    (!(hb)->begin_complex && !(hb)->end_0)
 #define HBYTES_ISSENTINEL(hb) (!(hb)->begin_complex && (hb)->end_0)
@@ -88,13 +129,41 @@ void hbytes_free(const HBytes_Value *frees);
 /* 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 dgram.c */
+
+extern Tcl_ObjType dgramsockid_type;
+typedef struct DgramSocket *DgramSockID;
+
 /* from hook.c */
 
 int staticerr(Tcl_Interp *ip, const char *m);
+int posixerr(Tcl_Interp *ip, int errnoval, const char *m);
 void objfreeir(Tcl_Obj *o);
-void obj_updatestr_array(Tcl_Obj *o, const Byte *array, int l);
 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 {
@@ -105,6 +174,11 @@ typedef struct {
 void fini_hbv(Tcl_Interp *ip, int rc, HBytes_Var *agg);
 
 /* from chop.c */
+  /* only do_... functions declared in tables.h */
+
+/* from ulong.c */
+
+Tcl_ObjType ulong_type;
 
 /* from enum.c */
 
@@ -138,7 +212,7 @@ typedef struct {
   int pad, use_algname;
 } PadMethod;
 
-Tcl_ObjType blockcipherkey_type;
+extern Tcl_ObjType blockcipherkey_type;
 
 /* from algtables.c */
 
@@ -187,9 +261,14 @@ typedef struct {
 
 extern const BlockCipherModeInfo blockciphermodeinfos[];
 
+/* from misc.c */
+
+int setnonblock(int fd, int isnonblock);
+
 /* 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)))