Error checking and memory leak fixes in NISTZ256.
[oweals/openssl.git] / crypto / jpake / jpake.c
1 #include <openssl/jpake.h>
2 #include <openssl/crypto.h>
3 #include <openssl/sha.h>
4 #include <openssl/err.h>
5 #include <memory.h>
6 #include <string.h>
7
8 /*
9  * In the definition, (xa, xb, xc, xd) are Alice's (x1, x2, x3, x4) or
10  * Bob's (x3, x4, x1, x2). If you see what I mean.
11  */
12
13 typedef struct {
14     char *name;                 /* Must be unique */
15     char *peer_name;
16     BIGNUM *p;
17     BIGNUM *g;
18     BIGNUM *q;
19     BIGNUM *gxc;                /* Alice's g^{x3} or Bob's g^{x1} */
20     BIGNUM *gxd;                /* Alice's g^{x4} or Bob's g^{x2} */
21 } JPAKE_CTX_PUBLIC;
22
23 struct JPAKE_CTX {
24     JPAKE_CTX_PUBLIC p;
25     BIGNUM *secret;             /* The shared secret */
26     BN_CTX *ctx;
27     BIGNUM *xa;                 /* Alice's x1 or Bob's x3 */
28     BIGNUM *xb;                 /* Alice's x2 or Bob's x4 */
29     BIGNUM *key;                /* The calculated (shared) key */
30 };
31
32 static void JPAKE_ZKP_init(JPAKE_ZKP *zkp)
33 {
34     zkp->gr = BN_new();
35     zkp->b = BN_new();
36 }
37
38 static void JPAKE_ZKP_release(JPAKE_ZKP *zkp)
39 {
40     BN_free(zkp->b);
41     BN_free(zkp->gr);
42 }
43
44 /* Two birds with one stone - make the global name as expected */
45 #define JPAKE_STEP_PART_init    JPAKE_STEP2_init
46 #define JPAKE_STEP_PART_release JPAKE_STEP2_release
47
48 void JPAKE_STEP_PART_init(JPAKE_STEP_PART *p)
49 {
50     p->gx = BN_new();
51     JPAKE_ZKP_init(&p->zkpx);
52 }
53
54 void JPAKE_STEP_PART_release(JPAKE_STEP_PART *p)
55 {
56     JPAKE_ZKP_release(&p->zkpx);
57     BN_free(p->gx);
58 }
59
60 void JPAKE_STEP1_init(JPAKE_STEP1 *s1)
61 {
62     JPAKE_STEP_PART_init(&s1->p1);
63     JPAKE_STEP_PART_init(&s1->p2);
64 }
65
66 void JPAKE_STEP1_release(JPAKE_STEP1 *s1)
67 {
68     JPAKE_STEP_PART_release(&s1->p2);
69     JPAKE_STEP_PART_release(&s1->p1);
70 }
71
72 static void JPAKE_CTX_init(JPAKE_CTX *ctx, const char *name,
73                            const char *peer_name, const BIGNUM *p,
74                            const BIGNUM *g, const BIGNUM *q,
75                            const BIGNUM *secret)
76 {
77     ctx->p.name = OPENSSL_strdup(name);
78     ctx->p.peer_name = OPENSSL_strdup(peer_name);
79     ctx->p.p = BN_dup(p);
80     ctx->p.g = BN_dup(g);
81     ctx->p.q = BN_dup(q);
82     ctx->secret = BN_dup(secret);
83
84     ctx->p.gxc = BN_new();
85     ctx->p.gxd = BN_new();
86
87     ctx->xa = BN_new();
88     ctx->xb = BN_new();
89     ctx->key = BN_new();
90     ctx->ctx = BN_CTX_new();
91 }
92
93 static void JPAKE_CTX_release(JPAKE_CTX *ctx)
94 {
95     BN_CTX_free(ctx->ctx);
96     BN_clear_free(ctx->key);
97     BN_clear_free(ctx->xb);
98     BN_clear_free(ctx->xa);
99
100     BN_free(ctx->p.gxd);
101     BN_free(ctx->p.gxc);
102
103     BN_clear_free(ctx->secret);
104     BN_free(ctx->p.q);
105     BN_free(ctx->p.g);
106     BN_free(ctx->p.p);
107     OPENSSL_free(ctx->p.peer_name);
108     OPENSSL_free(ctx->p.name);
109
110     memset(ctx, '\0', sizeof *ctx);
111 }
112
113 JPAKE_CTX *JPAKE_CTX_new(const char *name, const char *peer_name,
114                          const BIGNUM *p, const BIGNUM *g, const BIGNUM *q,
115                          const BIGNUM *secret)
116 {
117     JPAKE_CTX *ctx = OPENSSL_malloc(sizeof *ctx);
118     if (ctx == NULL)
119         return NULL;
120
121     JPAKE_CTX_init(ctx, name, peer_name, p, g, q, secret);
122
123     return ctx;
124 }
125
126 void JPAKE_CTX_free(JPAKE_CTX *ctx)
127 {
128     JPAKE_CTX_release(ctx);
129     OPENSSL_free(ctx);
130 }
131
132 static void hashlength(SHA_CTX *sha, size_t l)
133 {
134     unsigned char b[2];
135
136     OPENSSL_assert(l <= 0xffff);
137     b[0] = l >> 8;
138     b[1] = l & 0xff;
139     SHA1_Update(sha, b, 2);
140 }
141
142 static void hashstring(SHA_CTX *sha, const char *string)
143 {
144     size_t l = strlen(string);
145
146     hashlength(sha, l);
147     SHA1_Update(sha, string, l);
148 }
149
150 static int hashbn(SHA_CTX *sha, const BIGNUM *bn)
151 {
152     size_t l = BN_num_bytes(bn);
153     unsigned char *bin = OPENSSL_malloc(l);
154
155     if (bin == NULL)
156         return 0;
157
158     hashlength(sha, l);
159     BN_bn2bin(bn, bin);
160     SHA1_Update(sha, bin, l);
161     OPENSSL_free(bin);
162     return 1;
163 }
164
165 /* h=hash(g, g^r, g^x, name) */
166 static int zkp_hash(BIGNUM *h, const BIGNUM *zkpg, const JPAKE_STEP_PART *p,
167                     const char *proof_name)
168 {
169     unsigned char md[SHA_DIGEST_LENGTH];
170     SHA_CTX sha;
171
172     /*
173      * XXX: hash should not allow moving of the boundaries - Java code
174      * is flawed in this respect. Length encoding seems simplest.
175      */
176     SHA1_Init(&sha);
177     if (!hashbn(&sha, zkpg))
178         return 0;
179     OPENSSL_assert(!BN_is_zero(p->zkpx.gr));
180     if (!hashbn(&sha, p->zkpx.gr))
181         return 0;
182     if (!hashbn(&sha, p->gx))
183         return 0;
184     hashstring(&sha, proof_name);
185     SHA1_Final(md, &sha);
186     BN_bin2bn(md, SHA_DIGEST_LENGTH, h);
187     return 1;
188 }
189
190 /*
191  * Prove knowledge of x
192  * Note that p->gx has already been calculated
193  */
194 static int generate_zkp(JPAKE_STEP_PART *p, const BIGNUM *x,
195                         const BIGNUM *zkpg, JPAKE_CTX *ctx)
196 {
197     int res = 0;
198     BIGNUM *r = BN_new();
199     BIGNUM *h = BN_new();
200     BIGNUM *t = BN_new();
201
202    /*-
203     * r in [0,q)
204     * XXX: Java chooses r in [0, 2^160) - i.e. distribution not uniform
205     */
206     BN_rand_range(r, ctx->p.q);
207     /* g^r */
208     BN_mod_exp(p->zkpx.gr, zkpg, r, ctx->p.p, ctx->ctx);
209
210     /* h=hash... */
211     if (!zkp_hash(h, zkpg, p, ctx->p.name))
212         goto end;
213
214     /* b = r - x*h */
215     BN_mod_mul(t, x, h, ctx->p.q, ctx->ctx);
216     BN_mod_sub(p->zkpx.b, r, t, ctx->p.q, ctx->ctx);
217
218     res = 1;
219  end:
220     /* cleanup */
221     BN_free(t);
222     BN_free(h);
223     BN_free(r);
224     return res;
225 }
226
227 static int verify_zkp(const JPAKE_STEP_PART *p, const BIGNUM *zkpg,
228                       JPAKE_CTX *ctx)
229 {
230     BIGNUM *h = BN_new();
231     BIGNUM *t1 = BN_new();
232     BIGNUM *t2 = BN_new();
233     BIGNUM *t3 = BN_new();
234     int ret = 0;
235
236     if (!zkp_hash(h, zkpg, p, ctx->p.peer_name))
237         goto end;
238
239     /* t1 = g^b */
240     BN_mod_exp(t1, zkpg, p->zkpx.b, ctx->p.p, ctx->ctx);
241     /* t2 = (g^x)^h = g^{hx} */
242     BN_mod_exp(t2, p->gx, h, ctx->p.p, ctx->ctx);
243     /* t3 = t1 * t2 = g^{hx} * g^b = g^{hx+b} = g^r (allegedly) */
244     BN_mod_mul(t3, t1, t2, ctx->p.p, ctx->ctx);
245
246     /* verify t3 == g^r */
247     if (BN_cmp(t3, p->zkpx.gr) == 0)
248         ret = 1;
249     else
250         JPAKEerr(JPAKE_F_VERIFY_ZKP, JPAKE_R_ZKP_VERIFY_FAILED);
251
252  end:
253     /* cleanup */
254     BN_free(t3);
255     BN_free(t2);
256     BN_free(t1);
257     BN_free(h);
258
259     return ret;
260 }
261
262 static int generate_step_part(JPAKE_STEP_PART *p, const BIGNUM *x,
263                               const BIGNUM *g, JPAKE_CTX *ctx)
264 {
265     BN_mod_exp(p->gx, g, x, ctx->p.p, ctx->ctx);
266     if (!generate_zkp(p, x, g, ctx))
267         return 0;
268     return 1;
269 }
270
271 /* Generate each party's random numbers. xa is in [0, q), xb is in [1, q). */
272 static void genrand(JPAKE_CTX *ctx)
273 {
274     BIGNUM *qm1;
275
276     /* xa in [0, q) */
277     BN_rand_range(ctx->xa, ctx->p.q);
278
279     /* q-1 */
280     qm1 = BN_new();
281     BN_copy(qm1, ctx->p.q);
282     BN_sub_word(qm1, 1);
283
284     /* ... and xb in [0, q-1) */
285     BN_rand_range(ctx->xb, qm1);
286     /* [1, q) */
287     BN_add_word(ctx->xb, 1);
288
289     /* cleanup */
290     BN_free(qm1);
291 }
292
293 int JPAKE_STEP1_generate(JPAKE_STEP1 *send, JPAKE_CTX *ctx)
294 {
295     genrand(ctx);
296     if (!generate_step_part(&send->p1, ctx->xa, ctx->p.g, ctx))
297         return 0;
298     if (!generate_step_part(&send->p2, ctx->xb, ctx->p.g, ctx))
299         return 0;
300
301     return 1;
302 }
303
304 /* g^x is a legal value */
305 static int is_legal(const BIGNUM *gx, const JPAKE_CTX *ctx)
306 {
307     BIGNUM *t;
308     int res;
309
310     if (BN_is_negative(gx) || BN_is_zero(gx) || BN_cmp(gx, ctx->p.p) >= 0)
311         return 0;
312
313     t = BN_new();
314     BN_mod_exp(t, gx, ctx->p.q, ctx->p.p, ctx->ctx);
315     res = BN_is_one(t);
316     BN_free(t);
317
318     return res;
319 }
320
321 int JPAKE_STEP1_process(JPAKE_CTX *ctx, const JPAKE_STEP1 *received)
322 {
323     if (!is_legal(received->p1.gx, ctx)) {
324         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS,
325                  JPAKE_R_G_TO_THE_X3_IS_NOT_LEGAL);
326         return 0;
327     }
328
329     if (!is_legal(received->p2.gx, ctx)) {
330         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS,
331                  JPAKE_R_G_TO_THE_X4_IS_NOT_LEGAL);
332         return 0;
333     }
334
335     /* verify their ZKP(xc) */
336     if (!verify_zkp(&received->p1, ctx->p.g, ctx)) {
337         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_VERIFY_X3_FAILED);
338         return 0;
339     }
340
341     /* verify their ZKP(xd) */
342     if (!verify_zkp(&received->p2, ctx->p.g, ctx)) {
343         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_VERIFY_X4_FAILED);
344         return 0;
345     }
346
347     /* g^xd != 1 */
348     if (BN_is_one(received->p2.gx)) {
349         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_G_TO_THE_X4_IS_ONE);
350         return 0;
351     }
352
353     /* Save the bits we need for later */
354     BN_copy(ctx->p.gxc, received->p1.gx);
355     BN_copy(ctx->p.gxd, received->p2.gx);
356
357     return 1;
358 }
359
360 int JPAKE_STEP2_generate(JPAKE_STEP2 *send, JPAKE_CTX *ctx)
361 {
362     int ret;
363
364     BIGNUM *t1 = BN_new();
365     BIGNUM *t2 = BN_new();
366
367    /*-
368     * X = g^{(xa + xc + xd) * xb * s}
369     * t1 = g^xa
370     */
371     BN_mod_exp(t1, ctx->p.g, ctx->xa, ctx->p.p, ctx->ctx);
372     /* t2 = t1 * g^{xc} = g^{xa} * g^{xc} = g^{xa + xc} */
373     BN_mod_mul(t2, t1, ctx->p.gxc, ctx->p.p, ctx->ctx);
374     /* t1 = t2 * g^{xd} = g^{xa + xc + xd} */
375     BN_mod_mul(t1, t2, ctx->p.gxd, ctx->p.p, ctx->ctx);
376     /* t2 = xb * s */
377     BN_mod_mul(t2, ctx->xb, ctx->secret, ctx->p.q, ctx->ctx);
378
379    /*-
380     * ZKP(xb * s)
381     * XXX: this is kinda funky, because we're using
382     *
383     * g' = g^{xa + xc + xd}
384     *
385     * as the generator, which means X is g'^{xb * s}
386     * X = t1^{t2} = t1^{xb * s} = g^{(xa + xc + xd) * xb * s}
387     */
388     ret = generate_step_part(send, t2, t1, ctx);
389
390     /* cleanup */
391     BN_free(t1);
392     BN_free(t2);
393
394     return ret;
395 }
396
397 /* gx = g^{xc + xa + xb} * xd * s */
398 static int compute_key(JPAKE_CTX *ctx, const BIGNUM *gx)
399 {
400     BIGNUM *t1 = BN_new();
401     BIGNUM *t2 = BN_new();
402     BIGNUM *t3 = BN_new();
403
404    /*-
405     * K = (gx/g^{xb * xd * s})^{xb}
406     *   = (g^{(xc + xa + xb) * xd * s - xb * xd *s})^{xb}
407     *   = (g^{(xa + xc) * xd * s})^{xb}
408     *   = g^{(xa + xc) * xb * xd * s}
409     * [which is the same regardless of who calculates it]
410     */
411
412     /* t1 = (g^{xd})^{xb} = g^{xb * xd} */
413     BN_mod_exp(t1, ctx->p.gxd, ctx->xb, ctx->p.p, ctx->ctx);
414     /* t2 = -s = q-s */
415     BN_sub(t2, ctx->p.q, ctx->secret);
416     /* t3 = t1^t2 = g^{-xb * xd * s} */
417     BN_mod_exp(t3, t1, t2, ctx->p.p, ctx->ctx);
418     /* t1 = gx * t3 = X/g^{xb * xd * s} */
419     BN_mod_mul(t1, gx, t3, ctx->p.p, ctx->ctx);
420     /* K = t1^{xb} */
421     BN_mod_exp(ctx->key, t1, ctx->xb, ctx->p.p, ctx->ctx);
422
423     /* cleanup */
424     BN_free(t3);
425     BN_free(t2);
426     BN_free(t1);
427
428     return 1;
429 }
430
431 int JPAKE_STEP2_process(JPAKE_CTX *ctx, const JPAKE_STEP2 *received)
432 {
433     BIGNUM *t1 = BN_new();
434     BIGNUM *t2 = BN_new();
435     int ret = 0;
436
437    /*-
438     * g' = g^{xc + xa + xb} [from our POV]
439     * t1 = xa + xb
440     */
441     BN_mod_add(t1, ctx->xa, ctx->xb, ctx->p.q, ctx->ctx);
442     /* t2 = g^{t1} = g^{xa+xb} */
443     BN_mod_exp(t2, ctx->p.g, t1, ctx->p.p, ctx->ctx);
444     /* t1 = g^{xc} * t2 = g^{xc + xa + xb} */
445     BN_mod_mul(t1, ctx->p.gxc, t2, ctx->p.p, ctx->ctx);
446
447     if (verify_zkp(received, t1, ctx))
448         ret = 1;
449     else
450         JPAKEerr(JPAKE_F_JPAKE_STEP2_PROCESS, JPAKE_R_VERIFY_B_FAILED);
451
452     compute_key(ctx, received->gx);
453
454     /* cleanup */
455     BN_free(t2);
456     BN_free(t1);
457
458     return ret;
459 }
460
461 static int quickhashbn(unsigned char *md, const BIGNUM *bn)
462 {
463     SHA_CTX sha;
464
465     SHA1_Init(&sha);
466     if (!hashbn(&sha, bn))
467         return 0;
468     SHA1_Final(md, &sha);
469     return 1;
470 }
471
472 void JPAKE_STEP3A_init(JPAKE_STEP3A *s3a)
473 {
474 }
475
476 int JPAKE_STEP3A_generate(JPAKE_STEP3A *send, JPAKE_CTX *ctx)
477 {
478     if (!quickhashbn(send->hhk, ctx->key))
479         return 0;
480     SHA1(send->hhk, sizeof send->hhk, send->hhk);
481
482     return 1;
483 }
484
485 int JPAKE_STEP3A_process(JPAKE_CTX *ctx, const JPAKE_STEP3A *received)
486 {
487     unsigned char hhk[SHA_DIGEST_LENGTH];
488
489     if (!quickhashbn(hhk, ctx->key))
490         return 0;
491     SHA1(hhk, sizeof hhk, hhk);
492     if (memcmp(hhk, received->hhk, sizeof hhk)) {
493         JPAKEerr(JPAKE_F_JPAKE_STEP3A_PROCESS,
494                  JPAKE_R_HASH_OF_HASH_OF_KEY_MISMATCH);
495         return 0;
496     }
497     return 1;
498 }
499
500 void JPAKE_STEP3A_release(JPAKE_STEP3A *s3a)
501 {
502 }
503
504 void JPAKE_STEP3B_init(JPAKE_STEP3B *s3b)
505 {
506 }
507
508 int JPAKE_STEP3B_generate(JPAKE_STEP3B *send, JPAKE_CTX *ctx)
509 {
510     if (!quickhashbn(send->hk, ctx->key))
511         return 0;
512     return 1;
513 }
514
515 int JPAKE_STEP3B_process(JPAKE_CTX *ctx, const JPAKE_STEP3B *received)
516 {
517     unsigned char hk[SHA_DIGEST_LENGTH];
518
519     if (!quickhashbn(hk, ctx->key))
520         return 0;
521     if (memcmp(hk, received->hk, sizeof hk)) {
522         JPAKEerr(JPAKE_F_JPAKE_STEP3B_PROCESS, JPAKE_R_HASH_OF_KEY_MISMATCH);
523         return 0;
524     }
525     return 1;
526 }
527
528 void JPAKE_STEP3B_release(JPAKE_STEP3B *s3b)
529 {
530 }
531
532 const BIGNUM *JPAKE_get_shared_key(JPAKE_CTX *ctx)
533 {
534     return ctx->key;
535 }