crypto/ecdh/ecdh.h

   1 /* crypto/ecdh/ecdh.h */
   2 /* ====================================================================
   3  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
   4  *
   5  * The Elliptic Curve Public-Key Crypto Library (ECC Code) included
   6  * herein is developed by SUN MICROSYSTEMS, INC., and is contributed
   7  * to the OpenSSL project.
   8  *
   9  * The ECC Code is licensed pursuant to the OpenSSL open source
  10  * license provided below.
  11  *
  12  * In addition, Sun covenants to all licensees who provide a reciprocal
  13  * covenant with respect to their own patents if any, not to sue under
  14  * current and future patent claims necessarily infringed by the making,
  15  * using, practicing, selling, offering for sale and/or otherwise
  16  * disposing of the ECC Code as delivered hereunder (or portions thereof),
  17  * provided that such covenant shall not apply:
  18  *  1) for code that a licensee deletes from the ECC Code;
  19  *  2) separates from the ECC Code; or
  20  *  3) for infringements caused by:
  21  *       i) the modification of the ECC Code or
  22  *      ii) the combination of the ECC Code with other software or
  23  *          devices where such combination causes the infringement.
  24  *
  25  * The ECDH software is originally written by Douglas Stebila of
  26  * Sun Microsystems Laboratories.
  27  *
  28  */
  29 /* ====================================================================
  30  * Copyright (c) 2000-2002 The OpenSSL Project.  All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  *
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  *
  39  * 2. Redistributions in binary form must reproduce the above copyright
  40  *    notice, this list of conditions and the following disclaimer in
  41  *    the documentation and/or other materials provided with the
  42  *    distribution.
  43  *
  44  * 3. All advertising materials mentioning features or use of this
  45  *    software must display the following acknowledgment:
  46  *    "This product includes software developed by the OpenSSL Project
  47  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  48  *
  49  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  50  *    endorse or promote products derived from this software without
  51  *    prior written permission. For written permission, please contact
  52  *    licensing@OpenSSL.org.
  53  *
  54  * 5. Products derived from this software may not be called "OpenSSL"
  55  *    nor may "OpenSSL" appear in their names without prior written
  56  *    permission of the OpenSSL Project.
  57  *
  58  * 6. Redistributions of any form whatsoever must retain the following
  59  *    acknowledgment:
  60  *    "This product includes software developed by the OpenSSL Project
  61  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  62  *
  63  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  64  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  65  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  66  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  67  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  68  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  69  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  70  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  71  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  72  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  73  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  74  * OF THE POSSIBILITY OF SUCH DAMAGE.
  75  * ====================================================================
  76  *
  77  * This product includes cryptographic software written by Eric Young
  78  * (eay@cryptsoft.com).  This product includes software written by Tim
  79  * Hudson (tjh@cryptsoft.com).
  80  *
  81  */
  82 #ifndef HEADER_ECDH_H
  83 #define HEADER_ECDH_H
  84
  85 #ifdef OPENSSL_NO_ECDH
  86 #error ECDH is disabled.
  87 #endif
  88
  89 #include <openssl/bn.h>
  90 #include <openssl/ec.h>
  91 #include <openssl/ossl_typ.h>
  92
  93 #ifdef __cplusplus
  94 extern "C" {
  95 #endif
  96
  97 typedef struct ecdh_method
  98 {
  99         const char *name;
 100         int (*compute_key)(unsigned char *key,const EC_POINT *pub_key, EC_KEY *ecdh);
 101 #if 0
 102         int (*init)(EC_KEY *eckey);
 103         int (*finish)(EC_KEY *eckey);
 104 #endif
 105         int flags;
 106         char *app_data;
 107 } ECDH_METHOD;
 108
 109 typedef struct ecdh_data_st {
 110         /* EC_KEY_METH_DATA part */
 111         int (*init)(EC_KEY *);
 112         void (*finish)(EC_KEY *);
 113         /* method specific part */
 114         ENGINE  *engine;
 115         int     flags;
 116         const ECDH_METHOD *meth;
 117         CRYPTO_EX_DATA ex_data;
 118 } ECDH_DATA;
 119
 120 /* ECDH_DATA functions */
 121 ECDH_DATA *ECDH_DATA_new(void);
 122 ECDH_DATA *ECDH_DATA_new_method(ENGINE *);
 123 void ECDH_DATA_free(ECDH_DATA *);
 124
 125 ECDH_DATA *ecdh_check(EC_KEY *);
 126
 127
 128 const ECDH_METHOD *ECDH_OpenSSL(void);
 129
 130 void      ECDH_set_default_method(const ECDH_METHOD *);
 131 const ECDH_METHOD *ECDH_get_default_method(void);
 132 int       ECDH_set_method(EC_KEY *, const ECDH_METHOD *);
 133
 134 int       ECDH_size(const EC_KEY *);
 135 int ECDH_compute_key(unsigned char *key,const EC_POINT *pub_key, EC_KEY *ecdh);
 136
 137
 138 int       ECDH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new
 139                 *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
 140 int       ECDH_set_ex_data(EC_KEY *d, int idx, void *arg);
 141 void      *ECDH_get_ex_data(EC_KEY *d, int idx);
 142
 143
 144 /* BEGIN ERROR CODES */
 145 /* The following lines are auto generated by the script mkerr.pl. Any changes
 146  * made after this point may be overwritten when the script is next run.
 147  */
 148 void ERR_load_ECDH_strings(void);
 149
 150 /* Error codes for the ECDH functions. */
 151
 152 /* Function codes. */
 153 #define ECDH_F_ECDH_COMPUTE_KEY                          100
 154 #define ECDH_F_ECDH_DATA_NEW                             101
 155
 156 /* Reason codes. */
 157 #define ECDH_R_NO_PRIVATE_VALUE                          100
 158 #define ECDH_R_POINT_ARITHMETIC_FAILURE                  101
 159 #define ECDH_R_SHA1_DIGEST_FAILED                        102
 160
 161 #ifdef  __cplusplus
 162 }
 163 #endif
 164 #endif