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

   1 /* -*-c-*-
   2  *
   3  * $Id$
   4  *
   5  * Definitions for Catacomb bindings
   6  *
   7  * (c) 2004 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of the Python interface to Catacomb.
  13  *
  14  * Catacomb/Python 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/Python 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/Python; 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_PYTHON_H
  30 #define CATACOMB_PYTHON_H
  31
  32 #ifdef __cplusplus
  33   extern "C" {
  34 #endif
  35
  36 /*----- Header files ------------------------------------------------------*/
  37
  38 #include <Python.h>
  39 #include <longintrepr.h>
  40 #include <structmember.h>
  41
  42 #include <mLib/darray.h>
  43 #include <mLib/dstr.h>
  44 #include <mLib/macros.h>
  45
  46 #include <catacomb/buf.h>
  47
  48 #include <catacomb/grand.h>
  49 #include <catacomb/rand.h>
  50 #include <catacomb/noise.h>
  51 #include <catacomb/bbs.h>
  52 #include <catacomb/mprand.h>
  53 #include <catacomb/lcrand.h>
  54 #include <catacomb/fibrand.h>
  55 #include <catacomb/dsarand.h>
  56 #include <catacomb/sslprf.h>
  57 #include <catacomb/tlsprf.h>
  58
  59 #include <catacomb/gcipher.h>
  60 #include <catacomb/ghash.h>
  61 #include <catacomb/gmac.h>
  62 #include <catacomb/md5.h>
  63 #include <catacomb/md5-hmac.h>
  64 #include <catacomb/sha.h>
  65 #include <catacomb/sha-mgf.h>
  66 #include <catacomb/sha-hmac.h>
  67
  68 #include <catacomb/mp.h>
  69 #include <catacomb/mpint.h>
  70 #include <catacomb/mpmul.h>
  71 #include <catacomb/mpcrt.h>
  72 #include <catacomb/mpmont.h>
  73 #include <catacomb/mpbarrett.h>
  74 #include <catacomb/mpreduce.h>
  75
  76 #include <catacomb/pgen.h>
  77 #include <catacomb/pfilt.h>
  78 #include <catacomb/strongprime.h>
  79 #include <catacomb/limlee.h>
  80 #include <catacomb/dh.h>
  81 #include <catacomb/ptab.h>
  82 #include <catacomb/bintab.h>
  83 #include <catacomb/dsa.h>
  84
  85 #include <catacomb/gf.h>
  86 #include <catacomb/gfreduce.h>
  87 #include <catacomb/gfn.h>
  88
  89 #include <catacomb/field.h>
  90 #include <catacomb/field-guts.h>
  91
  92 #include <catacomb/ec.h>
  93 #include <catacomb/ec-raw.h>
  94 #include <catacomb/ectab.h>
  95
  96 #include <catacomb/group.h>
  97 #include <catacomb/group-guts.h>
  98
  99 #include <catacomb/gdsa.h>
 100 #include <catacomb/gkcdsa.h>
 101 #include <catacomb/rsa.h>
 102
 103 #include <catacomb/key.h>
 104 #include <catacomb/passphrase.h>
 105 #include <catacomb/pixie.h>
 106
 107 /*----- Utility macros ----------------------------------------------------*/
 108
 109 #define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
 110 #define RETURN_NONE RETURN_OBJ(Py_None)
 111 #define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
 112 #define RETURN_TRUE RETURN_OBJ(Py_True)
 113 #define RETURN_FALSE RETURN_OBJ(Py_False)
 114 #define RETURN_ME RETURN_OBJ(me)
 115
 116 #define EXCERR(exc, str) do {                                           \
 117   PyErr_SetString(exc, str);                                            \
 118   goto end;                                                             \
 119 } while (0)
 120 #define VALERR(str) EXCERR(PyExc_ValueError, str)
 121 #define TYERR(str) EXCERR(PyExc_TypeError, str)
 122 #define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
 123 #define SYNERR(str) EXCERR(PyExc_SyntaxError, str)
 124 #define SYSERR(str) EXCERR(PyExc_SystemError, str)
 125 #define OSERR(name) do {                                                \
 126   PyErr_SetFromErrnoWithFilename(PyExc_OSError, name);                  \
 127   goto end;                                                             \
 128 } while (0)
 129 #define PGENERR do { pgenerr(); goto end; } while (0)
 130
 131 #define CONVFUNC(ty, cty, ext)                                          \
 132   int conv##ty(PyObject *o, void *p)                                    \
 133   {                                                                     \
 134     if (!PyObject_TypeCheck(o, ty##_pytype))                            \
 135       TYERR("wanted a " #ty);                                           \
 136     *(cty *)p = ext(o);                                                 \
 137     return (1);                                                         \
 138   end:                                                                  \
 139     return (0);                                                         \
 140   }
 141
 142 #define root_pytype 0
 143 #define type_pytype &PyType_Type
 144 #define INITTYPE(ty, base) do {                                         \
 145   ty##_pytype_skel.tp_base = base##_pytype;                             \
 146   ty##_pytype = inittype(&ty##_pytype_skel);                            \
 147 } while (0)
 148
 149 #define INSERT(name, ob) do {                                           \
 150   PyObject *_o = (PyObject *)(ob);                                      \
 151   Py_INCREF(_o);                                                        \
 152   PyModule_AddObject(mod, name, _o);                                    \
 153 } while (0)
 154
 155 #define METH(func, doc)                                                 \
 156   { #func, METHNAME(func), METH_VARARGS, doc },
 157 #define KWMETH(func, doc)                                               \
 158   { #func, (PyCFunction)METHNAME(func),                                 \
 159     METH_VARARGS | METH_KEYWORDS, doc },
 160
 161 #define GET(func, doc)                                                  \
 162   { #func, GETSETNAME(get, func), 0, doc },
 163 #define GETSET(func, doc)                                               \
 164   { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
 165
 166 #define MEMBER(name, ty, f, doc)                                        \
 167   { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
 168
 169 #define MODULES(DO)                                                     \
 170   DO(bytestring)                                                        \
 171   DO(rand) DO(algorithms) DO(pubkey) DO(pgen)                           \
 172   DO(mp) DO(field) DO(ec) DO(group)                                     \
 173   DO(passphrase)
 174 #define DOMODINIT(m) m##_pyinit();
 175 #define DOMODINSERT(m) m##_pyinsert(mod);
 176 #define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
 177 #define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
 178
 179 #define DO(m)                                                           \
 180   extern void m##_pyinit(void);                                         \
 181   extern void m##_pyinsert(PyObject *);
 182 MODULES(DO)
 183 #undef DO
 184
 185 #define FREEOBJ(obj)                                                    \
 186   (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
 187
 188 /*----- Bytestrings -------------------------------------------------------*/
 189
 190 PyTypeObject *bytestring_pyobj;
 191 PyObject *bytestring_pywrap(const void *, size_t);
 192 PyObject *bytestring_pywrapbuf(buf *);
 193
 194 /*----- Multiprecision arithmetic -----------------------------------------*/
 195
 196 typedef struct mp_pyobj {
 197   PyObject_HEAD
 198   mp *x;
 199 } mp_pyobj;
 200
 201 extern PyTypeObject *mp_pytype;
 202 extern PyTypeObject *gf_pytype;
 203 #define MP_X(o) (((mp_pyobj *)(o))->x)
 204 #define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
 205 #define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
 206
 207 extern mp *mp_frompylong(PyLongObject *);
 208 extern PyLongObject *mp_topylong(mp *);
 209 extern mp *tomp(PyObject *);
 210 extern mp *getmp(PyObject *);
 211 extern int convmp(PyObject *, void *);
 212 extern mp *getgf(PyObject *);
 213 extern int convgf(PyObject *, void *);
 214 extern PyObject *mp_pywrap(mp *);
 215 extern PyObject *gf_pywrap(mp *);
 216 extern mp *mp_frompyobject(PyObject *, int);
 217 extern PyObject *mp_topystring(mp *, int,
 218                                const char *, const char *, const char *);
 219 extern int mp_tolong_checked(mp *, long *);
 220
 221 /*----- Abstract fields ---------------------------------------------------*/
 222
 223 typedef struct field_pyobj {
 224   PyHeapTypeObject ty;
 225   field *f;
 226 } field_pyobj;
 227
 228 extern PyTypeObject *fe_pytype;
 229 #define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
 230 #define FE_F(o) (((fe_pyobj *)(o))->f)
 231 #define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
 232 #define FE_X(o) (((fe_pyobj *)(o))->x)
 233 extern PyObject *fe_pywrap(PyObject *, mp *);
 234 extern mp *getfe(field *, PyObject *);
 235
 236 typedef struct fe_pyobj {
 237   PyObject_HEAD
 238   field *f;
 239   PyObject *fobj; /* to keep it alive */
 240   mp *x;
 241 } fe_pyobj;
 242
 243 extern PyTypeObject *field_pytype;
 244 extern PyTypeObject *primefield_pytype;
 245 extern PyTypeObject *niceprimefield_pytype;
 246 extern PyTypeObject *binfield_pytype;
 247 extern PyTypeObject *binpolyfield_pytype;
 248 extern PyTypeObject *binnormfield_pytype;
 249 #define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
 250 #define FIELD_F(o) (((field_pyobj *)(o))->f)
 251 extern PyObject *field_pywrap(field *);
 252 extern field *field_copy(field *);
 253
 254 /*----- Elliptic curves ---------------------------------------------------*/
 255
 256 typedef struct ecpt_pyobj {
 257   PyObject_HEAD
 258   ec_curve *c;
 259   ec p;
 260 } ecpt_pyobj;
 261
 262 extern PyTypeObject *ecpt_pytype, *ecptcurve_pytype;
 263 #define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
 264 #define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
 265 #define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
 266 #define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
 267 #define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
 268 #define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
 269 extern PyObject *ecpt_pywrap(PyObject *, ec *);
 270 extern PyObject *ecpt_pywrapout(void *, ec *);
 271 extern int toecpt(ec_curve *, ec *, PyObject *);
 272 extern int getecpt(ec_curve *, ec *, PyObject *);
 273 extern void getecptout(ec *, PyObject *);
 274 extern int convec(PyObject *, void *);
 275
 276 typedef struct eccurve_pyobj {
 277   PyHeapTypeObject ty;
 278   ec_curve *c;
 279   PyObject *fobj;
 280 } eccurve_pyobj;
 281
 282 extern PyTypeObject *eccurve_pytype;
 283 extern PyTypeObject *ecprimecurve_pytype;
 284 extern PyTypeObject *ecprimeprojcurve_pytype;
 285 extern PyTypeObject *ecbincurve_pytype;
 286 extern PyTypeObject *ecbinprojcurve_pytype;
 287 #define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
 288 #define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
 289 #define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
 290 extern PyObject *eccurve_pywrap(PyObject *, ec_curve *);
 291 extern ec_curve *eccurve_copy(ec_curve *);
 292
 293 typedef struct ecinfo_pyobj {
 294   PyObject_HEAD
 295   ec_info ei;
 296   PyObject *cobj;
 297 } ecinfo_pyobj;
 298
 299 extern PyTypeObject *ecinfo_pytype;
 300 #define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
 301 #define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
 302 #define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
 303 extern void ecinfo_copy(ec_info *, const ec_info *);
 304 extern PyObject *ecinfo_pywrap(ec_info *);
 305
 306 /*----- Cyclic groups -----------------------------------------------------*/
 307
 308 typedef struct fginfo_pyobj {
 309   PyObject_HEAD
 310   gprime_param dp;
 311 } fginfo_pyobj;
 312
 313 PyTypeObject *fginfo_pytype, *dhinfo_pytype, *bindhinfo_pytype;
 314 #define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
 315 PyObject *fginfo_pywrap(gprime_param *, PyTypeObject *);
 316
 317 typedef struct ge_pyobj {
 318   PyObject_HEAD
 319   ge *x;
 320   group *g;
 321 } ge_pyobj;
 322
 323 extern PyTypeObject *ge_pytype;
 324 #define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
 325 #define GE_X(o) (((ge_pyobj *)(o))->x)
 326 #define GE_G(o) (((ge_pyobj *)(o))->g)
 327 #define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
 328 extern PyObject *ge_pywrap(PyObject *, ge *);
 329
 330 typedef struct group_pyobj {
 331   PyHeapTypeObject ty;
 332   group *g;
 333 } group_pyobj;
 334
 335 extern PyTypeObject *group_pytype;
 336 extern PyTypeObject *primegroup_pytype, *bingroup_pytype, *ecgroup_pytype;
 337 #define GROUP_G(o) (((group_pyobj *)(o))->g)
 338 extern PyObject *group_pywrap(group *);
 339 extern group *group_copy(group *);
 340
 341 /*----- Random number generators ------------------------------------------*/
 342
 343 #define f_freeme 1u
 344
 345 typedef struct grand_pyobj {
 346   PyObject_HEAD
 347   unsigned f;
 348   grand *r;
 349 } grand_pyobj;
 350
 351 extern PyTypeObject *grand_pytype, *truerand_pytype;
 352 extern PyTypeObject *lcrand_pytype,* fibrand_pytype;
 353 extern PyTypeObject *dsarand_pytype, *bbs_pytype;
 354 extern PyObject *rand_pyobj;
 355 #define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
 356 #define GRAND_F(o) (((grand_pyobj *)(o))->f)
 357 #define GRAND_R(o) (((grand_pyobj *)(o))->r)
 358 extern PyObject *grand_pywrap(grand *, unsigned);
 359 extern int convgrand(PyObject *, void *);
 360
 361 /*----- Key sizes ---------------------------------------------------------*/
 362
 363 typedef struct keysz_pyobj {
 364   PyObject_HEAD
 365   int dfl;
 366 } keysz_pyobj;
 367
 368 typedef struct keyszrange_pyobj {
 369   PyObject_HEAD
 370   int dfl;
 371   int min, max, mod;
 372 } keyszrange_pyobj;
 373
 374 typedef struct keyszset_pyobj {
 375   PyObject_HEAD
 376   int dfl;
 377   PyObject *set;
 378 } keyszset_pyobj;
 379
 380 #define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
 381 extern PyObject *keysz_pywrap(const octet *);
 382
 383 /*----- Symmetric cryptography --------------------------------------------*/
 384
 385 typedef struct gccipher_pyobj {
 386   PyHeapTypeObject ty;
 387   gccipher *cc;
 388 } gccipher_pyobj;
 389
 390 extern PyTypeObject *gccipher_pytype;
 391 #define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
 392 #define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
 393 #define GCCIPHER_F(o) (((gccipher_pyobj *)(o))->f)
 394 extern PyObject *gccipher_pywrap(gccipher *);
 395 extern int convgccipher(PyObject *, void *);
 396 extern int convgcipher(PyObject *, void *);
 397
 398 typedef struct gcipher_pyobj {
 399   PyObject_HEAD
 400   unsigned f;
 401   gcipher *c;
 402 } gcipher_pyobj;
 403
 404 extern PyTypeObject *gcipher_pytype;
 405 #define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
 406 #define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
 407 #define GCIPHER_F(o) (((gcipher_pyobj *)(o))->f)
 408 extern PyObject *gcipher_pywrap(PyObject *, gcipher *, unsigned);
 409 extern int convgcipher(PyObject *, void *);
 410
 411 typedef struct gchash_pyobj {
 412   PyHeapTypeObject ty;
 413   gchash *ch;
 414 } gchash_pyobj;
 415
 416 extern PyTypeObject *gchash_pytype;
 417 #define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
 418 #define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
 419 #define GCHASH_F(o) (((gchash_pyobj *)(o))->f)
 420 extern PyObject *gchash_pywrap(gchash *);
 421 extern int convgchash(PyObject *, void *);
 422
 423 typedef struct ghash_pyobj {
 424   PyObject_HEAD
 425   unsigned f;
 426   ghash *h;
 427 } ghash_pyobj;
 428
 429 extern PyTypeObject *ghash_pytype, *gmhash_pytype;
 430 extern PyObject *sha_pyobj, *has160_pyobj;
 431 #define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
 432 #define GHASH_H(o) (((ghash_pyobj *)(o))->h)
 433 #define GHASH_F(o) (((ghash_pyobj *)(o))->f)
 434 extern PyObject *ghash_pywrap(PyObject *, ghash *, unsigned);
 435 extern int convghash(PyObject *, void *);
 436 extern int convgmhash(PyObject *, void *);
 437
 438 typedef struct gcmac_pyobj {
 439   PyHeapTypeObject ty;
 440   gcmac *cm;
 441 } gcmac_pyobj;
 442
 443 extern PyTypeObject *gcmac_pytype;
 444 #define GCMAC_PYCHECK(o) PyObject_TypeCheck((o), gcmac_pytype)
 445 #define GCMAC_CM(o) (((gcmac_pyobj *)(o))->cm)
 446 #define GCMAC_F(o) (((gcmac_pyobj *)(o))->f)
 447 extern PyObject *gcmac_pywrap(gcmac *);
 448 extern int convgcmac(PyObject *, void *);
 449
 450 typedef struct gmac_pyobj {
 451   PyHeapTypeObject ty;
 452   unsigned f;
 453   gmac *m;
 454 } gmac_pyobj;
 455
 456 extern PyTypeObject *gmac_pytype;
 457 #define GMAC_PYCHECK(o) PyObject_TypeCheck((o), gmac_pytype)
 458 #define GMAC_M(o) (((gmac_pyobj *)(o))->m)
 459 #define GMAC_F(o) (((gmac_pyobj *)(o))->f)
 460 extern PyObject *gmac_pywrap(PyObject *, gmac *, unsigned);
 461 extern int convgmac(PyObject *, void *);
 462
 463 /*----- Public key crypto -------------------------------------------------*/
 464
 465 /*----- Key generation ----------------------------------------------------*/
 466
 467 typedef struct pfilt_pyobj {
 468   PyObject_HEAD
 469   pfilt f;
 470   int st;
 471 } pfilt_pyobj;
 472
 473 extern PyTypeObject *pfilt_pytype;
 474 #define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
 475 #define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
 476 #define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
 477
 478 typedef struct { pgen_proc *proc; void *ctx; } pgev;
 479 #define PGEV_HEAD PyObject_HEAD pgev pg;
 480
 481 typedef struct pgev_pyobj {
 482   PGEV_HEAD
 483 } pgev_pyobj;
 484
 485 extern PyTypeObject *pgev_pytype;
 486 #define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
 487 #define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
 488
 489 extern int convpgev(PyObject *, void *);
 490 extern void droppgev(pgev *);
 491 extern void pgenerr(void);
 492
 493 /*----- Core utility functions --------------------------------------------*/
 494
 495 extern PyObject *mexp_common(PyObject *, PyObject *, size_t,
 496                              PyObject *(*id)(PyObject *),
 497                              int (*fill)(void *, PyObject *,
 498                                          PyObject *, PyObject *),
 499                              PyObject *(*exp)(PyObject *, void *, int),
 500                              void (*drop)(void *));
 501
 502 extern int convulong(PyObject *, void *);
 503 extern int convu32(PyObject *, void *);
 504 extern int convmpw(PyObject *, void *);
 505 extern int convuint(PyObject *, void *);
 506 extern int convszt(PyObject *, void *);
 507 extern int convbool(PyObject *, void *);
 508 extern PyObject *abstract_pynew(PyTypeObject *, PyObject *, PyObject *);
 509 extern PyObject *getbool(int);
 510 extern PyObject *getu32(uint32);
 511 extern void *newtype(PyTypeObject *, const PyTypeObject *, const char *);
 512 extern PyTypeObject *inittype(PyTypeObject *);
 513 extern void addmethods(const PyMethodDef *);
 514
 515 /*----- That's all, folks -------------------------------------------------*/
 516
 517 #ifdef __cplusplus
 518   }
 519 #endif
 520
 521 #endif