chiark / gitweb /
better core algorithm selection and new core alg suites
[chiark-tcl.git] / hbytes / hbytes.h
index 75ce6c816bf0f86f95fb3ded4d91c2f88cfb7702..06c98fce518d12654e61912823671b0c2ce58034 100644 (file)
@@ -4,6 +4,7 @@
  *  hbytes raw2h BINARY                          => hex
  *  hbytes h2raw HEX                             => binary
  *
+ *  hbytes length VALUE                          => count
  *  hbytes prepend VAR [VALUE ...]         = set VAR [concat VALUE ... $VAR]
  *  hbytes append VAR [VALUE ...]          = set VAR [concat $VAR VALUE ...]
  *  hbytes concat VAR [VALUE ...]          = set VAR [concat VALUE ...]
  *  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 VAR                         removes any leading 0 octets
+ *  hbytes repeat VALUE COUNT                    => COUNT copies of VALUE
+ *
+ *  hbytes ushort2h LONG           => LONG must be <2^16, returns as hex
+ *  hbytes h2ushort HEX            => |HEX| must be 2 bytes, returns as ulong
+ *
+ *  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 MODE [IV]     => IV
+ *  hbytes blockcipher d|e VAR ALG KEY MODE [IV] => IV
+ *  hbytes blockcipher mac MSG ALG KEY MODE IV   => final block
+ *  hbytes blockcipher prop PROPERTY ALG         => property value
  *
  *  hbytes hash ALG MESSAGE                      => hash
  *  hbytes hmac ALG MESSAGE KEY [MACLENGTH]      => mac
+ *  hbytes hash-prop PROPERTY ALG                => property value
+ *
+ *  ulong ul2int ULONG    => INT           can fail if >INT_MAX
+ *  ulong int2ul INT      => ULONG         can fail if <0
+ *  ulong mask A B                         => A & B
+ *  ulong add A B                          => A + B  (mod 2^32)
+ *  ulong subtract A B                     => A - B  (mod 2^32)
+ *  ulong compare A B                      => 0  -1 (A<B)  +1 (A>B)
+ *  ulong shift l|r ULONG BITS             fails if BITS >32
+ *
+ *  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)
+ *
+ * Error codes
+ *
+ * HBYTES BLOCKCIPHER CRYPTFAIL CRYPT  block cipher mode failed somehow (!)
+ * HBYTES BLOCKCIPHER CRYPTFAIL MAC    HMAC failed somehow (!)
+ * HBYTES BLOCKCIPHER LENGTH           block cipher input has unsuitable length
+ * HBYTES BLOCKCIPHER PARAMS           key or iv not suitable
+ * HBYTES HMAC PARAMS                  key, input or output size not suitable
+ * HBYTES LENGTH OVERRUN               block too long
+ * HBYTES LENGTH RANGE                 input length or offset is -ve or silly
+ * HBYTES LENGTH UNDERRUN              block too short (or offset too big)
+ * HBYTES SYNTAX                       supposed hex block had wrong syntax
+ * HBYTES VALUE OVERFLOW               value to be conv'd to hex too big/long
+ * 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
+ * ULONG BITCOUNT NEGATIVE             -ve bitcount specified where not allowed
+ * ULONG BITCOUNT OVERRUN              attempt to use more than 32 bits
+ * ULONG BITCOUNT UNDERRUN             bitfields add up to less than 32
+ * ULONG VALUE NEGATIVE                attempt convert -ve integers to ulong
+ * ULONG VALUE OVERFLOW                converted value does not fit in result
  *
  * Refs: HMAC: RFC2104
  */
 
 #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>
 
@@ -34,6 +100,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)
@@ -77,7 +145,7 @@ 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(HBytes_Value *frees);
+void hbytes_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
@@ -87,21 +155,57 @@ void hbytes_free(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 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 {
   HBytes_Value *hb;
   Tcl_Obj *obj, *var;
+  int copied;
 } HBytes_Var;
 
 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 */
 
@@ -113,7 +217,7 @@ const void *enum_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
                                    const char *what);
 #define enum_lookup_cached(ip,o,table,what)                    \
     (enum_lookup_cached_func((ip),(o),                         \
-                            sizeof((table)[0]),&(table)[0],    \
+                            &(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*.
@@ -130,26 +234,43 @@ int enum1_lookup_cached_func(Tcl_Interp *ip, Tcl_Obj *o,
 
 void memxor(Byte *dest, const Byte *src, int l);
 
-/* from hash.c */
+typedef struct {
+  const char *name;
+  int pad, use_algname;
+} PadMethod;
+
+extern Tcl_ObjType blockcipherkey_type;
+
+/* from algtables.c */
 
 typedef struct {
-  int blocksize, hashsize;
+  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;
 
-/* from blockciph.c */
+extern const HashAlgInfo hashalginfos[];
 
 typedef struct {
-  void (*make_schedule)(void *schedule, const Byte *key, int keylen);
+  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 */
-} BlockCipherDirectionInfo;
+} BlockCipherPerDirectionInfo;
 
 typedef struct {
   const char *name;
   int blocksize, schedule_size, key_min, key_max;
-  void (*byteswap)(Byte *block);
-  BlockCipherDirectionInfo encrypt, decrypt;
+  void (*byteswap)(void *block);
+  BlockCipherPerDirectionInfo encrypt, decrypt;
 } BlockCipherAlgInfo;
 
 extern const BlockCipherAlgInfo blockcipheralginfos[];
@@ -158,23 +279,43 @@ extern const BlockCipherAlgInfo blockcipheralginfos[];
 
 typedef struct {
   const char *name;
-  int iv_blocks, buf_blocks;
-  const char *(*encrypt)(Byte *data, int blocks,
+  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,
-                        int blocksize, const void *sch);
-  const char *(*decrypt)(Byte *data, int blocks,
+                        const void *sch);
+  const char *(*decrypt)(Byte *data, int nblocks,
                         const Byte *iv, Byte *buf,
                         const BlockCipherAlgInfo *alg, int encr,
-                        int blocksize, const void *sch);
-    /* in each case, *iv is provided, but may be modified */
+                        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);
+
 /* 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)))