X-Git-Url: https://git.distorted.org.uk/~mdw/catacomb-python/blobdiff_plain/8900d271da338c38ee55ee700b3420fb48fcd032..ef783f91d10008e1859fc52de1fb66a5cd292320:/rand.c

diff --git a/rand.c b/rand.c
index 1203f76..12ba834 100644
--- a/rand.c
+++ b/rand.c
@@ -27,14 +27,17 @@
 /*----- Header files ------------------------------------------------------*/
 
 #include "catacomb-python.h"
+PUBLIC_SYMBOLS;
 #include "algorithms.h"
+PRIVATE_SYMBOLS;
 
 /*----- Main code ---------------------------------------------------------*/
 
-PyTypeObject *grand_pytype, *truerand_pytype;
-PyTypeObject *lcrand_pytype, *fibrand_pytype;
-PyTypeObject *dsarand_pytype, *bbs_pytype, *bbspriv_pytype;
-PyTypeObject *sslprf_pytype, *tlsdx_pytype, *tlsprf_pytype;
+PyTypeObject *grand_pytype;
+static PyTypeObject *truerand_pytype;
+static PyTypeObject *lcrand_pytype, *fibrand_pytype;
+static PyTypeObject *dsarand_pytype, *bbs_pytype, *bbspriv_pytype;
+static PyTypeObject *sslprf_pytype, *tlsdx_pytype, *tlsprf_pytype;
 PyObject *rand_pyobj;
 
 static PyObject *gccrands_dict;
@@ -54,14 +57,14 @@ PyObject *grand_pywrap(grand *r, unsigned f)
   PyTypeObject *ty = grand_pytype;
   PyObject *ob;
 
-  if (strcmp(r->ops->name, "rand") == 0) ty = truerand_pytype;
-  else if (strcmp(r->ops->name, "lcrand") == 0) ty = lcrand_pytype;
-  else if (strcmp(r->ops->name, "fibrand") == 0) ty = fibrand_pytype;
-  else if (strcmp(r->ops->name, "dsarand") == 0) ty = dsarand_pytype;
-  else if (strcmp(r->ops->name, "bbs") == 0) ty = bbs_pytype;
-  else if (strcmp(r->ops->name, "sslprf") == 0) ty = sslprf_pytype;
-  else if (strcmp(r->ops->name, "tlsdx") == 0) ty = tlsdx_pytype;
-  else if (strcmp(r->ops->name, "tlsprf") == 0) ty = tlsprf_pytype;
+  if (STRCMP(r->ops->name, ==, "rand")) ty = truerand_pytype;
+  else if (STRCMP(r->ops->name, ==, "lcrand")) ty = lcrand_pytype;
+  else if (STRCMP(r->ops->name, ==, "fibrand")) ty = fibrand_pytype;
+  else if (STRCMP(r->ops->name, ==, "dsarand")) ty = dsarand_pytype;
+  else if (STRCMP(r->ops->name, ==, "bbs")) ty = bbs_pytype;
+  else if (STRCMP(r->ops->name, ==, "sslprf")) ty = sslprf_pytype;
+  else if (STRCMP(r->ops->name, ==, "tlsdx")) ty = tlsdx_pytype;
+  else if (STRCMP(r->ops->name, ==, "tlsprf")) ty = tlsprf_pytype;
   else if ((ob = PyDict_GetItemString(gccrands_dict, r->ops->name)) != 0)
     ty = (PyTypeObject *)ob;
   return (grand_dopywrap(ty, r, f));
@@ -124,9 +127,9 @@ static PyObject *grmeth_mp(PyObject *me, PyObject *arg, PyObject *kw)
 {
   size_t l;
   mpw o = 0;
-  char *kwlist[] = { "bits", "or", 0 };
+  static const char *const kwlist[] = { "bits", "or", 0 };
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "O&|O&:mp", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "O&|O&:mp", KWLIST,
 				   convszt, &l, convmpw, &o))
     goto end;
   if (grand_check(me)) return (0);
