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