There was a need to support thread ID types that couldn't be reliably cast
[openssl.git] / 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_set_thread, BN_BLINDING_cmp_thread, 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
26  void BN_BLINDING_set_thread(BN_BLINDING *);
27  int BN_BLINDING_cmp_thread(const BN_BLINDING *,
28         const CRYPTO_THREADID *);
29  unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
30  void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
31  BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
32         const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
33         int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
34                           const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
35         BN_MONT_CTX *m_ctx);
36
37 =head1 DESCRIPTION
38
39 BN_BLINDING_new() allocates a new B<BN_BLINDING> structure and copies
40 the B<A> and B<Ai> values into the newly created B<BN_BLINDING> object.
41
42 BN_BLINDING_free() frees the B<BN_BLINDING> structure.
43
44 BN_BLINDING_update() updates the B<BN_BLINDING> parameters by squaring
45 the B<A> and B<Ai> or, after specific number of uses and if the
46 necessary parameters are set, by re-creating the blinding parameters.
47
48 BN_BLINDING_convert_ex() multiplies B<n> with the blinding factor B<A>.
49 If B<r> is not NULL a copy the inverse blinding factor B<Ai> will be
50 returned in B<r> (this is useful if a B<RSA> object is shared amoung
51 several threads). BN_BLINDING_invert_ex() multiplies B<n> with the
52 inverse blinding factor B<Ai>. If B<r> is not NULL it will be used as
53 the inverse blinding.
54
55 BN_BLINDING_convert() and BN_BLINDING_invert() are wrapper
56 functions for BN_BLINDING_convert_ex() and BN_BLINDING_invert_ex()
57 with B<r> set to NULL.
58
59 BN_BLINDING_set_thread() and BN_BLINDING_cmp_thread()
60 set and compare the "thread id" of the B<BN_BLINDING> structure,
61 allowing users of the B<BN_BLINDING> structure to
62 provide proper locking if needed for multi-threaded use.
63
64 BN_BLINDING_get_flags() returns the BN_BLINDING flags. Currently
65 there are two supported flags: B<BN_BLINDING_NO_UPDATE> and
66 B<BN_BLINDING_NO_RECREATE>. B<BN_BLINDING_NO_UPDATE> inhibits the
67 automatic update of the B<BN_BLINDING> parameters after each use
68 and B<BN_BLINDING_NO_RECREATE> inhibits the automatic re-creation
69 of the B<BN_BLINDING> parameters after a fixed number of uses (currently
70 32). In newly allocated B<BN_BLINDING> objects no flags are set.
71 BN_BLINDING_set_flags() sets the B<BN_BLINDING> parameters flags.
72
73 BN_BLINDING_create_param() creates new B<BN_BLINDING> parameters
74 using the exponent B<e> and the modulus B<m>. B<bn_mod_exp> and
75 B<m_ctx> can be used to pass special functions for exponentiation
76 (normally BN_mod_exp_mont() and B<BN_MONT_CTX>).
77
78 =head1 RETURN VALUES
79
80 BN_BLINDING_new() returns the newly allocated B<BN_BLINDING> structure
81 or NULL in case of an error.
82
83 BN_BLINDING_update(), BN_BLINDING_convert(), BN_BLINDING_invert(),
84 BN_BLINDING_convert_ex() and BN_BLINDING_invert_ex() return 1 on
85 success and 0 if an error occured.
86
87 BN_BLINDING_get_thread_id() returns the thread id (a B<unsigned long>
88 value) or 0 if not set.
89 BN_BLINDING_cmp_thread() returns 0 if the thread id associated with the
90 B<BN_BLINDING> structure equals the provided thread id (which can be
91 obtained by CRYPTO_THREADID_set()), otherwise it returns -1 or +1
92 to indicate the thread ids are different (if the target architecture
93 supports ordering of thread ids, this follows the traditional "cmp"
94 semantics of memcmp() or strcmp()).
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)|bn(3)>
105
106 =head1 HISTORY
107
108 BN_BLINDING_convert_ex, BN_BLINDIND_invert_ex, BN_BLINDING_get_thread_id,
109 BN_BLINDING_set_thread_id, BN_BLINDING_set_flags, BN_BLINDING_get_flags
110 and BN_BLINDING_create_param were first introduced in OpenSSL 0.9.8
111
112 BN_BLINDING_get_thread_idptr, BN_BLINDING_set_thread_idptr were first
113 introduced in OpenSSL 0.9.9
114
115 BN_BLINDING_get_thread_id, BN_BLINDING_set_thread_id,
116 BN_BLINDING_get_thread_idptr, BN_BLINDING_set_thread_idptr were all
117 deprecated in favour of BN_BLINDING_set_thread, BN_BLINDING_cmp_thread
118 which were introduced in OpenSSL 0.9.9
119
120 =head1 AUTHOR
121
122 Nils Larsch for the OpenSSL project (http://www.openssl.org).
123
124 =cut