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>
73 #include <catacomb/mp.h>
74 #include <catacomb/mpint.h>
75 #include <catacomb/mpmul.h>
76 #include <catacomb/mpcrt.h>
77 #include <catacomb/mpmont.h>
78 #include <catacomb/mpbarrett.h>
79 #include <catacomb/mpreduce.h>
80 #include <catacomb/mp-fibonacci.h>
82 #include <catacomb/pgen.h>
83 #include <catacomb/pfilt.h>
84 #include <catacomb/strongprime.h>
85 #include <catacomb/limlee.h>
86 #include <catacomb/dh.h>
87 #include <catacomb/ptab.h>
88 #include <catacomb/bintab.h>
89 #include <catacomb/dsa.h>
91 #include <catacomb/gf.h>
92 #include <catacomb/gfreduce.h>
93 #include <catacomb/gfn.h>
95 #include <catacomb/field.h>
96 #include <catacomb/field-guts.h>
98 #include <catacomb/ec.h>
99 #include <catacomb/ec-raw.h>
100 #include <catacomb/ectab.h>
102 #include <catacomb/group.h>
103 #include <catacomb/group-guts.h>
105 #include <catacomb/gdsa.h>
106 #include <catacomb/gkcdsa.h>
107 #include <catacomb/rsa.h>
109 #include <catacomb/key.h>
110 #include <catacomb/passphrase.h>
111 #include <catacomb/pixie.h>
113 #include <catacomb/share.h>
114 #include <catacomb/gfshare.h>
116 /*----- Utility macros ----------------------------------------------------*/
118 #define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
119 #define RETURN_NONE RETURN_OBJ(Py_None)
120 #define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
121 #define RETURN_TRUE RETURN_OBJ(Py_True)
122 #define RETURN_FALSE RETURN_OBJ(Py_False)
123 #define RETURN_ME RETURN_OBJ(me)
125 #define EXCERR(exc, str) do { \
126 PyErr_SetString(exc, str); \
129 #define VALERR(str) EXCERR(PyExc_ValueError, str)
130 #define TYERR(str) EXCERR(PyExc_TypeError, str)
131 #define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
132 #define SYSERR(str) EXCERR(PyExc_SystemError, str)
133 #define NIERR(str) EXCERR(PyExc_NotImplementedError, str)
134 #define INDEXERR(idx) do { \
135 PyErr_SetObject(PyExc_KeyError, idx); \
138 #define OSERR(name) do { \
139 PyErr_SetFromErrnoWithFilename(PyExc_OSError, name); \
142 #define PGENERR do { pgenerr(); goto end; } while (0)
144 #define CONVFUNC(ty, cty, ext) \
145 int conv##ty(PyObject *o, void *p) \
147 if (!PyObject_TypeCheck(o, ty##_pytype)) \
148 TYERR("wanted a " #ty); \
149 *(cty *)p = ext(o); \
155 #if PY_VERSION_HEX < 0x02050000 /* Compatibility hack */
156 # define ht_name name
157 # define ht_type type
160 #define root_pytype 0
161 #define type_pytype &PyType_Type
162 #define INITTYPE_META(ty, base, meta) do { \
163 ty##_pytype_skel.tp_base = base##_pytype; \
164 ty##_pytype = inittype(&ty##_pytype_skel, meta##_pytype); \
166 #define INITTYPE(ty, base) INITTYPE_META(ty, base, type)
168 #define INSERT(name, ob) do { \
169 PyObject *_o = (PyObject *)(ob); \
171 PyModule_AddObject(mod, name, _o); \
174 #define INSEXC(name, var, base, meth) \
175 INSERT(name, var = mkexc(mod, base, name, meth))
177 #define METH(func, doc) \
178 { #func, METHNAME(func), METH_VARARGS, doc },
179 #define KWMETH(func, doc) \
180 { #func, (PyCFunction)METHNAME(func), \
181 METH_VARARGS | METH_KEYWORDS, doc },
183 #define GET(func, doc) \
184 { #func, GETSETNAME(get, func), 0, doc },
185 #define GETSET(func, doc) \
186 { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
188 #define MEMBER(name, ty, f, doc) \
189 { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
193 _(bytestring) _(buffer) \
194 _(rand) _(algorithms) _(pubkey) _(pgen) \
195 _(mp) _(field) _(ec) _(group) \
196 _(passphrase) _(share) _(key)
197 #define DOMODINIT(m) m##_pyinit();
198 #define DOMODINSERT(m) m##_pyinsert(mod);
199 #define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
200 #define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
203 extern void m##_pyinit(void); \
204 extern void m##_pyinsert(PyObject *);
208 #define FREEOBJ(obj) \
209 (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
211 #define GEN(func, base) \
212 static PyObject *func(void) \
214 PyObject *d = PyDict_New(); \
218 for (i = 0; g##base##tab[i]; i++) { \
219 o = gc##base##_pywrap((/*unconst*/ gc##base *)g##base##tab[i]); \
220 PyDict_SetItemString(d, \
221 (/*unconst*/ char *)g##base##tab[i]->name, \
228 struct nameval { const char *name; unsigned long value; };
229 extern void setconstants(PyObject *, const struct nameval *);
231 extern PyObject *mexp_common(PyObject *, PyObject *, size_t,
232 PyObject *(*id)(PyObject *),
233 int (*fill)(void *, PyObject *,
234 PyObject *, PyObject *),
235 PyObject *(*exp)(PyObject *, void *, int),
236 void (*drop)(void *));
238 extern int convulong(PyObject *, void *);
239 #define DECL_CONVU_(n) extern int convu##n(PyObject *, void *);
240 DOUINTSZ(DECL_CONVU_)
241 extern int convmpw(PyObject *, void *);
242 extern int convuint(PyObject *, void *);
243 extern int convk64(PyObject *, void *);
244 extern int convszt(PyObject *, void *);
245 extern int convbool(PyObject *, void *);
246 extern PyObject *abstract_pynew(PyTypeObject *, PyObject *, PyObject *);
247 extern PyObject *getbool(int);
248 extern PyObject *getulong(unsigned long);
249 extern PyObject *getk64(kludge64);
250 extern void *newtype(PyTypeObject *, const PyTypeObject *, const char *);
252 extern PyObject *mkexc(PyObject *, PyObject *, const char *, PyMethodDef *);
253 extern void typeready(PyTypeObject *);
254 extern PyTypeObject *inittype(PyTypeObject *, PyTypeObject *);
255 extern void addmethods(const PyMethodDef *);
256 extern PyMethodDef *donemethods(void);
258 /*----- Mapping methods ---------------------------------------------------*/
260 #define GMAP_METH(func, doc) { #func, gmapmeth_##func, METH_VARARGS, doc },
261 #define GMAP_KWMETH(func, doc) \
262 { #func, (PyCFunction)gmapmeth_##func, METH_VARARGS|METH_KEYWORDS, doc },
263 #define GMAP_METHDECL(func, doc) \
264 extern PyObject *gmapmeth_##func(PyObject *, PyObject *);
265 #define GMAP_KWMETHDECL(func, doc) \
266 extern PyObject *gmapmeth_##func(PyObject *, PyObject *, PyObject *);
268 #define GMAP_DOROMETHODS(METH, KWMETH) \
269 METH (has_key, "D.has_key(KEY) -> BOOL") \
270 METH (keys, "D.keys() -> LIST") \
271 METH (values, "D.values() -> LIST") \
272 METH (items, "D.items() -> LIST") \
273 METH (iterkeys, "D.iterkeys() -> ITER") \
274 METH (itervalues, "D.itervalues() -> ITER") \
275 METH (iteritems, "D.iteritems() -> ITER") \
276 KWMETH(get, "D.get(KEY, [default = None]) -> VALUE") \
278 #define GMAP_DOMETHODS(METH, KWMETH) \
279 GMAP_DOROMETHODS(METH, KWMETH) \
280 METH (clear, "D.clear()") \
281 KWMETH(setdefault, "D.setdefault(K, [default = None]) -> VALUE") \
282 KWMETH(pop, "D.pop(KEY, [default = <error>]) -> VALUE") \
283 METH (popitem, "D.popitem() -> (KEY, VALUE)") \
284 METH (update, "D.update(MAP)")
286 GMAP_DOMETHODS(GMAP_METHDECL, GMAP_KWMETHDECL)
287 #define GMAP_ROMETHODS GMAP_DOROMETHODS(GMAP_METH, GMAP_KWMETH)
288 #define GMAP_METHODS GMAP_DOMETHODS(GMAP_METH, GMAP_KWMETH)
289 extern Py_ssize_t gmap_pysize(PyObject *);
290 extern PySequenceMethods gmap_pysequence;
291 extern PyMethodDef gmap_pymethods[];
293 /*----- Bytestrings -------------------------------------------------------*/
295 PyTypeObject *bytestring_pyobj;
296 PyObject *bytestring_pywrap(const void *, size_t);
297 PyObject *bytestring_pywrapbuf(buf *);
299 /*----- Multiprecision arithmetic -----------------------------------------*/
301 typedef struct mp_pyobj {
306 extern PyTypeObject *mp_pytype;
307 extern PyTypeObject *gf_pytype;
308 #define MP_X(o) (((mp_pyobj *)(o))->x)
309 #define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
310 #define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
312 extern mp *mp_frompylong(PyObject *);
313 extern PyObject *mp_topylong(mp *);
314 extern mp *tomp(PyObject *);
315 extern mp *getmp(PyObject *);
316 extern int convmp(PyObject *, void *);
317 extern mp *getgf(PyObject *);
318 extern int convgf(PyObject *, void *);
319 extern PyObject *mp_pywrap(mp *);
320 extern PyObject *gf_pywrap(mp *);
321 extern mp *mp_frompyobject(PyObject *, int);
322 extern PyObject *mp_topystring(mp *, int,
323 const char *, const char *, const char *);
324 extern int mp_tolong_checked(mp *, long *);
326 /*----- Abstract fields ---------------------------------------------------*/
328 typedef struct field_pyobj {
333 extern PyTypeObject *fe_pytype;
334 #define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
335 #define FE_F(o) (((fe_pyobj *)(o))->f)
336 #define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
337 #define FE_X(o) (((fe_pyobj *)(o))->x)
338 extern PyObject *fe_pywrap(PyObject *, mp *);
339 extern mp *getfe(field *, PyObject *);
341 typedef struct fe_pyobj {
347 extern PyTypeObject *field_pytype;
348 extern PyTypeObject *primefield_pytype;
349 extern PyTypeObject *niceprimefield_pytype;
350 extern PyTypeObject *binfield_pytype;
351 extern PyTypeObject *binpolyfield_pytype;
352 extern PyTypeObject *binnormfield_pytype;
353 #define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
354 #define FIELD_F(o) (((field_pyobj *)(o))->f)
355 extern PyObject *field_pywrap(field *);
356 extern field *field_copy(field *);
358 /*----- Elliptic curves ---------------------------------------------------*/
360 typedef struct ecpt_pyobj {
366 extern PyTypeObject *ecpt_pytype, *ecptcurve_pytype;
367 #define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
368 #define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
369 #define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
370 #define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
371 #define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
372 #define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
373 extern PyObject *ecpt_pywrap(PyObject *, ec *);
374 extern PyObject *ecpt_pywrapout(void *, ec *);
375 extern int toecpt(ec_curve *, ec *, PyObject *);
376 extern int getecpt(ec_curve *, ec *, PyObject *);
377 extern void getecptout(ec *, PyObject *);
378 extern int convecpt(PyObject *, void *);
380 typedef struct eccurve_pyobj {
386 extern PyTypeObject *eccurve_pytype;
387 extern PyTypeObject *ecprimecurve_pytype;
388 extern PyTypeObject *ecprimeprojcurve_pytype;
389 extern PyTypeObject *ecbincurve_pytype;
390 extern PyTypeObject *ecbinprojcurve_pytype;
391 #define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
392 #define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
393 #define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
394 extern PyObject *eccurve_pywrap(PyObject *, ec_curve *);
395 extern ec_curve *eccurve_copy(ec_curve *);
397 typedef struct ecinfo_pyobj {
403 extern PyTypeObject *ecinfo_pytype;
404 #define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
405 #define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
406 #define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
407 extern void ecinfo_copy(ec_info *, const ec_info *);
408 extern PyObject *ecinfo_pywrap(ec_info *);
410 /*----- Cyclic groups -----------------------------------------------------*/
412 typedef struct fginfo_pyobj {
417 PyTypeObject *fginfo_pytype, *dhinfo_pytype, *bindhinfo_pytype;
418 #define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
419 PyObject *fginfo_pywrap(gprime_param *, PyTypeObject *);
421 typedef struct ge_pyobj {
427 extern PyTypeObject *ge_pytype;
428 #define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
429 #define GE_X(o) (((ge_pyobj *)(o))->x)
430 #define GE_G(o) (((ge_pyobj *)(o))->g)
431 #define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
432 extern PyObject *ge_pywrap(PyObject *, ge *);
434 typedef struct group_pyobj {
439 extern PyTypeObject *group_pytype;
440 extern PyTypeObject *primegroup_pytype, *bingroup_pytype, *ecgroup_pytype;
441 #define GROUP_G(o) (((group_pyobj *)(o))->g)
442 extern PyObject *group_pywrap(group *);
443 extern group *group_copy(group *);
445 /*----- Random number generators ------------------------------------------*/
449 typedef struct grand_pyobj {
455 extern PyTypeObject *grand_pytype, *truerand_pytype;
456 extern PyTypeObject *lcrand_pytype,* fibrand_pytype;
457 extern PyTypeObject *dsarand_pytype, *bbs_pytype;
458 extern PyObject *rand_pyobj;
459 #define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
460 #define GRAND_F(o) (((grand_pyobj *)(o))->f)
461 #define GRAND_R(o) (((grand_pyobj *)(o))->r)
462 extern PyObject *grand_pywrap(grand *, unsigned);
463 extern int convgrand(PyObject *, void *);
465 /*----- Key sizes ---------------------------------------------------------*/
467 typedef struct keysz_pyobj {
472 typedef struct keyszrange_pyobj {
478 typedef struct keyszset_pyobj {
484 #define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
485 extern PyObject *keysz_pywrap(const octet *);
487 /*----- Symmetric cryptography --------------------------------------------*/
489 typedef struct gccipher_pyobj {
494 extern PyTypeObject *gccipher_pytype;
495 #define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
496 #define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
497 #define GCCIPHER_F(o) (((gccipher_pyobj *)(o))->f)
498 extern PyObject *gccipher_pywrap(gccipher *);
499 extern int convgccipher(PyObject *, void *);
500 extern int convgcipher(PyObject *, void *);
502 typedef struct gcipher_pyobj {
508 extern PyTypeObject *gcipher_pytype;
509 #define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
510 #define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
511 #define GCIPHER_F(o) (((gcipher_pyobj *)(o))->f)
512 extern PyObject *gcipher_pywrap(PyObject *, gcipher *, unsigned);
513 extern int convgcipher(PyObject *, void *);
515 typedef struct gchash_pyobj {
520 extern PyTypeObject *gchash_pytype;
521 #define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
522 #define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
523 #define GCHASH_F(o) (((gchash_pyobj *)(o))->f)
524 extern PyObject *gchash_pywrap(gchash *);
525 extern int convgchash(PyObject *, void *);
527 typedef struct ghash_pyobj {
533 extern PyTypeObject *ghash_pytype, *gmhash_pytype;
534 extern PyObject *sha_pyobj, *has160_pyobj;
535 #define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
536 #define GHASH_H(o) (((ghash_pyobj *)(o))->h)
537 #define GHASH_F(o) (((ghash_pyobj *)(o))->f)
538 extern PyObject *ghash_pywrap(PyObject *, ghash *, unsigned);
539 extern int convghash(PyObject *, void *);
540 extern int convgmhash(PyObject *, void *);
542 typedef struct gcmac_pyobj {
547 extern PyTypeObject *gcmac_pytype;
548 #define GCMAC_PYCHECK(o) PyObject_TypeCheck((o), gcmac_pytype)
549 #define GCMAC_CM(o) (((gcmac_pyobj *)(o))->cm)
550 #define GCMAC_F(o) (((gcmac_pyobj *)(o))->f)
551 extern PyObject *gcmac_pywrap(gcmac *);
552 extern int convgcmac(PyObject *, void *);
554 typedef struct gmac_pyobj {
560 extern PyTypeObject *gmac_pytype;
561 #define GMAC_PYCHECK(o) PyObject_TypeCheck((o), gmac_pytype)
562 #define GMAC_M(o) (((gmac_pyobj *)(o))->m)
563 #define GMAC_F(o) (((gmac_pyobj *)(o))->f)
564 extern PyObject *gmac_pywrap(PyObject *, gmac *, unsigned);
565 extern int convgmac(PyObject *, void *);
567 /*----- Key generation ----------------------------------------------------*/
569 typedef struct pfilt_pyobj {
575 extern PyTypeObject *pfilt_pytype;
576 #define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
577 #define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
578 #define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
580 typedef struct { pgen_proc *proc; void *ctx; } pgev;
581 #define PGEV_HEAD PyObject_HEAD pgev pg;
583 typedef struct pgev_pyobj {
587 extern PyTypeObject *pgev_pytype;
588 #define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
589 #define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
591 extern int convpgev(PyObject *, void *);
592 extern void droppgev(pgev *);
593 extern void pgenerr(void);
595 /*----- That's all, folks -------------------------------------------------*/