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>
72 #include <catacomb/keccak1600.h>
74 #include <catacomb/mp.h>
75 #include <catacomb/mpint.h>
76 #include <catacomb/mpmul.h>
77 #include <catacomb/mpcrt.h>
78 #include <catacomb/mpmont.h>
79 #include <catacomb/mpbarrett.h>
80 #include <catacomb/mpreduce.h>
81 #include <catacomb/mp-fibonacci.h>
83 #include <catacomb/pgen.h>
84 #include <catacomb/pfilt.h>
85 #include <catacomb/strongprime.h>
86 #include <catacomb/limlee.h>
87 #include <catacomb/dh.h>
88 #include <catacomb/ptab.h>
89 #include <catacomb/bintab.h>
90 #include <catacomb/dsa.h>
91 #include <catacomb/x25519.h>
92 #include <catacomb/x448.h>
93 #include <catacomb/ed25519.h>
95 #include <catacomb/gf.h>
96 #include <catacomb/gfreduce.h>
97 #include <catacomb/gfn.h>
99 #include <catacomb/field.h>
100 #include <catacomb/field-guts.h>
102 #include <catacomb/ec.h>
103 #include <catacomb/ec-raw.h>
104 #include <catacomb/ectab.h>
106 #include <catacomb/group.h>
107 #include <catacomb/group-guts.h>
109 #include <catacomb/gdsa.h>
110 #include <catacomb/gkcdsa.h>
111 #include <catacomb/rsa.h>
113 #include <catacomb/key.h>
114 #include <catacomb/passphrase.h>
115 #include <catacomb/pixie.h>
117 #include <catacomb/share.h>
118 #include <catacomb/gfshare.h>
120 /*----- Utility macros ----------------------------------------------------*/
122 #define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
123 #define RETURN_NONE RETURN_OBJ(Py_None)
124 #define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
125 #define RETURN_TRUE RETURN_OBJ(Py_True)
126 #define RETURN_FALSE RETURN_OBJ(Py_False)
127 #define RETURN_ME RETURN_OBJ(me)
129 #define EXCERR(exc, str) do { \
130 PyErr_SetString(exc, str); \
133 #define VALERR(str) EXCERR(PyExc_ValueError, str)
134 #define TYERR(str) EXCERR(PyExc_TypeError, str)
135 #define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
136 #define SYSERR(str) EXCERR(PyExc_SystemError, str)
137 #define NIERR(str) EXCERR(PyExc_NotImplementedError, str)
138 #define INDEXERR(idx) do { \
139 PyErr_SetObject(PyExc_KeyError, idx); \
142 #define OSERR(name) do { \
143 PyErr_SetFromErrnoWithFilename(PyExc_OSError, name); \
146 #define PGENERR do { pgenerr(); goto end; } while (0)
148 #define CONVFUNC(ty, cty, ext) \
149 int conv##ty(PyObject *o, void *p) \
151 if (!PyObject_TypeCheck(o, ty##_pytype)) \
152 TYERR("wanted a " #ty); \
153 *(cty *)p = ext(o); \
159 #if PY_VERSION_HEX < 0x02050000 /* Compatibility hack */
160 # define ht_name name
161 # define ht_type type
164 #define root_pytype 0
165 #define type_pytype &PyType_Type
166 #define INITTYPE_META(ty, base, meta) do { \
167 ty##_pytype_skel.tp_base = base##_pytype; \
168 ty##_pytype = inittype(&ty##_pytype_skel, meta##_pytype); \
170 #define INITTYPE(ty, base) INITTYPE_META(ty, base, type)
172 #define INSERT(name, ob) do { \
173 PyObject *_o = (PyObject *)(ob); \
175 PyModule_AddObject(mod, name, _o); \
178 #define INSEXC(name, var, base, meth) \
179 INSERT(name, var = mkexc(mod, base, name, meth))
181 #define METH(func, doc) \
182 { #func, METHNAME(func), METH_VARARGS, doc },
183 #define KWMETH(func, doc) \
184 { #func, (PyCFunction)METHNAME(func), \
185 METH_VARARGS | METH_KEYWORDS, doc },
187 #define GET(func, doc) \
188 { #func, GETSETNAME(get, func), 0, doc },
189 #define GETSET(func, doc) \
190 { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
192 #define MEMBER(name, ty, f, doc) \
193 { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
197 _(bytestring) _(buffer) \
198 _(rand) _(algorithms) _(pubkey) _(pgen) \
199 _(mp) _(field) _(ec) _(group) \
200 _(passphrase) _(share) _(key)
201 #define DOMODINIT(m) m##_pyinit();
202 #define DOMODINSERT(m) m##_pyinsert(mod);
203 #define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
204 #define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
207 extern void m##_pyinit(void); \
208 extern void m##_pyinsert(PyObject *);
212 #define FREEOBJ(obj) \
213 (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
215 #define GEN(func, base) \
216 static PyObject *func(void) \
218 PyObject *d = PyDict_New(); \
222 for (i = 0; g##base##tab[i]; i++) { \
223 o = gc##base##_pywrap((/*unconst*/ gc##base *)g##base##tab[i]); \
224 PyDict_SetItemString(d, \
225 (/*unconst*/ char *)g##base##tab[i]->name, \
232 struct nameval
{ const char *name
; unsigned long value
; };
233 extern void setconstants(PyObject
*, const struct nameval
*);
235 extern PyObject
*mexp_common(PyObject
*, PyObject
*, size_t,
236 PyObject
*(*id
)(PyObject
*),
237 int (*fill
)(void *, PyObject
*,
238 PyObject
*, PyObject
*),
239 PyObject
*(*exp
)(PyObject
*, void *, int),
240 void (*drop
)(void *));
242 extern int convulong(PyObject
*, void *);
243 #define DECL_CONVU_(n) extern int convu##n(PyObject *, void *);
244 DOUINTSZ(DECL_CONVU_
)
245 extern int convmpw(PyObject
*, void *);
246 extern int convuint(PyObject
*, void *);
247 extern int convk64(PyObject
*, void *);
248 extern int convszt(PyObject
*, void *);
249 extern int convbool(PyObject
*, void *);
250 extern PyObject
*abstract_pynew(PyTypeObject
*, PyObject
*, PyObject
*);
251 extern PyObject
*getbool(int);
252 extern PyObject
*getulong(unsigned long);
253 extern PyObject
*getk64(kludge64
);
254 extern void *newtype(PyTypeObject
*, const PyTypeObject
*, const char *);
256 extern PyObject
*mkexc(PyObject
*, PyObject
*, const char *, PyMethodDef
*);
257 extern void typeready(PyTypeObject
*);
258 extern PyTypeObject
*inittype(PyTypeObject
*, PyTypeObject
*);
259 extern void addmethods(const PyMethodDef
*);
260 extern PyMethodDef
*donemethods(void);
262 /*----- Mapping methods ---------------------------------------------------*/
264 #define GMAP_METH(func, doc) { #func, gmapmeth_##func, METH_VARARGS, doc },
265 #define GMAP_KWMETH(func, doc) \
266 { #func, (PyCFunction)gmapmeth_##func, METH_VARARGS|METH_KEYWORDS, doc },
267 #define GMAP_METHDECL(func, doc) \
268 extern PyObject *gmapmeth_##func(PyObject *, PyObject *);
269 #define GMAP_KWMETHDECL(func, doc) \
270 extern PyObject *gmapmeth_##func(PyObject *, PyObject *, PyObject *);
272 #define GMAP_DOROMETHODS(METH, KWMETH) \
273 METH (has_key, "D.has_key(KEY) -> BOOL") \
274 METH (keys, "D.keys() -> LIST") \
275 METH (values, "D.values() -> LIST") \
276 METH (items, "D.items() -> LIST") \
277 METH (iterkeys, "D.iterkeys() -> ITER") \
278 METH (itervalues, "D.itervalues() -> ITER") \
279 METH (iteritems, "D.iteritems() -> ITER") \
280 KWMETH(get, "D.get(KEY, [default = None]) -> VALUE") \
282 #define GMAP_DOMETHODS(METH, KWMETH) \
283 GMAP_DOROMETHODS(METH, KWMETH) \
284 METH (clear, "D.clear()") \
285 KWMETH(setdefault, "D.setdefault(K, [default = None]) -> VALUE") \
286 KWMETH(pop, "D.pop(KEY, [default = <error>]) -> VALUE") \
287 METH (popitem, "D.popitem() -> (KEY, VALUE)") \
288 METH (update, "D.update(MAP)")
290 GMAP_DOMETHODS(GMAP_METHDECL
, GMAP_KWMETHDECL
)
291 #define GMAP_ROMETHODS GMAP_DOROMETHODS(GMAP_METH, GMAP_KWMETH)
292 #define GMAP_METHODS GMAP_DOMETHODS(GMAP_METH, GMAP_KWMETH)
293 extern Py_ssize_t
gmap_pysize(PyObject
*);
294 extern PySequenceMethods gmap_pysequence
;
295 extern PyMethodDef gmap_pymethods
[];
297 /*----- Bytestrings -------------------------------------------------------*/
299 PyTypeObject
*bytestring_pyobj
;
300 PyObject
*bytestring_pywrap(const void *, size_t);
301 PyObject
*bytestring_pywrapbuf(buf
*);
303 /*----- Multiprecision arithmetic -----------------------------------------*/
305 typedef struct mp_pyobj
{
310 extern PyTypeObject
*mp_pytype
;
311 extern PyTypeObject
*gf_pytype
;
312 #define MP_X(o) (((mp_pyobj *)(o))->x)
313 #define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
314 #define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
316 extern mp
*mp_frompylong(PyObject
*);
317 extern PyObject
*mp_topylong(mp
*);
318 extern mp
*tomp(PyObject
*);
319 extern mp
*getmp(PyObject
*);
320 extern int convmp(PyObject
*, void *);
321 extern mp
*getgf(PyObject
*);
322 extern int convgf(PyObject
*, void *);
323 extern PyObject
*mp_pywrap(mp
*);
324 extern PyObject
*gf_pywrap(mp
*);
325 extern mp
*mp_frompyobject(PyObject
*, int);
326 extern PyObject
*mp_topystring(mp
*, int,
327 const char *, const char *, const char *);
328 extern int mp_tolong_checked(mp
*, long *, int);
330 /*----- Abstract fields ---------------------------------------------------*/
332 typedef struct field_pyobj
{
337 extern PyTypeObject
*fe_pytype
;
338 #define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
339 #define FE_F(o) (((fe_pyobj *)(o))->f)
340 #define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
341 #define FE_X(o) (((fe_pyobj *)(o))->x)
342 extern PyObject
*fe_pywrap(PyObject
*, mp
*);
343 extern mp
*getfe(field
*, PyObject
*);
345 typedef struct fe_pyobj
{
351 extern PyTypeObject
*field_pytype
;
352 extern PyTypeObject
*primefield_pytype
;
353 extern PyTypeObject
*niceprimefield_pytype
;
354 extern PyTypeObject
*binfield_pytype
;
355 extern PyTypeObject
*binpolyfield_pytype
;
356 extern PyTypeObject
*binnormfield_pytype
;
357 #define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
358 #define FIELD_F(o) (((field_pyobj *)(o))->f)
359 extern PyObject
*field_pywrap(field
*);
360 extern field
*field_copy(field
*);
362 /*----- Elliptic curves ---------------------------------------------------*/
364 typedef struct ecpt_pyobj
{
370 extern PyTypeObject
*ecpt_pytype
, *ecptcurve_pytype
;
371 #define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
372 #define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
373 #define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
374 #define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
375 #define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
376 #define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
377 extern PyObject
*ecpt_pywrap(PyObject
*, ec
*);
378 extern PyObject
*ecpt_pywrapout(void *, ec
*);
379 extern int toecpt(ec_curve
*, ec
*, PyObject
*);
380 extern int getecpt(ec_curve
*, ec
*, PyObject
*);
381 extern void getecptout(ec
*, PyObject
*);
382 extern int convecpt(PyObject
*, void *);
384 typedef struct eccurve_pyobj
{
390 extern PyTypeObject
*eccurve_pytype
;
391 extern PyTypeObject
*ecprimecurve_pytype
;
392 extern PyTypeObject
*ecprimeprojcurve_pytype
;
393 extern PyTypeObject
*ecbincurve_pytype
;
394 extern PyTypeObject
*ecbinprojcurve_pytype
;
395 #define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
396 #define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
397 #define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
398 extern PyObject
*eccurve_pywrap(PyObject
*, ec_curve
*);
399 extern ec_curve
*eccurve_copy(ec_curve
*);
401 typedef struct ecinfo_pyobj
{
407 extern PyTypeObject
*ecinfo_pytype
;
408 #define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
409 #define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
410 #define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
411 extern void ecinfo_copy(ec_info
*, const ec_info
*);
412 extern PyObject
*ecinfo_pywrap(ec_info
*);
414 /*----- Cyclic groups -----------------------------------------------------*/
416 typedef struct fginfo_pyobj
{
421 PyTypeObject
*fginfo_pytype
, *dhinfo_pytype
, *bindhinfo_pytype
;
422 #define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
423 PyObject
*fginfo_pywrap(gprime_param
*, PyTypeObject
*);
425 typedef struct ge_pyobj
{
431 extern PyTypeObject
*ge_pytype
;
432 #define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
433 #define GE_X(o) (((ge_pyobj *)(o))->x)
434 #define GE_G(o) (((ge_pyobj *)(o))->g)
435 #define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
436 extern PyObject
*ge_pywrap(PyObject
*, ge
*);
438 typedef struct group_pyobj
{
443 extern PyTypeObject
*group_pytype
;
444 extern PyTypeObject
*primegroup_pytype
, *bingroup_pytype
, *ecgroup_pytype
;
445 #define GROUP_G(o) (((group_pyobj *)(o))->g)
446 extern PyObject
*group_pywrap(group
*);
447 extern group
*group_copy(group
*);
449 /*----- Random number generators ------------------------------------------*/
453 typedef struct grand_pyobj
{
459 extern PyTypeObject
*grand_pytype
, *truerand_pytype
;
460 extern PyTypeObject
*lcrand_pytype
,* fibrand_pytype
;
461 extern PyTypeObject
*dsarand_pytype
, *bbs_pytype
;
462 extern PyObject
*rand_pyobj
;
463 #define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
464 #define GRAND_F(o) (((grand_pyobj *)(o))->f)
465 #define GRAND_R(o) (((grand_pyobj *)(o))->r)
466 extern PyObject
*grand_pywrap(grand
*, unsigned);
467 extern int convgrand(PyObject
*, void *);
469 /*----- Key sizes ---------------------------------------------------------*/
471 typedef struct keysz_pyobj
{
476 typedef struct keyszrange_pyobj
{
482 typedef struct keyszset_pyobj
{
488 #define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
489 extern PyObject
*keysz_pywrap(const octet
*);
491 /*----- Symmetric cryptography --------------------------------------------*/
493 typedef struct gccipher_pyobj
{
498 extern PyTypeObject
*gccipher_pytype
;
499 #define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
500 #define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
501 #define GCCIPHER_F(o) (((gccipher_pyobj *)(o))->f)
502 extern PyObject
*gccipher_pywrap(gccipher
*);
503 extern int convgccipher(PyObject
*, void *);
504 extern int convgcipher(PyObject
*, void *);
506 typedef struct gcipher_pyobj
{
512 extern PyTypeObject
*gcipher_pytype
;
513 #define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
514 #define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
515 #define GCIPHER_F(o) (((gcipher_pyobj *)(o))->f)
516 extern PyObject
*gcipher_pywrap(PyObject
*, gcipher
*, unsigned);
517 extern int convgcipher(PyObject
*, void *);
519 typedef struct gchash_pyobj
{
524 extern PyTypeObject
*gchash_pytype
;
525 #define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
526 #define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
527 #define GCHASH_F(o) (((gchash_pyobj *)(o))->f)
528 extern PyObject
*gchash_pywrap(gchash
*);
529 extern int convgchash(PyObject
*, void *);
531 typedef struct ghash_pyobj
{
537 extern PyTypeObject
*ghash_pytype
, *gmhash_pytype
;
538 extern PyObject
*sha_pyobj
, *has160_pyobj
;
539 #define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
540 #define GHASH_H(o) (((ghash_pyobj *)(o))->h)
541 #define GHASH_F(o) (((ghash_pyobj *)(o))->f)
542 extern PyObject
*ghash_pywrap(PyObject
*, ghash
*, unsigned);
543 extern int convghash(PyObject
*, void *);
544 extern int convgmhash(PyObject
*, void *);
546 typedef struct gcmac_pyobj
{
551 extern PyTypeObject
*gcmac_pytype
;
552 #define GCMAC_PYCHECK(o) PyObject_TypeCheck((o), gcmac_pytype)
553 #define GCMAC_CM(o) (((gcmac_pyobj *)(o))->cm)
554 #define GCMAC_F(o) (((gcmac_pyobj *)(o))->f)
555 extern PyObject
*gcmac_pywrap(gcmac
*);
556 extern int convgcmac(PyObject
*, void *);
558 typedef struct gmac_pyobj
{
564 extern PyTypeObject
*gmac_pytype
;
565 #define GMAC_PYCHECK(o) PyObject_TypeCheck((o), gmac_pytype)
566 #define GMAC_M(o) (((gmac_pyobj *)(o))->m)
567 #define GMAC_F(o) (((gmac_pyobj *)(o))->f)
568 extern PyObject
*gmac_pywrap(PyObject
*, gmac
*, unsigned);
569 extern int convgmac(PyObject
*, void *);
571 /*----- Key generation ----------------------------------------------------*/
573 typedef struct pfilt_pyobj
{
579 extern PyTypeObject
*pfilt_pytype
;
580 #define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
581 #define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
582 #define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
584 typedef struct { pgen_proc
*proc
; void *ctx
; } pgev
;
585 #define PGEV_HEAD PyObject_HEAD pgev pg;
587 typedef struct pgev_pyobj
{
591 extern PyTypeObject
*pgev_pytype
;
592 #define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
593 #define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
595 extern int convpgev(PyObject
*, void *);
596 extern void droppgev(pgev
*);
597 extern void pgenerr(void);
599 /*----- That's all, folks -------------------------------------------------*/