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 /** Precompute parts of the signing operation
 140  *  \param  eckey  EC_KEY object containing a private EC key
 141  *  \param  ctx    BN_CTX object (optional)
 142  *  \param  kinv   BIGNUM pointer for the inverse of k
 143  *  \param  rp     BIGNUM pointer for x coordinate of k * generator
 144  *  \return 1 on success and 0 otherwise
 145  */
 146 int ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **rp);
 147
 148 /** Computes ECDSA signature of a given hash value using the supplied
 149  *  private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
 150  *  \param  type     this parameter is ignored
 151  *  \param  dgst     pointer to the hash value to sign
 152  *  \param  dgstlen  length of the hash value
 153  *  \param  sig      memory for the DER encoded created signature
 154  *  \param  siglen   pointer to the length of the returned signature
 155  *  \param  eckey    EC_KEY object containing a private EC key
 156  *  \return 1 on success and 0 otherwise
 157  */
 158 int ECDSA_sign(int type, const unsigned char *dgst, int dgstlen,
 159                unsigned char *sig, unsigned int *siglen, EC_KEY *eckey);
 160
 161 /** Computes ECDSA signature of a given hash value using the supplied
 162  *  private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
 163  *  \param  type     this parameter is ignored
 164  *  \param  dgst     pointer to the hash value to sign
 165  *  \param  dgstlen  length of the hash value
 166  *  \param  sig      buffer to hold the DER encoded signature
 167  *  \param  siglen   pointer to the length of the returned signature
 168  *  \param  kinv     BIGNUM with a pre-computed inverse k (optional)
 169  *  \param  rp       BIGNUM with a pre-computed rp value (optioanl),
 170  *                   see ECDSA_sign_setup
 171  *  \param  eckey    EC_KEY object containing a private EC key
 172  *  \return 1 on success and 0 otherwise
 173  */
 174 int ECDSA_sign_ex(int type, const unsigned char *dgst, int dgstlen,
 175                   unsigned char *sig, unsigned int *siglen,
 176                   const BIGNUM *kinv, const BIGNUM *rp, EC_KEY *eckey);
 177
 178 /** Verifies that the given signature is valid ECDSA signature
 179  *  of the supplied hash value using the specified public key.
 180  *  \param  type     this parameter is ignored
 181  *  \param  dgst     pointer to the hash value
 182  *  \param  dgstlen  length of the hash value
 183  *  \param  sig      pointer to the DER encoded signature
 184  *  \param  siglen   length of the DER encoded signature
 185  *  \param  eckey    EC_KEY object containing a public EC key
 186  *  \return 1 if the signature is valid, 0 if the signature is invalid
 187  *          and -1 on error
 188  */
 189 int ECDSA_verify(int type, const unsigned char *dgst, int dgstlen,
 190                  const unsigned char *sig, int siglen, EC_KEY *eckey);
 191
 192 /* the standard ex_data functions */
 193 #define ECDSA_get_ex_new_index(l, p, newf, dupf, freef) \
 194     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ECDSA, l, p, newf, dupf, freef)
 195 int ECDSA_set_ex_data(EC_KEY *d, int idx, void *arg);
 196 void *ECDSA_get_ex_data(EC_KEY *d, int idx);
 197
 198 /** Allocates and initialize a ECDSA_METHOD structure
 199  *  \param ecdsa_method pointer to ECDSA_METHOD to copy.  (May be NULL)
 200  *  \return pointer to a ECDSA_METHOD structure or NULL if an error occurred
 201  */
 202
 203 ECDSA_METHOD *ECDSA_METHOD_new(const ECDSA_METHOD *ecdsa_method);
 204
 205 /** frees a ECDSA_METHOD structure
 206  *  \param  ecdsa_method  pointer to the ECDSA_METHOD structure
 207  */
 208 void ECDSA_METHOD_free(ECDSA_METHOD *ecdsa_method);
 209
 210 /**  Sets application specific data in the ECDSA_METHOD
 211  *   \param  ecdsa_method pointer to existing ECDSA_METHOD
 212  *   \param  app application specific data to set
 213  */
 214
 215 void ECDSA_METHOD_set_app_data(ECDSA_METHOD *ecdsa_method, void *app);
 216
 217 /** Returns application specific data from a ECDSA_METHOD structure
 218  *  \param ecdsa_method pointer to ECDSA_METHOD structure
 219  *  \return pointer to application specific data.
 220  */
 221
 222 void *ECDSA_METHOD_get_app_data(ECDSA_METHOD *ecdsa_method);
 223
 224 /**  Set the ECDSA_do_sign function in the ECDSA_METHOD
 225  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 226  *   \param  ecdsa_do_sign a funtion of type ECDSA_do_sign
 227  */
 228
 229 void ECDSA_METHOD_set_sign(ECDSA_METHOD *ecdsa_method,
 230                            ECDSA_SIG *(*ecdsa_do_sign) (const unsigned char
 231                                                         *dgst, int dgst_len,
 232                                                         const BIGNUM *inv,
 233                                                         const BIGNUM *rp,
 234                                                         EC_KEY *eckey));
 235
 236 /**  Set the  ECDSA_sign_setup function in the ECDSA_METHOD
 237  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 238  *   \param  ecdsa_sign_setup a funtion of type ECDSA_sign_setup
 239  */
 240
 241 void ECDSA_METHOD_set_sign_setup(ECDSA_METHOD *ecdsa_method,
 242                                  int (*ecdsa_sign_setup) (EC_KEY *eckey,
 243                                                           BN_CTX *ctx,
 244                                                           BIGNUM **kinv,
 245                                                           BIGNUM **r));
 246
 247 /**  Set the ECDSA_do_verify function in the ECDSA_METHOD
 248  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 249  *   \param  ecdsa_do_verify a funtion of type ECDSA_do_verify
 250  */
 251
 252 void ECDSA_METHOD_set_verify(ECDSA_METHOD *ecdsa_method,
 253                              int (*ecdsa_do_verify) (const unsigned char
 254                                                      *dgst, int dgst_len,
 255                                                      const ECDSA_SIG *sig,
 256                                                      EC_KEY *eckey));
 257
 258 void ECDSA_METHOD_set_flags(ECDSA_METHOD *ecdsa_method, int flags);
 259
 260 /**  Set the flags field in the ECDSA_METHOD
 261  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 262  *   \param  flags flags value to set
 263  */
 264
 265 void ECDSA_METHOD_set_name(ECDSA_METHOD *ecdsa_method, char *name);
 266
 267 /**  Set the name field in the ECDSA_METHOD
 268  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 269  *   \param  name name to set
 270  */
 271
 272 /* BEGIN ERROR CODES */
 273 /*
 274  * The following lines are auto generated by the script mkerr.pl. Any changes
 275  * made after this point may be overwritten when the script is next run.
 276  */
 277 void ERR_load_ECDSA_strings(void);
 278
 279 /* Error codes for the ECDSA functions. */
 280
 281 /* Function codes. */
 282 # define ECDSA_F_ECDSA_DATA_NEW_METHOD                    100
 283 # define ECDSA_F_ECDSA_DO_SIGN                            101
 284 # define ECDSA_F_ECDSA_DO_VERIFY                          102
 285 # define ECDSA_F_ECDSA_METHOD_NEW                         105
 286 # define ECDSA_F_ECDSA_SIGN_SETUP                         103
 287
 288 /* Reason codes. */
 289 # define ECDSA_R_BAD_SIGNATURE                            100
 290 # define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE              101
 291 # define ECDSA_R_ERR_EC_LIB                               102
 292 # define ECDSA_R_MISSING_PARAMETERS                       103
 293 # define ECDSA_R_NEED_NEW_SETUP_VALUES                    106
 294 # define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED          104
 295 # define ECDSA_R_SIGNATURE_MALLOC_FAILED                  105
 296
 297 #ifdef  __cplusplus
 298 }
 299 #endif
 300 #endif