Debian Codegraph @

upstream/debian-unstable/man3/BN_mod_mul_montgomery.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_MONTGOMERY 3SSL"
58 .TH BN_MOD_MUL_MONTGOMERY 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_montgomery, BN_MONT_CTX_new,
65 BN_MONT_CTX_free, BN_MONT_CTX_set, BN_MONT_CTX_copy,
66 BN_from_montgomery, BN_to_montgomery \- Montgomery multiplication
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/bn.h>
71 \&
72 \& BN_MONT_CTX *BN_MONT_CTX_new(void);
73 \& void BN_MONT_CTX_free(BN_MONT_CTX *mont);
74 \&
75 \& int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *m, BN_CTX *ctx);
76 \& BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
77 \&
78 \& int BN_mod_mul_montgomery(BIGNUM *r, BIGNUM *a, BIGNUM *b,
79 \& BN_MONT_CTX *mont, BN_CTX *ctx);
80 \&
81 \& int BN_from_montgomery(BIGNUM *r, BIGNUM *a, BN_MONT_CTX *mont,
82 \& BN_CTX *ctx);
83 \&
84 \& int BN_to_montgomery(BIGNUM *r, BIGNUM *a, BN_MONT_CTX *mont,
85 \& BN_CTX *ctx);
86 .Ve
87 .SH DESCRIPTION
88 .IX Header "DESCRIPTION"
89 These functions implement Montgomery multiplication. They are used
90 automatically when \fBBN_mod_exp\fR\|(3) is called with suitable input,
91 but they may be useful when several operations are to be performed
92 using the same modulus.
93 .PP
94 \&\fBBN_MONT_CTX_new()\fR allocates and initializes a \fBBN_MONT_CTX\fR structure.
95 .PP
96 \&\fBBN_MONT_CTX_set()\fR sets up the \fImont\fR structure from the modulus \fIm\fR
97 by precomputing its inverse and a value R.
98 .PP
99 \&\fBBN_MONT_CTX_copy()\fR copies the \fBBN_MONT_CTX\fR \fIfrom\fR to \fIto\fR.
100 .PP
101 \&\fBBN_MONT_CTX_free()\fR frees the components of the \fBBN_MONT_CTX\fR, and, if
102 it was created by \fBBN_MONT_CTX_new()\fR, also the structure itself.
103 If \fBmont\fR is NULL, nothing is done.
104 .PP
105 \&\fBBN_mod_mul_montgomery()\fR computes Mont(\fIa\fR,\fIb\fR):=\fIa\fR*\fIb\fR*R^\-1 and places
106 the result in \fIr\fR.
107 .PP
108 \&\fBBN_from_montgomery()\fR performs the Montgomery reduction \fIr\fR = \fIa\fR*R^\-1.
109 .PP
110 \&\fBBN_to_montgomery()\fR computes Mont(\fIa\fR,R^2), i.e. \fIa\fR*R.
111 Note that \fIa\fR must be nonnegative and smaller than the modulus.
112 .PP
113 For all functions, \fIctx\fR is a previously allocated \fBBN_CTX\fR used for
114 temporary variables.
115 .SH "RETURN VALUES"
116 .IX Header "RETURN VALUES"
117 \&\fBBN_MONT_CTX_new()\fR returns the newly allocated \fBBN_MONT_CTX\fR, and NULL
118 on error.
119 .PP
120 \&\fBBN_MONT_CTX_free()\fR has no return value.
121 .PP
122 For the other functions, 1 is returned for success, 0 on error.
123 The error codes can be obtained by \fBERR_get_error\fR\|(3).
124 .SH WARNINGS
125 .IX Header "WARNINGS"
126 The inputs must be reduced modulo \fBm\fR, otherwise the result will be
127 outside the expected range.
128 .SH "SEE ALSO"
129 .IX Header "SEE ALSO"
130 \&\fBERR_get_error\fR\|(3), \fBBN_add\fR\|(3),
131 \&\fBBN_CTX_new\fR\|(3)
132 .SH HISTORY
133 .IX Header "HISTORY"
134 \&\fBBN_MONT_CTX_init()\fR was removed in OpenSSL 1.1.0
135 .SH COPYRIGHT
136 .IX Header "COPYRIGHT"
137 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
138 .PP
139 Licensed under the Apache License 2.0 (the "License"). You may not use
140 this file except in compliance with the License. You can obtain a copy
141 in the file LICENSE in the source distribution or at
142 <https://www.openssl.org/source/license.html>.