-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
Standard preamble:
========================================================================
..
.... \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================
Title "BN_add 3"
way too many mistakes in technical documents.
\fBBN_sub() subtracts b from a and places the result in r (\*(C`r=a-b\*(C'). \fIr may be the same BIGNUM as a or b.
\fBBN_mul() multiplies a and b and places the result in r (\*(C`r=a*b\*(C'). \fIr may be the same BIGNUM as a or b. For multiplication by powers of 2, use BN_lshift\|(3).
\fBBN_sqr() takes the square of a and places the result in r (\*(C`r=a^2\*(C'). r and a may be the same BIGNUM. This function is faster than BN_mul(r,a,a).
\fBBN_div() divides a by d and places the result in dv and the remainder in rem (\*(C`dv=a/d, rem=a%d\*(C'). Either of dv and rem may be NULL, in which case the respective value is not returned. The result is rounded towards zero; thus if a is negative, the remainder will be zero or negative. For division by powers of 2, use BN_rshift\|(3).
\fBBN_mod() corresponds to BN_div() with dv set to NULL.
\fBBN_nnmod() reduces a modulo m and places the nonnegative remainder in r.
\fBBN_mod_add() adds a to b modulo m and places the nonnegative result in r.
\fBBN_mod_sub() subtracts b from a modulo m and places the nonnegative result in r.
\fBBN_mod_mul() multiplies a by b and finds the nonnegative remainder respective to modulus m (\*(C`r=(a*b) mod m\*(C'). r may be the same BIGNUM as a or b. For more efficient algorithms for repeated computations using the same modulus, see \fBBN_mod_mul_montgomery\|(3) and \fBBN_mod_mul_reciprocal\|(3).
\fBBN_mod_sqr() takes the square of a modulo m and places the result in r.
\fBBN_mod_sqrt() returns the modular square root of a such that \f(CW\*(C`in^2 = a (mod p)\*(C'. The modulus p must be a prime, otherwise an error or an incorrect "result" will be returned. The result is stored into in which can be NULL. The result will be newly allocated in that case.
\fBBN_exp() raises a to the p-th power and places the result in r (\*(C`r=a^p\*(C'). This function is faster than repeated applications of \fBBN_mul().
\fBBN_mod_exp() computes a to the p-th power modulo m (\*(C`r=a^p % m\*(C'). This function uses less time and space than BN_exp(). Do not call this function when m is even and any of the parameters have the \fBBN_FLG_CONSTTIME flag set.
\fBBN_gcd() computes the greatest common divisor of a and b and places the result in r. r may be the same BIGNUM as a or \fIb.
For all functions, ctx is a previously allocated BN_CTX used for temporary variables; see BN_CTX_new\|(3).
Unless noted otherwise, the result BIGNUM must be different from the arguments.
For all remaining functions, 1 is returned for success, 0 on error. The return value should always be checked (e.g., \*(C`if (!BN_add(r,a,b)) goto err;\*(C'). The error codes can be obtained by ERR_get_error\|(3).
Licensed under the Apache License 2.0 (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 <https://www.openssl.org/source/license.html>.