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