Run util/openssl-format-source -v -c .
[oweals/openssl.git] / crypto / ecdsa / ecdsa.h
index f20c8ee7381eb7e4b56f31f4948a37be02367961..48dd9888ab748c8960f7a0142b02bb01c3206be6 100644 (file)
@@ -11,7 +11,7 @@
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer. 
+ *    notice, this list of conditions and the following disclaimer.
  *
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in
  *
  */
 #ifndef HEADER_ECDSA_H
-#define HEADER_ECDSA_H
+# define HEADER_ECDSA_H
 
-#include <openssl/opensslconf.h>
+# include <openssl/opensslconf.h>
 
-#ifdef OPENSSL_NO_ECDSA
-#error ECDSA is disabled.
-#endif
+# ifdef OPENSSL_NO_ECDSA
+#  error ECDSA is disabled.
+# endif
 
-#include <openssl/ec.h>
-#include <openssl/ossl_typ.h>
-#ifndef OPENSSL_NO_DEPRECATED
-#include <openssl/bn.h>
-#endif
+# include <openssl/ec.h>
+# include <openssl/ossl_typ.h>
+# ifndef OPENSSL_NO_DEPRECATED
+#  include <openssl/bn.h>
+# endif
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-typedef struct ECDSA_SIG_st
-       {
-       BIGNUM *r;
-       BIGNUM *s;
-       } ECDSA_SIG;
+typedef struct ECDSA_SIG_st {
+    BIGNUM *r;
+    BIGNUM *s;
+} ECDSA_SIG;
 
 /** ECDSA_SIG *ECDSA_SIG_new(void)
  * allocates and initialize a ECDSA_SIG structure
@@ -91,20 +90,20 @@ ECDSA_SIG *ECDSA_SIG_new(void);
  * frees a ECDSA_SIG structure
  * \param a pointer to the ECDSA_SIG structure
  */
-void     ECDSA_SIG_free(ECDSA_SIG *a);
+void ECDSA_SIG_free(ECDSA_SIG *a);
 
 /** i2d_ECDSA_SIG
  * DER encode content of ECDSA_SIG object (note: this function modifies *pp
  * (*pp += length of the DER encoded signature)).
  * \param a  pointer to the ECDSA_SIG object
  * \param pp pointer to a unsigned char pointer for the output or NULL
- * \return the length of the DER encoded ECDSA_SIG object or 0 
+ * \return the length of the DER encoded ECDSA_SIG object or 0
  */
-int      i2d_ECDSA_SIG(const ECDSA_SIG *a, unsigned char **pp);
+int i2d_ECDSA_SIG(const ECDSA_SIG *a, unsigned char **pp);
 
 /** d2i_ECDSA_SIG
  * decodes a DER encoded ECDSA signature (note: this function changes *pp
- * (*pp += len)). 
+ * (*pp += len)).
  * \param v pointer to ECDSA_SIG pointer (may be NULL)
  * \param pp buffer with the DER encoded signature
  * \param len bufferlength
@@ -120,7 +119,8 @@ ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **v, const unsigned char **pp, long len);
  * \param eckey pointer to the EC_KEY object containing a private EC key
  * \return pointer to a ECDSA_SIG structure or NULL
  */
-ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst,int dgst_len,EC_KEY *eckey);
+ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst, int dgst_len,
+                         EC_KEY *eckey);
 
 /** ECDSA_do_sign_ex
  * computes ECDSA signature of a given hash value using the supplied
@@ -128,13 +128,14 @@ ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst,int dgst_len,EC_KEY *eckey);
  * \param dgst pointer to the hash value to sign
  * \param dgstlen length of the hash value
  * \param kinv optional pointer to a pre-computed inverse k
- * \param rp optional pointer to the pre-computed rp value (see 
+ * \param rp optional pointer to the pre-computed rp value (see
  *        ECDSA_sign_setup
  * \param eckey pointer to the EC_KEY object containing a private EC key
  * \return pointer to a ECDSA_SIG structure or NULL
  */
-ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen, 
-               const BIGNUM *kinv, const BIGNUM *rp, EC_KEY *eckey);
+ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen,
+                            const BIGNUM *kinv, const BIGNUM *rp,
+                            EC_KEY *eckey);
 
 /** ECDSA_do_verify
  * verifies that the supplied signature is a valid ECDSA
@@ -145,8 +146,8 @@ ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen,
  * \param eckey pointer to the EC_KEY object containing a public EC key
  * \return 1 if the signature is valid, 0 if the signature is invalid and -1 on error
  */
-int      ECDSA_do_verify(const unsigned char *dgst, int dgst_len,
-               const ECDSA_SIG *sig, EC_KEY* eckey);
+int ECDSA_do_verify(const unsigned char *dgst, int dgst_len,
+                    const ECDSA_SIG *sig, EC_KEY *eckey);
 
 const ECDSA_METHOD *ECDSA_OpenSSL(void);
 
@@ -154,7 +155,7 @@ const ECDSA_METHOD *ECDSA_OpenSSL(void);
  * sets the default ECDSA method
  * \param meth the new default ECDSA_METHOD
  */
-void     ECDSA_set_default_method(const ECDSA_METHOD *meth);
+void ECDSA_set_default_method(const ECDSA_METHOD *meth);
 
 /** ECDSA_get_default_method
  * returns the default ECDSA method
@@ -166,27 +167,26 @@ const ECDSA_METHOD *ECDSA_get_default_method(void);
  * sets method to be used for the ECDSA operations
  * \param eckey pointer to the EC_KEY object
  * \param meth  pointer to the new method
- * \return 1 on success and 0 otherwise 
+ * \return 1 on success and 0 otherwise
  */
-int      ECDSA_set_method(EC_KEY *eckey, const ECDSA_METHOD *meth);
+int ECDSA_set_method(EC_KEY *eckey, const ECDSA_METHOD *meth);
 
 /** ECDSA_size
  * returns the maximum length of the DER encoded signature
  * \param  eckey pointer to a EC_KEY object
  * \return numbers of bytes required for the DER encoded signature
  */
-int      ECDSA_size(const EC_KEY *eckey);
+int ECDSA_size(const EC_KEY *eckey);
 
 /** ECDSA_sign_setup
- * precompute parts of the signing operation. 
+ * precompute parts of the signing operation.
  * \param eckey pointer to the EC_KEY object containing a private EC key
  * \param ctx  pointer to a BN_CTX object (may be NULL)
  * \param kinv pointer to a BIGNUM pointer for the inverse of k
  * \param rp   pointer to a BIGNUM pointer for x coordinate of k * generator
  * \return 1 on success and 0 otherwise
  */
-int      ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv, 
-               BIGNUM **rp);
+int ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv, BIGNUM **rp);
 
 /** ECDSA_sign
  * computes ECDSA signature of a given hash value using the supplied
@@ -199,9 +199,8 @@ int           ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv,
  * \param eckey pointer to the EC_KEY object containing a private EC key
  * \return 1 on success and 0 otherwise
  */
-int      ECDSA_sign(int type, const unsigned char *dgst, int dgstlen, 
-               unsigned char *sig, unsigned int *siglen, EC_KEY *eckey);
-
+int ECDSA_sign(int type, const unsigned char *dgst, int dgstlen,
+               unsigned char *sig, unsigned int *siglen, EC_KEY *eckey);
 
 /** ECDSA_sign_ex
  * computes ECDSA signature of a given hash value using the supplied
@@ -212,38 +211,39 @@ int         ECDSA_sign(int type, const unsigned char *dgst, int dgstlen,
  * \param sig buffer to hold the DER encoded signature
  * \param siglen pointer to the length of the returned signature
  * \param kinv optional pointer to a pre-computed inverse k
- * \param rp optional pointer to the pre-computed rp value (see 
+ * \param rp optional pointer to the pre-computed rp value (see
  *        ECDSA_sign_setup
  * \param eckey pointer to the EC_KEY object containing a private EC key
  * \return 1 on success and 0 otherwise
  */
