More style fixes to Curve448 code based on review feedback
[openssl.git] / crypto / ec / curve448 / f_generic.c
1 /*
2  * Copyright 2017-2018 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 #include "field.h"
13
14 static const gf MODULUS = {
15     FIELD_LITERAL(0xffffffffffffff, 0xffffffffffffff, 0xffffffffffffff,
16                   0xffffffffffffff, 0xfffffffffffffe, 0xffffffffffffff,
17                   0xffffffffffffff, 0xffffffffffffff)
18 };
19
20 /* Serialize to wire format. */
21 void gf_serialize(uint8_t serial[SER_BYTES], const gf x, int with_hibit)
22 {
23     unsigned int j = 0, fill = 0;
24     dword_t buffer = 0;
25     int i;
26     gf red;
27
28     gf_copy(red, x);
29     gf_strong_reduce(red);
30     if (!with_hibit)
31         assert(gf_hibit(red) == 0);
32
33     UNROLL for (i = 0; i < (with_hibit ? X_SER_BYTES : SER_BYTES); i++) {
34         if (fill < 8 && j < NLIMBS) {
35             buffer |= ((dword_t) red->limb[LIMBPERM(j)]) << fill;
36             fill += LIMB_PLACE_VALUE(LIMBPERM(j));
37             j++;
38         }
39         serial[i] = (uint8_t)buffer;
40         fill -= 8;
41         buffer >>= 8;
42     }
43 }
44
45 /* Return high bit of x = low bit of 2x mod p */
46 mask_t gf_hibit(const gf x)
47 {
48     gf y;
49
50     gf_add(y, x, x);
51     gf_strong_reduce(y);
52     return 0 - (y->limb[0] & 1);
53 }
54
55 /* Return high bit of x = low bit of 2x mod p */
56 mask_t gf_lobit(const gf x)
57 {
58     gf y;
59
60     gf_copy(y, x);
61     gf_strong_reduce(y);
62     return 0 - (y->limb[0] & 1);
63 }
64
65 /* Deserialize from wire format; return -1 on success and 0 on failure. */
66 mask_t gf_deserialize(gf x, const uint8_t serial[SER_BYTES], int with_hibit,
67                       uint8_t hi_nmask)
68 {
69     unsigned int j = 0, fill = 0;
70     dword_t buffer = 0;
71     dsword_t scarry = 0;
72     const unsigned nbytes = with_hibit ? X_SER_BYTES : SER_BYTES;
73     unsigned int i;
74     mask_t succ;
75
76     UNROLL for (i = 0; i < NLIMBS; i++) {
77         UNROLL while (fill < LIMB_PLACE_VALUE(LIMBPERM(i)) && j < nbytes) {
78             uint8_t sj = serial[j];
79             if (j == nbytes - 1)
80                 sj &= ~hi_nmask;
81             buffer |= ((dword_t) sj) << fill;
82             fill += 8;
83             j++;
84         }
85         x->limb[LIMBPERM(i)] = (word_t)
86             ((i < NLIMBS - 1) ? buffer & LIMB_MASK(LIMBPERM(i)) : buffer);
87         fill -= LIMB_PLACE_VALUE(LIMBPERM(i));
88         buffer >>= LIMB_PLACE_VALUE(LIMBPERM(i));
89         scarry =
90             (scarry + x->limb[LIMBPERM(i)] -
91              MODULUS->limb[LIMBPERM(i)]) >> (8 * sizeof(word_t));
92     }
93     succ = with_hibit ? 0 - (mask_t) 1 : ~gf_hibit(x);
94     return succ & word_is_zero((word_t)buffer) & ~word_is_zero((word_t)scarry);
95 }
96
97 /* Reduce to canonical form. */
98 void gf_strong_reduce(gf a)
99 {
100     dsword_t scarry;
101     word_t scarry_0;
102     dword_t carry = 0;
103     unsigned int i;
104
105     /* first, clear high */
106     gf_weak_reduce(a);          /* Determined to have negligible perf impact. */
107
108     /* now the total is less than 2p */
109
110     /* compute total_value - p.  No need to reduce mod p. */
111     scarry = 0;
112     for (i = 0; i < NLIMBS; i++) {
113         scarry = scarry + a->limb[LIMBPERM(i)] - MODULUS->limb[LIMBPERM(i)];
114         a->limb[LIMBPERM(i)] = scarry & LIMB_MASK(LIMBPERM(i));
115         scarry >>= LIMB_PLACE_VALUE(LIMBPERM(i));
116     }
117
118     /*
119      * uncommon case: it was >= p, so now scarry = 0 and this = x common case:
120      * it was < p, so now scarry = -1 and this = x - p + 2^255 so let's add
121      * back in p.  will carry back off the top for 2^255.
122      */
123     assert(word_is_zero(scarry) | word_is_zero(scarry + 1));
124
125     scarry_0 = (word_t)scarry;
126
127     /* add it back */
128     for (i = 0; i < NLIMBS; i++) {
129         carry =
130             carry + a->limb[LIMBPERM(i)] +
131             (scarry_0 & MODULUS->limb[LIMBPERM(i)]);
132         a->limb[LIMBPERM(i)] = carry & LIMB_MASK(LIMBPERM(i));
133         carry >>= LIMB_PLACE_VALUE(LIMBPERM(i));
134     }
135
136     assert(word_is_zero(carry + scarry_0));
137 }
138
139 /* Subtract two gf elements d=a-b */
140 void gf_sub(gf d, const gf a, const gf b)
141 {
142     gf_sub_RAW(d, a, b);
143     gf_bias(d, 2);
144     gf_weak_reduce(d);
145 }
146
147 /* Add two field elements d = a+b */
148 void gf_add(gf d, const gf a, const gf b)
149 {
150     gf_add_RAW(d, a, b);
151     gf_weak_reduce(d);
152 }
153
154 /* Compare a==b */
155 mask_t gf_eq(const gf a, const gf b)
156 {
157     gf c;
158     mask_t ret = 0;
159     unsigned int i;
160
161     gf_sub(c, a, b);
162     gf_strong_reduce(c);
163
164     for (i = 0; i < NLIMBS; i++)
165         ret |= c->limb[LIMBPERM(i)];
166
167     return word_is_zero(ret);
168 }
169
170 mask_t gf_isr(gf a, const gf x)
171 {
172     gf L0, L1, L2;
173
174     gf_sqr(L1, x);
175     gf_mul(L2, x, L1);
176     gf_sqr(L1, L2);
177     gf_mul(L2, x, L1);
178     gf_sqrn(L1, L2, 3);
179     gf_mul(L0, L2, L1);
180     gf_sqrn(L1, L0, 3);
181     gf_mul(L0, L2, L1);
182     gf_sqrn(L2, L0, 9);
183     gf_mul(L1, L0, L2);
184     gf_sqr(L0, L1);
185     gf_mul(L2, x, L0);
186     gf_sqrn(L0, L2, 18);
187     gf_mul(L2, L1, L0);
188     gf_sqrn(L0, L2, 37);
189     gf_mul(L1, L2, L0);
190     gf_sqrn(L0, L1, 37);
191     gf_mul(L1, L2, L0);
192     gf_sqrn(L0, L1, 111);
193     gf_mul(L2, L1, L0);
194     gf_sqr(L0, L2);
195     gf_mul(L1, x, L0);
196     gf_sqrn(L0, L1, 223);
197     gf_mul(L1, L2, L0);
198     gf_sqr(L2, L1);
199     gf_mul(L0, L2, x);
200     gf_copy(a, L1);
201     return gf_eq(L0, ONE);
202 }