crypto/libressl/include/openssl/ecdsa.h

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