@@ -214,10 +217,10 @@ end:
 
 static PyObject *grmeth_seedrand(PyObject *me, PyObject *arg, PyObject *kw)
 {
-  char *kwlist[] = { "rng", 0 };
+  static const char *const kwlist[] = { "rng", 0 };
   grand *r = GRAND_R(me);
   grand *rr = &rand_global;
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:seedrand", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:seedrand", KWLIST,
 				   convgrand, &rr) ||
       grand_check(me) || checkop(r, GRAND_SEEDRAND, "seedrand"))
     goto end;
@@ -306,7 +309,7 @@ static PyTypeObject grand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Generic random number source.",
+  "Generic random number source.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -332,8 +335,8 @@ static PyTypeObject grand_pytype_skel = {
 static PyObject *lcrand_pynew(PyTypeObject *me, PyObject *arg, PyObject *kw)
 {
   uint32 n = 0;
-  char *kwlist[] = { "seed", 0 };
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:new", kwlist, convu32, &n))
+  static const char *const kwlist[] = { "seed", 0 };
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:new", KWLIST, convu32, &n))
     return (0);
   return (grand_dopywrap(lcrand_pytype, lcrand_create(n), f_freeme));
 }
@@ -363,7 +366,7 @@ static PyTypeObject lcrand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Linear congruential generator.",
+  "LCRand([seed = 0]): linear congruential generator.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -389,8 +392,8 @@ static PyTypeObject lcrand_pytype_skel = {
 static PyObject *fibrand_pynew(PyTypeObject *me, PyObject *arg, PyObject *kw)
 {
   uint32 n = 0;
-  char *kwlist[] = { "seed", 0 };
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:new", kwlist, convu32, &n))
+  static const char *const kwlist[] = { "seed", 0 };
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&:new", KWLIST, convu32, &n))
     return (0);
   return (grand_dopywrap(fibrand_pytype, fibrand_create(n), f_freeme));
 }
@@ -420,7 +423,7 @@ static PyTypeObject fibrand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Fibonacci generator.",
+  "FibRand([seed = 0]): Fibonacci generator.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -503,10 +506,10 @@ static PyObject *trmeth_timer(PyObject *me, PyObject *arg)
 static PyObject *truerand_pynew(PyTypeObject *ty,
 				PyObject *arg, PyObject *kw)
 {
-  char *kwlist[] = { 0 };
+  static const char *const kwlist[] = { 0 };
   grand *r;
   PyObject *rc = 0;
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, ":new", kwlist)) goto end;
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, ":new", KWLIST)) goto end;
   r = rand_create();
   r->ops->misc(r, RAND_NOISESRC, &noise_source);
   r->ops->misc(r, RAND_SEED, 160);
@@ -565,7 +568,7 @@ static PyTypeObject truerand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"True random number source.",
+  "TrueRand(): true random number source.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -639,11 +642,11 @@ static const gccrand_info *const gcrandtab[] = {
 static PyObject *gcrand_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
 {
   const gccrand_info *info = GCCRAND_INFO(ty);
-  static char *kwlist[] = { "key", 0 };
+  static const char *const kwlist[] = { "key", 0 };
   char *k;
   Py_ssize_t n;
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#:new", kwlist, &k, &n))
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#:new", KWLIST, &k, &n))
     goto end;
   if (keysz(n, info->keysz) != n) VALERR("bad key length");
   return (grand_dopywrap(ty, info->func(k, n), f_freeme));
@@ -655,11 +658,11 @@ static PyObject *gcirand_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
 {
   const gccrand_info *info = GCCRAND_INFO(ty);
   uint32 i = 0;
-  static char *kwlist[] = { "key", "i", 0 };
+  static const char *const kwlist[] = { "key", "i", 0 };
   char *k;
   Py_ssize_t n;
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#O&:new", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#O&:new", KWLIST,
 				   &k, &n, convu32, &i))
     goto end;
   if (keysz(n, info->keysz) != n) VALERR("bad key length");
