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>
90 #include <catacomb/x25519.h>
91 #include <catacomb/ed25519.h>
93 #include <catacomb/gf.h>
94 #include <catacomb/gfreduce.h>
95 #include <catacomb/gfn.h>
97 #include <catacomb/field.h>
98 #include <catacomb/field-guts.h>
100 #include <catacomb/ec.h>
101 #include <catacomb/ec-raw.h>
102 #include <catacomb/ectab.h>
104 #include <catacomb/group.h>
105 #include <catacomb/group-guts.h>
107 #include <catacomb/gdsa.h>
108 #include <catacomb/gkcdsa.h>
109 #include <catacomb/rsa.h>
111 #include <catacomb/key.h>
112 #include <catacomb/passphrase.h>
113 #include <catacomb/pixie.h>
115 #include <catacomb/share.h>
116 #include <catacomb/gfshare.h>
118 /*----- Utility macros ----------------------------------------------------*/
120 #define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
121 #define RETURN_NONE RETURN_OBJ(Py_None)
122 #define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
123 #define RETURN_TRUE RETURN_OBJ(Py_True)
124 #define RETURN_FALSE RETURN_OBJ(Py_False)
125 #define RETURN_ME RETURN_OBJ(me)
127 #define EXCERR(exc, str) do { \
128 PyErr_SetString(exc, str); \
131 #define VALERR(str) EXCERR(PyExc_ValueError, str)
132 #define TYERR(str) EXCERR(PyExc_TypeError, str)
133 #define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
134 #define SYSERR(str) EXCERR(PyExc_SystemError, str)
135 #define NIERR(str) EXCERR(PyExc_NotImplementedError, str)
136 #define INDEXERR(idx) do { \
137 PyErr_SetObject(PyExc_KeyError, idx); \
140 #define OSERR(name) do { \
141 PyErr_SetFromErrnoWithFilename(PyExc_OSError, name); \
144 #define PGENERR do { pgenerr(); goto end; } while (0)
146 #define CONVFUNC(ty, cty, ext) \
147 int conv##ty(PyObject *o, void *p) \
149 if (!PyObject_TypeCheck(o, ty##_pytype)) \
150 TYERR("wanted a " #ty); \
151 *(cty *)p = ext(o); \
157 #if PY_VERSION_HEX < 0x02050000 /* Compatibility hack */
158 # define ht_name name
159 # define ht_type type
162 #define root_pytype 0
163 #define type_pytype &PyType_Type
164 #define INITTYPE_META(ty, base, meta) do { \
165 ty##_pytype_skel.tp_base = base##_pytype; \
166 ty##_pytype = inittype(&ty##_pytype_skel, meta##_pytype); \
168 #define INITTYPE(ty, base) INITTYPE_META(ty, base, type)
170 #define INSERT(name, ob) do { \
171 PyObject *_o = (PyObject *)(ob); \
173 PyModule_AddObject(mod, name, _o); \
176 #define INSEXC(name, var, base, meth) \
177 INSERT(name, var = mkexc(mod, base, name, meth))
179 #define METH(func, doc) \
180 { #func, METHNAME(func), METH_VARARGS, doc },
181 #define KWMETH(func, doc) \
182 { #func, (PyCFunction)METHNAME(func), \
183 METH_VARARGS | METH_KEYWORDS, doc },
185 #define GET(func, doc) \
186 { #func, GETSETNAME(get, func), 0, doc },
187 #define GETSET(func, doc) \
188 { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
190 #define MEMBER(name, ty, f, doc) \
191 { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
195 _(bytestring) _(buffer) \
196 _(rand) _(algorithms) _(pubkey) _(pgen) \
197 _(mp) _(field) _(ec) _(group) \
198 _(passphrase) _(share) _(key)
199 #define DOMODINIT(m) m##_pyinit();
200 #define DOMODINSERT(m) m##_pyinsert(mod);
201 #define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
202 #define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
205 extern void m##_pyinit(void); \
206 extern void m##_pyinsert(PyObject *);
210 #define FREEOBJ(obj) \
211 (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
213 #define GEN(func, base) \
214 static PyObject *func(void) \
216 PyObject *d = PyDict_New(); \
220 for (i = 0; g##base##tab[i]; i++) { \
221 o = gc##base##_pywrap((/*unconst*/ gc##base *)g##base##tab[i]); \
222 PyDict_SetItemString(d, \
223 (/*unconst*/ char *)g##base##tab[i]->name, \
230 struct nameval { const char *name; unsigned long value; };
231 extern void setconstants(PyObject *, const struct nameval *);
233 extern PyObject *mexp_common(PyObject *, PyObject *, size_t,
234 PyObject *(*id)(PyObject *),
235 int (*fill)(void *, PyObject *,
236 PyObject *, PyObject *),
237 PyObject *(*exp)(PyObject *, void *, int),
238 void (*drop)(void *));
240 extern int convulong(PyObject *, void *);
241 #define DECL_CONVU_(n) extern int convu##n(PyObject *, void *);
242 DOUINTSZ(DECL_CONVU_)
243 extern int convmpw(PyObject *, void *);
244 extern int convuint(PyObject *, void *);
245 extern int convk64(PyObject *, void *);
246 extern int convszt(PyObject *, void *);
247 extern int convbool(PyObject *, void *);
248 extern PyObject *abstract_pynew(PyTypeObject *, PyObject *, PyObject *);
249 extern PyObject *getbool(int);
250 extern PyObject *getulong(unsigned long);
251 extern PyObject *getk64(kludge64);
252 extern void *newtype(PyTypeObject *, const PyTypeObject *, const char *);
254 extern PyObject *mkexc(PyObject *, PyObject *, const char *, PyMethodDef *);
255 extern void typeready(PyTypeObject *);
256 extern PyTypeObject *inittype(PyTypeObject *, PyTypeObject *);
257 extern void addmethods(const PyMethodDef *);
258 extern PyMethodDef *donemethods(void);
260 /*----- Mapping methods ---------------------------------------------------*/
262 #define GMAP_METH(func, doc) { #func, gmapmeth_##func, METH_VARARGS, doc },
263 #define GMAP_KWMETH(func, doc) \
264 { #func, (PyCFunction)gmapmeth_##func, METH_VARARGS|METH_KEYWORDS, doc },
265 #define GMAP_METHDECL(func, doc) \
266 extern PyObject *gmapmeth_##func(PyObject *, PyObject *);
267 #define GMAP_KWMETHDECL(func, doc) \
268 extern PyObject *gmapmeth_##func(PyObject *, PyObject *, PyObject *);
270 #define GMAP_DOROMETHODS(METH, KWMETH) \
271 METH (has_key, "D.has_key(KEY) -> BOOL") \
272 METH (keys, "D.keys() -> LIST") \
273 METH (values, "D.values() -> LIST") \
274 METH (items, "D.items() -> LIST") \
275 METH (iterkeys, "D.iterkeys() -> ITER") \
276 METH (itervalues, "D.itervalues() -> ITER") \
277 METH (iteritems, "D.iteritems() -> ITER") \
278 KWMETH(get, "D.get(KEY, [default = None]) -> VALUE") \
280 #define GMAP_DOMETHODS(METH, KWMETH) \
281 GMAP_DOROMETHODS(METH, KWMETH) \
282 METH (clear, "D.clear()") \
283 KWMETH(setdefault, "D.setdefault(K, [default = None]) -> VALUE") \
284 KWMETH(pop, "D.pop(KEY, [default = <error>]) -> VALUE") \
285 METH (popitem, "D.popitem() -> (KEY, VALUE)") \
286 METH (update, "D.update(MAP)")
288 GMAP_DOMETHODS(GMAP_METHDECL, GMAP_KWMETHDECL)
289 #define GMAP_ROMETHODS GMAP_DOROMETHODS(GMAP_METH, GMAP_KWMETH)
290 #define GMAP_METHODS GMAP_DOMETHODS(GMAP_METH, GMAP_KWMETH)
291 extern Py_ssize_t gmap_pysize(PyObject *);
292 extern PySequenceMethods gmap_pysequence;
293 extern PyMethodDef gmap_pymethods[];
295 /*----- Bytestrings -------------------------------------------------------*/
297 PyTypeObject *bytestring_pyobj;
298 PyObject *bytestring_pywrap(const void *, size_t);
299 PyObject *bytestring_pywrapbuf(buf *);
301 /*----- Multiprecision arithmetic -----------------------------------------*/
303 typedef struct mp_pyobj {
308 extern PyTypeObject *mp_pytype;
309 extern PyTypeObject *gf_pytype;
310 #define MP_X(o) (((mp_pyobj *)(o))->x)
311 #define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
312 #define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
314 extern mp *mp_frompylong(PyObject *);
315 extern PyObject *mp_topylong(mp *);
316 extern mp *tomp(PyObject *);
317 extern mp *getmp(PyObject *);
318 extern int convmp(PyObject *, void *);
319 extern mp *getgf(PyObject *);
320 extern int convgf(PyObject *, void *);
321 extern PyObject *mp_pywrap(mp *);
322 extern PyObject *gf_pywrap(mp *);
323 extern mp *mp_frompyobject(PyObject *, int);
324 extern PyObject *mp_topystring(mp *, int,
325 const char *, const char *, const char *);
326 extern int mp_tolong_checked(mp *, long *, int);
328 /*----- Abstract fields ---------------------------------------------------*/
330 typedef struct field_pyobj {
335 extern PyTypeObject *fe_pytype;
336 #define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
337 #define FE_F(o) (((fe_pyobj *)(o))->f)
338 #define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
339 #define FE_X(o) (((fe_pyobj *)(o))->x)
340 extern PyObject *fe_pywrap(PyObject *, mp *);
341 extern mp *getfe(field *, PyObject *);
343 typedef struct fe_pyobj {
349 extern PyTypeObject *field_pytype;
350 extern PyTypeObject *primefield_pytype;
351 extern PyTypeObject *niceprimefield_pytype;
352 extern PyTypeObject *binfield_pytype;
353 extern PyTypeObject *binpolyfield_pytype;
354 extern PyTypeObject *binnormfield_pytype;
355 #define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
356 #define FIELD_F(o) (((field_pyobj *)(o))->f)
357 extern PyObject *field_pywrap(field *);
358 extern field *field_copy(field *);
360 /*----- Elliptic curves ---------------------------------------------------*/
362 typedef struct ecpt_pyobj {
368 extern PyTypeObject *ecpt_pytype, *ecptcurve_pytype;
369 #define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
370 #define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
371 #define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
372 #define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
373 #define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
374 #define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
375 extern PyObject *ecpt_pywrap(PyObject *, ec *);
376 extern PyObject *ecpt_pywrapout(void *, ec *);
377 extern int toecpt(ec_curve *, ec *, PyObject *);
378 extern int getecpt(ec_curve *, ec *, PyObject *);
379 extern void getecptout(ec *, PyObject *);
380 extern int convecpt(PyObject *, void *);
382 typedef struct eccurve_pyobj {
388 extern PyTypeObject *eccurve_pytype;
389 extern PyTypeObject *ecprimecurve_pytype;
390 extern PyTypeObject *ecprimeprojcurve_pytype;
391 extern PyTypeObject *ecbincurve_pytype;
392 extern PyTypeObject *ecbinprojcurve_pytype;
393 #define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
394 #define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
395 #define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
396 extern PyObject *eccurve_pywrap(PyObject *, ec_curve *);
397 extern ec_curve *eccurve_copy(ec_curve *);
399 typedef struct ecinfo_pyobj {
405 extern PyTypeObject *ecinfo_pytype;
406 #define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
407 #define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
408 #define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
409 extern void ecinfo_copy(ec_info *, const ec_info *);
410 extern PyObject *ecinfo_pywrap(ec_info *);
412 /*----- Cyclic groups -----------------------------------------------------*/
414 typedef struct fginfo_pyobj {
419 PyTypeObject *fginfo_pytype, *dhinfo_pytype, *bindhinfo_pytype;
420 #define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
421 PyObject *fginfo_pywrap(gprime_param *, PyTypeObject *);
423 typedef struct ge_pyobj {
429 extern PyTypeObject *ge_pytype;
430 #define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
431 #define GE_X(o) (((ge_pyobj *)(o))->x)
432 #define GE_G(o) (((ge_pyobj *)(o))->g)
433 #define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
434 extern PyObject *ge_pywrap(PyObject *, ge *);
436 typedef struct group_pyobj {
441 extern PyTypeObject *group_pytype;
442 extern PyTypeObject *primegroup_pytype, *bingroup_pytype, *ecgroup_pytype;
443 #define GROUP_G(o) (((group_pyobj *)(o))->g)
444 extern PyObject *group_pywrap(group *);
445 extern group *group_copy(group *);
447 /*----- Random number generators ------------------------------------------*/
451 typedef struct grand_pyobj {
457 extern PyTypeObject *grand_pytype, *truerand_pytype;
458 extern PyTypeObject *lcrand_pytype,* fibrand_pytype;
459 extern PyTypeObject *dsarand_pytype, *bbs_pytype;
460 extern PyObject *rand_pyobj;
461 #define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
462 #define GRAND_F(o) (((grand_pyobj *)(o))->f)
463 #define GRAND_R(o) (((grand_pyobj *)(o))->r)
464 extern PyObject *grand_pywrap(grand *, unsigned);
465 extern int convgrand(PyObject *, void *);
467 /*----- Key sizes ---------------------------------------------------------*/
469 typedef struct keysz_pyobj {
474 typedef struct keyszrange_pyobj {
480 typedef struct keyszset_pyobj {
486 #define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
487 extern PyObject *keysz_pywrap(const octet *);
489 /*----- Symmetric cryptography --------------------------------------------*/
491 typedef struct gccipher_pyobj {
496 extern PyTypeObject *gccipher_pytype;
497 #define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
498 #define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
499 #define GCCIPHER_F(o) (((gccipher_pyobj *)(o))->f)
500 extern PyObject *gccipher_pywrap(gccipher *);
501 extern int convgccipher(PyObject *, void *);
502 extern int convgcipher(PyObject *, void *);
504 typedef struct gcipher_pyobj {
510 extern PyTypeObject *gcipher_pytype;
511 #define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
512 #define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
513 #define GCIPHER_F(o) (((gcipher_pyobj *)(o))->f)
514 extern PyObject *gcipher_pywrap(PyObject *, gcipher *, unsigned);
515 extern int convgcipher(PyObject *, void *);
517 typedef struct gchash_pyobj {
522 extern PyTypeObject *gchash_pytype;
523 #define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
524 #define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
525 #define GCHASH_F(o) (((gchash_pyobj *)(o))->f)
526 extern PyObject *gchash_pywrap(gchash *);
527 extern int convgchash(PyObject *, void *);
529 typedef struct ghash_pyobj {
535 extern PyTypeObject *ghash_pytype, *gmhash_pytype;
536 extern PyObject *sha_pyobj, *has160_pyobj;
537 #define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
538 #define GHASH_H(o) (((ghash_pyobj *)(o))->h)
539 #define GHASH_F(o) (((ghash_pyobj *)(o))->f)
540 extern PyObject *ghash_pywrap(PyObject *, ghash *, unsigned);
541 extern int convghash(PyObject *, void *);
542 extern int convgmhash(PyObject *, void *);
544 typedef struct gcmac_pyobj {
549 extern PyTypeObject *gcmac_pytype;
550 #define GCMAC_PYCHECK(o) PyObject_TypeCheck((o), gcmac_pytype)
551 #define GCMAC_CM(o) (((gcmac_pyobj *)(o))->cm)
552 #define GCMAC_F(o) (((gcmac_pyobj *)(o))->f)
553 extern PyObject *gcmac_pywrap(gcmac *);
554 extern int convgcmac(PyObject *, void *);
556 typedef struct gmac_pyobj {
562 extern PyTypeObject *gmac_pytype;
563 #define GMAC_PYCHECK(o) PyObject_TypeCheck((o), gmac_pytype)
564 #define GMAC_M(o) (((gmac_pyobj *)(o))->m)
565 #define GMAC_F(o) (((gmac_pyobj *)(o))->f)
566 extern PyObject *gmac_pywrap(PyObject *, gmac *, unsigned);
567 extern int convgmac(PyObject *, void *);
569 /*----- Key generation ----------------------------------------------------*/
571 typedef struct pfilt_pyobj {
577 extern PyTypeObject *pfilt_pytype;
578 #define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
579 #define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
580 #define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
582 typedef struct { pgen_proc *proc; void *ctx; } pgev;
583 #define PGEV_HEAD PyObject_HEAD pgev pg;
585 typedef struct pgev_pyobj {
589 extern PyTypeObject *pgev_pytype;
590 #define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
591 #define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
593 extern int convpgev(PyObject *, void *);
594 extern void droppgev(pgev *);
595 extern void pgenerr(void);
597 /*----- That's all, folks -------------------------------------------------*/