algorithms.c (FOO.hashbufN): Consistently raise `ValueError' if too big.
[catacomb-python] / catacomb-python.h
CommitLineData
d7ab1bab 1/* -*-c-*-
2 *
d7ab1bab 3 * Definitions for Catacomb bindings
4 *
5 * (c) 2004 Straylight/Edgeware
6 */
7
b2687a0a 8/*----- Licensing notice --------------------------------------------------*
d7ab1bab 9 *
10 * This file is part of the Python interface to Catacomb.
11 *
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.
b2687a0a 16 *
d7ab1bab 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.
b2687a0a 21 *
d7ab1bab 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.
25 */
26
27#ifndef CATACOMB_PYTHON_H
28#define CATACOMB_PYTHON_H
29
30#ifdef __cplusplus
31 extern "C" {
32#endif
33
34/*----- Header files ------------------------------------------------------*/
35
10e6f88a 36#include "pyke/pyke-mLib.h"
6b54260d 37
10e6f88a 38PUBLIC_SYMBOLS;
d7ab1bab 39#include <longintrepr.h>
d7ab1bab 40
d7ab1bab 41#include <mLib/dstr.h>
42#include <mLib/macros.h>
46e6ad89 43#include <mLib/quis.h>
6d481bc6 44#include <mLib/unihash.h>
d7ab1bab 45
46#include <catacomb/buf.h>
bfb450cc 47#include <catacomb/ct.h>
d7ab1bab 48
49#include <catacomb/grand.h>
50#include <catacomb/rand.h>
51#include <catacomb/noise.h>
52#include <catacomb/bbs.h>
53#include <catacomb/mprand.h>
54#include <catacomb/lcrand.h>
55#include <catacomb/fibrand.h>
56#include <catacomb/dsarand.h>
57#include <catacomb/sslprf.h>
58#include <catacomb/tlsprf.h>
03ed9abb 59#include <catacomb/blkc.h>
d7ab1bab 60
61#include <catacomb/gcipher.h>
bebf03ab 62#include <catacomb/gaead.h>
d7ab1bab 63#include <catacomb/ghash.h>
64#include <catacomb/gmac.h>
65#include <catacomb/md5.h>
66#include <catacomb/md5-hmac.h>
204d480b 67#include <catacomb/poly1305.h>
d7ab1bab 68#include <catacomb/sha.h>
69#include <catacomb/sha-mgf.h>
70#include <catacomb/sha-hmac.h>
b35fdbe6 71#include <catacomb/keccak1600.h>
6bd22b53 72#include <catacomb/sha3.h>
d7ab1bab 73
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>
6313f40e 81#include <catacomb/mp-fibonacci.h>
d7ab1bab 82
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>
848ba392 91#include <catacomb/x25519.h>
eb8aa4ec 92#include <catacomb/x448.h>
dafb2da4 93#include <catacomb/ed25519.h>
eee202c3 94#include <catacomb/ed448.h>
d7ab1bab 95
96#include <catacomb/gf.h>
97#include <catacomb/gfreduce.h>
98#include <catacomb/gfn.h>
99
100#include <catacomb/field.h>
101#include <catacomb/field-guts.h>
102
103#include <catacomb/ec.h>
104#include <catacomb/ec-raw.h>
105#include <catacomb/ectab.h>
106
107#include <catacomb/group.h>
108#include <catacomb/group-guts.h>
109
110#include <catacomb/gdsa.h>
111#include <catacomb/gkcdsa.h>
112#include <catacomb/rsa.h>
113
114#include <catacomb/key.h>
115#include <catacomb/passphrase.h>
116#include <catacomb/pixie.h>
117
46e6ad89 118#include <catacomb/share.h>
119#include <catacomb/gfshare.h>
6640e060
MW
120PRIVATE_SYMBOLS;
121
10e6f88a 122/*----- Miscellaneous preliminaries ---------------------------------------*/
d7ab1bab 123
10e6f88a 124/* Submodules. */
46e6ad89 125#define MODULES(_) \
10e6f88a 126 _(pyke_core) _(pyke_gmap) \
46e6ad89 127 _(bytestring) _(buffer) \
128 _(rand) _(algorithms) _(pubkey) _(pgen) \
129 _(mp) _(field) _(ec) _(group) \
0b1b92bd 130 _(passphrase) _(share) _(key)
4e191783 131MODULES(DECLARE_MODINIT)
d7ab1bab 132
10e6f88a
MW
133/* Exceptions. */
134#define PGENERR(err) do { pgenerr(err); goto end; } while (0)
135
136/* Conversions. */
137extern int convmpw(PyObject *, void *);
3aa33042 138
a539ffb8
MW
139/* Building tables of things. */
140extern PyObject *make_algtab(const void *tab, size_t esz,
141 const char *(*namefn)(const void *),
142 PyObject *(*valfn)(const void *));
143extern PyObject *make_grouptab(const void *tab, size_t esz,
144 const char *(*namefn)(const void *),
145 int (*ixfn)(const void *),
146 PyObject *(*valfn)(int));
11cb3d97 147
10e6f88a 148/* Common handling for simultaneous exponentiation. */
11cb3d97
MW
149extern PyObject *mexp_common(PyObject *, PyObject *, size_t,
150 PyObject *(*id)(PyObject *),
151 int (*fill)(void *, PyObject *,
152 PyObject *, PyObject *),
153 PyObject *(*exp)(PyObject *, void *, int),
154 void (*drop)(void *));
155
d7ab1bab 156/*----- Bytestrings -------------------------------------------------------*/
157
d7ab1bab 158PyObject *bytestring_pywrap(const void *, size_t);
159PyObject *bytestring_pywrapbuf(buf *);
160
dc088b4d
MW
161/*----- Buffers -----------------------------------------------------------*/
162
163typedef struct buf_pyobj {
164 PyObject_HEAD
165 buf b;
166 PyObject *sub;
167 unsigned lk;
168} buf_pyobj;
169
170extern PyTypeObject *rbuf_pytype, *wbuf_pytype;
171#define RBUF_PYCHECK(o) PyObject_TypeCheck((o), rbuf_pytype)
172#define WBUF_PYCHECK(o) PyObject_TypeCheck((o), wbuf_pytype)
173#define BUF_B(o) (&((buf_pyobj *)(o))->b)
174#define BUF_SUB(o) (((buf_pyobj *)(o))->sub)
175#define BUF_LK(o) (((buf_pyobj *)(o))->lk)
176
177extern PyObject *buferr;
178#define BUFERR(str) do { PyErr_SetString(buferr, str); goto end; } while (0)
179
180extern int ensurebuf(PyObject *, size_t);
181
d7ab1bab 182/*----- Multiprecision arithmetic -----------------------------------------*/
183
184typedef struct mp_pyobj {
185 PyObject_HEAD
186 mp *x;
187} mp_pyobj;
188
189extern PyTypeObject *mp_pytype;
190extern PyTypeObject *gf_pytype;
191#define MP_X(o) (((mp_pyobj *)(o))->x)
192#define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
193#define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
194
f368b46e
MW
195extern mp *mp_frompylong(PyObject *);
196extern PyObject *mp_topylong(mp *);
d7ab1bab 197extern mp *tomp(PyObject *);
198extern mp *getmp(PyObject *);
199extern int convmp(PyObject *, void *);
200extern mp *getgf(PyObject *);
201extern int convgf(PyObject *, void *);
202extern PyObject *mp_pywrap(mp *);
203extern PyObject *gf_pywrap(mp *);
d6d78edc 204extern Py_hash_t mphash(mp *);
d7ab1bab 205extern mp *mp_frompyobject(PyObject *, int);
206extern PyObject *mp_topystring(mp *, int,
207 const char *, const char *, const char *);
bc243788 208extern int mp_tolong_checked(mp *, long *, int);
d7ab1bab 209
210/*----- Abstract fields ---------------------------------------------------*/
211
212typedef struct field_pyobj {
df9f8366 213 PyHeapTypeObject ty;
d7ab1bab 214 field *f;
215} field_pyobj;
216
d7ab1bab 217extern PyTypeObject *field_pytype;
218extern PyTypeObject *primefield_pytype;
219extern PyTypeObject *niceprimefield_pytype;
220extern PyTypeObject *binfield_pytype;
221extern PyTypeObject *binpolyfield_pytype;
222extern PyTypeObject *binnormfield_pytype;
223#define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
224#define FIELD_F(o) (((field_pyobj *)(o))->f)
225extern PyObject *field_pywrap(field *);
226extern field *field_copy(field *);
227
c6e89d48
MW
228typedef struct fe_pyobj {
229 PyObject_HEAD
230 field *f;
231 mp *x;
232} fe_pyobj;
233
234extern PyTypeObject *fe_pytype;
235#define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
236#define FE_F(o) (((fe_pyobj *)(o))->f)
2a448f86 237#define FE_FOBJ(o) ((PyObject *)Py_TYPE(o))
c6e89d48
MW
238#define FE_X(o) (((fe_pyobj *)(o))->x)
239extern PyObject *fe_pywrap(PyObject *, mp *);
240
d7ab1bab 241/*----- Elliptic curves ---------------------------------------------------*/
242
c6e89d48
MW
243typedef struct eccurve_pyobj {
244 PyHeapTypeObject ty;
245 ec_curve *c;
246 PyObject *fobj;
247} eccurve_pyobj;
248
249extern PyTypeObject *eccurve_pytype;
250extern PyTypeObject *ecprimecurve_pytype;
251extern PyTypeObject *ecprimeprojcurve_pytype;
252extern PyTypeObject *ecbincurve_pytype;
253extern PyTypeObject *ecbinprojcurve_pytype;
254#define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
255#define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
256#define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
257extern PyObject *eccurve_pywrap(PyObject *, ec_curve *);
258extern ec_curve *eccurve_copy(ec_curve *);
259
d7ab1bab 260typedef struct ecpt_pyobj {
261 PyObject_HEAD
262 ec_curve *c;
263 ec p;
264} ecpt_pyobj;
265
266extern PyTypeObject *ecpt_pytype, *ecptcurve_pytype;
267#define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
268#define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
269#define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
2a448f86 270#define ECPT_COBJ(o) ((PyObject *)Py_TYPE(o))
d7ab1bab 271#define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
272#define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
273extern PyObject *ecpt_pywrap(PyObject *, ec *);
274extern PyObject *ecpt_pywrapout(void *, ec *);
275extern int toecpt(ec_curve *, ec *, PyObject *);
276extern int getecpt(ec_curve *, ec *, PyObject *);
277extern void getecptout(ec *, PyObject *);
46e6ad89 278extern int convecpt(PyObject *, void *);
d7ab1bab 279
d7ab1bab 280typedef struct ecinfo_pyobj {
281 PyObject_HEAD
282 ec_info ei;
283 PyObject *cobj;
284} ecinfo_pyobj;
b2687a0a 285
d7ab1bab 286extern PyTypeObject *ecinfo_pytype;
287#define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
288#define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
289#define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
290extern void ecinfo_copy(ec_info *, const ec_info *);
291extern PyObject *ecinfo_pywrap(ec_info *);
292
293/*----- Cyclic groups -----------------------------------------------------*/
294
d7ab1bab 295typedef struct ge_pyobj {
296 PyObject_HEAD
297 ge *x;
298 group *g;
299} ge_pyobj;
300
301extern PyTypeObject *ge_pytype;
302#define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
303#define GE_X(o) (((ge_pyobj *)(o))->x)
304#define GE_G(o) (((ge_pyobj *)(o))->g)
2a448f86 305#define GE_GOBJ(o) (PyObject *)(Py_TYPE(o))
d7ab1bab 306extern PyObject *ge_pywrap(PyObject *, ge *);
307
308typedef struct group_pyobj {
df9f8366 309 PyHeapTypeObject ty;
d7ab1bab 310 group *g;
311} group_pyobj;
312
313extern PyTypeObject *group_pytype;
d7ab1bab 314#define GROUP_G(o) (((group_pyobj *)(o))->g)
315extern PyObject *group_pywrap(group *);
316extern group *group_copy(group *);
317
318/*----- Random number generators ------------------------------------------*/
319
320#define f_freeme 1u
321
322typedef struct grand_pyobj {
323 PyObject_HEAD
324 unsigned f;
325 grand *r;
326} grand_pyobj;
327
c6e89d48 328extern PyTypeObject *grand_pytype;
d7ab1bab 329extern PyObject *rand_pyobj;
330#define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
331#define GRAND_F(o) (((grand_pyobj *)(o))->f)
332#define GRAND_R(o) (((grand_pyobj *)(o))->r)
333extern PyObject *grand_pywrap(grand *, unsigned);
334extern int convgrand(PyObject *, void *);
335
d7ab1bab 336/*----- Symmetric cryptography --------------------------------------------*/
337
c6e89d48 338extern PyObject *keysz_pywrap(const octet *);
d7ab1bab 339
d7ab1bab 340extern int convgccipher(PyObject *, void *);
c6e89d48 341extern PyObject *gccipher_pywrap(gccipher *);
bebf03ab 342
d7ab1bab 343typedef struct gchash_pyobj {
df9f8366 344 PyHeapTypeObject ty;
d7ab1bab 345 gchash *ch;
346} gchash_pyobj;
347
348extern PyTypeObject *gchash_pytype;
c6e89d48 349extern PyObject *sha_pyobj, *has160_pyobj;
d7ab1bab 350#define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
351#define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
c41d0371 352extern PyObject *ghash_pywrap(PyObject *, ghash *);
c6e89d48 353extern int convgchash(PyObject *, void *);
d7ab1bab 354extern int convghash(PyObject *, void *);
d7ab1bab 355
d7ab1bab 356extern int convgcmac(PyObject *, void *);
357
d7ab1bab 358/*----- Key generation ----------------------------------------------------*/
b2687a0a 359
d7ab1bab 360typedef struct pfilt_pyobj {
361 PyObject_HEAD
362 pfilt f;
363 int st;
364} pfilt_pyobj;
365
366extern PyTypeObject *pfilt_pytype;
367#define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
368#define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
369#define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
370
371typedef struct { pgen_proc *proc; void *ctx; } pgev;
372#define PGEV_HEAD PyObject_HEAD pgev pg;
373
374typedef struct pgev_pyobj {
375 PGEV_HEAD
376} pgev_pyobj;
377
378extern PyTypeObject *pgev_pytype;
379#define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
380#define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
381
930d78e3
MW
382typedef struct pypgev {
383 pgev ev;
384 PyObject *obj;
385 struct excinfo *exc;
386} pypgev;
387
d7ab1bab 388extern int convpgev(PyObject *, void *);
930d78e3
MW
389extern void droppgev(pypgev *);
390extern void pgenerr(struct excinfo *exc);
d7ab1bab 391
d7ab1bab 392/*----- That's all, folks -------------------------------------------------*/
393
394#ifdef __cplusplus
395 }
396#endif
397
398#endif