Update the imported curve448 code to use OpenSSL copyright headers
[openssl.git] / crypto / ec / curve448 / point_448.h
1 /*
2  * Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright 2015-2016 Cryptography Research, Inc.
4  *
5  * Licensed under the OpenSSL license (the "License").  You may not use
6  * this file except in compliance with the License.  You can obtain a copy
7  * in the file LICENSE in the source distribution or at
8  * https://www.openssl.org/source/license.html
9  *
10  * Originally written by Mike Hamburg
11  */
12
13 #ifndef __DECAF_POINT_448_H__
14 #define __DECAF_POINT_448_H__ 1
15
16 #include "curve448utils.h"
17 #include "field.h"
18
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22
23 /** @cond internal */
24 #define DECAF_448_SCALAR_LIMBS ((446-1)/DECAF_WORD_BITS+1)
25 /** @endcond */
26
27 /** The number of bits in a scalar */
28 #define DECAF_448_SCALAR_BITS 446
29
30 /** Number of bytes in a serialized point. */
31 #define DECAF_448_SER_BYTES 56
32
33 /** Number of bytes in an elligated point.  For now set the same as SER_BYTES
34  * but could be different for other curves.
35  */
36 #define DECAF_448_HASH_BYTES 56
37
38 /** Number of bytes in a serialized scalar. */
39 #define DECAF_448_SCALAR_BYTES 56
40
41 /** Number of bits in the "which" field of an elligator inverse */
42 #define DECAF_448_INVERT_ELLIGATOR_WHICH_BITS 3
43
44 /** The cofactor the curve would have, if we hadn't removed it */
45 #define DECAF_448_REMOVED_COFACTOR 4
46
47 /** X448 encoding ratio. */
48 #define DECAF_X448_ENCODE_RATIO 2
49
50 /** Number of bytes in an x448 public key */
51 #define DECAF_X448_PUBLIC_BYTES 56
52
53 /** Number of bytes in an x448 private key */
54 #define DECAF_X448_PRIVATE_BYTES 56
55
56 /** Twisted Edwards extended homogeneous coordinates */
57 typedef struct curve448_point_s {
58     /** @cond internal */
59     gf_448_t x,y,z,t;
60     /** @endcond */
61 } curve448_point_t[1];
62
63 /** Precomputed table based on a point.  Can be trivial implementation. */
64 struct curve448_precomputed_s;
65
66 /** Precomputed table based on a point.  Can be trivial implementation. */
67 typedef struct curve448_precomputed_s curve448_precomputed_s; 
68
69 /** Scalar is stored packed, because we don't need the speed. */
70 typedef struct curve448_scalar_s {
71     /** @cond internal */
72     decaf_word_t limb[DECAF_448_SCALAR_LIMBS];
73     /** @endcond */
74 } curve448_scalar_t[1];
75
76 /** A scalar equal to 1. */
77 extern const curve448_scalar_t curve448_scalar_one;
78
79 /** A scalar equal to 0. */
80 extern const curve448_scalar_t curve448_scalar_zero;
81
82 /** The identity point on the curve. */
83 extern const curve448_point_t curve448_point_identity;
84
85 /** An arbitrarily chosen base point on the curve. */
86 extern const curve448_point_t curve448_point_base;
87
88 /** Precomputed table for the base point on the curve. */
89 extern const struct curve448_precomputed_s *curve448_precomputed_base;
90
91 /**
92  * @brief Read a scalar from wire format or from bytes.
93  *
94  * @param [in] ser Serialized form of a scalar.
95  * @param [out] out Deserialized form.
96  *
97  * @retval DECAF_SUCCESS The scalar was correctly encoded.
98  * @retval DECAF_FAILURE The scalar was greater than the modulus,
99  * and has been reduced modulo that modulus.
100  */
101 __owur decaf_error_t curve448_scalar_decode (
102     curve448_scalar_t out,
103     const unsigned char ser[DECAF_448_SCALAR_BYTES]
104 );
105
106 /**
107  * @brief Read a scalar from wire format or from bytes.  Reduces mod
108  * scalar prime.
109  *
110  * @param [in] ser Serialized form of a scalar.
111  * @param [in] ser_len Length of serialized form.
112  * @param [out] out Deserialized form.
113  */
114 void curve448_scalar_decode_long (
115     curve448_scalar_t out,
116     const unsigned char *ser,
117     size_t ser_len
118 );
119     
120 /**
121  * @brief Serialize a scalar to wire format.
122  *
123  * @param [out] ser Serialized form of a scalar.
124  * @param [in] s Deserialized scalar.
125  */
126 void curve448_scalar_encode (
127     unsigned char ser[DECAF_448_SCALAR_BYTES],
128     const curve448_scalar_t s
129 );
130         
131 /**
132  * @brief Add two scalars.  The scalars may use the same memory.
133  * @param [in] a One scalar.
134  * @param [in] b Another scalar.
135  * @param [out] out a+b.
136  */
137 void curve448_scalar_add (
138     curve448_scalar_t out,
139     const curve448_scalar_t a,
140     const curve448_scalar_t b
141 );
142
143 /**
144  * @brief Subtract two scalars.  The scalars may use the same memory.
145  * @param [in] a One scalar.
146  * @param [in] b Another scalar.
147  * @param [out] out a-b.
148  */  
149 void curve448_scalar_sub (
150     curve448_scalar_t out,
151     const curve448_scalar_t a,
152     const curve448_scalar_t b
153 );
154
155 /**
156  * @brief Multiply two scalars.  The scalars may use the same memory.
157  * @param [in] a One scalar.
158  * @param [in] b Another scalar.
159  * @param [out] out a*b.
160  */  
161 void curve448_scalar_mul (
162     curve448_scalar_t out,
163     const curve448_scalar_t a,
164     const curve448_scalar_t b
165 );
166         
167 /**
168 * @brief Halve a scalar.  The scalars may use the same memory.
169 * @param [in] a A scalar.
170 * @param [out] out a/2.
171 */
172 void curve448_scalar_halve (
173    curve448_scalar_t out,
174    const curve448_scalar_t a
175 );
176
177 /**
178  * @brief Copy a scalar.  The scalars may use the same memory, in which
179  * case this function does nothing.
180  * @param [in] a A scalar.
181  * @param [out] out Will become a copy of a.
182  */
183 static ossl_inline void curve448_scalar_copy (
184     curve448_scalar_t out,
185     const curve448_scalar_t a
186 ) {
187     *out = *a;
188 }
189
190 /**
191  * @brief Copy a point.  The input and output may alias,
192  * in which case this function does nothing.
193  *
194  * @param [out] a A copy of the point.
195  * @param [in] b Any point.
196  */
197 static ossl_inline void curve448_point_copy (
198     curve448_point_t a,
199     const curve448_point_t b
200 ) {
201     *a=*b;
202 }
203
204 /**
205  * @brief Test whether two points are equal.  If yes, return
206  * DECAF_TRUE, else return DECAF_FALSE.
207  *
208  * @param [in] a A point.
209  * @param [in] b Another point.
210  * @retval DECAF_TRUE The points are equal.
211  * @retval DECAF_FALSE The points are not equal.
212  */
213 __owur decaf_bool_t curve448_point_eq (
214     const curve448_point_t a,
215     const curve448_point_t b
216 );
217
218 /**
219  * @brief Double a point.  Equivalent to
220  * curve448_point_add(two_a,a,a), but potentially faster.
221  *
222  * @param [out] two_a The sum a+a.
223  * @param [in] a A point.
224  */
225 void curve448_point_double (
226     curve448_point_t two_a,
227     const curve448_point_t a
228 );
229
230 /**
231  * @brief RFC 7748 Diffie-Hellman scalarmul.  This function uses a different
232  * (non-Decaf) encoding.
233  *
234  * @param [out] scaled The scaled point base*scalar
235  * @param [in] base The point to be scaled.
236  * @param [in] scalar The scalar to multiply by.
237  *
238  * @retval DECAF_SUCCESS The scalarmul succeeded.
239  * @retval DECAF_FAILURE The scalarmul didn't succeed, because the base
240  * point is in a small subgroup.
241  */
242 __owur decaf_error_t decaf_x448 (
243     uint8_t out[DECAF_X448_PUBLIC_BYTES],
244     const uint8_t base[DECAF_X448_PUBLIC_BYTES],
245     const uint8_t scalar[DECAF_X448_PRIVATE_BYTES]
246 );
247
248 /**
249  * @brief Multiply a point by DECAF_X448_ENCODE_RATIO,
250  * then encode it like RFC 7748.
251  *
252  * This function is mainly used internally, but is exported in case
253  * it will be useful.
254  *
255  * The ratio is necessary because the internal representation doesn't
256  * track the cofactor information, so on output we must clear the cofactor.
257  * This would multiply by the cofactor, but in fact internally libdecaf's
258  * points are always even, so it multiplies by half the cofactor instead.
259  *
260  * As it happens, this aligns with the base point definitions; that is,
261  * if you pass the Decaf/Ristretto base point to this function, the result
262  * will be DECAF_X448_ENCODE_RATIO times the X448
263  * base point.
264  *
265  * @param [out] out The scaled and encoded point.
266  * @param [in] p The point to be scaled and encoded.
267  */
268 void curve448_point_mul_by_ratio_and_encode_like_x448 (
269     uint8_t out[DECAF_X448_PUBLIC_BYTES],
270     const curve448_point_t p
271 );
272
273 /** The base point for X448 Diffie-Hellman */
274 extern const uint8_t decaf_x448_base_point[DECAF_X448_PUBLIC_BYTES];
275     
276 /**
277  * @brief RFC 7748 Diffie-Hellman base point scalarmul.  This function uses
278  * a different (non-Decaf) encoding.
279  *
280  * Does exactly the same thing as decaf_x448_generate_key,
281  * but has a better name.
282  *
283  * @param [out] scaled The scaled point base*scalar
284  * @param [in] scalar The scalar to multiply by.
285  */
286 void decaf_x448_derive_public_key (
287     uint8_t out[DECAF_X448_PUBLIC_BYTES],
288     const uint8_t scalar[DECAF_X448_PRIVATE_BYTES]
289 );
290
291
292 /**
293  * @brief Multiply a precomputed base point by a scalar:
294  * scaled = scalar*base.
295  * Some implementations do not include precomputed points; for
296  * those implementations, this function is the same as
297  * curve448_point_scalarmul
298  *
299  * @param [out] scaled The scaled point base*scalar
300  * @param [in] base The point to be scaled.
301  * @param [in] scalar The scalar to multiply by.
302  */
303 void curve448_precomputed_scalarmul (
304     curve448_point_t scaled,
305     const curve448_precomputed_s *base,
306     const curve448_scalar_t scalar
307 );
308
309
310 /**
311  * @brief Multiply two base points by two scalars:
312  * scaled = scalar1*curve448_point_base + scalar2*base2.
313  *
314  * Otherwise equivalent to curve448_point_double_scalarmul, but may be
315  * faster at the expense of being variable time.
316  *
317  * @param [out] combo The linear combination scalar1*base + scalar2*base2.
318  * @param [in] scalar1 A first scalar to multiply by.
319  * @param [in] base2 A second point to be scaled.
320  * @param [in] scalar2 A second scalar to multiply by.
321  *
322  * @warning: This function takes variable time, and may leak the scalars
323  * used.  It is designed for signature verification.
324  */
325 void curve448_base_double_scalarmul_non_secret (
326     curve448_point_t combo,
327     const curve448_scalar_t scalar1,
328     const curve448_point_t base2,
329     const curve448_scalar_t scalar2
330 );
331
332 /**
333  * @brief Test that a point is valid, for debugging purposes.
334  *
335  * @param [in] to_test The point to test.
336  * @retval DECAF_TRUE The point is valid.
337  * @retval DECAF_FALSE The point is invalid.
338  */
339 __owur decaf_bool_t curve448_point_valid (
340     const curve448_point_t to_test
341 );
342
343 /**
344  * @brief Overwrite scalar with zeros.
345  */
346 void curve448_scalar_destroy (
347     curve448_scalar_t scalar
348 );
349
350 /**
351  * @brief Overwrite point with zeros.
352  */
353 void curve448_point_destroy (
354     curve448_point_t point
355 );
356
357 #ifdef __cplusplus
358 } /* extern "C" */
359 #endif
360
361 #endif /* __DECAF_POINT_448_H__ */