document BN_kronecker(3)

3 files changed, 61 insertions, 3 deletions

diff --git a/src/lib/libcrypto/man/BN_kronecker.3 b/src/lib/libcrypto/man/BN_kronecker.3
new file mode 100644
index 0000000000..af1c298bb5
--- /dev/null
+++ b/src/lib/libcrypto/man/BN_kronecker.3
@@ -0,0 +1,56 @@
+.\" $OpenBSD: BN_kronecker.3,v 1.1 2022/11/14 19:51:35 schwarze Exp $
+.\"
+.\" Copyright (c) 2022 Ingo Schwarze <schwarze@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: November 14 2022 $
+.Dt BN_KRONECKER 3
+.Os
+.Sh NAME
+.Nm BN_kronecker
+.Nd Kronecker symbol
+.Sh SYNOPSIS
+.In openssl/bn.h
+.Ft int
+.Fo BN_kronecker
+.Fa "const BIGNUM *a"
+.Fa "const BIGNUM *b"
+.Fa "BN_CTX *ctx"
+.Fc
+.Sh DESCRIPTION
+.Fn BN_kronecker
+computes the Kronecker symbol
+.Pq a | b ,
+which generalizes the Legendre and Jacobi symbols
+for arbitrary integer numbers
+.Fa b .
+.Sh RETURN VALUES
+.Fn BN_kronecker
+returns \-1, 0, or 1 in case of success or \-2 on error.
+.Sh SEE ALSO
+.Xr BN_CTX_new 3 ,
+.Xr BN_gcd 3 ,
+.Xr BN_new 3
+.Rs
+.%A Henri Cohen
+.%B A Course in Computational Algebraic Number Theory
+.%I Springer
+.%C Berlin
+.%D 1993
+.%O Algorithm 1.4.10
+.Re
+.Sh HISTORY
+.Fn BN_kronecker
+first appeared in OpenSSL 0.9.7 and has been available since
+.Ox 3.2 .
diff --git a/src/lib/libcrypto/man/BN_new.3 b/src/lib/libcrypto/man/BN_new.3
index e8d268e8f4..90c0fb4e34 100644
--- a/src/lib/libcrypto/man/BN_new.3
+++ b/src/lib/libcrypto/man/BN_new.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: BN_new.3,v 1.18 2022/07/13 21:51:35 schwarze Exp $
+.\" $OpenBSD: BN_new.3,v 1.19 2022/11/14 19:51:35 schwarze Exp $
 .\" full merge up to: OpenSSL man3/BN_new 2457c19d Mar 6 08:43:36 2004 +0000
 .\" selective merge up to: man3/BN_new 681acb31 Sep 29 13:10:34 2017 +0200
 .\" full merge up to: OpenSSL man7/bn 05ea606a May 20 20:52:46 2016 -0400
@@ -50,7 +50,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: July 13 2022 $
+.Dd $Mdocdate: November 14 2022 $
 .Dt BN_NEW 3
 .Os
 .Sh NAME
@@ -155,6 +155,7 @@ and sets an error code that can be obtained by
 .Xr BN_CTX_start 3 ,
 .Xr BN_generate_prime 3 ,
 .Xr BN_get0_nist_prime_521 3 ,
+.Xr BN_kronecker 3 ,
 .Xr BN_mod_inverse 3 ,
 .Xr BN_mod_mul_montgomery 3 ,
 .Xr BN_mod_mul_reciprocal 3 ,
diff --git a/src/lib/libcrypto/man/Makefile b/src/lib/libcrypto/man/Makefile
index 88483d2b78..9f514044c2 100644
--- a/src/lib/libcrypto/man/Makefile
+++ b/src/lib/libcrypto/man/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.234 2022/07/13 20:54:39 schwarze Exp $
+# $OpenBSD: Makefile,v 1.235 2022/11/14 19:51:35 schwarze Exp $
 
 .include <bsd.own.mk>
 
@@ -72,6 +72,7 @@ MAN=	\
         BN_copy.3 \
         BN_generate_prime.3 \
         BN_get0_nist_prime_521.3 \
+        BN_kronecker.3 \
         BN_mod_inverse.3 \
         BN_mod_mul_montgomery.3 \
         BN_mod_mul_reciprocal.3 \