RT4313: Fix build for !IMPLEMENTED code path in CRYPTO_secure_free()
[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     if (r == NULL || h == NULL || t == NULL)
205         goto end;
206
207    /*-
208     * r in [0,q)
209     * XXX: Java chooses r in [0, 2^160) - i.e. distribution not uniform
210     */
211     BN_rand_range(r, ctx->p.q);
212     /* g^r */
213     BN_mod_exp(p->zkpx.gr, zkpg, r, ctx->p.p, ctx->ctx);
214
215     /* h=hash... */
216     if (!zkp_hash(h, zkpg, p, ctx->p.name))
217         goto end;
218
219     /* b = r - x*h */
220     BN_mod_mul(t, x, h, ctx->p.q, ctx->ctx);
221     BN_mod_sub(p->zkpx.b, r, t, ctx->p.q, ctx->ctx);
222
223     res = 1;
224  end:
225     /* cleanup */
226     BN_free(t);
227     BN_free(h);
228     BN_free(r);
229     return res;
230 }
231
232 static int verify_zkp(const JPAKE_STEP_PART *p, const BIGNUM *zkpg,
233                       JPAKE_CTX *ctx)
234 {
235     BIGNUM *h = BN_new();
236     BIGNUM *t1 = BN_new();
237     BIGNUM *t2 = BN_new();
238     BIGNUM *t3 = BN_new();
239     int ret = 0;
240
241     if (h == NULL || t1 == NULL || t2 == NULL || t3 == NULL)
242         goto end;
243
244     if (!zkp_hash(h, zkpg, p, ctx->p.peer_name))
245         goto end;
246
247     /* t1 = g^b */
248     BN_mod_exp(t1, zkpg, p->zkpx.b, ctx->p.p, ctx->ctx);
249     /* t2 = (g^x)^h = g^{hx} */
250     BN_mod_exp(t2, p->gx, h, ctx->p.p, ctx->ctx);
251     /* t3 = t1 * t2 = g^{hx} * g^b = g^{hx+b} = g^r (allegedly) */
252     BN_mod_mul(t3, t1, t2, ctx->p.p, ctx->ctx);
253
254     /* verify t3 == g^r */
255     if (BN_cmp(t3, p->zkpx.gr) == 0)
256         ret = 1;
257     else
258         JPAKEerr(JPAKE_F_VERIFY_ZKP, JPAKE_R_ZKP_VERIFY_FAILED);
259
260  end:
261     /* cleanup */
262     BN_free(t3);
263     BN_free(t2);
264     BN_free(t1);
265     BN_free(h);
266
267     return ret;
268 }
269
270 static int generate_step_part(JPAKE_STEP_PART *p, const BIGNUM *x,
271                               const BIGNUM *g, JPAKE_CTX *ctx)
272 {
273     BN_mod_exp(p->gx, g, x, ctx->p.p, ctx->ctx);
274     if (!generate_zkp(p, x, g, ctx))
275         return 0;
276     return 1;
277 }
278
279 /* Generate each party's random numbers. xa is in [0, q), xb is in [1, q). */
280 static void genrand(JPAKE_CTX *ctx)
281 {
282     BIGNUM *qm1;
283
284     /* xa in [0, q) */
285     BN_rand_range(ctx->xa, ctx->p.q);
286
287     /* q-1 */
288     qm1 = BN_new();
289     BN_copy(qm1, ctx->p.q);
290     BN_sub_word(qm1, 1);
291
292     /* ... and xb in [0, q-1) */
293     BN_rand_range(ctx->xb, qm1);
294     /* [1, q) */
295     BN_add_word(ctx->xb, 1);
296
297     /* cleanup */
298     BN_free(qm1);
299 }
300
301 int JPAKE_STEP1_generate(JPAKE_STEP1 *send, JPAKE_CTX *ctx)
302 {
303     genrand(ctx);
304     if (!generate_step_part(&send->p1, ctx->xa, ctx->p.g, ctx))
305         return 0;
306     if (!generate_step_part(&send->p2, ctx->xb, ctx->p.g, ctx))
307         return 0;
308
309     return 1;
310 }
311
312 /* g^x is a legal value */
313 static int is_legal(const BIGNUM *gx, const JPAKE_CTX *ctx)
314 {
315     BIGNUM *t;
316     int res;
317
318     if (BN_is_negative(gx) || BN_is_zero(gx) || BN_cmp(gx, ctx->p.p) >= 0)
319         return 0;
320
321     t = BN_new();
322     BN_mod_exp(t, gx, ctx->p.q, ctx->p.p, ctx->ctx);
323     res = BN_is_one(t);
324     BN_free(t);
325
326     return res;
327 }
328
329 int JPAKE_STEP1_process(JPAKE_CTX *ctx, const JPAKE_STEP1 *received)
330 {
331     if (!is_legal(received->p1.gx, ctx)) {
332         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS,
333                  JPAKE_R_G_TO_THE_X3_IS_NOT_LEGAL);
334         return 0;
335     }
336
337     if (!is_legal(received->p2.gx, ctx)) {
338         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS,
339                  JPAKE_R_G_TO_THE_X4_IS_NOT_LEGAL);
340         return 0;
341     }
342
343     /* verify their ZKP(xc) */
344     if (!verify_zkp(&received->p1, ctx->p.g, ctx)) {
345         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_VERIFY_X3_FAILED);
346         return 0;
347     }
348
349     /* verify their ZKP(xd) */
350     if (!verify_zkp(&received->p2, ctx->p.g, ctx)) {
351         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_VERIFY_X4_FAILED);
352         return 0;
353     }
354
355     /* g^xd != 1 */
356     if (BN_is_one(received->p2.gx)) {
357         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_G_TO_THE_X4_IS_ONE);
358         return 0;
359     }
360
361     /* Save the bits we need for later */
362     BN_copy(ctx->p.gxc, received->p1.gx);
363     BN_copy(ctx->p.gxd, received->p2.gx);
364
365     return 1;
366 }
367
368 int JPAKE_STEP2_generate(JPAKE_STEP2 *send, JPAKE_CTX *ctx)
369 {
370     int ret;
371
372     BIGNUM *t1 = BN_new();
373     BIGNUM *t2 = BN_new();
374
375    /*-
376     * X = g^{(xa + xc + xd) * xb * s}
377     * t1 = g^xa
378     */
379     BN_mod_exp(t1, ctx->p.g, ctx->xa, ctx->p.p, ctx->ctx);
380     /* t2 = t1 * g^{xc} = g^{xa} * g^{xc} = g^{xa + xc} */
381     BN_mod_mul(t2, t1, ctx->p.gxc, ctx->p.p, ctx->ctx);
382     /* t1 = t2 * g^{xd} = g^{xa + xc + xd} */
383     BN_mod_mul(t1, t2, ctx->p.gxd, ctx->p.p, ctx->ctx);
384     /* t2 = xb * s */
385     BN_mod_mul(t2, ctx->xb, ctx->secret, ctx->p.q, ctx->ctx);
386
387    /*-
388     * ZKP(xb * s)
389     * XXX: this is kinda funky, because we're using
390     *
391     * g' = g^{xa + xc + xd}
392     *
393     * as the generator, which means X is g'^{xb * s}
394     * X = t1^{t2} = t1^{xb * s} = g^{(xa + xc + xd) * xb * s}
395     */
396     ret = generate_step_part(send, t2, t1, ctx);
397
398     /* cleanup */
399     BN_free(t1);
400     BN_free(t2);
401
402     return ret;
403 }
404
405 /* gx = g^{xc + xa + xb} * xd * s */
406 static int compute_key(JPAKE_CTX *ctx, const BIGNUM *gx)
407 {
408     BIGNUM *t1 = BN_new();
409     BIGNUM *t2 = BN_new();
410     BIGNUM *t3 = BN_new();
411
412    /*-
413     * K = (gx/g^{xb * xd * s})^{xb}
414     *   = (g^{(xc + xa + xb) * xd * s - xb * xd *s})^{xb}
415     *   = (g^{(xa + xc) * xd * s})^{xb}
416     *   = g^{(xa + xc) * xb * xd * s}
417     * [which is the same regardless of who calculates it]
418     */
419
420     /* t1 = (g^{xd})^{xb} = g^{xb * xd} */
421     BN_mod_exp(t1, ctx->p.gxd, ctx->xb, ctx->p.p, ctx->ctx);
422     /* t2 = -s = q-s */
423     BN_sub(t2, ctx->p.q, ctx->secret);
424     /* t3 = t1^t2 = g^{-xb * xd * s} */
425     BN_mod_exp(t3, t1, t2, ctx->p.p, ctx->ctx);
426     /* t1 = gx * t3 = X/g^{xb * xd * s} */
427     BN_mod_mul(t1, gx, t3, ctx->p.p, ctx->ctx);
428     /* K = t1^{xb} */
429     BN_mod_exp(ctx->key, t1, ctx->xb, ctx->p.p, ctx->ctx);
430
431     /* cleanup */
432     BN_free(t3);
433     BN_free(t2);
434     BN_free(t1);
435
436     return 1;
437 }
438
439 int JPAKE_STEP2_process(JPAKE_CTX *ctx, const JPAKE_STEP2 *received)
440 {
441     BIGNUM *t1 = BN_new();
442     BIGNUM *t2 = BN_new();
443     int ret = 0;
444
445    /*-
446     * g' = g^{xc + xa + xb} [from our POV]
447     * t1 = xa + xb
448     */
449     BN_mod_add(t1, ctx->xa, ctx->xb, ctx->p.q, ctx->ctx);
450     /* t2 = g^{t1} = g^{xa+xb} */
451     BN_mod_exp(t2, ctx->p.g, t1, ctx->p.p, ctx->ctx);
452     /* t1 = g^{xc} * t2 = g^{xc + xa + xb} */
453     BN_mod_mul(t1, ctx->p.gxc, t2, ctx->p.p, ctx->ctx);
454
455     if (verify_zkp(received, t1, ctx))
456         ret = 1;
457     else
458         JPAKEerr(JPAKE_F_JPAKE_STEP2_PROCESS, JPAKE_R_VERIFY_B_FAILED);
459
460     compute_key(ctx, received->gx);
461
462     /* cleanup */
463     BN_free(t2);
464     BN_free(t1);
465
466     return ret;
467 }
468
469 static int quickhashbn(unsigned char *md, const BIGNUM *bn)
470 {
471     SHA_CTX sha;
472
473     SHA1_Init(&sha);
474     if (!hashbn(&sha, bn))
475         return 0;
476     SHA1_Final(md, &sha);
477     return 1;
478 }
479
480 void JPAKE_STEP3A_init(JPAKE_STEP3A *s3a)
481 {
482 }
483
484 int JPAKE_STEP3A_generate(JPAKE_STEP3A *send, JPAKE_CTX *ctx)
485 {
486     if (!quickhashbn(send->hhk, ctx->key))
487         return 0;
488     SHA1(send->hhk, sizeof send->hhk, send->hhk);
489
490     return 1;
491 }
492
493 int JPAKE_STEP3A_process(JPAKE_CTX *ctx, const JPAKE_STEP3A *received)
494 {
495     unsigned char hhk[SHA_DIGEST_LENGTH];
496
497     if (!quickhashbn(hhk, ctx->key))
498         return 0;
499     SHA1(hhk, sizeof hhk, hhk);
500     if (memcmp(hhk, received->hhk, sizeof hhk)) {
501         JPAKEerr(JPAKE_F_JPAKE_STEP3A_PROCESS,
502                  JPAKE_R_HASH_OF_HASH_OF_KEY_MISMATCH);
503         return 0;
504     }
505     return 1;
506 }
507
508 void JPAKE_STEP3A_release(JPAKE_STEP3A *s3a)
509 {
510 }
511
512 void JPAKE_STEP3B_init(JPAKE_STEP3B *s3b)
513 {
514 }
515
516 int JPAKE_STEP3B_generate(JPAKE_STEP3B *send, JPAKE_CTX *ctx)
517 {
518     if (!quickhashbn(send->hk, ctx->key))
519         return 0;
520     return 1;
521 }
522
523 int JPAKE_STEP3B_process(JPAKE_CTX *ctx, const JPAKE_STEP3B *received)
524 {
525     unsigned char hk[SHA_DIGEST_LENGTH];
526
527     if (!quickhashbn(hk, ctx->key))
528         return 0;
529     if (memcmp(hk, received->hk, sizeof hk)) {
530         JPAKEerr(JPAKE_F_JPAKE_STEP3B_PROCESS, JPAKE_R_HASH_OF_KEY_MISMATCH);
531         return 0;
532     }
533     return 1;
534 }
535
536 void JPAKE_STEP3B_release(JPAKE_STEP3B *s3b)
537 {
538 }
539
540 const BIGNUM *JPAKE_get_shared_key(JPAKE_CTX *ctx)
541 {
542     return ctx->key;
543 }