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

/* TODO */
/* crypto/ec/ec_lcl.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).
 *
 */


#include <stdlib.h>

#include <openssl/ec.h>


/* Structure details are not part of the exported interface,
 * so all this may change in future versions. */

struct ec_method_st {
	/* used by EC_GROUP_new, EC_GROUP_set_GFp, EC_GROUP_free, EC_GROUP_copy: */
	int (*group_init)(EC_GROUP *);
	/* int (*group_set)(EC_GROUP *, .....); */
	int (*group_set_GFp)(EC_GROUP *, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *);
	void (*group_finish)(EC_GROUP *);
	int (*group_copy)(EC_GROUP *, const EC_GROUP *);

	/* used by EC_GROUP_set_generator: */
	int (*group_set_generator)(EC_GROUP *, const EC_POINT *generator,
	        const BIGNUM *order, const BIGNUM *cofactor);
	
	/* TODO: 'set' functions for EC_GROUPs */


	/* used by EC_POINT_new, EC_POINT_free, EC_POINT_copy: */
	int (*point_init)(EC_POINT *);
	void (*point_finish)(EC_POINT *);
	int (*point_copy)(EC_POINT *, const EC_POINT *);

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

	/* used by EC_POINT_point2oct, EC_POINT_oct2point: */
	size_t (*point2oct)(const EC_GROUP *, EC_POINT *, point_conversion_form_t form,
	        unsigned char *buf, size_t len, BN_CTX *);
	int (*oct2point)(const EC_GROUP *, EC_POINT *,
	        const unsigned char *buf, size_t len, BN_CTX *);

	/* used by EC_POINT_add, EC_POINT_dbl: */
	int (*add)(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *);
	int (*dbl)(const EC_GROUP *, EC_POINT *r, const EC_POINT *a, BN_CTX *);

	/* used by EC_POINT_is_at_infinity, EC_POINT_is_on_curve, EC_POINT_make_affine */
	int (*is_at_infinity)(const EC_GROUP *, EC_POINT *, BN_CTX *);
	int (*is_on_curve)(const EC_GROUP *, EC_POINT *, BN_CTX *);
	int (*make_affine)(const EC_GROUP *, EC_POINT *, BN_CTX *);


	/* internal functions */

	/* 'field_mult' and 'field_sqr' can be used by 'add' and 'dbl' so that
	 * the same implementations of point operations can be used with different
	 * optimized implementations of expensive field operations: */
	int (*field_mult)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *);
	int (*field_sqr)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *);

	int (*field_encode)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *); /* e.g. to Montgomery */
	int (*field_decode)(const EC_GROUP *, BIGNUM *r, const BIGNUM *a, BN_CTX *); /* e.g. from Montgomery */
} /* EC_METHOD */;


struct ec_group_st {
	EC_METHOD *meth;

	BIGNUM field; /* Field specification.
	               * For curves over GF(p), this is the modulus. */
	void *field_data; /* method-specific (e.g., Montgomery structure) */

	BIGNUM a, b; /* Curve coefficients.
	              * (Here the assumption is that BIGNUMs can be used
	              * or abused for all kinds of fields, not just GF(p).)
	              * For characteristic  > 3,  the curve is defined
	              * by a Weierstrass equation of the form
	              *     Y^2 = X^3 + a*X + b.
	              */
	int a_is_minus3; /* enable optimized point arithmetics for special case */

	EC_POINT *generator; /* optional */
	BIGNUM order, cofactor;

	/* optional Lim/Lee precomputation table */
} /* EC_GROUP */;


struct ec_point_st {
	EC_METHOD *meth;

	BIGNUM X;
	BIGNUM Y;
	BIGNUM Z; /* Jacobian projective coordinates:
	           * (X, Y, Z)  represents  (X/Z^2, Y/Z^3)  if  Z != 0 */
	int Z_is_one; /* enable optimized point arithmetics for special case */
} /* EC_POINT */;
Commit	Line	Data
65e81670 BM	1	/* TODO */
	2	/* crypto/ec/ec_lcl.h */
	3	/* ====================================================================
	4	* Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
	5	*
	6	* Redistribution and use in source and binary forms, with or without
	7	* modification, are permitted provided that the following conditions
	8	* are met:
	9	*
	10	* 1. Redistributions of source code must retain the above copyright
	11	* notice, this list of conditions and the following disclaimer.
	12	*
	13	* 2. Redistributions in binary form must reproduce the above copyright
	14	* notice, this list of conditions and the following disclaimer in
	15	* the documentation and/or other materials provided with the
	16	* distribution.
	17	*
	18	* 3. All advertising materials mentioning features or use of this
	19	* software must display the following acknowledgment:
	20	* "This product includes software developed by the OpenSSL Project
	21	* for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
	22	*
	23	* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
	24	* endorse or promote products derived from this software without
	25	* prior written permission. For written permission, please contact
	26	* openssl-core@openssl.org.
	27	*
	28	* 5. Products derived from this software may not be called "OpenSSL"
	29	* nor may "OpenSSL" appear in their names without prior written
	30	* permission of the OpenSSL Project.
	31	*
	32	* 6. Redistributions of any form whatsoever must retain the following
	33	* acknowledgment:
	34	* "This product includes software developed by the OpenSSL Project
	35	* for use in the OpenSSL Toolkit (http://www.openssl.org/)"
	36	*
	37	* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
	38	* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	39	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	40	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
	41	* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	42	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	43	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	44	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	45	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	46	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	47	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
	48	* OF THE POSSIBILITY OF SUCH DAMAGE.
	49	* ====================================================================
	50	*
	51	* This product includes cryptographic software written by Eric Young
	52	* (eay@cryptsoft.com). This product includes software written by Tim
	53	* Hudson (tjh@cryptsoft.com).
	54	*
	55	*/
