crypto/include/internal/bn_int.h

   1 /* ====================================================================
   2  * Copyright (c) 1998-2014 The OpenSSL Project.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in
  13  *    the documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  * 3. All advertising materials mentioning features or use of this
  17  *    software must display the following acknowledgment:
  18  *    "This product includes software developed by the OpenSSL Project
  19  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  20  *
  21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  22  *    endorse or promote products derived from this software without
  23  *    prior written permission. For written permission, please contact
  24  *    openssl-core@openssl.org.
  25  *
  26  * 5. Products derived from this software may not be called "OpenSSL"
  27  *    nor may "OpenSSL" appear in their names without prior written
  28  *    permission of the OpenSSL Project.
  29  *
  30  * 6. Redistributions of any form whatsoever must retain the following
  31  *    acknowledgment:
  32  *    "This product includes software developed by the OpenSSL Project
  33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  46  * OF THE POSSIBILITY OF SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This product includes cryptographic software written by Eric Young
  50  * (eay@cryptsoft.com).  This product includes software written by Tim
  51  * Hudson (tjh@cryptsoft.com).
  52  *
  53  */
  54
  55 #ifndef HEADER_BN_INT_H
  56 #define HEADER_BN_INT_H
  57
  58
  59 #include <openssl/bn.h>
  60
  61 #ifdef  __cplusplus
  62 extern "C" {
  63 #endif
  64
  65 #define bn_expand(a,bits) ((((((bits+BN_BITS2-1))/BN_BITS2)) <= (a)->dmax)?\
  66         (a):bn_expand2((a),(bits+BN_BITS2-1)/BN_BITS2))
  67 BIGNUM *bn_wexpand(BIGNUM *a, int words);
  68 BIGNUM *bn_expand2(BIGNUM *a, int words);
  69
  70 void bn_correct_top(BIGNUM *a);
  71
  72 /* Determine the modified width-(w+1) Non-Adjacent Form (wNAF) of 'scalar'.
  73  * This is an array  r[]  of values that are either zero or odd with an
  74  * absolute value less than  2^w  satisfying
  75  *     scalar = \sum_j r[j]*2^j
  76  * where at most one of any  w+1  consecutive digits is non-zero
  77  * with the exception that the most significant digit may be only
  78  * w-1 zeros away from that next non-zero digit.
  79  */
  80 signed char *bn_compute_wNAF(const BIGNUM *scalar, int w, size_t *ret_len);
  81
  82 int bn_get_top(const BIGNUM *a);
  83
  84 void bn_set_top(BIGNUM *a, int top);
  85
  86 int bn_get_dmax(const BIGNUM *a);
  87
  88 /* Set all words to zero */
  89 void bn_set_all_zero(BIGNUM *a);
  90
  91 /*
  92  * Copy the internal BIGNUM words into out which holds size elements (and size
  93  * must be bigger than top)
  94  */
  95 int bn_copy_words(BN_ULONG *out, const BIGNUM *in, int size);
  96
  97 BN_ULONG *bn_get_words(const BIGNUM *a);
  98
  99 /*
 100  * Set the internal data words in a to point to words which contains size
 101  * elements. The BN_FLG_STATIC_DATA flag is set
 102  */
 103 void bn_set_static_words(BIGNUM *a, BN_ULONG *words, int size);
 104
 105 /*
 106  * Copy data into the BIGNUM. The caller must check that dmax is sufficient to
 107  * hold the data
 108  */
 109 void bn_set_data(BIGNUM *a, const void *data, size_t size);
 110
 111 size_t bn_sizeof_BIGNUM(void);
 112
 113 /*
 114  * Return element el from an array of BIGNUMs starting at base (required
 115  * because callers do not know the size of BIGNUM at compilation time)
 116  */
 117 BIGNUM *bn_array_el(BIGNUM *base, int el);
 118
 119
 120 #ifdef  __cplusplus
 121 }
 122 #endif
 123
 124 #endif
 125