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>
92 #include <catacomb/gf.h>
93 #include <catacomb/gfreduce.h>
94 #include <catacomb/gfn.h>
96 #include <catacomb/field.h>
97 #include <catacomb/field-guts.h>
99 #include <catacomb/ec.h>
100 #include <catacomb/ec-raw.h>
101 #include <catacomb/ectab.h>
103 #include <catacomb/group.h>
104 #include <catacomb/group-guts.h>
106 #include <catacomb/gdsa.h>
107 #include <catacomb/gkcdsa.h>
108 #include <catacomb/rsa.h>
110 #include <catacomb/key.h>
111 #include <catacomb/passphrase.h>
112 #include <catacomb/pixie.h>
114 #include <catacomb/share.h>
115 #include <catacomb/gfshare.h>
117 /*----- Utility macros ----------------------------------------------------*/
119 #define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
120 #define RETURN_NONE RETURN_OBJ(Py_None)
121 #define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
122 #define RETURN_TRUE RETURN_OBJ(Py_True)
123 #define RETURN_FALSE RETURN_OBJ(Py_False)
124 #define RETURN_ME RETURN_OBJ(me)
126 #define EXCERR(exc, str) do { \
127 PyErr_SetString(exc, str); \
130 #define VALERR(str) EXCERR(PyExc_ValueError, str)
131 #define TYERR(str) EXCERR(PyExc_TypeError, str)
132 #define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
133 #define SYSERR(str) EXCERR(PyExc_SystemError, str)
134 #define NIERR(str) EXCERR(PyExc_NotImplementedError, str)
135 #define INDEXERR(idx) do { \
136 PyErr_SetObject(PyExc_KeyError, idx); \
139 #define OSERR(name) do { \
140 PyErr_SetFromErrnoWithFilename(PyExc_OSError, name); \
143 #define PGENERR do { pgenerr(); goto end; } while (0)
145 #define CONVFUNC(ty, cty, ext) \
146 int conv##ty(PyObject *o, void *p) \
148 if (!PyObject_TypeCheck(o, ty##_pytype)) \
149 TYERR("wanted a " #ty); \
150 *(cty *)p = ext(o); \
156 #if PY_VERSION_HEX < 0x02050000 /* Compatibility hack */
157 # define ht_name name
158 # define ht_type type
161 #define root_pytype 0
162 #define type_pytype &PyType_Type
163 #define INITTYPE_META(ty, base, meta) do { \
164 ty##_pytype_skel.tp_base = base##_pytype; \
165 ty##_pytype = inittype(&ty##_pytype_skel, meta##_pytype); \
167 #define INITTYPE(ty, base) INITTYPE_META(ty, base, type)
169 #define INSERT(name, ob) do { \
170 PyObject *_o = (PyObject *)(ob); \
172 PyModule_AddObject(mod, name, _o); \
175 #define INSEXC(name, var, base, meth) \
176 INSERT(name, var = mkexc(mod, base, name, meth))
178 #define METH(func, doc) \
179 { #func, METHNAME(func), METH_VARARGS, doc },
180 #define KWMETH(func, doc) \
181 { #func, (PyCFunction)METHNAME(func), \
182 METH_VARARGS | METH_KEYWORDS, doc },
184 #define GET(func, doc) \
185 { #func, GETSETNAME(get, func), 0, doc },
186 #define GETSET(func, doc) \
187 { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
189 #define MEMBER(name, ty, f, doc) \
190 { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
194 _(bytestring) _(buffer) \
195 _(rand) _(algorithms) _(pubkey) _(pgen) \
196 _(mp) _(field) _(ec) _(group) \
197 _(passphrase) _(share) _(key)
198 #define DOMODINIT(m) m##_pyinit();
199 #define DOMODINSERT(m) m##_pyinsert(mod);
200 #define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
201 #define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
204 extern void m##_pyinit(void); \
205 extern void m##_pyinsert(PyObject *);
209 #define FREEOBJ(obj) \
210 (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
212 #define GEN(func, base) \
213 static PyObject *func(void) \
215 PyObject *d = PyDict_New(); \
219 for (i = 0; g##base##tab[i]; i++) { \
220 o = gc##base##_pywrap((/*unconst*/ gc##base *)g##base##tab[i]); \
221 PyDict_SetItemString(d, \
222 (/*unconst*/ char *)g##base##tab[i]->name, \
229 struct nameval
{ const char *name
; unsigned long value
; };
230 extern void setconstants(PyObject
*, const struct nameval
*);
232 extern PyObject
*mexp_common(PyObject
*, PyObject
*, size_t,
233 PyObject
*(*id
)(PyObject
*),
234 int (*fill
)(void *, PyObject
*,
235 PyObject
*, PyObject
*),
236 PyObject
*(*exp
)(PyObject
*, void *, int),
237 void (*drop
)(void *));
239 extern int convulong(PyObject
*, void *);
240 #define DECL_CONVU_(n) extern int convu##n(PyObject *, void *);
241 DOUINTSZ(DECL_CONVU_
)
242 extern int convmpw(PyObject
*, void *);
243 extern int convuint(PyObject
*, void *);
244 extern int convk64(PyObject
*, void *);
245 extern int convszt(PyObject
*, void *);
246 extern int convbool(PyObject
*, void *);
247 extern PyObject
*abstract_pynew(PyTypeObject
*, PyObject
*, PyObject
*);
248 extern PyObject
*getbool(int);
249 extern PyObject
*getulong(unsigned long);
250 extern PyObject
*getk64(kludge64
);
251 extern void *newtype(PyTypeObject
*, const PyTypeObject
*, const char *);
253 extern PyObject
*mkexc(PyObject
*, PyObject
*, const char *, PyMethodDef
*);
254 extern void typeready(PyTypeObject
*);
255 extern PyTypeObject
*inittype(PyTypeObject
*, PyTypeObject
*);
256 extern void addmethods(const PyMethodDef
*);
257 extern PyMethodDef
*donemethods(void);
259 /*----- Mapping methods ---------------------------------------------------*/
261 #define GMAP_METH(func, doc) { #func, gmapmeth_##func, METH_VARARGS, doc },
262 #define GMAP_KWMETH(func, doc) \
263 { #func, (PyCFunction)gmapmeth_##func, METH_VARARGS|METH_KEYWORDS, doc },
264 #define GMAP_METHDECL(func, doc) \
265 extern PyObject *gmapmeth_##func(PyObject *, PyObject *);
266 #define GMAP_KWMETHDECL(func, doc) \
267 extern PyObject *gmapmeth_##func(PyObject *, PyObject *, PyObject *);
269 #define GMAP_DOROMETHODS(METH, KWMETH) \
270 METH (has_key, "D.has_key(KEY) -> BOOL") \
271 METH (keys, "D.keys() -> LIST") \
272 METH (values, "D.values() -> LIST") \
273 METH (items, "D.items() -> LIST") \
274 METH (iterkeys, "D.iterkeys() -> ITER") \
275 METH (itervalues, "D.itervalues() -> ITER") \
276 METH (iteritems, "D.iteritems() -> ITER") \
277 KWMETH(get, "D.get(KEY, [default = None]) -> VALUE") \
279 #define GMAP_DOMETHODS(METH, KWMETH) \
280 GMAP_DOROMETHODS(METH, KWMETH) \
281 METH (clear, "D.clear()") \
282 KWMETH(setdefault, "D.setdefault(K, [default = None]) -> VALUE") \
283 KWMETH(pop, "D.pop(KEY, [default = <error>]) -> VALUE") \
284 METH (popitem, "D.popitem() -> (KEY, VALUE)") \
285 METH (update, "D.update(MAP)")
287 GMAP_DOMETHODS(GMAP_METHDECL
, GMAP_KWMETHDECL
)
288 #define GMAP_ROMETHODS GMAP_DOROMETHODS(GMAP_METH, GMAP_KWMETH)
289 #define GMAP_METHODS GMAP_DOMETHODS(GMAP_METH, GMAP_KWMETH)
290 extern Py_ssize_t
gmap_pysize(PyObject
*);
291 extern PySequenceMethods gmap_pysequence
;
292 extern PyMethodDef gmap_pymethods
[];
294 /*----- Bytestrings -------------------------------------------------------*/
296 PyTypeObject
*bytestring_pyobj
;
297 PyObject
*bytestring_pywrap(const void *, size_t);
298 PyObject
*bytestring_pywrapbuf(buf
*);
300 /*----- Multiprecision arithmetic -----------------------------------------*/
302 typedef struct mp_pyobj
{
307 extern PyTypeObject
*mp_pytype
;
308 extern PyTypeObject
*gf_pytype
;
309 #define MP_X(o) (((mp_pyobj *)(o))->x)
310 #define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
311 #define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
313 extern mp
*mp_frompylong(PyObject
*);
314 extern PyObject
*mp_topylong(mp
*);
315 extern mp
*tomp(PyObject
*);
316 extern mp
*getmp(PyObject
*);
317 extern int convmp(PyObject
*, void *);
318 extern mp
*getgf(PyObject
*);
319 extern int convgf(PyObject
*, void *);
320 extern PyObject
*mp_pywrap(mp
*);
321 extern PyObject
*gf_pywrap(mp
*);
322 extern mp
*mp_frompyobject(PyObject
*, int);
323 extern PyObject
*mp_topystring(mp
*, int,
324 const char *, const char *, const char *);
325 extern int mp_tolong_checked(mp
*, long *, int);
327 /*----- Abstract fields ---------------------------------------------------*/
329 typedef struct field_pyobj
{
334 extern PyTypeObject
*fe_pytype
;
335 #define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
336 #define FE_F(o) (((fe_pyobj *)(o))->f)
337 #define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
338 #define FE_X(o) (((fe_pyobj *)(o))->x)
339 extern PyObject
*fe_pywrap(PyObject
*, mp
*);
340 extern mp
*getfe(field
*, PyObject
*);
342 typedef struct fe_pyobj
{
348 extern PyTypeObject
*field_pytype
;
349 extern PyTypeObject
*primefield_pytype
;
350 extern PyTypeObject
*niceprimefield_pytype
;
351 extern PyTypeObject
*binfield_pytype
;
352 extern PyTypeObject
*binpolyfield_pytype
;
353 extern PyTypeObject
*binnormfield_pytype
;
354 #define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
355 #define FIELD_F(o) (((field_pyobj *)(o))->f)
356 extern PyObject
*field_pywrap(field
*);
357 extern field
*field_copy(field
*);
359 /*----- Elliptic curves ---------------------------------------------------*/
361 typedef struct ecpt_pyobj
{
367 extern PyTypeObject
*ecpt_pytype
, *ecptcurve_pytype
;
368 #define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
369 #define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
370 #define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
371 #define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
372 #define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
373 #define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
374 extern PyObject
*ecpt_pywrap(PyObject
*, ec
*);
375 extern PyObject
*ecpt_pywrapout(void *, ec
*);
376 extern int toecpt(ec_curve
*, ec
*, PyObject
*);
377 extern int getecpt(ec_curve
*, ec
*, PyObject
*);
378 extern void getecptout(ec
*, PyObject
*);
379 extern int convecpt(PyObject
*, void *);
381 typedef struct eccurve_pyobj
{
387 extern PyTypeObject
*eccurve_pytype
;
388 extern PyTypeObject
*ecprimecurve_pytype
;
389 extern PyTypeObject
*ecprimeprojcurve_pytype
;
390 extern PyTypeObject
*ecbincurve_pytype
;
391 extern PyTypeObject
*ecbinprojcurve_pytype
;
392 #define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
393 #define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
394 #define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
395 extern PyObject
*eccurve_pywrap(PyObject
*, ec_curve
*);
396 extern ec_curve
*eccurve_copy(ec_curve
*);
398 typedef struct ecinfo_pyobj
{
404 extern PyTypeObject
*ecinfo_pytype
;
405 #define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
406 #define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
407 #define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
408 extern void ecinfo_copy(ec_info
*, const ec_info
*);
409 extern PyObject
*ecinfo_pywrap(ec_info
*);
411 /*----- Cyclic groups -----------------------------------------------------*/
413 typedef struct fginfo_pyobj
{
418 PyTypeObject
*fginfo_pytype
, *dhinfo_pytype
, *bindhinfo_pytype
;
419 #define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
420 PyObject
*fginfo_pywrap(gprime_param
*, PyTypeObject
*);
422 typedef struct ge_pyobj
{
428 extern PyTypeObject
*ge_pytype
;
429 #define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
430 #define GE_X(o) (((ge_pyobj *)(o))->x)
431 #define GE_G(o) (((ge_pyobj *)(o))->g)
432 #define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
433 extern PyObject
*ge_pywrap(PyObject
*, ge
*);
435 typedef struct group_pyobj
{
440 extern PyTypeObject
*group_pytype
;
441 extern PyTypeObject
*primegroup_pytype
, *bingroup_pytype
, *ecgroup_pytype
;
442 #define GROUP_G(o) (((group_pyobj *)(o))->g)
443 extern PyObject
*group_pywrap(group
*);
444 extern group
*group_copy(group
*);
446 /*----- Random number generators ------------------------------------------*/
450 typedef struct grand_pyobj
{
456 extern PyTypeObject
*grand_pytype
, *truerand_pytype
;
457 extern PyTypeObject
*lcrand_pytype
,* fibrand_pytype
;
458 extern PyTypeObject
*dsarand_pytype
, *bbs_pytype
;
459 extern PyObject
*rand_pyobj
;
460 #define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
461 #define GRAND_F(o) (((grand_pyobj *)(o))->f)
462 #define GRAND_R(o) (((grand_pyobj *)(o))->r)
463 extern PyObject
*grand_pywrap(grand
*, unsigned);
464 extern int convgrand(PyObject
*, void *);
466 /*----- Key sizes ---------------------------------------------------------*/
468 typedef struct keysz_pyobj
{
473 typedef struct keyszrange_pyobj
{
479 typedef struct keyszset_pyobj
{
485 #define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
486 extern PyObject
*keysz_pywrap(const octet
*);
488 /*----- Symmetric cryptography --------------------------------------------*/
490 typedef struct gccipher_pyobj
{
495 extern PyTypeObject
*gccipher_pytype
;
496 #define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
497 #define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
498 #define GCCIPHER_F(o) (((gccipher_pyobj *)(o))->f)
499 extern PyObject
*gccipher_pywrap(gccipher
*);
500 extern int convgccipher(PyObject
*, void *);
501 extern int convgcipher(PyObject
*, void *);
503 typedef struct gcipher_pyobj
{
509 extern PyTypeObject
*gcipher_pytype
;
510 #define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
511 #define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
512 #define GCIPHER_F(o) (((gcipher_pyobj *)(o))->f)
513 extern PyObject
*gcipher_pywrap(PyObject
*, gcipher
*, unsigned);
514 extern int convgcipher(PyObject
*, void *);
516 typedef struct gchash_pyobj
{
521 extern PyTypeObject
*gchash_pytype
;
522 #define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
523 #define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
524 #define GCHASH_F(o) (((gchash_pyobj *)(o))->f)
525 extern PyObject
*gchash_pywrap(gchash
*);
526 extern int convgchash(PyObject
*, void *);
528 typedef struct ghash_pyobj
{
534 extern PyTypeObject
*ghash_pytype
, *gmhash_pytype
;
535 extern PyObject
*sha_pyobj
, *has160_pyobj
;
536 #define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
537 #define GHASH_H(o) (((ghash_pyobj *)(o))->h)
538 #define GHASH_F(o) (((ghash_pyobj *)(o))->f)
539 extern PyObject
*ghash_pywrap(PyObject
*, ghash
*, unsigned);
540 extern int convghash(PyObject
*, void *);
541 extern int convgmhash(PyObject
*, void *);
543 typedef struct gcmac_pyobj
{
548 extern PyTypeObject
*gcmac_pytype
;
549 #define GCMAC_PYCHECK(o) PyObject_TypeCheck((o), gcmac_pytype)
550 #define GCMAC_CM(o) (((gcmac_pyobj *)(o))->cm)
551 #define GCMAC_F(o) (((gcmac_pyobj *)(o))->f)
552 extern PyObject
*gcmac_pywrap(gcmac
*);
553 extern int convgcmac(PyObject
*, void *);
555 typedef struct gmac_pyobj
{
561 extern PyTypeObject
*gmac_pytype
;
562 #define GMAC_PYCHECK(o) PyObject_TypeCheck((o), gmac_pytype)
563 #define GMAC_M(o) (((gmac_pyobj *)(o))->m)
564 #define GMAC_F(o) (((gmac_pyobj *)(o))->f)
565 extern PyObject
*gmac_pywrap(PyObject
*, gmac
*, unsigned);
566 extern int convgmac(PyObject
*, void *);
568 /*----- Key generation ----------------------------------------------------*/
570 typedef struct pfilt_pyobj
{
576 extern PyTypeObject
*pfilt_pytype
;
577 #define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
578 #define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
579 #define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
581 typedef struct { pgen_proc
*proc
; void *ctx
; } pgev
;
582 #define PGEV_HEAD PyObject_HEAD pgev pg;
584 typedef struct pgev_pyobj
{
588 extern PyTypeObject
*pgev_pytype
;
589 #define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
590 #define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
592 extern int convpgev(PyObject
*, void *);
593 extern void droppgev(pgev
*);
594 extern void pgenerr(void);
596 /*----- That's all, folks -------------------------------------------------*/