3 * Arithmetic in the Goldilocks field GF(2^448 - 2^224 - 1)
5 * (c) 2017 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of Catacomb.
12 * Catacomb is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Library General Public License as
14 * published by the Free Software Foundation; either version 2 of the
15 * License, or (at your option) any later version.
17 * Catacomb is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
22 * You should have received a copy of the GNU Library General Public
23 * License along with Catacomb; if not, write to the Free
24 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
28 #ifndef CATACOMB_FGOLDI_H
29 #define CATACOMB_FGOLDI_H
35 /*----- Header files ------------------------------------------------------*/
37 #include <mLib/bits.h>
39 #ifndef CATACOMB_QFARITH_H
43 /*----- Data structures ---------------------------------------------------*/
50 #if !defined(FGOLDI_IMPL) && defined(HAVE_INT64)
51 # define FGOLDI_IMPL 28
55 # define FGOLDI_IMPL 12
58 /*----- Functions provided ------------------------------------------------*/
60 /* --- @fgoldi_load@ --- *
62 * Arguments: @fgoldi *z@ = where to store the result
63 * @const octet xv[56]@ = source to read
67 * Use: Reads an element of %$\gf{2^{448} - 2^{224} - 19}$% in
68 * external representation from @xv@ and stores it in @z@.
70 * External representation is little-endian base-256. Some
71 * elements have multiple encodings, which are not produced by
72 * correct software; use of noncanonical encodings is not an
73 * error, and toleration of them is considered a performance
77 extern void fgoldi_load(fgoldi */
*z*/
, const octet
/*xv*/[56]);
79 /* --- @fgoldi_store@ --- *
81 * Arguments: @octet zv[56]@ = where to write the result
82 * @const fgoldi *x@ = the field element to write
86 * Use: Stores a field element in the given octet vector in external
87 * representation. A canonical encoding is always stored.
90 extern void fgoldi_store(octet
/*zv*/[56], const fgoldi */
*x*/
);
92 /* --- @fgoldi_set@ --- *
94 * Arguments: @fgoldi *z@ = where to write the result
95 * @int a@ = a small-ish constant
99 * Use: Sets @z@ to equal @a@.
102 extern void fgoldi_set(fgoldi */
*x*/
, int /*a*/);
104 /* --- @fgoldi_add@ --- *
106 * Arguments: @fgoldi *z@ = where to put the result (may alias @x@ or @y@)
107 * @const fgoldi *x, *y@ = two operands
111 * Use: Set @z@ to the sum %$x + y$%.
114 extern void fgoldi_add(fgoldi */
*z*/
,
115 const fgoldi */
*x*/
, const fgoldi */
*y*/
);
117 /* --- @fgoldi_sub@ --- *
119 * Arguments: @fgoldi *z@ = where to put the result (may alias @x@ or @y@)
120 * @const fgoldi *x, *y@ = two operands
124 * Use: Set @z@ to the difference %$x - y$%.
127 extern void fgoldi_sub(fgoldi */
*z*/
,
128 const fgoldi */
*x*/
, const fgoldi */
*y*/
);
130 /* --- @fgoldi_condswap@ --- *
132 * Arguments: @fgoldi *x, *y@ = two operands
133 * @uint32 m@ = a mask
137 * Use: If @m@ is zero, do nothing; if @m@ is all-bits-set, then
138 * exchange @x@ and @y@. If @m@ has some other value, then
139 * scramble @x@ and @y@ in an unhelpful way.
142 extern void fgoldi_condswap(fgoldi */
*x*/
, fgoldi */
*y*/
, uint32
/*m*/);
144 /* --- @fgoldi_mulconst@ --- *
146 * Arguments: @fgoldi *z@ = where to put the result (may alias @x@)
147 * @const fgoldi *x@ = an operand
148 * @long a@ = a small-ish constant; %$|a| < 2^{20}$%.
152 * Use: Set @z@ to the product %$a x$%.
155 extern void fgoldi_mulconst(fgoldi */
*z*/
, const fgoldi */
*x*/
, long /*a*/);
157 /* --- @fgoldi_mul@ --- *
159 * Arguments: @fgoldi *z@ = where to put the result (may alias @x@ or @y@)
160 * @const fgoldi *x, *y@ = two operands
164 * Use: Set @z@ to the product %$x y$%.
167 extern void fgoldi_mul(fgoldi */
*z*/
,
168 const fgoldi */
*x*/
, const fgoldi */
*y*/
);
170 /* --- @fgoldi_sqr@ --- *
172 * Arguments: @fgoldi *z@ = where to put the result (may alias @x@ or @y@)
173 * @const fgoldi *x@ = an operand
177 * Use: Set @z@ to the square %$x^2$%.
180 extern void fgoldi_sqr(fgoldi */
*z*/
, const fgoldi */
*x*/
);
182 /* --- @fgoldi_inv@ --- *
184 * Arguments: @fgoldi *z@ = where to put the result (may alias @x@)
185 * @const fgoldi *x@ = an operand
189 * Use: Stores in @z@ the multiplicative inverse %$x^{-1}$%. If
190 * %$x = 0$% then @z@ is set to zero. This is considered a
194 extern void fgoldi_inv(fgoldi */
*z*/
, const fgoldi */
*x*/
);
196 /*----- That's all, folks -------------------------------------------------*/