~mdw / pyke / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial check-in of catacomb-python.
[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
42#include <mLib/darray.h>
43#include <mLib/dstr.h>
44#include <mLib/macros.h>
45
46#include <catacomb/buf.h>
47
48#include <catacomb/grand.h>
49#include <catacomb/rand.h>
50#include <catacomb/noise.h>
51#include <catacomb/bbs.h>
52#include <catacomb/mprand.h>
53#include <catacomb/lcrand.h>
54#include <catacomb/fibrand.h>
55#include <catacomb/dsarand.h>
56#include <catacomb/sslprf.h>
57#include <catacomb/tlsprf.h>
58
59#include <catacomb/gcipher.h>
60#include <catacomb/ghash.h>
61#include <catacomb/gmac.h>
62#include <catacomb/md5.h>
63#include <catacomb/md5-hmac.h>
64#include <catacomb/sha.h>
65#include <catacomb/sha-mgf.h>
66#include <catacomb/sha-hmac.h>
67
68#include <catacomb/mp.h>
69#include <catacomb/mpint.h>
70#include <catacomb/mpmul.h>
71#include <catacomb/mpcrt.h>
72#include <catacomb/mpmont.h>
73#include <catacomb/mpbarrett.h>
74#include <catacomb/mpreduce.h>
75
76#include <catacomb/pgen.h>
77#include <catacomb/pfilt.h>
78#include <catacomb/strongprime.h>
79#include <catacomb/limlee.h>
80#include <catacomb/dh.h>
81#include <catacomb/ptab.h>
82#include <catacomb/bintab.h>
83#include <catacomb/dsa.h>
84
85#include <catacomb/gf.h>
86#include <catacomb/gfreduce.h>
87#include <catacomb/gfn.h>
88
89#include <catacomb/field.h>
90#include <catacomb/field-guts.h>
91
92#include <catacomb/ec.h>
93#include <catacomb/ec-raw.h>
94#include <catacomb/ectab.h>
95
96#include <catacomb/group.h>
97#include <catacomb/group-guts.h>
98
99#include <catacomb/gdsa.h>
100#include <catacomb/gkcdsa.h>
101#include <catacomb/rsa.h>
102
103#include <catacomb/key.h>
104#include <catacomb/passphrase.h>
105#include <catacomb/pixie.h>
106
107/*----- Utility macros ----------------------------------------------------*/
108
109#define RETURN_OBJ(obj) do { Py_INCREF(obj); return (obj); } while (0)
110#define RETURN_NONE RETURN_OBJ(Py_None)
111#define RETURN_NOTIMPL RETURN_OBJ(Py_NotImplemented)
112#define RETURN_TRUE RETURN_OBJ(Py_True)
113#define RETURN_FALSE RETURN_OBJ(Py_False)
114#define RETURN_ME RETURN_OBJ(me)
115
116#define EXCERR(exc, str) do { \
117 PyErr_SetString(exc, str); \
118 goto end; \
119} while (0)
120#define VALERR(str) EXCERR(PyExc_ValueError, str)
121#define TYERR(str) EXCERR(PyExc_TypeError, str)
122#define ZDIVERR(str) EXCERR(PyExc_ZeroDivisionError, str)
123#define SYNERR(str) EXCERR(PyExc_SyntaxError, str)
124#define SYSERR(str) EXCERR(PyExc_SystemError, str)
125#define OSERR(name) do { \
126 PyErr_SetFromErrnoWithFilename(PyExc_OSError, name); \
127 goto end; \
128} while (0)
129#define PGENERR do { pgenerr(); goto end; } while (0)
130
131#define CONVFUNC(ty, cty, ext) \
132 int conv##ty(PyObject *o, void *p) \
133 { \
134 if (!PyObject_TypeCheck(o, ty##_pytype)) \
135 TYERR("wanted a " #ty); \
136 *(cty *)p = ext(o); \
137 return (1); \
138 end: \
139 return (0); \
140 }
141
142#define root_pytype 0
143#define type_pytype &PyType_Type
144#define INITTYPE(ty, base) do { \
145 ty##_pytype_skel.tp_base = base##_pytype; \
146 ty##_pytype = inittype(&ty##_pytype_skel); \
147} while (0)
148
149#define INSERT(name, ob) do { \
150 PyObject *_o = (PyObject *)(ob); \
151 Py_INCREF(_o); \
152 PyModule_AddObject(mod, name, _o); \
153} while (0)
154
155#define METH(func, doc) \
156 { #func, METHNAME(func), METH_VARARGS, doc },
157#define KWMETH(func, doc) \
158 { #func, (PyCFunction)METHNAME(func), \
159 METH_VARARGS | METH_KEYWORDS, doc },
160
161#define GET(func, doc) \
162 { #func, GETSETNAME(get, func), 0, doc },
163#define GETSET(func, doc) \
164 { #func, GETSETNAME(get, func), GETSETNAME(set, func), doc },
165
166#define MEMBER(name, ty, f, doc) \
167 { #name, ty, offsetof(MEMBERSTRUCT, name), f, doc },
168
169#define MODULES(DO) \
170 DO(bytestring) \
171 DO(rand) DO(algorithms) DO(pubkey) DO(pgen) \
172 DO(mp) DO(field) DO(ec) DO(group) \
173 DO(passphrase)
174#define DOMODINIT(m) m##_pyinit();
175#define DOMODINSERT(m) m##_pyinsert(mod);
176#define INIT_MODULES do { MODULES(DOMODINIT) } while (0)
177#define INSERT_MODULES do { MODULES(DOMODINSERT) } while (0)
178
179#define DO(m) \
180 extern void m##_pyinit(void); \
181 extern void m##_pyinsert(PyObject *);
182MODULES(DO)
183#undef DO
184
185/*----- Bytestrings -------------------------------------------------------*/
186
187PyTypeObject *bytestring_pyobj;
188PyObject *bytestring_pywrap(const void *, size_t);
189PyObject *bytestring_pywrapbuf(buf *);
190
191/*----- Multiprecision arithmetic -----------------------------------------*/
192
193typedef struct mp_pyobj {
194 PyObject_HEAD
195 mp *x;
196} mp_pyobj;
197
198extern PyTypeObject *mp_pytype;
199extern PyTypeObject *gf_pytype;
200#define MP_X(o) (((mp_pyobj *)(o))->x)
201#define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
202#define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
203
204extern mp *mp_frompylong(PyLongObject *);
205extern PyLongObject *mp_topylong(mp *);
206extern mp *tomp(PyObject *);
207extern mp *getmp(PyObject *);
208extern int convmp(PyObject *, void *);
209extern mp *getgf(PyObject *);
210extern int convgf(PyObject *, void *);
211extern PyObject *mp_pywrap(mp *);
212extern PyObject *gf_pywrap(mp *);
213extern mp *mp_frompyobject(PyObject *, int);
214extern PyObject *mp_topystring(mp *, int,
215 const char *, const char *, const char *);
216extern int mp_tolong_checked(mp *, long *);
217
218/*----- Abstract fields ---------------------------------------------------*/
219
220typedef struct field_pyobj {
221 PyTypeObject ty;
222 field *f;
223} field_pyobj;
224
225extern PyTypeObject *fe_pytype;
226#define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
227#define FE_F(o) (((fe_pyobj *)(o))->f)
228#define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
229#define FE_X(o) (((fe_pyobj *)(o))->x)
230extern PyObject *fe_pywrap(PyObject *, mp *);
231extern mp *getfe(field *, PyObject *);
232
233typedef struct fe_pyobj {
234 PyObject_HEAD
235 field *f;
236 PyObject *fobj; /* to keep it alive */
237 mp *x;
238} fe_pyobj;
239
240extern PyTypeObject *field_pytype;
241extern PyTypeObject *primefield_pytype;
242extern PyTypeObject *niceprimefield_pytype;
243extern PyTypeObject *binfield_pytype;
244extern PyTypeObject *binpolyfield_pytype;
245extern PyTypeObject *binnormfield_pytype;
246#define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
247#define FIELD_F(o) (((field_pyobj *)(o))->f)
248extern PyObject *field_pywrap(field *);
249extern field *field_copy(field *);
250
251/*----- Elliptic curves ---------------------------------------------------*/
252
253typedef struct ecpt_pyobj {
254 PyObject_HEAD
255 ec_curve *c;
256 ec p;
257} ecpt_pyobj;
258
259extern PyTypeObject *ecpt_pytype, *ecptcurve_pytype;
260#define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
261#define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
262#define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
263#define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
264#define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
265#define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
266extern PyObject *ecpt_pywrap(PyObject *, ec *);
267extern PyObject *ecpt_pywrapout(void *, ec *);
268extern int toecpt(ec_curve *, ec *, PyObject *);
269extern int getecpt(ec_curve *, ec *, PyObject *);
270extern void getecptout(ec *, PyObject *);
271extern int convec(PyObject *, void *);
272
273typedef struct eccurve_pyobj {
274 PyTypeObject ty;
275 ec_curve *c;
276 PyObject *fobj;
277} eccurve_pyobj;
278
279extern PyTypeObject *eccurve_pytype;
280extern PyTypeObject *ecprimecurve_pytype;
281extern PyTypeObject *ecprimeprojcurve_pytype;
282extern PyTypeObject *ecbincurve_pytype;
283extern PyTypeObject *ecbinprojcurve_pytype;
284#define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
285#define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
286#define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
287extern PyObject *eccurve_pywrap(PyObject *, ec_curve *);
288extern ec_curve *eccurve_copy(ec_curve *);
289
290typedef struct ecinfo_pyobj {
291 PyObject_HEAD
292 ec_info ei;
293 PyObject *cobj;
294} ecinfo_pyobj;
295
296extern PyTypeObject *ecinfo_pytype;
297#define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
298#define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
299#define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
300extern void ecinfo_copy(ec_info *, const ec_info *);
301extern PyObject *ecinfo_pywrap(ec_info *);
302
303/*----- Cyclic groups -----------------------------------------------------*/
304
305typedef struct fginfo_pyobj {
306 PyObject_HEAD
307 gprime_param dp;
308} fginfo_pyobj;
309
310PyTypeObject *fginfo_pytype, *dhinfo_pytype, *bindhinfo_pytype;
311#define FGINFO_DP(fg) (&((fginfo_pyobj *)(fg))->dp)
312PyObject *fginfo_pywrap(gprime_param *, PyTypeObject *);
313
314typedef struct ge_pyobj {
315 PyObject_HEAD
316 ge *x;
317 group *g;
318} ge_pyobj;
319
320extern PyTypeObject *ge_pytype;
321#define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
322#define GE_X(o) (((ge_pyobj *)(o))->x)
323#define GE_G(o) (((ge_pyobj *)(o))->g)
324#define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
325extern PyObject *ge_pywrap(PyObject *, ge *);
326
327typedef struct group_pyobj {
328 PyTypeObject ty;
329 group *g;
330} group_pyobj;
331
332extern PyTypeObject *group_pytype;
333extern PyTypeObject *primegroup_pytype, *bingroup_pytype, *ecgroup_pytype;
334#define GROUP_G(o) (((group_pyobj *)(o))->g)
335extern PyObject *group_pywrap(group *);
336extern group *group_copy(group *);
337
338/*----- Random number generators ------------------------------------------*/
339
340#define f_freeme 1u
341
342typedef struct grand_pyobj {
343 PyObject_HEAD
344 unsigned f;
345 grand *r;
346} grand_pyobj;
347
348extern PyTypeObject *grand_pytype, *truerand_pytype;
349extern PyTypeObject *lcrand_pytype,* fibrand_pytype;
350extern PyTypeObject *dsarand_pytype, *bbs_pytype;
351extern PyObject *rand_pyobj;
352#define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
353#define GRAND_F(o) (((grand_pyobj *)(o))->f)
354#define GRAND_R(o) (((grand_pyobj *)(o))->r)
355extern PyObject *grand_pywrap(grand *, unsigned);
356extern int convgrand(PyObject *, void *);
357
358/*----- Key sizes ---------------------------------------------------------*/
359
360typedef struct keysz_pyobj {
361 PyObject_HEAD
362 int dfl;
363} keysz_pyobj;
364
365typedef struct keyszrange_pyobj {
366 PyObject_HEAD
367 int dfl;
368 int min, max, mod;
369} keyszrange_pyobj;
370
371typedef struct keyszset_pyobj {
372 PyObject_HEAD
373 int dfl;
374 PyObject *set;
375} keyszset_pyobj;
376
377#define KEYSZ_PYCHECK(o) PyObject_TypeCheck((o), keysz_pytype)
378extern PyObject *keysz_pywrap(const octet *);
379
380/*----- Symmetric cryptography --------------------------------------------*/
381
382typedef struct gccipher_pyobj {
383 PyTypeObject ty;
384 gccipher *cc;
385} gccipher_pyobj;
386
387extern PyTypeObject *gccipher_pytype;
388#define GCCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gccipher_pytype)
389#define GCCIPHER_CC(o) (((gccipher_pyobj *)(o))->cc)
390#define GCCIPHER_F(o) (((gccipher_pyobj *)(o))->f)
391extern PyObject *gccipher_pywrap(gccipher *);
392extern int convgccipher(PyObject *, void *);
393extern int convgcipher(PyObject *, void *);
394
395typedef struct gcipher_pyobj {
396 PyObject_HEAD
397 unsigned f;
398 gcipher *c;
399} gcipher_pyobj;
400
401extern PyTypeObject *gcipher_pytype;
402#define GCIPHER_PYCHECK(o) PyObject_TypeCheck((o), gcipher_pytype)
403#define GCIPHER_C(o) (((gcipher_pyobj *)(o))->c)
404#define GCIPHER_F(o) (((gcipher_pyobj *)(o))->f)
405extern PyObject *gcipher_pywrap(PyObject *, gcipher *, unsigned);
406extern int convgcipher(PyObject *, void *);
407
408typedef struct gchash_pyobj {
409 PyTypeObject ty;
410 gchash *ch;
411} gchash_pyobj;
412
413extern PyTypeObject *gchash_pytype;
414#define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
415#define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
416#define GCHASH_F(o) (((gchash_pyobj *)(o))->f)
417extern PyObject *gchash_pywrap(gchash *);
418extern int convgchash(PyObject *, void *);
419
420typedef struct ghash_pyobj {
421 PyObject_HEAD
422 unsigned f;
423 ghash *h;
424} ghash_pyobj;
425
426extern PyTypeObject *ghash_pytype, *gmhash_pytype;
427extern PyObject *sha_pyobj, *has160_pyobj;
428#define GHASH_PYCHECK(o) PyObject_TypeCheck((o), ghash_pytype)
429#define GHASH_H(o) (((ghash_pyobj *)(o))->h)
430#define GHASH_F(o) (((ghash_pyobj *)(o))->f)
431extern PyObject *ghash_pywrap(PyObject *, ghash *, unsigned);
432extern int convghash(PyObject *, void *);
433extern int convgmhash(PyObject *, void *);
434
435typedef struct gcmac_pyobj {
436 PyTypeObject ty;
437 gcmac *cm;
438} gcmac_pyobj;
439
440extern PyTypeObject *gcmac_pytype;
441#define GCMAC_PYCHECK(o) PyObject_TypeCheck((o), gcmac_pytype)
442#define GCMAC_CM(o) (((gcmac_pyobj *)(o))->cm)
443#define GCMAC_F(o) (((gcmac_pyobj *)(o))->f)
444extern PyObject *gcmac_pywrap(gcmac *);
445extern int convgcmac(PyObject *, void *);
446
447typedef struct gmac_pyobj {
448 PyTypeObject ty;
449 unsigned f;
450 gmac *m;
451 PyObject *nameobj;
452} gmac_pyobj;
453
454extern PyTypeObject *gmac_pytype;
455#define GMAC_PYCHECK(o) PyObject_TypeCheck((o), gmac_pytype)
456#define GMAC_M(o) (((gmac_pyobj *)(o))->m)
457#define GMAC_NAMEOBJ(o) (((gmac_pyobj *)(o))->nameobj)
458#define GMAC_F(o) (((gmac_pyobj *)(o))->f)
459extern PyObject *gmac_pywrap(PyObject *, gmac *, unsigned);
460extern int convgmac(PyObject *, void *);
461
462/*----- Public key crypto -------------------------------------------------*/
463
464/*----- Key generation ----------------------------------------------------*/
465
466typedef struct pfilt_pyobj {
467 PyObject_HEAD
468 pfilt f;
469 int st;
470} pfilt_pyobj;
471
472extern PyTypeObject *pfilt_pytype;
473#define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
474#define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
475#define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
476
477typedef struct { pgen_proc *proc; void *ctx; } pgev;
478#define PGEV_HEAD PyObject_HEAD pgev pg;
479
480typedef struct pgev_pyobj {
481 PGEV_HEAD
482} pgev_pyobj;
483
484extern PyTypeObject *pgev_pytype;
485#define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
486#define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
487
488extern int convpgev(PyObject *, void *);
489extern void droppgev(pgev *);
490extern void pgenerr(void);
491
492/*----- Core utility functions --------------------------------------------*/
493
494extern PyObject *mexp_common(PyObject *, PyObject *, size_t,
495 PyObject *(*id)(PyObject *),
496 int (*fill)(void *, PyObject *,
497 PyObject *, PyObject *),
498 PyObject *(*exp)(PyObject *, void *, int),
499 void (*drop)(void *));
500
501extern int convulong(PyObject *, void *);
502extern int convu32(PyObject *, void *);
503extern int convmpw(PyObject *, void *);
504extern int convuint(PyObject *, void *);
505extern int convszt(PyObject *, void *);
506extern int convbool(PyObject *, void *);
507extern PyObject *abstract_pynew(PyTypeObject *, PyObject *, PyObject *);
508extern PyObject *getbool(int);
509extern PyObject *getu32(uint32);
510extern void *newtype(PyTypeObject *, const PyTypeObject *);
511extern PyTypeObject *inittype(PyTypeObject *);
512extern void addmethods(const PyMethodDef *);
513
514/*----- That's all, folks -------------------------------------------------*/
515
516#ifdef __cplusplus
517 }
518#endif
519
520#endif
The Python Kit for Extensions: a library for writing Python extensions