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

Add docstrings for the utility class

Browse source
This commit is contained in:
Mark Haines 2015-08-20 10:08:15 +01:00
parent 7649125a9e
commit 5e1b8a5b3b
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
include/olm/utility.hh
View file

@ -31,13 +31,22 @@ struct Utility {
ErrorCode last_error; ErrorCode last_error;
/** The length of a SHA-256 hash in bytes. */
std::size_t sha256_length(); std::size_t sha256_length();
/** Compute a SHA-256 hash. Returns the length of the SHA-256 hash in bytes
* on success. Returns std::size_t(-1) on failure. On failure last_error
* will be set with an error code. If the output buffer was too small then
* last error will be OUTPUT_BUFFER_TOO_SMALL. */
std::size_t sha256( std::size_t sha256(
std::uint8_t const * input, std::size_t input_length, std::uint8_t const * input, std::size_t input_length,
std::uint8_t * output, std::size_t output_length std::uint8_t * output, std::size_t output_length
); );
/** Verify a ed25519 signature. Returns std::size_t(0) on success. Returns
* std::size_t(-1) on failure or if the signature was invalid. On failure
* last_error will be set with an error code. If the signature was too short
* or was not a valid signature then last_error will be BAD_MESSAGE_MAC. */
std::size_t ed25519_verify( std::size_t ed25519_verify(
Ed25519PublicKey const & key, Ed25519PublicKey const & key,
std::uint8_t const * message, std::size_t message_length, std::uint8_t const * message, std::size_t message_length,