- /* Originally written by Bodo Moeller for the OpenSSL project.
- * ====================================================================
- * Copyright (c) 1998-2005 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).
- *
- */
- /* ====================================================================
- * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
- *
- * Portions of the attached software ("Contribution") are developed by
- * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
- *
- * The Contribution is licensed pursuant to the OpenSSL open source
- * license provided above.
- *
- * The elliptic curve binary polynomial software is originally written by
- * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems
- * Laboratories. */
-
- #ifndef OPENSSL_HEADER_EC_H
- #define OPENSSL_HEADER_EC_H
-
- #include <openssl/base.h>
-
- #if defined(__cplusplus)
- extern "C" {
- #endif
-
-
- /* Low-level operations on elliptic curves. */
-
-
- typedef struct ec_group_st EC_GROUP;
- typedef struct ec_point_st EC_POINT;
-
- /** Enum for the point conversion form as defined in X9.62 (ECDSA)
- * for the encoding of a elliptic curve point (x,y) */
- typedef enum {
- /** the point is encoded as z||x, where the octet z specifies
- * which solution of the quadratic equation y is */
- POINT_CONVERSION_COMPRESSED = 2,
- /** the point is encoded as z||x||y, where z is the octet 0x02 */
- POINT_CONVERSION_UNCOMPRESSED = 4
- } point_conversion_form_t;
-
-
- /* Elliptic curve groups. */
-
- /* EC_GROUP_new_by_curve_name returns a fresh EC_GROUP object for the elliptic
- * curve specified by |nid|, or NULL on error.
- *
- * The supported NIDs are:
- * NID_secp224r1,
- * NID_X9_62_prime256v1,
- * NID_secp384r1,
- * NID_secp521r1 */
- OPENSSL_EXPORT EC_GROUP *EC_GROUP_new_by_curve_name(int nid);
-
- /* EC_GROUP_free frees |group| and the data that it points to. */
- OPENSSL_EXPORT void EC_GROUP_free(EC_GROUP *group);
-
- /* EC_GROUP_dup returns a fresh |EC_GROUP| which is equal to |a| or NULL on
- * error. */
- OPENSSL_EXPORT EC_GROUP *EC_GROUP_dup(const EC_GROUP *a);
-
- /* EC_GROUP_cmp returns zero if |a| and |b| are the same group and non-zero
- * otherwise. */
- OPENSSL_EXPORT int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b,
- BN_CTX *ignored);
-
- /* EC_GROUP_get0_generator returns a pointer to the internal |EC_POINT| object
- * in |group| that specifies the generator for the group. */
- OPENSSL_EXPORT const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group);
-
- /* EC_GROUP_get_order sets |*order| to the order of |group|, if it's not
- * NULL. It returns one on success and zero otherwise. |ctx| is ignored. */
- OPENSSL_EXPORT int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order,
- BN_CTX *ctx);
-
- /* EC_GROUP_get_cofactor sets |*cofactor| to the cofactor of |group| using
- * |ctx|, if it's not NULL. It returns one on success and zero otherwise. */
- OPENSSL_EXPORT int EC_GROUP_get_cofactor(const EC_GROUP *group,
- BIGNUM *cofactor, BN_CTX *ctx);
-
- /* EC_GROUP_get_curve_GFp gets various parameters about a group. It sets
- * |*out_p| to the order of the coordinate field and |*out_a| and |*out_b| to
- * the parameters of the curve when expressed as y² = x³ + ax + b. Any of the
- * output parameters can be NULL. It returns one on success and zero on
- * error. */
- OPENSSL_EXPORT int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *out_p,
- BIGNUM *out_a, BIGNUM *out_b,
- BN_CTX *ctx);
-
- /* EC_GROUP_get_curve_name returns a NID that identifies |group|. */
- OPENSSL_EXPORT int EC_GROUP_get_curve_name(const EC_GROUP *group);
-
- /* EC_GROUP_get_degree returns the number of bits needed to represent an
- * element of the field underlying |group|. */
- OPENSSL_EXPORT int EC_GROUP_get_degree(const EC_GROUP *group);
-
- /* EC_GROUP_precompute_mult precomputes multiplies of the generator in order to
- * speed up operations that involve calculating generator multiples. It returns
- * one on sucess and zero otherwise. If |ctx| is not NULL, it may be used. */
- OPENSSL_EXPORT int EC_GROUP_precompute_mult(EC_GROUP *group, BN_CTX *ctx);
-
- /* EC_GROUP_have_precompute_mult returns one if |group| contains precomputed
- * generator multiples. */
- OPENSSL_EXPORT int EC_GROUP_have_precompute_mult(const EC_GROUP *group);
-
-
- /* Points on elliptic curves. */
-
- /* EC_POINT_new returns a fresh |EC_POINT| object in the given group, or NULL
- * on error. */
- OPENSSL_EXPORT EC_POINT *EC_POINT_new(const EC_GROUP *group);
-
- /* EC_POINT_free frees |point| and the data that it points to. */
- OPENSSL_EXPORT void EC_POINT_free(EC_POINT *point);
-
- /* EC_POINT_clear_free clears the data that |point| points to, frees it and
- * then frees |point| itself. */
- OPENSSL_EXPORT void EC_POINT_clear_free(EC_POINT *point);
-
- /* EC_POINT_copy sets |*dest| equal to |*src|. It returns one on success and
- * zero otherwise. */
- OPENSSL_EXPORT int EC_POINT_copy(EC_POINT *dest, const EC_POINT *src);
-
- /* EC_POINT_dup returns a fresh |EC_POINT| that contains the same values as
- * |src|, or NULL on error. */
- OPENSSL_EXPORT EC_POINT *EC_POINT_dup(const EC_POINT *src,
- const EC_GROUP *group);
-
- /* EC_POINT_set_to_infinity sets |point| to be the "point at infinity" for the
- * given group. */
- OPENSSL_EXPORT int EC_POINT_set_to_infinity(const EC_GROUP *group,
- EC_POINT *point);
-
- /* EC_POINT_is_at_infinity returns one iff |point| is the point at infinity and
- * zero otherwise. */
- OPENSSL_EXPORT int EC_POINT_is_at_infinity(const EC_GROUP *group,
- const EC_POINT *point);
-
- /* EC_POINT_is_on_curve returns one if |point| is an element of |group| and
- * zero otheriwse. If |ctx| is non-NULL, it may be used. */
- OPENSSL_EXPORT int EC_POINT_is_on_curve(const EC_GROUP *group,
- const EC_POINT *point, BN_CTX *ctx);
-
- /* EC_POINT_cmp returns zero if |a| is equal to |b|, greater than zero is
- * non-equal and -1 on error. If |ctx| is not NULL, it may be used. */
- OPENSSL_EXPORT int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a,
- const EC_POINT *b, BN_CTX *ctx);
-
- /* EC_POINT_make_affine converts |point| to affine form, internally. It returns
- * one on success and zero otherwise. If |ctx| is not NULL, it may be used. */
- OPENSSL_EXPORT int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point,
- BN_CTX *ctx);
-
- /* EC_POINTs_make_affine converts |num| points from |points| to affine form,
- * internally. It returns one on success and zero otherwise. If |ctx| is not
- * NULL, it may be used. */
- OPENSSL_EXPORT int EC_POINTs_make_affine(const EC_GROUP *group, size_t num,
- EC_POINT *points[], BN_CTX *ctx);
-
-
- /* Point conversion. */
-
- /* EC_POINT_get_affine_coordinates_GFp sets |x| and |y| to the affine value of
- * |point| using |ctx|, if it's not NULL. It returns one on success and zero
- * otherwise. */
- OPENSSL_EXPORT int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,
- const EC_POINT *point,
- BIGNUM *x, BIGNUM *y,
- BN_CTX *ctx);
-
- /* EC_POINT_set_affine_coordinates sets the value of |p| to be (|x|, |y|). The
- * |ctx| argument may be used if not NULL. */
- OPENSSL_EXPORT int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group,
- EC_POINT *point,
- const BIGNUM *x,
- const BIGNUM *y,
- BN_CTX *ctx);
-
- /* EC_POINT_point2oct serialises |point| into the X9.62 form given by |form|
- * into, at most, |len| bytes at |buf|. It returns the number of bytes written
- * or zero on error if |buf| is non-NULL, else the number of bytes needed. The
- * |ctx| argument may be used if not NULL. */
- OPENSSL_EXPORT size_t EC_POINT_point2oct(const EC_GROUP *group,
- const EC_POINT *point,
- point_conversion_form_t form,
- uint8_t *buf, size_t len, BN_CTX *ctx);
-
- /* EC_POINT_oct2point sets |point| from |len| bytes of X9.62 format
- * serialisation in |buf|. It returns one on success and zero otherwise. The
- * |ctx| argument may be used if not NULL. */
- OPENSSL_EXPORT int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *point,
- const uint8_t *buf, size_t len,
- BN_CTX *ctx);
-
- /* EC_POINT_set_compressed_coordinates_GFp sets |point| to equal the point with
- * the given |x| coordinate and the y coordinate specified by |y_bit| (see
- * X9.62). It returns one on success and zero otherwise. */
- OPENSSL_EXPORT int EC_POINT_set_compressed_coordinates_GFp(
- const EC_GROUP *group, EC_POINT *point, const BIGNUM *x, int y_bit,
- BN_CTX *ctx);
-
-
- /* Group operations. */
-
- /* EC_POINT_add sets |r| equal to |a| plus |b|. It returns one on success and
- * zero otherwise. If |ctx| is not NULL, it may be used. */
- OPENSSL_EXPORT int EC_POINT_add(const EC_GROUP *group, EC_POINT *r,
- const EC_POINT *a, const EC_POINT *b,
- BN_CTX *ctx);
-
- /* EC_POINT_dbl sets |r| equal to |a| plus |a|. It returns one on success and
- * zero otherwise. If |ctx| is not NULL, it may be used. */
- OPENSSL_EXPORT int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r,
- const EC_POINT *a, BN_CTX *ctx);
-
- /* EC_POINT_dbl sets |a| equal to minus |a|. It returns one on success and zero
- * otherwise. If |ctx| is not NULL, it may be used. */
- OPENSSL_EXPORT int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a,
- BN_CTX *ctx);
-
- /* EC_POINT_mul sets r = generator*n + q*m. It returns one on success and zero
- * otherwise. If |ctx| is not NULL, it may be used. */
- OPENSSL_EXPORT int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r,
- const BIGNUM *n, const EC_POINT *q,
- const BIGNUM *m, BN_CTX *ctx);
-
- /* EC_POINTs_mul sets r = generator*n + sum(p[i]*m[i]). It returns one on
- * success and zero otherwise. If |ctx| is not NULL, it may be used. */
- OPENSSL_EXPORT int EC_POINTs_mul(const EC_GROUP *group, EC_POINT *r,
- const BIGNUM *n, size_t num,
- const EC_POINT *p[], const BIGNUM *m[],
- BN_CTX *ctx);
-
-
- /* Deprecated functions. */
-
- /* EC_GROUP_set_asn1_flag does nothing. */
- OPENSSL_EXPORT void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag);
-
- #define OPENSSL_EC_NAMED_CURVE 0
-
- typedef struct ec_method_st EC_METHOD;
-
- /* EC_GROUP_method_of returns NULL. */
- OPENSSL_EXPORT const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);
-
- /* EC_METHOD_get_field_type returns NID_X9_62_prime_field. */
- OPENSSL_EXPORT int EC_METHOD_get_field_type(const EC_METHOD *meth);
-
-
- /* Old code expects to get EC_KEY from ec.h. */
- #if !defined(OPENSSL_HEADER_EC_KEY_H)
- #include <openssl/ec_key.h>
- #endif
-
-
- #if defined(__cplusplus)
- } /* extern C */
- #endif
-
- #define EC_F_EC_GROUP_copy 100
- #define EC_F_EC_GROUP_get_curve_GFp 101
- #define EC_F_EC_GROUP_get_degree 102
- #define EC_F_EC_GROUP_new_by_curve_name 103
- #define EC_F_EC_KEY_check_key 104
- #define EC_F_EC_KEY_copy 105
- #define EC_F_EC_KEY_generate_key 106
- #define EC_F_EC_KEY_new_method 107
- #define EC_F_EC_KEY_set_public_key_affine_coordinates 108
- #define EC_F_EC_POINT_add 109
- #define EC_F_EC_POINT_cmp 110
- #define EC_F_EC_POINT_copy 111
- #define EC_F_EC_POINT_dbl 112
- #define EC_F_EC_POINT_dup 113
- #define EC_F_EC_POINT_get_affine_coordinates_GFp 114
- #define EC_F_EC_POINT_invert 115
- #define EC_F_EC_POINT_is_at_infinity 116
- #define EC_F_EC_POINT_is_on_curve 117
- #define EC_F_EC_POINT_make_affine 118
- #define EC_F_EC_POINT_new 119
- #define EC_F_EC_POINT_oct2point 120
- #define EC_F_EC_POINT_point2oct 121
- #define EC_F_EC_POINT_set_affine_coordinates_GFp 122
- #define EC_F_EC_POINT_set_compressed_coordinates_GFp 123
- #define EC_F_EC_POINT_set_to_infinity 124
- #define EC_F_EC_POINTs_make_affine 125
- #define EC_F_compute_wNAF 126
- #define EC_F_d2i_ECPKParameters 127
- #define EC_F_d2i_ECParameters 128
- #define EC_F_d2i_ECPrivateKey 129
- #define EC_F_ec_GFp_mont_field_decode 130
- #define EC_F_ec_GFp_mont_field_encode 131
- #define EC_F_ec_GFp_mont_field_mul 132
- #define EC_F_ec_GFp_mont_field_set_to_one 133
- #define EC_F_ec_GFp_mont_field_sqr 134
- #define EC_F_ec_GFp_mont_group_set_curve 135
- #define EC_F_ec_GFp_simple_group_check_discriminant 136
- #define EC_F_ec_GFp_simple_group_set_curve 137
- #define EC_F_ec_GFp_simple_make_affine 138
- #define EC_F_ec_GFp_simple_oct2point 139
- #define EC_F_ec_GFp_simple_point2oct 140
- #define EC_F_ec_GFp_simple_point_get_affine_coordinates 141
- #define EC_F_ec_GFp_simple_point_set_affine_coordinates 142
- #define EC_F_ec_GFp_simple_points_make_affine 143
- #define EC_F_ec_GFp_simple_set_compressed_coordinates 144
- #define EC_F_ec_asn1_group2pkparameters 145
- #define EC_F_ec_asn1_pkparameters2group 146
- #define EC_F_ec_group_new 147
- #define EC_F_ec_group_new_curve_GFp 148
- #define EC_F_ec_group_new_from_data 149
- #define EC_F_ec_point_set_Jprojective_coordinates_GFp 150
- #define EC_F_ec_pre_comp_new 151
- #define EC_F_ec_wNAF_mul 152
- #define EC_F_ec_wNAF_precompute_mult 153
- #define EC_F_i2d_ECPKParameters 154
- #define EC_F_i2d_ECParameters 155
- #define EC_F_i2d_ECPrivateKey 156
- #define EC_F_i2o_ECPublicKey 157
- #define EC_F_o2i_ECPublicKey 158
- #define EC_F_BN_to_felem 159
- #define EC_F_ec_GFp_nistp256_group_set_curve 160
- #define EC_F_ec_GFp_nistp256_point_get_affine_coordinates 161
- #define EC_F_ec_GFp_nistp256_points_mul 162
- #define EC_F_ec_group_copy 163
- #define EC_F_nistp256_pre_comp_new 164
- #define EC_R_BUFFER_TOO_SMALL 100
- #define EC_R_COORDINATES_OUT_OF_RANGE 101
- #define EC_R_D2I_ECPKPARAMETERS_FAILURE 102
- #define EC_R_EC_GROUP_NEW_BY_NAME_FAILURE 103
- #define EC_R_GROUP2PKPARAMETERS_FAILURE 104
- #define EC_R_I2D_ECPKPARAMETERS_FAILURE 105
- #define EC_R_INCOMPATIBLE_OBJECTS 106
- #define EC_R_INVALID_COMPRESSED_POINT 107
- #define EC_R_INVALID_COMPRESSION_BIT 108
- #define EC_R_INVALID_ENCODING 109
- #define EC_R_INVALID_FIELD 110
- #define EC_R_INVALID_FORM 111
- #define EC_R_INVALID_GROUP_ORDER 112
- #define EC_R_INVALID_PRIVATE_KEY 113
- #define EC_R_MISSING_PARAMETERS 114
- #define EC_R_MISSING_PRIVATE_KEY 115
- #define EC_R_NON_NAMED_CURVE 116
- #define EC_R_NOT_INITIALIZED 117
- #define EC_R_PKPARAMETERS2GROUP_FAILURE 118
- #define EC_R_POINT_AT_INFINITY 119
- #define EC_R_POINT_IS_NOT_ON_CURVE 120
- #define EC_R_SLOT_FULL 121
- #define EC_R_UNDEFINED_GENERATOR 122
- #define EC_R_UNKNOWN_GROUP 123
- #define EC_R_UNKNOWN_ORDER 124
- #define EC_R_WRONG_ORDER 125
- #define EC_R_BIGNUM_OUT_OF_RANGE 126
- #define EC_R_WRONG_CURVE_PARAMETERS 127
-
- #endif /* OPENSSL_HEADER_EC_H */
|