chiark - git - mdw - catacomb/blob - field.h

   1 /* -*-c-*-
   2  *
   3  * $Id: field.h,v 1.4 2004/03/21 22:52:06 mdw Exp $
   4  *
   5  * Definitions for field arithmetic
   6  *
   7  * (c) 2000 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of Catacomb.
  13  *
  14  * Catacomb is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU Library General Public License as
  16  * published by the Free Software Foundation; either version 2 of the
  17  * License, or (at your option) any later version.
  18  *
  19  * Catacomb is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Library General Public
  25  * License along with Catacomb; if not, write to the Free
  26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 /*----- Revision history --------------------------------------------------*
  31  *
  32  * $Log: field.h,v $
  33  * Revision 1.4  2004/03/21 22:52:06  mdw
  34  * Merge and close elliptic curve branch.
  35  *
  36  * Revision 1.3.4.2  2004/03/21 22:39:46  mdw
  37  * Elliptic curves on binary fields work.
  38  *
  39  * Revision 1.3.4.1  2004/03/20 00:13:31  mdw
  40  * Projective coordinates for prime curves
  41  *
  42  * Revision 1.3  2002/01/13 13:48:44  mdw
  43  * Further progress.
  44  *
  45  * Revision 1.2  2001/05/07 17:30:13  mdw
  46  * Add an internal-representation no-op function.
  47  *
  48  * Revision 1.1  2001/04/29 18:12:33  mdw
  49  * Prototype version.
  50  *
  51  */
  52
  53 #ifndef CATACOMB_FIELD_H
  54 #define CATACOMB_FIELD_H
  55
  56 #ifdef __cplusplus
  57   extern "C" {
  58 #endif
  59
  60 /*----- Header files ------------------------------------------------------*/
  61
  62 #ifndef CATACOMB_MP_H
  63 #  include "mp.h"
  64 #endif
  65
  66 /*----- Data structures ---------------------------------------------------*/
  67
  68 typedef struct field {
  69   const struct field_ops *ops;          /* Field operations */
  70   mp *zero, *one;                       /* Identities in the field */
  71 } field;
  72
  73 typedef struct field_ops {
  74
  75   /* --- Universal operations --- */
  76
  77   void (*destroy)(field */*f*/);
  78
  79   mp *(*in)(field */*f*/, mp */*d*/, mp */*x*/);
  80   mp *(*out)(field */*f*/, mp */*d*/, mp */*x*/);
  81
  82   int (*zerop)(field */*f*/, mp */*x*/);
  83   mp *(*neg)(field */*f*/, mp */*d*/, mp */*x*/);
  84   mp *(*add)(field */*f*/, mp */*d*/, mp */*x*/, mp */*y*/);
  85   mp *(*sub)(field */*f*/, mp */*d*/, mp */*x*/, mp */*y*/);
  86   mp *(*mul)(field */*f*/, mp */*d*/, mp */*x*/, mp */*y*/);
  87   mp *(*sqr)(field */*f*/, mp */*d*/, mp */*x*/);
  88   mp *(*inv)(field */*f*/, mp */*d*/, mp */*x*/);
  89   mp *(*reduce)(field */*f*/, mp */*d*/, mp */*x*/);
  90   mp *(*sqrt)(field */*f*/, mp */*d*/, mp */*x*/);
  91
  92   /* --- Operations for binary fields only --- */
  93
  94   mp *(*quadsolve)(field */*f*/, mp */*d*/, mp */*x*/);
  95
  96   /* --- Operations for prime fields only --- */
  97
  98   mp *(*dbl)(field */*f*/, mp */*d*/, mp */*x*/);
  99   mp *(*tpl)(field */*f*/, mp */*d*/, mp */*x*/);
 100   mp *(*qdl)(field */*f*/, mp */*d*/, mp */*x*/);
 101   mp *(*hlv)(field */*f*/, mp */*d*/, mp */*x*/);
 102
 103 } field_ops;
 104
 105 #define F_DESTROY(f)            (f)->ops->destroy((f))
 106
 107 #define F_IN(f, d, x)           (f)->ops->in((f), (d), (x))
 108 #define F_OUT(f, d, x)          (f)->ops->out((f), (d), (x))
 109
 110 #define F_ZEROP(f, x)           (f)->ops->zerop((f), (x))
 111 #define F_NEG(f, d, x)          (f)->ops->neg((f), (d), (x))
 112 #define F_ADD(f, d, x, y)       (f)->ops->add((f), (d), (x), (y))
 113 #define F_SUB(f, d, x, y)       (f)->ops->sub((f), (d), (x), (y))
 114 #define F_MUL(f, d, x, y)       (f)->ops->mul((f), (d), (x), (y))
 115 #define F_SQR(f, d, x)          (f)->ops->sqr((f), (d), (x))
 116 #define F_INV(f, d, x)          (f)->ops->inv((f), (d), (x))
 117 #define F_REDUCE(f, d, x)       (f)->ops->reduce((f), (d), (x))
 118 #define F_SQRT(f, d, x)         (f)->ops->sqrt((f), (d), (x))
 119
 120 #define F_QUADSOLVE(f, d, x)    (f)->ops->quadsolve((f), (d), (x))
 121
 122 #define F_DBL(f, d, x)          (f)->ops->dbl((f), (d), (x))
 123 #define F_TPL(f, d, x)          (f)->ops->tpl((f), (d), (x))
 124 #define F_QDL(f, d, x)          (f)->ops->qdl((f), (d), (x))
 125 #define F_HLV(f, d, x)          (f)->ops->hlv((f), (d), (x))
 126
 127 /*----- Helpful field operations ------------------------------------------*/
 128
 129 /* --- @field_id@ --- *
 130  *
 131  * Arguments:   @field *f@ = pointer to a field
 132  *              @mp *d@ = a destination element
 133  *              @mp *x@ = a source element
 134  *
 135  * Returns:     The result element.
 136  *
 137  * Use:         An identity operation which can be used if your field has no
 138  *              internal representation.
 139  */
 140
 141 extern mp *field_id(field */*f*/, mp */*d*/, mp */*x*/);
 142
 143 /*----- Creating fields ---------------------------------------------------*/
 144
 145 /* --- @field_prime@ --- *
 146  *
 147  * Arguments:   @mp *p@ = the characteristic of the field
 148  *
 149  * Returns:     A pointer to the field.
 150  *
 151  * Use:         Creates a field structure for a prime field of size %$p$%,
 152  *              using Montgomery reduction for arithmetic.
 153  */
 154
 155 extern field *field_prime(mp */*p*/);
 156
 157 /* --- @field_binpoly@ --- *
 158  *
 159  * Arguments:   @mp *p@ = an irreducible polynomial over %$\gf{2}$%
 160  *
 161  * Returns:     A pointer to the field.
 162  *
 163  * Use:         Creates a field structure for a binary field using naive
 164  *              arithmetic.
 165  */
 166
 167 extern field *field_binpoly(mp */*p*/);
 168
 169 /*----- That's all, folks -------------------------------------------------*/
 170
 171 #ifdef __cplusplus
 172   }
 173 #endif
 174
 175 #endif