1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
|
/*
* Copyright (C) 2005-2012 Free Software Foundation, Inc.
*
* Author: Nikos Mavrogiannopoulos
*
* This file is part of GnuTLS.
*
* The GnuTLS is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>
*
*/
/* Functions for manipulating the PSK credentials. */
#include "gnutls_int.h"
#include "errors.h"
#include "str.h"
#include "auth/psk.h"
#include "state.h"
#ifdef ENABLE_PSK
#include "auth/psk_passwd.h"
#include "num.h"
#include "file.h"
#include "datum.h"
#include "debug.h"
#include "dh.h"
/**
* gnutls_psk_free_client_credentials:
* @sc: is a #gnutls_psk_client_credentials_t type.
*
* Free a gnutls_psk_client_credentials_t structure.
**/
void gnutls_psk_free_client_credentials(gnutls_psk_client_credentials_t sc)
{
_gnutls_free_datum(&sc->username);
_gnutls_free_datum(&sc->key);
gnutls_free(sc);
}
/**
* gnutls_psk_allocate_client_credentials:
* @sc: is a pointer to a #gnutls_psk_client_credentials_t type.
*
* Allocate a gnutls_psk_client_credentials_t structure.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
* an error code is returned.
**/
int gnutls_psk_allocate_client_credentials(gnutls_psk_client_credentials_t *sc)
{
/* TLS 1.3 - Default binder HMAC algorithm is SHA-256 */
return gnutls_psk_allocate_client_credentials2(sc, GNUTLS_MAC_SHA256);
}
/**
* gnutls_psk_allocate_client_credentials2:
* @sc: is a pointer to a #gnutls_psk_client_credentials_t type.
* @mac: encryption algorithm to use
*
* Allocate a gnutls_psk_client_credentials_t structure and initializes
* the HMAC binder algorithm to @mac.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
* an error code is returned.
**/
int gnutls_psk_allocate_client_credentials2(gnutls_psk_client_credentials_t *sc,
gnutls_mac_algorithm_t mac)
{
/* TLS 1.3 - Only SHA-256 and SHA-384 are allowed */
if (mac != GNUTLS_MAC_SHA256 && mac != GNUTLS_MAC_SHA384)
return gnutls_assert_val(GNUTLS_E_INVALID_REQUEST);
*sc = gnutls_calloc(1, sizeof(psk_client_credentials_st));
if (*sc == NULL)
return GNUTLS_E_MEMORY_ERROR;
(*sc)->binder_algo = _gnutls_mac_to_entry(mac);
return 0;
}
/**
* gnutls_psk_set_client_credentials:
* @res: is a #gnutls_psk_client_credentials_t type.
* @username: is the user's zero-terminated userid
* @key: is the user's key
* @flags: indicate the format of the key, either
* %GNUTLS_PSK_KEY_RAW or %GNUTLS_PSK_KEY_HEX.
*
* This function sets the username and password, in a
* gnutls_psk_client_credentials_t type. Those will be used in
* PSK authentication. @username should be an ASCII string or UTF-8
* string. In case of a UTF-8 string it is recommended to be following
* the PRECIS framework for usernames (rfc8265). The key can be either
* in raw byte format or in Hex format (without the 0x prefix).
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
* an error code is returned.
**/
int gnutls_psk_set_client_credentials(gnutls_psk_client_credentials_t res,
const char *username,
const gnutls_datum_t *key,
gnutls_psk_key_flags flags)
{
gnutls_datum_t dat;
if (username == NULL)
return gnutls_assert_val(GNUTLS_E_INVALID_REQUEST);
dat.data = (unsigned char *)username;
dat.size = strlen(username);
return gnutls_psk_set_client_credentials2(res, &dat, key, flags);
}
/**
* gnutls_psk_set_client_credentials2:
* @res: is a #gnutls_psk_client_credentials_t type.
* @username: is the userid
* @key: is the user's key
* @flags: indicate the format of the key, either
* %GNUTLS_PSK_KEY_RAW or %GNUTLS_PSK_KEY_HEX.
*
* This function is identical to gnutls_psk_set_client_credentials(),
* except that it allows a non-null-terminated username to be introduced.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
* an error code is returned.
*/
int gnutls_psk_set_client_credentials2(gnutls_psk_client_credentials_t res,
const gnutls_datum_t *username,
const gnutls_datum_t *key,
gnutls_psk_key_flags flags)
{
int ret;
if (username == NULL || username->data == NULL || key == NULL ||
key->data == NULL) {
gnutls_assert();
return GNUTLS_E_INVALID_REQUEST;
}
ret = _gnutls_set_datum(&res->username, username->data, username->size);
if (ret < 0)
return ret;
if (flags == GNUTLS_PSK_KEY_RAW) {
if (_gnutls_set_datum(&res->key, key->data, key->size) < 0) {
gnutls_assert();
ret = GNUTLS_E_MEMORY_ERROR;
goto error;
}
} else { /* HEX key */
size_t size;
size = res->key.size = key->size / 2;
res->key.data = gnutls_malloc(size);
if (res->key.data == NULL) {
gnutls_assert();
ret = GNUTLS_E_MEMORY_ERROR;
goto error;
}
ret = gnutls_hex_decode(key, (char *)res->key.data, &size);
res->key.size = (unsigned int)size;
if (ret < 0) {
gnutls_assert();
goto error;
}
if (size < 4) {
gnutls_assert();
ret = GNUTLS_E_INVALID_REQUEST;
goto error;
}
}
return 0;
error:
_gnutls_free_datum(&res->username);
_gnutls_free_datum(&res->key);
return ret;
}
/**
* gnutls_psk_free_server_credentials:
* @sc: is a #gnutls_psk_server_credentials_t type.
*
* Free a gnutls_psk_server_credentials_t structure.
**/
void gnutls_psk_free_server_credentials(gnutls_psk_server_credentials_t sc)
{
if (sc->deinit_dh_params) {
gnutls_dh_params_deinit(sc->dh_params);
}
gnutls_free(sc->password_file);
gnutls_free(sc->hint);
gnutls_free(sc);
}
/**
* gnutls_psk_allocate_server_credentials:
* @sc: is a pointer to a #gnutls_psk_server_credentials_t type.
*
* Allocate a gnutls_psk_server_credentials_t structure.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
* an error code is returned.
**/
int gnutls_psk_allocate_server_credentials(gnutls_psk_server_credentials_t *sc)
{
/* TLS 1.3 - Default binder HMAC algorithm is SHA-256 */
return gnutls_psk_allocate_server_credentials2(sc, GNUTLS_MAC_SHA256);
}
/**
* gnutls_psk_allocate_server_credentials2:
* @sc: is a pointer to a #gnutls_psk_server_credentials_t type.
* @mac: encryption algorithm to use
*
* Allocate a gnutls_psk_server_credentials_t structure and initializes
* the HMAC binder algorithm to @mac. If @mac is set to GNUTLS_MAC_UNKNOWN
* both possible algorithms SHA384 and SHA256 are applied to find a matching
* binder value.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
* an error code is returned.
**/
int gnutls_psk_allocate_server_credentials2(gnutls_psk_server_credentials_t *sc,
gnutls_mac_algorithm_t mac)
{
/*
* TLS 1.3 - Only SHA-256 and SHA-384 are allowed;
* additionally allow GNUTLS_MAC_UNKNOWN for autodetection.
*/
if (mac != GNUTLS_MAC_SHA256 && mac != GNUTLS_MAC_SHA384 &&
mac != GNUTLS_MAC_UNKNOWN)
return gnutls_assert_val(GNUTLS_E_INVALID_REQUEST);
*sc = gnutls_calloc(1, sizeof(psk_server_cred_st));
if (*sc == NULL)
return GNUTLS_E_MEMORY_ERROR;
/*
* For GNUTLS_MAC_UNKNOWN, setting binder_algo to NULL allows
* for auto-detction.
*/
(*sc)->binder_algo =
(mac == GNUTLS_MAC_UNKNOWN ? NULL : _gnutls_mac_to_entry(mac));
return 0;
}
/**
* gnutls_psk_set_server_credentials_file:
* @res: is a #gnutls_psk_server_credentials_t type.
* @password_file: is the PSK password file (passwd.psk)
*
* This function sets the password file, in a
* #gnutls_psk_server_credentials_t type. This password file
* holds usernames and keys and will be used for PSK authentication.
*
* Each entry in the file consists of a username, followed by a colon
* (':') and a hex-encoded key. If the username contains a colon or
* any other special character, it can be hex-encoded preceded by a
* '#'.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
* an error code is returned.
**/
int gnutls_psk_set_server_credentials_file(gnutls_psk_server_credentials_t res,
const char *password_file)
{
if (password_file == NULL) {
gnutls_assert();
return GNUTLS_E_INVALID_REQUEST;
}
/* Check if the files can be opened */
if (_gnutls_file_exists(password_file) != 0) {
gnutls_assert();
return GNUTLS_E_FILE_ERROR;
}
res->password_file = gnutls_strdup(password_file);
if (res->password_file == NULL) {
gnutls_assert();
return GNUTLS_E_MEMORY_ERROR;
}
return 0;
}
/**
* gnutls_psk_set_server_credentials_hint:
* @res: is a #gnutls_psk_server_credentials_t type.
* @hint: is the PSK identity hint string
*
* This function sets the identity hint, in a
* #gnutls_psk_server_credentials_t type. This hint is sent to
* the client to help it chose a good PSK credential (i.e., username
* and password).
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
* an error code is returned.
*
* Since: 2.4.0
**/
int gnutls_psk_set_server_credentials_hint(gnutls_psk_server_credentials_t res,
const char *hint)
{
res->hint = gnutls_strdup(hint);
if (res->hint == NULL) {
gnutls_assert();
return GNUTLS_E_MEMORY_ERROR;
}
return 0;
}
static int call_server_callback1(gnutls_session_t session,
const gnutls_datum_t *username,
gnutls_datum_t *key)
{
gnutls_psk_server_credentials_t cred =
(gnutls_psk_server_credentials_t)_gnutls_get_cred(
session, GNUTLS_CRD_PSK);
if (unlikely(cred == NULL))
return gnutls_assert_val(-1);
return cred->pwd_callback1(session, (const char *)username->data, key);
}
static int call_server_callback2(gnutls_session_t session,
const gnutls_datum_t *username,
gnutls_datum_t *key,
gnutls_psk_key_flags *flags)
{
gnutls_psk_server_credentials_t cred;
int ret;
cred = (gnutls_psk_server_credentials_t)_gnutls_get_cred(
session, GNUTLS_CRD_PSK);
if (unlikely(cred == NULL))
return gnutls_assert_val(-1);
ret = cred->pwd_callback2(session, username, key);
if (ret >= 0) {
if (flags) {
*flags = 0;
}
}
return ret;
}
/**
* gnutls_psk_set_server_credentials_function:
* @cred: is a #gnutls_psk_server_credentials_t type.
* @func: is the callback function
*
* This function can be used to set a callback to retrieve the user's PSK credentials.
* The callback's function form is:
* int (*callback)(gnutls_session_t, const char* username,
* gnutls_datum_t* key);
*
* @username contains the actual username.
* The @key must be filled in using the gnutls_malloc().
*
* In case the callback returned a negative number then gnutls will
* assume that the username does not exist.
*
* The callback function will only be called once per handshake. The
* callback function should return 0 on success, while -1 indicates
* an error.
**/
void gnutls_psk_set_server_credentials_function(
gnutls_psk_server_credentials_t cred,
gnutls_psk_server_credentials_function *func)
{
cred->pwd_callback1 = func;
cred->pwd_callback2 = call_server_callback1;
cred->pwd_callback = call_server_callback2;
}
/**
* gnutls_psk_set_server_credentials_function2:
* @cred: is a #gnutls_psk_server_credentials_t type.
* @func: is the callback function
*
* This function can be used to set a callback to retrieve the user's PSK credentials.
* The callback's function form is:
* int (*callback)(gnutls_session_t, const gnutls_datum_t* username,
* gnutls_datum_t* key);
*
* This callback function has the same semantics as that of gnutls_psk_set_server_credentials_function(),
* but it allows non-string usernames to be used.
*
* @username contains the actual username.
* The @key must be filled in using the gnutls_malloc().
*
* In case the callback returned a negative number then gnutls will
* assume that the username does not exist.
*
* The callback function will only be called once per handshake. The
* callback function should return 0 on success, while -1 indicates
* an error.
**/
void gnutls_psk_set_server_credentials_function2(
gnutls_psk_server_credentials_t cred,
gnutls_psk_server_credentials_function2 func)
{
cred->pwd_callback1 = NULL;
cred->pwd_callback2 = func;
cred->pwd_callback = call_server_callback2;
}
/**
* gnutls_psk_set_server_credentials_function3:
* @cred: is a #gnutls_psk_server_credentials_t type.
* @func: is the callback function
*
* This function can be used to set a callback to retrieve the user's PSK credentials.
* The callback's function form is:
* int (*callback)(gnutls_session_t, const gnutls_datum_t* username,
* gnutls_datum_t* key, gnutls_psk_key_flags *flags);
*
* This callback function has the same semantics as that of
* gnutls_psk_set_server_credentials_function2(), but it returns flags
* associated with the key. The callback may import external PSK
* using the method described in RFC 9258 by using
* gnutls_psk_format_imported_identity().
*
* @username contains the actual username.
* The @key must be filled in using the gnutls_malloc().
*
* In case the callback returned a negative number then gnutls will
* assume that the username does not exist.
*
* The callback function will only be called once per handshake. The
* callback function should return 0 on success, while -1 indicates
* an error.
**/
void gnutls_psk_set_server_credentials_function3(
gnutls_psk_server_credentials_t cred,
gnutls_psk_server_credentials_function3 func)
{
cred->pwd_callback1 = NULL;
cred->pwd_callback2 = NULL;
cred->pwd_callback = func;
}
static int call_client_callback1(gnutls_session_t session,
gnutls_datum_t *username, gnutls_datum_t *key)
{
gnutls_psk_client_credentials_t cred;
int ret;
char *user_p;
cred = (gnutls_psk_client_credentials_t)_gnutls_get_cred(
session, GNUTLS_CRD_PSK);
if (unlikely(cred == NULL))
return gnutls_assert_val(-1);
ret = cred->get_function1(session, &user_p, key);
if (ret >= 0) {
username->data = (uint8_t *)user_p;
username->size = strlen(user_p);
}
return ret;
}
static int call_client_callback2(gnutls_session_t session,
gnutls_datum_t *username, gnutls_datum_t *key,
gnutls_psk_key_flags *flags)
{
gnutls_psk_client_credentials_t cred;
int ret;
cred = (gnutls_psk_client_credentials_t)_gnutls_get_cred(
session, GNUTLS_CRD_PSK);
if (unlikely(cred == NULL))
return gnutls_assert_val(-1);
ret = cred->get_function2(session, username, key);
if (ret < 0) {
return ret;
}
if (flags) {
*flags = 0;
}
return ret;
}
/**
* gnutls_psk_set_client_credentials_function:
* @cred: is a #gnutls_psk_server_credentials_t type.
* @func: is the callback function
*
* This function can be used to set a callback to retrieve the username and
* password for client PSK authentication.
* The callback's function form is:
* int (*callback)(gnutls_session_t, char** username,
* gnutls_datum_t* key);
*
* The @username and @key->data must be allocated using gnutls_malloc().
* The @username should be an ASCII string or UTF-8
* string. In case of a UTF-8 string it is recommended to be following
* the PRECIS framework for usernames (rfc8265).
*
* The callback function will be called once per handshake.
*
* The callback function should return 0 on success.
* -1 indicates an error.
**/
void gnutls_psk_set_client_credentials_function(
gnutls_psk_client_credentials_t cred,
gnutls_psk_client_credentials_function *func)
{
cred->get_function1 = func;
cred->get_function2 = call_client_callback1;
cred->get_function = call_client_callback2;
}
/**
* gnutls_psk_set_client_credentials_function2:
* @cred: is a #gnutls_psk_server_credentials_t type.
* @func: is the callback function
*
* This function can be used to set a callback to retrieve the username and
* password for client PSK authentication.
* The callback's function form is:
* int (*callback)(gnutls_session_t, gnutls_datum_t* username,
* gnutls_datum_t* key);
*
* This callback function has the same semantics as that of gnutls_psk_set_client_credentials_function(),
* but it allows non-string usernames to be used.
*
* The @username and @key->data must be allocated using gnutls_malloc().
* The @username should be an ASCII string or UTF-8
* string. In case of a UTF-8 string it is recommended to be following
* the PRECIS framework for usernames (rfc8265).
*
* The callback function will be called once per handshake.
*
* The callback function should return 0 on success.
* -1 indicates an error.
**/
void gnutls_psk_set_client_credentials_function2(
gnutls_psk_client_credentials_t cred,
gnutls_psk_client_credentials_function2 *func)
{
cred->get_function1 = NULL;
cred->get_function2 = func;
cred->get_function = call_client_callback2;
}
/**
* gnutls_psk_set_client_credentials_function3:
* @cred: is a #gnutls_psk_server_credentials_t type.
* @func: is the callback function
*
* This function can be used to set a callback to retrieve the username and
* password for client PSK authentication.
* The callback's function form is:
* int (*callback)(gnutls_session_t, gnutls_datum_t* username,
* gnutls_datum_t* key, gnutls_datum_t* context, gnutls_psk_key_flags *flags);
*
* This callback function has the same semantics as that of
* gnutls_psk_set_client_credentials_function2(), but it returns flags
* associated with the key. The callback may import external PSK
* using the method described in RFC 9258 by using
* gnutls_psk_format_imported_identity().
*
* The data field of @username, @key, and @context must be allocated
* using gnutls_malloc(). The @username should be an ASCII string or
* UTF-8 string. In case of a UTF-8 string it is recommended to be
* following the PRECIS framework for usernames (rfc8265).
*
* The callback function will be called once per handshake.
*
* The callback function should return 0 on success.
* -1 indicates an error.
**/
void gnutls_psk_set_client_credentials_function3(
gnutls_psk_client_credentials_t cred,
gnutls_psk_client_credentials_function3 *func)
{
cred->get_function1 = NULL;
cred->get_function2 = NULL;
cred->get_function = func;
}
/**
* gnutls_psk_server_get_username:
* @session: is a gnutls session
*
* This should only be called in case of PSK authentication and in
* case of a server.
*
* The returned pointer should be considered constant (do not free) and valid
* for the lifetime of the session.
*
* This function will return %NULL if the username has embedded NULL bytes.
* In that case, gnutls_psk_server_get_username2() should be used to retrieve the username.
*
* Returns: the username of the peer, or %NULL in case of an error,
* or if the username has embedded NULLs.
**/
const char *gnutls_psk_server_get_username(gnutls_session_t session)
{
psk_auth_info_t info;
CHECK_AUTH_TYPE(GNUTLS_CRD_PSK, NULL);
info = _gnutls_get_auth_info(session, GNUTLS_CRD_PSK);
if (info == NULL)
return NULL;
if (info->username && !memchr(info->username, '\0', info->username_len))
return info->username;
return NULL;
}
/**
* gnutls_psk_server_get_username2:
* @session: is a gnutls session
* @username: a datum that will be filled in by this function
*
* Return a pointer to the username of the peer in the supplied datum. Does not
* need to be null-terminated.
*
* This should only be called in case of PSK authentication and in
* case of a server.
*
* The returned pointer should be considered constant (do not free) and valid
* for the lifetime of the session.
*
* Returns: %GNUTLS_E_SUCCESS, or a negative value in case of an error.
**/
int gnutls_psk_server_get_username2(gnutls_session_t session,
gnutls_datum_t *username)
{
psk_auth_info_t info;
CHECK_AUTH_TYPE(GNUTLS_CRD_PSK, GNUTLS_E_INVALID_REQUEST);
info = _gnutls_get_auth_info(session, GNUTLS_CRD_PSK);
if (info == NULL)
return GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE;
if (info->username_len > 0) {
username->data = (unsigned char *)info->username;
username->size = info->username_len;
return 0;
}
return GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE;
}
/**
* gnutls_psk_client_get_hint:
* @session: is a gnutls session
*
* The PSK identity hint may give the client help in deciding which
* username to use. This should only be called in case of PSK
* authentication and in case of a client.
*
* Note: there is no hint in TLS 1.3, so this function will return %NULL
* if TLS 1.3 has been negotiated.
*
* Returns: the identity hint of the peer, or %NULL in case of an error or if TLS 1.3 is being used.
*
* Since: 2.4.0
**/
const char *gnutls_psk_client_get_hint(gnutls_session_t session)
{
psk_auth_info_t info;
CHECK_AUTH_TYPE(GNUTLS_CRD_PSK, NULL);
info = _gnutls_get_auth_info(session, GNUTLS_CRD_PSK);
return info ? info->hint : NULL;
}
/**
* gnutls_psk_set_server_dh_params:
* @res: is a gnutls_psk_server_credentials_t type
* @dh_params: is a structure that holds Diffie-Hellman parameters.
*
* This function will set the Diffie-Hellman parameters for an
* anonymous server to use. These parameters will be used in
* Diffie-Hellman exchange with PSK cipher suites.
*
* Deprecated: This function is unnecessary and discouraged on GnuTLS 3.6.0
* or later. Since 3.6.0, DH parameters are negotiated
* following RFC7919.
*
**/
void gnutls_psk_set_server_dh_params(gnutls_psk_server_credentials_t res,
gnutls_dh_params_t dh_params)
{
if (res->deinit_dh_params) {
res->deinit_dh_params = 0;
gnutls_dh_params_deinit(res->dh_params);
res->dh_params = NULL;
}
res->dh_params = dh_params;
res->dh_sec_param = gnutls_pk_bits_to_sec_param(
GNUTLS_PK_DH, _gnutls_mpi_get_nbits(dh_params->params[0]));
}
/**
* gnutls_psk_set_server_known_dh_params:
* @res: is a gnutls_psk_server_credentials_t type
* @sec_param: is an option of the %gnutls_sec_param_t enumeration
*
* This function will set the Diffie-Hellman parameters for a
* PSK server to use. These parameters will be used in
* Ephemeral Diffie-Hellman cipher suites and will be selected from
* the FFDHE set of RFC7919 according to the security level provided.
*
* Deprecated: This function is unnecessary and discouraged on GnuTLS 3.6.0
* or later. Since 3.6.0, DH parameters are negotiated
* following RFC7919.
*
* Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a
* negative error value.
*
* Since: 3.5.6
**/
int gnutls_psk_set_server_known_dh_params(gnutls_psk_server_credentials_t res,
gnutls_sec_param_t sec_param)
{
res->dh_sec_param = sec_param;
return 0;
}
/**
* gnutls_psk_set_server_params_function:
* @res: is a #gnutls_certificate_credentials_t type
* @func: is the function to be called
*
* This function will set a callback in order for the server to get
* the Diffie-Hellman parameters for PSK authentication. The callback
* should return %GNUTLS_E_SUCCESS (0) on success.
*
* Deprecated: This function is unnecessary and discouraged on GnuTLS 3.6.0
* or later. Since 3.6.0, DH parameters are negotiated
* following RFC7919.
*
**/
void gnutls_psk_set_server_params_function(gnutls_psk_server_credentials_t res,
gnutls_params_function *func)
{
res->params_func = func;
}
/**
* gnutls_psk_set_params_function:
* @res: is a gnutls_psk_server_credentials_t type
* @func: is the function to be called
*
* This function will set a callback in order for the server to get
* the Diffie-Hellman or RSA parameters for PSK authentication. The
* callback should return %GNUTLS_E_SUCCESS (0) on success.
*
* Deprecated: This function is unnecessary and discouraged on GnuTLS 3.6.0
* or later. Since 3.6.0, DH parameters are negotiated
* following RFC7919.
*
**/
void gnutls_psk_set_params_function(gnutls_psk_server_credentials_t res,
gnutls_params_function *func)
{
res->params_func = func;
}
#endif /* ENABLE_PSK */
|