Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / lib / libcrypto / man / BN_BLINDING_new.3
CommitLineData
e3261593 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
a561f9ff
SS
2.\"
3.\" Standard preamble:
4.\" ========================================================================
a561f9ff
SS
5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v
7.if n .sp
8..
9.de Vb \" Begin verbatim text
10.ft CW
11.nf
12.ne \\$1
13..
14.de Ve \" End verbatim text
15.ft R
16.fi
17..
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
a561f9ff
SS
25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26.ie n \{\
27. ds -- \(*W-
28. ds PI pi
29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31. ds L" ""
32. ds R" ""
33. ds C` ""
34. ds C' ""
35'br\}
36.el\{\
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
41'br\}
42.\"
e257b235
PA
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
a561f9ff 47.\" If the F register is turned on, we'll generate index entries on stderr for
01185282 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
a561f9ff
SS
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
e257b235 51.ie \nF \{\
a561f9ff
SS
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
54..
55. nr % 0
56. rr F
57.\}
e257b235
PA
58.el \{\
59. de IX
60..
61.\}
aac4ff6f 62.\"
a561f9ff
SS
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
66.if n \{\
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
71. ds #] \fP
72.\}
73.if t \{\
74. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75. ds #V .6m
76. ds #F 0
77. ds #[ \&
78. ds #] \&
79.\}
80. \" simple accents for nroff and troff
81.if n \{\
82. ds ' \&
83. ds ` \&
84. ds ^ \&
85. ds , \&
86. ds ~ ~
87. ds /
88.\}
89.if t \{\
90. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96.\}
97. \" troff and (daisy-wheel) nroff accents
98.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105.ds ae a\h'-(\w'a'u*4/10)'e
106.ds Ae A\h'-(\w'A'u*4/10)'E
107. \" corrections for vroff
108.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110. \" for low resolution devices (crt and lpr)
111.if \n(.H>23 .if \n(.V>19 \
112\{\
113. ds : e
114. ds 8 ss
115. ds o a
116. ds d- d\h'-1'\(ga
117. ds D- D\h'-1'\(hy
118. ds th \o'bp'
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
122.\}
123.rm #[ #] #H #V #F C
124.\" ========================================================================
125.\"
126.IX Title "BN_BLINDING_new 3"
e3261593 127.TH BN_BLINDING_new 3 "2012-01-04" "1.0.0f" "OpenSSL"
e257b235
PA
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
a561f9ff
SS
132.SH "NAME"
133BN_BLINDING_new, BN_BLINDING_free, BN_BLINDING_update, BN_BLINDING_convert,
134BN_BLINDING_invert, BN_BLINDING_convert_ex, BN_BLINDING_invert_ex,
135BN_BLINDING_get_thread_id, BN_BLINDING_set_thread_id, BN_BLINDING_get_flags,
136BN_BLINDING_set_flags, BN_BLINDING_create_param \- blinding related BIGNUM
137functions.
138.SH "SYNOPSIS"
139.IX Header "SYNOPSIS"
140.Vb 1
141\& #include <openssl/bn.h>
e257b235 142\&
a561f9ff
SS
143\& BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai,
144\& BIGNUM *mod);
145\& void BN_BLINDING_free(BN_BLINDING *b);
146\& int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx);
147\& int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
148\& int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
149\& int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b,
150\& BN_CTX *ctx);
151\& int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
152\& BN_CTX *ctx);
01185282 153\& #ifndef OPENSSL_NO_DEPRECATED
a561f9ff
SS
154\& unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *);
155\& void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long);
01185282
PA
156\& #endif
157\& CRYPTO_THREADID *BN_BLINDING_thread_id(BN_BLINDING *);
a561f9ff
SS
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
01185282
PA
188\&\fIBN_BLINDING_thread_id()\fR provides access to the \fB\s-1CRYPTO_THREADID\s0\fR
189object within the \fB\s-1BN_BLINDING\s0\fR structure. This is to help users
190provide proper locking if needed for multi-threaded use. The \*(L"thread
191id\*(R" object of a newly allocated \fB\s-1BN_BLINDING\s0\fR structure is
192initialised to the thread id in which \fIBN_BLINDING_new()\fR was called.
a561f9ff
SS
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
01185282
PA
216\&\fIBN_BLINDING_thread_id()\fR returns a pointer to the thread id object
217within a \fB\s-1BN_BLINDING\s0\fR object.
a561f9ff
SS
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"
01185282
PA
229BN_BLINDING_thread_id was first introduced in OpenSSL 1.0.0, and it
230deprecates BN_BLINDING_set_thread_id and BN_BLINDING_get_thread_id.
231.PP
a561f9ff
SS
232BN_BLINDING_convert_ex, BN_BLINDIND_invert_ex, BN_BLINDING_get_thread_id,
233BN_BLINDING_set_thread_id, BN_BLINDING_set_flags, BN_BLINDING_get_flags
234and BN_BLINDING_create_param were first introduced in OpenSSL 0.9.8
235.SH "AUTHOR"
236.IX Header "AUTHOR"
237Nils Larsch for the OpenSSL project (http://www.openssl.org).