[thirdparty/openssl.git] / crypto / ec / ec.h

/* crypto/ec/ec.h */
/* ====================================================================
 * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    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
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
 *
 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    openssl-core@openssl.org.
 *
 * 5. Products derived from this software may not be called "OpenSSL"
 *    nor may "OpenSSL" appear in their names without prior written
 *    permission of the OpenSSL Project.
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
 *
 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 *
 * This product includes cryptographic software written by Eric Young
 * (eay@cryptsoft.com).  This product includes software written by Tim
 * Hudson (tjh@cryptsoft.com).
 *
 */

#ifndef HEADER_EC_H
#define HEADER_EC_H

#include <openssl/bn.h>

#ifdef  __cplusplus
extern "C" {
#endif


typedef enum {
	POINT_CONVERSION_COMPRESSED = 2,
	POINT_CONVERSION_UNCOMPRESSED = 4,
	POINT_CONVERSION_HYBRID = 6
} point_conversion_form_t;


typedef struct ec_method_st EC_METHOD;

typedef struct ec_group_st
	/*
	 EC_METHOD *meth;
	 -- field definition
	 -- curve coefficients
	 -- optional generator with associated information (order, cofactor)
	 -- optional Lim/Lee precomputation table
	*/
	EC_GROUP;

typedef struct ec_point_st EC_POINT;


/* EC_METHODs for curves over GF(p).
 * EC_GFp_simple_method provides the basis for the optimized methods.
 */
 
const EC_METHOD *EC_GFp_simple_method(void);
const EC_METHOD *EC_GFp_mont_method(void);
const EC_METHOD *EC_GFp_recp_method(void);
const EC_METHOD *EC_GFp_nist_method(void);


EC_GROUP *EC_GROUP_new(const EC_METHOD *);
/* We don't have types for field specifications and field elements in general.
 * Otherwise we would declare
 *     int EC_GROUP_set_curve(EC_GROUP *, .....);
 */
int EC_GROUP_set_curve_GFp(EC_GROUP *, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
void EC_GROUP_free(EC_GROUP *);
void EC_GROUP_clear_free(EC_GROUP *);
int EC_GROUP_copy(EC_GROUP *, const EC_GROUP*);

/* EC_GROUP_new_GFp() calls EC_GROUP_new() and EC_GROUP_set_GFp()
 * after choosing an appropriate EC_METHOD */
EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *);

int EC_GROUP_set_generator(EC_GROUP *, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor);

/* TODO: 'set' and 'get' functions for EC_GROUPs */


EC_POINT *EC_POINT_new(const EC_GROUP *);
void EC_POINT_free(EC_POINT *);
void EC_POINT_clear_free(EC_POINT *);
int EC_POINT_copy(EC_POINT *, const EC_POINT *);
 
/* TODO: 'set' and 'get' functions for EC_POINTs */

size_t EC_POINT_point2oct(const EC_GROUP *, const EC_POINT *, point_conversion_form_t form,
        unsigned char *buf, size_t len, BN_CTX *);
int EC_POINT_oct2point(const EC_GROUP *, EC_POINT *,
        const unsigned char *buf, size_t len, BN_CTX *);

int EC_POINT_add(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
int EC_POINT_dbl(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);

int EC_POINT_is_at_infinity(const EC_GROUP *, const EC_POINT *);
int EC_POINT_is_on_curve(const EC_GROUP *, const EC_POINT *, BN_CTX *);

int EC_POINT_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *);


/* TODO: scalar multiplication */


/* BEGIN ERROR CODES */
/* 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.
 */

/* Error codes for the EC functions. */

/* Function codes. */
#define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR		 117
#define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE			 118
#define EC_F_EC_GROUP_CLEAR_FREE			 103
#define EC_F_EC_GROUP_COPY				 102
#define EC_F_EC_GROUP_FREE				 104
#define EC_F_EC_GROUP_GET_EXTRA_DATA			 115
#define EC_F_EC_GROUP_NEW				 100
#define EC_F_EC_GROUP_SET_CURVE_GFP			 101
#define EC_F_EC_GROUP_SET_EXTRA_DATA			 116
#define EC_F_EC_GROUP_SET_GENERATOR			 106
#define EC_F_EC_POINT_ADD				 107
#define EC_F_EC_POINT_COPY				 108
#define EC_F_EC_POINT_DBL				 109
#define EC_F_EC_POINT_IS_AT_INFINITY			 110
#define EC_F_EC_POINT_IS_ON_CURVE			 111
#define EC_F_EC_POINT_MAKE_AFFINE			 112
#define EC_F_EC_POINT_NEW				 105
#define EC_F_EC_POINT_OCT2POINT				 113
#define EC_F_EC_POINT_POINT2OCT				 114

/* Reason codes. */
#define EC_R_INCOMPATIBLE_OBJECTS			 100
#define EC_R_NO_SUCH_EXTRA_DATA				 101
#define EC_R_SLOT_FULL					 102

#ifdef  __cplusplus
}
#endif
#endif
Commit	Line	Data
65e81670 BM	1	/* crypto/ec/ec.h */
	2	/* ====================================================================
	3	* Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
6cc5e19d	4	*
65e81670 BM	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
6cc5e19d	8	*
65e81670 BM	9	* 1. Redistributions of source code must retain the above copyright
65e81670 BM	10	* notice, this list of conditions and the following disclaimer.
6cc5e19d	11	*
65e81670 BM	12	* 2. Redistributions in binary form must reproduce the above copyright
	13	* notice, this list of conditions and the following disclaimer in
	14	* the documentation and/or other materials provided with the
	15	* distribution.
6cc5e19d	16	*
65e81670 BM	17	* 3. All advertising materials mentioning features or use of this
	18	* software must display the following acknowledgment:
	19	* "This product includes software developed by the OpenSSL Project
	20	* for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
	21	*
	22	* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
	23	* endorse or promote products derived from this software without
	24	* prior written permission. For written permission, please contact
	25	* openssl-core@openssl.org.
	26	*
	27	* 5. Products derived from this software may not be called "OpenSSL"
	28	* nor may "OpenSSL" appear in their names without prior written
	29	* permission of the OpenSSL Project.
	30	*
	31	* 6. Redistributions of any form whatsoever must retain the following
	32	* acknowledgment:
	33	* "This product includes software developed by the OpenSSL Project
	34	* for use in the OpenSSL Toolkit (http://www.openssl.org/)"
	35	*
	36	* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
	37	* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	38	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	39	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
	40	* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	41	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	42	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	43	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	44	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	45	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	46	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
	47	* OF THE POSSIBILITY OF SUCH DAMAGE.
	48	* ====================================================================
	49	*
	50	* This product includes cryptographic software written by Eric Young
	51	* (eay@cryptsoft.com). This product includes software written by Tim
	52	* Hudson (tjh@cryptsoft.com).
6cc5e19d BM	53	*
	54	*/
	55
