algorithms: Add PRPs as objects in their own right.
[pyke] / catacomb-python.h
CommitLineData
b6a86d2e 1/* -*-c-*-
2 *
3 * $Id$
4 *
5 * Definitions for Catacomb bindings
6 *
7 * (c) 2004 Straylight/Edgeware
8 */
9
10/*----- Licensing notice --------------------------------------------------*
11 *
12 * This file is part of the Python interface to Catacomb.
13 *
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.
18 *
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.
23 *
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.
27 */
28
29#ifndef CATACOMB_PYTHON_H
30#define CATACOMB_PYTHON_H
31
32#ifdef __cplusplus
33 extern "C" {
34#endif
35
36/*----- Header files ------------------------------------------------------*/
37
38#include <Python.h>
39#include <longintrepr.h>
40#include <structmember.h>
41
73a712fa 42#undef ULLONG_MAX
43#undef ULONG_LONG_MAX
44
b6a86d2e 45#include <mLib/darray.h>
46#include <mLib/dstr.h>
47#include <mLib/macros.h>
73a712fa 48#include <mLib/quis.h>
b6a86d2e 49
50#include <catacomb/buf.h>
51
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>
62058916 62#include <catacomb/blkc.h>
b6a86d2e 63
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>
72
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
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>
89
90#include <catacomb/gf.h>
91#include <catacomb/gfreduce.h>
92#include <catacomb/gfn.h>
93
94#include <catacomb/field.h>
95#include <catacomb/field-guts.h>
96
97#include <catacomb/ec.h>
98#include <catacomb/ec-raw.h>
99#include <catacomb/ectab.h>
100
101#include <catacomb/group.h>
102#include <catacomb/group-guts.h>
103
104#include <catacomb/gdsa.h>
105#include <catacomb/gkcdsa.h>
106#include <catacomb/rsa.h>
107
108#include <catacomb/key.h>
109#include <catacomb/passphrase.h>
110#include <catacomb/pixie.h>
111
73a712fa 112#include <catacomb/share.h>
113#include <catacomb/gfshare.h>
114
b6a86d2e 115/*----- Utility macros ----------------------------------------------------*/
116
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)
123
124#define EXCERR(exc, str) do { \
125 PyErr_SetString(exc, str); \
126 goto end; \
127} while (0)
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)
73a712fa 133#define INDEXERR(idx) do { \
134 PyErr_SetObject(PyExc_KeyError, idx); \
135 goto end; \
136} while (0)
b6a86d2e 137#define OSERR(name) do { \
138 PyErr_SetFromErrnoWithFilename(PyExc_OSError, name); \
139 goto end; \
140} while (0)
141#define PGENERR do { pgenerr(); goto end; } while (0)
142
143#define CONVFUNC(ty, cty, ext) \
144 int conv##ty(PyObject *o, void *p) \
145 { \
146 if (!PyObject_TypeCheck(o, ty##_pytype)) \
147 TYERR("wanted a " #ty); \
148 *(cty *)p = ext(o); \
149 return (1); \
150 end: \
151 return (0); \
152 }
153
154#define root_pytype 0
155#define type_pytype &PyType_Type
156#define INITTYPE(ty, base) do { \
157 ty##_pytype_skel.tp_base = base##_pytype; \
158 ty##_pytype = inittype(&ty##_pytype_skel); \
159} while (0)
160
161#define INSERT(name, ob) do { \
162 PyObject *_o = (PyObject *)(ob); \
163 Py_INCREF(_o); \
164 PyModule_AddObject(mod, name, _o); \
165} while (0)
166
73a712fa 167#define INSEXC(name, var, base, meth) \
168 INSERT(name, var = mkexc(mod, base, name, meth))
169
b6a86d2e 170#define METH(func, doc) \
171 { #func, METHNAME(func), METH_VARARGS, doc },
172#define KWMETH(func, doc) \
173 { #func, (PyCFunction)METHNAME(func), \
174 METH_VARARGS | METH_KEYWORDS, doc },
175
176#define GET(func, doc) \
177 { #func, GETSETNAME(get, func), 0, doc },
178#define GETSET(func, doc) \
179 { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
180
181#define MEMBER(name, ty, f, doc) \
182 { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
183
73a712fa 184#define MODULES(_) \
185 _(bytestring) _(buffer) \
186 _(rand) _(algorithms) _(pubkey) _(pgen) \
187 _(mp) _(field) _(ec) _(group) \
188 _(passphrase) _(share) _(key)
b6a86d2e 189#define DOMODINIT(m) m##_pyinit();
190#define DOMODINSERT(m) m##_pyinsert(mod);
191#define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
192#define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
193
194#define DO(m) \
195 extern void m##_pyinit(void); \
196 extern void m##_pyinsert(PyObject *);
197MODULES(DO)
198#undef DO
199
ba45a729 200#define FREEOBJ(obj) \
201 (((PyObject *)(obj))->ob_type->tp_free((PyObject *)(obj)))
202
b6a86d2e 203/*----- Bytestrings -------------------------------------------------------*/
204
205PyTypeObject *bytestring_pyobj;
206PyObject *bytestring_pywrap(const void *, size_t);
207PyObject *bytestring_pywrapbuf(buf *);
208
209/*----- Multiprecision arithmetic -----------------------------------------*/
210
211typedef struct mp_pyobj {
212 PyObject_HEAD
213 mp *x;
214} mp_pyobj;
215
216extern PyTypeObject *mp_pytype;
217extern PyTypeObject *gf_pytype;
218#define MP_X(o) (((mp_pyobj *)(o))->x)
219#define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
220#define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
221
222extern mp *mp_frompylong(PyLongObject *);
223extern PyLongObject *mp_topylong(mp *);
224extern mp *tomp(PyObject *);
225extern mp *getmp(PyObject *);
226extern int convmp(PyObject *, void *);
227extern mp *getgf(PyObject *);
228extern int convgf(PyObject *, void *);
229extern PyObject *mp_pywrap(mp *);
230extern PyObject *gf_pywrap(mp *);
231extern mp *mp_frompyobject(PyObject *, int);
232extern PyObject *mp_topystring(mp *, int,
233 const char *, const char *, const char *);
234extern int mp_tolong_checked(mp *, long *);
235
236/*----- Abstract fields ---------------------------------------------------*/
237
238typedef struct field_pyobj {
f0526039 239 PyHeapTypeObject ty;
b6a86d2e 240 field *f;
241} field_pyobj;
242
243extern PyTypeObject *fe_pytype;
244#define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
245#define FE_F(o) (((fe_pyobj *)(o))->f)
246#define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
247#define FE_X(o) (((fe_pyobj *)(o))->x)
248extern PyObject *fe_pywrap(PyObject *, mp *);
249extern mp *getfe(field *, PyObject *);
250
251typedef struct fe_pyobj {
252 PyObject_HEAD
253 field *f;
b6a86d2e 254 mp *x;
255} fe_pyobj;
256
257extern PyTypeObject *field_pytype;
258extern PyTypeObject *primefield_pytype;
259extern PyTypeObject *niceprimefield_pytype;
260extern PyTypeObject *binfield_pytype;
261extern PyTypeObject *binpolyfield_pytype;
262extern PyTypeObject *binnormfield_pytype;
263#define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
264#define FIELD_F(o) (((field_pyobj *)(o))->f)
265extern PyObject *field_pywrap(field *);
266extern field *field_copy(field *);
267
268/*----- Elliptic curves ---------------------------------------------------*/
269
270typedef struct ecpt_pyobj {
271 PyObject_HEAD
272 ec_curve *c;
273 ec p;
274} ecpt_pyobj;
275
276extern PyTypeObject *ecpt_pytype, *ecptcurve_pytype;
277#define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
278#define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
279#define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
280#define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
281#define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
282#define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
283extern PyObject *ecpt_pywrap(PyObject *, ec *);
284extern PyObject *ecpt_pywrapout(void *, ec *);
285extern int toecpt(ec_curve *, ec *, PyObject *);
286extern int getecpt(ec_curve *, ec *, PyObject *);
287extern void getecptout(ec *, PyObject *);
73a712fa 288extern int convecpt(PyObject *, void *);
b6a86d2e 289
290typedef struct eccurve_pyobj {
f0526039 291 PyHeapTypeObject ty;
b6a86d2e 292 ec_curve *c;
293 PyObject *fobj;
294} eccurve_pyobj;
295
296extern PyTypeObject *eccurve_pytype;
297extern PyTypeObject *ecprimecurve_pytype;
298extern PyTypeObject *ecprimeprojcurve_pytype;
299extern PyTypeObject *ecbincurve_pytype;
300extern PyTypeObject *ecbinprojcurve_pytype;
301#define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
302#define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
303#define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
304extern PyObject *eccurve_pywrap(PyObject *, ec_curve *);
305extern ec_curve *eccurve_copy(ec_curve *);
306
307typedef struct ecinfo_pyobj {
308 PyObject_HEAD
309 ec_info ei;
310 PyObject *cobj;
311} ecinfo_pyobj;
312
313extern PyTypeObject *ecinfo_pytype;
314#define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
315#define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
316#define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
317extern void ecinfo_copy(ec_info *, const ec_info *);
318extern PyObject *ecinfo_pywrap(ec_info *);
319
320/*----- Cyclic groups -----------------------------------------------------*/
321
322typedef struct fginfo_pyobj {
323 PyObject_HEAD
324 gprime_param dp;
325} fginfo_pyobj;
326
327PyTypeObject *fginfo_pytype, *dhinfo_pytype, *bindhinfo_pytype;
328#define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
329PyObject *fginfo_pywrap(gprime_param *, PyTypeObject *);
330
331typedef struct ge_pyobj {
332 PyObject_HEAD
333 ge *x;
334 group *g;
335} ge_pyobj;
336
337extern PyTypeObject *ge_pytype;
338#define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
339#define GE_X(o) (((ge_pyobj *)(o))->x)
340#define GE_G(o) (((ge_pyobj *)(o))->g)
341#define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
342extern PyObject *ge_pywrap(PyObject *, ge *);
343
344typedef struct group_pyobj {
f0526039 345 PyHeapTypeObject ty;
b6a86d2e 346 group *g;
347} group_pyobj;
348
349extern PyTypeObject *group_pytype;
350extern PyTypeObject *primegroup_pytype, *bingroup_pytype, *ecgroup_pytype;
351#define GROUP_G(o) (((group_pyobj *)(o))->g)
352extern PyObject *group_pywrap(group *);
353extern group *group_copy(group *);
354
355/*----- Random number generators ------------------------------------------*/
356
357#define f_freeme 1u
358
359typedef struct grand_pyobj {
360 PyObject_HEAD
361 unsigned f;
362 grand *r;
363} grand_pyobj;
364
365extern PyTypeObject *grand_pytype, *truerand_pytype;
366extern PyTypeObject *lcrand_pytype,* fibrand_pytype;
367extern PyTypeObject *dsarand_pytype, *bbs_pytype;
368extern PyObject *rand_pyobj;
369#define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
370#define GRAND_F(o) (((grand_pyobj *)(o))->f)
371#define GRAND_R(o) (((grand_pyobj *)(o))->r)
372extern PyObject *grand_pywrap(grand *, unsigned);
373extern int convgrand(PyObject *, void *);
374
375/*----- Key sizes ---------------------------------------------------------*/
376
377typedef struct keysz_pyobj {
378 PyObject_HEAD
379 int dfl;
380} keysz_pyobj;
381
382typedef struct keyszrange_pyobj {
383 PyObject_HEAD
384 int dfl;
385 int min, max, mod;
386} keyszrange_pyobj;
387
388typedef struct keyszset_pyobj {
389 PyObject_HEAD
390 int dfl;
391 PyObject *set;
392} keyszset_pyobj;
393
394#define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
395extern PyObject *keysz_pywrap(const octet *);
396
397/*----- Symmetric cryptography --------------------------------------------*/
398
399typedef struct gccipher_pyobj {
f0526039 400 PyHeapTypeObject ty;
b6a86d2e 401 gccipher *cc;
402} gccipher_pyobj;
403
404extern PyTypeObject *gccipher_pytype;
405#define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
406#define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
407#define GCCIPHER_F(o) (((gccipher_pyobj *)(o))->f)
408extern PyObject *gccipher_pywrap(gccipher *);
409extern int convgccipher(PyObject *, void *);
410extern int convgcipher(PyObject *, void *);
411
412typedef struct gcipher_pyobj {
413 PyObject_HEAD
414 unsigned f;
415 gcipher *c;
416} gcipher_pyobj;
417
418extern PyTypeObject *gcipher_pytype;
419#define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
420#define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
421#define GCIPHER_F(o) (((gcipher_pyobj *)(o))->f)
422extern PyObject *gcipher_pywrap(PyObject *, gcipher *, unsigned);
423extern int convgcipher(PyObject *, void *);
424
425typedef struct gchash_pyobj {
f0526039 426 PyHeapTypeObject ty;
b6a86d2e 427 gchash *ch;
428} gchash_pyobj;
429
430extern PyTypeObject *gchash_pytype;
431#define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
432#define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
433#define GCHASH_F(o) (((gchash_pyobj *)(o))->f)
434extern PyObject *gchash_pywrap(gchash *);
435extern int convgchash(PyObject *, void *);
436
437typedef struct ghash_pyobj {
438 PyObject_HEAD
439 unsigned f;
440 ghash *h;
441} ghash_pyobj;
442
443extern PyTypeObject *ghash_pytype, *gmhash_pytype;
444extern PyObject *sha_pyobj, *has160_pyobj;
445#define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
446#define GHASH_H(o) (((ghash_pyobj *)(o))->h)
447#define GHASH_F(o) (((ghash_pyobj *)(o))->f)
448extern PyObject *ghash_pywrap(PyObject *, ghash *, unsigned);
449extern int convghash(PyObject *, void *);
450extern int convgmhash(PyObject *, void *);
451
452typedef struct gcmac_pyobj {
f0526039 453 PyHeapTypeObject ty;
b6a86d2e 454 gcmac *cm;
455} gcmac_pyobj;
456
457extern PyTypeObject *gcmac_pytype;
458#define GCMAC_PYCHECK(o) PyObject_TypeCheck((o), gcmac_pytype)
459#define GCMAC_CM(o) (((gcmac_pyobj *)(o))->cm)
460#define GCMAC_F(o) (((gcmac_pyobj *)(o))->f)
461extern PyObject *gcmac_pywrap(gcmac *);
462extern int convgcmac(PyObject *, void *);
463
464typedef struct gmac_pyobj {
f0526039 465 PyHeapTypeObject ty;
b6a86d2e 466 unsigned f;
467 gmac *m;
b6a86d2e 468} gmac_pyobj;
469
470extern PyTypeObject *gmac_pytype;
471#define GMAC_PYCHECK(o) PyObject_TypeCheck((o), gmac_pytype)
472#define GMAC_M(o) (((gmac_pyobj *)(o))->m)
b6a86d2e 473#define GMAC_F(o) (((gmac_pyobj *)(o))->f)
474extern PyObject *gmac_pywrap(PyObject *, gmac *, unsigned);
475extern int convgmac(PyObject *, void *);
476
b6a86d2e 477/*----- Key generation ----------------------------------------------------*/
478
479typedef struct pfilt_pyobj {
480 PyObject_HEAD
481 pfilt f;
482 int st;
483} pfilt_pyobj;
484
485extern PyTypeObject *pfilt_pytype;
486#define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
487#define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
488#define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
489
490typedef struct { pgen_proc *proc; void *ctx; } pgev;
491#define PGEV_HEAD PyObject_HEAD pgev pg;
492
493typedef struct pgev_pyobj {
494 PGEV_HEAD
495} pgev_pyobj;
496
497extern PyTypeObject *pgev_pytype;
498#define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
499#define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
500
501extern int convpgev(PyObject *, void *);
502extern void droppgev(pgev *);
503extern void pgenerr(void);
504
505/*----- Core utility functions --------------------------------------------*/
506
507extern PyObject *mexp_common(PyObject *, PyObject *, size_t,
508 PyObject *(*id)(PyObject *),
509 int (*fill)(void *, PyObject *,
510 PyObject *, PyObject *),
511 PyObject *(*exp)(PyObject *, void *, int),
512 void (*drop)(void *));
513
514extern int convulong(PyObject *, void *);
73a712fa 515#define DECL_CONVU_(n) extern int convu##n(PyObject *, void *);
516DOUINTSZ(DECL_CONVU_)
b6a86d2e 517extern int convmpw(PyObject *, void *);
518extern int convuint(PyObject *, void *);
519extern int convszt(PyObject *, void *);
520extern int convbool(PyObject *, void *);
521extern PyObject *abstract_pynew(PyTypeObject *, PyObject *, PyObject *);
522extern PyObject *getbool(int);
73a712fa 523#define DECL_GETU_(n) extern PyObject *getu##n(uint##n);
524DOUINTSZ(DECL_GETU_)
525extern PyObject * mkexc(PyObject *, PyObject *, const char *, PyMethodDef *);
f0526039 526extern void *newtype(PyTypeObject *, const PyTypeObject *, const char *);
b6a86d2e 527extern PyTypeObject *inittype(PyTypeObject *);
528extern void addmethods(const PyMethodDef *);
529
530/*----- That's all, folks -------------------------------------------------*/
531
532#ifdef __cplusplus
533 }
534#endif
535
536#endif