JPAKE_CTX_new: check for NULL result when allocating ctx
[openssl.git] / crypto / jpake / jpake.c
1 #include "jpake.h"
2
3 #include <openssl/crypto.h>
4 #include <openssl/sha.h>
5 #include <openssl/err.h>
6 #include <memory.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 void 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     hashlength(sha, l);
158     BN_bn2bin(bn, bin);
159     SHA1_Update(sha, bin, l);
160     OPENSSL_free(bin);
161     }
162
163 /* h=hash(g, g^r, g^x, name) */
164 static void zkp_hash(BIGNUM *h, const BIGNUM *zkpg, const JPAKE_STEP_PART *p,
165                      const char *proof_name)
166     {
167     unsigned char md[SHA_DIGEST_LENGTH];
168     SHA_CTX sha;
169
170    /*
171     * XXX: hash should not allow moving of the boundaries - Java code
172     * is flawed in this respect. Length encoding seems simplest.
173     */
174     SHA1_Init(&sha);
175     hashbn(&sha, zkpg);
176     OPENSSL_assert(!BN_is_zero(p->zkpx.gr));
177     hashbn(&sha, p->zkpx.gr);
178     hashbn(&sha, p->gx);
179     hashstring(&sha, proof_name);
180     SHA1_Final(md, &sha);
181     BN_bin2bn(md, SHA_DIGEST_LENGTH, h);
182     }
183
184 /*
185  * Prove knowledge of x
186  * Note that p->gx has already been calculated
187  */
188 static void generate_zkp(JPAKE_STEP_PART *p, const BIGNUM *x,
189                          const BIGNUM *zkpg, JPAKE_CTX *ctx)
190     {
191     BIGNUM *r = BN_new();
192     BIGNUM *h = BN_new();
193     BIGNUM *t = BN_new();
194
195    /*
196     * r in [0,q)
197     * XXX: Java chooses r in [0, 2^160) - i.e. distribution not uniform
198     */
199     BN_rand_range(r, ctx->p.q);
200    /* g^r */
201     BN_mod_exp(p->zkpx.gr, zkpg, r, ctx->p.p, ctx->ctx);
202
203    /* h=hash... */
204     zkp_hash(h, zkpg, p, ctx->p.name);
205
206    /* b = r - x*h */
207     BN_mod_mul(t, x, h, ctx->p.q, ctx->ctx);
208     BN_mod_sub(p->zkpx.b, r, t, ctx->p.q, ctx->ctx);
209
210    /* cleanup */
211     BN_free(t);
212     BN_free(h);
213     BN_free(r);
214     }
215
216 static int verify_zkp(const JPAKE_STEP_PART *p, const BIGNUM *zkpg,
217                       JPAKE_CTX *ctx)
218     {
219     BIGNUM *h = BN_new();
220     BIGNUM *t1 = BN_new();
221     BIGNUM *t2 = BN_new();
222     BIGNUM *t3 = BN_new();
223     int ret = 0;
224
225     zkp_hash(h, zkpg, p, ctx->p.peer_name);
226
227    /* t1 = g^b */
228     BN_mod_exp(t1, zkpg, p->zkpx.b, ctx->p.p, ctx->ctx);
229    /* t2 = (g^x)^h = g^{hx} */
230     BN_mod_exp(t2, p->gx, h, ctx->p.p, ctx->ctx);
231    /* t3 = t1 * t2 = g^{hx} * g^b = g^{hx+b} = g^r (allegedly) */
232     BN_mod_mul(t3, t1, t2, ctx->p.p, ctx->ctx);
233
234    /* verify t3 == g^r */
235     if(BN_cmp(t3, p->zkpx.gr) == 0)
236         ret = 1;
237     else
238         JPAKEerr(JPAKE_F_VERIFY_ZKP, JPAKE_R_ZKP_VERIFY_FAILED);
239
240    /* cleanup */
241     BN_free(t3);
242     BN_free(t2);
243     BN_free(t1);
244     BN_free(h);
245
246     return ret;
247     }    
248
249 static void generate_step_part(JPAKE_STEP_PART *p, const BIGNUM *x,
250                                const BIGNUM *g, JPAKE_CTX *ctx)
251     {
252     BN_mod_exp(p->gx, g, x, ctx->p.p, ctx->ctx);
253     generate_zkp(p, x, g, ctx);
254     }
255
256 /* Generate each party's random numbers. xa is in [0, q), xb is in [1, q). */
257 static void genrand(JPAKE_CTX *ctx)
258     {
259     BIGNUM *qm1;
260
261    /* xa in [0, q) */
262     BN_rand_range(ctx->xa, ctx->p.q);
263
264    /* q-1 */
265     qm1 = BN_new();
266     BN_copy(qm1, ctx->p.q);
267     BN_sub_word(qm1, 1);
268
269    /* ... and xb in [0, q-1) */
270     BN_rand_range(ctx->xb, qm1);
271    /* [1, q) */
272     BN_add_word(ctx->xb, 1);
273
274    /* cleanup */
275     BN_free(qm1);
276     }
277
278 int JPAKE_STEP1_generate(JPAKE_STEP1 *send, JPAKE_CTX *ctx)
279     {
280     genrand(ctx);
281     generate_step_part(&send->p1, ctx->xa, ctx->p.g, ctx);
282     generate_step_part(&send->p2, ctx->xb, ctx->p.g, ctx);
283
284     return 1;
285     }
286
287 /* g^x is a legal value */
288 static int is_legal(const BIGNUM *gx, const JPAKE_CTX *ctx)
289     {
290     BIGNUM *t;
291     int res;
292     
293     if(BN_is_negative(gx) || BN_is_zero(gx) || BN_cmp(gx, ctx->p.p) >= 0)
294         return 0;
295
296     t = BN_new();
297     BN_mod_exp(t, gx, ctx->p.q, ctx->p.p, ctx->ctx);
298     res = BN_is_one(t);
299     BN_free(t);
300
301     return res;
302     }
303
304 int JPAKE_STEP1_process(JPAKE_CTX *ctx, const JPAKE_STEP1 *received)
305     {
306     if(!is_legal(received->p1.gx, ctx))
307         {
308         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_G_TO_THE_X3_IS_NOT_LEGAL);
309         return 0;
310         }
311
312     if(!is_legal(received->p2.gx, ctx))
313         {
314         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_G_TO_THE_X4_IS_NOT_LEGAL);
315         return 0;
316         }
317
318    /* verify their ZKP(xc) */
319     if(!verify_zkp(&received->p1, ctx->p.g, ctx))
320         {
321         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_VERIFY_X3_FAILED);
322         return 0;
323         }
324
325    /* verify their ZKP(xd) */
326     if(!verify_zkp(&received->p2, ctx->p.g, ctx))
327         {
328         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_VERIFY_X4_FAILED);
329         return 0;
330         }
331
332    /* g^xd != 1 */
333     if(BN_is_one(received->p2.gx))
334         {
335         JPAKEerr(JPAKE_F_JPAKE_STEP1_PROCESS, JPAKE_R_G_TO_THE_X4_IS_ONE);
336         return 0;
337         }
338
339    /* Save the bits we need for later */
340     BN_copy(ctx->p.gxc, received->p1.gx);
341     BN_copy(ctx->p.gxd, received->p2.gx);
342
343     return 1;
344     }
345
346
347 int JPAKE_STEP2_generate(JPAKE_STEP2 *send, JPAKE_CTX *ctx)
348     {
349     BIGNUM *t1 = BN_new();
350     BIGNUM *t2 = BN_new();
351
352    /*
353     * X = g^{(xa + xc + xd) * xb * s}
354     * t1 = g^xa
355     */
356     BN_mod_exp(t1, ctx->p.g, ctx->xa, ctx->p.p, ctx->ctx);
357    /* t2 = t1 * g^{xc} = g^{xa} * g^{xc} = g^{xa + xc} */
358     BN_mod_mul(t2, t1, ctx->p.gxc, ctx->p.p, ctx->ctx);
359    /* t1 = t2 * g^{xd} = g^{xa + xc + xd} */
360     BN_mod_mul(t1, t2, ctx->p.gxd, ctx->p.p, ctx->ctx);
361    /* t2 = xb * s */
362     BN_mod_mul(t2, ctx->xb, ctx->secret, ctx->p.q, ctx->ctx);
363
364    /*
365     * ZKP(xb * s)
366     * XXX: this is kinda funky, because we're using
367     *
368     * g' = g^{xa + xc + xd}
369     *
370     * as the generator, which means X is g'^{xb * s}
371     * X = t1^{t2} = t1^{xb * s} = g^{(xa + xc + xd) * xb * s}
372     */
373     generate_step_part(send, t2, t1, ctx);
374
375    /* cleanup */
376     BN_free(t1);
377     BN_free(t2);
378
379     return 1;
380     }
381
382 /* gx = g^{xc + xa + xb} * xd * s */
383 static int compute_key(JPAKE_CTX *ctx, const BIGNUM *gx)
384     {
385     BIGNUM *t1 = BN_new();
386     BIGNUM *t2 = BN_new();
387     BIGNUM *t3 = BN_new();
388
389    /*
390     * K = (gx/g^{xb * xd * s})^{xb}
391     *   = (g^{(xc + xa + xb) * xd * s - xb * xd *s})^{xb}
392     *   = (g^{(xa + xc) * xd * s})^{xb}
393     *   = g^{(xa + xc) * xb * xd * s}
394     * [which is the same regardless of who calculates it]
395     */
396
397    /* t1 = (g^{xd})^{xb} = g^{xb * xd} */
398     BN_mod_exp(t1, ctx->p.gxd, ctx->xb, ctx->p.p, ctx->ctx);
399    /* t2 = -s = q-s */
400     BN_sub(t2, ctx->p.q, ctx->secret);
401    /* t3 = t1^t2 = g^{-xb * xd * s} */
402     BN_mod_exp(t3, t1, t2, ctx->p.p, ctx->ctx);
403    /* t1 = gx * t3 = X/g^{xb * xd * s} */
404     BN_mod_mul(t1, gx, t3, ctx->p.p, ctx->ctx);
405    /* K = t1^{xb} */
406     BN_mod_exp(ctx->key, t1, ctx->xb, ctx->p.p, ctx->ctx);
407
408    /* cleanup */
409     BN_free(t3);
410     BN_free(t2);
411     BN_free(t1);
412
413     return 1;
414     }
415
416 int JPAKE_STEP2_process(JPAKE_CTX *ctx, const JPAKE_STEP2 *received)
417     {
418     BIGNUM *t1 = BN_new();
419     BIGNUM *t2 = BN_new();
420     int ret = 0;
421
422    /*
423     * g' = g^{xc + xa + xb} [from our POV]
424     * t1 = xa + xb
425     */
426     BN_mod_add(t1, ctx->xa, ctx->xb, ctx->p.q, ctx->ctx);
427    /* t2 = g^{t1} = g^{xa+xb} */
428     BN_mod_exp(t2, ctx->p.g, t1, ctx->p.p, ctx->ctx);
429    /* t1 = g^{xc} * t2 = g^{xc + xa + xb} */
430     BN_mod_mul(t1, ctx->p.gxc, t2, ctx->p.p, ctx->ctx);
431
432     if(verify_zkp(received, t1, ctx))
433         ret = 1;
434     else
435         JPAKEerr(JPAKE_F_JPAKE_STEP2_PROCESS, JPAKE_R_VERIFY_B_FAILED);
436
437     compute_key(ctx, received->gx);
438
439    /* cleanup */
440     BN_free(t2);
441     BN_free(t1);
442
443     return ret;
444     }
445
446 static void quickhashbn(unsigned char *md, const BIGNUM *bn)
447     {
448     SHA_CTX sha;
449
450     SHA1_Init(&sha);
451     hashbn(&sha, bn);
452     SHA1_Final(md, &sha);
453     }
454
455 void JPAKE_STEP3A_init(JPAKE_STEP3A *s3a)
456     {}
457
458 int JPAKE_STEP3A_generate(JPAKE_STEP3A *send, JPAKE_CTX *ctx)
459     {
460     quickhashbn(send->hhk, ctx->key);
461     SHA1(send->hhk, sizeof send->hhk, send->hhk);
462
463     return 1;
464     }
465
466 int JPAKE_STEP3A_process(JPAKE_CTX *ctx, const JPAKE_STEP3A *received)
467     {
468     unsigned char hhk[SHA_DIGEST_LENGTH];
469
470     quickhashbn(hhk, ctx->key);
471     SHA1(hhk, sizeof hhk, hhk);
472     if(memcmp(hhk, received->hhk, sizeof hhk))
473         {
474         JPAKEerr(JPAKE_F_JPAKE_STEP3A_PROCESS, JPAKE_R_HASH_OF_HASH_OF_KEY_MISMATCH);
475         return 0;
476         }
477     return 1;
478     }
479
480 void JPAKE_STEP3A_release(JPAKE_STEP3A *s3a)
481     {}
482
483 void JPAKE_STEP3B_init(JPAKE_STEP3B *s3b)
484     {}
485
486 int JPAKE_STEP3B_generate(JPAKE_STEP3B *send, JPAKE_CTX *ctx)
487     {
488     quickhashbn(send->hk, ctx->key);
489
490     return 1;
491     }
492
493 int JPAKE_STEP3B_process(JPAKE_CTX *ctx, const JPAKE_STEP3B *received)
494     {
495     unsigned char hk[SHA_DIGEST_LENGTH];
496
497     quickhashbn(hk, ctx->key);
498     if(memcmp(hk, received->hk, sizeof hk))
499         {
500         JPAKEerr(JPAKE_F_JPAKE_STEP3B_PROCESS, JPAKE_R_HASH_OF_KEY_MISMATCH);
501         return 0;
502         }
503     return 1;
504     }
505
506 void JPAKE_STEP3B_release(JPAKE_STEP3B *s3b)
507     {}
508
509 const BIGNUM *JPAKE_get_shared_key(JPAKE_CTX *ctx)
510     {
511     return ctx->key;
512     }
513