crypto/ecdsa/ecdsa.h

   1 /* crypto/ecdsa/ecdsa.h */
   2 /* ====================================================================
   3  * Copyright (c) 2000-2002 The OpenSSL Project.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in
  14  *    the documentation and/or other materials provided with the
  15  *    distribution.
  16  *
  17  * 3. All advertising materials mentioning features or use of this
  18  *    software must display the following acknowledgment:
  19  *    "This product includes software developed by the OpenSSL Project
  20  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  21  *
  22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  23  *    endorse or promote products derived from this software without
  24  *    prior written permission. For written permission, please contact
  25  *    licensing@OpenSSL.org.
  26  *
  27  * 5. Products derived from this software may not be called "OpenSSL"
  28  *    nor may "OpenSSL" appear in their names without prior written
  29  *    permission of the OpenSSL Project.
  30  *
  31  * 6. Redistributions of any form whatsoever must retain the following
  32  *    acknowledgment:
  33  *    "This product includes software developed by the OpenSSL Project
  34  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  35  *
  36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  47  * OF THE POSSIBILITY OF SUCH DAMAGE.
  48  * ====================================================================
  49  *
  50  * This product includes cryptographic software written by Eric Young
  51  * (eay@cryptsoft.com).  This product includes software written by Tim
  52  * Hudson (tjh@cryptsoft.com).
  53  *
  54  */
  55 #ifndef HEADER_ECDSA_H
  56 #define HEADER_ECDSA_H
  57
  58 #ifdef OPENSSL_NO_ECDSA
  59 #error ECDSA is disabled.
  60 #endif
  61
  62 #ifndef OPENSSL_NO_BIO
  63 #include <openssl/bio.h>
  64 #endif
  65 #include <openssl/bn.h>
  66 #include <openssl/ec.h>
  67 #include <openssl/crypto.h>
  68 #include <openssl/ossl_typ.h>
  69 #include <openssl/asn1.h>
  70 #include <openssl/asn1t.h>
  71
  72 #ifdef __cplusplus
  73 extern "C" {
  74 #endif
  75
  76 typedef struct ecdsa_st ECDSA;
  77
  78 typedef struct ECDSA_SIG_st
  79 {
  80         BIGNUM *r;
  81         BIGNUM *s;
  82 } ECDSA_SIG;
  83
  84 typedef struct ecdsa_method
  85 {
  86         const char *name;
  87         ECDSA_SIG *(*ecdsa_do_sign)(const unsigned char *dgst, int dgst_len, ECDSA *ecdsa);
  88         int (*ecdsa_sign_setup)(ECDSA *ecdsa, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **r);
  89         int (*ecdsa_do_verify)(const unsigned char *dgst, int dgst_len, ECDSA_SIG *sig, ECDSA *ecdsa);
  90         int (*init)(ECDSA *ecdsa);
  91         int (*finish)(ECDSA *ecdsa);
  92         int flags;
  93         char *app_data;
  94 } ECDSA_METHOD;
  95
  96 struct ecdsa_st
  97 {
  98         int version;
  99         point_conversion_form_t conversion_form;
 100
 101         EC_GROUP *group;
 102
 103         EC_POINT *pub_key;
 104         BIGNUM   *priv_key;
 105
 106         BIGNUM   *kinv; /* signing pre-calc */
 107         BIGNUM   *r;    /* signing pre-calc */
 108
 109         int     references;
 110         int     flags;
 111         CRYPTO_EX_DATA ex_data;
 112         const ECDSA_METHOD *meth;
 113         struct engine_st *engine;
 114 };
 115
 116 ECDSA_SIG *ECDSA_SIG_new(void);
 117 void      ECDSA_SIG_free(ECDSA_SIG *a);
 118 int       i2d_ECDSA_SIG(const ECDSA_SIG *a, unsigned char **pp);
 119 ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **v, const unsigned char **pp, long length);
 120
 121 ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, int dgst_len, ECDSA *ecdsa);
 122 int       ECDSA_do_verify(const unsigned char *dgst, int dgst_len, ECDSA_SIG *sig, ECDSA* ecdsa);
 123 int       ECDSA_generate_key(ECDSA *ecdsa);
 124 int       ECDSA_check_key(ECDSA *ecdsa);
 125
 126 const ECDSA_METHOD *ECDSA_OpenSSL(void);
 127
 128 void      ECDSA_set_default_method(const ECDSA_METHOD *);
 129 const ECDSA_METHOD *ECDSA_get_default_method(void);
 130 int       ECDSA_set_method(ECDSA *, const ECDSA_METHOD *);
 131
 132 ECDSA     *ECDSA_new(void);
 133 ECDSA     *ECDSA_new_method(ENGINE *engine);
 134 int       ECDSA_size(const ECDSA *);
 135 int       ECDSA_sign_setup(ECDSA *ecdsa, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **rp);
 136 int       ECDSA_sign(int type, const unsigned char *dgst, int dgst_len, unsigned char *sig,
 137                      unsigned int *siglen, ECDSA *ecdsa);
 138 int       ECDSA_verify(int type, const unsigned char *dgst, int dgst_len, const unsigned char *sig,
 139                        int sig_len, ECDSA *ecdsa);
 140 int       ECDSA_up_ref(ECDSA *ecdsa);
 141 void      ECDSA_free(ECDSA *a);
 142 int       ECDSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 143                                  CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
 144 int       ECDSA_set_ex_data(ECDSA *d, int idx, void *arg);
 145 void      *ECDSA_get_ex_data(ECDSA *d, int idx);
 146
 147 #ifndef OPENSSL_NO_BIO
 148 int     ECDSAParameters_print(BIO *bp, const ECDSA *x);
 149 int     ECDSA_print(BIO *bp, const ECDSA *x, int off);
 150 #endif
 151 #ifndef OPENSSL_NO_FP_API
 152 int     ECDSAParameters_print_fp(FILE *fp, const ECDSA *x);
 153 int     ECDSA_print_fp(FILE *fp, const ECDSA *x, int off);
 154 #endif
 155
 156 /* The ECDSA_{set|get}_conversion_type() functions set/get the
 157  * conversion form for ec-points (see ec.h) in a ECDSA-structure */
 158 void    ECDSA_set_conversion_form(ECDSA *, const point_conversion_form_t);
 159 point_conversion_form_t ECDSA_get_conversion_form(const ECDSA *);
 160 /* The ECDSA_{set|get}_default_conversion_form() functions set/get the
 161  * default conversion form */
 162 void    ECDSA_set_default_conversion_form(const point_conversion_form_t);
 163 point_conversion_form_t ECDSA_get_default_conversion_form(void);
 164
 165 /* the basic de- and encode functions ( see ecs_asn1.c ) */
 166 ECDSA   *d2i_ECDSAParameters(ECDSA **a, const unsigned char **in, long len);
 167 int     i2d_ECDSAParameters(ECDSA *a, unsigned char **out);
 168
 169 ECDSA   *d2i_ECDSAPrivateKey(ECDSA **a, const unsigned char **in, long len);
 170 int     i2d_ECDSAPrivateKey(ECDSA *a, unsigned char **out);
 171
 172 /* ECDSAPublicKey_set_octet_string() sets the public key in the ECDSA-structure.
 173  * (*a) must be a pointer to a ECDSA-structure with (*a)->group not zero
 174  * (e.g. a ECDSA-structure with a valid EC_GROUP-structure) */
 175 ECDSA   *ECDSAPublicKey_set_octet_string(ECDSA **a, const unsigned char **in, long len);
 176 /* ECDSAPublicKey_get_octet_string() returns the length of the octet string encoding
 177  * of the public key. If out != NULL then the function returns in *out
 178  * a pointer to the octet string */
 179 int     ECDSAPublicKey_get_octet_string(ECDSA *a, unsigned char **out);
 180
 181
 182 #define ECDSAParameters_dup(x) (ECDSA *)ASN1_dup((int (*)())i2d_ECDSAParameters, \
 183                 (char *(*)())d2i_ECDSAParameters,(char *)(x))
 184 #define d2i_ECDSAParameters_fp(fp,x) (ECDSA *)ASN1_d2i_fp((char *(*)())ECDSA_new, \
 185                 (char *(*)())d2i_ECDSAParameters,(fp),(unsigned char **)(x))
 186 #define i2d_ECDSAParameters_fp(fp,x) ASN1_i2d_fp(i2d_ECDSAParameters,(fp), \
 187                 (unsigned char *)(x))
 188 #define d2i_ECDSAParameters_bio(bp,x) (ECDSA *)ASN1_d2i_bio((char *(*)())ECDSA_new, \
 189                 (char *(*)())d2i_ECDSAParameters,(bp),(unsigned char **)(x))
 190 #define i2d_ECDSAParameters_bio(bp,x) ASN1_i2d_bio(i2d_ECDSAParameters,(bp), \
 191                 (unsigned char *)(x))
 192
 193 /* BEGIN ERROR CODES */
 194 /* The following lines are auto generated by the script mkerr.pl. Any changes
 195  * made after this point may be overwritten when the script is next run.
 196  */
 197 void ERR_load_ECDSA_strings(void);
 198
 199 /* Error codes for the ECDSA functions. */
 200
 201 /* Function codes. */
 202 #define ECDSA_F_D2I_ECDSAPARAMETERS                      100
 203 #define ECDSA_F_D2I_ECDSAPRIVATEKEY                      101
 204 #define ECDSA_F_ECDSAPARAMETERS_PRINT                    102
 205 #define ECDSA_F_ECDSAPARAMETERS_PRINT_FP                 103
 206 #define ECDSA_F_ECDSA_DO_SIGN                            104
 207 #define ECDSA_F_ECDSA_DO_VERIFY                          105
 208 #define ECDSA_F_ECDSA_GENERATE_KEY                       106
 209 #define ECDSA_F_ECDSA_GET                                107
 210 #define ECDSA_F_ECDSA_GET_CURVE_NID                      120
 211 #define ECDSA_F_ECDSA_GET_ECDSA                          121
 212 #define ECDSA_F_ECDSA_GET_EC_PARAMETERS                  122
 213 #define ECDSA_F_ECDSA_GET_X9_62_CURVE                    108
 214 #define ECDSA_F_ECDSA_GET_X9_62_EC_PARAMETERS            109
 215 #define ECDSA_F_ECDSA_GET_X9_62_FIELDID                  110
 216 #define ECDSA_F_ECDSA_NEW                                111
 217 #define ECDSA_F_ECDSA_PRINT                              112
 218 #define ECDSA_F_ECDSA_PRINT_FP                           113
 219 #define ECDSA_F_ECDSA_SET_GROUP_P                        114
 220 #define ECDSA_F_ECDSA_SET_PRIME_GROUP                    123
 221 #define ECDSA_F_ECDSA_SIGN_SETUP                         115
 222 #define ECDSA_F_I2D_ECDSAPARAMETERS                      116
 223 #define ECDSA_F_I2D_ECDSAPRIVATEKEY                      117
 224 #define ECDSA_F_I2D_ECDSAPUBLICKEY                       118
 225 #define ECDSA_F_SIG_CB                                   119
 226
 227 /* Reason codes. */
 228 #define ECDSA_R_BAD_SIGNATURE                            100
 229 #define ECDSA_R_CAN_NOT_GET_GENERATOR                    101
 230 #define ECDSA_R_D2I_ECDSAPRIVATEKEY_MISSING_PRIVATE_KEY  102
 231 #define ECDSA_R_D2I_ECDSA_PRIVATEKEY_FAILURE             103
 232 #define ECDSA_R_D2I_EC_PARAMETERS_FAILURE                133
 233 #define ECDSA_R_D2I_X9_62_EC_PARAMETERS_FAILURE          104
 234 #define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE              105
 235 #define ECDSA_R_ECDSAPRIVATEKEY_NEW_FAILURE              106
 236 #define ECDSA_R_ECDSA_F_ECDSA_NEW                        107
 237 #define ECDSA_R_ECDSA_GET_EC_PARAMETERS_FAILURE          134
 238 #define ECDSA_R_ECDSA_GET_FAILURE                        108
 239 #define ECDSA_R_ECDSA_GET_X9_62_CURVE_FAILURE            109
 240 #define ECDSA_R_ECDSA_GET_X9_62_EC_PARAMETERS_FAILURE    110
 241 #define ECDSA_R_ECDSA_GET_X9_62_FIELDID_FAILURE          111
 242 #define ECDSA_R_ECDSA_NEW_FAILURE                        112
 243 #define ECDSA_R_ECDSA_R_D2I_EC_PARAMETERS_FAILURE        135
 244 #define ECDSA_R_ECDSA_R_D2I_X9_62_EC_PARAMETERS_FAILURE  113
 245 #define ECDSA_R_ECPARAMETERS2ECDSA_FAILURE               138
 246 #define ECDSA_R_EC_GROUP_NID2CURVE_FAILURE               136
 247 #define ECDSA_R_ERR_EC_LIB                               114
 248 #define ECDSA_R_I2D_ECDSA_PRIVATEKEY                     115
 249 #define ECDSA_R_I2D_ECDSA_PUBLICKEY                      116
 250 #define ECDSA_R_MISSING_PARAMETERS                       117
 251 #define ECDSA_R_MISSING_PRIVATE_KEY                      139
 252 #define ECDSA_R_NOT_SUPPORTED                            118
 253 #define ECDSA_R_NO_CURVE_PARAMETER_A_SPECIFIED           119
 254 #define ECDSA_R_NO_CURVE_PARAMETER_B_SPECIFIED           120
 255 #define ECDSA_R_NO_CURVE_SPECIFIED                       121
 256 #define ECDSA_R_NO_FIELD_SPECIFIED                       122
 257 #define ECDSA_R_PRIME_MISSING                            123
 258 #define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED          124
 259 #define ECDSA_R_SIGNATURE_MALLOC_FAILED                  125
 260 #define ECDSA_R_UNEXPECTED_ASN1_TYPE                     126
 261 #define ECDSA_R_UNEXPECTED_PARAMETER                     127
 262 #define ECDSA_R_UNEXPECTED_PARAMETER_LENGTH              128
 263 #define ECDSA_R_UNEXPECTED_VERSION_NUMER                 129
 264 #define ECDSA_R_UNKNOWN_PARAMETERS_TYPE                  137
 265 #define ECDSA_R_WRONG_FIELD_IDENTIFIER                   130
 266 #define ECDSA_R_X9_62_CURVE_NEW_FAILURE                  131
 267 #define ECDSA_R_X9_62_EC_PARAMETERS_NEW_FAILURE          132
 268
 269 #ifdef  __cplusplus
 270 }
 271 #endif
 272 #endif