mdw@git.distorted.org.uk Git - catacomb-python/blob - catacomb-python.h

   1 /* -*-c-*-
   2  *
   3  * Definitions for Catacomb bindings
   4  *
   5  * (c) 2004 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   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.
  16  *
  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.
  21  *
  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
  36 #include "pyke/pyke-mLib.h"
  37
  38 PUBLIC_SYMBOLS;
  39 #include <longintrepr.h>
  40
  41 #include <mLib/dstr.h>
  42 #include <mLib/macros.h>
  43 #include <mLib/quis.h>
  44 #include <mLib/unihash.h>
  45
  46 #include <catacomb/buf.h>
  47 #include <catacomb/ct.h>
  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>
  59 #include <catacomb/blkc.h>
  60
  61 #include <catacomb/gcipher.h>
  62 #include <catacomb/gaead.h>
  63 #include <catacomb/ghash.h>
  64 #include <catacomb/gmac.h>
  65 #include <catacomb/md5.h>
  66 #include <catacomb/md5-hmac.h>
  67 #include <catacomb/poly1305.h>
  68 #include <catacomb/sha.h>
  69 #include <catacomb/sha-mgf.h>
  70 #include <catacomb/sha-hmac.h>
  71 #include <catacomb/keccak1600.h>
  72 #include <catacomb/sha3.h>
  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>
  81 #include <catacomb/mp-fibonacci.h>
  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>
  91 #include <catacomb/x25519.h>
  92 #include <catacomb/x448.h>
  93 #include <catacomb/ed25519.h>
  94 #include <catacomb/ed448.h>
  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
 118 #include <catacomb/share.h>
 119 #include <catacomb/gfshare.h>
 120 PRIVATE_SYMBOLS;
 121
 122 /*----- Miscellaneous preliminaries ---------------------------------------*/
 123
 124 /* Submodules. */
 125 #define MODULES(_)                                                      \
 126   _(pyke_core) _(pyke_gmap)                                             \
 127   _(bytestring) _(buffer)                                               \
 128   _(rand) _(algorithms) _(pubkey) _(pgen)                               \
 129   _(mp) _(field) _(ec) _(group)                                         \
 130   _(passphrase) _(share) _(key)
 131 MODULES(DECLARE_MODINIT)
 132
 133 /* Exceptions. */
 134 #define PGENERR(err) do { pgenerr(err); goto end; } while (0)
 135
 136 /* Conversions. */
 137 extern int convmpw(PyObject *, void *);
 138
 139 /* Make a dictionary of generic-crypto classes. */
 140 #define GEN(func, base)                                                 \
 141   static PyObject *func(void)                                           \
 142   {                                                                     \
 143     PyObject *d = PyDict_New();                                         \
 144     PyObject *o;                                                        \
 145     int i;                                                              \
 146                                                                         \
 147     for (i = 0; g##base##tab[i]; i++) {                                 \
 148       o = gc##base##_pywrap(CONVERT_CAREFULLY(gc##base *, const gc##base *, \
 149                                               g##base##tab[i]));        \
 150       PyDict_SetItemString(d,                                           \
 151                            (/*unconst*/ char *)g##base##tab[i]->name,   \
 152                            o);                                          \
 153       Py_DECREF(o);                                                     \
 154     }                                                                   \
 155     return (d);                                                         \
 156   }
 157
 158 /* Common handling for simultaneous exponentiation. */
 159 extern PyObject *mexp_common(PyObject *, PyObject *, size_t,
 160                              PyObject *(*id)(PyObject *),
 161                              int (*fill)(void *, PyObject *,
 162                                          PyObject *, PyObject *),
 163                              PyObject *(*exp)(PyObject *, void *, int),
 164                              void (*drop)(void *));
 165
 166 /*----- Bytestrings -------------------------------------------------------*/
 167
 168 PyObject *bytestring_pywrap(const void *, size_t);
 169 PyObject *bytestring_pywrapbuf(buf *);
 170
 171 /*----- Multiprecision arithmetic -----------------------------------------*/
 172
 173 typedef struct mp_pyobj {
 174   PyObject_HEAD
 175   mp *x;
 176 } mp_pyobj;
 177
 178 extern PyTypeObject *mp_pytype;
 179 extern PyTypeObject *gf_pytype;
 180 #define MP_X(o) (((mp_pyobj *)(o))->x)
 181 #define MP_PYCHECK(o) PyObject_TypeCheck((o), mp_pytype)
 182 #define GF_PYCHECK(o) PyObject_TypeCheck((o), gf_pytype)
 183
 184 extern mp *mp_frompylong(PyObject *);
 185 extern PyObject *mp_topylong(mp *);
 186 extern mp *tomp(PyObject *);
 187 extern mp *getmp(PyObject *);
 188 extern int convmp(PyObject *, void *);
 189 extern mp *getgf(PyObject *);
 190 extern int convgf(PyObject *, void *);
 191 extern PyObject *mp_pywrap(mp *);
 192 extern PyObject *gf_pywrap(mp *);
 193 extern long mphash(mp *);
 194 extern mp *mp_frompyobject(PyObject *, int);
 195 extern PyObject *mp_topystring(mp *, int,
 196                                const char *, const char *, const char *);
 197 extern int mp_tolong_checked(mp *, long *, int);
 198
 199 /*----- Abstract fields ---------------------------------------------------*/
 200
 201 typedef struct field_pyobj {
 202   PyHeapTypeObject ty;
 203   field *f;
 204 } field_pyobj;
 205
 206 extern PyTypeObject *field_pytype;
 207 extern PyTypeObject *primefield_pytype;
 208 extern PyTypeObject *niceprimefield_pytype;
 209 extern PyTypeObject *binfield_pytype;
 210 extern PyTypeObject *binpolyfield_pytype;
 211 extern PyTypeObject *binnormfield_pytype;
 212 #define FIELD_PYCHECK(o) PyObject_TypeCheck((o), field_pytype)
 213 #define FIELD_F(o) (((field_pyobj *)(o))->f)
 214 extern PyObject *field_pywrap(field *);
 215 extern field *field_copy(field *);
 216
 217 typedef struct fe_pyobj {
 218   PyObject_HEAD
 219   field *f;
 220   mp *x;
 221 } fe_pyobj;
 222
 223 extern PyTypeObject *fe_pytype;
 224 #define FE_PYCHECK(o) PyObject_TypeCheck((o), fe_pytype)
 225 #define FE_F(o) (((fe_pyobj *)(o))->f)
 226 #define FE_FOBJ(o) ((PyObject *)(o)->ob_type)
 227 #define FE_X(o) (((fe_pyobj *)(o))->x)
 228 extern PyObject *fe_pywrap(PyObject *, mp *);
 229
 230 /*----- Elliptic curves ---------------------------------------------------*/
 231
 232 typedef struct eccurve_pyobj {
 233   PyHeapTypeObject ty;
 234   ec_curve *c;
 235   PyObject *fobj;
 236 } eccurve_pyobj;
 237
 238 extern PyTypeObject *eccurve_pytype;
 239 extern PyTypeObject *ecprimecurve_pytype;
 240 extern PyTypeObject *ecprimeprojcurve_pytype;
 241 extern PyTypeObject *ecbincurve_pytype;
 242 extern PyTypeObject *ecbinprojcurve_pytype;
 243 #define ECCURVE_PYCHECK(o) PyObject_TypeCheck((o), eccurve_pytype)
 244 #define ECCURVE_C(o) (((eccurve_pyobj *)(o))->c)
 245 #define ECCURVE_FOBJ(o) (((eccurve_pyobj *)(o))->fobj)
 246 extern PyObject *eccurve_pywrap(PyObject *, ec_curve *);
 247 extern ec_curve *eccurve_copy(ec_curve *);
 248
 249 typedef struct ecpt_pyobj {
 250   PyObject_HEAD
 251   ec_curve *c;
 252   ec p;
 253 } ecpt_pyobj;
 254
 255 extern PyTypeObject *ecpt_pytype, *ecptcurve_pytype;
 256 #define ECPT_PYCHECK(o) PyObject_TypeCheck((o), ecpt_pytype)
 257 #define ECPTCURVE_PYCHECK(o) PyObject_TypeCheck((o), ecptcurve_pytype)
 258 #define ECPT_C(o) (((ecpt_pyobj *)(o))->c)
 259 #define ECPT_COBJ(o) ((PyObject *)(o)->ob_type)
 260 #define ECPT_FOBJ(o) ECCURVE_FOBJ(ECPT_COBJ((o)))
 261 #define ECPT_P(o) (&((ecpt_pyobj *)(o))->p)
 262 extern PyObject *ecpt_pywrap(PyObject *, ec *);
 263 extern PyObject *ecpt_pywrapout(void *, ec *);
 264 extern int toecpt(ec_curve *, ec *, PyObject *);
 265 extern int getecpt(ec_curve *, ec *, PyObject *);
 266 extern void getecptout(ec *, PyObject *);
 267 extern int convecpt(PyObject *, void *);
 268
 269 typedef struct ecinfo_pyobj {
 270   PyObject_HEAD
 271   ec_info ei;
 272   PyObject *cobj;
 273 } ecinfo_pyobj;
 274
 275 extern PyTypeObject *ecinfo_pytype;
 276 #define ECINFO_PYCHECK(o) PyObject_TypeCheck((o), ecinfo_pytype)
 277 #define ECINFO_EI(o) (&((ecinfo_pyobj *)(o))->ei)
 278 #define ECINFO_COBJ(o) (((ecinfo_pyobj *)(o))->cobj)
 279 extern void ecinfo_copy(ec_info *, const ec_info *);
 280 extern PyObject *ecinfo_pywrap(ec_info *);
 281
 282 /*----- Cyclic groups -----------------------------------------------------*/
 283
 284 typedef struct ge_pyobj {
 285   PyObject_HEAD
 286   ge *x;
 287   group *g;
 288 } ge_pyobj;
 289
 290 extern PyTypeObject *ge_pytype;
 291 #define GE_PYCHECK(o) PyObject_TypeCheck((o), ge_pytype)
 292 #define GE_X(o) (((ge_pyobj *)(o))->x)
 293 #define GE_G(o) (((ge_pyobj *)(o))->g)
 294 #define GE_GOBJ(o) ((PyObject *)(group_pyobj *)(o)->ob_type)
 295 extern PyObject *ge_pywrap(PyObject *, ge *);
 296
 297 typedef struct group_pyobj {
 298   PyHeapTypeObject ty;
 299   group *g;
 300 } group_pyobj;
 301
 302 extern PyTypeObject *group_pytype;
 303 #define GROUP_G(o) (((group_pyobj *)(o))->g)
 304 extern PyObject *group_pywrap(group *);
 305 extern group *group_copy(group *);
 306
 307 /*----- Random number generators ------------------------------------------*/
 308
 309 #define f_freeme 1u
 310
 311 typedef struct grand_pyobj {
 312   PyObject_HEAD
 313   unsigned f;
 314   grand *r;
 315 } grand_pyobj;
 316
 317 extern PyTypeObject *grand_pytype;
 318 extern PyObject *rand_pyobj;
 319 #define GRAND_PYCHECK(o) PyObject_TypeCheck((o), grand_pytype)
 320 #define GRAND_F(o) (((grand_pyobj *)(o))->f)
 321 #define GRAND_R(o) (((grand_pyobj *)(o))->r)
 322 extern PyObject *grand_pywrap(grand *, unsigned);
 323 extern int convgrand(PyObject *, void *);
 324
 325 /*----- Symmetric cryptography --------------------------------------------*/
 326
 327 extern PyObject *keysz_pywrap(const octet *);
 328
 329 extern int convgccipher(PyObject *, void *);
 330 extern PyObject *gccipher_pywrap(gccipher *);
 331
 332 typedef struct gchash_pyobj {
 333   PyHeapTypeObject ty;
 334   gchash *ch;
 335 } gchash_pyobj;
 336
 337 extern PyTypeObject *gchash_pytype;
 338 extern PyObject *sha_pyobj, *has160_pyobj;
 339 #define GCHASH_PYCHECK(o) PyObject_TypeCheck((o), gchash_pytype)
 340 #define GCHASH_CH(o) (((gchash_pyobj *)(o))->ch)
 341 extern PyObject *ghash_pywrap(PyObject *, ghash *);
 342 extern int convgchash(PyObject *, void *);
 343 extern int convghash(PyObject *, void *);
 344
 345 extern int convgcmac(PyObject *, void *);
 346
 347 /*----- Key generation ----------------------------------------------------*/
 348
 349 typedef struct pfilt_pyobj {
 350   PyObject_HEAD
 351   pfilt f;
 352   int st;
 353 } pfilt_pyobj;
 354
 355 extern PyTypeObject *pfilt_pytype;
 356 #define PFILT_PYCHECK(o) PyObject_TypeCheck(o, pfilt_pytype)
 357 #define PFILT_F(o) (&((pfilt_pyobj *)(o))->f)
 358 #define PFILT_ST(o) (((pfilt_pyobj *)(o))->st)
 359
 360 typedef struct { pgen_proc *proc; void *ctx; } pgev;
 361 #define PGEV_HEAD PyObject_HEAD pgev pg;
 362
 363 typedef struct pgev_pyobj {
 364   PGEV_HEAD
 365 } pgev_pyobj;
 366
 367 extern PyTypeObject *pgev_pytype;
 368 #define PGEV_PYCHECK(o) PyObject_TypeCheck(o, pgev_pytype)
 369 #define PGEV_PG(o) (&((pgev_pyobj *)(o))->pg)
 370
 371 typedef struct pypgev {
 372   pgev ev;
 373   PyObject *obj;
 374   struct excinfo *exc;
 375 } pypgev;
 376
 377 extern int convpgev(PyObject *, void *);
 378 extern void droppgev(pypgev *);
 379 extern void pgenerr(struct excinfo *exc);
 380
 381 /*----- That's all, folks -------------------------------------------------*/
 382
 383 #ifdef __cplusplus
 384   }
 385 #endif
 386
 387 #endif