algorithms.c: Add bindings for STROBE.

[catacomb-python] / catacomb-python.h

/* -*-c-*-
 *
 * Definitions for Catacomb bindings
 *
 * (c) 2004 Straylight/Edgeware
 */

/*----- Licensing notice --------------------------------------------------*
 *
 * This file is part of the Python interface to Catacomb.
 *
 * Catacomb/Python is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Catacomb/Python is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Catacomb/Python; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef CATACOMB_PYTHON_H
#define CATACOMB_PYTHON_H

#ifdef __cplusplus
  extern "C" {
#endif

/*----- Header files ------------------------------------------------------*/

#include "pyke/pyke-mLib.h"

PUBLIC_SYMBOLS;
#include <longintrepr.h>

#include <mLib/dstr.h>
#include <mLib/macros.h>
#include <mLib/quis.h>
#include <mLib/unihash.h>

#include <catacomb/buf.h>
#include <catacomb/ct.h>

#include <catacomb/grand.h>
#include <catacomb/rand.h>
#include <catacomb/noise.h>
#include <catacomb/bbs.h>
#include <catacomb/mprand.h>
#include <catacomb/lcrand.h>
#include <catacomb/fibrand.h>
#include <catacomb/dsarand.h>
#include <catacomb/sslprf.h>
#include <catacomb/tlsprf.h>
#include <catacomb/blkc.h>

#include <catacomb/gcipher.h>
#include <catacomb/gaead.h>
#include <catacomb/ghash.h>
#include <catacomb/gmac.h>
#include <catacomb/md5.h>
#include <catacomb/md5-hmac.h>
#include <catacomb/poly1305.h>
#include <catacomb/sha.h>
#include <catacomb/sha-mgf.h>
#include <catacomb/sha-hmac.h>
#include <catacomb/keccak1600.h>
#include <catacomb/sha3.h>
#include <catacomb/strobe.h>

#include <catacomb/mp.h>
#include <catacomb/mpint.h>
#include <catacomb/mpmul.h>
#include <catacomb/mpcrt.h>
#include <catacomb/mpmont.h>
#include <catacomb/mpbarrett.h>
#include <catacomb/mpreduce.h>
#include <catacomb/mp-fibonacci.h>

#include <catacomb/pgen.h>
#include <catacomb/primeiter.h>
#include <catacomb/pfilt.h>
#include <catacomb/strongprime.h>
#include <catacomb/limlee.h>
#include <catacomb/dh.h>
#include <catacomb/ptab.h>
#include <catacomb/bintab.h>
#include <catacomb/dsa.h>
#include <catacomb/x25519.h>
#include <catacomb/x448.h>
#include <catacomb/ed25519.h>
#include <catacomb/ed448.h>

#include <catacomb/gf.h>
#include <catacomb/gfreduce.h>
#include <catacomb/gfn.h>

#include <catacomb/field.h>
#include <catacomb/field-guts.h>

#include <catacomb/ec.h>
#include <catacomb/ec-raw.h>
#include <catacomb/ectab.h>

#include <catacomb/group.h>
#include <catacomb/group-guts.h>

#include <catacomb/gdsa.h>
#include <catacomb/gkcdsa.h>
#include <catacomb/rsa.h>

#include <catacomb/key.h>
#include <catacomb/passphrase.h>
#include <catacomb/pixie.h>

#include <catacomb/share.h>
#include <catacomb/gfshare.h>
PRIVATE_SYMBOLS;

/*----- Miscellaneous preliminaries ---------------------------------------*/

/* Submodules. */
#define MODULES(_)							\
  _(pyke_core) _(pyke_gmap)						\
  _(bytestring) _(buffer)						\
  _(rand) _(algorithms) _(pubkey) _(pgen)				\
  _(mp) _(field) _(ec) _(group)						\
  _(passphrase) _(share) _(key)
MODULES(DECLARE_MODINIT)

/* Exceptions. */
#define PGENERR(err) do { pgenerr(err); goto end; } while (0)

/* Conversions. */
extern int convmpw(PyObject *, void *);

/* Building tables of things. */
extern PyObject *make_algtab(const void *tab, size_t esz,
			     const char *(*namefn)(const void *),
			     PyObject *(*valfn)(const void *));