@@ -673,11 +676,11 @@ end:
 static PyObject *gcnrand_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
 {
   const gccrand_info *info = GCCRAND_INFO(ty);
-  static char *kwlist[] = { "key", "nonce", 0 };
+  static const char *const kwlist[] = { "key", "nonce", 0 };
   char *k, *n;
   Py_ssize_t ksz, nsz;
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#s#:new", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#s#:new", KWLIST,
 				   &k, &ksz, &n, &nsz))
     goto end;
   if (keysz(ksz, info->keysz) != ksz) VALERR("bad key length");
@@ -693,15 +696,18 @@ static PyObject *gcshakyrand_pynew(PyTypeObject *ty,
 				   PyObject *arg, PyObject *kw)
 {
   const gccrand_info *info = GCCRAND_INFO(ty);
-  static char *kwlist_shake[] = { "key", "func", "perso", 0 };
-  static char *kwlist_func[] = { "key", "perso", 0 };
+  static const char
+    *const kwlist_shake[] = { "key", "func", "perso", 0 },
+    *const kwlist_func[] = { "key", "perso", 0 };
   char *k, *f = 0, *p = 0;
   Py_ssize_t ksz, fsz = 0, psz = 0;
 
   if ((info->f&RNGF_MASK) == RNG_SHAKE
-	? !PyArg_ParseTupleAndKeywords(arg, kw, "s#|s#s#:new", kwlist_shake,
+	? !PyArg_ParseTupleAndKeywords(arg, kw, "s#|s#s#:new",
+				       (/*unconst*/ char **)kwlist_shake,
 				       &k, &ksz, &f, &fsz, &p, &psz)
-	: !PyArg_ParseTupleAndKeywords(arg, kw, "s#|s#:new", kwlist_func,
+	: !PyArg_ParseTupleAndKeywords(arg, kw, "s#|s#:new",
+				       (/*unconst*/ char **)kwlist_func,
 				       &k, &ksz, &p, &psz))
     goto end;
   if (keysz(ksz, info->keysz) != ksz) VALERR("bad key length");
@@ -772,8 +778,8 @@ static PyObject *gclrmeth_seek(PyObject *me, PyObject *arg)
 
 static PyGetSetDef gccrand_pygetset[] = {
 #define GETSETNAME(op, name) gccr##op##_##name
-  GET	(keysz,			"CR.keysz -> acceptable key sizes")
-  GET	(name,			"CR.name -> name of this kind of generator")
+  GET	(keysz,		"CR.keysz -> acceptable key sizes")
+  GET	(name,		"CR.name -> name of this kind of generator")
 #undef GETSETNAME
   { 0 }
 };
@@ -811,7 +817,7 @@ static PyTypeObject gccrand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Metaclass for symmetric crypto-based generators.",
+  "Metaclass for symmetric crypto-based generators.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -859,7 +865,7 @@ static PyTypeObject gcrand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Abstract base class for symmetric crypto-based generators.",
+  "Abstract base class for symmetric crypto-based generators.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -907,7 +913,7 @@ static PyTypeObject gclatinrand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Abstract base class for symmetric crypto-based generators.",
+  "Abstract base class for symmetric crypto-based generators.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -938,9 +944,9 @@ static PyObject *sslprf_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
   int ksz, ssz;
   const gchash *hco = &md5, *hci = &sha;
   PyObject *rc = 0;
-  char *kwlist[] = { "key", "seed", "ohash", "ihash", 0 };
+  static const char *const kwlist[] = { "key", "seed", "ohash", "ihash", 0 };
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#s#|O&O&:new", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#s#|O&O&:new", KWLIST,
 				   &k, &ksz, &s, &ssz,
 				   convgchash, &hco, convgchash, &hci))
     goto end;
@@ -955,9 +961,9 @@ static PyObject *tlsdx_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
   int ksz, ssz;
   const gcmac *mc = &sha_hmac;
   PyObject *rc = 0;
-  char *kwlist[] = { "key", "seed", "mac", 0 };
+  static const char *const kwlist[] = { "key", "seed", "mac", 0 };
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#s#|O&:new", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#s#|O&:new", KWLIST,
 				   &k, &ksz, &s, &ssz,
 				   convgcmac, &mc))
     goto end;
