mdw@git.distorted.org.uk Git - catacomb-perl/blob - catacomb-perl.h

   1 /* -*-c-*-
   2  *
   3  * $Id$
   4  *
   5  * Main header file for Catacomb/Perl
   6  *
   7  * (c) 2001 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of the Perl interface to Catacomb.
  13  *
  14  * Catacomb/Perl is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * Catacomb/Perl is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with Catacomb/Perl; if not, write to the Free Software Foundation,
  26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27  */
  28
  29 #ifndef CATACOMB_PERL_H
  30 #define CATACOMB_PERL_H
  31
  32 #ifdef __cplusplus
  33   extern "C" {
  34 #endif
  35
  36 /*----- Header files ------------------------------------------------------*/
  37
  38 #include <EXTERN.h>
  39 #include <perl.h>
  40 #include <XSUB.h>
  41
  42 #include <assert.h>
  43 #include <stdio.h>
  44 #include <stdarg.h>
  45 #include <stdlib.h>
  46 #include <string.h>
  47
  48 #include <catacomb/blkc.h>
  49 #include <catacomb/gcipher.h>
  50 #include <catacomb/ghash.h>
  51 #include <catacomb/gmac.h>
  52
  53 #include <catacomb/grand.h>
  54 #include <catacomb/fibrand.h>
  55 #include <catacomb/lcrand.h>
  56 #include <catacomb/dsarand.h>
  57 #include <catacomb/rand.h>
  58 #include <catacomb/noise.h>
  59
  60 #include <catacomb/share.h>
  61 #include <catacomb/gfshare.h>
  62
  63 #include <catacomb/key.h>
  64 #include <catacomb/passphrase.h>
  65
  66 #include <catacomb/mp.h>
  67 #include <catacomb/gf.h>
  68 #include <catacomb/ec.h>
  69 #include <catacomb/rsa.h>
  70 #include <catacomb/dh.h>
  71 #include <catacomb/dsa.h>
  72 #include <catacomb/gdsa.h>
  73 #include <catacomb/gkcdsa.h>
  74 #include <catacomb/field.h>
  75 #include <catacomb/group.h>
  76 #include <catacomb/mpint.h>
  77 #include <catacomb/mpmul.h>
  78 #include <catacomb/mprand.h>
  79 #include <catacomb/mpcrt.h>
  80 #include <catacomb/mpmont.h>
  81 #include <catacomb/mpbarrett.h>
  82 #include <catacomb/mpreduce.h>
  83 #include <catacomb/gfreduce.h>
  84
  85 #include <catacomb/pfilt.h>
  86 #include <catacomb/rabin.h>
  87 #include <catacomb/pgen.h>
  88 #include <catacomb/limlee.h>
  89 #include <catacomb/strongprime.h>
  90
  91 /*----- Misc support ------------------------------------------------------*/
  92
  93 struct consttab { const char *name; UV val; };
  94
  95 typedef struct cursor {
  96   unsigned f;
  97   union {
  98     HV *hv;
  99     struct { AV *av; unsigned i; } a;
 100   } u;
 101 } cursor;
 102 #define CF_ARRAY 0u
 103 #define CF_HASH 1u
 104 #define CF_MUST 1u
 105
 106 extern U32 findconst(const struct consttab *cc,
 107                      const char *pkg, const char *name);
 108 extern void ptrtosv(SV **sv, void *p, const char *type);
 109 extern void *ptrfromsv(SV *sv, const char *type, const char *what, ...);
 110 extern void *ptrfromsvdflt(SV *sv, const char *type, void *dflt,
 111                            const char *what);
 112 extern void c_init(cursor *c, SV *sv);
 113 extern void c_skip(cursor *c);
 114 extern SV *c_get(cursor *c, const char *tag, unsigned f);
 115 extern ge *groupelt(SV *sv, const char *what);
 116 extern mp *fieldelt(SV *sv, const char *what);
 117 extern ec *ecpt(SV *sv, const char *what);
 118
 119 #define SET(sv, ob, ty) sv_setref_pv((sv), (char *)(ty), (void *)(ob))
 120 #define MAKE(ob, ty) SET(NEWSV(0, 0), ob, ty)
 121 #define RET(ob, ty) SET(sv_newmortal(), ob, ty)
 122 #define C_MP(c, tag) mp_fromsv(c_get(c, tag, CF_MUST), tag, 0, 0)
 123 #define C_PTR(c, tag, type) ptrfromsv(c_get(c, tag, CF_MUST), type, tag)
 124 #define C_PTRDFLT(c, tag, type, def)                                    \
 125   ptrfromsvdflt(c_get(c, tag, 0), type, def, tag)
 126 #define C_GE(c, tag) groupelt(c_get(c, tag, CF_MUST), tag)
 127 #define C_FE(c, tag) fieldelt(c_get(c, tag, CF_MUST), tag)
 128 #define C_EC(c, tag) ecpt(c_get(c, tag, CF_MUST), tag)
 129 extern void hvput(HV *hv, const char *k, SV *val);
 130
 131 /*----- Crypto algorithms -------------------------------------------------*/
 132
 133 typedef struct PRPClass {
 134   char *name;
 135   const octet *ksz;
 136   size_t ctxsz;
 137   size_t blksz;
 138   void (*init)(void *ctx, const void *k, size_t sz);
 139   void (*eblk)(const void *ctx, const void *in, void *out);
 140   void (*dblk)(const void *ctx, const void *in, void *out);
 141 } PRPClass;
 142
 143 typedef struct PRP {
 144   PRPClass *c;
 145 } PRP;
 146
 147 extern PRPClass *const prptab[];
 148
 149 struct randtab { const char *name; grand *(*rand)(const void *, size_t); };
 150
 151 typedef const octet keysize;
 152 typedef gmac gMAC;
 153 typedef gcmac gcMAC;
 154
 155 typedef grand Rand_True, Rand_DSA;
 156
 157 typedef rsa_pubctx RSA_Public;
 158 typedef rsa_privctx RSA_Private;
 159
 160 typedef gfshare Share_GF;
 161 typedef share Share_Prime;
 162
 163 extern const struct randtab mgftab[], ctrtab[], ofbtab[];
 164
 165 extern void gdsa_privfromsv(gdsa *g, SV *sv);
 166 extern void gdsa_pubfromsv(gdsa *g, SV *sv);
 167 extern SV *findrand(const struct randtab *rt, const char *cls,
 168                     const char *name, SV *k);
 169 extern void listrand(const struct randtab *rt);
 170
 171 /*------ Key mangling -----------------------------------------------------*/
 172
 173 typedef struct Key_File {
 174   unsigned ref;
 175   key_file kf;
 176 } Key_File;
 177
 178 typedef struct Key {
 179   Key_File *kf;
 180   key *k;
 181 } Key;
 182 typedef struct Key_AttrIter {
 183   Key_File *kf;
 184   key_attriter i;
 185 } Key_AttrIter;
 186
 187 typedef int KeyErr;
 188 typedef key_data Key_Data;
 189 typedef struct Key_FileIter {
 190   Key_File *kf;
 191   key_iter i;
 192 } Key_FileIter;
 193 typedef sym_iter Key_StructIter;
 194 typedef key_filter Key_Filter;
 195
 196 extern void keyreport(const char *file, int line, const char *err, void *p);
 197 extern const char *keydata_type(Key_Data *kd);
 198 extern SV *keyerr(int rc);
 199
 200 /*------ Multiprecision maths ---------------------------------------------*/
 201
 202 typedef mp gf;
 203 typedef mpmont MP_Mont;
 204 typedef mpbarrett MP_Barrett;
 205 typedef mpcrt MP_CRT;
 206
 207 typedef mpreduce MP_Reduce;
 208 typedef gfreduce GF_Reduce;
 209
 210 typedef ec_curve EC_Curve;
 211 typedef field Field;
 212 typedef mp fe;
 213
 214 typedef group Group;
 215
 216 #define XSINTERFACE_FUNC_SETMP(cv, f) \
 217   CvXSUBANY(cv).any_dptr = (void (*) _((void *)))(mp_##f)
 218 #define XSINTERFACE_FUNC_SETGF(cv, f) \
 219   CvXSUBANY(cv).any_dptr = (void (*) _((void *)))(gf_##f)
 220
 221 #define SET_MP(sv, x) SET(sv, x, "Catacomb::MP")
 222 #define MAKE_MP(x) MAKE(x, "Catacomb::MP")
 223 #define RET_MP(x) RET(x, "Catacomb::MP")
 224
 225 #define SET_GF(sv, x) SET(sv, x, "Catacomb::GF")
 226 #define MAKE_GF(x) MAKE(x, "Catacomb::GF")
 227 #define RET_GF(x) RET(x, "Catacomb::GF")
 228
 229 extern mp *mp_fromiv(mp *d, IV iv);
 230 extern IV mp_toiv(mp *x);
 231 extern mp *mp_readsv(mp *m, SV *sv, STRLEN *off, int radix);
 232 extern int mp_writesv(mp *m, SV *sv, int radix);
 233 extern mp *mp_fromsv(SV *sv, const char *what, int radix, int keep, ...);
 234 extern int group_writesv(group *g, ge *x, SV *sv);
 235
 236 /*----- Prime generation --------------------------------------------------*/
 237
 238 typedef struct { pfilt pf; int rc; } MP_Prime_Filter;
 239 typedef rabin MP_Prime_Rabin;
 240 typedef SV MP_Prime_Gen_Proc, MP_Prime_Gen_NullProc;
 241 typedef struct { pgen_proc *p; void *ctx; } pgmagic, MP_Prime_Gen_MagicProc;
 242 typedef struct { pgmagic mg; pgen_filterctx f; } MP_Prime_Gen_FilterStepper;
 243 typedef struct { pgmagic mg; pgen_jumpctx j; pfilt pf; }
 244   MP_Prime_Gen_JumpStepper;
 245 typedef struct { pgmagic mg; rabin r; } MP_Prime_Gen_RabinTester;
 246 typedef struct pgen_event MP_Prime_Gen_Event;
 247
 248 extern void pgproc_get(SV *sv, pgen_proc **p, void **ctx);
 249
 250 /*----- Other gear --------------------------------------------------------*/
 251
 252 extern void names(const char *name);
 253
 254 extern SV *info_field(field *f);
 255 extern SV *info_curve(ec_curve *c);
 256 extern SV *info_group(group *g);
 257
 258 extern field *copy_field(field *f);
 259 extern ec_curve *copy_curve(ec_curve *c);
 260 extern group *copy_group(group *g);
 261
 262 /*----- That's all, folks -------------------------------------------------*/
 263
 264 #ifdef __cplusplus
 265   }
 266 #endif
 267
 268 #endif