6cc5e19d BM	56	#ifndef HEADER_EC_H
	57	#define HEADER_EC_H
	58
5acaa495	59	#include <openssl/bn.h>
6cc5e19d	60
65e81670 BM	61	#ifdef __cplusplus
	62	extern "C" {
	63	#endif
6cc5e19d	64
6cc5e19d	65
7d7db13e	66
3a12ce01 BM	67	typedef enum {
	68	POINT_CONVERSION_COMPRESSED = 2,
	69	POINT_CONVERSION_UNCOMPRESSED = 4,
	70	POINT_CONVERSION_HYBRID = 6
	71	} point_conversion_form_t;
	72
	73
	74	typedef struct ec_method_st EC_METHOD;
	75
	76	typedef struct ec_group_st
	77	/*
	78	EC_METHOD *meth;
	79	-- field definition
	80	-- curve coefficients
	81	-- optional generator with associated information (order, cofactor)
	82	-- optional Lim/Lee precomputation table
	83	*/
	84	EC_GROUP;
	85
	86	typedef struct ec_point_st EC_POINT;
	87
	88
	89	/* EC_METHODs for curves over GF(p).
	90	* EC_GFp_simple_method provides the basis for the optimized methods.
	91	*/
	92
	93	const EC_METHOD *EC_GFp_simple_method(void);
	94	const EC_METHOD *EC_GFp_mont_method(void);
	95	const EC_METHOD *EC_GFp_recp_method(void);
	96	const EC_METHOD *EC_GFp_nist_method(void);
	97
	98
	99	EC_GROUP EC_GROUP_new(const EC_METHOD );
	100	/* We don't have types for field specifications and field elements in general.
	101	* Otherwise we would declare
7d7db13e	102	* int EC_GROUP_set_curve(EC_GROUP *, .....);
3a12ce01	103	*/
7d7db13e	104	int EC_GROUP_set_curve_GFp(EC_GROUP , const BIGNUM p, const BIGNUM a, const BIGNUM b, BN_CTX *);
3a12ce01	105	void EC_GROUP_free(EC_GROUP *);
0657bf9c	106	void EC_GROUP_clear_free(EC_GROUP *);
7d7db13e	107	int EC_GROUP_copy(EC_GROUP , const EC_GROUP);
3a12ce01	108
24b8dc9a BM	109	/* EC_GROUP_new_GFp() calls EC_GROUP_new() and EC_GROUP_set_GFp()
24b8dc9a BM	110	* after choosing an appropriate EC_METHOD */
7d7db13e BM	111	EC_GROUP EC_GROUP_new_curve_GFp(const BIGNUM p, const BIGNUM a, const BIGNUM b, BN_CTX *);
	112
	113	int EC_GROUP_set_generator(EC_GROUP , const EC_POINT generator, const BIGNUM order, const BIGNUM cofactor);
	114
2e0db076	115	/* TODO: 'set' and 'get' functions for EC_GROUPs */
24b8dc9a BM	116
24b8dc9a BM	117
3a12ce01 BM	118	EC_POINT EC_POINT_new(const EC_GROUP );
3a12ce01 BM	119	void EC_POINT_free(EC_POINT *);
0657bf9c	120	void EC_POINT_clear_free(EC_POINT *);
7d7db13e	121	int EC_POINT_copy(EC_POINT , const EC_POINT );
3a12ce01	122
7d7db13e BM	123	/* TODO: 'set' and 'get' functions for EC_POINTs */
7d7db13e BM	124
5b438e9b	125	size_t EC_POINT_point2oct(const EC_GROUP , const EC_POINT , point_conversion_form_t form,
7d7db13e BM	126	unsigned char buf, size_t len, BN_CTX );
	127	int EC_POINT_oct2point(const EC_GROUP , EC_POINT ,
	128	const unsigned char buf, size_t len, BN_CTX );
	129
	130	int EC_POINT_add(const EC_GROUP , EC_POINT r, const EC_POINT a, const EC_POINT b, BN_CTX *);
	131	int EC_POINT_dbl(const EC_GROUP , EC_POINT r, const EC_POINT a, BN_CTX );
3a12ce01	132
5b438e9b BM	133	int EC_POINT_is_at_infinity(const EC_GROUP , const EC_POINT );
5b438e9b BM	134	int EC_POINT_is_on_curve(const EC_GROUP , const EC_POINT , BN_CTX *);
fb171e53	135
e869d4bd	136	int EC_POINT_make_affine(const EC_GROUP , EC_POINT , BN_CTX *);
fb171e53	137
3a12ce01 BM	138
	139
	140	/* TODO: scalar multiplication */
6cc5e19d	141
6cc5e19d BM	142
6cc5e19d BM	143
65e81670 BM	144	/* BEGIN ERROR CODES */
	145	/* The following lines are auto generated by the script mkerr.pl. Any changes
	146	* made after this point may be overwritten when the script is next run.
	147	*/
6cc5e19d	148
65e81670	149	/* Error codes for the EC functions. */
6cc5e19d	150
65e81670	151	/* Function codes. */
60428dbf	152	#define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR 117
e869d4bd	153	#define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE 118
0657bf9c BM	154	#define EC_F_EC_GROUP_CLEAR_FREE 103
	155	#define EC_F_EC_GROUP_COPY 102
	156	#define EC_F_EC_GROUP_FREE 104
df9cc153	157	#define EC_F_EC_GROUP_GET_EXTRA_DATA 115
0657bf9c BM	158	#define EC_F_EC_GROUP_NEW 100
0657bf9c BM	159	#define EC_F_EC_GROUP_SET_CURVE_GFP 101
df9cc153	160	#define EC_F_EC_GROUP_SET_EXTRA_DATA 116
0657bf9c BM	161	#define EC_F_EC_GROUP_SET_GENERATOR 106
	162	#define EC_F_EC_POINT_ADD 107
	163	#define EC_F_EC_POINT_COPY 108
	164	#define EC_F_EC_POINT_DBL 109
	165	#define EC_F_EC_POINT_IS_AT_INFINITY 110
	166	#define EC_F_EC_POINT_IS_ON_CURVE 111
	167	#define EC_F_EC_POINT_MAKE_AFFINE 112
	168	#define EC_F_EC_POINT_NEW 105
	169	#define EC_F_EC_POINT_OCT2POINT 113
	170	#define EC_F_EC_POINT_POINT2OCT 114
6cc5e19d	171
65e81670	172	/* Reason codes. */
0657bf9c	173	#define EC_R_INCOMPATIBLE_OBJECTS 100
df9cc153 BM	174	#define EC_R_NO_SUCH_EXTRA_DATA 101
df9cc153 BM	175	#define EC_R_SLOT_FULL 102
6cc5e19d	176
65e81670 BM	177	#ifdef __cplusplus
	178	}
	179	#endif
5acaa495	180	#endif
65e81670	181