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_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
  45 BN_BLINDING_update() updates the B<BN_BLINDING> parameters by squaring
  46 the B<A> and B<Ai> or, after specific number of uses and if the
  47 necessary parameters are set, by re-creating the blinding parameters.
  48
  49 BN_BLINDING_convert_ex() multiplies B<n> with the blinding factor B<A>.
  50 If B<r> is not NULL a copy the inverse blinding factor B<Ai> will be
  51 returned in B<r> (this is useful if a B<RSA> object is shared amoung
  52 several threads). BN_BLINDING_invert_ex() multiplies B<n> with the
  53 inverse blinding factor B<Ai>. If B<r> is not NULL it will be used as
  54 the inverse blinding.
  55
  56 BN_BLINDING_convert() and BN_BLINDING_invert() are wrapper
  57 functions for BN_BLINDING_convert_ex() and BN_BLINDING_invert_ex()
  58 with B<r> set to NULL.
  59
  60 BN_BLINDING_thread_id() provides access to the B<CRYPTO_THREADID>
  61 object within the B<BN_BLINDING> structure. This is to help users
  62 provide proper locking if needed for multi-threaded use. The "thread
  63 id" object of a newly allocated B<BN_BLINDING> structure is
  64 initialised to the thread id in which BN_BLINDING_new() was called.
  65
  66 BN_BLINDING_get_flags() returns the BN_BLINDING flags. Currently
  67 there are two supported flags: B<BN_BLINDING_NO_UPDATE> and
  68 B<BN_BLINDING_NO_RECREATE>. B<BN_BLINDING_NO_UPDATE> inhibits the
  69 automatic update of the B<BN_BLINDING> parameters after each use
  70 and B<BN_BLINDING_NO_RECREATE> inhibits the automatic re-creation
  71 of the B<BN_BLINDING> parameters after a fixed number of uses (currently
  72 32). In newly allocated B<BN_BLINDING> objects no flags are set.
  73 BN_BLINDING_set_flags() sets the B<BN_BLINDING> parameters flags.
  74
  75 BN_BLINDING_create_param() creates new B<BN_BLINDING> parameters
  76 using the exponent B<e> and the modulus B<m>. B<bn_mod_exp> and
  77 B<m_ctx> can be used to pass special functions for exponentiation
  78 (normally BN_mod_exp_mont() and B<BN_MONT_CTX>).
  79
  80 =head1 RETURN VALUES
  81
  82 BN_BLINDING_new() returns the newly allocated B<BN_BLINDING> structure
  83 or NULL in case of an error.
  84
  85 BN_BLINDING_update(), BN_BLINDING_convert(), BN_BLINDING_invert(),
  86 BN_BLINDING_convert_ex() and BN_BLINDING_invert_ex() return 1 on
  87 success and 0 if an error occured.
  88
  89 BN_BLINDING_thread_id() returns a pointer to the thread id object
  90 within a B<BN_BLINDING> object.
  91
  92 BN_BLINDING_get_flags() returns the currently set B<BN_BLINDING> flags
  93 (a B<unsigned long> value).
  94
  95 BN_BLINDING_create_param() returns the newly created B<BN_BLINDING>
  96 parameters or NULL on error.
  97
  98 =head1 SEE ALSO
  99
 100 L<bn(3)|bn(3)>
 101
 102 =head1 HISTORY
 103
 104 BN_BLINDING_thread_id was first introduced in OpenSSL 0.9.9, and it
 105 deprecates BN_BLINDING_set_thread_id and BN_BLINDING_get_thread_id.
 106
 107 BN_BLINDING_convert_ex, BN_BLINDIND_invert_ex, BN_BLINDING_get_thread_id,
 108 BN_BLINDING_set_thread_id, BN_BLINDING_set_flags, BN_BLINDING_get_flags
 109 and BN_BLINDING_create_param were first introduced in OpenSSL 0.9.8
 110
 111 =head1 AUTHOR
 112
 113 Nils Larsch for the OpenSSL project (http://www.openssl.org).
 114
 115 =cut