timoreo/olm
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add comment about input buffers being overwritten

Browse source 
also make some params const where possible
This commit is contained in:
Hubert Chathi 2019-05-14 12:53:19 -04:00
parent 769d013ef7
commit 0757e6df40
2 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
include/olm/sas.h
View file

@ -59,7 +59,8 @@ size_t olm_create_sas_random_length(
/** Creates a new SAS object. /** Creates a new SAS object.
* *
* @param[in] sas the SAS object to create, initialized by `olm_sas()`. * @param[in] sas the SAS object to create, initialized by `olm_sas()`.
* @param[in] random array of random bytes. * @param[in] random array of random bytes. The contents of the buffer may be
* overwritten.
* @param[in] random_length the number of random bytes provided. Must be at * @param[in] random_length the number of random bytes provided. Must be at
* least `olm_create_sas_random_length()`. * least `olm_create_sas_random_length()`.
* *
@ -92,7 +93,8 @@ size_t olm_sas_get_pubkey(
/** Sets the public key of other user. /** Sets the public key of other user.
* *
* @param[in] sas the SAS object. * @param[in] sas the SAS object.
* @param[in] their_key the other user's public key. * @param[in] their_key the other user's public key. The contents of the
* buffer will be overwritten.
* @param[in] their_key_length the size of the `their_key` buffer. * @param[in] their_key_length the size of the `their_key` buffer.
* *
* @return `olm_error()` on failure. If the `their_key` buffer is too small, * @return `olm_error()` on failure. If the `their_key` buffer is too small,
@ -142,7 +144,7 @@ size_t olm_sas_mac_length(
*/ */
size_t olm_sas_calculate_mac( size_t olm_sas_calculate_mac(
OlmSAS * sas, OlmSAS * sas,
void * input, size_t input_length, const void * input, size_t input_length,
const void * info, size_t info_length, const void * info, size_t info_length,
void * mac, size_t mac_length void * mac, size_t mac_length
); );
@ -150,7 +152,7 @@ size_t olm_sas_calculate_mac(
// for compatibility with an old version of Riot // for compatibility with an old version of Riot
size_t olm_sas_calculate_mac_long_kdf( size_t olm_sas_calculate_mac_long_kdf(
OlmSAS * sas, OlmSAS * sas,
void * input, size_t input_length, const void * input, size_t input_length,
const void * info, size_t info_length, const void * info, size_t info_length,
void * mac, size_t mac_length void * mac, size_t mac_length
); );

4
src/sas.c
View file

@ -120,7 +120,7 @@ size_t olm_sas_mac_length(
size_t olm_sas_calculate_mac( size_t olm_sas_calculate_mac(
OlmSAS * sas, OlmSAS * sas,
void * input, size_t input_length, const void * input, size_t input_length,
const void * info, size_t info_length, const void * info, size_t info_length,
void * mac, size_t mac_length void * mac, size_t mac_length
) { ) {
@ -143,7 +143,7 @@ size_t olm_sas_calculate_mac(
// for compatibility with an old version of Riot // for compatibility with an old version of Riot
size_t olm_sas_calculate_mac_long_kdf( size_t olm_sas_calculate_mac_long_kdf(
OlmSAS * sas, OlmSAS * sas,
void * input, size_t input_length, const void * input, size_t input_length,
const void * info, size_t info_length, const void * info, size_t info_length,
void * mac, size_t mac_length void * mac, size_t mac_length
) { ) {