@@ -972,9 +978,9 @@ static PyObject *tlsprf_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
   int ksz, ssz;
   const gcmac *mcl = &md5_hmac, *mcr = &sha_hmac;
   PyObject *rc = 0;
-  char *kwlist[] = { "key", "seed", "lmac", "rmac", 0 };
+  static const char *const kwlist[] = { "key", "seed", "lmac", "rmac", 0 };
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#s#|O&O&:new", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#s#|O&O&:new", KWLIST,
 				   &k, &ksz, &s, &ssz,
 				   convgcmac, &mcl, convgcmac, &mcr))
     goto end;
@@ -1008,7 +1014,8 @@ static PyTypeObject sslprf_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Random number generator for SSL master secret.",
+  "SSLRand(KEY, SEED, [ohash = md5], [ihash = sha]):\n"
+  "  RNG for SSL master secret.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -1056,7 +1063,8 @@ static PyTypeObject tlsdx_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"TLS data expansion function.",
+  "TLSDataExpansion(KEY, SEED, [mac = sha_hmac]):\n"
+  "  TLS data expansion function.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -1104,7 +1112,8 @@ static PyTypeObject tlsprf_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"TLS pseudorandom function.",
+  "TLSPRF(KEY, SEED, [lmac = md5_hmac], [rmac = sha_hmac]):\n"
+  "  TLS pseudorandom function.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -1134,9 +1143,9 @@ static PyObject *dsarand_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
   char *p;
   int sz;
   PyObject *rc = 0;
-  char *kwlist[] = { "seed", 0 };
+  static const char *const kwlist[] = { "seed", 0 };
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#:new", kwlist, &p, &sz))
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "s#:new", KWLIST, &p, &sz))
     goto end;
   rc = grand_dopywrap(ty, dsarand_create(p, sz), f_freeme);
 end:
@@ -1184,7 +1193,7 @@ static PyTypeObject dsarand_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Pseudorandom number generator for constructing DSA parameters.",
+  "DSARand(SEED): pseudorandom number generator for DSA parameters.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -1213,9 +1222,9 @@ static PyObject *bbs_pynew(PyTypeObject *ty, PyObject *arg, PyObject *kw)
 {
   mp *n = 0, *x = MP_TWO;
   PyObject *rc = 0;
-  char *kwlist[] = { "n", "x", 0 };
+  static const char *const kwlist[] = { "n", "x", 0 };
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "O&|O&:new", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "O&|O&:new", KWLIST,
 				   convmp, &n, convmp, &x))
     goto end;
   rc = grand_dopywrap(ty, bbs_rand(n, x), f_freeme);
@@ -1262,7 +1271,8 @@ static PyObject *bbsget_x(PyObject *me, void *hunoz)
 static int bbsset_x(PyObject *me, PyObject *val, void *hunoz)
 {
   mp *x = 0; grand *r = GRAND_R(me); int rc = -1; if (!val) NIERR("__del__");
-  if ((x = getmp(val)) == 0) goto end; r->ops->misc(r, BBS_SET, x); rc = 0;
+  if ((x = getmp(val)) == 0) goto end;
+  r->ops->misc(r, BBS_SET, x); rc = 0;
   end: mp_drop(x); return (rc);
 }
 
