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