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>
96 #include <catacomb/gf.h>
97 #include <catacomb/gfreduce.h>
98 #include <catacomb/gfn.h>
100 #include <catacomb/field.h>
101 #include <catacomb/field-guts.h>
103 #include <catacomb/ec.h>
104 #include <catacomb/ec-raw.h>
105 #include <catacomb/ectab.h>
107 #include <catacomb/group.h>
108 #include <catacomb/group-guts.h>
110 #include <catacomb/gdsa.h>
111 #include <catacomb/gkcdsa.h>
112 #include <catacomb/rsa.h>
114 #include <catacomb/key.h>
115 #include <catacomb/passphrase.h>
116 #include <catacomb/pixie.h>
118 #include <catacomb/share.h>
119 #include <catacomb/gfshare.h>
121 /*----- Utility macros ----------------------------------------------------*/
123 #define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
124 #define RETURN_NONE RETURN_OBJ(Py_None)
125 #define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
126 #define RETURN_TRUE RETURN_OBJ(Py_True)
127 #define RETURN_FALSE RETURN_OBJ(Py_False)
128 #define RETURN_ME RETURN_OBJ(me)
130 #define EXCERR(exc, str) do { \
131 PyErr_SetString(exc, str); \
134 #define VALERR(str) EXCERR(PyExc_ValueError, str)
135 #define TYERR(str) EXCERR(PyExc_TypeError, str)
136 #define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
137 #define SYSERR(str) EXCERR(PyExc_SystemError, str)
138 #define NIERR(str) EXCERR(PyExc_NotImplementedError, str)
139 #define INDEXERR(idx) do { \
140 PyErr_SetObject(PyExc_KeyError, idx); \
143 #define OSERR(name) do { \
144 PyErr_SetFromErrnoWithFilename(PyExc_OSError, name); \
147 #define PGENERR do { pgenerr(); goto end; } while (0)
149 #define CONVFUNC(ty, cty, ext) \
150 int conv##ty(PyObject *o, void *p) \
152 if (!PyObject_TypeCheck(o, ty##_pytype)) \
153 TYERR("wanted a " #ty); \
154 *(cty *)p = ext(o); \
160 #if PY_VERSION_HEX < 0x02050000 /* Compatibility hack */
161 # define ht_name name
162 # define ht_type type
165 #define root_pytype 0
166 #define type_pytype &PyType_Type
167 #define INITTYPE_META(ty, base, meta) do { \
168 ty##_pytype_skel.tp_base = base##_pytype; \
169 ty##_pytype = inittype(&ty##_pytype_skel, meta##_pytype); \
171 #define INITTYPE(ty, base) INITTYPE_META(ty, base, type)
173 #define INSERT(name, ob) do { \
174 PyObject *_o = (PyObject *)(ob); \
176 PyModule_AddObject(mod, name, _o); \
179 #define INSEXC(name, var, base, meth) \
180 INSERT(name, var = mkexc(mod, base, name, meth))
182 #define METH(func, doc) \
183 { #func, METHNAME(func), METH_VARARGS, doc },
184 #define KWMETH(func, doc) \
185 { #func, (PyCFunction)METHNAME(func), \
186 METH_VARARGS | METH_KEYWORDS, doc },
188 #define GET(func, doc) \
189 { #func, GETSETNAME(get, func), 0, doc },
190 #define GETSET(func, doc) \
191 { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
193 #define MEMBER(name, ty, f, doc) \
194 { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
198 _(bytestring) _(buffer) \
199 _(rand) _(algorithms) _(pubkey) _(pgen) \
200 _(mp) _(field) _(ec) _(group) \
201 _(passphrase) _(share) _(key)
202 #define DOMODINIT(m) m##_pyinit();
203 #define DOMODINSERT(m) m##_pyinsert(mod);
204 #define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
205 #define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
208 extern void m##_pyinit(void); \
209 extern void m##_pyinsert(PyObject *);
213 #define FREEOBJ(obj) \
214 (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
216 #define GEN(func, base) \
217 static PyObject *func(void) \
219 PyObject *d = PyDict_New(); \
223 for (i = 0; g##base##tab[i]; i++) { \
224 o = gc##base##_pywrap((/*unconst*/ gc##base *)g##base##tab[i]); \
225 PyDict_SetItemString(d, \
226 (/*unconst*/ char *)g##base##tab[i]->name, \
233 struct nameval { const char *name; unsigned long value; };
234 extern void setconstants(PyObject *, const struct nameval *);
236 extern PyObject *mexp_common(PyObject *, PyObject *, size_t,
237 PyObject *(*id)(PyObject *),
238 int (*fill)(void *, PyObject *,
239 PyObject *, PyObject *),
240 PyObject *(*exp)(PyObject *, void *, int),
241 void (*drop)(void *));
243 extern int convulong(PyObject *, void *);
244 #define DECL_CONVU_(n) extern int convu##n(PyObject *, void *);
245 DOUINTSZ(DECL_CONVU_)
246 extern int convmpw(PyObject *, void *);
247 extern int convuint(PyObject *, void *);
248 extern int convk64(PyObject *, void *);
249 extern int convszt(PyObject *, void *);
250 extern int convbool(PyObject *, void *);
251 extern PyObject *abstract_pynew(PyTypeObject *, PyObject *, PyObject *);
252 extern PyObject *getbool(int);
253 extern PyObject *getulong(unsigned long);
254 extern PyObject *getk64(kludge64);
255 extern void *newtype(PyTypeObject *, const PyTypeObject *, const char *);
257 extern PyObject *mkexc(PyObject *, PyObject *, const char *, PyMethodDef *);
258 extern void typeready(PyTypeObject *);
259 extern PyTypeObject *inittype(PyTypeObject *, PyTypeObject *);
260 extern void addmethods(const PyMethodDef *);
261 extern PyMethodDef *donemethods(void);
263 /*----- Mapping methods ---------------------------------------------------*/
265 #define GMAP_METH(func, doc) { #func, gmapmeth_##func, METH_VARARGS, doc },
266 #define GMAP_KWMETH(func, doc) \
267 { #func, (PyCFunction)gmapmeth_##func, METH_VARARGS|METH_KEYWORDS, doc },
268 #define GMAP_METHDECL(func, doc) \
269 extern PyObject *gmapmeth_##func(PyObject *, PyObject *);
270 #define GMAP_KWMETHDECL(func, doc) \
271 extern PyObject *gmapmeth_##func(PyObject *, PyObject *, PyObject *);
273 #define GMAP_DOROMETHODS(METH, KWMETH) \
274 METH (has_key, "D.has_key(KEY) -> BOOL") \
275 METH (keys, "D.keys() -> LIST") \
276 METH (values, "D.values() -> LIST") \
277 METH (items, "D.items() -> LIST") \
278 METH (iterkeys, "D.iterkeys() -> ITER") \
279 METH (itervalues, "D.itervalues() -> ITER") \
280 METH (iteritems, "D.iteritems() -> ITER") \
281 KWMETH(get, "D.get(KEY, [default = None]) -> VALUE") \
283 #define GMAP_DOMETHODS(METH, KWMETH) \
284 GMAP_DOROMETHODS(METH, KWMETH) \
285 METH (clear, "D.clear()") \
286 KWMETH(setdefault, "D.setdefault(K, [default = None]) -> VALUE") \
287 KWMETH(pop, "D.pop(KEY, [default = <error>]) -> VALUE") \
288 METH (popitem, "D.popitem() -> (KEY, VALUE)") \
289 METH (update, "D.update(MAP)")
291 GMAP_DOMETHODS(GMAP_METHDECL, GMAP_KWMETHDECL)
292 #define GMAP_ROMETHODS GMAP_DOROMETHODS(GMAP_METH, GMAP_KWMETH)
293 #define GMAP_METHODS GMAP_DOMETHODS(GMAP_METH, GMAP_KWMETH)
294 extern Py_ssize_t gmap_pysize(PyObject *);
295 extern PySequenceMethods gmap_pysequence;
296 extern PyMethodDef gmap_pymethods[];
298 /*----- Bytestrings -------------------------------------------------------*/
300 PyTypeObject *bytestring_pyobj;
301 PyObject *bytestring_pywrap(const void *, size_t);
302 PyObject *bytestring_pywrapbuf(buf *);
304 /*----- Multiprecision arithmetic -----------------------------------------*/
306 typedef struct mp_pyobj {
311 extern PyTypeObject *mp_pytype;
312 extern PyTypeObject *gf_pytype;
313 #define MP_X(o) (((mp_pyobj *)(o))->x)
314 #define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
315 #define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
317 extern mp *mp_frompylong(PyObject *);
318 extern PyObject *mp_topylong(mp *);
319 extern mp *tomp(PyObject *);
320 extern mp *getmp(PyObject *);
321 extern int convmp(PyObject *, void *);
322 extern mp *getgf(PyObject *);
323 extern int convgf(PyObject *, void *);
324 extern PyObject *mp_pywrap(mp *);
325 extern PyObject *gf_pywrap(mp *);
326 extern mp *mp_frompyobject(PyObject *, int);
327 extern PyObject *mp_topystring(mp *, int,
328 const char *, const char *, const char *);
329 extern int mp_tolong_checked(mp *, long *, int);
331 /*----- Abstract fields ---------------------------------------------------*/
333 typedef struct field_pyobj {
338 extern PyTypeObject *fe_pytype;
339 #define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
340 #define FE_F(o) (((fe_pyobj *)(o))->f)
341 #define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
342 #define FE_X(o) (((fe_pyobj *)(o))->x)
343 extern PyObject *fe_pywrap(PyObject *, mp *);
344 extern mp *getfe(field *, PyObject *);
346 typedef struct fe_pyobj {
352 extern PyTypeObject *field_pytype;
353 extern PyTypeObject *primefield_pytype;
354 extern PyTypeObject *niceprimefield_pytype;
355 extern PyTypeObject *binfield_pytype;
356 extern PyTypeObject *binpolyfield_pytype;
357 extern PyTypeObject *binnormfield_pytype;
358 #define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
359 #define FIELD_F(o) (((field_pyobj *)(o))->f)
360 extern PyObject *field_pywrap(field *);
361 extern field *field_copy(field *);
363 /*----- Elliptic curves ---------------------------------------------------*/
365 typedef struct ecpt_pyobj {
371 extern PyTypeObject *ecpt_pytype, *ecptcurve_pytype;
372 #define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
373 #define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
374 #define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
375 #define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
376 #define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
377 #define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
378 extern PyObject *ecpt_pywrap(PyObject *, ec *);
379 extern PyObject *ecpt_pywrapout(void *, ec *);
380 extern int toecpt(ec_curve *, ec *, PyObject *);
381 extern int getecpt(ec_curve *, ec *, PyObject *);
382 extern void getecptout(ec *, PyObject *);
383 extern int convecpt(PyObject *, void *);
385 typedef struct eccurve_pyobj {
391 extern PyTypeObject *eccurve_pytype;
392 extern PyTypeObject *ecprimecurve_pytype;
393 extern PyTypeObject *ecprimeprojcurve_pytype;
394 extern PyTypeObject *ecbincurve_pytype;
395 extern PyTypeObject *ecbinprojcurve_pytype;
396 #define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
397 #define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
398 #define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
399 extern PyObject *eccurve_pywrap(PyObject *, ec_curve *);
400 extern ec_curve *eccurve_copy(ec_curve *);
402 typedef struct ecinfo_pyobj {
408 extern PyTypeObject *ecinfo_pytype;
409 #define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
410 #define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
411 #define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
412 extern void ecinfo_copy(ec_info *, const ec_info *);
413 extern PyObject *ecinfo_pywrap(ec_info *);
415 /*----- Cyclic groups -----------------------------------------------------*/
417 typedef struct fginfo_pyobj {
422 PyTypeObject *fginfo_pytype, *dhinfo_pytype, *bindhinfo_pytype;
423 #define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
424 PyObject *fginfo_pywrap(gprime_param *, PyTypeObject *);
426 typedef struct ge_pyobj {
432 extern PyTypeObject *ge_pytype;
433 #define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
434 #define GE_X(o) (((ge_pyobj *)(o))->x)
435 #define GE_G(o) (((ge_pyobj *)(o))->g)
436 #define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
437 extern PyObject *ge_pywrap(PyObject *, ge *);
439 typedef struct group_pyobj {
444 extern PyTypeObject *group_pytype;
445 extern PyTypeObject *primegroup_pytype, *bingroup_pytype, *ecgroup_pytype;
446 #define GROUP_G(o) (((group_pyobj *)(o))->g)
447 extern PyObject *group_pywrap(group *);
448 extern group *group_copy(group *);
450 /*----- Random number generators ------------------------------------------*/
454 typedef struct grand_pyobj {
460 extern PyTypeObject *grand_pytype, *truerand_pytype;
461 extern PyTypeObject *lcrand_pytype,* fibrand_pytype;
462 extern PyTypeObject *dsarand_pytype, *bbs_pytype;
463 extern PyObject *rand_pyobj;
464 #define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
465 #define GRAND_F(o) (((grand_pyobj *)(o))->f)
466 #define GRAND_R(o) (((grand_pyobj *)(o))->r)
467 extern PyObject *grand_pywrap(grand *, unsigned);
468 extern int convgrand(PyObject *, void *);
470 /*----- Key sizes ---------------------------------------------------------*/
472 typedef struct keysz_pyobj {
477 typedef struct keyszrange_pyobj {
483 typedef struct keyszset_pyobj {
489 #define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
490 extern PyObject *keysz_pywrap(const octet *);
492 /*----- Symmetric cryptography --------------------------------------------*/
494 typedef struct gccipher_pyobj {
499 extern PyTypeObject *gccipher_pytype;
500 #define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
501 #define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
502 #define GCCIPHER_F(o) (((gccipher_pyobj *)(o))->f)
503 extern PyObject *gccipher_pywrap(gccipher *);
504 extern int convgccipher(PyObject *, void *);
505 extern int convgcipher(PyObject *, void *);
507 typedef struct gcipher_pyobj {
513 extern PyTypeObject *gcipher_pytype;
514 #define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
515 #define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
516 #define GCIPHER_F(o) (((gcipher_pyobj *)(o))->f)
517 extern PyObject *gcipher_pywrap(PyObject *, gcipher *, unsigned);
518 extern int convgcipher(PyObject *, void *);
520 typedef struct gchash_pyobj {
525 extern PyTypeObject *gchash_pytype;
526 #define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
527 #define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
528 #define GCHASH_F(o) (((gchash_pyobj *)(o))->f)
529 extern PyObject *gchash_pywrap(gchash *);
530 extern int convgchash(PyObject *, void *);
532 typedef struct ghash_pyobj {
538 extern PyTypeObject *ghash_pytype, *gmhash_pytype;
539 extern PyObject *sha_pyobj, *has160_pyobj;
540 #define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
541 #define GHASH_H(o) (((ghash_pyobj *)(o))->h)
542 #define GHASH_F(o) (((ghash_pyobj *)(o))->f)
543 extern PyObject *ghash_pywrap(PyObject *, ghash *, unsigned);
544 extern int convghash(PyObject *, void *);
545 extern int convgmhash(PyObject *, void *);
547 typedef struct gcmac_pyobj {
552 extern PyTypeObject *gcmac_pytype;
553 #define GCMAC_PYCHECK(o) PyObject_TypeCheck((o), gcmac_pytype)
554 #define GCMAC_CM(o) (((gcmac_pyobj *)(o))->cm)
555 #define GCMAC_F(o) (((gcmac_pyobj *)(o))->f)
556 extern PyObject *gcmac_pywrap(gcmac *);
557 extern int convgcmac(PyObject *, void *);
559 typedef struct gmac_pyobj {
565 extern PyTypeObject *gmac_pytype;
566 #define GMAC_PYCHECK(o) PyObject_TypeCheck((o), gmac_pytype)
567 #define GMAC_M(o) (((gmac_pyobj *)(o))->m)
568 #define GMAC_F(o) (((gmac_pyobj *)(o))->f)
569 extern PyObject *gmac_pywrap(PyObject *, gmac *, unsigned);
570 extern int convgmac(PyObject *, void *);
572 /*----- Key generation ----------------------------------------------------*/
574 typedef struct pfilt_pyobj {
580 extern PyTypeObject *pfilt_pytype;
581 #define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
582 #define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
583 #define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
585 typedef struct { pgen_proc *proc; void *ctx; } pgev;
586 #define PGEV_HEAD PyObject_HEAD pgev pg;
588 typedef struct pgev_pyobj {
592 extern PyTypeObject *pgev_pytype;
593 #define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
594 #define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
596 extern int convpgev(PyObject *, void *);
597 extern void droppgev(pgev *);
598 extern void pgenerr(void);
600 /*----- That's all, folks -------------------------------------------------*/