e8bdbf58b1db0545043b3906e01ef4b6a5d4a2a0
[openssl.git] / crypto / srp / srp_vfy.c
1 /* crypto/srp/srp_vfy.c */
2 /*
3  * Written by Christophe Renou (christophe.renou@edelweb.fr) with the
4  * precious help of Peter Sylvester (peter.sylvester@edelweb.fr) for the
5  * EdelKey project and contributed to the OpenSSL project 2004.
6  */
7 /* ====================================================================
8  * Copyright (c) 2004 The OpenSSL Project.  All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  *
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  *
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in
19  *    the documentation and/or other materials provided with the
20  *    distribution.
21  *
22  * 3. All advertising materials mentioning features or use of this
23  *    software must display the following acknowledgment:
24  *    "This product includes software developed by the OpenSSL Project
25  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26  *
27  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
28  *    endorse or promote products derived from this software without
29  *    prior written permission. For written permission, please contact
30  *    licensing@OpenSSL.org.
31  *
32  * 5. Products derived from this software may not be called "OpenSSL"
33  *    nor may "OpenSSL" appear in their names without prior written
34  *    permission of the OpenSSL Project.
35  *
36  * 6. Redistributions of any form whatsoever must retain the following
37  *    acknowledgment:
38  *    "This product includes software developed by the OpenSSL Project
39  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
42  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
44  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
45  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
47  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
48  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
50  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
51  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
52  * OF THE POSSIBILITY OF SUCH DAMAGE.
53  * ====================================================================
54  *
55  * This product includes cryptographic software written by Eric Young
56  * (eay@cryptsoft.com).  This product includes software written by Tim
57  * Hudson (tjh@cryptsoft.com).
58  *
59  */
60 #ifndef OPENSSL_NO_SRP
61 # include "cryptlib.h"
62 # include <openssl/sha.h>
63 # include <openssl/srp.h>
64 # include <openssl/evp.h>
65 # include <openssl/buffer.h>
66 # include <openssl/rand.h>
67 # include <openssl/txt_db.h>
68
69 # define SRP_RANDOM_SALT_LEN 20
70 # define MAX_LEN 2500
71
72 static char b64table[] =
73     "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz./";
74
75 /*
76  * the following two conversion routines have been inspired by code from
77  * Stanford
78  */
79
80 /*
81  * Convert a base64 string into raw byte array representation.
82  */
83 static int t_fromb64(unsigned char *a, const char *src)
84 {
85     char *loc;
86     int i, j;
87     int size;
88
89     while (*src && (*src == ' ' || *src == '\t' || *src == '\n'))
90         ++src;
91     size = strlen(src);
92     i = 0;
93     while (i < size) {
94         loc = strchr(b64table, src[i]);
95         if (loc == (char *)0)
96             break;
97         else
98             a[i] = loc - b64table;
99         ++i;
100     }
101     /* if nothing valid to process we have a zero length response */
102     if (i == 0)
103         return 0;
104     size = i;
105     i = size - 1;
106     j = size;
107     while (1) {
108         a[j] = a[i];
109         if (--i < 0)
110             break;
111         a[j] |= (a[i] & 3) << 6;
112         --j;
113         a[j] = (unsigned char)((a[i] & 0x3c) >> 2);
114         if (--i < 0)
115             break;
116         a[j] |= (a[i] & 0xf) << 4;
117         --j;
118         a[j] = (unsigned char)((a[i] & 0x30) >> 4);
119         if (--i < 0)
120             break;
121         a[j] |= (a[i] << 2);
122
123         a[--j] = 0;
124         if (--i < 0)
125             break;
126     }
127     while (a[j] == 0 && j <= size)
128         ++j;
129     i = 0;
130     while (j <= size)
131         a[i++] = a[j++];
132     return i;
133 }
134
135 /*
136  * Convert a raw byte string into a null-terminated base64 ASCII string.
137  */
138 static char *t_tob64(char *dst, const unsigned char *src, int size)
139 {
140     int c, pos = size % 3;
141     unsigned char b0 = 0, b1 = 0, b2 = 0, notleading = 0;
142     char *olddst = dst;
143
144     switch (pos) {
145     case 1:
146         b2 = src[0];
147         break;
148     case 2:
149         b1 = src[0];
150         b2 = src[1];
151         break;
152     }
153
154     while (1) {
155         c = (b0 & 0xfc) >> 2;
156         if (notleading || c != 0) {
157             *dst++ = b64table[c];
158             notleading = 1;
159         }
160         c = ((b0 & 3) << 4) | ((b1 & 0xf0) >> 4);
161         if (notleading || c != 0) {
162             *dst++ = b64table[c];
163             notleading = 1;
164         }
165         c = ((b1 & 0xf) << 2) | ((b2 & 0xc0) >> 6);
166         if (notleading || c != 0) {
167             *dst++ = b64table[c];
168             notleading = 1;
169         }
170         c = b2 & 0x3f;
171         if (notleading || c != 0) {
172             *dst++ = b64table[c];
173             notleading = 1;
174         }
175         if (pos >= size)
176             break;
177         else {
178             b0 = src[pos++];
179             b1 = src[pos++];
180             b2 = src[pos++];
181         }
182     }
183
184     *dst++ = '\0';
185     return olddst;
186 }
187
188 static void SRP_user_pwd_free(SRP_user_pwd *user_pwd)
189 {
190     if (user_pwd == NULL)
191         return;
192     BN_free(user_pwd->s);
193     BN_clear_free(user_pwd->v);
194     OPENSSL_free(user_pwd->id);
195     OPENSSL_free(user_pwd->info);
196     OPENSSL_free(user_pwd);
197 }
198
199 static SRP_user_pwd *SRP_user_pwd_new(void)
200 {
201     SRP_user_pwd *ret = OPENSSL_malloc(sizeof(SRP_user_pwd));
202     if (ret == NULL)
203         return NULL;
204     ret->N = NULL;
205     ret->g = NULL;
206     ret->s = NULL;
207     ret->v = NULL;
208     ret->id = NULL;
209     ret->info = NULL;
210     return ret;
211 }
212
213 static void SRP_user_pwd_set_gN(SRP_user_pwd *vinfo, const BIGNUM *g,
214                                 const BIGNUM *N)
215 {
216     vinfo->N = N;
217     vinfo->g = g;
218 }
219
220 static int SRP_user_pwd_set_ids(SRP_user_pwd *vinfo, const char *id,
221                                 const char *info)
222 {
223     if (id != NULL && NULL == (vinfo->id = BUF_strdup(id)))
224         return 0;
225     return (info == NULL || NULL != (vinfo->info = BUF_strdup(info)));
226 }
227
228 static int SRP_user_pwd_set_sv(SRP_user_pwd *vinfo, const char *s,
229                                const char *v)
230 {
231     unsigned char tmp[MAX_LEN];
232     int len;
233
234     if (strlen(s) > MAX_LEN || strlen(v) > MAX_LEN)
235         return 0;
236     len = t_fromb64(tmp, v);
237     if (NULL == (vinfo->v = BN_bin2bn(tmp, len, NULL)))
238         return 0;
239     len = t_fromb64(tmp, s);
240     return ((vinfo->s = BN_bin2bn(tmp, len, NULL)) != NULL);
241 }
242
243 static int SRP_user_pwd_set_sv_BN(SRP_user_pwd *vinfo, BIGNUM *s, BIGNUM *v)
244 {
245     vinfo->v = v;
246     vinfo->s = s;
247     return (vinfo->s != NULL && vinfo->v != NULL);
248 }
249
250 SRP_VBASE *SRP_VBASE_new(char *seed_key)
251 {
252     SRP_VBASE *vb = OPENSSL_malloc(sizeof(SRP_VBASE));
253
254     if (vb == NULL)
255         return NULL;
256     if (!(vb->users_pwd = sk_SRP_user_pwd_new_null()) ||
257         !(vb->gN_cache = sk_SRP_gN_cache_new_null())) {
258         OPENSSL_free(vb);
259         return NULL;
260     }
261     vb->default_g = NULL;
262     vb->default_N = NULL;
263     vb->seed_key = NULL;
264     if ((seed_key != NULL) && (vb->seed_key = BUF_strdup(seed_key)) == NULL) {
265         sk_SRP_user_pwd_free(vb->users_pwd);
266         sk_SRP_gN_cache_free(vb->gN_cache);
267         OPENSSL_free(vb);
268         return NULL;
269     }
270     return vb;
271 }
272
273 int SRP_VBASE_free(SRP_VBASE *vb)
274 {
275     sk_SRP_user_pwd_pop_free(vb->users_pwd, SRP_user_pwd_free);
276     sk_SRP_gN_cache_free(vb->gN_cache);
277     OPENSSL_free(vb->seed_key);
278     OPENSSL_free(vb);
279     return 0;
280 }
281
282 static SRP_gN_cache *SRP_gN_new_init(const char *ch)
283 {
284     unsigned char tmp[MAX_LEN];
285     int len;
286     SRP_gN_cache *newgN = OPENSSL_malloc(sizeof(SRP_gN_cache));
287
288     if (newgN == NULL)
289         return NULL;
290
291     if ((newgN->b64_bn = BUF_strdup(ch)) == NULL)
292         goto err;
293
294     len = t_fromb64(tmp, ch);
295     if ((newgN->bn = BN_bin2bn(tmp, len, NULL)))
296         return newgN;
297
298     OPENSSL_free(newgN->b64_bn);
299  err:
300     OPENSSL_free(newgN);
301     return NULL;
302 }
303
304 static void SRP_gN_free(SRP_gN_cache *gN_cache)
305 {
306     if (gN_cache == NULL)
307         return;
308     OPENSSL_free(gN_cache->b64_bn);
309     BN_free(gN_cache->bn);
310     OPENSSL_free(gN_cache);
311 }
312
313 static SRP_gN *SRP_get_gN_by_id(const char *id, STACK_OF(SRP_gN) *gN_tab)
314 {
315     int i;
316
317     SRP_gN *gN;
318     if (gN_tab != NULL)
319         for (i = 0; i < sk_SRP_gN_num(gN_tab); i++) {
320             gN = sk_SRP_gN_value(gN_tab, i);
321             if (gN && (id == NULL || strcmp(gN->id, id) == 0))
322                 return gN;
323         }
324
325     return SRP_get_default_gN(id);
326 }
327
328 static BIGNUM *SRP_gN_place_bn(STACK_OF(SRP_gN_cache) *gN_cache, char *ch)
329 {
330     int i;
331     if (gN_cache == NULL)
332         return NULL;
333
334     /* search if we have already one... */
335     for (i = 0; i < sk_SRP_gN_cache_num(gN_cache); i++) {
336         SRP_gN_cache *cache = sk_SRP_gN_cache_value(gN_cache, i);
337         if (strcmp(cache->b64_bn, ch) == 0)
338             return cache->bn;
339     }
340     {                           /* it is the first time that we find it */
341         SRP_gN_cache *newgN = SRP_gN_new_init(ch);
342         if (newgN) {
343             if (sk_SRP_gN_cache_insert(gN_cache, newgN, 0) > 0)
344                 return newgN->bn;
345             SRP_gN_free(newgN);
346         }
347     }
348     return NULL;
349 }
350
351 /*
352  * this function parses verifier file. Format is:
353  * string(index):base64(N):base64(g):0
354  * string(username):base64(v):base64(salt):int(index)
355  */
356
357 int SRP_VBASE_init(SRP_VBASE *vb, char *verifier_file)
358 {
359     int error_code;
360     STACK_OF(SRP_gN) *SRP_gN_tab = sk_SRP_gN_new_null();
361     char *last_index = NULL;
362     int i;
363     char **pp;
364
365     SRP_gN *gN = NULL;
366     SRP_user_pwd *user_pwd = NULL;
367
368     TXT_DB *tmpdb = NULL;
369     BIO *in = BIO_new(BIO_s_file());
370
371     error_code = SRP_ERR_OPEN_FILE;
372
373     if (in == NULL || BIO_read_filename(in, verifier_file) <= 0)
374         goto err;
375
376     error_code = SRP_ERR_VBASE_INCOMPLETE_FILE;
377
378     if ((tmpdb = TXT_DB_read(in, DB_NUMBER)) == NULL)
379         goto err;
380
381     error_code = SRP_ERR_MEMORY;
382
383     if (vb->seed_key) {
384         last_index = SRP_get_default_gN(NULL)->id;
385     }
386     for (i = 0; i < sk_OPENSSL_PSTRING_num(tmpdb->data); i++) {
387         pp = sk_OPENSSL_PSTRING_value(tmpdb->data, i);
388         if (pp[DB_srptype][0] == DB_SRP_INDEX) {
389             /*
390              * we add this couple in the internal Stack
391              */
392
393             if ((gN = OPENSSL_malloc(sizeof(SRP_gN))) == NULL)
394                 goto err;
395
396             if (!(gN->id = BUF_strdup(pp[DB_srpid]))
397                 || !(gN->N =
398                      SRP_gN_place_bn(vb->gN_cache, pp[DB_srpverifier]))
399                 || !(gN->g = SRP_gN_place_bn(vb->gN_cache, pp[DB_srpsalt]))
400                 || sk_SRP_gN_insert(SRP_gN_tab, gN, 0) == 0)
401                 goto err;
402
403             gN = NULL;
404
405             if (vb->seed_key != NULL) {
406                 last_index = pp[DB_srpid];
407             }
408         } else if (pp[DB_srptype][0] == DB_SRP_VALID) {
409             /* it is a user .... */
410             const SRP_gN *lgN;
411
412             if ((lgN = SRP_get_gN_by_id(pp[DB_srpgN], SRP_gN_tab)) != NULL) {
413                 error_code = SRP_ERR_MEMORY;
414                 if ((user_pwd = SRP_user_pwd_new()) == NULL)
415                     goto err;
416
417                 SRP_user_pwd_set_gN(user_pwd, lgN->g, lgN->N);
418                 if (!SRP_user_pwd_set_ids
419                     (user_pwd, pp[DB_srpid], pp[DB_srpinfo]))
420                     goto err;
421
422                 error_code = SRP_ERR_VBASE_BN_LIB;
423                 if (!SRP_user_pwd_set_sv
424                     (user_pwd, pp[DB_srpsalt], pp[DB_srpverifier]))
425                     goto err;
426
427                 if (sk_SRP_user_pwd_insert(vb->users_pwd, user_pwd, 0) == 0)
428                     goto err;
429                 user_pwd = NULL; /* abandon responsability */
430             }
431         }
432     }
433
434     if (last_index != NULL) {
435         /* this means that we want to simulate a default user */
436
437         if (((gN = SRP_get_gN_by_id(last_index, SRP_gN_tab)) == NULL)) {
438             error_code = SRP_ERR_VBASE_BN_LIB;
439             goto err;
440         }
441         vb->default_g = gN->g;
442         vb->default_N = gN->N;
443         gN = NULL;
444     }
445     error_code = SRP_NO_ERROR;
446
447  err:
448     /*
449      * there may be still some leaks to fix, if this fails, the application
450      * terminates most likely
451      */
452
453     if (gN != NULL) {
454         OPENSSL_free(gN->id);
455         OPENSSL_free(gN);
456     }
457
458     SRP_user_pwd_free(user_pwd);
459
460     if (tmpdb)
461         TXT_DB_free(tmpdb);
462     BIO_free_all(in);
463
464     sk_SRP_gN_free(SRP_gN_tab);
465
466     return error_code;
467
468 }
469
470 SRP_user_pwd *SRP_VBASE_get_by_user(SRP_VBASE *vb, char *username)
471 {
472     int i;
473     SRP_user_pwd *user;
474     unsigned char digv[SHA_DIGEST_LENGTH];
475     unsigned char digs[SHA_DIGEST_LENGTH];
476     EVP_MD_CTX ctxt;
477
478     if (vb == NULL)
479         return NULL;
480     for (i = 0; i < sk_SRP_user_pwd_num(vb->users_pwd); i++) {
481         user = sk_SRP_user_pwd_value(vb->users_pwd, i);
482         if (strcmp(user->id, username) == 0)
483             return user;
484     }
485     if ((vb->seed_key == NULL) ||
486         (vb->default_g == NULL) || (vb->default_N == NULL))
487         return NULL;
488
489 /* if the user is unknown we set parameters as well if we have a seed_key */
490
491     if ((user = SRP_user_pwd_new()) == NULL)
492         return NULL;
493
494     SRP_user_pwd_set_gN(user, vb->default_g, vb->default_N);
495
496     if (!SRP_user_pwd_set_ids(user, username, NULL))
497         goto err;
498
499     if (RAND_bytes(digv, SHA_DIGEST_LENGTH) <= 0)
500         goto err;
501     EVP_MD_CTX_init(&ctxt);
502     EVP_DigestInit_ex(&ctxt, EVP_sha1(), NULL);
503     EVP_DigestUpdate(&ctxt, vb->seed_key, strlen(vb->seed_key));
504     EVP_DigestUpdate(&ctxt, username, strlen(username));
505     EVP_DigestFinal_ex(&ctxt, digs, NULL);
506     EVP_MD_CTX_cleanup(&ctxt);
507     if (SRP_user_pwd_set_sv_BN
508         (user, BN_bin2bn(digs, SHA_DIGEST_LENGTH, NULL),
509          BN_bin2bn(digv, SHA_DIGEST_LENGTH, NULL)))
510         return user;
511
512  err:SRP_user_pwd_free(user);
513     return NULL;
514 }
515
516 /*
517  * create a verifier (*salt,*verifier,g and N are in base64)
518  */
519 char *SRP_create_verifier(const char *user, const char *pass, char **salt,
520                           char **verifier, const char *N, const char *g)
521 {
522     int len;
523     char *result = NULL;
524     char *vf;
525     BIGNUM *N_bn = NULL, *g_bn = NULL, *s = NULL, *v = NULL;
526     unsigned char tmp[MAX_LEN];
527     unsigned char tmp2[MAX_LEN];
528     char *defgNid = NULL;
529
530     if ((user == NULL) ||
531         (pass == NULL) || (salt == NULL) || (verifier == NULL))
532         goto err;
533
534     if (N) {
535         if (!(len = t_fromb64(tmp, N)))
536             goto err;
537         N_bn = BN_bin2bn(tmp, len, NULL);
538         if (!(len = t_fromb64(tmp, g)))
539             goto err;
540         g_bn = BN_bin2bn(tmp, len, NULL);
541         defgNid = "*";
542     } else {
543         SRP_gN *gN = SRP_get_gN_by_id(g, NULL);
544         if (gN == NULL)
545             goto err;
546         N_bn = gN->N;
547         g_bn = gN->g;
548         defgNid = gN->id;
549     }
550
551     if (*salt == NULL) {
552         if (RAND_bytes(tmp2, SRP_RANDOM_SALT_LEN) <= 0)
553             goto err;
554
555         s = BN_bin2bn(tmp2, SRP_RANDOM_SALT_LEN, NULL);
556     } else {
557         if (!(len = t_fromb64(tmp2, *salt)))
558             goto err;
559         s = BN_bin2bn(tmp2, len, NULL);
560     }
561
562     if (!SRP_create_verifier_BN(user, pass, &s, &v, N_bn, g_bn))
563         goto err;
564
565     BN_bn2bin(v, tmp);
566     if (((vf = OPENSSL_malloc(BN_num_bytes(v) * 2)) == NULL))
567         goto err;
568     t_tob64(vf, tmp, BN_num_bytes(v));
569
570     *verifier = vf;
571     if (*salt == NULL) {
572         char *tmp_salt;
573
574         if ((tmp_salt = OPENSSL_malloc(SRP_RANDOM_SALT_LEN * 2)) == NULL) {
575             OPENSSL_free(vf);
576             goto err;
577         }
578         t_tob64(tmp_salt, tmp2, SRP_RANDOM_SALT_LEN);
579         *salt = tmp_salt;
580     }
581
582     result = defgNid;
583
584  err:
585     if (N) {
586         BN_free(N_bn);
587         BN_free(g_bn);
588     }
589     return result;
590 }
591
592 /*
593  * create a verifier (*salt,*verifier,g and N are BIGNUMs)
594  */
595 int SRP_create_verifier_BN(const char *user, const char *pass, BIGNUM **salt,
596                            BIGNUM **verifier, const BIGNUM *N,
597                            const BIGNUM *g)
598 {
599     int result = 0;
600     BIGNUM *x = NULL;
601     BN_CTX *bn_ctx = BN_CTX_new();
602     unsigned char tmp2[MAX_LEN];
603
604     if ((user == NULL) ||
605         (pass == NULL) ||
606         (salt == NULL) ||
607         (verifier == NULL) || (N == NULL) || (g == NULL) || (bn_ctx == NULL))
608         goto err;
609
610     if (*salt == NULL) {
611         if (RAND_bytes(tmp2, SRP_RANDOM_SALT_LEN) <= 0)
612             goto err;
613
614         *salt = BN_bin2bn(tmp2, SRP_RANDOM_SALT_LEN, NULL);
615     }
616
617     x = SRP_Calc_x(*salt, user, pass);
618
619     *verifier = BN_new();
620     if (*verifier == NULL)
621         goto err;
622
623     if (!BN_mod_exp(*verifier, g, x, N, bn_ctx)) {
624         BN_clear_free(*verifier);
625         goto err;
626     }
627
628     result = 1;
629
630  err:
631
632     BN_clear_free(x);
633     BN_CTX_free(bn_ctx);
634     return result;
635 }
636
637 #endif