In documentation, consistently refer to OpenSSL 3.0
[openssl.git] / doc / man3 / RSA_blinding_on.pod
1 =pod
2
3 =head1 NAME
4
5 RSA_blinding_on, RSA_blinding_off - protect the RSA operation from timing attacks
6
7 =head1 SYNOPSIS
8
9  #include <openssl/rsa.h>
10
11  int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
12
13  void RSA_blinding_off(RSA *rsa);
14
15 =head1 DESCRIPTION
16
17 RSA is vulnerable to timing attacks. In a setup where attackers can
18 measure the time of RSA decryption or signature operations, blinding
19 must be used to protect the RSA operation from that attack.
20
21 RSA_blinding_on() turns blinding on for key B<rsa> and generates a
22 random blinding factor. B<ctx> is B<NULL> or a pre-allocated and
23 initialized B<BN_CTX>.
24
25 RSA_blinding_off() turns blinding off and frees the memory used for
26 the blinding factor.
27
28 =head1 RETURN VALUES
29
30 RSA_blinding_on() returns 1 on success, and 0 if an error occurred.
31
32 RSA_blinding_off() returns no value.
33
34 =head1 COPYRIGHT
35
36 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
37
38 Licensed under the Apache License 2.0 (the "License").  You may not use
39 this file except in compliance with the License.  You can obtain a copy
40 in the file LICENSE in the source distribution or at
41 L<https://www.openssl.org/source/license.html>.
42
43 =cut