From 99d63d4662e16afbeff49f29b48f1c87d5558ed0 Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Wed, 26 Oct 2016 13:56:48 -0400 Subject: Move manpages to man[1357] structure. Move manpages to manX directories Add Windows/VMS install fix from Richard Levitte Update README Fix typo's Remove some duplicates Reviewed-by: Richard Levitte --- doc/man3/BN_BLINDING_new.pod | 126 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 126 insertions(+) create mode 100644 doc/man3/BN_BLINDING_new.pod (limited to 'doc/man3/BN_BLINDING_new.pod') diff --git a/doc/man3/BN_BLINDING_new.pod b/doc/man3/BN_BLINDING_new.pod new file mode 100644 index 0000000000..5f56aa3fc9 --- /dev/null +++ b/doc/man3/BN_BLINDING_new.pod @@ -0,0 +1,126 @@ +=pod + +=head1 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 + +=head1 SYNOPSIS + + #include + + 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); + +=head1 DESCRIPTION + +BN_BLINDING_new() allocates a new B structure and copies +the B and B values into the newly created B object. + +BN_BLINDING_free() frees the B structure. +If B is NULL, nothing is done. + +BN_BLINDING_update() updates the B parameters by squaring +the B and B or, after specific number of uses and if the +necessary parameters are set, by re-creating the blinding parameters. + +BN_BLINDING_convert_ex() multiplies B with the blinding factor B. +If B is not NULL a copy the inverse blinding factor B will be +returned in B (this is useful if a B object is shared among +several threads). BN_BLINDING_invert_ex() multiplies B with the +inverse blinding factor B. If B is not NULL it will be used as +the inverse blinding. + +BN_BLINDING_convert() and BN_BLINDING_invert() are wrapper +functions for BN_BLINDING_convert_ex() and BN_BLINDING_invert_ex() +with B set to NULL. + +BN_BLINDING_is_current_thread() returns whether the B +structure is owned by the current thread. This is to help users +provide proper locking if needed for multi-threaded use. + +BN_BLINDING_set_current_thread() sets the current thread as the +owner of the B structure. + +BN_BLINDING_lock() locks the B structure. + +BN_BLINDING_unlock() unlocks the B structure. + +BN_BLINDING_get_flags() returns the BN_BLINDING flags. Currently +there are two supported flags: B and +B. B inhibits the +automatic update of the B parameters after each use +and B inhibits the automatic re-creation +of the B parameters after a fixed number of uses (currently +32). In newly allocated B objects no flags are set. +BN_BLINDING_set_flags() sets the B parameters flags. + +BN_BLINDING_create_param() creates new B parameters +using the exponent B and the modulus B. B and +B can be used to pass special functions for exponentiation +(normally BN_mod_exp_mont() and B). + +=head1 RETURN VALUES + +BN_BLINDING_new() returns the newly allocated B structure +or NULL in case of an error. + +BN_BLINDING_update(), BN_BLINDING_convert(), BN_BLINDING_invert(), +BN_BLINDING_convert_ex() and BN_BLINDING_invert_ex() return 1 on +success and 0 if an error occurred. + +BN_BLINDING_is_current_thread() returns 1 if the current thread owns +the B object, 0 otherwise. + +BN_BLINDING_set_current_thread() doesn't return anything. + +BN_BLINDING_lock(), BN_BLINDING_unlock() return 1 if the operation +succeeded or 0 on error. + +BN_BLINDING_get_flags() returns the currently set B flags +(a B value). + +BN_BLINDING_create_param() returns the newly created B +parameters or NULL on error. + +=head1 SEE ALSO + +L + +=head1 HISTORY + +BN_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(). + +=head1 COPYRIGHT + +Copyright 2005-2016 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut -- cgit v1.2.3