crypto/openssl/crypto/ecdsa/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-2003 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_ECDSA
  65 #  error ECDSA is disabled.
  66 # endif
  67
  68 # include <openssl/ec.h>
  69 # include <openssl/ossl_typ.h>
  70 # ifndef OPENSSL_NO_DEPRECATED
  71 #  include <openssl/bn.h>
  72 # endif
  73
  74 #ifdef __cplusplus
  75 extern "C" {
  76 #endif
  77
  78 typedef struct ECDSA_SIG_st {
  79     BIGNUM *r;
  80     BIGNUM *s;
  81 } ECDSA_SIG;
  82
  83 /** ECDSA_SIG *ECDSA_SIG_new(void)
  84  * allocates and initialize a ECDSA_SIG structure
  85  * \return pointer to a ECDSA_SIG structure or NULL if an error occurred
  86  */
  87 ECDSA_SIG *ECDSA_SIG_new(void);
  88
  89 /** ECDSA_SIG_free
  90  * frees a ECDSA_SIG structure
  91  * \param a pointer to the ECDSA_SIG structure
  92  */
  93 void ECDSA_SIG_free(ECDSA_SIG *a);
  94
  95 /** i2d_ECDSA_SIG
  96  * DER encode content of ECDSA_SIG object (note: this function modifies *pp
  97  * (*pp += length of the DER encoded signature)).
  98  * \param a  pointer to the ECDSA_SIG object
  99  * \param pp pointer to a unsigned char pointer for the output or NULL
 100  * \return the length of the DER encoded ECDSA_SIG object or 0
 101  */
 102 int i2d_ECDSA_SIG(const ECDSA_SIG *a, unsigned char **pp);
 103
 104 /** d2i_ECDSA_SIG
 105  * decodes a DER encoded ECDSA signature (note: this function changes *pp
 106  * (*pp += len)).
 107  * \param v pointer to ECDSA_SIG pointer (may be NULL)
 108  * \param pp buffer with the DER encoded signature
 109  * \param len bufferlength
 110  * \return pointer to the decoded ECDSA_SIG structure (or NULL)
 111  */
 112 ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **v, const unsigned char **pp, long len);
 113
 114 /** ECDSA_do_sign
 115  * computes the ECDSA signature of the given hash value using
 116  * the supplied private key and returns the created signature.
 117  * \param dgst pointer to the hash value
 118  * \param dgst_len length of the hash value
 119  * \param eckey pointer to the EC_KEY object containing a private EC key
 120  * \return pointer to a ECDSA_SIG structure or NULL
 121  */
 122 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, int dgst_len,
 123                          EC_KEY *eckey);
 124
 125 /** ECDSA_do_sign_ex
 126  * computes ECDSA signature of a given hash value using the supplied
 127  * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
 128  * \param dgst pointer to the hash value to sign
 129  * \param dgstlen length of the hash value
 130  * \param kinv optional pointer to a pre-computed inverse k
 131  * \param rp optional pointer to the pre-computed rp value (see
 132  *        ECDSA_sign_setup
 133  * \param eckey pointer to the EC_KEY object containing a private EC key
 134  * \return pointer to a ECDSA_SIG structure or NULL
 135  */
 136 ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen,
 137                             const BIGNUM *kinv, const BIGNUM *rp,
 138                             EC_KEY *eckey);
 139
 140 /** ECDSA_do_verify
 141  * verifies that the supplied signature is a valid ECDSA
 142  * signature of the supplied hash value using the supplied public key.
 143  * \param dgst pointer to the hash value
 144  * \param dgst_len length of the hash value
 145  * \param sig  pointer to the ECDSA_SIG structure
 146  * \param eckey pointer to the EC_KEY object containing a public EC key
 147  * \return 1 if the signature is valid, 0 if the signature is invalid and -1 on error
 148  */
 149 int ECDSA_do_verify(const unsigned char *dgst, int dgst_len,
 150                     const ECDSA_SIG *sig, EC_KEY *eckey);
 151
 152 const ECDSA_METHOD *ECDSA_OpenSSL(void);
 153
 154 /** ECDSA_set_default_method
 155  * sets the default ECDSA method
 156  * \param meth the new default ECDSA_METHOD
 157  */
 158 void ECDSA_set_default_method(const ECDSA_METHOD *meth);
 159
 160 /** ECDSA_get_default_method
 161  * returns the default ECDSA method
 162  * \return pointer to ECDSA_METHOD structure containing the default method
 163  */
 164 const ECDSA_METHOD *ECDSA_get_default_method(void);
 165
 166 /** ECDSA_set_method
 167  * sets method to be used for the ECDSA operations
 168  * \param eckey pointer to the EC_KEY object
 169  * \param meth  pointer to the new method
 170  * \return 1 on success and 0 otherwise
 171  */
 172 int ECDSA_set_method(EC_KEY *eckey, const ECDSA_METHOD *meth);
 173
 174 /** ECDSA_size
 175  * returns the maximum length of the DER encoded signature
 176  * \param  eckey pointer to a EC_KEY object
 177  * \return numbers of bytes required for the DER encoded signature
 178  */
 179 int ECDSA_size(const EC_KEY *eckey);
 180
 181 /** ECDSA_sign_setup
 182  * precompute parts of the signing operation.
 183  * \param eckey pointer to the EC_KEY object containing a private EC key
 184  * \param ctx  pointer to a BN_CTX object (may be NULL)
 185  * \param kinv pointer to a BIGNUM pointer for the inverse of k
 186  * \param rp   pointer to a BIGNUM pointer for x coordinate of k * generator
 187  * \return 1 on success and 0 otherwise
 188  */
 189 int ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **rp);
 190
 191 /** ECDSA_sign
 192  * computes ECDSA signature of a given hash value using the supplied
 193  * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
 194  * \param type this parameter is ignored
 195  * \param dgst pointer to the hash value to sign
 196  * \param dgstlen length of the hash value
 197  * \param sig buffer to hold the DER encoded signature
 198  * \param siglen pointer to the length of the returned signature
 199  * \param eckey pointer to the EC_KEY object containing a private EC key
 200  * \return 1 on success and 0 otherwise
 201  */
 202 int ECDSA_sign(int type, const unsigned char *dgst, int dgstlen,
 203                unsigned char *sig, unsigned int *siglen, EC_KEY *eckey);
 204
 205 /** ECDSA_sign_ex
 206  * computes ECDSA signature of a given hash value using the supplied
 207  * private key (note: sig must point to ECDSA_size(eckey) bytes of memory).
 208  * \param type this parameter is ignored
 209  * \param dgst pointer to the hash value to sign
 210  * \param dgstlen length of the hash value
 211  * \param sig buffer to hold the DER encoded signature
 212  * \param siglen pointer to the length of the returned signature
 213  * \param kinv optional pointer to a pre-computed inverse k
 214  * \param rp optional pointer to the pre-computed rp value (see
 215  *        ECDSA_sign_setup
 216  * \param eckey pointer to the EC_KEY object containing a private EC key
 217  * \return 1 on success and 0 otherwise
 218  */
 219 int ECDSA_sign_ex(int type, const unsigned char *dgst, int dgstlen,
 220                   unsigned char *sig, unsigned int *siglen,
 221                   const BIGNUM *kinv, const BIGNUM *rp, EC_KEY *eckey);
 222
 223 /** ECDSA_verify
 224  * verifies that the given signature is valid ECDSA signature
 225  * of the supplied hash value using the specified public key.
 226  * \param type this parameter is ignored
 227  * \param dgst pointer to the hash value
 228  * \param dgstlen length of the hash value
 229  * \param sig  pointer to the DER encoded signature
 230  * \param siglen length of the DER encoded signature
 231  * \param eckey pointer to the EC_KEY object containing a public EC key
 232  * \return 1 if the signature is valid, 0 if the signature is invalid and -1 on error
 233  */
 234 int ECDSA_verify(int type, const unsigned char *dgst, int dgstlen,
 235                  const unsigned char *sig, int siglen, EC_KEY *eckey);
 236
 237 /* the standard ex_data functions */
 238 int ECDSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new
 239                            *new_func, CRYPTO_EX_dup *dup_func,
 240                            CRYPTO_EX_free *free_func);
 241 int ECDSA_set_ex_data(EC_KEY *d, int idx, void *arg);
 242 void *ECDSA_get_ex_data(EC_KEY *d, int idx);
 243
 244 /* BEGIN ERROR CODES */
 245 /*
 246  * The following lines are auto generated by the script mkerr.pl. Any changes
 247  * made after this point may be overwritten when the script is next run.
 248  */
 249 void ERR_load_ECDSA_strings(void);
 250
 251 /* Error codes for the ECDSA functions. */
 252
 253 /* Function codes. */
 254 # define ECDSA_F_ECDSA_DATA_NEW_METHOD                    100
 255 # define ECDSA_F_ECDSA_DO_SIGN                            101
 256 # define ECDSA_F_ECDSA_DO_VERIFY                          102
 257 # define ECDSA_F_ECDSA_SIGN_SETUP                         103
 258
 259 /* Reason codes. */
 260 # define ECDSA_R_BAD_SIGNATURE                            100
 261 # define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE              101
 262 # define ECDSA_R_ERR_EC_LIB                               102
 263 # define ECDSA_R_MISSING_PARAMETERS                       103
 264 # define ECDSA_R_NEED_NEW_SETUP_VALUES                    106
 265 # define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED          104
 266 # define ECDSA_R_SIGNATURE_MALLOC_FAILED                  105
 267
 268 #ifdef  __cplusplus
 269 }
 270 #endif
 271 #endif