lib/libcrypto/man/BN_cmp.3

   1 .\"     $OpenBSD: BN_cmp.3,v 1.6 2018/03/27 17:35:50 schwarze Exp $
   2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
   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: March 27 2018 $
  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_is_odd
  61 .Nd BIGNUM comparison and test functions
  62 .Sh SYNOPSIS
  63 .In openssl/bn.h
  64 .Ft int
  65 .Fo BN_cmp
  66 .Fa "BIGNUM *a"
  67 .Fa "BIGNUM *b"
  68 .Fc
  69 .Ft int
  70 .Fo BN_ucmp
  71 .Fa "BIGNUM *a"
  72 .Fa "BIGNUM *b"
  73 .Fc
  74 .Ft int
  75 .Fo BN_is_zero
  76 .Fa "BIGNUM *a"
  77 .Fc
  78 .Ft int
  79 .Fo BN_is_one
  80 .Fa "BIGNUM *a"
  81 .Fc
  82 .Ft int
  83 .Fo BN_is_word
  84 .Fa "BIGNUM *a"
  85 .Fa "BN_ULONG w"
  86 .Fc
  87 .Ft int
  88 .Fo BN_is_odd
  89 .Fa "BIGNUM *a"
  90 .Fc
  91 .Sh DESCRIPTION
  92 .Fn BN_cmp
  93 compares the numbers
  94 .Fa a
  95 and
  96 .Fa b .
  97 .Fn BN_ucmp
  98 compares their absolute values.
  99 .Pp
 100 .Fn BN_is_zero ,
 101 .Fn BN_is_one
 102 and
 103 .Fn BN_is_word
 104 test if
 105 .Fa a
 106 equals 0, 1, or
 107 .Fa w
 108 respectively.
 109 .Fn BN_is_odd
 110 tests if a is odd.
 111 .Pp
 112 .Fn BN_is_zero ,
 113 .Fn BN_is_one ,
 114 .Fn BN_is_word ,
 115 and
 116 .Fn BN_is_odd
 117 are macros.
 118 .Sh RETURN VALUES
 119 .Fn BN_cmp
 120 returns -1 if
 121 .Fa a Ns < Ns Fa b ,
 122 0 if
 123 .Fa a Ns == Ns Fa b ,
 124 and 1 if
 125 .Fa a Ns > Ns Fa b .
 126 .Fn BN_ucmp
 127 is the same using the absolute values of
 128 .Fa a
 129 and
 130 .Fa b .
 131 .Pp
 132 .Fn BN_is_zero ,
 133 .Fn BN_is_one ,
 134 .Fn BN_is_word ,
 135 and
 136 .Fn BN_is_odd
 137 return 1 if the condition is true, 0 otherwise.
 138 .Sh SEE ALSO
 139 .Xr BN_new 3
 140 .Sh HISTORY
 141 .Fn BN_cmp ,
 142 .Fn BN_ucmp ,
 143 .Fn BN_is_zero ,
 144 .Fn BN_is_one ,
 145 and
 146 .Fn BN_is_word
 147 first appeared in SSLeay 0.5.1.
 148 .Fn BN_is_odd
 149 first appeared in SSLeay 0.8.0.
 150 All these functions have been available since
 151 .Ox 2.4 .