Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / lib / libcrypto / man / BN_BLINDING_new.3
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
a561f9ff
SS
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
a561f9ff
SS
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
aac4ff6f
PA
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
a561f9ff
SS
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "BN_BLINDING_new 3"
aac4ff6f 132.TH BN_BLINDING_new 3 "2008-09-06" "0.9.8h" "OpenSSL"
a561f9ff
SS
133.SH "NAME"
134BN_BLINDING_new, BN_BLINDING_free, BN_BLINDING_update, BN_BLINDING_convert,
135BN_BLINDING_invert, BN_BLINDING_convert_ex, BN_BLINDING_invert_ex,
136BN_BLINDING_get_thread_id, BN_BLINDING_set_thread_id, BN_BLINDING_get_flags,
137BN_BLINDING_set_flags, BN_BLINDING_create_param \- blinding related BIGNUM
138functions.
139.SH "SYNOPSIS"
140.IX Header "SYNOPSIS"
141.Vb 1
142\& #include <openssl/bn.h>
aac4ff6f
PA
143.Ve
144.PP
145.Vb 19
a561f9ff
SS
146\& BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai,
147\& BIGNUM *mod);
148\& void BN_BLINDING_free(BN_BLINDING *b);
149\& int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
150\& int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
151\& int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
152\& int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b,
153\& BN_CTX *ctx);
154\& int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
155\& BN_CTX *ctx);
156\& unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *);
157\& void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long);
158\& unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
159\& void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
160\& BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
161\& const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
162\& int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
163\& const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx),
164\& BN_MONT_CTX *m_ctx);
165.Ve
166.SH "DESCRIPTION"
167.IX Header "DESCRIPTION"
168\&\fIBN_BLINDING_new()\fR allocates a new \fB\s-1BN_BLINDING\s0\fR structure and copies
169the \fBA\fR and \fBAi\fR values into the newly created \fB\s-1BN_BLINDING\s0\fR object.
170.PP
171\&\fIBN_BLINDING_free()\fR frees the \fB\s-1BN_BLINDING\s0\fR structure.
172.PP
173\&\fIBN_BLINDING_update()\fR updates the \fB\s-1BN_BLINDING\s0\fR parameters by squaring
174the \fBA\fR and \fBAi\fR or, after specific number of uses and if the
175necessary parameters are set, by re-creating the blinding parameters.
176.PP
177\&\fIBN_BLINDING_convert_ex()\fR multiplies \fBn\fR with the blinding factor \fBA\fR.
178If \fBr\fR is not \s-1NULL\s0 a copy the inverse blinding factor \fBAi\fR will be
179returned in \fBr\fR (this is useful if a \fB\s-1RSA\s0\fR object is shared amoung
180several threads). \fIBN_BLINDING_invert_ex()\fR multiplies \fBn\fR with the
181inverse blinding factor \fBAi\fR. If \fBr\fR is not \s-1NULL\s0 it will be used as
182the inverse blinding.
183.PP
184\&\fIBN_BLINDING_convert()\fR and \fIBN_BLINDING_invert()\fR are wrapper
185functions for \fIBN_BLINDING_convert_ex()\fR and \fIBN_BLINDING_invert_ex()\fR
186with \fBr\fR set to \s-1NULL\s0.
187.PP
188\&\fIBN_BLINDING_set_thread_id()\fR and \fIBN_BLINDING_get_thread_id()\fR
189set and get the \*(L"thread id\*(R" value of the \fB\s-1BN_BLINDING\s0\fR structure,
190a field provided to users of \fB\s-1BN_BLINDING\s0\fR structure to help them
191provide proper locking if needed for multi-threaded use. The
192\&\*(L"thread id\*(R" of a newly allocated \fB\s-1BN_BLINDING\s0\fR structure is zero.
193.PP
194\&\fIBN_BLINDING_get_flags()\fR returns the \s-1BN_BLINDING\s0 flags. Currently
195there are two supported flags: \fB\s-1BN_BLINDING_NO_UPDATE\s0\fR and
196\&\fB\s-1BN_BLINDING_NO_RECREATE\s0\fR. \fB\s-1BN_BLINDING_NO_UPDATE\s0\fR inhibits the
197automatic update of the \fB\s-1BN_BLINDING\s0\fR parameters after each use
198and \fB\s-1BN_BLINDING_NO_RECREATE\s0\fR inhibits the automatic re-creation
199of the \fB\s-1BN_BLINDING\s0\fR parameters after a fixed number of uses (currently
20032). In newly allocated \fB\s-1BN_BLINDING\s0\fR objects no flags are set.
201\&\fIBN_BLINDING_set_flags()\fR sets the \fB\s-1BN_BLINDING\s0\fR parameters flags.
202.PP
203\&\fIBN_BLINDING_create_param()\fR creates new \fB\s-1BN_BLINDING\s0\fR parameters
204using the exponent \fBe\fR and the modulus \fBm\fR. \fBbn_mod_exp\fR and
205\&\fBm_ctx\fR can be used to pass special functions for exponentiation
206(normally \fIBN_mod_exp_mont()\fR and \fB\s-1BN_MONT_CTX\s0\fR).
207.SH "RETURN VALUES"
208.IX Header "RETURN VALUES"
209\&\fIBN_BLINDING_new()\fR returns the newly allocated \fB\s-1BN_BLINDING\s0\fR structure
210or \s-1NULL\s0 in case of an error.
211.PP
212\&\fIBN_BLINDING_update()\fR, \fIBN_BLINDING_convert()\fR, \fIBN_BLINDING_invert()\fR,
213\&\fIBN_BLINDING_convert_ex()\fR and \fIBN_BLINDING_invert_ex()\fR return 1 on
214success and 0 if an error occured.
215.PP
216\&\fIBN_BLINDING_get_thread_id()\fR returns the thread id (a \fBunsigned long\fR
217value) or 0 if not set.
218.PP
219\&\fIBN_BLINDING_get_flags()\fR returns the currently set \fB\s-1BN_BLINDING\s0\fR flags
220(a \fBunsigned long\fR value).
221.PP
222\&\fIBN_BLINDING_create_param()\fR returns the newly created \fB\s-1BN_BLINDING\s0\fR
223parameters or \s-1NULL\s0 on error.
224.SH "SEE ALSO"
225.IX Header "SEE ALSO"
226\&\fIbn\fR\|(3)
227.SH "HISTORY"
228.IX Header "HISTORY"
229BN_BLINDING_convert_ex, BN_BLINDIND_invert_ex, BN_BLINDING_get_thread_id,
230BN_BLINDING_set_thread_id, BN_BLINDING_set_flags, BN_BLINDING_get_flags
231and BN_BLINDING_create_param were first introduced in OpenSSL 0.9.8
232.SH "AUTHOR"
233.IX Header "AUTHOR"
234Nils Larsch for the OpenSSL project (http://www.openssl.org).