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