$NetBSD: BN_BLINDING_new.3,v 1.1.1.2 2023/04/18 14:19:13 christos Exp $ Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) Standard preamble: ========================================================================..
..
..
Set up some character translations and predefined strings. \*(-- will give an unbreakable dash, \*(PI will give pi, \*(L" will give a left double quote, and \*(R" will give a right double quote. \*(C+ will give a nicer C++. Capital omega is used to do unbreakable dashes and therefore won't be available. \*(C` and \*(C' expand to `' in nroff, nothing in troff, for use with C<>..tr \(*W-
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
Escape single quotes in literal strings from groff's Unicode transform. If the F register is >0, we'll generate index entries on stderr for titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index entries marked with X<> in POD. Of course, you'll have to process the output yourself in some meaningful fashion. Avoid warning from groff about undefined register 'F'...
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). Fear. Run. Save yourself. No user-serviceable parts.. \" fudge factors for nroff and troff
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #]
.\}
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
. \" corrections for vroff
. \" for low resolution devices (crt and lpr)
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
======================================================================== Title "BN_BLINDING_new 3" BN_BLINDING_new 3 "2018-09-23" "1.1.1i" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents..nh
"NAME"
BN_BLINDING_new, BN_BLINDING_free, BN_BLINDING_update, BN_BLINDING_convert,
BN_BLINDING_invert, BN_BLINDING_convert_ex, BN_BLINDING_invert_ex,
BN_BLINDING_is_current_thread, BN_BLINDING_set_current_thread,
BN_BLINDING_lock, BN_BLINDING_unlock, BN_BLINDING_get_flags,
BN_BLINDING_set_flags, BN_BLINDING_create_param - blinding related BIGNUM functions
"LIBRARY"
libcrypto, -lcrypto
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1
#include <
openssl/
bn.h>
\&
BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai,
BIGNUM *mod);
void BN_BLINDING_free(BN_BLINDING *b);
int BN_BLINDING_update(BN_BLINDING *b, BN_CTX *ctx);
int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx);
int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b,
BN_CTX *ctx);
int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b,
BN_CTX *ctx);
int BN_BLINDING_is_current_thread(BN_BLINDING *b);
void BN_BLINDING_set_current_thread(BN_BLINDING *b);
int BN_BLINDING_lock(BN_BLINDING *b);
int BN_BLINDING_unlock(BN_BLINDING *b);
unsigned long BN_BLINDING_get_flags(const BN_BLINDING *);
void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long);
BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b,
const BIGNUM *e, BIGNUM *m, BN_CTX *ctx,
int (*bn_mod_exp)(BIGNUM *r,
const BIGNUM *a,
const BIGNUM *p,
const BIGNUM *m,
BN_CTX *ctx,
BN_MONT_CTX *m_ctx),
BN_MONT_CTX *m_ctx);
.Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBBN_BLINDING_new() allocates a new
\s-1BN_BLINDING\s0 structure and copies
the
A and
Ai values into the newly created
\s-1BN_BLINDING\s0 object.
\fBBN_BLINDING_free() frees the \s-1BN_BLINDING\s0 structure.
If b is \s-1NULL,\s0 nothing is done.
\fBBN_BLINDING_update() updates the \s-1BN_BLINDING\s0 parameters by squaring
the A and Ai or, after specific number of uses and if the
necessary parameters are set, by re-creating the blinding parameters.
\fBBN_BLINDING_convert_ex() multiplies n with the blinding factor A.
If r is not \s-1NULL\s0 a copy the inverse blinding factor Ai will be
returned in r (this is useful if a \s-1RSA\s0 object is shared among
several threads). BN_BLINDING_invert_ex() multiplies n with the
inverse blinding factor Ai. If r is not \s-1NULL\s0 it will be used as
the inverse blinding.
\fBBN_BLINDING_convert() and BN_BLINDING_invert() are wrapper
functions for BN_BLINDING_convert_ex() and BN_BLINDING_invert_ex()
with r set to \s-1NULL.\s0
\fBBN_BLINDING_is_current_thread() returns whether the \s-1BN_BLINDING\s0
structure is owned by the current thread. This is to help users
provide proper locking if needed for multi-threaded use.
\fBBN_BLINDING_set_current_thread() sets the current thread as the
owner of the \s-1BN_BLINDING\s0 structure.
\fBBN_BLINDING_lock() locks the \s-1BN_BLINDING\s0 structure.
\fBBN_BLINDING_unlock() unlocks the \s-1BN_BLINDING\s0 structure.
\fBBN_BLINDING_get_flags() returns the \s-1BN_BLINDING\s0 flags. Currently
there are two supported flags: \s-1BN_BLINDING_NO_UPDATE\s0 and
\fB\s-1BN_BLINDING_NO_RECREATE\s0. \s-1BN_BLINDING_NO_UPDATE\s0 inhibits the
automatic update of the \s-1BN_BLINDING\s0 parameters after each use
and \s-1BN_BLINDING_NO_RECREATE\s0 inhibits the automatic re-creation
of the \s-1BN_BLINDING\s0 parameters after a fixed number of uses (currently
32). In newly allocated \s-1BN_BLINDING\s0 objects no flags are set.
\fBBN_BLINDING_set_flags() sets the \s-1BN_BLINDING\s0 parameters flags.
\fBBN_BLINDING_create_param() creates new \s-1BN_BLINDING\s0 parameters
using the exponent e and the modulus m. bn_mod_exp and
\fBm_ctx can be used to pass special functions for exponentiation
(normally BN_mod_exp_mont() and \s-1BN_MONT_CTX\s0).
"RETURN VALUES"
Header "RETURN VALUES" \fBBN_BLINDING_new() returns the newly allocated
\s-1BN_BLINDING\s0 structure
or \s-1NULL\s0 in case of an error.
\fBBN_BLINDING_update(), BN_BLINDING_convert(), BN_BLINDING_invert(),
\fBBN_BLINDING_convert_ex() and BN_BLINDING_invert_ex() return 1 on
success and 0 if an error occurred.
\fBBN_BLINDING_is_current_thread() returns 1 if the current thread owns
the \s-1BN_BLINDING\s0 object, 0 otherwise.
\fBBN_BLINDING_set_current_thread() doesn't return anything.
\fBBN_BLINDING_lock(), BN_BLINDING_unlock() return 1 if the operation
succeeded or 0 on error.
\fBBN_BLINDING_get_flags() returns the currently set \s-1BN_BLINDING\s0 flags
(a unsigned long value).
\fBBN_BLINDING_create_param() returns the newly created \s-1BN_BLINDING\s0
parameters or \s-1NULL\s0 on error.
"HISTORY"
Header "HISTORY" \fBBN_BLINDING_thread_id() was first introduced in OpenSSL 1.0.0, and it
deprecates
BN_BLINDING_set_thread_id() and
BN_BLINDING_get_thread_id().
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2005-2017 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file \s-1LICENSE\s0 in the source distribution or at
<https://www.openssl.org/source/license.html>.