extern PyObject *make_grouptab(const void *tab, size_t esz,
			       const char *(*namefn)(const void *),
			       int (*ixfn)(const void *),
			       PyObject *(*valfn)(int));

/* Common handling for simultaneous exponentiation. */
extern PyObject *mexp_common(PyObject *, PyObject *, size_t,
			     PyObject *(*id)(PyObject *),
			     int (*fill)(void *, PyObject *,
					 PyObject *, PyObject *),
			     PyObject *(*exp)(PyObject *, void *, size_t),
			     void (*drop)(void *));

/*----- Bytestrings -------------------------------------------------------*/

PyObject *bytestring_pywrap(const void *, size_t);
PyObject *bytestring_pywrapbuf(buf *);

/*----- Buffers -----------------------------------------------------------*/

typedef struct buf_pyobj {
  PyObject_HEAD
  buf b;
  PyObject *sub;
  unsigned lk;
} buf_pyobj;

extern PyTypeObject *rbuf_pytype, *wbuf_pytype;
#define RBUF_PYCHECK(o) PyObject_TypeCheck((o), rbuf_pytype)
#define WBUF_PYCHECK(o) PyObject_TypeCheck((o), wbuf_pytype)
#define BUF_B(o) (&((buf_pyobj *)(o))->b)
#define BUF_SUB(o) (((buf_pyobj *)(o))->sub)
#define BUF_LK(o) (((buf_pyobj *)(o))->lk)

extern PyObject *buferr;
#define BUFERR(str) do { PyErr_SetString(buferr, str); goto end; } while (0)

extern int ensurebuf(PyObject *, size_t);

/*----- Multiprecision arithmetic -----------------------------------------*/

typedef struct mp_pyobj {
  PyObject_HEAD
  mp *x;
} mp_pyobj;

extern PyTypeObject *mp_pytype;
extern PyTypeObject *gf_pytype;
#define MP_X(o) (((mp_pyobj *)(o))->x)
#define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
#define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)

extern mp *mp_frompylong(PyObject *);
extern PyObject *mp_topylong(mp *);
extern mp *tomp(PyObject *);
extern mp *implicitmp(PyObject *);
extern mp *getmp(PyObject *);
extern int convmp(PyObject *, void *);
extern mp *implicitgf(PyObject *);
extern mp *getgf(PyObject *);
extern int convgf(PyObject *, void *);
extern PyObject *mp_pywrap(mp *);
extern PyObject *gf_pywrap(mp *);
extern Py_hash_t mphash(mp *);
extern mp *mp_frompyobject(PyObject *, int);
extern PyObject *mp_topystring(mp *, int,
			       const char *, const char *, const char *);
extern int mp_tolong_checked(mp *, long *, int);

/*----- Abstract fields ---------------------------------------------------*/

typedef struct field_pyobj {
  PyHeapTypeObject ty;
  field *f;
} field_pyobj;

extern PyTypeObject *field_pytype;
extern PyTypeObject *primefield_pytype;
extern PyTypeObject *niceprimefield_pytype;
extern PyTypeObject *binfield_pytype;
extern PyTypeObject *binpolyfield_pytype;
extern PyTypeObject *binnormfield_pytype;
#define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
#define FIELD_F(o) (((field_pyobj *)(o))->f)
extern PyObject *field_pywrap(field *);
extern field *field_copy(field *);

typedef struct fe_pyobj {
  PyObject_HEAD
  field *f;
  mp *x;
} fe_pyobj;

extern PyTypeObject *fe_pytype;
#define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
#define FE_F(o) (((fe_pyobj *)(o))->f)
#define FE_FOBJ(o) ((PyObject *)Py_TYPE(o))
#define FE_X(o) (((fe_pyobj *)(o))->x)
extern PyObject *fe_pywrap(PyObject *, mp *);

/*----- Elliptic curves ---------------------------------------------------*/

typedef struct eccurve_pyobj {
  PyHeapTypeObject ty;
  ec_curve *c;
  PyObject *fobj;
} eccurve_pyobj;

extern PyTypeObject *eccurve_pytype;
extern PyTypeObject *ecprimecurve_pytype;
extern PyTypeObject *ecprimeprojcurve_pytype;
extern PyTypeObject *ecbincurve_pytype;
extern PyTypeObject *ecbinprojcurve_pytype;
#define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
#define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
#define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
extern PyObject *eccurve_pywrap(PyObject *, ec_curve *);
extern ec_curve *eccurve_copy(ec_curve *);

