X-Git-Url: https://git.distorted.org.uk/u/mdw/catacomb/blobdiff_plain/0f5ec153dcb1c20a765d0420cc189ebac1b9682d..ab9168949ec2762698d6293adf17b637f30b891e:/rabin.h

diff --git a/rabin.h b/rabin.h
index ed08aeb..a491625 100644
--- a/rabin.h
+++ b/rabin.h
@@ -1,13 +1,13 @@
 /* -*-c-*-
  *
- * $Id: rabin.h,v 1.1 1999/11/19 13:17:57 mdw Exp $
+ * $Id$
  *
  * Miller-Rabin primality test
  *
  * (c) 1999 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of Catacomb.
  *
@@ -15,28 +15,20 @@
  * it under the terms of the GNU Library General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
- * 
+ *
  * Catacomb 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 Library General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Library General Public
  * License along with Catacomb; if not, write to the Free
  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: rabin.h,v $
- * Revision 1.1  1999/11/19 13:17:57  mdw
- * Prime number generator and tester.
- *
- */
-
-#ifndef RABIN_H
-#define RABIN_H
+#ifndef CATACOMB_RABIN_H
+#define CATACOMB_RABIN_H
 
 #ifdef __cplusplus
   extern "C" {
@@ -44,16 +36,16 @@
 
 /*----- Header files ------------------------------------------------------*/
 
-#ifndef MP_H
+#ifndef CATACOMB_MP_H
 #  include "mp.h"
 #endif
 
-#ifndef MPMONT_H
+#ifndef CATACOMB_MPMONT_H
 #  include "mpmont.h"
 #endif
 
-#ifndef PGEN_H
-#  include "pgen.h"
+#ifndef CATACOMB_PFILT_H
+#  include "pfilt.h"
 #endif
 
 /*----- Data structures ---------------------------------------------------*/
@@ -62,7 +54,7 @@ typedef struct rabin {
   mpmont mm;				/* Montgomery arithmetic context */
   size_t s;				/* %$m = 2^s r + 1$% */
   mp *r;				/* %$m = 2^s r + 1$% */
-  mp *m1;				/* %$(m - 1)R \bmod m */
+  mp *m1;				/* %$(m - 1)R \bmod m$% */
 } rabin;
 
 /*----- Functions provided ------------------------------------------------*/
@@ -72,13 +64,13 @@ typedef struct rabin {
  * Arguments:	@rabin *r@ = pointer to Rabin-Miller context
  *		@mp *m@ = pointer to number to test
  *
- * Returns:	---
+ * Returns:	Zero on success, nonzero for failure.
  *
  * Use:		Precomputes some useful values for performing the
  *		Miller-Rabin probabilistic primality test.
  */
 
-extern void rabin_create(rabin */*r*/, mp */*m*/);
+extern int rabin_create(rabin */*r*/, mp */*m*/);
 
 /* --- @rabin_destroy@ --- *
  *
@@ -92,20 +84,34 @@ extern void rabin_create(rabin */*r*/, mp */*m*/);
 
 extern void rabin_destroy(rabin */*r*/);
 
-/* --- @rabin_test@ --- *
+/* --- @rabin_test@, @rabin_rtest@ --- *
  *
  * Arguments:	@rabin *r@ = pointer to Rabin-Miller context
  *		@mp *g@ = base to test the number against
  *
- * Returns:	Either @PGEN_COMPOSITE@ if the test failed, or @PGEN_MAYBE@
+ * Returns:	Either @PGEN_FAIL@ if the test failed, or @PGEN_PASS@
  *		if it succeeded.
  *
  * Use:		Performs a single iteration of the Rabin-Miller primality
- *		test.
+ *		test.  The @rtest@ variant assumes that %$g$% is either
+ *		already in Montgomery representation, or you don't care.
  */
 
+extern int rabin_rtest(rabin */*r*/, mp */*g*/);
 extern int rabin_test(rabin */*r*/, mp */*g*/);
 
+/* --- @rabin_iters@ --- *
+ *
+ * Arguments:	@unsigned len@ = number of bits in value
+ *
+ * Returns:	Number of iterations recommended.
+ *
+ * Use:		Returns the recommended number of iterations to ensure that a
+ *		number with @len@ bits is really prime.
+ */
+
+extern int rabin_iters(unsigned /*len*/);
+
 /*----- That's all, folks -------------------------------------------------*/
 
 #ifdef __cplusplus