doc/crypto/BN_BLINDING_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BN_BLINDING_new, BN_BLINDING_free, BN_BLINDING_update, BN_BLINDING_convert,
   6 BN_BLINDING_invert, BN_BLINDING_convert_ex, BN_BLINDING_invert_ex,
   7 BN_BLINDING_get_thread_id, BN_BLINDING_set_thread_id, BN_BLINDING_thread_id, BN_BLINDING_get_flags,
   8 BN_BLINDING_set_flags, BN_BLINDING_create_param - blinding related BIGNUM
   9 functions.
  10
  11 =head1 SYNOPSIS
  12
  13  #include <openssl/bn.h>
  14
  15  BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai,
  16         BIGNUM *mod);
  17  void BN_BLINDING_free(BN_BLINDING *b);
  18  int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
  19  int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
  20  int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
  21  int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b,
  22         BN_CTX *ctx);
  23  int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
  24         BN_CTX *ctx);
  25  CRYPTO_THREADID *BN_BLINDING_thread_id(BN_BLINDING *);
  26  unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
  27  void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
  28  BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
  29         const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
  30         int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
  31                           const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
  32         BN_MONT_CTX *m_ctx);
  33
  34 Deprecated:
  35
  36  #if OPENSSL_API_COMPAT < 0x10000000L
  37  unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *);
  38  void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long);
  39  #endif
  40
  41 =head1 DESCRIPTION
  42
  43 BN_BLINDING_new() allocates a new B<BN_BLINDING> structure and copies
  44 the B<A> and B<Ai> values into the newly created B<BN_BLINDING> object.
  45
  46 BN_BLINDING_free() frees the B<BN_BLINDING> structure.
  47 If B<b> is NULL, nothing is done.
  48
  49 BN_BLINDING_update() updates the B<BN_BLINDING> parameters by squaring
  50 the B<A> and B<Ai> or, after specific number of uses and if the
  51 necessary parameters are set, by re-creating the blinding parameters.
  52
  53 BN_BLINDING_convert_ex() multiplies B<n> with the blinding factor B<A>.
  54 If B<r> is not NULL a copy the inverse blinding factor B<Ai> will be
  55 returned in B<r> (this is useful if a B<RSA> object is shared among
  56 several threads). BN_BLINDING_invert_ex() multiplies B<n> with the
  57 inverse blinding factor B<Ai>. If B<r> is not NULL it will be used as
  58 the inverse blinding.
  59
  60 BN_BLINDING_convert() and BN_BLINDING_invert() are wrapper
  61 functions for BN_BLINDING_convert_ex() and BN_BLINDING_invert_ex()
  62 with B<r> set to NULL.
  63
  64 BN_BLINDING_thread_id() provides access to the B<CRYPTO_THREADID>
  65 object within the B<BN_BLINDING> structure. This is to help users
  66 provide proper locking if needed for multi-threaded use. The "thread
  67 id" object of a newly allocated B<BN_BLINDING> structure is
  68 initialised to the thread id in which BN_BLINDING_new() was called.
  69
  70 BN_BLINDING_get_flags() returns the BN_BLINDING flags. Currently
  71 there are two supported flags: B<BN_BLINDING_NO_UPDATE> and
  72 B<BN_BLINDING_NO_RECREATE>. B<BN_BLINDING_NO_UPDATE> inhibits the
  73 automatic update of the B<BN_BLINDING> parameters after each use
  74 and B<BN_BLINDING_NO_RECREATE> inhibits the automatic re-creation
  75 of the B<BN_BLINDING> parameters after a fixed number of uses (currently
  76 32). In newly allocated B<BN_BLINDING> objects no flags are set.
  77 BN_BLINDING_set_flags() sets the B<BN_BLINDING> parameters flags.
  78
  79 BN_BLINDING_create_param() creates new B<BN_BLINDING> parameters
  80 using the exponent B<e> and the modulus B<m>. B<bn_mod_exp> and
  81 B<m_ctx> can be used to pass special functions for exponentiation
  82 (normally BN_mod_exp_mont() and B<BN_MONT_CTX>).
  83
  84 =head1 RETURN VALUES
  85
  86 BN_BLINDING_new() returns the newly allocated B<BN_BLINDING> structure
  87 or NULL in case of an error.
  88
  89 BN_BLINDING_update(), BN_BLINDING_convert(), BN_BLINDING_invert(),
  90 BN_BLINDING_convert_ex() and BN_BLINDING_invert_ex() return 1 on
  91 success and 0 if an error occurred.
  92
  93 BN_BLINDING_thread_id() returns a pointer to the thread id object
  94 within a B<BN_BLINDING> object.
  95
  96 BN_BLINDING_get_flags() returns the currently set B<BN_BLINDING> flags
  97 (a B<unsigned long> value).
  98
  99 BN_BLINDING_create_param() returns the newly created B<BN_BLINDING>
 100 parameters or NULL on error.
 101
 102 =head1 SEE ALSO
 103
 104 L<bn(3)>
 105
 106 =head1 HISTORY
 107
 108 BN_BLINDING_thread_id() was first introduced in OpenSSL 1.0.0, and it
 109 deprecates BN_BLINDING_set_thread_id() and BN_BLINDING_get_thread_id().
 110
 111 =cut