2 * Copyright 2004-2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2004, EdelKey Project. All Rights Reserved.
5 * Licensed under the OpenSSL license (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
10 * Originally written by Christophe Renou and Peter Sylvester,
11 * for the EdelKey project.
14 #ifndef OPENSSL_NO_SRP
15 # include "internal/cryptlib.h"
16 # include "internal/evp_int.h"
17 # include <openssl/sha.h>
18 # include <openssl/srp.h>
19 # include <openssl/evp.h>
20 # include <openssl/buffer.h>
21 # include <openssl/rand.h>
22 # include <openssl/txt_db.h>
23 # include <openssl/err.h>
25 # define SRP_RANDOM_SALT_LEN 20
29 * Note that SRP uses its own variant of base 64 encoding. A different base64
30 * alphabet is used and no padding '=' characters are added. Instead we pad to
31 * the front with 0 bytes and subsequently strip off leading encoded padding.
32 * This variant is used for compatibility with other SRP implementations -
33 * notably libsrp, but also others. It is also required for backwards
34 * compatibility in order to load verifier files from other OpenSSL versions.
38 * Convert a base64 string into raw byte array representation.
39 * Returns the length of the decoded data, or -1 on error.
41 static int t_fromb64(unsigned char *a, size_t alen, const char *src)
44 int outl = 0, outl2 = 0;
46 const unsigned char *pad = (const unsigned char *)"00";
48 while (*src == ' ' || *src == '\t' || *src == '\n')
51 padsize = 4 - (size & 3);
54 /* Four bytes in src become three bytes output. */
55 if (size > INT_MAX || ((size + padsize) / 4) * 3 > alen)
58 ctx = EVP_ENCODE_CTX_new();
63 * This should never occur because 1 byte of data always requires 2 bytes of
65 * 0 bytes unencoded = 0 bytes encoded
66 * 1 byte unencoded = 2 bytes encoded
67 * 2 bytes unencoded = 3 bytes encoded
68 * 3 bytes unencoded = 4 bytes encoded
69 * 4 bytes unencoded = 6 bytes encoded
77 /* Valid padsize values are now 0, 1 or 2 */
80 evp_encode_ctx_set_flags(ctx, EVP_ENCODE_CTX_USE_SRP_ALPHABET);
82 /* Add any encoded padding that is required */
84 && EVP_DecodeUpdate(ctx, a, &outl, pad, padsize) < 0) {
88 if (EVP_DecodeUpdate(ctx, a, &outl2, (const unsigned char *)src, size) < 0) {
93 EVP_DecodeFinal(ctx, a + outl, &outl2);
96 /* Strip off the leading padding */
98 if ((int)padsize >= outl) {
104 * If we added 1 byte of padding prior to encoding then we have 2 bytes
105 * of "real" data which gets spread across 4 encoded bytes like this:
106 * (6 bits pad)(2 bits pad | 4 bits data)(6 bits data)(6 bits data)
107 * So 1 byte of pre-encoding padding results in 1 full byte of encoded
109 * If we added 2 bytes of padding prior to encoding this gets encoded
111 * (6 bits pad)(6 bits pad)(4 bits pad | 2 bits data)(6 bits data)
112 * So 2 bytes of pre-encoding padding results in 2 full bytes of encoded
113 * padding, i.e. we have to strip the same number of bytes of padding
114 * from the encoded data as we added to the pre-encoded data.
116 memmove(a, a + padsize, outl - padsize);
121 EVP_ENCODE_CTX_free(ctx);
127 * Convert a raw byte string into a null-terminated base64 ASCII string.
128 * Returns 1 on success or 0 on error.
130 static int t_tob64(char *dst, const unsigned char *src, int size)
132 EVP_ENCODE_CTX *ctx = EVP_ENCODE_CTX_new();
133 int outl = 0, outl2 = 0;
134 unsigned char pad[2] = {0, 0};
141 evp_encode_ctx_set_flags(ctx, EVP_ENCODE_CTX_NO_NEWLINES
142 | EVP_ENCODE_CTX_USE_SRP_ALPHABET);
145 * We pad at the front with zero bytes until the length is a multiple of 3
146 * so that EVP_EncodeUpdate/EVP_EncodeFinal does not add any of its own "="
149 leadz = 3 - (size % 3);
151 && !EVP_EncodeUpdate(ctx, (unsigned char *)dst, &outl, pad,
153 EVP_ENCODE_CTX_free(ctx);
157 if (!EVP_EncodeUpdate(ctx, (unsigned char *)dst + outl, &outl2, src,
159 EVP_ENCODE_CTX_free(ctx);
163 EVP_EncodeFinal(ctx, (unsigned char *)dst + outl, &outl2);
166 /* Strip the encoded padding at the front */
168 memmove(dst, dst + leadz, outl - leadz);
169 dst[outl - leadz] = '\0';
172 EVP_ENCODE_CTX_free(ctx);
176 void SRP_user_pwd_free(SRP_user_pwd *user_pwd)
178 if (user_pwd == NULL)
180 BN_free(user_pwd->s);
181 BN_clear_free(user_pwd->v);
182 OPENSSL_free(user_pwd->id);
183 OPENSSL_free(user_pwd->info);
184 OPENSSL_free(user_pwd);
187 SRP_user_pwd *SRP_user_pwd_new(void)
191 if ((ret = OPENSSL_malloc(sizeof(*ret))) == NULL) {
192 /* SRPerr(SRP_F_SRP_USER_PWD_NEW, ERR_R_MALLOC_FAILURE); */ /*ckerr_ignore*/
204 void SRP_user_pwd_set_gN(SRP_user_pwd *vinfo, const BIGNUM *g,
211 int SRP_user_pwd_set1_ids(SRP_user_pwd *vinfo, const char *id,
214 OPENSSL_free(vinfo->id);
215 OPENSSL_free(vinfo->info);
216 if (id != NULL && NULL == (vinfo->id = OPENSSL_strdup(id)))
218 return (info == NULL || NULL != (vinfo->info = OPENSSL_strdup(info)));
221 static int SRP_user_pwd_set_sv(SRP_user_pwd *vinfo, const char *s,
224 unsigned char tmp[MAX_LEN];
230 len = t_fromb64(tmp, sizeof(tmp), v);
233 if (NULL == (vinfo->v = BN_bin2bn(tmp, len, NULL)))
235 len = t_fromb64(tmp, sizeof(tmp), s);
238 vinfo->s = BN_bin2bn(tmp, len, NULL);
239 if (vinfo->s == NULL)
248 int SRP_user_pwd_set0_sv(SRP_user_pwd *vinfo, BIGNUM *s, BIGNUM *v)
251 BN_clear_free(vinfo->v);
254 return (vinfo->s != NULL && vinfo->v != NULL);
257 static SRP_user_pwd *srp_user_pwd_dup(SRP_user_pwd *src)
263 if ((ret = SRP_user_pwd_new()) == NULL)
266 SRP_user_pwd_set_gN(ret, src->g, src->N);
267 if (!SRP_user_pwd_set1_ids(ret, src->id, src->info)
268 || !SRP_user_pwd_set0_sv(ret, BN_dup(src->s), BN_dup(src->v))) {
269 SRP_user_pwd_free(ret);
275 SRP_VBASE *SRP_VBASE_new(char *seed_key)
277 SRP_VBASE *vb = OPENSSL_malloc(sizeof(*vb));
281 if ((vb->users_pwd = sk_SRP_user_pwd_new_null()) == NULL
282 || (vb->gN_cache = sk_SRP_gN_cache_new_null()) == NULL) {
286 vb->default_g = NULL;
287 vb->default_N = NULL;
289 if ((seed_key != NULL) && (vb->seed_key = OPENSSL_strdup(seed_key)) == NULL) {
290 sk_SRP_user_pwd_free(vb->users_pwd);
291 sk_SRP_gN_cache_free(vb->gN_cache);
298 void SRP_VBASE_free(SRP_VBASE *vb)
302 sk_SRP_user_pwd_pop_free(vb->users_pwd, SRP_user_pwd_free);
303 sk_SRP_gN_cache_free(vb->gN_cache);
304 OPENSSL_free(vb->seed_key);
308 static SRP_gN_cache *SRP_gN_new_init(const char *ch)
310 unsigned char tmp[MAX_LEN];
312 SRP_gN_cache *newgN = OPENSSL_malloc(sizeof(*newgN));
317 len = t_fromb64(tmp, sizeof(tmp), ch);
321 if ((newgN->b64_bn = OPENSSL_strdup(ch)) == NULL)
324 if ((newgN->bn = BN_bin2bn(tmp, len, NULL)))
327 OPENSSL_free(newgN->b64_bn);
333 static void SRP_gN_free(SRP_gN_cache *gN_cache)
335 if (gN_cache == NULL)
337 OPENSSL_free(gN_cache->b64_bn);
338 BN_free(gN_cache->bn);
339 OPENSSL_free(gN_cache);
342 static SRP_gN *SRP_get_gN_by_id(const char *id, STACK_OF(SRP_gN) *gN_tab)
347 if (gN_tab != NULL) {
348 for (i = 0; i < sk_SRP_gN_num(gN_tab); i++) {
349 gN = sk_SRP_gN_value(gN_tab, i);
350 if (gN && (id == NULL || strcmp(gN->id, id) == 0))
355 return SRP_get_default_gN(id);
358 static BIGNUM *SRP_gN_place_bn(STACK_OF(SRP_gN_cache) *gN_cache, char *ch)
361 if (gN_cache == NULL)
364 /* search if we have already one... */
365 for (i = 0; i < sk_SRP_gN_cache_num(gN_cache); i++) {
366 SRP_gN_cache *cache = sk_SRP_gN_cache_value(gN_cache, i);
367 if (strcmp(cache->b64_bn, ch) == 0)
370 { /* it is the first time that we find it */
371 SRP_gN_cache *newgN = SRP_gN_new_init(ch);
373 if (sk_SRP_gN_cache_insert(gN_cache, newgN, 0) > 0)
382 * This function parses the verifier file generated by the srp app.
383 * The format for each entry is:
384 * V base64(verifier) base64(salt) username gNid userinfo(optional)
386 * I base64(N) base64(g)
387 * Note that base64 is the SRP variant of base64 encoding described
391 int SRP_VBASE_init(SRP_VBASE *vb, char *verifier_file)
394 STACK_OF(SRP_gN) *SRP_gN_tab = sk_SRP_gN_new_null();
395 char *last_index = NULL;
400 SRP_user_pwd *user_pwd = NULL;
402 TXT_DB *tmpdb = NULL;
403 BIO *in = BIO_new(BIO_s_file());
405 error_code = SRP_ERR_OPEN_FILE;
407 if (in == NULL || BIO_read_filename(in, verifier_file) <= 0)
410 error_code = SRP_ERR_VBASE_INCOMPLETE_FILE;
412 if ((tmpdb = TXT_DB_read(in, DB_NUMBER)) == NULL)
415 error_code = SRP_ERR_MEMORY;
418 last_index = SRP_get_default_gN(NULL)->id;
420 for (i = 0; i < sk_OPENSSL_PSTRING_num(tmpdb->data); i++) {
421 pp = sk_OPENSSL_PSTRING_value(tmpdb->data, i);
422 if (pp[DB_srptype][0] == DB_SRP_INDEX) {
424 * we add this couple in the internal Stack
427 if ((gN = OPENSSL_malloc(sizeof(*gN))) == NULL)
430 if ((gN->id = OPENSSL_strdup(pp[DB_srpid])) == NULL
431 || (gN->N = SRP_gN_place_bn(vb->gN_cache, pp[DB_srpverifier]))
433 || (gN->g = SRP_gN_place_bn(vb->gN_cache, pp[DB_srpsalt]))
435 || sk_SRP_gN_insert(SRP_gN_tab, gN, 0) == 0)
440 if (vb->seed_key != NULL) {
441 last_index = pp[DB_srpid];
443 } else if (pp[DB_srptype][0] == DB_SRP_VALID) {
444 /* it is a user .... */
447 if ((lgN = SRP_get_gN_by_id(pp[DB_srpgN], SRP_gN_tab)) != NULL) {
448 error_code = SRP_ERR_MEMORY;
449 if ((user_pwd = SRP_user_pwd_new()) == NULL)
452 SRP_user_pwd_set_gN(user_pwd, lgN->g, lgN->N);
453 if (!SRP_user_pwd_set1_ids
454 (user_pwd, pp[DB_srpid], pp[DB_srpinfo]))
457 error_code = SRP_ERR_VBASE_BN_LIB;
458 if (!SRP_user_pwd_set_sv
459 (user_pwd, pp[DB_srpsalt], pp[DB_srpverifier]))
462 if (sk_SRP_user_pwd_insert(vb->users_pwd, user_pwd, 0) == 0)
464 user_pwd = NULL; /* abandon responsibility */
469 if (last_index != NULL) {
470 /* this means that we want to simulate a default user */
472 if (((gN = SRP_get_gN_by_id(last_index, SRP_gN_tab)) == NULL)) {
473 error_code = SRP_ERR_VBASE_BN_LIB;
476 vb->default_g = gN->g;
477 vb->default_N = gN->N;
480 error_code = SRP_NO_ERROR;
484 * there may be still some leaks to fix, if this fails, the application
485 * terminates most likely
489 OPENSSL_free(gN->id);
493 SRP_user_pwd_free(user_pwd);
498 sk_SRP_gN_free(SRP_gN_tab);
504 static SRP_user_pwd *find_user(SRP_VBASE *vb, char *username)
512 for (i = 0; i < sk_SRP_user_pwd_num(vb->users_pwd); i++) {
513 user = sk_SRP_user_pwd_value(vb->users_pwd, i);
514 if (strcmp(user->id, username) == 0)
521 int SRP_VBASE_add0_user(SRP_VBASE *vb, SRP_user_pwd *user_pwd)
523 if (sk_SRP_user_pwd_push(vb->users_pwd, user_pwd) <= 0)
528 # if OPENSSL_API_COMPAT < 0x10100000L
530 * DEPRECATED: use SRP_VBASE_get1_by_user instead.
531 * This method ignores the configured seed and fails for an unknown user.
532 * Ownership of the returned pointer is not released to the caller.
533 * In other words, caller must not free the result.
535 SRP_user_pwd *SRP_VBASE_get_by_user(SRP_VBASE *vb, char *username)
537 return find_user(vb, username);
542 * Ownership of the returned pointer is released to the caller.
543 * In other words, caller must free the result once done.
545 SRP_user_pwd *SRP_VBASE_get1_by_user(SRP_VBASE *vb, char *username)
548 unsigned char digv[SHA_DIGEST_LENGTH];
549 unsigned char digs[SHA_DIGEST_LENGTH];
550 EVP_MD_CTX *ctxt = NULL;
555 if ((user = find_user(vb, username)) != NULL)
556 return srp_user_pwd_dup(user);
558 if ((vb->seed_key == NULL) ||
559 (vb->default_g == NULL) || (vb->default_N == NULL))
562 /* if the user is unknown we set parameters as well if we have a seed_key */
564 if ((user = SRP_user_pwd_new()) == NULL)
567 SRP_user_pwd_set_gN(user, vb->default_g, vb->default_N);
569 if (!SRP_user_pwd_set1_ids(user, username, NULL))
572 if (RAND_priv_bytes(digv, SHA_DIGEST_LENGTH) <= 0)
574 ctxt = EVP_MD_CTX_new();
576 || !EVP_DigestInit_ex(ctxt, EVP_sha1(), NULL)
577 || !EVP_DigestUpdate(ctxt, vb->seed_key, strlen(vb->seed_key))
578 || !EVP_DigestUpdate(ctxt, username, strlen(username))
579 || !EVP_DigestFinal_ex(ctxt, digs, NULL))
581 EVP_MD_CTX_free(ctxt);
583 if (SRP_user_pwd_set0_sv(user,
584 BN_bin2bn(digs, SHA_DIGEST_LENGTH, NULL),
585 BN_bin2bn(digv, SHA_DIGEST_LENGTH, NULL)))
589 EVP_MD_CTX_free(ctxt);
590 SRP_user_pwd_free(user);
595 * create a verifier (*salt,*verifier,g and N are in base64)
597 char *SRP_create_verifier(const char *user, const char *pass, char **salt,
598 char **verifier, const char *N, const char *g)
601 char *result = NULL, *vf = NULL;
602 const BIGNUM *N_bn = NULL, *g_bn = NULL;
603 BIGNUM *N_bn_alloc = NULL, *g_bn_alloc = NULL, *s = NULL, *v = NULL;
604 unsigned char tmp[MAX_LEN];
605 unsigned char tmp2[MAX_LEN];
606 char *defgNid = NULL;
609 if ((user == NULL) ||
610 (pass == NULL) || (salt == NULL) || (verifier == NULL))
614 if ((len = t_fromb64(tmp, sizeof(tmp), N)) <= 0)
616 N_bn_alloc = BN_bin2bn(tmp, len, NULL);
618 if ((len = t_fromb64(tmp, sizeof(tmp) ,g)) <= 0)
620 g_bn_alloc = BN_bin2bn(tmp, len, NULL);
624 SRP_gN *gN = SRP_get_default_gN(g);
633 if (RAND_bytes(tmp2, SRP_RANDOM_SALT_LEN) <= 0)
636 s = BN_bin2bn(tmp2, SRP_RANDOM_SALT_LEN, NULL);
638 if ((len = t_fromb64(tmp2, sizeof(tmp2), *salt)) <= 0)
640 s = BN_bin2bn(tmp2, len, NULL);
643 if (!SRP_create_verifier_BN(user, pass, &s, &v, N_bn, g_bn))
647 vfsize = BN_num_bytes(v) * 2;
648 if (((vf = OPENSSL_malloc(vfsize)) == NULL))
650 t_tob64(vf, tmp, BN_num_bytes(v));
655 if ((tmp_salt = OPENSSL_malloc(SRP_RANDOM_SALT_LEN * 2)) == NULL) {
658 t_tob64(tmp_salt, tmp2, SRP_RANDOM_SALT_LEN);
669 OPENSSL_clear_free(vf, vfsize);
676 * create a verifier (*salt,*verifier,g and N are BIGNUMs). If *salt != NULL
677 * then the provided salt will be used. On successful exit *verifier will point
678 * to a newly allocated BIGNUM containing the verifier and (if a salt was not
679 * provided) *salt will be populated with a newly allocated BIGNUM containing a
681 * The caller is responsible for freeing the allocated *salt and *verifier
684 int SRP_create_verifier_BN(const char *user, const char *pass, BIGNUM **salt,
685 BIGNUM **verifier, const BIGNUM *N,
690 BN_CTX *bn_ctx = BN_CTX_new();
691 unsigned char tmp2[MAX_LEN];
692 BIGNUM *salttmp = NULL;
694 if ((user == NULL) ||
697 (verifier == NULL) || (N == NULL) || (g == NULL) || (bn_ctx == NULL))
701 if (RAND_bytes(tmp2, SRP_RANDOM_SALT_LEN) <= 0)
704 salttmp = BN_bin2bn(tmp2, SRP_RANDOM_SALT_LEN, NULL);
709 x = SRP_Calc_x(salttmp, user, pass);
711 *verifier = BN_new();
712 if (*verifier == NULL)
715 if (!BN_mod_exp(*verifier, g, x, N, bn_ctx)) {
716 BN_clear_free(*verifier);
724 if (salt != NULL && *salt != salttmp)
725 BN_clear_free(salttmp);