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