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