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>
73 #include <catacomb/sha3.h>
75 #include <catacomb/mp.h>
76 #include <catacomb/mpint.h>
77 #include <catacomb/mpmul.h>
78 #include <catacomb/mpcrt.h>
79 #include <catacomb/mpmont.h>
80 #include <catacomb/mpbarrett.h>
81 #include <catacomb/mpreduce.h>
82 #include <catacomb/mp-fibonacci.h>
84 #include <catacomb/pgen.h>
85 #include <catacomb/pfilt.h>
86 #include <catacomb/strongprime.h>
87 #include <catacomb/limlee.h>
88 #include <catacomb/dh.h>
89 #include <catacomb/ptab.h>
90 #include <catacomb/bintab.h>
91 #include <catacomb/dsa.h>
92 #include <catacomb/x25519.h>
93 #include <catacomb/x448.h>
94 #include <catacomb/ed25519.h>
95 #include <catacomb/ed448.h>
97 #include <catacomb/gf.h>
98 #include <catacomb/gfreduce.h>
99 #include <catacomb/gfn.h>
101 #include <catacomb/field.h>
102 #include <catacomb/field-guts.h>
104 #include <catacomb/ec.h>
105 #include <catacomb/ec-raw.h>
106 #include <catacomb/ectab.h>
108 #include <catacomb/group.h>
109 #include <catacomb/group-guts.h>
111 #include <catacomb/gdsa.h>
112 #include <catacomb/gkcdsa.h>
113 #include <catacomb/rsa.h>
115 #include <catacomb/key.h>
116 #include <catacomb/passphrase.h>
117 #include <catacomb/pixie.h>
119 #include <catacomb/share.h>
120 #include <catacomb/gfshare.h>
122 /*----- Utility macros ----------------------------------------------------*/
124 #define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
125 #define RETURN_NONE RETURN_OBJ(Py_None)
126 #define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
127 #define RETURN_TRUE RETURN_OBJ(Py_True)
128 #define RETURN_FALSE RETURN_OBJ(Py_False)
129 #define RETURN_ME RETURN_OBJ(me)
131 #define EXCERR(exc, str) do { \
132 PyErr_SetString(exc, str); \
135 #define VALERR(str) EXCERR(PyExc_ValueError, str)
136 #define TYERR(str) EXCERR(PyExc_TypeError, str)
137 #define IXERR(str) EXCERR(PyExc_IndexError, str)
138 #define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
139 #define SYSERR(str) EXCERR(PyExc_SystemError, str)
140 #define NIERR(str) EXCERR(PyExc_NotImplementedError, str)
141 #define INDEXERR(idx) do { \
142 PyErr_SetObject(PyExc_KeyError, idx); \
145 #define OSERR(name) do { \
146 PyErr_SetFromErrnoWithFilename(PyExc_OSError, name); \
149 #define PGENERR do { pgenerr(); goto end; } while (0)
151 #define CONVFUNC(ty, cty, ext) \
152 int conv##ty(PyObject *o, void *p) \
154 if (!PyObject_TypeCheck(o, ty##_pytype)) \
155 TYERR("wanted a " #ty); \
156 *(cty *)p = ext(o); \
162 #if PY_VERSION_HEX < 0x02050000 /* Compatibility hack */
163 # define ht_name name
164 # define ht_type type
167 #define root_pytype 0
168 #define type_pytype &PyType_Type
169 #define INITTYPE_META(ty, base, meta) do { \
170 ty##_pytype_skel.tp_base = base##_pytype; \
171 ty##_pytype = inittype(&ty##_pytype_skel, meta##_pytype); \
173 #define INITTYPE(ty, base) INITTYPE_META(ty, base, type)
175 #define INSERT(name, ob) do { \
176 PyObject *_o = (PyObject *)(ob); \
178 PyModule_AddObject(mod, name, _o); \
181 #define INSEXC(name, var, base, meth) \
182 INSERT(name, var = mkexc(mod, base, name, meth))
184 #define METH(func, doc) \
185 { #func, METHNAME(func), METH_VARARGS, doc },
186 #define KWMETH(func, doc) \
187 { #func, (PyCFunction)METHNAME(func), \
188 METH_VARARGS | METH_KEYWORDS, doc },
190 #define GET(func, doc) \
191 { #func, GETSETNAME(get, func), 0, doc },
192 #define GETSET(func, doc) \
193 { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
195 #define MEMBER(name, ty, f, doc) \
196 { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
200 _(bytestring) _(buffer) \
201 _(rand) _(algorithms) _(pubkey) _(pgen) \
202 _(mp) _(field) _(ec) _(group) \
203 _(passphrase) _(share) _(key)
204 #define DOMODINIT(m) m##_pyinit();
205 #define DOMODINSERT(m) m##_pyinsert(mod);
206 #define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
207 #define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
210 extern void m##_pyinit(void); \
211 extern void m##_pyinsert(PyObject *);
215 #define FREEOBJ(obj) \
216 (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
218 #define GEN(func, base) \
219 static PyObject *func(void) \
221 PyObject *d = PyDict_New(); \
225 for (i = 0; g##base##tab[i]; i++) { \
226 o = gc##base##_pywrap((/*unconst*/ gc##base *)g##base##tab[i]); \
227 PyDict_SetItemString(d, \
228 (/*unconst*/ char *)g##base##tab[i]->name, \
235 #define KWLIST (/*unconst*/ char **)kwlist
237 struct nameval
{ const char *name
; unsigned long value
; };
238 extern void setconstants(PyObject
*, const struct nameval
*);
240 extern PyObject
*mexp_common(PyObject
*, PyObject
*, size_t,
241 PyObject
*(*id
)(PyObject
*),
242 int (*fill
)(void *, PyObject
*,
243 PyObject
*, PyObject
*),
244 PyObject
*(*exp
)(PyObject
*, void *, int),
245 void (*drop
)(void *));
247 extern int convulong(PyObject
*, void *);
248 #define DECL_CONVU_(n) extern int convu##n(PyObject *, void *);
249 DOUINTSZ(DECL_CONVU_
)
250 extern int convmpw(PyObject
*, void *);
251 extern int convuint(PyObject
*, void *);
252 extern int convk64(PyObject
*, void *);
253 extern int convszt(PyObject
*, void *);
254 extern int convbool(PyObject
*, void *);
255 extern PyObject
*abstract_pynew(PyTypeObject
*, PyObject
*, PyObject
*);
256 extern PyObject
*getbool(int);
257 extern PyObject
*getulong(unsigned long);
258 extern PyObject
*getk64(kludge64
);
259 extern void *newtype(PyTypeObject
*, const PyTypeObject
*, const char *);
261 extern PyObject
*mkexc(PyObject
*, PyObject
*, const char *, PyMethodDef
*);
262 extern void typeready(PyTypeObject
*);
263 extern PyTypeObject
*inittype(PyTypeObject
*, PyTypeObject
*);
264 extern void addmethods(const PyMethodDef
*);
265 extern PyMethodDef
*donemethods(void);
267 /*----- Mapping methods ---------------------------------------------------*/
269 #define GMAP_METH(func, doc) { #func, gmapmeth_##func, METH_VARARGS, doc },
270 #define GMAP_KWMETH(func, doc) \
271 { #func, (PyCFunction)gmapmeth_##func, METH_VARARGS|METH_KEYWORDS, doc },
272 #define GMAP_METHDECL(func, doc) \
273 extern PyObject *gmapmeth_##func(PyObject *, PyObject *);
274 #define GMAP_KWMETHDECL(func, doc) \
275 extern PyObject *gmapmeth_##func(PyObject *, PyObject *, PyObject *);
277 #define GMAP_DOROMETHODS(METH, KWMETH) \
278 METH (has_key, "D.has_key(KEY) -> BOOL") \
279 METH (keys, "D.keys() -> LIST") \
280 METH (values, "D.values() -> LIST") \
281 METH (items, "D.items() -> LIST") \
282 METH (iterkeys, "D.iterkeys() -> ITER") \
283 METH (itervalues, "D.itervalues() -> ITER") \
284 METH (iteritems, "D.iteritems() -> ITER") \
285 KWMETH(get, "D.get(KEY, [default = None]) -> VALUE") \
287 #define GMAP_DOMETHODS(METH, KWMETH) \
288 GMAP_DOROMETHODS(METH, KWMETH) \
289 METH (clear, "D.clear()") \
290 KWMETH(setdefault, "D.setdefault(K, [default = None]) -> VALUE") \
291 KWMETH(pop, "D.pop(KEY, [default = <error>]) -> VALUE") \
292 METH (popitem, "D.popitem() -> (KEY, VALUE)") \
293 METH (update, "D.update(MAP)")
295 GMAP_DOMETHODS(GMAP_METHDECL
, GMAP_KWMETHDECL
)
296 #define GMAP_ROMETHODS GMAP_DOROMETHODS(GMAP_METH, GMAP_KWMETH)
297 #define GMAP_METHODS GMAP_DOMETHODS(GMAP_METH, GMAP_KWMETH)
298 extern Py_ssize_t
gmap_pysize(PyObject
*);
299 extern PySequenceMethods gmap_pysequence
;
300 extern PyMethodDef gmap_pymethods
[];
302 /*----- Bytestrings -------------------------------------------------------*/
304 PyTypeObject
*bytestring_pyobj
;
305 PyObject
*bytestring_pywrap(const void *, size_t);
306 PyObject
*bytestring_pywrapbuf(buf
*);
308 /*----- Multiprecision arithmetic -----------------------------------------*/
310 typedef struct mp_pyobj
{
315 extern PyTypeObject
*mp_pytype
;
316 extern PyTypeObject
*gf_pytype
;
317 #define MP_X(o) (((mp_pyobj *)(o))->x)
318 #define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
319 #define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
321 extern mp
*mp_frompylong(PyObject
*);
322 extern PyObject
*mp_topylong(mp
*);
323 extern mp
*tomp(PyObject
*);
324 extern mp
*getmp(PyObject
*);
325 extern int convmp(PyObject
*, void *);
326 extern mp
*getgf(PyObject
*);
327 extern int convgf(PyObject
*, void *);
328 extern PyObject
*mp_pywrap(mp
*);
329 extern PyObject
*gf_pywrap(mp
*);
330 extern mp
*mp_frompyobject(PyObject
*, int);
331 extern PyObject
*mp_topystring(mp
*, int,
332 const char *, const char *, const char *);
333 extern int mp_tolong_checked(mp
*, long *, int);
335 /*----- Abstract fields ---------------------------------------------------*/
337 typedef struct field_pyobj
{
342 extern PyTypeObject
*fe_pytype
;
343 #define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
344 #define FE_F(o) (((fe_pyobj *)(o))->f)
345 #define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
346 #define FE_X(o) (((fe_pyobj *)(o))->x)
347 extern PyObject
*fe_pywrap(PyObject
*, mp
*);
348 extern mp
*getfe(field
*, PyObject
*);
350 typedef struct fe_pyobj
{
356 extern PyTypeObject
*field_pytype
;
357 extern PyTypeObject
*primefield_pytype
;
358 extern PyTypeObject
*niceprimefield_pytype
;
359 extern PyTypeObject
*binfield_pytype
;
360 extern PyTypeObject
*binpolyfield_pytype
;
361 extern PyTypeObject
*binnormfield_pytype
;
362 #define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
363 #define FIELD_F(o) (((field_pyobj *)(o))->f)
364 extern PyObject
*field_pywrap(field
*);
365 extern field
*field_copy(field
*);
367 /*----- Elliptic curves ---------------------------------------------------*/
369 typedef struct ecpt_pyobj
{
375 extern PyTypeObject
*ecpt_pytype
, *ecptcurve_pytype
;
376 #define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
377 #define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
378 #define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
379 #define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
380 #define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
381 #define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
382 extern PyObject
*ecpt_pywrap(PyObject
*, ec
*);
383 extern PyObject
*ecpt_pywrapout(void *, ec
*);
384 extern int toecpt(ec_curve
*, ec
*, PyObject
*);
385 extern int getecpt(ec_curve
*, ec
*, PyObject
*);
386 extern void getecptout(ec
*, PyObject
*);
387 extern int convecpt(PyObject
*, void *);
389 typedef struct eccurve_pyobj
{
395 extern PyTypeObject
*eccurve_pytype
;
396 extern PyTypeObject
*ecprimecurve_pytype
;
397 extern PyTypeObject
*ecprimeprojcurve_pytype
;
398 extern PyTypeObject
*ecbincurve_pytype
;
399 extern PyTypeObject
*ecbinprojcurve_pytype
;
400 #define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
401 #define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
402 #define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
403 extern PyObject
*eccurve_pywrap(PyObject
*, ec_curve
*);
404 extern ec_curve
*eccurve_copy(ec_curve
*);
406 typedef struct ecinfo_pyobj
{
412 extern PyTypeObject
*ecinfo_pytype
;
413 #define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
414 #define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
415 #define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
416 extern void ecinfo_copy(ec_info
*, const ec_info
*);
417 extern PyObject
*ecinfo_pywrap(ec_info
*);
419 /*----- Cyclic groups -----------------------------------------------------*/
421 typedef struct fginfo_pyobj
{
426 PyTypeObject
*fginfo_pytype
, *dhinfo_pytype
, *bindhinfo_pytype
;
427 #define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
428 PyObject
*fginfo_pywrap(gprime_param
*, PyTypeObject
*);
430 typedef struct ge_pyobj
{
436 extern PyTypeObject
*ge_pytype
;
437 #define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
438 #define GE_X(o) (((ge_pyobj *)(o))->x)
439 #define GE_G(o) (((ge_pyobj *)(o))->g)
440 #define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
441 extern PyObject
*ge_pywrap(PyObject
*, ge
*);
443 typedef struct group_pyobj
{
448 extern PyTypeObject
*group_pytype
;
449 extern PyTypeObject
*primegroup_pytype
, *bingroup_pytype
, *ecgroup_pytype
;
450 #define GROUP_G(o) (((group_pyobj *)(o))->g)
451 extern PyObject
*group_pywrap(group
*);
452 extern group
*group_copy(group
*);
454 /*----- Random number generators ------------------------------------------*/
458 typedef struct grand_pyobj
{
464 extern PyTypeObject
*grand_pytype
, *truerand_pytype
;
465 extern PyTypeObject
*lcrand_pytype
,* fibrand_pytype
;
466 extern PyTypeObject
*dsarand_pytype
, *bbs_pytype
;
467 extern PyObject
*rand_pyobj
;
468 #define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
469 #define GRAND_F(o) (((grand_pyobj *)(o))->f)
470 #define GRAND_R(o) (((grand_pyobj *)(o))->r)
471 extern PyObject
*grand_pywrap(grand
*, unsigned);
472 extern int convgrand(PyObject
*, void *);
474 /*----- Key sizes ---------------------------------------------------------*/
476 typedef struct keysz_pyobj
{
481 typedef struct keyszrange_pyobj
{
487 typedef struct keyszset_pyobj
{
493 #define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
494 extern PyObject
*keysz_pywrap(const octet
*);
496 /*----- Symmetric cryptography --------------------------------------------*/
498 typedef struct gccipher_pyobj
{
503 extern PyTypeObject
*gccipher_pytype
;
504 #define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
505 #define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
506 extern PyObject
*gccipher_pywrap(gccipher
*);
507 extern int convgccipher(PyObject
*, void *);
509 typedef struct gcipher_pyobj
{
514 extern PyTypeObject
*gcipher_pytype
;
515 #define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
516 #define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
517 extern PyObject
*gcipher_pywrap(PyObject
*, gcipher
*);
518 extern int convgcipher(PyObject
*, void *);
520 typedef struct gchash_pyobj
{
525 extern PyTypeObject
*gchash_pytype
;
526 #define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
527 #define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
528 extern PyObject
*gchash_pywrap(gchash
*);
529 extern int convgchash(PyObject
*, void *);
531 typedef struct ghash_pyobj
{
536 extern PyTypeObject
*ghash_pytype
, *gmhash_pytype
;
537 extern PyObject
*sha_pyobj
, *has160_pyobj
;
538 #define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
539 #define GHASH_H(o) (((ghash_pyobj *)(o))->h)
540 extern PyObject
*ghash_pywrap(PyObject
*, ghash
*);
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
{
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
*);
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 -------------------------------------------------*/