BN_BLINDING_new.pod 4.4 KB

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