Commit 50db8163 authored by Matt Caswell's avatar Matt Caswell
Browse files

Deprecate the EC curve type specific functions in 1.2.0 



Reviewed-by: default avatarRich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/6815)
parent 9cc570d4

crypto/ec/ec_lib.c

+9 −3
Original line number Diff line number Diff line
@@ -435,6 +435,7 @@ int EC_GROUP_get_curve(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, 
    return group->meth->group_get_curve(group, p, a, b, ctx);

}



#if OPENSSL_API_COMPAT < 0x10200000L

int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a,

                           const BIGNUM *b, BN_CTX *ctx)

{
@@ -460,6 +461,7 @@ int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, 
    return EC_GROUP_get_curve(group, p, a, b, ctx);

}

# endif

#endif



int EC_GROUP_get_degree(const EC_GROUP *group)

{
@@ -724,6 +726,7 @@ int EC_POINT_set_affine_coordinates(const EC_GROUP *group, EC_POINT *point, 
    return 1;

}



#if OPENSSL_API_COMPAT < 0x10200000L

int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group,

                                        EC_POINT *point, const BIGNUM *x,

                                        const BIGNUM *y, BN_CTX *ctx)
@@ -739,6 +742,7 @@ int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, 
    return EC_POINT_set_affine_coordinates(group, point, x, y, ctx);

}

# endif

#endif



int EC_POINT_get_affine_coordinates(const EC_GROUP *group,

                                    const EC_POINT *point, BIGNUM *x, BIGNUM *y,
@@ -756,6 +760,7 @@ int EC_POINT_get_affine_coordinates(const EC_GROUP *group, 
    return group->meth->point_get_affine_coordinates(group, point, x, y, ctx);

}



#if OPENSSL_API_COMPAT < 0x10200000L

int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,

                                        const EC_POINT *point, BIGNUM *x,

                                        BIGNUM *y, BN_CTX *ctx)
@@ -771,6 +776,7 @@ int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group, 
    return EC_POINT_get_affine_coordinates(group, point, x, y, ctx);

}

# endif

#endif



int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a,

                 const EC_POINT *b, BN_CTX *ctx)

crypto/ec/ec_oct.c

+3 −1
Original line number Diff line number Diff line
@@ -49,6 +49,7 @@ int EC_POINT_set_compressed_coordinates(const EC_GROUP *group, EC_POINT *point, 
                                                         y_bit, ctx);

}



#if OPENSSL_API_COMPAT < 0x10200000L

int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group,

                                            EC_POINT *point, const BIGNUM *x,

                                            int y_bit, BN_CTX *ctx)
@@ -64,6 +65,7 @@ int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group, 
    return EC_POINT_set_compressed_coordinates(group, point, x, y_bit, ctx);

}

# endif

#endif



size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *point,

                          point_conversion_form_t form, unsigned char *buf,

doc/man3/EC_GROUP_new.pod

+4 −2
Original line number Diff line number Diff line
@@ -84,9 +84,11 @@ the polynomial is a trinomial or a pentanomial. 


EC_group_get_curve() obtains the previously set curve parameters.



EC_GROUP_set_curve_GFp() and EC_GROUP_set_curve_GF2m are synonyms for EC_GROUP_set_curve().

EC_GROUP_set_curve_GFp() and EC_GROUP_set_curve_GF2m() are synonyms for EC_GROUP_set_curve(). They are defined for

backwards compatibility only and should not be used.



EC_GROUP_get_curve_GFp() and EC_GROUP_get_curve_GF2m are synonyms for EC_GROUP_get_curve().

EC_GROUP_get_curve_GFp() and EC_GROUP_get_curve_GF2m() are synonyms for EC_GROUP_get_curve(). They are defined for

backwards compatibility only and should not be used.



The functions EC_GROUP_new_curve_GFp and EC_GROUP_new_curve_GF2m are shortcuts for calling EC_GROUP_new and then the

