bn.pod 7.3 KB
Newer Older
1 2 3 4
=pod

=head1 NAME

U
Ulf Möller 已提交
5
bn - multiprecision integer arithmetics
6 7 8 9 10 11

=head1 SYNOPSIS

 #include <openssl/bn.h>

 BIGNUM *BN_new(void);
U
Ulf Möller 已提交
12 13 14 15 16
 void BN_free(BIGNUM *a);
 void BN_clear(BIGNUM *a);
 void BN_clear_free(BIGNUM *a);

 BN_CTX *BN_CTX_new(void);
R
Rich Salz 已提交
17
 BN_CTX *BN_CTX_secure_new(void);
U
Ulf Möller 已提交
18 19
 void BN_CTX_free(BN_CTX *c);

20 21
 BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
 BIGNUM *BN_dup(const BIGNUM *a);
U
Ulf Möller 已提交
22

B
Bodo Möller 已提交
23 24
 BIGNUM *BN_swap(BIGNUM *a, BIGNUM *b);

U
Ulf Möller 已提交
25 26 27 28
 int BN_num_bytes(const BIGNUM *a);
 int BN_num_bits(const BIGNUM *a);
 int BN_num_bits_word(BN_ULONG w);

29 30 31
 void BN_set_negative(BIGNUM *a, int n);
 int  BN_is_negative(const BIGNUM *a);

B
Bodo Möller 已提交
32
 int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
U
Ulf Möller 已提交
33 34
 int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
 int BN_mul(BIGNUM *r, BIGNUM *a, BIGNUM *b, BN_CTX *ctx);
B
Bodo Möller 已提交
35
 int BN_sqr(BIGNUM *r, BIGNUM *a, BN_CTX *ctx);
U
Ulf Möller 已提交
36 37 38
 int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *a, const BIGNUM *d,
         BN_CTX *ctx);
 int BN_mod(BIGNUM *rem, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
B
Bodo Möller 已提交
39 40 41 42 43
 int BN_nnmod(BIGNUM *rem, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
 int BN_mod_add(BIGNUM *ret, BIGNUM *a, BIGNUM *b, const BIGNUM *m,
         BN_CTX *ctx);
 int BN_mod_sub(BIGNUM *ret, BIGNUM *a, BIGNUM *b, const BIGNUM *m,
         BN_CTX *ctx);
U
Ulf Möller 已提交
44 45
 int BN_mod_mul(BIGNUM *ret, BIGNUM *a, BIGNUM *b, const BIGNUM *m,
         BN_CTX *ctx);
B
Bodo Möller 已提交
46
 int BN_mod_sqr(BIGNUM *ret, BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
U
Ulf Möller 已提交
47 48 49 50 51 52 53 54 55
 int BN_exp(BIGNUM *r, BIGNUM *a, BIGNUM *p, BN_CTX *ctx);
 int BN_mod_exp(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
         const BIGNUM *m, BN_CTX *ctx);
 int BN_gcd(BIGNUM *r, BIGNUM *a, BIGNUM *b, BN_CTX *ctx);

 int BN_add_word(BIGNUM *a, BN_ULONG w);
 int BN_sub_word(BIGNUM *a, BN_ULONG w);
 int BN_mul_word(BIGNUM *a, BN_ULONG w);
 BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
B
Bodo Möller 已提交
56
 BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
U
Ulf Möller 已提交
57 58 59 60 61 62 63 64 65 66

 int BN_cmp(BIGNUM *a, BIGNUM *b);
 int BN_ucmp(BIGNUM *a, BIGNUM *b);
 int BN_is_zero(BIGNUM *a);
 int BN_is_one(BIGNUM *a);
 int BN_is_word(BIGNUM *a, BN_ULONG w);
 int BN_is_odd(BIGNUM *a);

 int BN_zero(BIGNUM *a);
 int BN_one(BIGNUM *a);
B
Bodo Möller 已提交
67
 const BIGNUM *BN_value_one(void);
U
Ulf Möller 已提交
68 69 70
 int BN_set_word(BIGNUM *a, unsigned long w);
 unsigned long BN_get_word(BIGNUM *a);

U
Ulf Möller 已提交
71 72
 int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
 int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
B
Bodo Möller 已提交
73
 int BN_rand_range(BIGNUM *rnd, BIGNUM *range);
74
 int BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range);
U
Ulf Möller 已提交
75

76 77 78 79 80 81 82 83 84 85 86 87 88 89
 int BN_generate_prime_ex(BIGNUM *ret,int bits,int safe, const BIGNUM *add,
     const BIGNUM *rem, BN_GENCB *cb);

 int BN_is_prime_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, BN_GENCB *cb);

 int BN_is_prime_fasttest_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx,
     int do_trial_division, BN_GENCB *cb);

 int BN_GENCB_call(BN_GENCB *cb, int a, int b);
 BN_GENCB *BN_GENCB_new(void);
 void BN_GENCB_free(BN_GENCB *cb);
 void BN_GENCB_set_old(BN_GENCB *gencb, void (*callback)(int, int, void *), void *cb_arg);
 void BN_GENCB_set(BN_GENCB *gencb, int (*callback)(int, int, BN_GENCB *), void *cb_arg);
 void *BN_GENCB_get_arg(BN_GENCB *cb);
