cipher: document args
#include <stdint.h>
/**
- * @param[out] must have inlen + 64 bytes.
+ * @param[in] in bytes to encrypt
+ * @param[in] in_len size of `in`
+ * @param[out] out must have inlen + 64 bytes.
* @param[inout] out_len must be inlen + 64 incoming, and will be the actual
* length of the output.
- * @param[in] secret 32 bytes secret
+ * @param[in] secret 32 bytes secret from which the encryption/auth keys are derived.
*/
bool cipher_aes_hmac_encrypt(
const uint8_t* in,
@@ -33,10 +35,12 @@ bool cipher_aes_hmac_encrypt(
const uint8_t* secret);
/**
- * @param[in] must have at least 64 bytes.
+ * @param[in] bytes to decrypt.
+ * @param[in] in_len size of `in`, must be at least 64 bytes (IV, padding, HMAC).
* @param[out] must have in_len - 48 bytes.
* @param[inout] out_len must be inlen - 48 incoming, and will be the actual
* length of the output.
+ * @param[in] secret 32 bytes secret from which the encryption/auth keys are derived.
*/
bool cipher_aes_hmac_decrypt(
const uint8_t* in,
