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 The following functions have been deprecated since OpenSSL 3.0, and can be
  12 hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
  13 see L<openssl_user_macros(7)>:
  14
  15  int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
  16
  17  void RSA_blinding_off(RSA *rsa);
  18
  19 =head1 DESCRIPTION
  20
  21 All of the functions described on this page are deprecated.
  22
  23 RSA is vulnerable to timing attacks. In a setup where attackers can
  24 measure the time of RSA decryption or signature operations, blinding
  25 must be used to protect the RSA operation from that attack.
  26
  27 RSA_blinding_on() turns blinding on for key B<rsa> and generates a
  28 random blinding factor. B<ctx> is B<NULL> or a preallocated and
  29 initialized B<BN_CTX>.
  30
  31 RSA_blinding_off() turns blinding off and frees the memory used for
  32 the blinding factor.
  33
  34 =head1 RETURN VALUES
  35
  36 RSA_blinding_on() returns 1 on success, and 0 if an error occurred.
  37
  38 RSA_blinding_off() returns no value.
  39
  40 =head1 HISTORY
  41
  42 All of these functions were deprecated in OpenSSL 3.0.
  43
  44 =head1 COPYRIGHT
  45
  46 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
  47
  48 Licensed under the Apache License 2.0 (the "License").  You may not use
  49 this file except in compliance with the License.  You can obtain a copy
  50 in the file LICENSE in the source distribution or at
  51 L<https://www.openssl.org/source/license.html>.
  52
  53 =cut