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 ------------------------------------------------------*/
37 #include <longintrepr.h>
38 #include <structmember.h>
43 #include <mLib/darray.h>
44 #include <mLib/dstr.h>
45 #include <mLib/macros.h>
46 #include <mLib/quis.h>
47 #include <mLib/unihash.h>
49 #include <catacomb/buf.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/sha.h>
69 #include <catacomb/sha-mgf.h>
70 #include <catacomb/sha-hmac.h>
72 #include <catacomb/mp.h>
73 #include <catacomb/mpint.h>
74 #include <catacomb/mpmul.h>
75 #include <catacomb/mpcrt.h>
76 #include <catacomb/mpmont.h>
77 #include <catacomb/mpbarrett.h>
78 #include <catacomb/mpreduce.h>
79 #include <catacomb/mp-fibonacci.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 SYSERR(str) EXCERR(PyExc_SystemError, str)
132 #define NIERR(str) EXCERR(PyExc_NotImplementedError, str)
133 #define INDEXERR(idx) do { \
134 PyErr_SetObject(PyExc_KeyError, idx); \
137 #define OSERR(name) do { \
138 PyErr_SetFromErrnoWithFilename(PyExc_OSError, name); \
141 #define PGENERR do { pgenerr(); goto end; } while (0)
143 #define CONVFUNC(ty, cty, ext) \
144 int conv##ty(PyObject *o, void *p) \
146 if (!PyObject_TypeCheck(o, ty##_pytype)) \
147 TYERR("wanted a " #ty); \
148 *(cty *)p = ext(o); \
154 #if PY_VERSION_HEX < 0x02050000 /* Compatibility hack */
155 # define ht_name name
156 # define ht_type type
159 #define root_pytype 0
160 #define type_pytype &PyType_Type
161 #define INITTYPE(ty, base) do { \
162 ty##_pytype_skel.tp_base = base##_pytype; \
163 ty##_pytype = inittype(&ty##_pytype_skel); \
166 #define INSERT(name, ob) do { \
167 PyObject *_o = (PyObject *)(ob); \
169 PyModule_AddObject(mod, name, _o); \
172 #define INSEXC(name, var, base, meth) \
173 INSERT(name, var = mkexc(mod, base, name, meth))
175 #define METH(func, doc) \
176 { #func, METHNAME(func), METH_VARARGS, doc },
177 #define KWMETH(func, doc) \
178 { #func, (PyCFunction)METHNAME(func), \
179 METH_VARARGS | METH_KEYWORDS, doc },
181 #define GET(func, doc) \
182 { #func, GETSETNAME(get, func), 0, doc },
183 #define GETSET(func, doc) \
184 { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
186 #define MEMBER(name, ty, f, doc) \
187 { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
191 _(bytestring) _(buffer) \
192 _(rand) _(algorithms) _(pubkey) _(pgen) \
193 _(mp) _(field) _(ec) _(group) \
194 _(passphrase) _(share) _(key)
195 #define DOMODINIT(m) m##_pyinit();
196 #define DOMODINSERT(m) m##_pyinsert(mod);
197 #define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
198 #define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
201 extern void m##_pyinit(void); \
202 extern void m##_pyinsert(PyObject *);
206 #define FREEOBJ(obj) \
207 (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
209 #define GEN(func, base) \
210 static PyObject *func(void) \
212 PyObject *d = PyDict_New(); \
216 for (i = 0; g##base##tab[i]; i++) { \
217 o = gc##base##_pywrap((/*unconst*/ gc##base *)g##base##tab[i]); \
218 PyDict_SetItemString(d, \
219 (/*unconst*/ char *)g##base##tab[i]->name, \
226 struct nameval
{ const char *name
; unsigned long value
; };
227 extern void setconstants(PyObject
*, const struct nameval
*);
229 extern PyObject
*mexp_common(PyObject
*, PyObject
*, size_t,
230 PyObject
*(*id
)(PyObject
*),
231 int (*fill
)(void *, PyObject
*,
232 PyObject
*, PyObject
*),
233 PyObject
*(*exp
)(PyObject
*, void *, int),
234 void (*drop
)(void *));
236 extern int convulong(PyObject
*, void *);
237 #define DECL_CONVU_(n) extern int convu##n(PyObject *, void *);
238 DOUINTSZ(DECL_CONVU_
)
239 extern int convmpw(PyObject
*, void *);
240 extern int convuint(PyObject
*, void *);
241 extern int convszt(PyObject
*, void *);
242 extern int convbool(PyObject
*, void *);
243 extern PyObject
*abstract_pynew(PyTypeObject
*, PyObject
*, PyObject
*);
244 extern PyObject
*getbool(int);
245 extern PyObject
*getulong(unsigned long);
246 extern void *newtype(PyTypeObject
*, const PyTypeObject
*, const char *);
248 extern PyObject
*mkexc(PyObject
*, PyObject
*, const char *, PyMethodDef
*);
249 extern void typeready(PyTypeObject
*);
250 extern PyTypeObject
*inittype(PyTypeObject
*);
251 extern void addmethods(const PyMethodDef
*);
252 extern PyMethodDef
*donemethods(void);
254 /*----- Mapping methods ---------------------------------------------------*/
256 #define GMAP_METH(func, doc) { #func, gmapmeth_##func, METH_VARARGS, doc },
257 #define GMAP_KWMETH(func, doc) \
258 { #func, (PyCFunction)gmapmeth_##func, METH_VARARGS|METH_KEYWORDS, doc },
259 #define GMAP_METHDECL(func, doc) \
260 extern PyObject *gmapmeth_##func(PyObject *, PyObject *);
261 #define GMAP_KWMETHDECL(func, doc) \
262 extern PyObject *gmapmeth_##func(PyObject *, PyObject *, PyObject *);
264 #define GMAP_DOROMETHODS(METH, KWMETH) \
265 METH (has_key, "D.has_key(KEY) -> BOOL") \
266 METH (keys, "D.keys() -> LIST") \
267 METH (values, "D.values() -> LIST") \
268 METH (items, "D.items() -> LIST") \
269 METH (iterkeys, "D.iterkeys() -> ITER") \
270 METH (itervalues, "D.itervalues() -> ITER") \
271 METH (iteritems, "D.iteritems() -> ITER") \
272 KWMETH(get, "D.get(KEY, [default = None]) -> VALUE") \
274 #define GMAP_DOMETHODS(METH, KWMETH) \
275 GMAP_DOROMETHODS(METH, KWMETH) \
276 METH (clear, "D.clear()") \
277 KWMETH(setdefault, "D.setdefault(K, [default = None]) -> VALUE") \
278 KWMETH(pop, "D.pop(KEY, [default = <error>]) -> VALUE") \
279 METH (popitem, "D.popitem() -> (KEY, VALUE)") \
280 METH (update, "D.update(MAP)")
282 GMAP_DOMETHODS(GMAP_METHDECL
, GMAP_KWMETHDECL
)
283 #define GMAP_ROMETHODS GMAP_DOROMETHODS(GMAP_METH, GMAP_KWMETH)
284 #define GMAP_METHODS GMAP_DOMETHODS(GMAP_METH, GMAP_KWMETH)
285 extern int gmap_pysize(PyObject
*);
286 extern PySequenceMethods gmap_pysequence
;
287 extern PyMethodDef gmap_pymethods
[];
289 /*----- Bytestrings -------------------------------------------------------*/
291 PyTypeObject
*bytestring_pyobj
;
292 PyObject
*bytestring_pywrap(const void *, size_t);
293 PyObject
*bytestring_pywrapbuf(buf
*);
295 /*----- Multiprecision arithmetic -----------------------------------------*/
297 typedef struct mp_pyobj
{
302 extern PyTypeObject
*mp_pytype
;
303 extern PyTypeObject
*gf_pytype
;
304 #define MP_X(o) (((mp_pyobj *)(o))->x)
305 #define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
306 #define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
308 extern mp
*mp_frompylong(PyObject
*);
309 extern PyObject
*mp_topylong(mp
*);
310 extern mp
*tomp(PyObject
*);
311 extern mp
*getmp(PyObject
*);
312 extern int convmp(PyObject
*, void *);
313 extern mp
*getgf(PyObject
*);
314 extern int convgf(PyObject
*, void *);
315 extern PyObject
*mp_pywrap(mp
*);
316 extern PyObject
*gf_pywrap(mp
*);
317 extern mp
*mp_frompyobject(PyObject
*, int);
318 extern PyObject
*mp_topystring(mp
*, int,
319 const char *, const char *, const char *);
320 extern int mp_tolong_checked(mp
*, long *);
322 /*----- Abstract fields ---------------------------------------------------*/
324 typedef struct field_pyobj
{
329 extern PyTypeObject
*fe_pytype
;
330 #define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
331 #define FE_F(o) (((fe_pyobj *)(o))->f)
332 #define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
333 #define FE_X(o) (((fe_pyobj *)(o))->x)
334 extern PyObject
*fe_pywrap(PyObject
*, mp
*);
335 extern mp
*getfe(field
*, PyObject
*);
337 typedef struct fe_pyobj
{
343 extern PyTypeObject
*field_pytype
;
344 extern PyTypeObject
*primefield_pytype
;
345 extern PyTypeObject
*niceprimefield_pytype
;
346 extern PyTypeObject
*binfield_pytype
;
347 extern PyTypeObject
*binpolyfield_pytype
;
348 extern PyTypeObject
*binnormfield_pytype
;
349 #define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
350 #define FIELD_F(o) (((field_pyobj *)(o))->f)
351 extern PyObject
*field_pywrap(field
*);
352 extern field
*field_copy(field
*);
354 /*----- Elliptic curves ---------------------------------------------------*/
356 typedef struct ecpt_pyobj
{
362 extern PyTypeObject
*ecpt_pytype
, *ecptcurve_pytype
;
363 #define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
364 #define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
365 #define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
366 #define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
367 #define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
368 #define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
369 extern PyObject
*ecpt_pywrap(PyObject
*, ec
*);
370 extern PyObject
*ecpt_pywrapout(void *, ec
*);
371 extern int toecpt(ec_curve
*, ec
*, PyObject
*);
372 extern int getecpt(ec_curve
*, ec
*, PyObject
*);
373 extern void getecptout(ec
*, PyObject
*);
374 extern int convecpt(PyObject
*, void *);
376 typedef struct eccurve_pyobj
{
382 extern PyTypeObject
*eccurve_pytype
;
383 extern PyTypeObject
*ecprimecurve_pytype
;
384 extern PyTypeObject
*ecprimeprojcurve_pytype
;
385 extern PyTypeObject
*ecbincurve_pytype
;
386 extern PyTypeObject
*ecbinprojcurve_pytype
;
387 #define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
388 #define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
389 #define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
390 extern PyObject
*eccurve_pywrap(PyObject
*, ec_curve
*);
391 extern ec_curve
*eccurve_copy(ec_curve
*);
393 typedef struct ecinfo_pyobj
{
399 extern PyTypeObject
*ecinfo_pytype
;
400 #define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
401 #define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
402 #define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
403 extern void ecinfo_copy(ec_info
*, const ec_info
*);
404 extern PyObject
*ecinfo_pywrap(ec_info
*);
406 /*----- Cyclic groups -----------------------------------------------------*/
408 typedef struct fginfo_pyobj
{
413 PyTypeObject
*fginfo_pytype
, *dhinfo_pytype
, *bindhinfo_pytype
;
414 #define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
415 PyObject
*fginfo_pywrap(gprime_param
*, PyTypeObject
*);
417 typedef struct ge_pyobj
{
423 extern PyTypeObject
*ge_pytype
;
424 #define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
425 #define GE_X(o) (((ge_pyobj *)(o))->x)
426 #define GE_G(o) (((ge_pyobj *)(o))->g)
427 #define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
428 extern PyObject
*ge_pywrap(PyObject
*, ge
*);
430 typedef struct group_pyobj
{
435 extern PyTypeObject
*group_pytype
;
436 extern PyTypeObject
*primegroup_pytype
, *bingroup_pytype
, *ecgroup_pytype
;
437 #define GROUP_G(o) (((group_pyobj *)(o))->g)
438 extern PyObject
*group_pywrap(group
*);
439 extern group
*group_copy(group
*);
441 /*----- Random number generators ------------------------------------------*/
445 typedef struct grand_pyobj
{
451 extern PyTypeObject
*grand_pytype
, *truerand_pytype
;
452 extern PyTypeObject
*lcrand_pytype
,* fibrand_pytype
;
453 extern PyTypeObject
*dsarand_pytype
, *bbs_pytype
;
454 extern PyObject
*rand_pyobj
;
455 #define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
456 #define GRAND_F(o) (((grand_pyobj *)(o))->f)
457 #define GRAND_R(o) (((grand_pyobj *)(o))->r)
458 extern PyObject
*grand_pywrap(grand
*, unsigned);
459 extern int convgrand(PyObject
*, void *);
461 /*----- Key sizes ---------------------------------------------------------*/
463 typedef struct keysz_pyobj
{
468 typedef struct keyszrange_pyobj
{
474 typedef struct keyszset_pyobj
{
480 #define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
481 extern PyObject
*keysz_pywrap(const octet
*);
483 /*----- Symmetric cryptography --------------------------------------------*/
485 typedef struct gccipher_pyobj
{
490 extern PyTypeObject
*gccipher_pytype
;
491 #define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
492 #define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
493 #define GCCIPHER_F(o) (((gccipher_pyobj *)(o))->f)
494 extern PyObject
*gccipher_pywrap(gccipher
*);
495 extern int convgccipher(PyObject
*, void *);
496 extern int convgcipher(PyObject
*, void *);
498 typedef struct gcipher_pyobj
{
504 extern PyTypeObject
*gcipher_pytype
;
505 #define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
506 #define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
507 #define GCIPHER_F(o) (((gcipher_pyobj *)(o))->f)
508 extern PyObject
*gcipher_pywrap(PyObject
*, gcipher
*, unsigned);
509 extern int convgcipher(PyObject
*, void *);
511 typedef struct gchash_pyobj
{
516 extern PyTypeObject
*gchash_pytype
;
517 #define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
518 #define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
519 #define GCHASH_F(o) (((gchash_pyobj *)(o))->f)
520 extern PyObject
*gchash_pywrap(gchash
*);
521 extern int convgchash(PyObject
*, void *);
523 typedef struct ghash_pyobj
{
529 extern PyTypeObject
*ghash_pytype
, *gmhash_pytype
;
530 extern PyObject
*sha_pyobj
, *has160_pyobj
;
531 #define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
532 #define GHASH_H(o) (((ghash_pyobj *)(o))->h)
533 #define GHASH_F(o) (((ghash_pyobj *)(o))->f)
534 extern PyObject
*ghash_pywrap(PyObject
*, ghash
*, unsigned);
535 extern int convghash(PyObject
*, void *);
536 extern int convgmhash(PyObject
*, void *);
538 typedef struct gcmac_pyobj
{
543 extern PyTypeObject
*gcmac_pytype
;
544 #define GCMAC_PYCHECK(o) PyObject_TypeCheck((o), gcmac_pytype)
545 #define GCMAC_CM(o) (((gcmac_pyobj *)(o))->cm)
546 #define GCMAC_F(o) (((gcmac_pyobj *)(o))->f)
547 extern PyObject
*gcmac_pywrap(gcmac
*);
548 extern int convgcmac(PyObject
*, void *);
550 typedef struct gmac_pyobj
{
556 extern PyTypeObject
*gmac_pytype
;
557 #define GMAC_PYCHECK(o) PyObject_TypeCheck((o), gmac_pytype)
558 #define GMAC_M(o) (((gmac_pyobj *)(o))->m)
559 #define GMAC_F(o) (((gmac_pyobj *)(o))->f)
560 extern PyObject
*gmac_pywrap(PyObject
*, gmac
*, unsigned);
561 extern int convgmac(PyObject
*, void *);
563 /*----- Key generation ----------------------------------------------------*/
565 typedef struct pfilt_pyobj
{
571 extern PyTypeObject
*pfilt_pytype
;
572 #define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
573 #define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
574 #define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
576 typedef struct { pgen_proc
*proc
; void *ctx
; } pgev
;
577 #define PGEV_HEAD PyObject_HEAD pgev pg;
579 typedef struct pgev_pyobj
{
583 extern PyTypeObject
*pgev_pytype
;
584 #define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
585 #define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
587 extern int convpgev(PyObject
*, void *);
588 extern void droppgev(pgev
*);
589 extern void pgenerr(void);
591 /*----- That's all, folks -------------------------------------------------*/