Update files for OpenSSL-1.0.0e import.
[dragonfly.git] / secure / lib / libcrypto / man / bn.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.14)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "bn 3"
127 .TH bn 3 "2011-09-06" "1.0.0e" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 bn \- multiprecision integer arithmetics
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 1
137 \& #include <openssl/bn.h>
138 \&
139 \& BIGNUM *BN_new(void);
140 \& void BN_free(BIGNUM *a);
141 \& void BN_init(BIGNUM *);
142 \& void BN_clear(BIGNUM *a);
143 \& void BN_clear_free(BIGNUM *a);
144 \&
145 \& BN_CTX *BN_CTX_new(void);
146 \& void BN_CTX_init(BN_CTX *c);
147 \& void BN_CTX_free(BN_CTX *c);
148 \&
149 \& BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b);
150 \& BIGNUM *BN_dup(const BIGNUM *a);
151 \&
152 \& BIGNUM *BN_swap(BIGNUM *a, BIGNUM *b);
153 \&
154 \& int BN_num_bytes(const BIGNUM *a);
155 \& int BN_num_bits(const BIGNUM *a);
156 \& int BN_num_bits_word(BN_ULONG w);
157 \&
158 \& void BN_set_negative(BIGNUM *a, int n);
159 \& int  BN_is_negative(const BIGNUM *a);
160 \&
161 \& int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
162 \& int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b);
163 \& int BN_mul(BIGNUM *r, BIGNUM *a, BIGNUM *b, BN_CTX *ctx);
164 \& int BN_sqr(BIGNUM *r, BIGNUM *a, BN_CTX *ctx);
165 \& int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *a, const BIGNUM *d,
166 \&         BN_CTX *ctx);
167 \& int BN_mod(BIGNUM *rem, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
168 \& int BN_nnmod(BIGNUM *rem, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
169 \& int BN_mod_add(BIGNUM *ret, BIGNUM *a, BIGNUM *b, const BIGNUM *m,
170 \&         BN_CTX *ctx);
171 \& int BN_mod_sub(BIGNUM *ret, BIGNUM *a, BIGNUM *b, const BIGNUM *m,
172 \&         BN_CTX *ctx);
173 \& int BN_mod_mul(BIGNUM *ret, BIGNUM *a, BIGNUM *b, const BIGNUM *m,
174 \&         BN_CTX *ctx);
175 \& int BN_mod_sqr(BIGNUM *ret, BIGNUM *a, const BIGNUM *m, BN_CTX *ctx);
176 \& int BN_exp(BIGNUM *r, BIGNUM *a, BIGNUM *p, BN_CTX *ctx);
177 \& int BN_mod_exp(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
178 \&         const BIGNUM *m, BN_CTX *ctx);
179 \& int BN_gcd(BIGNUM *r, BIGNUM *a, BIGNUM *b, BN_CTX *ctx);
180 \&
181 \& int BN_add_word(BIGNUM *a, BN_ULONG w);
182 \& int BN_sub_word(BIGNUM *a, BN_ULONG w);
183 \& int BN_mul_word(BIGNUM *a, BN_ULONG w);
184 \& BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);
185 \& BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);
186 \&
187 \& int BN_cmp(BIGNUM *a, BIGNUM *b);
188 \& int BN_ucmp(BIGNUM *a, BIGNUM *b);
189 \& int BN_is_zero(BIGNUM *a);
190 \& int BN_is_one(BIGNUM *a);
191 \& int BN_is_word(BIGNUM *a, BN_ULONG w);
192 \& int BN_is_odd(BIGNUM *a);
193 \&
194 \& int BN_zero(BIGNUM *a);
195 \& int BN_one(BIGNUM *a);
196 \& const BIGNUM *BN_value_one(void);
197 \& int BN_set_word(BIGNUM *a, unsigned long w);
198 \& unsigned long BN_get_word(BIGNUM *a);
199 \&
200 \& int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
201 \& int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
202 \& int BN_rand_range(BIGNUM *rnd, BIGNUM *range);
203 \& int BN_pseudo_rand_range(BIGNUM *rnd, BIGNUM *range);
204 \&
205 \& BIGNUM *BN_generate_prime(BIGNUM *ret, int bits,int safe, BIGNUM *add,
206 \&         BIGNUM *rem, void (*callback)(int, int, void *), void *cb_arg);
207 \& int BN_is_prime(const BIGNUM *p, int nchecks,
208 \&         void (*callback)(int, int, void *), BN_CTX *ctx, void *cb_arg);
209 \&
210 \& int BN_set_bit(BIGNUM *a, int n);
211 \& int BN_clear_bit(BIGNUM *a, int n);
212 \& int BN_is_bit_set(const BIGNUM *a, int n);
213 \& int BN_mask_bits(BIGNUM *a, int n);
214 \& int BN_lshift(BIGNUM *r, const BIGNUM *a, int n);
215 \& int BN_lshift1(BIGNUM *r, BIGNUM *a);
216 \& int BN_rshift(BIGNUM *r, BIGNUM *a, int n);
217 \& int BN_rshift1(BIGNUM *r, BIGNUM *a);
218 \&
219 \& int BN_bn2bin(const BIGNUM *a, unsigned char *to);
220 \& BIGNUM *BN_bin2bn(const unsigned char *s, int len, BIGNUM *ret);
221 \& char *BN_bn2hex(const BIGNUM *a);
222 \& char *BN_bn2dec(const BIGNUM *a);
223 \& int BN_hex2bn(BIGNUM **a, const char *str);
224 \& int BN_dec2bn(BIGNUM **a, const char *str);
225 \& int BN_print(BIO *fp, const BIGNUM *a);
226 \& int BN_print_fp(FILE *fp, const BIGNUM *a);
227 \& int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
228 \& BIGNUM *BN_mpi2bn(unsigned char *s, int len, BIGNUM *ret);
229 \&
230 \& BIGNUM *BN_mod_inverse(BIGNUM *r, BIGNUM *a, const BIGNUM *n,
231 \&     BN_CTX *ctx);
232 \&
233 \& BN_RECP_CTX *BN_RECP_CTX_new(void);
234 \& void BN_RECP_CTX_init(BN_RECP_CTX *recp);
235 \& void BN_RECP_CTX_free(BN_RECP_CTX *recp);
236 \& int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *m, BN_CTX *ctx);
237 \& int BN_mod_mul_reciprocal(BIGNUM *r, BIGNUM *a, BIGNUM *b,
238 \&        BN_RECP_CTX *recp, BN_CTX *ctx);
239 \&
240 \& BN_MONT_CTX *BN_MONT_CTX_new(void);
241 \& void BN_MONT_CTX_init(BN_MONT_CTX *ctx);
242 \& void BN_MONT_CTX_free(BN_MONT_CTX *mont);
243 \& int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *m, BN_CTX *ctx);
244 \& BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
245 \& int BN_mod_mul_montgomery(BIGNUM *r, BIGNUM *a, BIGNUM *b,
246 \&         BN_MONT_CTX *mont, BN_CTX *ctx);
247 \& int BN_from_montgomery(BIGNUM *r, BIGNUM *a, BN_MONT_CTX *mont,
248 \&         BN_CTX *ctx);
249 \& int BN_to_montgomery(BIGNUM *r, BIGNUM *a, BN_MONT_CTX *mont,
250 \&         BN_CTX *ctx);
251 \&
252 \& BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai,
253 \&        BIGNUM *mod);
254 \& void BN_BLINDING_free(BN_BLINDING *b);
255 \& int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
256 \& int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
257 \& int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
258 \& int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b,
259 \&        BN_CTX *ctx);
260 \& int BN_BLINDING_invert_ex(BIGNUM *n,const BIGNUM *r,BN_BLINDING *b,
261 \&        BN_CTX *ctx);
262 \& unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *);
263 \& void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long);
264 \& unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
265 \& void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
266 \& BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
267 \&        const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
268 \&        int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
269 \&                          const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
270 \&        BN_MONT_CTX *m_ctx);
271 .Ve
272 .SH "DESCRIPTION"
273 .IX Header "DESCRIPTION"
274 This library performs arithmetic operations on integers of arbitrary
275 size. It was written for use in public key cryptography, such as \s-1RSA\s0
276 and Diffie-Hellman.
277 .PP
278 It uses dynamic memory allocation for storing its data structures.
279 That means that there is no limit on the size of the numbers
280 manipulated by these functions, but return values must always be
281 checked in case a memory allocation error has occurred.
282 .PP
283 The basic object in this library is a \fB\s-1BIGNUM\s0\fR. It is used to hold a
284 single large integer. This type should be considered opaque and fields
285 should not be modified or accessed directly.
286 .PP
287 The creation of \fB\s-1BIGNUM\s0\fR objects is described in \fIBN_new\fR\|(3);
288 \&\fIBN_add\fR\|(3) describes most of the arithmetic operations.
289 Comparison is described in \fIBN_cmp\fR\|(3); \fIBN_zero\fR\|(3)
290 describes certain assignments, \fIBN_rand\fR\|(3) the generation of
291 random numbers, \fIBN_generate_prime\fR\|(3) deals with prime
292 numbers and \fIBN_set_bit\fR\|(3) with bit operations. The conversion
293 of \fB\s-1BIGNUM\s0\fRs to external formats is described in \fIBN_bn2bin\fR\|(3).
294 .SH "SEE ALSO"
295 .IX Header "SEE ALSO"
296 \&\fIbn_internal\fR\|(3),
297 \&\fIdh\fR\|(3), \fIerr\fR\|(3), \fIrand\fR\|(3), \fIrsa\fR\|(3),
298 \&\fIBN_new\fR\|(3), \fIBN_CTX_new\fR\|(3),
299 \&\fIBN_copy\fR\|(3), \fIBN_swap\fR\|(3), \fIBN_num_bytes\fR\|(3),
300 \&\fIBN_add\fR\|(3), \fIBN_add_word\fR\|(3),
301 \&\fIBN_cmp\fR\|(3), \fIBN_zero\fR\|(3), \fIBN_rand\fR\|(3),
302 \&\fIBN_generate_prime\fR\|(3), \fIBN_set_bit\fR\|(3),
303 \&\fIBN_bn2bin\fR\|(3), \fIBN_mod_inverse\fR\|(3),
304 \&\fIBN_mod_mul_reciprocal\fR\|(3),
305 \&\fIBN_mod_mul_montgomery\fR\|(3),
306 \&\fIBN_BLINDING_new\fR\|(3)