2 * Copyright 2004-2021 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2004, EdelKey Project. All Rights Reserved.
5 * Licensed under the Apache License 2.0 (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.
15 * We need to use the SRP deprecated APIs in order to implement the SSL SRP
16 * APIs - which are themselves deprecated.
18 #define OPENSSL_SUPPRESS_DEPRECATED
20 #include <openssl/crypto.h>
21 #include <openssl/rand.h>
22 #include <openssl/err.h>
23 #include "ssl_local.h"
25 #ifndef OPENSSL_NO_SRP
26 # include <openssl/srp.h>
29 * The public API SSL_CTX_SRP_CTX_free() is deprecated so we use
30 * ssl_ctx_srp_ctx_free_intern() internally.
32 int ssl_ctx_srp_ctx_free_intern(SSL_CTX *ctx)
36 OPENSSL_free(ctx->srp_ctx.login);
37 OPENSSL_free(ctx->srp_ctx.info);
38 BN_free(ctx->srp_ctx.N);
39 BN_free(ctx->srp_ctx.g);
40 BN_free(ctx->srp_ctx.s);
41 BN_free(ctx->srp_ctx.B);
42 BN_free(ctx->srp_ctx.A);
43 BN_free(ctx->srp_ctx.a);
44 BN_free(ctx->srp_ctx.b);
45 BN_free(ctx->srp_ctx.v);
46 memset(&ctx->srp_ctx, 0, sizeof(ctx->srp_ctx));
47 ctx->srp_ctx.strength = SRP_MINIMAL_N;
51 int SSL_CTX_SRP_CTX_free(SSL_CTX *ctx)
53 return ssl_ctx_srp_ctx_free_intern(ctx);
57 * The public API SSL_SRP_CTX_free() is deprecated so we use
58 * ssl_srp_ctx_free_intern() internally.
60 int ssl_srp_ctx_free_intern(SSL_CONNECTION *s)
64 OPENSSL_free(s->srp_ctx.login);
65 OPENSSL_free(s->srp_ctx.info);
66 BN_free(s->srp_ctx.N);
67 BN_free(s->srp_ctx.g);
68 BN_free(s->srp_ctx.s);
69 BN_free(s->srp_ctx.B);
70 BN_free(s->srp_ctx.A);
71 BN_free(s->srp_ctx.a);
72 BN_free(s->srp_ctx.b);
73 BN_free(s->srp_ctx.v);
74 memset(&s->srp_ctx, 0, sizeof(s->srp_ctx));
75 s->srp_ctx.strength = SRP_MINIMAL_N;
79 int SSL_SRP_CTX_free(SSL *s)
81 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
83 /* the call works with NULL sc */
84 return ssl_srp_ctx_free_intern(sc);
88 * The public API SSL_SRP_CTX_init() is deprecated so we use
89 * ssl_srp_ctx_init_intern() internally.
91 int ssl_srp_ctx_init_intern(SSL_CONNECTION *s)
95 if (s == NULL || (ctx = SSL_CONNECTION_GET_CTX(s)) == NULL)
98 memset(&s->srp_ctx, 0, sizeof(s->srp_ctx));
100 s->srp_ctx.SRP_cb_arg = ctx->srp_ctx.SRP_cb_arg;
101 /* set client Hello login callback */
102 s->srp_ctx.TLS_ext_srp_username_callback =
103 ctx->srp_ctx.TLS_ext_srp_username_callback;
104 /* set SRP N/g param callback for verification */
105 s->srp_ctx.SRP_verify_param_callback =
106 ctx->srp_ctx.SRP_verify_param_callback;
107 /* set SRP client passwd callback */
108 s->srp_ctx.SRP_give_srp_client_pwd_callback =
109 ctx->srp_ctx.SRP_give_srp_client_pwd_callback;
111 s->srp_ctx.strength = ctx->srp_ctx.strength;
113 if (((ctx->srp_ctx.N != NULL) &&
114 ((s->srp_ctx.N = BN_dup(ctx->srp_ctx.N)) == NULL)) ||
115 ((ctx->srp_ctx.g != NULL) &&
116 ((s->srp_ctx.g = BN_dup(ctx->srp_ctx.g)) == NULL)) ||
117 ((ctx->srp_ctx.s != NULL) &&
118 ((s->srp_ctx.s = BN_dup(ctx->srp_ctx.s)) == NULL)) ||
119 ((ctx->srp_ctx.B != NULL) &&
120 ((s->srp_ctx.B = BN_dup(ctx->srp_ctx.B)) == NULL)) ||
121 ((ctx->srp_ctx.A != NULL) &&
122 ((s->srp_ctx.A = BN_dup(ctx->srp_ctx.A)) == NULL)) ||
123 ((ctx->srp_ctx.a != NULL) &&
124 ((s->srp_ctx.a = BN_dup(ctx->srp_ctx.a)) == NULL)) ||
125 ((ctx->srp_ctx.v != NULL) &&
126 ((s->srp_ctx.v = BN_dup(ctx->srp_ctx.v)) == NULL)) ||
127 ((ctx->srp_ctx.b != NULL) &&
128 ((s->srp_ctx.b = BN_dup(ctx->srp_ctx.b)) == NULL))) {
129 ERR_raise(ERR_LIB_SSL, ERR_R_BN_LIB);
132 if ((ctx->srp_ctx.login != NULL) &&
133 ((s->srp_ctx.login = OPENSSL_strdup(ctx->srp_ctx.login)) == NULL)) {
134 ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
137 if ((ctx->srp_ctx.info != NULL) &&
138 ((s->srp_ctx.info = OPENSSL_strdup(ctx->srp_ctx.info)) == NULL)) {
139 ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
142 s->srp_ctx.srp_Mask = ctx->srp_ctx.srp_Mask;
146 OPENSSL_free(s->srp_ctx.login);
147 OPENSSL_free(s->srp_ctx.info);
148 BN_free(s->srp_ctx.N);
149 BN_free(s->srp_ctx.g);
150 BN_free(s->srp_ctx.s);
151 BN_free(s->srp_ctx.B);
152 BN_free(s->srp_ctx.A);
153 BN_free(s->srp_ctx.a);
154 BN_free(s->srp_ctx.b);
155 BN_free(s->srp_ctx.v);
156 memset(&s->srp_ctx, 0, sizeof(s->srp_ctx));
160 int SSL_SRP_CTX_init(SSL *s)
162 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
164 /* the call works with NULL sc */
165 return ssl_srp_ctx_init_intern(sc);
169 * The public API SSL_CTX_SRP_CTX_init() is deprecated so we use
170 * ssl_ctx_srp_ctx_init_intern() internally.
172 int ssl_ctx_srp_ctx_init_intern(SSL_CTX *ctx)
177 memset(&ctx->srp_ctx, 0, sizeof(ctx->srp_ctx));
178 ctx->srp_ctx.strength = SRP_MINIMAL_N;
183 int SSL_CTX_SRP_CTX_init(SSL_CTX *ctx)
185 return ssl_ctx_srp_ctx_init_intern(ctx);
190 * The public API SSL_srp_server_param_with_username() is deprecated so we use
191 * ssl_srp_server_param_with_username_intern() internally.
193 int ssl_srp_server_param_with_username_intern(SSL_CONNECTION *s, int *ad)
195 unsigned char b[SSL_MAX_MASTER_KEY_LENGTH];
197 SSL_CTX *sctx = SSL_CONNECTION_GET_CTX(s);
199 *ad = SSL_AD_UNKNOWN_PSK_IDENTITY;
200 if ((s->srp_ctx.TLS_ext_srp_username_callback != NULL) &&
202 s->srp_ctx.TLS_ext_srp_username_callback(SSL_CONNECTION_GET_SSL(s),
204 s->srp_ctx.SRP_cb_arg)) !=
208 *ad = SSL_AD_INTERNAL_ERROR;
209 if ((s->srp_ctx.N == NULL) ||
210 (s->srp_ctx.g == NULL) ||
211 (s->srp_ctx.s == NULL) || (s->srp_ctx.v == NULL))
212 return SSL3_AL_FATAL;
214 if (RAND_priv_bytes_ex(SSL_CONNECTION_GET_CTX(s)->libctx, b, sizeof(b),
216 return SSL3_AL_FATAL;
217 s->srp_ctx.b = BN_bin2bn(b, sizeof(b), NULL);
218 OPENSSL_cleanse(b, sizeof(b));
220 /* Calculate: B = (kv + g^b) % N */
222 return ((s->srp_ctx.B =
223 SRP_Calc_B_ex(s->srp_ctx.b, s->srp_ctx.N, s->srp_ctx.g,
224 s->srp_ctx.v, sctx->libctx, sctx->propq)) !=
225 NULL) ? SSL_ERROR_NONE : SSL3_AL_FATAL;
228 int SSL_srp_server_param_with_username(SSL *s, int *ad)
230 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
233 return SSL3_AL_FATAL;
235 return ssl_srp_server_param_with_username_intern(sc, ad);
239 * If the server just has the raw password, make up a verifier entry on the
242 int SSL_set_srp_server_param_pw(SSL *s, const char *user, const char *pass,
246 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
251 GN = SRP_get_default_gN(grp);
254 sc->srp_ctx.N = BN_dup(GN->N);
255 sc->srp_ctx.g = BN_dup(GN->g);
256 BN_clear_free(sc->srp_ctx.v);
257 sc->srp_ctx.v = NULL;
258 BN_clear_free(sc->srp_ctx.s);
259 sc->srp_ctx.s = NULL;
260 if (!SRP_create_verifier_BN_ex(user, pass, &sc->srp_ctx.s, &sc->srp_ctx.v,
261 sc->srp_ctx.N, sc->srp_ctx.g, s->ctx->libctx,
268 int SSL_set_srp_server_param(SSL *s, const BIGNUM *N, const BIGNUM *g,
269 BIGNUM *sa, BIGNUM *v, char *info)
271 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
277 if (sc->srp_ctx.N != NULL) {
278 if (!BN_copy(sc->srp_ctx.N, N)) {
279 BN_free(sc->srp_ctx.N);
280 sc->srp_ctx.N = NULL;
283 sc->srp_ctx.N = BN_dup(N);
286 if (sc->srp_ctx.g != NULL) {
287 if (!BN_copy(sc->srp_ctx.g, g)) {
288 BN_free(sc->srp_ctx.g);
289 sc->srp_ctx.g = NULL;
292 sc->srp_ctx.g = BN_dup(g);
295 if (sc->srp_ctx.s != NULL) {
296 if (!BN_copy(sc->srp_ctx.s, sa)) {
297 BN_free(sc->srp_ctx.s);
298 sc->srp_ctx.s = NULL;
301 sc->srp_ctx.s = BN_dup(sa);
304 if (sc->srp_ctx.v != NULL) {
305 if (!BN_copy(sc->srp_ctx.v, v)) {
306 BN_free(sc->srp_ctx.v);
307 sc->srp_ctx.v = NULL;
310 sc->srp_ctx.v = BN_dup(v);
313 if (sc->srp_ctx.info)
314 OPENSSL_free(sc->srp_ctx.info);
315 if ((sc->srp_ctx.info = OPENSSL_strdup(info)) == NULL)
319 if (!(sc->srp_ctx.N) ||
320 !(sc->srp_ctx.g) || !(sc->srp_ctx.s) || !(sc->srp_ctx.v))
326 int srp_generate_server_master_secret(SSL_CONNECTION *s)
328 BIGNUM *K = NULL, *u = NULL;
329 int ret = 0, tmp_len = 0;
330 unsigned char *tmp = NULL;
331 SSL_CTX *sctx = SSL_CONNECTION_GET_CTX(s);
333 if (!SRP_Verify_A_mod_N(s->srp_ctx.A, s->srp_ctx.N))
335 if ((u = SRP_Calc_u_ex(s->srp_ctx.A, s->srp_ctx.B, s->srp_ctx.N,
336 sctx->libctx, sctx->propq)) == NULL)
338 if ((K = SRP_Calc_server_key(s->srp_ctx.A, s->srp_ctx.v, u, s->srp_ctx.b,
339 s->srp_ctx.N)) == NULL)
342 tmp_len = BN_num_bytes(K);
343 if ((tmp = OPENSSL_malloc(tmp_len)) == NULL) {
344 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_CRYPTO_LIB);
348 /* Calls SSLfatal() as required */
349 ret = ssl_generate_master_secret(s, tmp, tmp_len, 1);
357 int srp_generate_client_master_secret(SSL_CONNECTION *s)
359 BIGNUM *x = NULL, *u = NULL, *K = NULL;
360 int ret = 0, tmp_len = 0;
362 unsigned char *tmp = NULL;
363 SSL_CTX *sctx = SSL_CONNECTION_GET_CTX(s);
366 * Checks if b % n == 0
368 if (SRP_Verify_B_mod_N(s->srp_ctx.B, s->srp_ctx.N) == 0
369 || (u = SRP_Calc_u_ex(s->srp_ctx.A, s->srp_ctx.B, s->srp_ctx.N,
370 sctx->libctx, sctx->propq))
372 || s->srp_ctx.SRP_give_srp_client_pwd_callback == NULL) {
373 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
376 if ((passwd = s->srp_ctx.SRP_give_srp_client_pwd_callback(SSL_CONNECTION_GET_SSL(s),
377 s->srp_ctx.SRP_cb_arg))
379 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_R_CALLBACK_FAILED);
382 if ((x = SRP_Calc_x_ex(s->srp_ctx.s, s->srp_ctx.login, passwd,
383 sctx->libctx, sctx->propq)) == NULL
384 || (K = SRP_Calc_client_key_ex(s->srp_ctx.N, s->srp_ctx.B,
388 sctx->propq)) == NULL) {
389 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_INTERNAL_ERROR);
393 tmp_len = BN_num_bytes(K);
394 if ((tmp = OPENSSL_malloc(tmp_len)) == NULL) {
395 SSLfatal(s, SSL_AD_INTERNAL_ERROR, ERR_R_CRYPTO_LIB);
399 /* Calls SSLfatal() as required */
400 ret = ssl_generate_master_secret(s, tmp, tmp_len, 1);
405 OPENSSL_clear_free(passwd, strlen(passwd));
410 int srp_verify_server_param(SSL_CONNECTION *s)
412 SRP_CTX *srp = &s->srp_ctx;
414 * Sanity check parameters: we can quickly check B % N == 0 by checking B
417 if (BN_ucmp(srp->g, srp->N) >= 0 || BN_ucmp(srp->B, srp->N) >= 0
418 || BN_is_zero(srp->B)) {
419 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_R_BAD_DATA);
423 if (BN_num_bits(srp->N) < srp->strength) {
424 SSLfatal(s, SSL_AD_INSUFFICIENT_SECURITY, SSL_R_INSUFFICIENT_SECURITY);
428 if (srp->SRP_verify_param_callback) {
429 if (srp->SRP_verify_param_callback(SSL_CONNECTION_GET_SSL(s),
430 srp->SRP_cb_arg) <= 0) {
431 SSLfatal(s, SSL_AD_INSUFFICIENT_SECURITY, SSL_R_CALLBACK_FAILED);
434 } else if (!SRP_check_known_gN_param(srp->g, srp->N)) {
435 SSLfatal(s, SSL_AD_INSUFFICIENT_SECURITY,
436 SSL_R_INSUFFICIENT_SECURITY);
444 * The public API SRP_Calc_A_param() is deprecated so we use
445 * ssl_srp_calc_a_param_intern() internally.
447 int ssl_srp_calc_a_param_intern(SSL_CONNECTION *s)
449 unsigned char rnd[SSL_MAX_MASTER_KEY_LENGTH];
451 if (RAND_priv_bytes_ex(SSL_CONNECTION_GET_CTX(s)->libctx,
452 rnd, sizeof(rnd), 0) <= 0)
454 s->srp_ctx.a = BN_bin2bn(rnd, sizeof(rnd), s->srp_ctx.a);
455 OPENSSL_cleanse(rnd, sizeof(rnd));
457 if (!(s->srp_ctx.A = SRP_Calc_A(s->srp_ctx.a, s->srp_ctx.N, s->srp_ctx.g)))
463 int SRP_Calc_A_param(SSL *s)
465 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
470 return ssl_srp_calc_a_param_intern(sc);
473 BIGNUM *SSL_get_srp_g(SSL *s)
475 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
480 if (sc->srp_ctx.g != NULL)
481 return sc->srp_ctx.g;
482 return s->ctx->srp_ctx.g;
485 BIGNUM *SSL_get_srp_N(SSL *s)
487 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
492 if (sc->srp_ctx.N != NULL)
493 return sc->srp_ctx.N;
494 return s->ctx->srp_ctx.N;
497 char *SSL_get_srp_username(SSL *s)
499 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
504 if (sc->srp_ctx.login != NULL)
505 return sc->srp_ctx.login;
506 return s->ctx->srp_ctx.login;
509 char *SSL_get_srp_userinfo(SSL *s)
511 SSL_CONNECTION *sc = SSL_CONNECTION_FROM_SSL(s);
516 if (sc->srp_ctx.info != NULL)
517 return sc->srp_ctx.info;
518 return s->ctx->srp_ctx.info;
521 # define tls1_ctx_ctrl ssl3_ctx_ctrl
522 # define tls1_ctx_callback_ctrl ssl3_ctx_callback_ctrl
524 int SSL_CTX_set_srp_username(SSL_CTX *ctx, char *name)
526 return tls1_ctx_ctrl(ctx, SSL_CTRL_SET_TLS_EXT_SRP_USERNAME, 0, name);
529 int SSL_CTX_set_srp_password(SSL_CTX *ctx, char *password)
531 return tls1_ctx_ctrl(ctx, SSL_CTRL_SET_TLS_EXT_SRP_PASSWORD, 0, password);
534 int SSL_CTX_set_srp_strength(SSL_CTX *ctx, int strength)
536 return tls1_ctx_ctrl(ctx, SSL_CTRL_SET_TLS_EXT_SRP_STRENGTH, strength,
540 int SSL_CTX_set_srp_verify_param_callback(SSL_CTX *ctx,
541 int (*cb) (SSL *, void *))
543 return tls1_ctx_callback_ctrl(ctx, SSL_CTRL_SET_SRP_VERIFY_PARAM_CB,
547 int SSL_CTX_set_srp_cb_arg(SSL_CTX *ctx, void *arg)
549 return tls1_ctx_ctrl(ctx, SSL_CTRL_SET_SRP_ARG, 0, arg);
552 int SSL_CTX_set_srp_username_callback(SSL_CTX *ctx,
553 int (*cb) (SSL *, int *, void *))
555 return tls1_ctx_callback_ctrl(ctx, SSL_CTRL_SET_TLS_EXT_SRP_USERNAME_CB,
559 int SSL_CTX_set_srp_client_pwd_callback(SSL_CTX *ctx,
560 char *(*cb) (SSL *, void *))
562 return tls1_ctx_callback_ctrl(ctx, SSL_CTRL_SET_SRP_GIVE_CLIENT_PWD_CB,