You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

398 regels
17 KiB

  1. /* Originally written by Bodo Moeller for the OpenSSL project.
  2. * ====================================================================
  3. * Copyright (c) 1998-2005 The OpenSSL Project. All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions
  7. * are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright
  10. * notice, this list of conditions and the following disclaimer.
  11. *
  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.
  16. *
  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).
  53. *
  54. */
  55. /* ====================================================================
  56. * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  57. *
  58. * Portions of the attached software ("Contribution") are developed by
  59. * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
  60. *
  61. * The Contribution is licensed pursuant to the OpenSSL open source
  62. * license provided above.
  63. *
  64. * The elliptic curve binary polynomial software is originally written by
  65. * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems
  66. * Laboratories. */
  67. #ifndef OPENSSL_HEADER_EC_H
  68. #define OPENSSL_HEADER_EC_H
  69. #include <openssl/base.h>
  70. #if defined(__cplusplus)
  71. extern "C" {
  72. #endif
  73. /* Low-level operations on elliptic curves. */
  74. typedef struct ec_group_st EC_GROUP;
  75. typedef struct ec_point_st EC_POINT;
  76. /* point_conversion_form_t enumerates forms, as defined in X9.62 (ECDSA), for
  77. * the encoding of a elliptic curve point (x,y) */
  78. typedef enum {
  79. /* POINT_CONVERSION_COMPRESSED indicates that the point is encoded as z||x,
  80. * where the octet z specifies which solution of the quadratic equation y
  81. * is. */
  82. POINT_CONVERSION_COMPRESSED = 2,
  83. /* POINT_CONVERSION_COMPRESSED indicates that the point is encoded as
  84. * z||x||y, where z is the octet 0x04. */
  85. POINT_CONVERSION_UNCOMPRESSED = 4,
  86. /* POINT_CONVERSION_HYBRID indicates that the point is encoded as z||x||y,
  87. * where z specifies which solution of the quadratic equation y is. This is
  88. * not supported by the code and has never been observed in use.
  89. *
  90. * TODO(agl): remove once node.js no longer references this. */
  91. POINT_CONVERSION_HYBRID = 6,
  92. } point_conversion_form_t;
  93. /* Elliptic curve groups. */
  94. /* EC_GROUP_new_by_curve_name returns a fresh EC_GROUP object for the elliptic
  95. * curve specified by |nid|, or NULL on error.
  96. *
  97. * The supported NIDs are:
  98. * NID_secp224r1,
  99. * NID_X9_62_prime256v1,
  100. * NID_secp384r1,
  101. * NID_secp521r1 */
  102. OPENSSL_EXPORT EC_GROUP *EC_GROUP_new_by_curve_name(int nid);
  103. /* EC_GROUP_free frees |group| and the data that it points to. */
  104. OPENSSL_EXPORT void EC_GROUP_free(EC_GROUP *group);
  105. /* EC_GROUP_dup returns a fresh |EC_GROUP| which is equal to |a| or NULL on
  106. * error. */
  107. OPENSSL_EXPORT EC_GROUP *EC_GROUP_dup(const EC_GROUP *a);
  108. /* EC_GROUP_cmp returns zero if |a| and |b| are the same group and non-zero
  109. * otherwise. */
  110. OPENSSL_EXPORT int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b,
  111. BN_CTX *ignored);
  112. /* EC_GROUP_get0_generator returns a pointer to the internal |EC_POINT| object
  113. * in |group| that specifies the generator for the group. */
  114. OPENSSL_EXPORT const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group);
  115. /* EC_GROUP_get0_order returns a pointer to the internal |BIGNUM| object in
  116. * |group| that specifies the order of the group. */
  117. OPENSSL_EXPORT const BIGNUM *EC_GROUP_get0_order(const EC_GROUP *group);
  118. /* EC_GROUP_get_cofactor sets |*cofactor| to the cofactor of |group| using
  119. * |ctx|, if it's not NULL. It returns one on success and zero otherwise. */
  120. OPENSSL_EXPORT int EC_GROUP_get_cofactor(const EC_GROUP *group,
  121. BIGNUM *cofactor, BN_CTX *ctx);
  122. /* EC_GROUP_get_curve_GFp gets various parameters about a group. It sets
  123. * |*out_p| to the order of the coordinate field and |*out_a| and |*out_b| to
  124. * the parameters of the curve when expressed as y² = x³ + ax + b. Any of the
  125. * output parameters can be NULL. It returns one on success and zero on
  126. * error. */
  127. OPENSSL_EXPORT int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *out_p,
  128. BIGNUM *out_a, BIGNUM *out_b,
  129. BN_CTX *ctx);
  130. /* EC_GROUP_get_curve_name returns a NID that identifies |group|. */
  131. OPENSSL_EXPORT int EC_GROUP_get_curve_name(const EC_GROUP *group);
  132. /* EC_GROUP_get_degree returns the number of bits needed to represent an
  133. * element of the field underlying |group|. */
  134. OPENSSL_EXPORT unsigned EC_GROUP_get_degree(const EC_GROUP *group);
  135. /* Points on elliptic curves. */
  136. /* EC_POINT_new returns a fresh |EC_POINT| object in the given group, or NULL
  137. * on error. */
  138. OPENSSL_EXPORT EC_POINT *EC_POINT_new(const EC_GROUP *group);
  139. /* EC_POINT_free frees |point| and the data that it points to. */
  140. OPENSSL_EXPORT void EC_POINT_free(EC_POINT *point);
  141. /* EC_POINT_clear_free clears the data that |point| points to, frees it and
  142. * then frees |point| itself. */
  143. OPENSSL_EXPORT void EC_POINT_clear_free(EC_POINT *point);
  144. /* EC_POINT_copy sets |*dest| equal to |*src|. It returns one on success and
  145. * zero otherwise. */
  146. OPENSSL_EXPORT int EC_POINT_copy(EC_POINT *dest, const EC_POINT *src);
  147. /* EC_POINT_dup returns a fresh |EC_POINT| that contains the same values as
  148. * |src|, or NULL on error. */
  149. OPENSSL_EXPORT EC_POINT *EC_POINT_dup(const EC_POINT *src,
  150. const EC_GROUP *group);
  151. /* EC_POINT_set_to_infinity sets |point| to be the "point at infinity" for the
  152. * given group. */
  153. OPENSSL_EXPORT int EC_POINT_set_to_infinity(const EC_GROUP *group,
  154. EC_POINT *point);
  155. /* EC_POINT_is_at_infinity returns one iff |point| is the point at infinity and
  156. * zero otherwise. */
  157. OPENSSL_EXPORT int EC_POINT_is_at_infinity(const EC_GROUP *group,
  158. const EC_POINT *point);
  159. /* EC_POINT_is_on_curve returns one if |point| is an element of |group| and
  160. * and zero otherwise or when an error occurs. This is different from OpenSSL,
  161. * which returns -1 on error. If |ctx| is non-NULL, it may be used. */
  162. OPENSSL_EXPORT int EC_POINT_is_on_curve(const EC_GROUP *group,
  163. const EC_POINT *point, BN_CTX *ctx);
  164. /* EC_POINT_cmp returns zero if |a| is equal to |b|, greater than zero if
  165. * not equal and -1 on error. If |ctx| is not NULL, it may be used. */
  166. OPENSSL_EXPORT int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a,
  167. const EC_POINT *b, BN_CTX *ctx);
  168. /* EC_POINT_make_affine converts |point| to affine form, internally. It returns
  169. * one on success and zero otherwise. If |ctx| is not NULL, it may be used. */
  170. OPENSSL_EXPORT int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point,
  171. BN_CTX *ctx);
  172. /* EC_POINTs_make_affine converts |num| points from |points| to affine form,
  173. * internally. It returns one on success and zero otherwise. If |ctx| is not
  174. * NULL, it may be used. */
  175. OPENSSL_EXPORT int EC_POINTs_make_affine(const EC_GROUP *group, size_t num,
  176. EC_POINT *points[], BN_CTX *ctx);
  177. /* Point conversion. */
  178. /* EC_POINT_get_affine_coordinates_GFp sets |x| and |y| to the affine value of
  179. * |point| using |ctx|, if it's not NULL. It returns one on success and zero
  180. * otherwise. */
  181. OPENSSL_EXPORT int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group,
  182. const EC_POINT *point,
  183. BIGNUM *x, BIGNUM *y,
  184. BN_CTX *ctx);
  185. /* EC_POINT_set_affine_coordinates_GFp sets the value of |point| to be
  186. * (|x|, |y|). The |ctx| argument may be used if not NULL. It returns one
  187. * on success or zero on error. Note that, unlike with OpenSSL, it's
  188. * considered an error if the point is not on the curve. */
  189. OPENSSL_EXPORT int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group,
  190. EC_POINT *point,
  191. const BIGNUM *x,
  192. const BIGNUM *y,
  193. BN_CTX *ctx);
  194. /* EC_POINT_point2oct serialises |point| into the X9.62 form given by |form|
  195. * into, at most, |len| bytes at |buf|. It returns the number of bytes written
  196. * or zero on error if |buf| is non-NULL, else the number of bytes needed. The
  197. * |ctx| argument may be used if not NULL. */
  198. OPENSSL_EXPORT size_t EC_POINT_point2oct(const EC_GROUP *group,
  199. const EC_POINT *point,
  200. point_conversion_form_t form,
  201. uint8_t *buf, size_t len, BN_CTX *ctx);
  202. /* EC_POINT_point2cbb behaves like |EC_POINT_point2oct| but appends the
  203. * serialised point to |cbb|. It returns one on success and zero on error. */
  204. OPENSSL_EXPORT int EC_POINT_point2cbb(CBB *out, const EC_GROUP *group,
  205. const EC_POINT *point,
  206. point_conversion_form_t form,
  207. BN_CTX *ctx);
  208. /* EC_POINT_oct2point sets |point| from |len| bytes of X9.62 format
  209. * serialisation in |buf|. It returns one on success and zero otherwise. The
  210. * |ctx| argument may be used if not NULL. */
  211. OPENSSL_EXPORT int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *point,
  212. const uint8_t *buf, size_t len,
  213. BN_CTX *ctx);
  214. /* EC_POINT_set_compressed_coordinates_GFp sets |point| to equal the point with
  215. * the given |x| coordinate and the y coordinate specified by |y_bit| (see
  216. * X9.62). It returns one on success and zero otherwise. */
  217. OPENSSL_EXPORT int EC_POINT_set_compressed_coordinates_GFp(
  218. const EC_GROUP *group, EC_POINT *point, const BIGNUM *x, int y_bit,
  219. BN_CTX *ctx);
  220. /* Group operations. */
  221. /* EC_POINT_add sets |r| equal to |a| plus |b|. It returns one on success and
  222. * zero otherwise. If |ctx| is not NULL, it may be used. */
  223. OPENSSL_EXPORT int EC_POINT_add(const EC_GROUP *group, EC_POINT *r,
  224. const EC_POINT *a, const EC_POINT *b,
  225. BN_CTX *ctx);
  226. /* EC_POINT_dbl sets |r| equal to |a| plus |a|. It returns one on success and
  227. * zero otherwise. If |ctx| is not NULL, it may be used. */
  228. OPENSSL_EXPORT int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r,
  229. const EC_POINT *a, BN_CTX *ctx);
  230. /* EC_POINT_invert sets |a| equal to minus |a|. It returns one on success and zero
  231. * otherwise. If |ctx| is not NULL, it may be used. */
  232. OPENSSL_EXPORT int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a,
  233. BN_CTX *ctx);
  234. /* EC_POINT_mul sets r = generator*n + q*m. It returns one on success and zero
  235. * otherwise. If |ctx| is not NULL, it may be used. */
  236. OPENSSL_EXPORT int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r,
  237. const BIGNUM *n, const EC_POINT *q,
  238. const BIGNUM *m, BN_CTX *ctx);
  239. /* Deprecated functions. */
  240. /* EC_GROUP_new_curve_GFp creates a new, arbitrary elliptic curve group based
  241. * on the equation y² = x³ + a·x + b. It returns the new group or NULL on
  242. * error.
  243. *
  244. * This new group has no generator. It is an error to use a generator-less group
  245. * with any functions except for |EC_GROUP_free|, |EC_POINT_new|,
  246. * |EC_POINT_set_affine_coordinates_GFp|, and |EC_GROUP_set_generator|.
  247. *
  248. * |EC_GROUP|s returned by this function will always compare as unequal via
  249. * |EC_GROUP_cmp| (even to themselves). |EC_GROUP_get_curve_name| will always
  250. * return |NID_undef|.
  251. *
  252. * Avoid using arbitrary curves and use |EC_GROUP_new_by_curve_name| instead. */
  253. OPENSSL_EXPORT EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p,
  254. const BIGNUM *a,
  255. const BIGNUM *b, BN_CTX *ctx);
  256. /* EC_GROUP_set_generator sets the generator for |group| to |generator|, which
  257. * must have the given order and cofactor. It may only be used with |EC_GROUP|
  258. * objects returned by |EC_GROUP_new_curve_GFp| and may only be used once on
  259. * each group. */
  260. OPENSSL_EXPORT int EC_GROUP_set_generator(EC_GROUP *group,
  261. const EC_POINT *generator,
  262. const BIGNUM *order,
  263. const BIGNUM *cofactor);
  264. /* EC_GROUP_get_order sets |*order| to the order of |group|, if it's not
  265. * NULL. It returns one on success and zero otherwise. |ctx| is ignored. Use
  266. * |EC_GROUP_get0_order| instead. */
  267. OPENSSL_EXPORT int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order,
  268. BN_CTX *ctx);
  269. /* EC_GROUP_set_asn1_flag does nothing. */
  270. OPENSSL_EXPORT void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag);
  271. #define OPENSSL_EC_NAMED_CURVE 0
  272. typedef struct ec_method_st EC_METHOD;
  273. /* EC_GROUP_method_of returns NULL. */
  274. OPENSSL_EXPORT const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);
  275. /* EC_METHOD_get_field_type returns NID_X9_62_prime_field. */
  276. OPENSSL_EXPORT int EC_METHOD_get_field_type(const EC_METHOD *meth);
  277. /* EC_GROUP_set_point_conversion_form aborts the process if |form| is not
  278. * |POINT_CONVERSION_UNCOMPRESSED| and otherwise does nothing. */
  279. OPENSSL_EXPORT void EC_GROUP_set_point_conversion_form(
  280. EC_GROUP *group, point_conversion_form_t form);
  281. /* EC_builtin_curve describes a supported elliptic curve. */
  282. typedef struct {
  283. int nid;
  284. const char *comment;
  285. } EC_builtin_curve;
  286. /* EC_get_builtin_curves writes at most |max_num_curves| elements to
  287. * |out_curves| and returns the total number that it would have written, had
  288. * |max_num_curves| been large enough.
  289. *
  290. * The |EC_builtin_curve| items describe the supported elliptic curves. */
  291. OPENSSL_EXPORT size_t EC_get_builtin_curves(EC_builtin_curve *out_curves,
  292. size_t max_num_curves);
  293. /* Old code expects to get EC_KEY from ec.h. */
  294. #include <openssl/ec_key.h>
  295. #if defined(__cplusplus)
  296. } /* extern C */
  297. #endif
  298. #define EC_R_BUFFER_TOO_SMALL 100
  299. #define EC_R_COORDINATES_OUT_OF_RANGE 101
  300. #define EC_R_D2I_ECPKPARAMETERS_FAILURE 102
  301. #define EC_R_EC_GROUP_NEW_BY_NAME_FAILURE 103
  302. #define EC_R_GROUP2PKPARAMETERS_FAILURE 104
  303. #define EC_R_I2D_ECPKPARAMETERS_FAILURE 105
  304. #define EC_R_INCOMPATIBLE_OBJECTS 106
  305. #define EC_R_INVALID_COMPRESSED_POINT 107
  306. #define EC_R_INVALID_COMPRESSION_BIT 108
  307. #define EC_R_INVALID_ENCODING 109
  308. #define EC_R_INVALID_FIELD 110
  309. #define EC_R_INVALID_FORM 111
  310. #define EC_R_INVALID_GROUP_ORDER 112
  311. #define EC_R_INVALID_PRIVATE_KEY 113
  312. #define EC_R_MISSING_PARAMETERS 114
  313. #define EC_R_MISSING_PRIVATE_KEY 115
  314. #define EC_R_NON_NAMED_CURVE 116
  315. #define EC_R_NOT_INITIALIZED 117
  316. #define EC_R_PKPARAMETERS2GROUP_FAILURE 118
  317. #define EC_R_POINT_AT_INFINITY 119
  318. #define EC_R_POINT_IS_NOT_ON_CURVE 120
  319. #define EC_R_SLOT_FULL 121
  320. #define EC_R_UNDEFINED_GENERATOR 122
  321. #define EC_R_UNKNOWN_GROUP 123
  322. #define EC_R_UNKNOWN_ORDER 124
  323. #define EC_R_WRONG_ORDER 125
  324. #define EC_R_BIGNUM_OUT_OF_RANGE 126
  325. #define EC_R_WRONG_CURVE_PARAMETERS 127
  326. #define EC_R_DECODE_ERROR 128
  327. #define EC_R_ENCODE_ERROR 129
  328. #define EC_R_GROUP_MISMATCH 130
  329. #define EC_R_INVALID_COFACTOR 131
  330. #endif /* OPENSSL_HEADER_EC_H */