typedef struct ecpt_pyobj {
  PyObject_HEAD
  ec_curve *c;
  ec p;
} ecpt_pyobj;

extern PyTypeObject *ecpt_pytype, *ecptcurve_pytype;
#define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
#define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
#define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
#define ECPT_COBJ(o) ((PyObject *)Py_TYPE(o))
#define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
#define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
extern PyObject *ecpt_pywrap(PyObject *, ec *);
extern PyObject *ecpt_pywrapout(void *, ec *);
extern int toecpt(ec_curve *, ec *, PyObject *);
extern int getecpt(ec_curve *, ec *, PyObject *);
extern void getecptout(ec *, PyObject *);
extern int convecpt(PyObject *, void *);

typedef struct ecinfo_pyobj {
  PyObject_HEAD
  ec_info ei;
  PyObject *cobj;
} ecinfo_pyobj;

extern PyTypeObject *ecinfo_pytype;
#define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
#define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
#define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
extern void ecinfo_copy(ec_info *, const ec_info *);
extern PyObject *ecinfo_pywrap(ec_info *);

/*----- Cyclic groups -----------------------------------------------------*/

typedef struct ge_pyobj {
  PyObject_HEAD
  ge *x;
  group *g;
} ge_pyobj;

extern PyTypeObject *ge_pytype;
#define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
#define GE_X(o) (((ge_pyobj *)(o))->x)
#define GE_G(o) (((ge_pyobj *)(o))->g)
#define GE_GOBJ(o) (PyObject *)(Py_TYPE(o))
extern PyObject *ge_pywrap(PyObject *, ge *);

typedef struct group_pyobj {
  PyHeapTypeObject ty;
  group *g;
} group_pyobj;

extern PyTypeObject *group_pytype;
#define GROUP_G(o) (((group_pyobj *)(o))->g)
extern PyObject *group_pywrap(group *);
extern group *group_copy(group *);

/*----- Random number generators ------------------------------------------*/

#define f_freeme 1u

typedef struct grand_pyobj {
  PyObject_HEAD
  unsigned f;
  grand *r;
} grand_pyobj;

extern PyTypeObject *grand_pytype;
extern PyObject *rand_pyobj;
#define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
#define GRAND_F(o) (((grand_pyobj *)(o))->f)
#define GRAND_R(o) (((grand_pyobj *)(o))->r)
extern PyObject *grand_pywrap(grand *, unsigned);
extern int convgrand(PyObject *, void *);

/*----- Symmetric cryptography --------------------------------------------*/

extern PyObject *keysz_pywrap(const octet *);

extern int convgccipher(PyObject *, void *);
extern PyObject *gccipher_pywrap(gccipher *);

typedef struct gchash_pyobj {
  PyHeapTypeObject ty;
  gchash *ch;
} gchash_pyobj;

extern PyTypeObject *gchash_pytype;
extern PyObject *sha_pyobj, *has160_pyobj;
#define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
#define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
extern PyObject *ghash_pywrap(PyObject *, ghash *);
extern int convgchash(PyObject *, void *);
extern int convghash(PyObject *, void *);

extern int convgcmac(PyObject *, void *);

/*----- Key generation ----------------------------------------------------*/

typedef struct pfilt_pyobj {
  PyObject_HEAD
  pfilt f;
  int st;
} pfilt_pyobj;

extern PyTypeObject *pfilt_pytype;
#define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
#define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
#define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)

typedef struct { pgen_proc *proc; void *ctx; } pgev;
#define PGEV_HEAD PyObject_HEAD pgev pg;

typedef struct pgev_pyobj {
  PGEV_HEAD
} pgev_pyobj;

extern PyTypeObject *pgev_pytype;
#define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
#define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)

typedef struct pypgev {
  pgev ev;
  PyObject *obj;
  struct excinfo *exc;
} pypgev;

extern int convpgev(PyObject *, void *);
extern void droppgev(pypgev *);
extern void pgenerr(struct excinfo *exc);

/*----- That's all, folks -------------------------------------------------*/

#ifdef __cplusplus
  }
#endif

#endif