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 /** Allocates and initialize a ECDSA_SIG structure
  79  *  \return pointer to a ECDSA_SIG structure or NULL if an error occurred
  80  */
  81 ECDSA_SIG *ECDSA_SIG_new(void);
  82
  83 /** frees a ECDSA_SIG structure
  84  *  \param  sig  pointer to the ECDSA_SIG structure
  85  */
  86 void ECDSA_SIG_free(ECDSA_SIG *sig);
  87
  88 /** DER encode content of ECDSA_SIG object (note: this function modifies *pp
  89  *  (*pp += length of the DER encoded signature)).
  90  *  \param  sig  pointer to the ECDSA_SIG object
  91  *  \param  pp   pointer to a unsigned char pointer for the output or NULL
  92  *  \return the length of the DER encoded ECDSA_SIG object or 0
  93  */
  94 int i2d_ECDSA_SIG(const ECDSA_SIG *sig, unsigned char **pp);
  95
  96 /** Decodes a DER encoded ECDSA signature (note: this function changes *pp
  97  *  (*pp += len)).
  98  *  \param  sig  pointer to ECDSA_SIG pointer (may be NULL)
  99  *  \param  pp   memory buffer with the DER encoded signature
 100  *  \param  len  length of the buffer
 101  *  \return pointer to the decoded ECDSA_SIG structure (or NULL)
 102  */
 103 ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **sig, const unsigned char **pp, long len);
 104
 105 /** Computes the ECDSA signature of the given hash value using
 106  *  the supplied private key and returns the created signature.
 107  *  \param  dgst      pointer to the hash value
 108  *  \param  dgst_len  length of the hash value
 109  *  \param  eckey     EC_KEY object containing a private EC key
 110  *  \return pointer to a ECDSA_SIG structure or NULL if an error occurred
 111  */
 112 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, int dgst_len,
 113                          EC_KEY *eckey);
 114
 115 /** Computes ECDSA signature of a given hash value using the supplied
 116  *  private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
 117  *  \param  dgst     pointer to the hash value to sign
 118  *  \param  dgstlen  length of the hash value
 119  *  \param  kinv     BIGNUM with a pre-computed inverse k (optional)
 120  *  \param  rp       BIGNUM with a pre-computed rp value (optioanl),
 121  *                   see ECDSA_sign_setup
 122  *  \param  eckey    EC_KEY object containing a private EC key
 123  *  \return pointer to a ECDSA_SIG structure or NULL if an error occurred
 124  */
 125 ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen,
 126                             const BIGNUM *kinv, const BIGNUM *rp,
 127                             EC_KEY *eckey);
 128
 129 /** Verifies that the supplied signature is a valid ECDSA
 130  *  signature of the supplied hash value using the supplied public key.
 131  *  \param  dgst      pointer to the hash value
 132  *  \param  dgst_len  length of the hash value
 133  *  \param  sig       ECDSA_SIG structure
 134  *  \param  eckey     EC_KEY object containing a public EC key
 135  *  \return 1 if the signature is valid, 0 if the signature is invalid
 136  *          and -1 on error
 137  */
 138 int ECDSA_do_verify(const unsigned char *dgst, int dgst_len,
 139                     const ECDSA_SIG *sig, EC_KEY *eckey);
 140
 141 const ECDSA_METHOD *ECDSA_OpenSSL(void);
 142
 143 /** Sets the default ECDSA method
 144  *  \param  meth  new default ECDSA_METHOD
 145  */
 146 void ECDSA_set_default_method(const ECDSA_METHOD *meth);
 147
 148 /** Returns the default ECDSA method
 149  *  \return pointer to ECDSA_METHOD structure containing the default method
 150  */
 151 const ECDSA_METHOD *ECDSA_get_default_method(void);
 152
 153 /** Sets method to be used for the ECDSA operations
 154  *  \param  eckey  EC_KEY object
 155  *  \param  meth   new method
 156  *  \return 1 on success and 0 otherwise
 157  */
 158 int ECDSA_set_method(EC_KEY *eckey, const ECDSA_METHOD *meth);
 159
 160 /** Returns the maximum length of the DER encoded signature
 161  *  \param  eckey  EC_KEY object
 162  *  \return numbers of bytes required for the DER encoded signature
 163  */
 164 int ECDSA_size(const EC_KEY *eckey);
 165
 166 /** Precompute parts of the signing operation
 167  *  \param  eckey  EC_KEY object containing a private EC key
 168  *  \param  ctx    BN_CTX object (optional)
 169  *  \param  kinv   BIGNUM pointer for the inverse of k
 170  *  \param  rp     BIGNUM pointer for x coordinate of k * generator
 171  *  \return 1 on success and 0 otherwise
 172  */
 173 int ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **rp);
 174
 175 /** Computes ECDSA signature of a given hash value using the supplied
 176  *  private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
 177  *  \param  type     this parameter is ignored
 178  *  \param  dgst     pointer to the hash value to sign
 179  *  \param  dgstlen  length of the hash value
 180  *  \param  sig      memory for the DER encoded created signature
 181  *  \param  siglen   pointer to the length of the returned signature
 182  *  \param  eckey    EC_KEY object containing a private EC key
 183  *  \return 1 on success and 0 otherwise
 184  */
 185 int ECDSA_sign(int type, const unsigned char *dgst, int dgstlen,
 186                unsigned char *sig, unsigned int *siglen, EC_KEY *eckey);
 187
 188 /** Computes ECDSA signature of a given hash value using the supplied
 189  *  private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
 190  *  \param  type     this parameter is ignored
 191  *  \param  dgst     pointer to the hash value to sign
 192  *  \param  dgstlen  length of the hash value
 193  *  \param  sig      buffer to hold the DER encoded signature
 194  *  \param  siglen   pointer to the length of the returned signature
 195  *  \param  kinv     BIGNUM with a pre-computed inverse k (optional)
 196  *  \param  rp       BIGNUM with a pre-computed rp value (optioanl),
 197  *                   see ECDSA_sign_setup
 198  *  \param  eckey    EC_KEY object containing a private EC key
 199  *  \return 1 on success and 0 otherwise
 200  */
 201 int ECDSA_sign_ex(int type, const unsigned char *dgst, int dgstlen,
 202                   unsigned char *sig, unsigned int *siglen,
 203                   const BIGNUM *kinv, const BIGNUM *rp, EC_KEY *eckey);
 204
 205 /** Verifies that the given signature is valid ECDSA signature
 206  *  of the supplied hash value using the specified public key.
 207  *  \param  type     this parameter is ignored
 208  *  \param  dgst     pointer to the hash value
 209  *  \param  dgstlen  length of the hash value
 210  *  \param  sig      pointer to the DER encoded signature
 211  *  \param  siglen   length of the DER encoded signature
 212  *  \param  eckey    EC_KEY object containing a public EC key
 213  *  \return 1 if the signature is valid, 0 if the signature is invalid
 214  *          and -1 on error
 215  */
 216 int ECDSA_verify(int type, const unsigned char *dgst, int dgstlen,
 217                  const unsigned char *sig, int siglen, EC_KEY *eckey);
 218
 219 /* the standard ex_data functions */
 220 #define ECDSA_get_ex_new_index(l, p, newf, dupf, freef) \
 221     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_ECDSA, l, p, newf, dupf, freef)
 222 int ECDSA_set_ex_data(EC_KEY *d, int idx, void *arg);
 223 void *ECDSA_get_ex_data(EC_KEY *d, int idx);
 224
 225 /** Allocates and initialize a ECDSA_METHOD structure
 226  *  \param ecdsa_method pointer to ECDSA_METHOD to copy.  (May be NULL)
 227  *  \return pointer to a ECDSA_METHOD structure or NULL if an error occurred
 228  */
 229
 230 ECDSA_METHOD *ECDSA_METHOD_new(const ECDSA_METHOD *ecdsa_method);
 231
 232 /** frees a ECDSA_METHOD structure
 233  *  \param  ecdsa_method  pointer to the ECDSA_METHOD structure
 234  */
 235 void ECDSA_METHOD_free(ECDSA_METHOD *ecdsa_method);
 236
 237 /**  Sets application specific data in the ECDSA_METHOD
 238  *   \param  ecdsa_method pointer to existing ECDSA_METHOD
 239  *   \param  app application specific data to set
 240  */
 241
 242 void ECDSA_METHOD_set_app_data(ECDSA_METHOD *ecdsa_method, void *app);
 243
 244 /** Returns application specific data from a ECDSA_METHOD structure
 245  *  \param ecdsa_method pointer to ECDSA_METHOD structure
 246  *  \return pointer to application specific data.
 247  */
 248
 249 void *ECDSA_METHOD_get_app_data(ECDSA_METHOD *ecdsa_method);
 250
 251 /**  Set the ECDSA_do_sign function in the ECDSA_METHOD
 252  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 253  *   \param  ecdsa_do_sign a funtion of type ECDSA_do_sign
 254  */
 255
 256 void ECDSA_METHOD_set_sign(ECDSA_METHOD *ecdsa_method,
 257                            ECDSA_SIG *(*ecdsa_do_sign) (const unsigned char
 258                                                         *dgst, int dgst_len,
 259                                                         const BIGNUM *inv,
 260                                                         const BIGNUM *rp,
 261                                                         EC_KEY *eckey));
 262
 263 /**  Set the  ECDSA_sign_setup function in the ECDSA_METHOD
 264  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 265  *   \param  ecdsa_sign_setup a funtion of type ECDSA_sign_setup
 266  */
 267
 268 void ECDSA_METHOD_set_sign_setup(ECDSA_METHOD *ecdsa_method,
 269                                  int (*ecdsa_sign_setup) (EC_KEY *eckey,
 270                                                           BN_CTX *ctx,
 271                                                           BIGNUM **kinv,
 272                                                           BIGNUM **r));
 273
 274 /**  Set the ECDSA_do_verify function in the ECDSA_METHOD
 275  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 276  *   \param  ecdsa_do_verify a funtion of type ECDSA_do_verify
 277  */
 278
 279 void ECDSA_METHOD_set_verify(ECDSA_METHOD *ecdsa_method,
 280                              int (*ecdsa_do_verify) (const unsigned char
 281                                                      *dgst, int dgst_len,
 282                                                      const ECDSA_SIG *sig,
 283                                                      EC_KEY *eckey));
 284
 285 void ECDSA_METHOD_set_flags(ECDSA_METHOD *ecdsa_method, int flags);
 286
 287 /**  Set the flags field in the ECDSA_METHOD
 288  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 289  *   \param  flags flags value to set
 290  */
 291
 292 void ECDSA_METHOD_set_name(ECDSA_METHOD *ecdsa_method, char *name);
 293
 294 /**  Set the name field in the ECDSA_METHOD
 295  *   \param  ecdsa_method  pointer to existing ECDSA_METHOD
 296  *   \param  name name to set
 297  */
 298
 299 /* BEGIN ERROR CODES */
 300 /*
 301  * The following lines are auto generated by the script mkerr.pl. Any changes
 302  * made after this point may be overwritten when the script is next run.
 303  */
 304 void ERR_load_ECDSA_strings(void);
 305
 306 /* Error codes for the ECDSA functions. */
 307
 308 /* Function codes. */
 309 # define ECDSA_F_ECDSA_DATA_NEW_METHOD                    100
 310 # define ECDSA_F_ECDSA_DO_SIGN                            101
 311 # define ECDSA_F_ECDSA_DO_VERIFY                          102
 312 # define ECDSA_F_ECDSA_METHOD_NEW                         105
 313 # define ECDSA_F_ECDSA_SIGN_SETUP                         103
 314
 315 /* Reason codes. */
 316 # define ECDSA_R_BAD_SIGNATURE                            100
 317 # define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE              101
 318 # define ECDSA_R_ERR_EC_LIB                               102
 319 # define ECDSA_R_MISSING_PARAMETERS                       103
 320 # define ECDSA_R_NEED_NEW_SETUP_VALUES                    106
 321 # define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED          104
 322 # define ECDSA_R_SIGNATURE_MALLOC_FAILED                  105
 323
 324 #ifdef  __cplusplus
 325 }
 326 #endif
 327 #endif