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