Debian Codegraph @

upstream/debian-unstable/man3/RSA_blinding_on.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 "RSA_BLINDING_ON 3SSL"
58 .TH RSA_BLINDING_ON 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 RSA_blinding_on, RSA_blinding_off \- protect the RSA operation from timing attacks
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/rsa.h>
69 .Ve
70 .PP
71 The following functions have been deprecated since OpenSSL 3.0, and can be
72 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
73 see \fBopenssl_user_macros\fR\|(7):
74 .PP
75 .Vb 1
76 \& int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
77 \&
78 \& void RSA_blinding_off(RSA *rsa);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 All of the functions described on this page are deprecated.
83 .PP
84 RSA is vulnerable to timing attacks. In a setup where attackers can
85 measure the time of RSA decryption or signature operations, blinding
86 must be used to protect the RSA operation from that attack.
87 .PP
88 \&\fBRSA_blinding_on()\fR turns blinding on for key \fBrsa\fR and generates a
89 random blinding factor. \fBctx\fR is \fBNULL\fR or a preallocated and
90 initialized \fBBN_CTX\fR.
91 .PP
92 \&\fBRSA_blinding_off()\fR turns blinding off and frees the memory used for
93 the blinding factor.
94 .SH "RETURN VALUES"
95 .IX Header "RETURN VALUES"
96 \&\fBRSA_blinding_on()\fR returns 1 on success, and 0 if an error occurred.
97 .PP
98 \&\fBRSA_blinding_off()\fR returns no value.
99 .SH HISTORY
100 .IX Header "HISTORY"
101 All of these functions were deprecated in OpenSSL 3.0.
102 .SH COPYRIGHT
103 .IX Header "COPYRIGHT"
104 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
105 .PP
106 Licensed under the Apache License 2.0 (the "License"). You may not use
107 this file except in compliance with the License. You can obtain a copy
108 in the file LICENSE in the source distribution or at
109 <https://www.openssl.org/source/license.html>.