5 * Elliptic curve information management
7 * (c) 2004 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
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.
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.
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,
30 /*----- Header files ------------------------------------------------------*/
40 /*----- Main code ---------------------------------------------------------*/
42 /* --- @ec_curveparse@ --- *
44 * Arguments: @qd_parse *qd@ = parser context
46 * Returns: Elliptic curve pointer if OK, or null.
48 * Use: Parses an elliptic curve description, which has the form
50 * * a field description
52 * * `prime', `primeproj', `bin', or `binproj'
54 * * the %$a$% parameter
56 * * the %$b$% parameter
59 ec_curve
*ec_curveparse(qd_parse
*qd
)
61 mp
*a
= MP_NEW
, *b
= MP_NEW
;
65 if ((f
= field_parse(qd
)) == 0) goto fail
;
67 switch (qd_enum(qd
, "prime,primeproj,bin,binproj")) {
69 if (F_TYPE(f
) != FTY_PRIME
) {
70 qd
->e
= "field not prime";
74 if ((a
= qd_getmp(qd
)) == 0) goto fail
;
76 if ((b
= qd_getmp(qd
)) == 0) goto fail
;
77 c
= ec_prime(f
, a
, b
);
80 if (F_TYPE(f
) != FTY_PRIME
) {
81 qd
->e
= "field not prime";
85 if ((a
= qd_getmp(qd
)) == 0) goto fail
;
87 if ((b
= qd_getmp(qd
)) == 0) goto fail
;
88 c
= ec_primeproj(f
, a
, b
);
91 if (F_TYPE(f
) != FTY_BINARY
) {
92 qd
->e
= "field not binary";
96 if ((a
= qd_getmp(qd
)) == 0) goto fail
;
98 if ((b
= qd_getmp(qd
)) == 0) goto fail
;
102 if (F_TYPE(f
) != FTY_BINARY
) {
103 qd
->e
= "field not binary";
107 if ((a
= qd_getmp(qd
)) == 0) goto fail
;
109 if ((b
= qd_getmp(qd
)) == 0) goto fail
;
110 c
= ec_binproj(f
, a
, b
);
116 qd
->e
= "bad curve parameters";
130 /* --- @ec_ptparse@ --- *
132 * Arguments: @qd_parse *qd@ = parser context
133 * @ec *p@ = where to put the point
135 * Returns: The point address, or null.
137 * Use: Parses an elliptic curve point. This has the form
144 ec
*ec_ptparse(qd_parse
*qd
, ec
*p
)
146 mp
*x
= MP_NEW
, *y
= MP_NEW
;
148 if (qd_enum(qd
, "inf") >= 0) {
152 if ((x
= qd_getmp(qd
)) == 0) goto fail
;
154 if ((y
= qd_getmp(qd
)) == 0) goto fail
;
167 /* --- @ec_infofromdata@ --- *
169 * Arguments: @ec_info *ei@ = where to write the information
170 * @ecdata *ed@ = raw data
174 * Use: Loads elliptic curve information about one of the standard
178 void ec_infofromdata(ec_info
*ei
, ecdata
*ed
)
184 f
= field_prime(&ed
->p
);
185 ei
->c
= ec_primeproj(f
, &ed
->a
, &ed
->b
);
188 f
= field_niceprime(&ed
->p
);
189 ei
->c
= ec_primeproj(f
, &ed
->a
, &ed
->b
);
192 f
= field_binpoly(&ed
->p
);
193 ei
->c
= ec_binproj(f
, &ed
->a
, &ed
->b
);
196 f
= field_binnorm(&ed
->p
, &ed
->beta
);
197 ei
->c
= ec_binproj(f
, &ed
->a
, &ed
->b
);
203 assert(f
); assert(ei
->c
);
204 EC_CREATE(&ei
->g
); ei
->g
.x
= &ed
->gx
; ei
->g
.y
= &ed
->gy
; ei
->g
.z
= 0;
205 ei
->r
= &ed
->r
; ei
->h
= &ed
->h
;
208 /* --- @ec_infoparse@ --- *
210 * Arguments: @qd_parse *qd@ = parser context
211 * @ec_info *ei@ = curve information block, currently
214 * Returns: Zero on success, nonzero on failure.
216 * Use: Parses an elliptic curve information string, and stores the
217 * information in @ei@. This is either the name of a standard
218 * curve, or it has the form
220 * * elliptic curve description
229 int ec_infoparse(qd_parse
*qd
, ec_info
*ei
)
235 mp
*r
= MP_NEW
, *h
= MP_NEW
;
237 for (ee
= ectab
; ee
->name
; ee
++) {
238 if (qd_enum(qd
, ee
->name
) >= 0) {
239 ec_infofromdata(ei
, ee
->data
);
244 if ((c
= ec_curveparse(qd
)) == 0) goto fail
;
245 qd_delim(qd
, '/'); if (!ec_ptparse(qd
, &g
)) goto fail
;
246 qd_delim(qd
, ':'); if ((r
= qd_getmp(qd
)) == 0) goto fail
;
247 qd_delim(qd
, '*'); if ((h
= qd_getmp(qd
)) == 0) goto fail
;
248 ei
->c
= c
; ei
->g
= g
; ei
->r
= r
; ei
->h
= h
;
257 if (c
) { f
= c
->f
; ec_destroycurve(c
); F_DESTROY(f
); }
261 /* --- @ec_getinfo@ --- *
263 * Arguments: @ec_info *ei@ = where to write the information
264 * @const char *p@ = string describing a curve
266 * Returns: Null on success, or a pointer to an error message.
268 * Use: Parses out information about a curve. The string is either a
269 * standard curve name, or a curve info string.
272 const char *ec_getinfo(ec_info
*ei
, const char *p
)
278 if (ec_infoparse(&qd
, ei
))
282 return ("junk found at end of string");
287 /* --- @ec_sameinfop@ --- *
289 * Arguments: @ec_info *ei, *ej@ = two elliptic curve parameter sets
291 * Returns: Nonzero if the curves are identical (not just isomorphic).
293 * Use: Checks for sameness of curve parameters.
296 int ec_sameinfop(ec_info
*ei
, ec_info
*ej
)
298 return (ec_samep(ei
->c
, ej
->c
) &&
299 MP_EQ(ei
->r
, ej
->r
) && MP_EQ(ei
->h
, ej
->h
) &&
300 EC_EQ(&ei
->g
, &ej
->g
));
303 /* --- @ec_freeinfo@ --- *
305 * Arguments: @ec_info *ei@ = elliptic curve information block to free
309 * Use: Frees the information block.
312 void ec_freeinfo(ec_info
*ei
)
319 f
= ei
->c
->f
; ec_destroycurve(ei
->c
); F_DESTROY(f
);
322 /* --- @ec_checkinfo@ --- *
324 * Arguments: @const ec_info *ei@ = elliptic curve information block
326 * Returns: Null if OK, or pointer to error message.
328 * Use: Checks an elliptic curve according to the rules in SEC1.
331 static int primeeltp(mp
*x
, field
*f
)
333 return (!MP_NEGP(x
) && MP_CMP(x
, <, f
->m
));
336 static const char *primecheck(const ec_info
*ei
, grand
*gr
)
345 /* --- Check %$p$% is an odd prime --- */
347 if (!pgen_primep(f
->m
, gr
)) return ("p not prime");
349 /* --- Check %$a$%, %$b$%, %$G_x$% and %$G_y$% are in %$[0, p)$% --- */
351 if (!primeeltp(c
->a
, f
)) return ("a out of range");
352 if (!primeeltp(c
->b
, f
)) return ("b out of range");
353 if (!primeeltp(ei
->g
.x
, f
)) return ("G_x out of range");
354 if (!primeeltp(ei
->g
.x
, f
)) return ("G_y out of range");
356 /* --- Check %$4 a^3 + 27 b^2 \not\equiv 0 \pmod{p}$% --- */
358 x
= F_SQR(f
, MP_NEW
, c
->a
);
359 x
= F_MUL(f
, x
, x
, c
->a
);
361 y
= F_SQR(f
, MP_NEW
, c
->b
);
365 x
= F_ADD(f
, x
, x
, y
);
369 if (rc
) return ("not an elliptic curve");
371 /* --- Check %$G \in E$% --- */
373 if (EC_ATINF(&ei
->g
)) return ("generator at infinity");
374 if (ec_check(c
, &ei
->g
)) return ("generator not on curve");
376 /* --- Check %$r$% is prime --- */
378 if (!pgen_primep(ei
->r
, gr
)) return ("generator order not prime");
380 /* --- Check %$h = \lfloor (\sqrt{p} + 1)^2/r \rlfoor$% --- *
382 * This seems to work with the approximate-sqrt in the library, but might
383 * not be so good in some cases. Throw in some extra significate figures
387 x
= mp_lsl(MP_NEW
, f
->m
, 128);
389 y
= mp_lsl(MP_NEW
, MP_ONE
, 64);
392 mp_div(&x
, 0, x
, ei
->r
);
393 x
= mp_lsr(x
, x
, 128);
394 rc
= MP_EQ(x
, ei
->h
);
397 if (!rc
) return ("incorrect cofactor");
399 /* --- Check %$n G = O$% --- */
402 ec_mul(c
, &p
, &ei
->g
, ei
->r
);
405 if (!rc
) return ("incorrect group order");
407 /* --- Check that %$p^B \not\equiv 1 \pmod{r}$% for %$1 \le B < 20$% --- *
409 * The spec says %$q$%, not %$p$%, but I think that's a misprint.
413 mp_div(0, &x
, f
->m
, ei
->r
);
416 if (MP_EQ(x
, MP_ONE
)) break;
417 x
= mp_mul(x
, x
, f
->m
);
418 mp_div(0, &x
, x
, ei
->r
);
422 if (i
) return ("curve is weak");
424 /* --- Check %$0 < h \le 4$% --- */
426 if (MP_CMP(ei
->h
, <, MP_ONE
) || MP_CMP(ei
->h
, >, MP_FOUR
))
427 return ("cofactor out of range");
434 static const char *bincheck(const ec_info
*ei
, grand
*gr
)
443 /* --- Check that %$m$% is prime --- */
445 x
= mp_fromuint(MP_NEW
, f
->nbits
);
446 rc
= pfilt_smallfactor(x
);
448 if (rc
!= PGEN_DONE
) return ("degree not prime");
450 /* --- Check that %$p$% is irreducible --- */
452 if (!gf_irreduciblep(f
->m
)) return ("p not irreducible");
454 /* --- Check that %$a, b, G_x, G_y$% have degree less than %$p$% --- */
456 if (mp_bits(c
->a
) > f
->nbits
) return ("a out of range");
457 if (mp_bits(c
->b
) > f
->nbits
) return ("a out of range");
458 if (mp_bits(ei
->g
.x
) > f
->nbits
) return ("G_x out of range");
459 if (mp_bits(ei
->g
.y
) > f
->nbits
) return ("G_y out of range");
461 /* --- Check that %$b \ne 0$% --- */
463 if (F_ZEROP(f
, c
->b
)) return ("b is zero");
465 /* --- Check that %$G \in E$% --- */
467 if (EC_ATINF(&ei
->g
)) return ("generator at infinity");
468 if (ec_check(c
, &ei
->g
)) return ("generator not on curve");
470 /* --- Check %$r$% is prime --- */
472 if (!pgen_primep(ei
->r
, gr
)) return ("generator order not prime");
474 /* --- Check %$h = \lfloor (\sqrt{2^m} + 1)^2/r \rlfoor$% --- *
476 * This seems to work with the approximate-sqrt in the library, but might
477 * not be so good in some cases. Throw in some extra significate figures
481 x
= mp_lsl(MP_NEW
, MP_ONE
, f
->nbits
+ 128);
483 y
= mp_lsl(MP_NEW
, MP_ONE
, 64);
486 mp_div(&x
, 0, x
, ei
->r
);
487 x
= mp_lsr(x
, x
, 128);
488 rc
= MP_EQ(x
, ei
->h
);
491 if (!rc
) return ("incorrect cofactor");
493 /* --- Check %$n G = O$% --- */
496 ec_mul(c
, &p
, &ei
->g
, ei
->r
);
499 if (!rc
) return ("incorrect group order");
501 /* --- Check %$2^{m B} \not\equiv 1 \pmod{r}$% for %$1 \le B < 20$% --- */
503 x
= mp_lsl(MP_NEW
, MP_ONE
, f
->nbits
);
504 mp_div(0, &x
, x
, ei
->r
);
507 if (MP_EQ(x
, MP_ONE
)) break;
508 x
= mp_mul(x
, x
, f
->m
);
509 mp_div(0, &x
, x
, ei
->r
);
513 if (i
) return ("curve is weak");
515 /* --- Check %$0 < h \le 4$% --- */
517 if (MP_CMP(ei
->h
, <, MP_ONE
) || MP_CMP(ei
->h
, >, MP_FOUR
))
518 return ("cofactor out of range");
525 const char *ec_checkinfo(const ec_info
*ei
, grand
*gr
)
527 switch (F_TYPE(ei
->c
->f
)) {
528 case FTY_PRIME
: return (primecheck(ei
, gr
)); break;
529 case FTY_BINARY
: return (bincheck(ei
, gr
)); break;
531 return ("unknown curve type");
534 /*----- Test rig ----------------------------------------------------------*/
540 int main(int argc
, char *argv
[])
548 gr
= fibrand_create(0);
550 for (i
= 1; i
< argc
; i
++) {
552 if ((e
= ec_getinfo(&ei
, argv
[i
])) != 0)
553 fprintf(stderr
, "bad curve spec `%s': %s", argv
[i
], e
);
555 e
= ec_checkinfo(&ei
, gr
);
558 printf("OK %s\n", argv
[i
]);
560 printf("BAD %s: %s\n", argv
[i
], e
);
566 fputs("checking standard curves:", stdout
);
568 for (ee
= ectab
; ee
->name
; ee
++) {
570 ec_infofromdata(&ei
, ee
->data
);
571 e
= ec_checkinfo(&ei
, gr
);
574 printf(" [%s fails: %s]", ee
->name
, e
);
577 printf(" %s", ee
->name
);
580 fputs(ok ?
" ok\n" : " failed\n", stdout
);
582 gr
->ops
->destroy(gr
);
588 /*----- That's all, folks -------------------------------------------------*/