-int      ECDSA_sign_ex(int type, const unsigned char *dgst, int dgstlen, 
-               unsigned char *sig, unsigned int *siglen, const BIGNUM *kinv,
-               const BIGNUM *rp, EC_KEY *eckey);
+int ECDSA_sign_ex(int type, const unsigned char *dgst, int dgstlen,
+                  unsigned char *sig, unsigned int *siglen,
+                  const BIGNUM *kinv, const BIGNUM *rp, EC_KEY *eckey);
 
 /** ECDSA_verify
  * verifies that the given signature is valid ECDSA signature
  * of the supplied hash value using the specified public key.
  * \param type this parameter is ignored
- * \param dgst pointer to the hash value 
+ * \param dgst pointer to the hash value
  * \param dgstlen length of the hash value
  * \param sig  pointer to the DER encoded signature
  * \param siglen length of the DER encoded signature
  * \param eckey pointer to the EC_KEY object containing a public EC key
  * \return 1 if the signature is valid, 0 if the signature is invalid and -1 on error
  */
-int      ECDSA_verify(int type, const unsigned char *dgst, int dgstlen, 
-               const unsigned char *sig, int siglen, EC_KEY *eckey);
+int ECDSA_verify(int type, const unsigned char *dgst, int dgstlen,
+                 const unsigned char *sig, int siglen, EC_KEY *eckey);
 
 /* the standard ex_data functions */
-int      ECDSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new 
-               *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
-int      ECDSA_set_ex_data(EC_KEY *d, int idx, void *arg);
-void     *ECDSA_get_ex_data(EC_KEY *d, int idx);
-
+int ECDSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new
+                           *new_func, CRYPTO_EX_dup *dup_func,
+                           CRYPTO_EX_free *free_func);
+int ECDSA_set_ex_data(EC_KEY *d, int idx, void *arg);
+void *ECDSA_get_ex_data(EC_KEY *d, int idx);
 
 /* BEGIN ERROR CODES */
-/* The following lines are auto generated by the script mkerr.pl. Any changes
+/*
+ * The following lines are auto generated by the script mkerr.pl. Any changes
  * made after this point may be overwritten when the script is next run.
  */
 void ERR_load_ECDSA_strings(void);
@@ -251,19 +251,19 @@ void ERR_load_ECDSA_strings(void);
 /* Error codes for the ECDSA functions. */
 
 /* Function codes. */
-#define ECDSA_F_ECDSA_DATA_NEW_METHOD                   100
-#define ECDSA_F_ECDSA_DO_SIGN                           101
-#define ECDSA_F_ECDSA_DO_VERIFY                                 102
-#define ECDSA_F_ECDSA_SIGN_SETUP                        103
+# define ECDSA_F_ECDSA_DATA_NEW_METHOD                    100
+# define ECDSA_F_ECDSA_DO_SIGN                            101
+# define ECDSA_F_ECDSA_DO_VERIFY                          102
+# define ECDSA_F_ECDSA_SIGN_SETUP                         103
 
 /* Reason codes. */
-#define ECDSA_R_BAD_SIGNATURE                           100
-#define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE             101
-#define ECDSA_R_ERR_EC_LIB                              102
-#define ECDSA_R_MISSING_PARAMETERS                      103
-#define ECDSA_R_NEED_NEW_SETUP_VALUES                   106
-#define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED                 104
-#define ECDSA_R_SIGNATURE_MALLOC_FAILED                         105
+# define ECDSA_R_BAD_SIGNATURE                            100
+# define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE              101
+# define ECDSA_R_ERR_EC_LIB                               102
+# define ECDSA_R_MISSING_PARAMETERS                       103
+# define ECDSA_R_NEED_NEW_SETUP_VALUES                    106
+# define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED          104
+# define ECDSA_R_SIGNATURE_MALLOC_FAILED                  105
 
 #ifdef  __cplusplus
 }