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