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