2a9729bb3d55b84e083e5808a547b502ea712532
[openssl.git] / crypto / ec / curve448 / point_448.h
1 /**
2  * @file decaf/point_448.h
3  * @author Mike Hamburg
4  *
5  * @copyright
6  *   Copyright (c) 2015-2016 Cryptography Research, Inc.  \n
7  *   Released under the MIT License.  See LICENSE.txt for license information.
8  *
9  * @brief A group of prime order p, based on Ed448-Goldilocks.
10  *
11  * @warning This file was automatically generated in Python.
12  * Please do not edit it.
13  */
14
15 #ifndef __DECAF_POINT_448_H__
16 #define __DECAF_POINT_448_H__ 1
17
18 #include "curve448utils.h"
19
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23
24 /** @cond internal */
25 #define DECAF_448_SCALAR_LIMBS ((446-1)/DECAF_WORD_BITS+1)
26 /** @endcond */
27
28 /** The number of bits in a scalar */
29 #define DECAF_448_SCALAR_BITS 446
30
31 /** @cond internal */
32 #ifndef __DECAF_448_GF_DEFINED__
33 #define __DECAF_448_GF_DEFINED__ 1
34 /** @brief Galois field element internal structure */
35 typedef struct gf_448_s {
36     decaf_word_t limb[512/DECAF_WORD_BITS];
37 } __attribute__((aligned(32))) gf_448_s, gf_448_t[1];
38 #endif /* __DECAF_448_GF_DEFINED__ */
39 /** @endcond */
40
41 /** Number of bytes in a serialized point. */
42 #define DECAF_448_SER_BYTES 56
43
44 /** Number of bytes in an elligated point.  For now set the same as SER_BYTES
45  * but could be different for other curves.
46  */
47 #define DECAF_448_HASH_BYTES 56
48
49 /** Number of bytes in a serialized scalar. */
50 #define DECAF_448_SCALAR_BYTES 56
51
52 /** Number of bits in the "which" field of an elligator inverse */
53 #define DECAF_448_INVERT_ELLIGATOR_WHICH_BITS 3
54
55 /** The cofactor the curve would have, if we hadn't removed it */
56 #define DECAF_448_REMOVED_COFACTOR 4
57
58 /** X448 encoding ratio. */
59 #define DECAF_X448_ENCODE_RATIO 2
60
61 /** Number of bytes in an x448 public key */
62 #define DECAF_X448_PUBLIC_BYTES 56
63
64 /** Number of bytes in an x448 private key */
65 #define DECAF_X448_PRIVATE_BYTES 56
66
67 /** Twisted Edwards extended homogeneous coordinates */
68 typedef struct decaf_448_point_s {
69     /** @cond internal */
70     gf_448_t x,y,z,t;
71     /** @endcond */
72 } decaf_448_point_t[1];
73
74 /** Precomputed table based on a point.  Can be trivial implementation. */
75 struct decaf_448_precomputed_s;
76
77 /** Precomputed table based on a point.  Can be trivial implementation. */
78 typedef struct decaf_448_precomputed_s decaf_448_precomputed_s; 
79
80 /** Scalar is stored packed, because we don't need the speed. */
81 typedef struct decaf_448_scalar_s {
82     /** @cond internal */
83     decaf_word_t limb[DECAF_448_SCALAR_LIMBS];
84     /** @endcond */
85 } decaf_448_scalar_t[1];
86
87 /** A scalar equal to 1. */
88 extern const decaf_448_scalar_t decaf_448_scalar_one DECAF_API_VIS;
89
90 /** A scalar equal to 0. */
91 extern const decaf_448_scalar_t decaf_448_scalar_zero DECAF_API_VIS;
92
93 /** The identity point on the curve. */
94 extern const decaf_448_point_t decaf_448_point_identity DECAF_API_VIS;
95
96 /** An arbitrarily chosen base point on the curve. */
97 extern const decaf_448_point_t decaf_448_point_base DECAF_API_VIS;
98
99 /** Precomputed table for the base point on the curve. */
100 extern const struct decaf_448_precomputed_s *decaf_448_precomputed_base DECAF_API_VIS;
101
102 /**
103  * @brief Read a scalar from wire format or from bytes.
104  *
105  * @param [in] ser Serialized form of a scalar.
106  * @param [out] out Deserialized form.
107  *
108  * @retval DECAF_SUCCESS The scalar was correctly encoded.
109  * @retval DECAF_FAILURE The scalar was greater than the modulus,
110  * and has been reduced modulo that modulus.
111  */
112 decaf_error_t decaf_448_scalar_decode (
113     decaf_448_scalar_t out,
114     const unsigned char ser[DECAF_448_SCALAR_BYTES]
115 ) DECAF_API_VIS DECAF_WARN_UNUSED DECAF_NONNULL DECAF_NOINLINE;
116
117 /**
118  * @brief Read a scalar from wire format or from bytes.  Reduces mod
119  * scalar prime.
120  *
121  * @param [in] ser Serialized form of a scalar.
122  * @param [in] ser_len Length of serialized form.
123  * @param [out] out Deserialized form.
124  */
125 void decaf_448_scalar_decode_long (
126     decaf_448_scalar_t out,
127     const unsigned char *ser,
128     size_t ser_len
129 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
130     
131 /**
132  * @brief Serialize a scalar to wire format.
133  *
134  * @param [out] ser Serialized form of a scalar.
135  * @param [in] s Deserialized scalar.
136  */
137 void decaf_448_scalar_encode (
138     unsigned char ser[DECAF_448_SCALAR_BYTES],
139     const decaf_448_scalar_t s
140 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE DECAF_NOINLINE;
141         
142 /**
143  * @brief Add two scalars.  The scalars may use the same memory.
144  * @param [in] a One scalar.
145  * @param [in] b Another scalar.
146  * @param [out] out a+b.
147  */
148 void decaf_448_scalar_add (
149     decaf_448_scalar_t out,
150     const decaf_448_scalar_t a,
151     const decaf_448_scalar_t b
152 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
153
154 /**
155  * @brief Compare two scalars.
156  * @param [in] a One scalar.
157  * @param [in] b Another scalar.
158  * @retval DECAF_TRUE The scalars are equal.
159  * @retval DECAF_FALSE The scalars are not equal.
160  */    
161 decaf_bool_t decaf_448_scalar_eq (
162     const decaf_448_scalar_t a,
163     const decaf_448_scalar_t b
164 ) DECAF_API_VIS DECAF_WARN_UNUSED DECAF_NONNULL DECAF_NOINLINE;
165
166 /**
167  * @brief Subtract two scalars.  The scalars may use the same memory.
168  * @param [in] a One scalar.
169  * @param [in] b Another scalar.
170  * @param [out] out a-b.
171  */  
172 void decaf_448_scalar_sub (
173     decaf_448_scalar_t out,
174     const decaf_448_scalar_t a,
175     const decaf_448_scalar_t b
176 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
177
178 /**
179  * @brief Multiply two scalars.  The scalars may use the same memory.
180  * @param [in] a One scalar.
181  * @param [in] b Another scalar.
182  * @param [out] out a*b.
183  */  
184 void decaf_448_scalar_mul (
185     decaf_448_scalar_t out,
186     const decaf_448_scalar_t a,
187     const decaf_448_scalar_t b
188 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
189         
190 /**
191 * @brief Halve a scalar.  The scalars may use the same memory.
192 * @param [in] a A scalar.
193 * @param [out] out a/2.
194 */
195 void decaf_448_scalar_halve (
196    decaf_448_scalar_t out,
197    const decaf_448_scalar_t a
198 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
199
200 /**
201  * @brief Invert a scalar.  When passed zero, return 0.  The input and output may alias.
202  * @param [in] a A scalar.
203  * @param [out] out 1/a.
204  * @return DECAF_SUCCESS The input is nonzero.
205  */  
206 decaf_error_t decaf_448_scalar_invert (
207     decaf_448_scalar_t out,
208     const decaf_448_scalar_t a
209 ) DECAF_API_VIS DECAF_WARN_UNUSED DECAF_NONNULL DECAF_NOINLINE;
210
211 /**
212  * @brief Copy a scalar.  The scalars may use the same memory, in which
213  * case this function does nothing.
214  * @param [in] a A scalar.
215  * @param [out] out Will become a copy of a.
216  */
217 static inline void DECAF_NONNULL decaf_448_scalar_copy (
218     decaf_448_scalar_t out,
219     const decaf_448_scalar_t a
220 ) {
221     *out = *a;
222 }
223
224 /**
225  * @brief Set a scalar to an unsigned 64-bit integer.
226  * @param [in] a An integer.
227  * @param [out] out Will become equal to a.
228  */  
229 void decaf_448_scalar_set_unsigned (
230     decaf_448_scalar_t out,
231     uint64_t a
232 ) DECAF_API_VIS DECAF_NONNULL;
233
234 /**
235  * @brief Copy a point.  The input and output may alias,
236  * in which case this function does nothing.
237  *
238  * @param [out] a A copy of the point.
239  * @param [in] b Any point.
240  */
241 static inline void DECAF_NONNULL decaf_448_point_copy (
242     decaf_448_point_t a,
243     const decaf_448_point_t b
244 ) {
245     *a=*b;
246 }
247
248 /**
249  * @brief Test whether two points are equal.  If yes, return
250  * DECAF_TRUE, else return DECAF_FALSE.
251  *
252  * @param [in] a A point.
253  * @param [in] b Another point.
254  * @retval DECAF_TRUE The points are equal.
255  * @retval DECAF_FALSE The points are not equal.
256  */
257 decaf_bool_t decaf_448_point_eq (
258     const decaf_448_point_t a,
259     const decaf_448_point_t b
260 ) DECAF_API_VIS DECAF_WARN_UNUSED DECAF_NONNULL DECAF_NOINLINE;
261
262 /**
263  * @brief Double a point.  Equivalent to
264  * decaf_448_point_add(two_a,a,a), but potentially faster.
265  *
266  * @param [out] two_a The sum a+a.
267  * @param [in] a A point.
268  */
269 void decaf_448_point_double (
270     decaf_448_point_t two_a,
271     const decaf_448_point_t a
272 ) DECAF_API_VIS DECAF_NONNULL;
273
274 /**
275  * @brief RFC 7748 Diffie-Hellman scalarmul.  This function uses a different
276  * (non-Decaf) encoding.
277  *
278  * @param [out] scaled The scaled point base*scalar
279  * @param [in] base The point to be scaled.
280  * @param [in] scalar The scalar to multiply by.
281  *
282  * @retval DECAF_SUCCESS The scalarmul succeeded.
283  * @retval DECAF_FAILURE The scalarmul didn't succeed, because the base
284  * point is in a small subgroup.
285  */
286 decaf_error_t decaf_x448 (
287     uint8_t out[DECAF_X448_PUBLIC_BYTES],
288     const uint8_t base[DECAF_X448_PUBLIC_BYTES],
289     const uint8_t scalar[DECAF_X448_PRIVATE_BYTES]
290 ) DECAF_API_VIS DECAF_NONNULL DECAF_WARN_UNUSED DECAF_NOINLINE;
291
292 /**
293  * @brief Multiply a point by DECAF_X448_ENCODE_RATIO,
294  * then encode it like RFC 7748.
295  *
296  * This function is mainly used internally, but is exported in case
297  * it will be useful.
298  *
299  * The ratio is necessary because the internal representation doesn't
300  * track the cofactor information, so on output we must clear the cofactor.
301  * This would multiply by the cofactor, but in fact internally libdecaf's
302  * points are always even, so it multiplies by half the cofactor instead.
303  *
304  * As it happens, this aligns with the base point definitions; that is,
305  * if you pass the Decaf/Ristretto base point to this function, the result
306  * will be DECAF_X448_ENCODE_RATIO times the X448
307  * base point.
308  *
309  * @param [out] out The scaled and encoded point.
310  * @param [in] p The point to be scaled and encoded.
311  */
312 void decaf_448_point_mul_by_ratio_and_encode_like_x448 (
313     uint8_t out[DECAF_X448_PUBLIC_BYTES],
314     const decaf_448_point_t p
315 ) DECAF_API_VIS DECAF_NONNULL;
316
317 /** The base point for X448 Diffie-Hellman */
318 extern const uint8_t decaf_x448_base_point[DECAF_X448_PUBLIC_BYTES] DECAF_API_VIS;
319     
320 /**
321  * @brief RFC 7748 Diffie-Hellman base point scalarmul.  This function uses
322  * a different (non-Decaf) encoding.
323  *
324  * Does exactly the same thing as decaf_x448_generate_key,
325  * but has a better name.
326  *
327  * @param [out] scaled The scaled point base*scalar
328  * @param [in] scalar The scalar to multiply by.
329  */
330 void decaf_x448_derive_public_key (
331     uint8_t out[DECAF_X448_PUBLIC_BYTES],
332     const uint8_t scalar[DECAF_X448_PRIVATE_BYTES]
333 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
334
335 /* FUTURE: uint8_t decaf_448_encode_like_curve448) */
336
337 /**
338  * @brief Precompute a table for fast scalar multiplication.
339  * Some implementations do not include precomputed points; for
340  * those implementations, this implementation simply copies the
341  * point.
342  *
343  * @param [out] a A precomputed table of multiples of the point.
344  * @param [in] b Any point.
345  */
346 void decaf_448_precompute (
347     decaf_448_precomputed_s *a,
348     const decaf_448_point_t b
349 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
350
351 /**
352  * @brief Multiply a precomputed base point by a scalar:
353  * scaled = scalar*base.
354  * Some implementations do not include precomputed points; for
355  * those implementations, this function is the same as
356  * decaf_448_point_scalarmul
357  *
358  * @param [out] scaled The scaled point base*scalar
359  * @param [in] base The point to be scaled.
360  * @param [in] scalar The scalar to multiply by.
361  */
362 void decaf_448_precomputed_scalarmul (
363     decaf_448_point_t scaled,
364     const decaf_448_precomputed_s *base,
365     const decaf_448_scalar_t scalar
366 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
367
368
369 /**
370  * @brief Multiply two base points by two scalars:
371  * scaled = scalar1*decaf_448_point_base + scalar2*base2.
372  *
373  * Otherwise equivalent to decaf_448_point_double_scalarmul, but may be
374  * faster at the expense of being variable time.
375  *
376  * @param [out] combo The linear combination scalar1*base + scalar2*base2.
377  * @param [in] scalar1 A first scalar to multiply by.
378  * @param [in] base2 A second point to be scaled.
379  * @param [in] scalar2 A second scalar to multiply by.
380  *
381  * @warning: This function takes variable time, and may leak the scalars
382  * used.  It is designed for signature verification.
383  */
384 void decaf_448_base_double_scalarmul_non_secret (
385     decaf_448_point_t combo,
386     const decaf_448_scalar_t scalar1,
387     const decaf_448_point_t base2,
388     const decaf_448_scalar_t scalar2
389 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
390
391 /**
392  * @brief Constant-time decision between two scalars.  If pick_b
393  * is zero, out = a; else out = b.
394  *
395  * @param [out] out The output.  It may be the same as either input.
396  * @param [in] a Any scalar.
397  * @param [in] b Any scalar.
398  * @param [in] pick_b If nonzero, choose scalar b.
399  */
400 void decaf_448_scalar_cond_sel (
401     decaf_448_scalar_t out,
402     const decaf_448_scalar_t a,
403     const decaf_448_scalar_t b,
404     decaf_word_t pick_b
405 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
406
407 /**
408  * @brief Test that a point is valid, for debugging purposes.
409  *
410  * @param [in] to_test The point to test.
411  * @retval DECAF_TRUE The point is valid.
412  * @retval DECAF_FALSE The point is invalid.
413  */
414 decaf_bool_t decaf_448_point_valid (
415     const decaf_448_point_t to_test
416 ) DECAF_API_VIS DECAF_WARN_UNUSED DECAF_NONNULL DECAF_NOINLINE;
417
418
419 /**
420  * @brief Almost-Elligator-like hash to curve.
421  *
422  * Call this function with the output of a hash to make a hash to the curve.
423  *
424  * This function runs Elligator2 on the decaf_448 Jacobi quartic model.  It then
425  * uses the isogeny to put the result in twisted Edwards form.  As a result,
426  * it is safe (cannot produce points of order 4), and would be compatible with
427  * hypothetical other implementations of Decaf using a Montgomery or untwisted
428  * Edwards model.
429  *
430  * Unlike Elligator, this function may be up to 4:1 on [0,(p-1)/2]:
431  *   A factor of 2 due to the isogeny.
432  *   A factor of 2 because we quotient out the 2-torsion.
433  *
434  * This makes it about 8:1 overall, or 16:1 overall on curves with cofactor 8.
435  *
436  * Negating the input (mod q) results in the same point.  Inverting the input
437  * (mod q) results in the negative point.  This is the same as Elligator.
438  *
439  * This function isn't quite indifferentiable from a random oracle.
440  * However, it is suitable for many protocols, including SPEKE and SPAKE2 EE. 
441  * Furthermore, calling it twice with independent seeds and adding the results
442  * is indifferentiable from a random oracle.
443  *
444  * @param [in] hashed_data Output of some hash function.
445  * @param [out] pt The data hashed to the curve.
446  */
447 void
448 decaf_448_point_from_hash_nonuniform (
449     decaf_448_point_t pt,
450     const unsigned char hashed_data[DECAF_448_HASH_BYTES]
451 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
452
453 /**
454  * @brief Indifferentiable hash function encoding to curve.
455  *
456  * Equivalent to calling decaf_448_point_from_hash_nonuniform twice and adding.
457  *
458  * @param [in] hashed_data Output of some hash function.
459  * @param [out] pt The data hashed to the curve.
460  */ 
461 void decaf_448_point_from_hash_uniform (
462     decaf_448_point_t pt,
463     const unsigned char hashed_data[2*DECAF_448_HASH_BYTES]
464 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE;
465
466 /**
467  * @brief Inverse of elligator-like hash to curve.
468  *
469  * This function writes to the buffer, to make it so that
470  * decaf_448_point_from_hash_nonuniform(buffer) = pt if
471  * possible.  Since there may be multiple preimages, the
472  * "which" parameter chooses between them.  To ensure uniform
473  * inverse sampling, this function succeeds or fails
474  * independently for different "which" values.
475  *
476  * This function isn't guaranteed to find every possible
477  * preimage, but it finds all except a small finite number.
478  * In particular, when the number of bits in the modulus isn't
479  * a multiple of 8 (i.e. for curve25519), it sets the high bits
480  * independently, which enables the generated data to be uniform.
481  * But it doesn't add p, so you'll never get exactly p from this
482  * function.  This might change in the future, especially if
483  * we ever support eg Brainpool curves, where this could cause
484  * real nonuniformity.
485  *
486  * @param [out] recovered_hash Encoded data.
487  * @param [in] pt The point to encode.
488  * @param [in] which A value determining which inverse point
489  * to return.
490  *
491  * @retval DECAF_SUCCESS The inverse succeeded.
492  * @retval DECAF_FAILURE The inverse failed.
493  */
494 decaf_error_t
495 decaf_448_invert_elligator_nonuniform (
496     unsigned char recovered_hash[DECAF_448_HASH_BYTES],
497     const decaf_448_point_t pt,
498     uint32_t which
499 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE DECAF_WARN_UNUSED;
500
501 /**
502  * @brief Inverse of elligator-like hash to curve.
503  *
504  * This function writes to the buffer, to make it so that
505  * decaf_448_point_from_hash_uniform(buffer) = pt if
506  * possible.  Since there may be multiple preimages, the
507  * "which" parameter chooses between them.  To ensure uniform
508  * inverse sampling, this function succeeds or fails
509  * independently for different "which" values.
510  *
511  * @param [out] recovered_hash Encoded data.
512  * @param [in] pt The point to encode.
513  * @param [in] which A value determining which inverse point
514  * to return.
515  *
516  * @retval DECAF_SUCCESS The inverse succeeded.
517  * @retval DECAF_FAILURE The inverse failed.
518  */
519 decaf_error_t
520 decaf_448_invert_elligator_uniform (
521     unsigned char recovered_hash[2*DECAF_448_HASH_BYTES],
522     const decaf_448_point_t pt,
523     uint32_t which
524 ) DECAF_API_VIS DECAF_NONNULL DECAF_NOINLINE DECAF_WARN_UNUSED;
525
526 /**
527  * @brief Overwrite scalar with zeros.
528  */
529 void decaf_448_scalar_destroy (
530     decaf_448_scalar_t scalar
531 ) DECAF_NONNULL DECAF_API_VIS;
532
533 /**
534  * @brief Overwrite point with zeros.
535  */
536 void decaf_448_point_destroy (
537     decaf_448_point_t point
538 ) DECAF_NONNULL DECAF_API_VIS;
539
540 #ifdef __cplusplus
541 } /* extern "C" */
542 #endif
543
544 #endif /* __DECAF_POINT_448_H__ */