EC_GROUP_set_curve function. An appropriate default implementation method will be used.

doc/man3/EC_POINT_new.pod

+6 −3
Original line number Diff line number Diff line
@@ -126,11 +126,13 @@ may be NULL, to the corresponding coordinates of B<p>. 


The functions EC_POINT_set_affine_coordinates_GFp() and

EC_POINT_set_affine_coordinates_GF2m() are synonyms for

EC_POINT_set_affine_coordinates().

EC_POINT_set_affine_coordinates(). They are defined for backwards compatibility

only and should not be used.



The functions EC_POINT_get_affine_coordinates_GFp() and

EC_POINT_get_affine_coordinates_GF2m() are synonyms for

EC_POINT_get_affine_coordinates().

EC_POINT_get_affine_coordinates(). They are defined for backwards compatibility

only and should not be used.



As well as the affine co-ordinates, a point can alternatively be described in

terms of its Jacobian projective co-ordinates (for Fp curves only). Jacobian
@@ -153,7 +155,8 @@ possible values for y should be used. 


The functions EC_POINT_set_compressed_coordinates_GFp() and

EC_POINT_set_compressed_coordinates_GF2m() are synonyms for

EC_POINT_set_compressed_coordinates().

EC_POINT_set_compressed_coordinates(). They are defined for backwards

compatibility only and should not be used.



In addition B<EC_POINT> can be converted to and from various external

representations. The octet form is the binary encoding of the B<ECPoint>

include/openssl/ec.h

+42 −26
Original line number Diff line number Diff line
@@ -258,8 +258,9 @@ int EC_GROUP_get_curve(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, 
 *  \param  ctx    BN_CTX object (optional)

 *  \return 1 on success and 0 if an error occurred

 */

int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a,

                           const BIGNUM *b, BN_CTX *ctx);

DEPRECATEDIN_1_2_0(int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p,

                                              const BIGNUM *a, const BIGNUM *b,

                                              BN_CTX *ctx))



/** Gets the parameters of an ec curve. Synonym for EC_GROUP_get_curve

 *  \param  group  EC_GROUP object
@@ -270,8 +271,9 @@ int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, 
 *  \param  ctx    BN_CTX object (optional)

 *  \return 1 on success and 0 if an error occurred

 */

int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p, BIGNUM *a,

                           BIGNUM *b, BN_CTX *ctx);

DEPRECATEDIN_1_2_0(int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p,

                                              BIGNUM *a, BIGNUM *b,

                                              BN_CTX *ctx))



# ifndef OPENSSL_NO_EC2M

/** Sets the parameter of an ec curve. Synonym for EC_GROUP_set_curve
@@ -283,8 +285,9 @@ int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, 
 *  \param  ctx    BN_CTX object (optional)

 *  \return 1 on success and 0 if an error occurred

 */

int EC_GROUP_set_curve_GF2m(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a,

                            const BIGNUM *b, BN_CTX *ctx);

DEPRECATEDIN_1_2_0(int EC_GROUP_set_curve_GF2m(EC_GROUP *group, const BIGNUM *p,

                                               const BIGNUM *a, const BIGNUM *b,

                                               BN_CTX *ctx))



/** Gets the parameters of an ec curve. Synonym for EC_GROUP_get_curve

 *  \param  group  EC_GROUP object
@@ -295,8 +298,9 @@ int EC_GROUP_set_curve_GF2m(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, 
 *  \param  ctx    BN_CTX object (optional)

 *  \return 1 on success and 0 if an error occurred

 */

int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, BIGNUM *p, BIGNUM *a,

                            BIGNUM *b, BN_CTX *ctx);

DEPRECATEDIN_1_2_0(int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, BIGNUM *p,

                                               BIGNUM *a, BIGNUM *b,

                                               BN_CTX *ctx))

# endif

