include/openssl/ecdsa.h

   1 /* crypto/ecdsa/ecdsa.h */
   2 /**
   3  * \file   crypto/ecdsa/ecdsa.h Include file for the OpenSSL ECDSA functions
   4  * \author Written by Nils Larsch for the OpenSSL project
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 2000-2005 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    licensing@OpenSSL.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59 #ifndef HEADER_ECDSA_H
  60 # define HEADER_ECDSA_H
  61
  62 # include <openssl/opensslconf.h>
  63
  64 # ifdef OPENSSL_NO_EC
  65 #  error EC is disabled.
  66 # endif
  67
  68 # include <openssl/ec.h>
  69 # include <openssl/ossl_typ.h>
  70 # ifdef OPENSSL_USE_DEPRECATED
  71 #  include <openssl/bn.h>
  72 # endif
  73
  74 #ifdef __cplusplus
  75 extern "C" {
  76 #endif
  77
  78 /** Computes the ECDSA signature of the given hash value using
  79  *  the supplied private key and returns the created signature.
  80  *  \param  dgst      pointer to the hash value
  81  *  \param  dgst_len  length of the hash value
  82  *  \param  eckey     EC_KEY object containing a private EC key
  83  *  \return pointer to a ECDSA_SIG structure or NULL if an error occurred
  84  */
  85 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, int dgst_len,
  86                          EC_KEY *eckey);
  87
  88 /** Computes ECDSA signature of a given hash value using the supplied
  89  *  private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
  90  *  \param  dgst     pointer to the hash value to sign
  91  *  \param  dgstlen  length of the hash value
  92  *  \param  kinv     BIGNUM with a pre-computed inverse k (optional)
  93  *  \param  rp       BIGNUM with a pre-computed rp value (optioanl),
  94  *                   see ECDSA_sign_setup
  95  *  \param  eckey    EC_KEY object containing a private EC key
  96  *  \return pointer to a ECDSA_SIG structure or NULL if an error occurred
  97  */
  98 ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen,
  99                             const BIGNUM *kinv, const BIGNUM *rp,
 100                             EC_KEY *eckey);
 101
 102 /** Verifies that the supplied signature is a valid ECDSA
 103  *  signature of the supplied hash value using the supplied public key.
 104  *  \param  dgst      pointer to the hash value
 105  *  \param  dgst_len  length of the hash value
 106  *  \param  sig       ECDSA_SIG structure
 107  *  \param  eckey     EC_KEY object containing a public EC key
 108  *  \return 1 if the signature is valid, 0 if the signature is invalid
 109  *          and -1 on error
 110  */
 111 int ECDSA_do_verify(const unsigned char *dgst, int dgst_len,
 112                     const ECDSA_SIG *sig, EC_KEY *eckey);
 113
 114 const ECDSA_METHOD *ECDSA_OpenSSL(void);
 115
 116 /** Sets the default ECDSA method
 117  *  \param  meth  new default ECDSA_METHOD
 118  */
 119 void ECDSA_set_default_method(const ECDSA_METHOD *meth);
 120
 121 /** Returns the default ECDSA method
 122  *  \return pointer to ECDSA_METHOD structure containing the default method
 123  */
 124 const ECDSA_METHOD *ECDSA_get_default_method(void);
 125
 126 /** Sets method to be used for the ECDSA operations
 127  *  \param  eckey  EC_KEY object
 128  *  \param  meth   new method
 129  *  \return 1 on success and 0 otherwise
 130  */
 131 int ECDSA_set_method(EC_KEY *eckey, const ECDSA_METHOD *meth);
 132
 133 /** Returns the maximum length of the DER encoded signature
 134  *  \param  eckey  EC_KEY object
 135  *  \return numbers of bytes required for the DER encoded signature
 136  */
 137 int ECDSA_size(const EC_KEY *eckey);
 138
 139 /* the standard ex_data functions */
 140 #define ECDSA_get_ex_new_index(l, p, newf, dupf, freef) \
 141     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ECDSA, l, p, newf, dupf, freef)
 142 int ECDSA_set_ex_data(EC_KEY *d, int idx, void *arg);
 143 void *ECDSA_get_ex_data(EC_KEY *d, int idx);
 144
 145 /** Allocates and initialize a ECDSA_METHOD structure
 146  *  \param ecdsa_method pointer to ECDSA_METHOD to copy.  (May be NULL)
 147  *  \return pointer to a ECDSA_METHOD structure or NULL if an error occurred
 148  */
 149
 150 ECDSA_METHOD *ECDSA_METHOD_new(const ECDSA_METHOD *ecdsa_method);
 151
 152 /** frees a ECDSA_METHOD structure
 153  *  \param  ecdsa_method  pointer to the ECDSA_METHOD structure
 154  */
 155 void ECDSA_METHOD_free(ECDSA_METHOD *ecdsa_method);
 156
 157 /**  Sets application specific data in the ECDSA_METHOD
 158  *   \param  ecdsa_method pointer to existing ECDSA_METHOD
 159  *   \param  app application specific data to set
 160  */
 161
 162 void ECDSA_METHOD_set_app_data(ECDSA_METHOD *ecdsa_method, void *app);
 163
 164 /** Returns application specific data from a ECDSA_METHOD structure
 165  *  \param ecdsa_method pointer to ECDSA_METHOD structure
 166  *  \return pointer to application specific data.
 167  */
 168
 169 void *ECDSA_METHOD_get_app_data(ECDSA_METHOD *ecdsa_method);
 170
 171 /**  Set the ECDSA_do_sign function in the ECDSA_METHOD
 172  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 173  *   \param  ecdsa_do_sign a funtion of type ECDSA_do_sign
 174  */
 175
 176 void ECDSA_METHOD_set_sign(ECDSA_METHOD *ecdsa_method,
 177                            ECDSA_SIG *(*ecdsa_do_sign) (const unsigned char
 178                                                         *dgst, int dgst_len,
 179                                                         const BIGNUM *inv,
 180                                                         const BIGNUM *rp,
 181                                                         EC_KEY *eckey));
 182
 183 /**  Set the  ECDSA_sign_setup function in the ECDSA_METHOD
 184  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 185  *   \param  ecdsa_sign_setup a funtion of type ECDSA_sign_setup
 186  */
 187
 188 void ECDSA_METHOD_set_sign_setup(ECDSA_METHOD *ecdsa_method,
 189                                  int (*ecdsa_sign_setup) (EC_KEY *eckey,
 190                                                           BN_CTX *ctx,
 191                                                           BIGNUM **kinv,
 192                                                           BIGNUM **r));
 193
 194 /**  Set the ECDSA_do_verify function in the ECDSA_METHOD
 195  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 196  *   \param  ecdsa_do_verify a funtion of type ECDSA_do_verify
 197  */
 198
 199 void ECDSA_METHOD_set_verify(ECDSA_METHOD *ecdsa_method,
 200                              int (*ecdsa_do_verify) (const unsigned char
 201                                                      *dgst, int dgst_len,
 202                                                      const ECDSA_SIG *sig,
 203                                                      EC_KEY *eckey));
 204
 205 void ECDSA_METHOD_set_flags(ECDSA_METHOD *ecdsa_method, int flags);
 206
 207 /**  Set the flags field in the ECDSA_METHOD
 208  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 209  *   \param  flags flags value to set
 210  */
 211
 212 void ECDSA_METHOD_set_name(ECDSA_METHOD *ecdsa_method, char *name);
 213
 214 /**  Set the name field in the ECDSA_METHOD
 215  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 216  *   \param  name name to set
 217  */
 218
 219 /* BEGIN ERROR CODES */
 220 /*
 221  * The following lines are auto generated by the script mkerr.pl. Any changes
 222  * made after this point may be overwritten when the script is next run.
 223  */
 224 void ERR_load_ECDSA_strings(void);
 225
 226 /* Error codes for the ECDSA functions. */
 227
 228 /* Function codes. */
 229 # define ECDSA_F_ECDSA_DATA_NEW_METHOD                    100
 230 # define ECDSA_F_ECDSA_DO_SIGN                            101
 231 # define ECDSA_F_ECDSA_DO_VERIFY                          102
 232 # define ECDSA_F_ECDSA_METHOD_NEW                         105
 233 # define ECDSA_F_ECDSA_SIGN_SETUP                         103
 234
 235 /* Reason codes. */
 236 # define ECDSA_R_BAD_SIGNATURE                            100
 237 # define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE              101
 238 # define ECDSA_R_ERR_EC_LIB                               102
 239 # define ECDSA_R_MISSING_PARAMETERS                       103
 240 # define ECDSA_R_NEED_NEW_SETUP_VALUES                    106
 241 # define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED          104
 242 # define ECDSA_R_SIGNATURE_MALLOC_FAILED                  105
 243
 244 #ifdef  __cplusplus
 245 }
 246 #endif
 247 #endif