38e3c581	56
3a12ce01 BM	57
	58	#include <stdlib.h>
	59
38e3c581	60	#include <openssl/ec.h>
3a12ce01 BM	61
	62
	63	/* Structure details are not part of the exported interface,
	64	* so all this may change in future versions. */
	65
	66	struct ec_method_st {
7d7db13e	67	/* used by EC_GROUP_new, EC_GROUP_set_GFp, EC_GROUP_free, EC_GROUP_copy: */
3a12ce01 BM	68	int (group_init)(EC_GROUP );
3a12ce01 BM	69	/* int (group_set)(EC_GROUP , .....); */
7d7db13e	70	int (group_set_GFp)(EC_GROUP , BIGNUM p, BIGNUM a, BIGNUM b, BN_CTX );
3a12ce01	71	void (group_finish)(EC_GROUP );
7d7db13e	72	int (group_copy)(EC_GROUP , const EC_GROUP *);
3a12ce01	73
7d7db13e BM	74	/* used by EC_GROUP_set_generator: */
	75	int (group_set_generator)(EC_GROUP , const EC_POINT *generator,
	76	const BIGNUM order, const BIGNUM cofactor);
	77
	78	/* TODO: 'set' functions for EC_GROUPs */
	79
	80
	81	/* used by EC_POINT_new, EC_POINT_free, EC_POINT_copy: */
3a12ce01 BM	82	int (point_init)(EC_POINT );
3a12ce01 BM	83	void (point_finish)(EC_POINT );
7d7db13e	84	int (point_copy)(EC_POINT , const EC_POINT *);
3a12ce01	85
7d7db13e	86	/* TODO: 'set' and 'get' functions for EC_POINTs */
3a12ce01	87
d8c79c7f	88	/* used by EC_POINT_point2oct, EC_POINT_oct2point: */
7d7db13e BM	89	size_t (point2oct)(const EC_GROUP , EC_POINT *, point_conversion_form_t form,
	90	unsigned char buf, size_t len, BN_CTX );
	91	int (oct2point)(const EC_GROUP , EC_POINT *,
	92	const unsigned char buf, size_t len, BN_CTX );
	93
	94	/* used by EC_POINT_add, EC_POINT_dbl: */
	95	int (add)(const EC_GROUP , EC_POINT r, const EC_POINT a, const EC_POINT b, BN_CTX );
	96	int (dbl)(const EC_GROUP , EC_POINT r, const EC_POINT a, BN_CTX *);
3a12ce01	97
fb171e53 BM	98	/* used by EC_POINT_is_at_infinity, EC_POINT_is_on_curve, EC_POINT_make_affine */
	99	int (is_at_infinity)(const EC_GROUP , EC_POINT , BN_CTX );
	100	int (is_on_curve)(const EC_GROUP , EC_POINT , BN_CTX );
	101	int (make_affine)(const EC_GROUP , EC_POINT , BN_CTX );
	102
3a12ce01 BM	103
	104	/* internal functions */
	105
	106	/* 'field_mult' and 'field_sqr' can be used by 'add' and 'dbl' so that
	107	* the same implementations of point operations can be used with different
d8c79c7f	108	* optimized implementations of expensive field operations: */
7d7db13e BM	109	int (field_mult)(const EC_GROUP , BIGNUM r, const BIGNUM a, const BIGNUM b, BN_CTX );
	110	int (field_sqr)(const EC_GROUP , BIGNUM r, const BIGNUM a, BN_CTX *);
	111
	112	int (field_encode)(const EC_GROUP , BIGNUM r, const BIGNUM a, BN_CTX ); / e.g. to Montgomery */
	113	int (field_decode)(const EC_GROUP , BIGNUM r, const BIGNUM a, BN_CTX ); / e.g. from Montgomery */
3a12ce01 BM	114	} /* EC_METHOD */;
	115
	116
	117	struct ec_group_st {
	118	EC_METHOD *meth;
	119
	120	BIGNUM field; /* Field specification.
	121	* For curves over GF(p), this is the modulus. */
	122	void field_data; / method-specific (e.g., Montgomery structure) */
	123
	124	BIGNUM a, b; /* Curve coefficients.
	125	* (Here the assumption is that BIGNUMs can be used
fb171e53 BM	126	* or abused for all kinds of fields, not just GF(p).)
	127	* For characteristic > 3, the curve is defined
	128	* by a Weierstrass equation of the form
	129	* Y^2 = X^3 + a*X + b.
	130	*/
3a12ce01 BM	131	int a_is_minus3; /* enable optimized point arithmetics for special case */
3a12ce01 BM	132
7d7db13e BM	133	EC_POINT generator; / optional */
	134	BIGNUM order, cofactor;
	135
	136	/* optional Lim/Lee precomputation table */
3a12ce01 BM	137	} /* EC_GROUP */;
	138
	139
	140	struct ec_point_st {
	141	EC_METHOD *meth;
	142
fb171e53 BM	143	BIGNUM X;
	144	BIGNUM Y;
	145	BIGNUM Z; /* Jacobian projective coordinates:
	146	* (X, Y, Z) represents (X/Z^2, Y/Z^3) if Z != 0 */
	147	int Z_is_one; /* enable optimized point arithmetics for special case */
3a12ce01	148	} /* EC_POINT */;