1.\" $OpenBSD: BN_cmp.3,v 1.10 2022/11/22 19:02:07 schwarze Exp $ 2.\" full merge up to: OpenSSL 5b31b9df Aug 4 10:45:52 2021 +0300 3.\" 4.\" This file was written by Ulf Moeller <ulf@openssl.org>. 5.\" Copyright (c) 2000 The OpenSSL Project. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in 16.\" the documentation and/or other materials provided with the 17.\" distribution. 18.\" 19.\" 3. All advertising materials mentioning features or use of this 20.\" software must display the following acknowledgment: 21.\" "This product includes software developed by the OpenSSL Project 22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 23.\" 24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 25.\" endorse or promote products derived from this software without 26.\" prior written permission. For written permission, please contact 27.\" openssl-core@openssl.org. 28.\" 29.\" 5. Products derived from this software may not be called "OpenSSL" 30.\" nor may "OpenSSL" appear in their names without prior written 31.\" permission of the OpenSSL Project. 32.\" 33.\" 6. Redistributions of any form whatsoever must retain the following 34.\" acknowledgment: 35.\" "This product includes software developed by the OpenSSL Project 36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 37.\" 38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" 51.Dd $Mdocdate: November 22 2022 $ 52.Dt BN_CMP 3 53.Os 54.Sh NAME 55.Nm BN_cmp , 56.Nm BN_ucmp , 57.Nm BN_is_zero , 58.Nm BN_is_one , 59.Nm BN_is_word , 60.Nm BN_abs_is_word , 61.Nm BN_is_odd 62.Nd BIGNUM comparison and test functions 63.Sh SYNOPSIS 64.In openssl/bn.h 65.Ft int 66.Fo BN_cmp 67.Fa "const BIGNUM *a" 68.Fa "const BIGNUM *b" 69.Fc 70.Ft int 71.Fo BN_ucmp 72.Fa "const BIGNUM *a" 73.Fa "const BIGNUM *b" 74.Fc 75.Ft int 76.Fo BN_is_zero 77.Fa "const BIGNUM *a" 78.Fc 79.Ft int 80.Fo BN_is_one 81.Fa "const BIGNUM *a" 82.Fc 83.Ft int 84.Fo BN_is_word 85.Fa "const BIGNUM *a" 86.Fa "const BN_ULONG w" 87.Fc 88.Ft int 89.Fo BN_abs_is_word 90.Fa "const BIGNUM *a" 91.Fa "const BN_ULONG w" 92.Fc 93.Ft int 94.Fo BN_is_odd 95.Fa "const BIGNUM *a" 96.Fc 97.Sh DESCRIPTION 98.Fn BN_cmp 99compares the numbers 100.Fa a 101and 102.Fa b . 103.Fn BN_ucmp 104compares their absolute values. 105.Pp 106.Fn BN_is_zero , 107.Fn BN_is_one 108and 109.Fn BN_is_word 110test if 111.Fa a 112equals 0, 1, or 113.Fa w 114respectively. 115.Fn BN_abs_is_word 116tests if the absolute value of 117.Fa a 118equals 119.Fa w . 120.Fn BN_is_odd 121tests if a is odd. 122.Pp 123.Vt BN_ULONG 124is a macro that expands to 125.Vt unsigned long Pq = Vt uint64_t 126on 127.Dv _LP64 128platforms and 129.Vt unsigned int Pq = Vt uint32_t 130elsewhere. 131.Sh RETURN VALUES 132.Fn BN_cmp 133returns -1 if 134.Fa a Ns < Ns Fa b , 1350 if 136.Fa a Ns == Ns Fa b , 137and 1 if 138.Fa a Ns > Ns Fa b . 139.Fn BN_ucmp 140is the same using the absolute values of 141.Fa a 142and 143.Fa b . 144.Pp 145.Fn BN_is_zero , 146.Fn BN_is_one , 147.Fn BN_is_word , 148.Fn BN_abs_is_word , 149and 150.Fn BN_is_odd 151return 1 if the condition is true, 0 otherwise. 152.Sh SEE ALSO 153.Xr BN_new 3 154.Sh HISTORY 155.Fn BN_cmp , 156.Fn BN_ucmp , 157.Fn BN_is_zero , 158.Fn BN_is_one , 159and 160.Fn BN_is_word 161first appeared in SSLeay 0.5.1. 162.Fn BN_is_odd 163first appeared in SSLeay 0.8.0. 164These functions have been available since 165.Ox 2.4 . 166.Pp 167.Fn BN_abs_is_word 168first appeared in OpenSSL 0.9.7 and has been available since 169.Ox 3.2 . 170