blob: 641b7d6fd0966dac7f49465dd0c0be9df2a560f8 [file] [log] [blame]
Dmitry Kasatkin5ce3e312011-08-31 14:05:16 +03001/* mpi.h - Multi Precision Integers
2 * Copyright (C) 1994, 1996, 1998, 1999,
3 * 2000, 2001 Free Software Foundation, Inc.
4 *
5 * This file is part of GNUPG.
6 *
7 * GNUPG is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * GNUPG is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20 *
21 * Note: This code is heavily based on the GNU MP Library.
22 * Actually it's the same code with only minor changes in the
23 * way the data is stored; this is to support the abstraction
24 * of an optional secure memory allocation which may be used
25 * to avoid revealing of sensitive data due to paging etc.
26 * The GNU MP Library itself is published under the LGPL;
27 * however I decided to publish this code under the plain GPL.
28 */
29
30#ifndef G10_MPI_H
31#define G10_MPI_H
32
33#include <linux/types.h>
34
35/* DSI defines */
36
37#define SHA1_DIGEST_LENGTH 20
38
39/*end of DSI defines */
40
41#define BYTES_PER_MPI_LIMB (BITS_PER_LONG / 8)
42#define BITS_PER_MPI_LIMB BITS_PER_LONG
43
44typedef unsigned long int mpi_limb_t;
45typedef signed long int mpi_limb_signed_t;
46
47struct gcry_mpi {
48 int alloced; /* array size (# of allocated limbs) */
49 int nlimbs; /* number of valid limbs */
50 int nbits; /* the real number of valid bits (info only) */
51 int sign; /* indicates a negative number */
52 unsigned flags; /* bit 0: array must be allocated in secure memory space */
53 /* bit 1: not used */
54 /* bit 2: the limb is a pointer to some m_alloced data */
55 mpi_limb_t *d; /* array with the limbs */
56};
57
58typedef struct gcry_mpi *MPI;
59
Dmitry Kasatkin5ce3e312011-08-31 14:05:16 +030060#define mpi_get_nlimbs(a) ((a)->nlimbs)
61#define mpi_is_neg(a) ((a)->sign)
62
63/*-- mpiutil.c --*/
64MPI mpi_alloc(unsigned nlimbs);
65MPI mpi_alloc_secure(unsigned nlimbs);
66MPI mpi_alloc_like(MPI a);
67void mpi_free(MPI a);
68int mpi_resize(MPI a, unsigned nlimbs);
69int mpi_copy(MPI *copy, const MPI a);
70void mpi_clear(MPI a);
71int mpi_set(MPI w, MPI u);
72int mpi_set_ui(MPI w, ulong u);
73MPI mpi_alloc_set_ui(unsigned long u);
74void mpi_m_check(MPI a);
75void mpi_swap(MPI a, MPI b);
76
77/*-- mpicoder.c --*/
78MPI do_encode_md(const void *sha_buffer, unsigned nbits);
David Howellse1045992012-09-24 17:11:27 +010079MPI mpi_read_raw_data(const void *xbuffer, size_t nbytes);
Dmitry Kasatkin5ce3e312011-08-31 14:05:16 +030080MPI mpi_read_from_buffer(const void *buffer, unsigned *ret_nread);
81int mpi_fromstr(MPI val, const char *str);
82u32 mpi_get_keyid(MPI a, u32 *keyid);
83void *mpi_get_buffer(MPI a, unsigned *nbytes, int *sign);
Tadeusz Strukd37e2962015-06-15 13:18:36 -070084int mpi_read_buffer(MPI a, uint8_t *buf, unsigned buf_len, unsigned *nbytes,
85 int *sign);
Dmitry Kasatkin5ce3e312011-08-31 14:05:16 +030086void *mpi_get_secure_buffer(MPI a, unsigned *nbytes, int *sign);
87int mpi_set_buffer(MPI a, const void *buffer, unsigned nbytes, int sign);
88
89#define log_mpidump g10_log_mpidump
90
91/*-- mpi-add.c --*/
92int mpi_add_ui(MPI w, MPI u, ulong v);
93int mpi_add(MPI w, MPI u, MPI v);
94int mpi_addm(MPI w, MPI u, MPI v, MPI m);
95int mpi_sub_ui(MPI w, MPI u, ulong v);
96int mpi_sub(MPI w, MPI u, MPI v);
97int mpi_subm(MPI w, MPI u, MPI v, MPI m);
98
99/*-- mpi-mul.c --*/
100int mpi_mul_ui(MPI w, MPI u, ulong v);
101int mpi_mul_2exp(MPI w, MPI u, ulong cnt);
102int mpi_mul(MPI w, MPI u, MPI v);
103int mpi_mulm(MPI w, MPI u, MPI v, MPI m);
104
105/*-- mpi-div.c --*/
106ulong mpi_fdiv_r_ui(MPI rem, MPI dividend, ulong divisor);
107int mpi_fdiv_r(MPI rem, MPI dividend, MPI divisor);
108int mpi_fdiv_q(MPI quot, MPI dividend, MPI divisor);
109int mpi_fdiv_qr(MPI quot, MPI rem, MPI dividend, MPI divisor);
110int mpi_tdiv_r(MPI rem, MPI num, MPI den);
111int mpi_tdiv_qr(MPI quot, MPI rem, MPI num, MPI den);
112int mpi_tdiv_q_2exp(MPI w, MPI u, unsigned count);
113int mpi_divisible_ui(const MPI dividend, ulong divisor);
114
115/*-- mpi-gcd.c --*/
116int mpi_gcd(MPI g, const MPI a, const MPI b);
117
118/*-- mpi-pow.c --*/
119int mpi_pow(MPI w, MPI u, MPI v);
120int mpi_powm(MPI res, MPI base, MPI exp, MPI mod);
121
122/*-- mpi-mpow.c --*/
123int mpi_mulpowm(MPI res, MPI *basearray, MPI *exparray, MPI mod);
124
125/*-- mpi-cmp.c --*/
126int mpi_cmp_ui(MPI u, ulong v);
127int mpi_cmp(MPI u, MPI v);
128
129/*-- mpi-scan.c --*/
130int mpi_getbyte(MPI a, unsigned idx);
131void mpi_putbyte(MPI a, unsigned idx, int value);
132unsigned mpi_trailing_zeros(MPI a);
133
134/*-- mpi-bit.c --*/
135void mpi_normalize(MPI a);
136unsigned mpi_get_nbits(MPI a);
137int mpi_test_bit(MPI a, unsigned n);
138int mpi_set_bit(MPI a, unsigned n);
139int mpi_set_highbit(MPI a, unsigned n);
140void mpi_clear_highbit(MPI a, unsigned n);
141void mpi_clear_bit(MPI a, unsigned n);
142int mpi_rshift(MPI x, MPI a, unsigned n);
143
144/*-- mpi-inv.c --*/
145int mpi_invm(MPI x, MPI u, MPI v);
146
Tadeusz Strukd37e2962015-06-15 13:18:36 -0700147/* inline functions */
148
149/**
150 * mpi_get_size() - returns max size required to store the number
151 *
152 * @a: A multi precision integer for which we want to allocate a bufer
153 *
154 * Return: size required to store the number
155 */
156static inline unsigned int mpi_get_size(MPI a)
157{
158 return a->nlimbs * BYTES_PER_MPI_LIMB;
159}
Dmitry Kasatkin5ce3e312011-08-31 14:05:16 +0300160#endif /*G10_MPI_H */