3 * $Id: rabin.h,v 1.7 2004/04/08 01:36:15 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 #ifndef CATACOMB_RABIN_H
31 #define CATACOMB_RABIN_H
37 /*----- Header files ------------------------------------------------------*/
43 #ifndef CATACOMB_MPMONT_H
47 #ifndef CATACOMB_PFILT_H
51 /*----- Data structures ---------------------------------------------------*/
53 typedef struct rabin
{
54 mpmont mm
; /* Montgomery arithmetic context */
55 size_t s
; /* %$m = 2^s r + 1$% */
56 mp
*r
; /* %$m = 2^s r + 1$% */
57 mp
*m1
; /* %$(m - 1)R \bmod m$% */
60 /*----- Functions provided ------------------------------------------------*/
62 /* --- @rabin_create@ --- *
64 * Arguments: @rabin *r@ = pointer to Rabin-Miller context
65 * @mp *m@ = pointer to number to test
69 * Use: Precomputes some useful values for performing the
70 * Miller-Rabin probabilistic primality test.
73 extern void rabin_create(rabin */
*r*/
, mp */
*m*/
);
75 /* --- @rabin_destroy@ --- *
77 * Arguments: @rabin *r@ = pointer to Rabin-Miller context
81 * Use: Disposes of a Rabin-Miller context when it's no longer
85 extern void rabin_destroy(rabin */
*r*/
);
87 /* --- @rabin_test@, @rabin_rtest@ --- *
89 * Arguments: @rabin *r@ = pointer to Rabin-Miller context
90 * @mp *g@ = base to test the number against
92 * Returns: Either @PGEN_FAIL@ if the test failed, or @PGEN_PASS@
95 * Use: Performs a single iteration of the Rabin-Miller primality
96 * test. The @rtest@ variant assumes that %$g$% is either
97 * already in Montgomery representation, or you don't care.
100 extern int rabin_rtest(rabin */
*r*/
, mp */
*g*/
);
101 extern int rabin_test(rabin */
*r*/
, mp */
*g*/
);
103 /* --- @rabin_iters@ --- *
105 * Arguments: @unsigned len@ = number of bits in value
107 * Returns: Number of iterations recommended.
109 * Use: Returns the recommended number of iterations to ensure that a
110 * number with @len@ bits is really prime.
113 extern int rabin_iters(unsigned /*len*/);
115 /*----- That's all, folks -------------------------------------------------*/