b494ac01dcbe597b726f9dbfc9fb116d79ffa6ed
[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     if (!ctx)
129         return;
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         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS,
327                  JPAKE_R_G_TO_THE_X3_IS_NOT_LEGAL);
328         return 0;
329     }
330
331     if (!is_legal(received->p2.gx, ctx)) {
332         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS,
333                  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         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_VERIFY_X3_FAILED);
340         return 0;
341     }
342
343     /* verify their ZKP(xd) */
344     if (!verify_zkp(&received->p2, ctx->p.g, ctx)) {
345         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_VERIFY_X4_FAILED);
346         return 0;
347     }
348
349     /* g^xd != 1 */
350     if (BN_is_one(received->p2.gx)) {
351         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_G_TO_THE_X4_IS_ONE);
352         return 0;
353     }
354
355     /* Save the bits we need for later */
356     BN_copy(ctx->p.gxc, received->p1.gx);
357     BN_copy(ctx->p.gxd, received->p2.gx);
358
359     return 1;
360 }
361
362 int JPAKE_STEP2_generate(JPAKE_STEP2 *send, JPAKE_CTX *ctx)
363 {
364     int ret;
365
366     BIGNUM *t1 = BN_new();
367     BIGNUM *t2 = BN_new();
368
369    /*-
370     * X = g^{(xa + xc + xd) * xb * s}
371     * t1 = g^xa
372     */
373     BN_mod_exp(t1, ctx->p.g, ctx->xa, ctx->p.p, ctx->ctx);
374     /* t2 = t1 * g^{xc} = g^{xa} * g^{xc} = g^{xa + xc} */
375     BN_mod_mul(t2, t1, ctx->p.gxc, ctx->p.p, ctx->ctx);
376     /* t1 = t2 * g^{xd} = g^{xa + xc + xd} */
377     BN_mod_mul(t1, t2, ctx->p.gxd, ctx->p.p, ctx->ctx);
378     /* t2 = xb * s */
379     BN_mod_mul(t2, ctx->xb, ctx->secret, ctx->p.q, ctx->ctx);
380
381    /*-
382     * ZKP(xb * s)
383     * XXX: this is kinda funky, because we're using
384     *
385     * g' = g^{xa + xc + xd}
386     *
387     * as the generator, which means X is g'^{xb * s}
388     * X = t1^{t2} = t1^{xb * s} = g^{(xa + xc + xd) * xb * s}
389     */
390     ret = generate_step_part(send, t2, t1, ctx);
391
392     /* cleanup */
393     BN_free(t1);
394     BN_free(t2);
395
396     return ret;
397 }
398
399 /* gx = g^{xc + xa + xb} * xd * s */
400 static int compute_key(JPAKE_CTX *ctx, const BIGNUM *gx)
401 {
402     BIGNUM *t1 = BN_new();
403     BIGNUM *t2 = BN_new();
404     BIGNUM *t3 = BN_new();
405
406    /*-
407     * K = (gx/g^{xb * xd * s})^{xb}
408     *   = (g^{(xc + xa + xb) * xd * s - xb * xd *s})^{xb}
409     *   = (g^{(xa + xc) * xd * s})^{xb}
410     *   = g^{(xa + xc) * xb * xd * s}
411     * [which is the same regardless of who calculates it]
412     */
413
414     /* t1 = (g^{xd})^{xb} = g^{xb * xd} */
415     BN_mod_exp(t1, ctx->p.gxd, ctx->xb, ctx->p.p, ctx->ctx);
416     /* t2 = -s = q-s */
417     BN_sub(t2, ctx->p.q, ctx->secret);
418     /* t3 = t1^t2 = g^{-xb * xd * s} */
419     BN_mod_exp(t3, t1, t2, ctx->p.p, ctx->ctx);
420     /* t1 = gx * t3 = X/g^{xb * xd * s} */
421     BN_mod_mul(t1, gx, t3, ctx->p.p, ctx->ctx);
422     /* K = t1^{xb} */
423     BN_mod_exp(ctx->key, t1, ctx->xb, ctx->p.p, ctx->ctx);
424
425     /* cleanup */
426     BN_free(t3);
427     BN_free(t2);
428     BN_free(t1);
429
430     return 1;
431 }
432
433 int JPAKE_STEP2_process(JPAKE_CTX *ctx, const JPAKE_STEP2 *received)
434 {
435     BIGNUM *t1 = BN_new();
436     BIGNUM *t2 = BN_new();
437     int ret = 0;
438
439    /*-
440     * g' = g^{xc + xa + xb} [from our POV]
441     * t1 = xa + xb
442     */
443     BN_mod_add(t1, ctx->xa, ctx->xb, ctx->p.q, ctx->ctx);
444     /* t2 = g^{t1} = g^{xa+xb} */
445     BN_mod_exp(t2, ctx->p.g, t1, ctx->p.p, ctx->ctx);
446     /* t1 = g^{xc} * t2 = g^{xc + xa + xb} */
447     BN_mod_mul(t1, ctx->p.gxc, t2, ctx->p.p, ctx->ctx);
448
449     if (verify_zkp(received, t1, ctx))
450         ret = 1;
451     else
452         JPAKEerr(JPAKE_F_JPAKE_STEP2_PROCESS, JPAKE_R_VERIFY_B_FAILED);
453
454     compute_key(ctx, received->gx);
455
456     /* cleanup */
457     BN_free(t2);
458     BN_free(t1);
459
460     return ret;
461 }
462
463 static int quickhashbn(unsigned char *md, const BIGNUM *bn)
464 {
465     SHA_CTX sha;
466
467     SHA1_Init(&sha);
468     if (!hashbn(&sha, bn))
469         return 0;
470     SHA1_Final(md, &sha);
471     return 1;
472 }
473
474 void JPAKE_STEP3A_init(JPAKE_STEP3A *s3a)
475 {
476 }
477
478 int JPAKE_STEP3A_generate(JPAKE_STEP3A *send, JPAKE_CTX *ctx)
479 {
480     if (!quickhashbn(send->hhk, ctx->key))
481         return 0;
482     SHA1(send->hhk, sizeof send->hhk, send->hhk);
483
484     return 1;
485 }
486
487 int JPAKE_STEP3A_process(JPAKE_CTX *ctx, const JPAKE_STEP3A *received)
488 {
489     unsigned char hhk[SHA_DIGEST_LENGTH];
490
491     if (!quickhashbn(hhk, ctx->key))
492         return 0;
493     SHA1(hhk, sizeof hhk, hhk);
494     if (memcmp(hhk, received->hhk, sizeof hhk)) {
495         JPAKEerr(JPAKE_F_JPAKE_STEP3A_PROCESS,
496                  JPAKE_R_HASH_OF_HASH_OF_KEY_MISMATCH);
497         return 0;
498     }
499     return 1;
500 }
501
502 void JPAKE_STEP3A_release(JPAKE_STEP3A *s3a)
503 {
504 }
505
506 void JPAKE_STEP3B_init(JPAKE_STEP3B *s3b)
507 {
508 }
509
510 int JPAKE_STEP3B_generate(JPAKE_STEP3B *send, JPAKE_CTX *ctx)
511 {
512     if (!quickhashbn(send->hk, ctx->key))
513         return 0;
514     return 1;
515 }
516
517 int JPAKE_STEP3B_process(JPAKE_CTX *ctx, const JPAKE_STEP3B *received)
518 {
519     unsigned char hk[SHA_DIGEST_LENGTH];
520
521     if (!quickhashbn(hk, ctx->key))
522         return 0;
523     if (memcmp(hk, received->hk, sizeof hk)) {
524         JPAKEerr(JPAKE_F_JPAKE_STEP3B_PROCESS, JPAKE_R_HASH_OF_KEY_MISMATCH);
525         return 0;
526     }
527     return 1;
528 }
529
530 void JPAKE_STEP3B_release(JPAKE_STEP3B *s3b)
531 {
532 }
533
534 const BIGNUM *JPAKE_get_shared_key(JPAKE_CTX *ctx)
535 {
536     return ctx->key;
537 }