Debian Codegraph @

upstream/debian-unstable/man3/BN_mod_inverse.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_INVERSE 3SSL"
58 .TH BN_MOD_INVERSE 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_inverse \- compute inverse modulo n
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/bn.h>
69 \&
70 \& BIGNUM *BN_mod_inverse(BIGNUM *r, BIGNUM *a, const BIGNUM *n,
71 \& BN_CTX *ctx);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\fBBN_mod_inverse()\fR computes the inverse of \fBa\fR modulo \fBn\fR
76 places the result in \fBr\fR (\f(CW\*(C`(a*r)%n==1\*(C'\fR). If \fBr\fR is NULL,
77 a new \fBBIGNUM\fR is created.
78 .PP
79 \&\fBctx\fR is a previously allocated \fBBN_CTX\fR used for temporary
80 variables. \fBr\fR may be the same \fBBIGNUM\fR as \fBa\fR.
81 .SH NOTES
82 .IX Header "NOTES"
83 It is an error to use the same \fBBIGNUM\fR as \fBn\fR.
84 .SH "RETURN VALUES"
85 .IX Header "RETURN VALUES"
86 \&\fBBN_mod_inverse()\fR returns the \fBBIGNUM\fR containing the inverse, and
87 NULL on error. The error codes can be obtained by \fBERR_get_error\fR\|(3).
88 .SH "SEE ALSO"
89 .IX Header "SEE ALSO"
90 \&\fBERR_get_error\fR\|(3), \fBBN_add\fR\|(3)
91 .SH COPYRIGHT
92 .IX Header "COPYRIGHT"
93 Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
94 .PP
95 Licensed under the Apache License 2.0 (the "License"). You may not use
96 this file except in compliance with the License. You can obtain a copy
97 in the file LICENSE in the source distribution or at
98 <https://www.openssl.org/source/license.html>.