Initial revision
[silc.git] / lib / silcmath / modinv.c
1 /*
2
3   modinv.h
4
5   Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
6
7   Copyright (C) 1997 - 2000 Pekka Riikonen
8
9   This program is free software; you can redistribute it and/or modify
10   it under the terms of the GNU General Public License as published by
11   the Free Software Foundation; either version 2 of the License, or
12   (at your option) any later version.
13   
14   This program is distributed in the hope that it will be useful,
15   but WITHOUT ANY WARRANTY; without even the implied warranty of
16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   GNU General Public License for more details.
18
19 */
20
21 #include "silcincludes.h"
22
23 /* Table for finding multiplicative inverse */
24 typedef struct {
25   SilcInt x;
26 } ModInv;
27
28 #define plus1   (i == 2 ? 0 : i + 1)
29 #define minus1  (i == 0 ? 2 : i - 1)
30
31 /* Find multiplicative inverse using Euclid's extended algorithm. 
32    Computes inverse such that a * inv mod n = 1, where 0 < a < n. 
33    Algorithm goes like this:
34    
35    g(0) = n    v(0) = 0
36    g(1) = a    v(1) = 1
37    
38    y = g(i-1) / g(i)
39    g(i+1) = g(i-1) - y * g(i) = g(i)-1 mod g(i)
40    v(i+1) = v(i-1) - y * v(i)
41    
42    do until g(i) = 0, then inverse = v(i-1). If inverse is negative then n, 
43    is added to inverse making it positive again. (Sometimes the algorithm 
44    has a variable u defined too and it behaves just like v, except that 
45    initalize values are swapped (i.e. u(0) = 1, u(1) = 0). However, u is 
46    not needed by the algorithm so it does not have to be included.)
47 */
48
49 void silc_mp_modinv(SilcInt *inv, SilcInt *a, SilcInt *n)
50 {
51   int i;
52   SilcInt y;
53   SilcInt x;
54   
55   ModInv g[3];
56   ModInv v[3];
57   
58   /* init MP vars */
59   silc_mp_init(&y);
60   silc_mp_init(&x);
61   silc_mp_init_set_ui(&v[0].x, 0L);             /* v(0) = 0 */
62   silc_mp_init_set_ui(&v[1].x, 1L);             /* v(1) = 1 */
63   silc_mp_init(&v[2].x);
64   silc_mp_init_set(&g[0].x, n);                 /* g(0) = n */
65   silc_mp_init_set(&g[1].x, a);                 /* g(1) = a */
66   silc_mp_init(&g[2].x);
67   
68   i = 1;
69   while(silc_mp_cmp_ui(&g[i].x, 0) != 0) {
70     silc_mp_div(&y, &g[minus1].x, &g[i].x);     /* y = n / a */
71     silc_mp_mod(&g[plus1].x, &g[minus1].x, &g[i].x); /* remainder */
72     silc_mp_mul(&x, &y, &v[i].x);
73     silc_mp_set(&v[plus1].x, &v[minus1].x);
74     silc_mp_sub(&v[plus1].x, &v[plus1].x, &x);
75     i = plus1;
76   }
77   
78   /* set the inverse */
79   silc_mp_set(inv, &v[minus1].x);
80   
81   /* if inverse is negative, add n to inverse */
82   if (silc_mp_cmp_ui(inv, 0) < 0)
83     silc_mp_add(inv, inv, n);
84   
85   /* clear the vars */
86   memset(&g, 0, sizeof(g));
87   memset(&v, 0, sizeof(v));
88   silc_mp_clear(&y);
89   silc_mp_clear(&x);
90   silc_mp_clear(&g[0].x);
91   silc_mp_clear(&g[1].x);
92   silc_mp_clear(&g[2].x);
93   silc_mp_clear(&v[0].x);
94   silc_mp_clear(&v[1].x);
95   silc_mp_clear(&v[2].x);
96 }