Differences From Artifact [e1a5b71855]:
- File src/pbkdf2.h — part of check-in [7d71c669ec] at 2020-06-20 15:36:04 on branch trunk — Add missing documentation (user: js, size: 1955) [annotate] [blame] [check-ins using] [more...]
To Artifact [139e147fae]:
- File
src/pbkdf2.h
— part of check-in
[b9641347e3]
at
2020-06-21 21:30:23
on branch trunk
— Move parameters for of_pbkdf2() to a struct
This should make it more readable for such a large number of parameters. (user: js, size: 2111) [annotate] [blame] [check-ins using]
| ︙ | ︙ | |||
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
OF_ASSUME_NONNULL_BEGIN
/*! @file */
@class OFHMAC;
#ifdef __cplusplus
extern "C" {
#endif
/*!
* @brief Derives a key from a password and a salt using PBKDF2.
*
* @note This will call @ref OFHMAC::reset on the `HMAC` first, making it
* possible to reuse the `HMAC`, but also meaning all previous results
* from the `HMAC` get invalidated if they have not been copied.
*
| > > > > > > > > > > > > > > > > > > > > > > > > > > > > < < < < | < < < < < | < < < | 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 |
OF_ASSUME_NONNULL_BEGIN
/*! @file */
@class OFHMAC;
/*!
* @brief The parameters for @ref of_pbkdf2.
*/
typedef struct of_pbkdf2_parameters_t {
/*! @brief The HMAC to use to derive a key. */
OFHMAC *HMAC;
/*! @brief The number of iterations to perform. */
size_t iterations;
/*! @brief The salt to derive a key with. */
const unsigned char *salt;
/*! @brief The length of the salt. */
size_t saltLength;
/*! @brief The password to derive a key from. */
const char *password;
/*! @brief The length of the password. */
size_t passwordLength;
/*! @brief The buffer to write the key to. */
unsigned char *key;
/*!
* @brief The desired length for the derived key.
*
* @ref key needs to have enough storage).
*/
size_t keyLength;
/*! @brief Whether data may be stored in swappable memory. */
bool allowsSwappableMemory;
} of_pbkdf2_parameters_t;
#ifdef __cplusplus
extern "C" {
#endif
/*!
* @brief Derives a key from a password and a salt using PBKDF2.
*
* @note This will call @ref OFHMAC::reset on the `HMAC` first, making it
* possible to reuse the `HMAC`, but also meaning all previous results
* from the `HMAC` get invalidated if they have not been copied.
*
* @param param The parameters to use
*/
extern void of_pbkdf2(of_pbkdf2_parameters_t param);
#ifdef __cplusplus
}
#endif
OF_ASSUME_NONNULL_END
|