/** Returns the number of bits needed to represent a field element

 *  \param  group  EC_GROUP object
@@ -521,9 +525,11 @@ int EC_POINT_get_affine_coordinates(const EC_GROUP *group, const EC_POINT *p, 
 *  \param  ctx    BN_CTX object (optional)

 *  \return 1 on success and 0 if an error occurred

 */

int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *p,

                                        const BIGNUM *x, const BIGNUM *y,

                                        BN_CTX *ctx);

DEPRECATEDIN_1_2_0(int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group,

                                                           EC_POINT *p,

                                                           const BIGNUM *x,

                                                           const BIGNUM *y,

                                                           BN_CTX *ctx))



/** Gets the affine coordinates of an EC_POINT. A synonym of

 *  EC_POINT_get_affine_coordinates
@@ -534,9 +540,11 @@ int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *p, 
 *  \param  ctx    BN_CTX object (optional)

 *  \return 1 on success and 0 if an error occurred

 */

int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,

                                        const EC_POINT *p, BIGNUM *x,

                                        BIGNUM *y, BN_CTX *ctx);

DEPRECATEDIN_1_2_0(int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,

                                                           const EC_POINT *p,

                                                           BIGNUM *x,

                                                           BIGNUM *y,

                                                           BN_CTX *ctx))



/** Sets the x9.62 compressed coordinates of a EC_POINT

 *  \param  group  underlying EC_GROUP object
@@ -559,9 +567,11 @@ int EC_POINT_set_compressed_coordinates(const EC_GROUP *group, EC_POINT *p, 
 *  \param  ctx    BN_CTX object (optional)

 *  \return 1 on success and 0 if an error occurred

 */

int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group,

                                            EC_POINT *p, const BIGNUM *x,

                                            int y_bit, BN_CTX *ctx);

DEPRECATEDIN_1_2_0(int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group,

                                                               EC_POINT *p,

                                                               const BIGNUM *x,

                                                               int y_bit,

                                                               BN_CTX *ctx))

# ifndef OPENSSL_NO_EC2M

/** Sets the affine coordinates of an EC_POINT. A synonym of

 *  EC_POINT_set_affine_coordinates
@@ -572,9 +582,11 @@ int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, 
 *  \param  ctx    BN_CTX object (optional)

 *  \return 1 on success and 0 if an error occurred

 */

int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p,

                                         const BIGNUM *x, const BIGNUM *y,

                                         BN_CTX *ctx);

DEPRECATEDIN_1_2_0(int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group,

                                                            EC_POINT *p,

                                                            const BIGNUM *x,

                                                            const BIGNUM *y,

                                                            BN_CTX *ctx))



/** Gets the affine coordinates of an EC_POINT. A synonym of

 *  EC_POINT_get_affine_coordinates
@@ -585,9 +597,11 @@ int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p, 
 *  \param  ctx    BN_CTX object (optional)

 *  \return 1 on success and 0 if an error occurred

 */

int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group,

                                         const EC_POINT *p, BIGNUM *x,

                                         BIGNUM *y, BN_CTX *ctx);

DEPRECATEDIN_1_2_0(int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group,

                                                            const EC_POINT *p,

                                                            BIGNUM *x,

                                                            BIGNUM *y,

                                                            BN_CTX *ctx))



/** Sets the x9.62 compressed coordinates of a EC_POINT. A synonym of

 *  EC_POINT_set_compressed_coordinates
@@ -598,9 +612,11 @@ int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group, 
 *  \param  ctx    BN_CTX object (optional)

 *  \return 1 on success and 0 if an error occurred

 */

int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group,

                                             EC_POINT *p, const BIGNUM *x,

                                             int y_bit, BN_CTX *ctx);

DEPRECATEDIN_1_2_0(int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group,

                                                                EC_POINT *p,

                                                                const BIGNUM *x,

                                                                int y_bit,

                                                                BN_CTX *ctx))

# endif

/** Encodes a EC_POINT object to a octet string

 *  \param  group  underlying EC_GROUP object