@@ -192,11 +192,17 @@ static inline void psa_clear_key_slot_number(
192
192
* \retval #PSA_ERROR_NOT_PERMITTED
193
193
* The caller is not authorized to register the specified key slot.
194
194
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
195
+ * There is not enough memory to register the key.
195
196
* \retval #PSA_ERROR_INSUFFICIENT_STORAGE
197
+ * There is not enough storage to register the key.
196
198
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
199
+ * There was a failure in communication with the secure element.
197
200
* \retval #PSA_ERROR_DATA_INVALID
201
+ * The key data is not valid.
198
202
* \retval #PSA_ERROR_DATA_CORRUPT
203
+ * The key data is corrupted.
199
204
* \retval #PSA_ERROR_CORRUPTION_DETECTED
205
+ * The key data has been corrupted.
200
206
* \retval #PSA_ERROR_BAD_STATE
201
207
* The library has not been previously initialized by psa_crypto_init().
202
208
* It is implementation-dependent whether a failure to initialize
@@ -495,9 +501,15 @@ psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
495
501
* \param data_length Size of the \p data buffer in bytes.
496
502
*
497
503
* \retval #PSA_SUCCESS
504
+ * Success.
498
505
* \retval #PSA_ERROR_INVALID_ARGUMENT
506
+ * \p type is not a supported key type, or the key type does not
507
+ * support domain parameters, or the domain parameters are not
508
+ * valid for the key type.
499
509
* \retval #PSA_ERROR_NOT_SUPPORTED
510
+ * The key type does not support domain parameters.
500
511
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
512
+ * There was insufficient memory to store the domain parameters.
501
513
*/
502
514
psa_status_t psa_set_key_domain_parameters (psa_key_attributes_t * attributes ,
503
515
psa_key_type_t type ,
@@ -525,7 +537,10 @@ psa_status_t psa_set_key_domain_parameters(psa_key_attributes_t *attributes,
525
537
* that make up the key domain parameters data.
526
538
*
527
539
* \retval #PSA_SUCCESS
540
+ * Success.
528
541
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
542
+ * \p data_size is too small. You can determine a sufficient buffer
543
+ * size by calling PSA_KEY_DOMAIN_PARAMETERS_SIZE().
529
544
*/
530
545
psa_status_t psa_get_key_domain_parameters (
531
546
const psa_key_attributes_t * attributes ,
@@ -1354,8 +1369,12 @@ static psa_pake_operation_t psa_pake_operation_init(void);
1354
1369
* \retval #PSA_ERROR_NOT_SUPPORTED
1355
1370
* The \p cipher_suite is not supported or is not valid.
1356
1371
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
1372
+ * Communication with the peer failed.
1357
1373
* \retval #PSA_ERROR_HARDWARE_FAILURE
1374
+ * A failure of the random generator hardware.
1358
1375
* \retval #PSA_ERROR_CORRUPTION_DETECTED
1376
+ * The implementation detected a potential corruption of its internal
1377
+ * data structures.
1359
1378
* \retval #PSA_ERROR_BAD_STATE
1360
1379
* The library has not been previously initialized by psa_crypto_init().
1361
1380
* It is implementation-dependent whether a failure to initialize
@@ -1389,11 +1408,18 @@ psa_status_t psa_pake_setup(psa_pake_operation_t *operation,
1389
1408
* \retval #PSA_ERROR_BAD_STATE
1390
1409
* The operation state is not valid (it must have been set up.)
1391
1410
* \retval #PSA_ERROR_CORRUPTION_DETECTED
1411
+ * The implementation detected a potential corruption of its internal
1412
+ * data structures.
1392
1413
* \retval #PSA_ERROR_INVALID_HANDLE
1414
+ * \p password is not a valid key identifier.
1393
1415
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
1416
+ * Communication with the key store failed.
1394
1417
* \retval #PSA_ERROR_HARDWARE_FAILURE
1418
+ * A failure of the key store hardware.
1395
1419
* \retval #PSA_ERROR_STORAGE_FAILURE
1420
+ * Storage failure preventing the key from being retrieved.
1396
1421
* \retval #PSA_ERROR_NOT_PERMITTED
1422
+ * The key policy does not allow the requested operation.
1397
1423
* \retval #PSA_ERROR_INVALID_ARGUMENT
1398
1424
* \p key is not compatible with the algorithm or the cipher suite.
1399
1425
* \retval #PSA_ERROR_BAD_STATE
@@ -1430,9 +1456,14 @@ psa_status_t psa_pake_set_password_key(psa_pake_operation_t *operation,
1430
1456
* \retval #PSA_ERROR_BAD_STATE
1431
1457
* The operation state is not valid.
1432
1458
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1459
+ * There was insufficient memory to perform the operation.
1433
1460
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
1461
+ * Communication with the peer failed.
1434
1462
* \retval #PSA_ERROR_HARDWARE_FAILURE
1463
+ * A failure of the random generator hardware.
1435
1464
* \retval #PSA_ERROR_CORRUPTION_DETECTED
1465
+ * The implementation detected a potential corruption of its internal
1466
+ * data structures.
1436
1467
* \retval #PSA_ERROR_INVALID_ARGUMENT
1437
1468
* \p user_id is NULL.
1438
1469
* \retval #PSA_ERROR_BAD_STATE
@@ -1472,9 +1503,14 @@ psa_status_t psa_pake_set_user(psa_pake_operation_t *operation,
1472
1503
* \retval #PSA_ERROR_NOT_SUPPORTED
1473
1504
* The algorithm doesn't associate a second identity with the session.
1474
1505
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1506
+ * There was insufficient memory to perform the operation.
1475
1507
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
1508
+ * Communication with the peer failed.
1476
1509
* \retval #PSA_ERROR_HARDWARE_FAILURE
1510
+ * A failure of the random generator hardware.
1477
1511
* \retval #PSA_ERROR_CORRUPTION_DETECTED
1512
+ * The implementation detected a potential corruption of its internal
1513
+ * data structures.
1478
1514
* \retval #PSA_ERROR_INVALID_ARGUMENT
1479
1515
* \p user_id is NULL.
1480
1516
* \retval #PSA_ERROR_BAD_STATE
@@ -1515,8 +1551,12 @@ psa_status_t psa_pake_set_peer(psa_pake_operation_t *operation,
1515
1551
* \retval #PSA_ERROR_NOT_SUPPORTED
1516
1552
* The \p side for this algorithm is not supported or is not valid.
1517
1553
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
1554
+ * Communication with the peer failed.
1518
1555
* \retval #PSA_ERROR_HARDWARE_FAILURE
1556
+ * A failure of the random generator hardware.
1519
1557
* \retval #PSA_ERROR_CORRUPTION_DETECTED
1558
+ * The implementation detected a potential corruption of its internal
1559
+ * data structures.
1520
1560
* \retval #PSA_ERROR_BAD_STATE
1521
1561
* The library has not been previously initialized by psa_crypto_init().
1522
1562
* It is implementation-dependent whether a failure to initialize
@@ -1562,10 +1602,16 @@ psa_status_t psa_pake_set_side(psa_pake_operation_t *operation,
1562
1602
* \retval #PSA_ERROR_BUFFER_TOO_SMALL
1563
1603
* The size of the \p output buffer is too small.
1564
1604
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1605
+ * There was insufficient memory to perform the operation.
1565
1606
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
1607
+ * Communication with the peer failed.
1566
1608
* \retval #PSA_ERROR_HARDWARE_FAILURE
1609
+ * A failure of the random generator hardware.
1567
1610
* \retval #PSA_ERROR_CORRUPTION_DETECTED
1611
+ * The implementation detected a potential corruption of its internal
1612
+ * data structures.
1568
1613
* \retval #PSA_ERROR_STORAGE_FAILURE
1614
+ * Storage failure preventing the key from being retrieved.
1569
1615
* \retval #PSA_ERROR_BAD_STATE
1570
1616
* The library has not been previously initialized by psa_crypto_init().
1571
1617
* It is implementation-dependent whether a failure to initialize
@@ -1606,10 +1652,16 @@ psa_status_t psa_pake_output(psa_pake_operation_t *operation,
1606
1652
* The operation state is not valid (it must be active, but beyond that
1607
1653
* validity is specific to the algorithm).
1608
1654
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1655
+ * There was insufficient memory to perform the operation.
1609
1656
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
1657
+ * Communication with the peer failed.
1610
1658
* \retval #PSA_ERROR_HARDWARE_FAILURE
1659
+ * A failure of the random generator hardware.
1611
1660
* \retval #PSA_ERROR_CORRUPTION_DETECTED
1661
+ * The implementation detected a potential corruption of its internal
1662
+ * data structures.
1612
1663
* \retval #PSA_ERROR_STORAGE_FAILURE
1664
+ * Storage failure preventing the key from being retrieved.
1613
1665
* \retval #PSA_ERROR_INVALID_ARGUMENT
1614
1666
* The input is not valid for the algorithm, ciphersuite or \p step.
1615
1667
* \retval #PSA_ERROR_BAD_STATE
@@ -1669,10 +1721,16 @@ psa_status_t psa_pake_input(psa_pake_operation_t *operation,
1669
1721
* #PSA_KEY_DERIVATION_INPUT_SECRET is not compatible with the output’s
1670
1722
* algorithm.
1671
1723
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY
1724
+ * There was insufficient memory to perform the operation.
1672
1725
* \retval #PSA_ERROR_COMMUNICATION_FAILURE
1726
+ * Communication with the peer failed.
1673
1727
* \retval #PSA_ERROR_HARDWARE_FAILURE
1728
+ * A failure of the random generator hardware.
1674
1729
* \retval #PSA_ERROR_CORRUPTION_DETECTED
1730
+ * The implementation detected a potential corruption of its internal
1731
+ * data structures.
1675
1732
* \retval #PSA_ERROR_STORAGE_FAILURE
1733
+ * Storage failure preventing the key from being retrieved.
1676
1734
* \retval #PSA_ERROR_BAD_STATE
1677
1735
* The library has not been previously initialized by psa_crypto_init().
1678
1736
* It is implementation-dependent whether a failure to initialize
0 commit comments