U
Ulf Möller 已提交
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106

 int BN_set_bit(BIGNUM *a, int n);
 int BN_clear_bit(BIGNUM *a, int n);
 int BN_is_bit_set(const BIGNUM *a, int n);
 int BN_mask_bits(BIGNUM *a, int n);
 int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
 int BN_lshift1(BIGNUM *r, BIGNUM *a);
 int BN_rshift(BIGNUM *r, BIGNUM *a, int n);
 int BN_rshift1(BIGNUM *r, BIGNUM *a);

 int BN_bn2bin(const BIGNUM *a, unsigned char *to);
 BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
 char *BN_bn2hex(const BIGNUM *a);
 char *BN_bn2dec(const BIGNUM *a);
 int BN_hex2bn(BIGNUM **a, const char *str);
 int BN_dec2bn(BIGNUM **a, const char *str);
 int BN_print(BIO *fp, const BIGNUM *a);
U
Ulf Möller 已提交
107
 int BN_print_fp(FILE *fp, const BIGNUM *a);
U
Ulf Möller 已提交
108 109 110 111 112 113 114 115 116 117 118 119 120
 int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
 BIGNUM *BN_mpi2bn(unsigned char *s, int len, BIGNUM *ret);

 BIGNUM *BN_mod_inverse(BIGNUM *r, BIGNUM *a, const BIGNUM *n,
     BN_CTX *ctx);

 BN_RECP_CTX *BN_RECP_CTX_new(void);
 void BN_RECP_CTX_free(BN_RECP_CTX *recp);
 int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *m, BN_CTX *ctx);
 int BN_mod_mul_reciprocal(BIGNUM *r, BIGNUM *a, BIGNUM *b,
        BN_RECP_CTX *recp, BN_CTX *ctx);

 BN_MONT_CTX *BN_MONT_CTX_new(void);
121
 void BN_MONT_CTX_free(BN_MONT_CTX *mont);
U
Ulf Möller 已提交
122 123 124 125 126 127 128 129 130
 int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *m, BN_CTX *ctx);
 BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
 int BN_mod_mul_montgomery(BIGNUM *r, BIGNUM *a, BIGNUM *b,
         BN_MONT_CTX *mont, BN_CTX *ctx);
 int BN_from_montgomery(BIGNUM *r, BIGNUM *a, BN_MONT_CTX *mont,
         BN_CTX *ctx);
 int BN_to_montgomery(BIGNUM *r, BIGNUM *a, BN_MONT_CTX *mont,
         BN_CTX *ctx);

N
Nils Larsch 已提交
131 132 133 134 135 136 137 138 139 140
 BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai,
	BIGNUM *mod);
 void BN_BLINDING_free(BN_BLINDING *b);
 int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
 int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
 int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
 int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b,
	BN_CTX *ctx);
 int BN_BLINDING_invert_ex(BIGNUM *n,const BIGNUM *r,BN_BLINDING *b,
	BN_CTX *ctx);
141 142
 unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *);
 void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long);
N
Nils Larsch 已提交
143 144 145 146 147 148 149
 unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
 void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
 BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
	const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
	int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
			  const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
	BN_MONT_CTX *m_ctx);
150 151 152

=head1 DESCRIPTION

U
Ulf Möller 已提交
153 154 155 156 157 158 159 160 161 162 163 164 165
This library performs arithmetic operations on integers of arbitrary
size. It was written for use in public key cryptography, such as RSA
and Diffie-Hellman.

It uses dynamic memory allocation for storing its data structures.
That means that there is no limit on the size of the numbers
manipulated by these functions, but return values must always be
checked in case a memory allocation error has occurred.

The basic object in this library is a B<BIGNUM>. It is used to hold a
single large integer. This type should be considered opaque and fields
should not be modified or accessed directly.

R
Rich Salz 已提交
166 167 168 169 170 171 172
The creation of B<BIGNUM> objects is described in L<BN_new(3)>;
L<BN_add(3)> describes most of the arithmetic operations.
Comparison is described in L<BN_cmp(3)>; L<BN_zero(3)>
describes certain assignments, L<BN_rand(3)> the generation of
random numbers, L<BN_generate_prime(3)> deals with prime
numbers and L<BN_set_bit(3)> with bit operations. The conversion
of B<BIGNUM>s to external formats is described in L<BN_bn2bin(3)>.
U
Ulf Möller 已提交
173

174 175
=head1 SEE ALSO

R
Rich Salz 已提交
176 177 178 179 180 181 182 183 184 185 186
L<bn_internal(3)>,
L<dh(3)>, L<err(3)>, L<rand(3)>, L<rsa(3)>,
L<BN_new(3)>, L<BN_CTX_new(3)>,
L<BN_copy(3)>, L<BN_swap(3)>, L<BN_num_bytes(3)>,
L<BN_add(3)>, L<BN_add_word(3)>,
L<BN_cmp(3)>, L<BN_zero(3)>, L<BN_rand(3)>,
L<BN_generate_prime(3)>, L<BN_set_bit(3)>,
L<BN_bn2bin(3)>, L<BN_mod_inverse(3)>,
L<BN_mod_mul_reciprocal(3)>,
L<BN_mod_mul_montgomery(3)>,
L<BN_BLINDING_new(3)>
187 188

=cut
R
Rich Salz 已提交
189 190 191 192 193 194 195 196 197 198 199

=head1 COPYRIGHT

Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut