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