@@ -1274,9 +1284,9 @@ static PyObject *bbsget_stepsz(PyObject *me, void *hunoz)
 
 static PyMethodDef bbs_pymethods[] = {
 #define METHNAME(name) bbsmeth_##name
-  METH	(step,	"R.step(): steps the generator (not useful)")
-  METH	(bits,	"R.bits(N) -> W: returns N bits (<= 32) from the generator")
-  METH	(wrap,	"R.wrap(): flushes unused bits in internal buffer")
+  METH	(step,		"R.step(): steps the generator (not useful)")
+  METH	(bits,	 "R.bits(N) -> W: returns N bits (<= 32) from the generator")
+  METH	(wrap,		"R.wrap(): flushes unused bits in internal buffer")
 #undef METHNAME
   { 0 }
 };
@@ -1315,7 +1325,7 @@ static PyTypeObject bbs_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Blum-Blum-Shub strong pseudorandom number generator.",
+  "BlumBlumShub(N, [x = 2]): Blum-Blum-Shub pseudorandom number generator.",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -1350,9 +1360,9 @@ static PyObject *bbspriv_pynew(PyTypeObject *ty,
 {
   mp *p = 0, *q = 0, *n = 0, *x = MP_TWO;
   bbspriv_pyobj *rc = 0;
-  char *kwlist[] = { "n", "p", "q", "seed", 0 };
+  static const char *const kwlist[] = { "n", "p", "q", "seed", 0 };
 
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&O&O&O&:new", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "|O&O&O&O&:new", KWLIST,
 				   convmp, &n, convmp, &p, convmp, &q,
 				   convmp, &x))
     goto end;
@@ -1380,11 +1390,12 @@ static PyObject *meth__BBSPriv_generate(PyObject *me,
   pypgev evt = { { 0 } };
   unsigned nbits, n = 0;
   grand *r = &rand_global;
-  char *kwlist[] = { "class", "nbits", "event", "rng", "nsteps", "seed", 0 };
+  static const char *const kwlist[] =
+    { "class", "nbits", "event", "rng", "nsteps", "seed", 0 };
   bbspriv_pyobj *rc = 0;
 
   evt.exc = &exc;
-  if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO&|O&O&O&O&:generate", kwlist,
+  if (!PyArg_ParseTupleAndKeywords(arg, kw, "OO&|O&O&O&O&:generate", KWLIST,
 				   &me, convuint, &nbits, convpgev, &evt,
 				   convgrand, &r, convuint, &n, convmp, &x))
     goto end;
@@ -1435,8 +1446,8 @@ static PyObject *bpget_q(PyObject *me, void *hunoz)
 
 static PyMethodDef bbspriv_pymethods[] = {
 #define METHNAME(name) bpmeth_##name
-  METH	(ff,			"R.ff(N): fast-forward N places")
-  METH	(rew,			"R.rew(N): rewind N places")
+  METH	(ff,		"R.ff(N): fast-forward N places")
+  METH	(rew,		"R.rew(N): rewind N places")
 #undef METHNAME
   { 0 }
 };
@@ -1475,7 +1486,8 @@ static PyTypeObject bbspriv_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"Blum-Blum-Shub strong pseudorandom generator, with private key.",
+  "BBSPriv(..., [seed = 2]): Blum-Blum-Shub, with private key.\n"
+  "  Keywords: n, p, q; must provide at least two",
 
   0,					/* @tp_traverse@ */
   0,					/* @tp_clear@ */
@@ -1502,9 +1514,8 @@ static PyTypeObject bbspriv_pytype_skel = {
 
 static PyMethodDef methods[] = {
 #define METHNAME(name) meth_##name
-  KWMETH(_BBSPriv_generate,		"\
-generate(NBITS, [event = pgen_nullev], [rng = rand],\n\
-	 [nsteps = 0], [seed = 2]) -> R")
+  KWMETH(_BBSPriv_generate, "generate(NBITS, [event = pgen_nullev], "
+			      "[rng = rand], [nsteps = 0], [seed = 2]) -> R")
 #undef METHNAME
   { 0 }
 };