3 * Definitions for Catacomb bindings
5 * (c) 2004 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of the Python interface to Catacomb.
12 * Catacomb/Python is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * Catacomb/Python is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with Catacomb/Python; if not, write to the Free Software Foundation,
24 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 #ifndef CATACOMB_PYTHON_H
28 #define CATACOMB_PYTHON_H
34 /*----- Header files ------------------------------------------------------*/
36 #define PY_SSIZE_T_CLEAN
39 #include <longintrepr.h>
40 #include <structmember.h>
42 #include <mLib/darray.h>
43 #include <mLib/dstr.h>
44 #include <mLib/macros.h>
45 #include <mLib/quis.h>
46 #include <mLib/unihash.h>
48 #include <catacomb/buf.h>
49 #include <catacomb/ct.h>
51 #include <catacomb/grand.h>
52 #include <catacomb/rand.h>
53 #include <catacomb/noise.h>
54 #include <catacomb/bbs.h>
55 #include <catacomb/mprand.h>
56 #include <catacomb/lcrand.h>
57 #include <catacomb/fibrand.h>
58 #include <catacomb/dsarand.h>
59 #include <catacomb/sslprf.h>
60 #include <catacomb/tlsprf.h>
61 #include <catacomb/blkc.h>
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/poly1305.h>
69 #include <catacomb/sha.h>
70 #include <catacomb/sha-mgf.h>
71 #include <catacomb/sha-hmac.h>
72 #include <catacomb/keccak1600.h>
73 #include <catacomb/sha3.h>
75 #include <catacomb/mp.h>
76 #include <catacomb/mpint.h>
77 #include <catacomb/mpmul.h>
78 #include <catacomb/mpcrt.h>
79 #include <catacomb/mpmont.h>
80 #include <catacomb/mpbarrett.h>
81 #include <catacomb/mpreduce.h>
82 #include <catacomb/mp-fibonacci.h>
84 #include <catacomb/pgen.h>
85 #include <catacomb/pfilt.h>
86 #include <catacomb/strongprime.h>
87 #include <catacomb/limlee.h>
88 #include <catacomb/dh.h>
89 #include <catacomb/ptab.h>
90 #include <catacomb/bintab.h>
91 #include <catacomb/dsa.h>
92 #include <catacomb/x25519.h>
93 #include <catacomb/x448.h>
94 #include <catacomb/ed25519.h>
95 #include <catacomb/ed448.h>
97 #include <catacomb/gf.h>
98 #include <catacomb/gfreduce.h>
99 #include <catacomb/gfn.h>
101 #include <catacomb/field.h>
102 #include <catacomb/field-guts.h>
104 #include <catacomb/ec.h>
105 #include <catacomb/ec-raw.h>
106 #include <catacomb/ectab.h>
108 #include <catacomb/group.h>
109 #include <catacomb/group-guts.h>
111 #include <catacomb/gdsa.h>
112 #include <catacomb/gkcdsa.h>
113 #include <catacomb/rsa.h>
115 #include <catacomb/key.h>
116 #include <catacomb/passphrase.h>
117 #include <catacomb/pixie.h>
119 #include <catacomb/share.h>
120 #include <catacomb/gfshare.h>
122 /*----- Utility macros ----------------------------------------------------*/
124 #define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
125 #define RETURN_NONE RETURN_OBJ(Py_None)
126 #define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
127 #define RETURN_TRUE RETURN_OBJ(Py_True)
128 #define RETURN_FALSE RETURN_OBJ(Py_False)
129 #define RETURN_ME RETURN_OBJ(me)
131 #define EXCERR(exc, str) do { \
132 PyErr_SetString(exc, str); \
135 #define VALERR(str) EXCERR(PyExc_ValueError, str)
136 #define TYERR(str) EXCERR(PyExc_TypeError, str)
137 #define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
138 #define SYSERR(str) EXCERR(PyExc_SystemError, str)
139 #define NIERR(str) EXCERR(PyExc_NotImplementedError, str)
140 #define INDEXERR(idx) do { \
141 PyErr_SetObject(PyExc_KeyError, idx); \
144 #define OSERR(name) do { \
145 PyErr_SetFromErrnoWithFilename(PyExc_OSError, name); \
148 #define PGENERR do { pgenerr(); goto end; } while (0)
150 #define CONVFUNC(ty, cty, ext) \
151 int conv##ty(PyObject *o, void *p) \
153 if (!PyObject_TypeCheck(o, ty##_pytype)) \
154 TYERR("wanted a " #ty); \
155 *(cty *)p = ext(o); \
161 #if PY_VERSION_HEX < 0x02050000 /* Compatibility hack */
162 # define ht_name name
163 # define ht_type type
166 #define root_pytype 0
167 #define type_pytype &PyType_Type
168 #define INITTYPE_META(ty, base, meta) do { \
169 ty##_pytype_skel.tp_base = base##_pytype; \
170 ty##_pytype = inittype(&ty##_pytype_skel, meta##_pytype); \
172 #define INITTYPE(ty, base) INITTYPE_META(ty, base, type)
174 #define INSERT(name, ob) do { \
175 PyObject *_o = (PyObject *)(ob); \
177 PyModule_AddObject(mod, name, _o); \
180 #define INSEXC(name, var, base, meth) \
181 INSERT(name, var = mkexc(mod, base, name, meth))
183 #define METH(func, doc) \
184 { #func, METHNAME(func), METH_VARARGS, doc },
185 #define KWMETH(func, doc) \
186 { #func, (PyCFunction)METHNAME(func), \
187 METH_VARARGS | METH_KEYWORDS, doc },
189 #define GET(func, doc) \
190 { #func, GETSETNAME(get, func), 0, doc },
191 #define GETSET(func, doc) \
192 { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
194 #define MEMBER(name, ty, f, doc) \
195 { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
199 _(bytestring) _(buffer) \
200 _(rand) _(algorithms) _(pubkey) _(pgen) \
201 _(mp) _(field) _(ec) _(group) \
202 _(passphrase) _(share) _(key)
203 #define DOMODINIT(m) m##_pyinit();
204 #define DOMODINSERT(m) m##_pyinsert(mod);
205 #define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
206 #define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
209 extern void m##_pyinit(void); \
210 extern void m##_pyinsert(PyObject *);
214 #define FREEOBJ(obj) \
215 (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
217 #define GEN(func, base) \
218 static PyObject *func(void) \
220 PyObject *d = PyDict_New(); \
224 for (i = 0; g##base##tab[i]; i++) { \
225 o = gc##base##_pywrap((/*unconst*/ gc##base *)g##base##tab[i]); \
226 PyDict_SetItemString(d, \
227 (/*unconst*/ char *)g##base##tab[i]->name, \
234 struct nameval { const char *name; unsigned long value; };
235 extern void setconstants(PyObject *, const struct nameval *);
237 extern PyObject *mexp_common(PyObject *, PyObject *, size_t,
238 PyObject *(*id)(PyObject *),
239 int (*fill)(void *, PyObject *,
240 PyObject *, PyObject *),
241 PyObject *(*exp)(PyObject *, void *, int),
242 void (*drop)(void *));
244 extern int convulong(PyObject *, void *);
245 #define DECL_CONVU_(n) extern int convu##n(PyObject *, void *);
246 DOUINTSZ(DECL_CONVU_)
247 extern int convmpw(PyObject *, void *);
248 extern int convuint(PyObject *, void *);
249 extern int convk64(PyObject *, void *);
250 extern int convszt(PyObject *, void *);
251 extern int convbool(PyObject *, void *);
252 extern PyObject *abstract_pynew(PyTypeObject *, PyObject *, PyObject *);
253 extern PyObject *getbool(int);
254 extern PyObject *getulong(unsigned long);
255 extern PyObject *getk64(kludge64);
256 extern void *newtype(PyTypeObject *, const PyTypeObject *, const char *);
258 extern PyObject *mkexc(PyObject *, PyObject *, const char *, PyMethodDef *);
259 extern void typeready(PyTypeObject *);
260 extern PyTypeObject *inittype(PyTypeObject *, PyTypeObject *);
261 extern void addmethods(const PyMethodDef *);
262 extern PyMethodDef *donemethods(void);
264 /*----- Mapping methods ---------------------------------------------------*/
266 #define GMAP_METH(func, doc) { #func, gmapmeth_##func, METH_VARARGS, doc },
267 #define GMAP_KWMETH(func, doc) \
268 { #func, (PyCFunction)gmapmeth_##func, METH_VARARGS|METH_KEYWORDS, doc },
269 #define GMAP_METHDECL(func, doc) \
270 extern PyObject *gmapmeth_##func(PyObject *, PyObject *);
271 #define GMAP_KWMETHDECL(func, doc) \
272 extern PyObject *gmapmeth_##func(PyObject *, PyObject *, PyObject *);
274 #define GMAP_DOROMETHODS(METH, KWMETH) \
275 METH (has_key, "D.has_key(KEY) -> BOOL") \
276 METH (keys, "D.keys() -> LIST") \
277 METH (values, "D.values() -> LIST") \
278 METH (items, "D.items() -> LIST") \
279 METH (iterkeys, "D.iterkeys() -> ITER") \
280 METH (itervalues, "D.itervalues() -> ITER") \
281 METH (iteritems, "D.iteritems() -> ITER") \
282 KWMETH(get, "D.get(KEY, [default = None]) -> VALUE") \
284 #define GMAP_DOMETHODS(METH, KWMETH) \
285 GMAP_DOROMETHODS(METH, KWMETH) \
286 METH (clear, "D.clear()") \
287 KWMETH(setdefault, "D.setdefault(K, [default = None]) -> VALUE") \
288 KWMETH(pop, "D.pop(KEY, [default = <error>]) -> VALUE") \
289 METH (popitem, "D.popitem() -> (KEY, VALUE)") \
290 METH (update, "D.update(MAP)")
292 GMAP_DOMETHODS(GMAP_METHDECL, GMAP_KWMETHDECL)
293 #define GMAP_ROMETHODS GMAP_DOROMETHODS(GMAP_METH, GMAP_KWMETH)
294 #define GMAP_METHODS GMAP_DOMETHODS(GMAP_METH, GMAP_KWMETH)
295 extern Py_ssize_t gmap_pysize(PyObject *);
296 extern PySequenceMethods gmap_pysequence;
297 extern PyMethodDef gmap_pymethods[];
299 /*----- Bytestrings -------------------------------------------------------*/
301 PyTypeObject *bytestring_pyobj;
302 PyObject *bytestring_pywrap(const void *, size_t);
303 PyObject *bytestring_pywrapbuf(buf *);
305 /*----- Multiprecision arithmetic -----------------------------------------*/
307 typedef struct mp_pyobj {
312 extern PyTypeObject *mp_pytype;
313 extern PyTypeObject *gf_pytype;
314 #define MP_X(o) (((mp_pyobj *)(o))->x)
315 #define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
316 #define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
318 extern mp *mp_frompylong(PyObject *);
319 extern PyObject *mp_topylong(mp *);
320 extern mp *tomp(PyObject *);
321 extern mp *getmp(PyObject *);
322 extern int convmp(PyObject *, void *);
323 extern mp *getgf(PyObject *);
324 extern int convgf(PyObject *, void *);
325 extern PyObject *mp_pywrap(mp *);
326 extern PyObject *gf_pywrap(mp *);
327 extern mp *mp_frompyobject(PyObject *, int);
328 extern PyObject *mp_topystring(mp *, int,
329 const char *, const char *, const char *);
330 extern int mp_tolong_checked(mp *, long *, int);
332 /*----- Abstract fields ---------------------------------------------------*/
334 typedef struct field_pyobj {
339 extern PyTypeObject *fe_pytype;
340 #define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
341 #define FE_F(o) (((fe_pyobj *)(o))->f)
342 #define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
343 #define FE_X(o) (((fe_pyobj *)(o))->x)
344 extern PyObject *fe_pywrap(PyObject *, mp *);
345 extern mp *getfe(field *, PyObject *);
347 typedef struct fe_pyobj {
353 extern PyTypeObject *field_pytype;
354 extern PyTypeObject *primefield_pytype;
355 extern PyTypeObject *niceprimefield_pytype;
356 extern PyTypeObject *binfield_pytype;
357 extern PyTypeObject *binpolyfield_pytype;
358 extern PyTypeObject *binnormfield_pytype;
359 #define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
360 #define FIELD_F(o) (((field_pyobj *)(o))->f)
361 extern PyObject *field_pywrap(field *);
362 extern field *field_copy(field *);
364 /*----- Elliptic curves ---------------------------------------------------*/
366 typedef struct ecpt_pyobj {
372 extern PyTypeObject *ecpt_pytype, *ecptcurve_pytype;
373 #define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
374 #define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
375 #define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
376 #define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
377 #define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
378 #define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
379 extern PyObject *ecpt_pywrap(PyObject *, ec *);
380 extern PyObject *ecpt_pywrapout(void *, ec *);
381 extern int toecpt(ec_curve *, ec *, PyObject *);
382 extern int getecpt(ec_curve *, ec *, PyObject *);
383 extern void getecptout(ec *, PyObject *);
384 extern int convecpt(PyObject *, void *);
386 typedef struct eccurve_pyobj {
392 extern PyTypeObject *eccurve_pytype;
393 extern PyTypeObject *ecprimecurve_pytype;
394 extern PyTypeObject *ecprimeprojcurve_pytype;
395 extern PyTypeObject *ecbincurve_pytype;
396 extern PyTypeObject *ecbinprojcurve_pytype;
397 #define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
398 #define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
399 #define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
400 extern PyObject *eccurve_pywrap(PyObject *, ec_curve *);
401 extern ec_curve *eccurve_copy(ec_curve *);
403 typedef struct ecinfo_pyobj {
409 extern PyTypeObject *ecinfo_pytype;
410 #define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
411 #define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
412 #define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
413 extern void ecinfo_copy(ec_info *, const ec_info *);
414 extern PyObject *ecinfo_pywrap(ec_info *);
416 /*----- Cyclic groups -----------------------------------------------------*/
418 typedef struct fginfo_pyobj {
423 PyTypeObject *fginfo_pytype, *dhinfo_pytype, *bindhinfo_pytype;
424 #define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
425 PyObject *fginfo_pywrap(gprime_param *, PyTypeObject *);
427 typedef struct ge_pyobj {
433 extern PyTypeObject *ge_pytype;
434 #define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
435 #define GE_X(o) (((ge_pyobj *)(o))->x)
436 #define GE_G(o) (((ge_pyobj *)(o))->g)
437 #define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
438 extern PyObject *ge_pywrap(PyObject *, ge *);
440 typedef struct group_pyobj {
445 extern PyTypeObject *group_pytype;
446 extern PyTypeObject *primegroup_pytype, *bingroup_pytype, *ecgroup_pytype;
447 #define GROUP_G(o) (((group_pyobj *)(o))->g)
448 extern PyObject *group_pywrap(group *);
449 extern group *group_copy(group *);
451 /*----- Random number generators ------------------------------------------*/
455 typedef struct grand_pyobj {
461 extern PyTypeObject *grand_pytype, *truerand_pytype;
462 extern PyTypeObject *lcrand_pytype,* fibrand_pytype;
463 extern PyTypeObject *dsarand_pytype, *bbs_pytype;
464 extern PyObject *rand_pyobj;
465 #define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
466 #define GRAND_F(o) (((grand_pyobj *)(o))->f)
467 #define GRAND_R(o) (((grand_pyobj *)(o))->r)
468 extern PyObject *grand_pywrap(grand *, unsigned);
469 extern int convgrand(PyObject *, void *);
471 /*----- Key sizes ---------------------------------------------------------*/
473 typedef struct keysz_pyobj {
478 typedef struct keyszrange_pyobj {
484 typedef struct keyszset_pyobj {
490 #define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
491 extern PyObject *keysz_pywrap(const octet *);
493 /*----- Symmetric cryptography --------------------------------------------*/
495 typedef struct gccipher_pyobj {
500 extern PyTypeObject *gccipher_pytype;
501 #define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
502 #define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
503 #define GCCIPHER_F(o) (((gccipher_pyobj *)(o))->f)
504 extern PyObject *gccipher_pywrap(gccipher *);
505 extern int convgccipher(PyObject *, void *);
506 extern int convgcipher(PyObject *, void *);
508 typedef struct gcipher_pyobj {
514 extern PyTypeObject *gcipher_pytype;
515 #define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
516 #define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
517 #define GCIPHER_F(o) (((gcipher_pyobj *)(o))->f)
518 extern PyObject *gcipher_pywrap(PyObject *, gcipher *, unsigned);
519 extern int convgcipher(PyObject *, void *);
521 typedef struct gchash_pyobj {
526 extern PyTypeObject *gchash_pytype;
527 #define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
528 #define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
529 #define GCHASH_F(o) (((gchash_pyobj *)(o))->f)
530 extern PyObject *gchash_pywrap(gchash *);
531 extern int convgchash(PyObject *, void *);
533 typedef struct ghash_pyobj {
539 extern PyTypeObject *ghash_pytype, *gmhash_pytype;
540 extern PyObject *sha_pyobj, *has160_pyobj;
541 #define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
542 #define GHASH_H(o) (((ghash_pyobj *)(o))->h)
543 #define GHASH_F(o) (((ghash_pyobj *)(o))->f)
544 extern PyObject *ghash_pywrap(PyObject *, ghash *, unsigned);
545 extern int convghash(PyObject *, void *);
546 extern int convgmhash(PyObject *, void *);
548 typedef struct gcmac_pyobj {
553 extern PyTypeObject *gcmac_pytype;
554 #define GCMAC_PYCHECK(o) PyObject_TypeCheck((o), gcmac_pytype)
555 #define GCMAC_CM(o) (((gcmac_pyobj *)(o))->cm)
556 #define GCMAC_F(o) (((gcmac_pyobj *)(o))->f)
557 extern PyObject *gcmac_pywrap(gcmac *);
558 extern int convgcmac(PyObject *, void *);
560 typedef struct gmac_pyobj {
566 extern PyTypeObject *gmac_pytype;
567 #define GMAC_PYCHECK(o) PyObject_TypeCheck((o), gmac_pytype)
568 #define GMAC_M(o) (((gmac_pyobj *)(o))->m)
569 #define GMAC_F(o) (((gmac_pyobj *)(o))->f)
570 extern PyObject *gmac_pywrap(PyObject *, gmac *, unsigned);
571 extern int convgmac(PyObject *, void *);
573 /*----- Key generation ----------------------------------------------------*/
575 typedef struct pfilt_pyobj {
581 extern PyTypeObject *pfilt_pytype;
582 #define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
583 #define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
584 #define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
586 typedef struct { pgen_proc *proc; void *ctx; } pgev;
587 #define PGEV_HEAD PyObject_HEAD pgev pg;
589 typedef struct pgev_pyobj {
593 extern PyTypeObject *pgev_pytype;
594 #define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
595 #define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
597 extern int convpgev(PyObject *, void *);
598 extern void droppgev(pgev *);
599 extern void pgenerr(void);
601 /*----- That's all, folks -------------------------------------------------*/