Debian Codegraph @

upstream/debian-unstable/man3/BN_mod_mul_reciprocal.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "BN_MOD_MUL_RECIPROCAL 3SSL"
58 .TH BN_MOD_MUL_RECIPROCAL 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 BN_mod_mul_reciprocal, BN_div_recp, BN_RECP_CTX_new,
65 BN_RECP_CTX_free, BN_RECP_CTX_set \- modular multiplication using
66 reciprocal
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/bn.h>
71 \&
72 \& BN_RECP_CTX *BN_RECP_CTX_new(void);
73 \& void BN_RECP_CTX_free(BN_RECP_CTX *recp);
74 \&
75 \& int BN_RECP_CTX_set(BN_RECP_CTX *recp, const BIGNUM *m, BN_CTX *ctx);
76 \&
77 \& int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *a, BN_RECP_CTX *recp,
78 \& BN_CTX *ctx);
79 \&
80 \& int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *a, const BIGNUM *b,
81 \& BN_RECP_CTX *recp, BN_CTX *ctx);
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 \&\fBBN_mod_mul_reciprocal()\fR can be used to perform an efficient
86 \&\fBBN_mod_mul\fR\|(3) operation when the operation will be performed
87 repeatedly with the same modulus. It computes \fBr\fR=(\fBa\fR*\fBb\fR)%\fBm\fR
88 using \fBrecp\fR=1/\fBm\fR, which is set as described below. \fBctx\fR is a
89 previously allocated \fBBN_CTX\fR used for temporary variables.
90 .PP
91 \&\fBBN_RECP_CTX_new()\fR allocates and initializes a \fBBN_RECP\fR structure.
92 .PP
93 \&\fBBN_RECP_CTX_free()\fR frees the components of the \fBBN_RECP\fR, and, if it
94 was created by \fBBN_RECP_CTX_new()\fR, also the structure itself.
95 If \fBrecp\fR is NULL, nothing is done.
96 .PP
97 \&\fBBN_RECP_CTX_set()\fR stores \fBm\fR in \fBrecp\fR and sets it up for computing
98 1/\fBm\fR and shifting it left by BN_num_bits(\fBm\fR)+1 to make it an
99 integer. The result and the number of bits it was shifted left will
100 later be stored in \fBrecp\fR.
101 .PP
102 \&\fBBN_div_recp()\fR divides \fBa\fR by \fBm\fR using \fBrecp\fR. It places the quotient
103 in \fBdv\fR and the remainder in \fBrem\fR.
104 .PP
105 The \fBBN_RECP_CTX\fR structure cannot be shared between threads.
106 .SH "RETURN VALUES"
107 .IX Header "RETURN VALUES"
108 \&\fBBN_RECP_CTX_new()\fR returns the newly allocated \fBBN_RECP_CTX\fR, and NULL
109 on error.
110 .PP
111 \&\fBBN_RECP_CTX_free()\fR has no return value.
112 .PP
113 For the other functions, 1 is returned for success, 0 on error.
114 The error codes can be obtained by \fBERR_get_error\fR\|(3).
115 .SH "SEE ALSO"
116 .IX Header "SEE ALSO"
117 \&\fBERR_get_error\fR\|(3), \fBBN_add\fR\|(3),
118 \&\fBBN_CTX_new\fR\|(3)
119 .SH HISTORY
120 .IX Header "HISTORY"
121 \&\fBBN_RECP_CTX_init()\fR was removed in OpenSSL 1.1.0
122 .SH COPYRIGHT
123 .IX Header "COPYRIGHT"
124 Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
125 .PP
126 Licensed under the Apache License 2.0 (the "License"). You may not use
127 this file except in compliance with the License. You can obtain a copy
128 in the file LICENSE in the source distribution or at
129 <https://www.openssl.org/source/license.html>.