3 * $Id: rabin.h,v 1.5 2000/07/09 21:32:16 mdw Exp $
5 * Miller-Rabin primality test
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.5 2000/07/09 21:32:16 mdw
34 * rabin_test: Correct error in comment.
36 * Revision 1.4 2000/06/17 11:52:48 mdw
39 * Revision 1.3 1999/12/22 15:50:29 mdw
40 * Reworking for new prime-search system. Add function for working out how
41 * many iterations to use for a particular number.
43 * Revision 1.2 1999/12/10 23:29:48 mdw
44 * Change header file guard names.
46 * Revision 1.1 1999/11/19 13:17:57 mdw
47 * Prime number generator and tester.
51 #ifndef CATACOMB_RABIN_H
52 #define CATACOMB_RABIN_H
58 /*----- Header files ------------------------------------------------------*/
64 #ifndef CATACOMB_MPMONT_H
68 #ifndef CATACOMB_PFILT_H
72 /*----- Data structures ---------------------------------------------------*/
74 typedef struct rabin
{
75 mpmont mm
; /* Montgomery arithmetic context */
76 size_t s
; /* %$m = 2^s r + 1$% */
77 mp
*r
; /* %$m = 2^s r + 1$% */
78 mp
*m1
; /* %$(m - 1)R \bmod m$% */
81 /*----- Functions provided ------------------------------------------------*/
83 /* --- @rabin_create@ --- *
85 * Arguments: @rabin *r@ = pointer to Rabin-Miller context
86 * @mp *m@ = pointer to number to test
90 * Use: Precomputes some useful values for performing the
91 * Miller-Rabin probabilistic primality test.
94 extern void rabin_create(rabin */
*r*/
, mp */
*m*/
);
96 /* --- @rabin_destroy@ --- *
98 * Arguments: @rabin *r@ = pointer to Rabin-Miller context
102 * Use: Disposes of a Rabin-Miller context when it's no longer
106 extern void rabin_destroy(rabin */
*r*/
);
108 /* --- @rabin_test@ --- *
110 * Arguments: @rabin *r@ = pointer to Rabin-Miller context
111 * @mp *g@ = base to test the number against
113 * Returns: Either @PGEN_FAIL@ if the test failed, or @PGEN_PASS@
116 * Use: Performs a single iteration of the Rabin-Miller primality
120 extern int rabin_test(rabin */
*r*/
, mp */
*g*/
);
122 /* --- @rabin_iters@ --- *
124 * Arguments: @unsigned len@ = number of bits in value
126 * Returns: Number of iterations recommended.
128 * Use: Returns the recommended number of iterations to ensure that a
129 * number with @len@ bits is really prime.
132 extern int rabin_iters(unsigned /*len*/);
134 /*----- That's all, folks -------------------------------------------------*/