5 * Definitions for Catacomb bindings
7 * (c) 2004 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the Python interface to Catacomb.
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.
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.
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.
29 #ifndef CATACOMB_PYTHON_H
30 #define CATACOMB_PYTHON_H
36 /*----- Header files ------------------------------------------------------*/
39 #include <longintrepr.h>
40 #include <structmember.h>
45 #include <mLib/darray.h>
46 #include <mLib/dstr.h>
47 #include <mLib/macros.h>
48 #include <mLib/quis.h>
50 #include <catacomb/buf.h>
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 #include <catacomb/blkc.h>
64 #include <catacomb/gcipher.h>
65 #include <catacomb/ghash.h>
66 #include <catacomb/gmac.h>
67 #include <catacomb/md5.h>
68 #include <catacomb/md5-hmac.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>
81 #include <catacomb/pgen.h>
82 #include <catacomb/pfilt.h>
83 #include <catacomb/strongprime.h>
84 #include <catacomb/limlee.h>
85 #include <catacomb/dh.h>
86 #include <catacomb/ptab.h>
87 #include <catacomb/bintab.h>
88 #include <catacomb/dsa.h>
90 #include <catacomb/gf.h>
91 #include <catacomb/gfreduce.h>
92 #include <catacomb/gfn.h>
94 #include <catacomb/field.h>
95 #include <catacomb/field-guts.h>
97 #include <catacomb/ec.h>
98 #include <catacomb/ec-raw.h>
99 #include <catacomb/ectab.h>
101 #include <catacomb/group.h>
102 #include <catacomb/group-guts.h>
104 #include <catacomb/gdsa.h>
105 #include <catacomb/gkcdsa.h>
106 #include <catacomb/rsa.h>
108 #include <catacomb/key.h>
109 #include <catacomb/passphrase.h>
110 #include <catacomb/pixie.h>
112 #include <catacomb/share.h>
113 #include <catacomb/gfshare.h>
115 /*----- Utility macros ----------------------------------------------------*/
117 #define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
118 #define RETURN_NONE RETURN_OBJ(Py_None)
119 #define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
120 #define RETURN_TRUE RETURN_OBJ(Py_True)
121 #define RETURN_FALSE RETURN_OBJ(Py_False)
122 #define RETURN_ME RETURN_OBJ(me)
124 #define EXCERR(exc, str) do { \
125 PyErr_SetString(exc, str); \
128 #define VALERR(str) EXCERR(PyExc_ValueError, str)
129 #define TYERR(str) EXCERR(PyExc_TypeError, str)
130 #define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
131 #define SYNERR(str) EXCERR(PyExc_SyntaxError, 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 #define root_pytype 0
156 #define type_pytype &PyType_Type
157 #define INITTYPE(ty, base) do { \
158 ty##_pytype_skel.tp_base = base##_pytype; \
159 ty##_pytype = inittype(&ty##_pytype_skel); \
162 #define INSERT(name, ob) do { \
163 PyObject *_o = (PyObject *)(ob); \
165 PyModule_AddObject(mod, name, _o); \
168 #define INSEXC(name, var, base, meth) \
169 INSERT(name, var = mkexc(mod, base, name, meth))
171 #define METH(func, doc) \
172 { #func, METHNAME(func), METH_VARARGS, doc },
173 #define KWMETH(func, doc) \
174 { #func, (PyCFunction)METHNAME(func), \
175 METH_VARARGS | METH_KEYWORDS, doc },
177 #define GET(func, doc) \
178 { #func, GETSETNAME(get, func), 0, doc },
179 #define GETSET(func, doc) \
180 { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
182 #define MEMBER(name, ty, f, doc) \
183 { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
186 _(bytestring) _(buffer) \
187 _(rand) _(algorithms) _(pubkey) _(pgen) \
188 _(mp) _(field) _(ec) _(group) \
189 _(passphrase) _(share) _(key)
190 #define DOMODINIT(m) m##_pyinit();
191 #define DOMODINSERT(m) m##_pyinsert(mod);
192 #define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
193 #define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
196 extern void m##_pyinit(void); \
197 extern void m##_pyinsert(PyObject *);
201 #define FREEOBJ(obj) \
202 (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
204 #define GEN(func, base) \
205 static PyObject *func(void) \
207 PyObject *d = PyDict_New(); \
211 for (i = 0; g##base##tab[i]; i++) { \
212 o = gc##base##_pywrap((/*unconst*/ gc##base *)g##base##tab[i]); \
213 PyDict_SetItemString(d, \
214 (/*unconst*/ char *)g##base##tab[i]->name, \
221 struct nameval
{ const char *name
; unsigned long value
; };
222 extern void setconstants(PyObject
*, const struct nameval
*);
224 extern PyObject
*mexp_common(PyObject
*, PyObject
*, size_t,
225 PyObject
*(*id
)(PyObject
*),
226 int (*fill
)(void *, PyObject
*,
227 PyObject
*, PyObject
*),
228 PyObject
*(*exp
)(PyObject
*, void *, int),
229 void (*drop
)(void *));
231 extern int convulong(PyObject
*, void *);
232 #define DECL_CONVU_(n) extern int convu##n(PyObject *, void *);
233 DOUINTSZ(DECL_CONVU_
)
234 extern int convmpw(PyObject
*, void *);
235 extern int convuint(PyObject
*, void *);
236 extern int convszt(PyObject
*, void *);
237 extern int convbool(PyObject
*, void *);
238 extern PyObject
*abstract_pynew(PyTypeObject
*, PyObject
*, PyObject
*);
239 extern PyObject
*getbool(int);
240 #define DECL_GETU_(n) extern PyObject *getu##n(uint##n);
242 extern void *newtype(PyTypeObject
*, const PyTypeObject
*, const char *);
244 extern PyObject
* mkexc(PyObject
*, PyObject
*, const char *, PyMethodDef
*);
245 extern PyTypeObject
*inittype(PyTypeObject
*);
246 extern void addmethods(const PyMethodDef
*);
247 extern PyMethodDef
*donemethods(void);
249 /*----- Mapping methods ---------------------------------------------------*/
251 #define GMAP_METH(func, doc) { #func, gmapmeth_##func, METH_VARARGS, doc },
252 #define GMAP_KWMETH(func, doc) \
253 { #func, (PyCFunction)gmapmeth_##func, METH_VARARGS|METH_KEYWORDS, doc },
254 #define GMAP_METHDECL(func, doc) \
255 extern PyObject *gmapmeth_##func(PyObject *, PyObject *);
256 #define GMAP_KWMETHDECL(func, doc) \
257 extern PyObject *gmapmeth_##func(PyObject *, PyObject *, PyObject *);
259 #define GMAP_DOROMETHODS(METH, KWMETH) \
260 METH (has_key, "D.has_key(KEY) -> BOOL") \
261 METH (keys, "D.keys() -> LIST") \
262 METH (values, "D.values() -> LIST") \
263 METH (items, "D.items() -> LIST") \
264 METH (iterkeys, "D.iterkeys() -> ITER") \
265 METH (itervalues, "D.itervalues() -> ITER") \
266 METH (iteritems, "D.iteritems() -> ITER") \
267 KWMETH(get, "D.get(KEY, [default = None]) -> VALUE") \
269 #define GMAP_DOMETHODS(METH, KWMETH) \
270 GMAP_DOROMETHODS(METH, KWMETH) \
271 METH (clear, "D.clear()") \
272 KWMETH(setdefault, "D.setdefault(K, [default = None]) -> VALUE") \
273 KWMETH(pop, "D.pop(KEY, [default = <error>]) -> VALUE") \
274 METH (popitem, "D.popitem() -> (KEY, VALUE)") \
275 METH (update, "D.update(MAP)")
277 GMAP_DOMETHODS(GMAP_METHDECL
, GMAP_KWMETHDECL
)
278 #define GMAP_ROMETHODS GMAP_DOROMETHODS(GMAP_METH, GMAP_KWMETH)
279 #define GMAP_METHODS GMAP_DOMETHODS(GMAP_METH, GMAP_KWMETH)
280 extern int gmap_pysize(PyObject
*);
281 extern PySequenceMethods gmap_pysequence
;
282 extern PyMethodDef gmap_pymethods
[];
284 /*----- Bytestrings -------------------------------------------------------*/
286 PyTypeObject
*bytestring_pyobj
;
287 PyObject
*bytestring_pywrap(const void *, size_t);
288 PyObject
*bytestring_pywrapbuf(buf
*);
290 /*----- Multiprecision arithmetic -----------------------------------------*/
292 typedef struct mp_pyobj
{
297 extern PyTypeObject
*mp_pytype
;
298 extern PyTypeObject
*gf_pytype
;
299 #define MP_X(o) (((mp_pyobj *)(o))->x)
300 #define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
301 #define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
303 extern mp
*mp_frompylong(PyObject
*);
304 extern PyObject
*mp_topylong(mp
*);
305 extern mp
*tomp(PyObject
*);
306 extern mp
*getmp(PyObject
*);
307 extern int convmp(PyObject
*, void *);
308 extern mp
*getgf(PyObject
*);
309 extern int convgf(PyObject
*, void *);
310 extern PyObject
*mp_pywrap(mp
*);
311 extern PyObject
*gf_pywrap(mp
*);
312 extern mp
*mp_frompyobject(PyObject
*, int);
313 extern PyObject
*mp_topystring(mp
*, int,
314 const char *, const char *, const char *);
315 extern int mp_tolong_checked(mp
*, long *);
317 /*----- Abstract fields ---------------------------------------------------*/
319 typedef struct field_pyobj
{
324 extern PyTypeObject
*fe_pytype
;
325 #define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
326 #define FE_F(o) (((fe_pyobj *)(o))->f)
327 #define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
328 #define FE_X(o) (((fe_pyobj *)(o))->x)
329 extern PyObject
*fe_pywrap(PyObject
*, mp
*);
330 extern mp
*getfe(field
*, PyObject
*);
332 typedef struct fe_pyobj
{
338 extern PyTypeObject
*field_pytype
;
339 extern PyTypeObject
*primefield_pytype
;
340 extern PyTypeObject
*niceprimefield_pytype
;
341 extern PyTypeObject
*binfield_pytype
;
342 extern PyTypeObject
*binpolyfield_pytype
;
343 extern PyTypeObject
*binnormfield_pytype
;
344 #define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
345 #define FIELD_F(o) (((field_pyobj *)(o))->f)
346 extern PyObject
*field_pywrap(field
*);
347 extern field
*field_copy(field
*);
349 /*----- Elliptic curves ---------------------------------------------------*/
351 typedef struct ecpt_pyobj
{
357 extern PyTypeObject
*ecpt_pytype
, *ecptcurve_pytype
;
358 #define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
359 #define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
360 #define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
361 #define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
362 #define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
363 #define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
364 extern PyObject
*ecpt_pywrap(PyObject
*, ec
*);
365 extern PyObject
*ecpt_pywrapout(void *, ec
*);
366 extern int toecpt(ec_curve
*, ec
*, PyObject
*);
367 extern int getecpt(ec_curve
*, ec
*, PyObject
*);
368 extern void getecptout(ec
*, PyObject
*);
369 extern int convecpt(PyObject
*, void *);
371 typedef struct eccurve_pyobj
{
377 extern PyTypeObject
*eccurve_pytype
;
378 extern PyTypeObject
*ecprimecurve_pytype
;
379 extern PyTypeObject
*ecprimeprojcurve_pytype
;
380 extern PyTypeObject
*ecbincurve_pytype
;
381 extern PyTypeObject
*ecbinprojcurve_pytype
;
382 #define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
383 #define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
384 #define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
385 extern PyObject
*eccurve_pywrap(PyObject
*, ec_curve
*);
386 extern ec_curve
*eccurve_copy(ec_curve
*);
388 typedef struct ecinfo_pyobj
{
394 extern PyTypeObject
*ecinfo_pytype
;
395 #define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
396 #define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
397 #define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
398 extern void ecinfo_copy(ec_info
*, const ec_info
*);
399 extern PyObject
*ecinfo_pywrap(ec_info
*);
401 /*----- Cyclic groups -----------------------------------------------------*/
403 typedef struct fginfo_pyobj
{
408 PyTypeObject
*fginfo_pytype
, *dhinfo_pytype
, *bindhinfo_pytype
;
409 #define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
410 PyObject
*fginfo_pywrap(gprime_param
*, PyTypeObject
*);
412 typedef struct ge_pyobj
{
418 extern PyTypeObject
*ge_pytype
;
419 #define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
420 #define GE_X(o) (((ge_pyobj *)(o))->x)
421 #define GE_G(o) (((ge_pyobj *)(o))->g)
422 #define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
423 extern PyObject
*ge_pywrap(PyObject
*, ge
*);
425 typedef struct group_pyobj
{
430 extern PyTypeObject
*group_pytype
;
431 extern PyTypeObject
*primegroup_pytype
, *bingroup_pytype
, *ecgroup_pytype
;
432 #define GROUP_G(o) (((group_pyobj *)(o))->g)
433 extern PyObject
*group_pywrap(group
*);
434 extern group
*group_copy(group
*);
436 /*----- Random number generators ------------------------------------------*/
440 typedef struct grand_pyobj
{
446 extern PyTypeObject
*grand_pytype
, *truerand_pytype
;
447 extern PyTypeObject
*lcrand_pytype
,* fibrand_pytype
;
448 extern PyTypeObject
*dsarand_pytype
, *bbs_pytype
;
449 extern PyObject
*rand_pyobj
;
450 #define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
451 #define GRAND_F(o) (((grand_pyobj *)(o))->f)
452 #define GRAND_R(o) (((grand_pyobj *)(o))->r)
453 extern PyObject
*grand_pywrap(grand
*, unsigned);
454 extern int convgrand(PyObject
*, void *);
456 /*----- Key sizes ---------------------------------------------------------*/
458 typedef struct keysz_pyobj
{
463 typedef struct keyszrange_pyobj
{
469 typedef struct keyszset_pyobj
{
475 #define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
476 extern PyObject
*keysz_pywrap(const octet
*);
478 /*----- Symmetric cryptography --------------------------------------------*/
480 typedef struct gccipher_pyobj
{
485 extern PyTypeObject
*gccipher_pytype
;
486 #define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
487 #define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
488 #define GCCIPHER_F(o) (((gccipher_pyobj *)(o))->f)
489 extern PyObject
*gccipher_pywrap(gccipher
*);
490 extern int convgccipher(PyObject
*, void *);
491 extern int convgcipher(PyObject
*, void *);
493 typedef struct gcipher_pyobj
{
499 extern PyTypeObject
*gcipher_pytype
;
500 #define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
501 #define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
502 #define GCIPHER_F(o) (((gcipher_pyobj *)(o))->f)
503 extern PyObject
*gcipher_pywrap(PyObject
*, gcipher
*, unsigned);
504 extern int convgcipher(PyObject
*, void *);
506 typedef struct gchash_pyobj
{
511 extern PyTypeObject
*gchash_pytype
;
512 #define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
513 #define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
514 #define GCHASH_F(o) (((gchash_pyobj *)(o))->f)
515 extern PyObject
*gchash_pywrap(gchash
*);
516 extern int convgchash(PyObject
*, void *);
518 typedef struct ghash_pyobj
{
524 extern PyTypeObject
*ghash_pytype
, *gmhash_pytype
;
525 extern PyObject
*sha_pyobj
, *has160_pyobj
;
526 #define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
527 #define GHASH_H(o) (((ghash_pyobj *)(o))->h)
528 #define GHASH_F(o) (((ghash_pyobj *)(o))->f)
529 extern PyObject
*ghash_pywrap(PyObject
*, ghash
*, unsigned);
530 extern int convghash(PyObject
*, void *);
531 extern int convgmhash(PyObject
*, void *);
533 typedef struct gcmac_pyobj
{
538 extern PyTypeObject
*gcmac_pytype
;
539 #define GCMAC_PYCHECK(o) PyObject_TypeCheck((o), gcmac_pytype)
540 #define GCMAC_CM(o) (((gcmac_pyobj *)(o))->cm)
541 #define GCMAC_F(o) (((gcmac_pyobj *)(o))->f)
542 extern PyObject
*gcmac_pywrap(gcmac
*);
543 extern int convgcmac(PyObject
*, void *);
545 typedef struct gmac_pyobj
{
551 extern PyTypeObject
*gmac_pytype
;
552 #define GMAC_PYCHECK(o) PyObject_TypeCheck((o), gmac_pytype)
553 #define GMAC_M(o) (((gmac_pyobj *)(o))->m)
554 #define GMAC_F(o) (((gmac_pyobj *)(o))->f)
555 extern PyObject
*gmac_pywrap(PyObject
*, gmac
*, unsigned);
556 extern int convgmac(PyObject
*, void *);
558 /*----- Key generation ----------------------------------------------------*/
560 typedef struct pfilt_pyobj
{
566 extern PyTypeObject
*pfilt_pytype
;
567 #define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
568 #define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
569 #define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
571 typedef struct { pgen_proc
*proc
; void *ctx
; } pgev
;
572 #define PGEV_HEAD PyObject_HEAD pgev pg;
574 typedef struct pgev_pyobj
{
578 extern PyTypeObject
*pgev_pytype
;
579 #define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
580 #define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
582 extern int convpgev(PyObject
*, void *);
583 extern void droppgev(pgev
*);
584 extern void pgenerr(void);
586 /*----- That's all, folks -------------------------------------------------*/