diff options
Diffstat (limited to 'src/include/openssl/hmac.h')
| -rw-r--r-- | src/include/openssl/hmac.h | 86 |
1 files changed, 43 insertions, 43 deletions
diff --git a/src/include/openssl/hmac.h b/src/include/openssl/hmac.h index e4cc04e6..1754d7fb 100644 --- a/src/include/openssl/hmac.h +++ b/src/include/openssl/hmac.h @@ -66,84 +66,84 @@ extern "C" { #endif -/* HMAC contains functions for constructing PRFs from Merkle–Damgård hash - * functions using HMAC. */ +// HMAC contains functions for constructing PRFs from Merkle–Damgård hash +// functions using HMAC. -/* One-shot operation. */ +// One-shot operation. -/* HMAC calculates the HMAC of |data_len| bytes of |data|, using the given key - * and hash function, and writes the result to |out|. On entry, |out| must - * contain at least |EVP_MD_size| bytes of space. The actual length of the - * result is written to |*out_len|. An output size of |EVP_MAX_MD_SIZE| will - * always be large enough. It returns |out| or NULL on error. */ +// HMAC calculates the HMAC of |data_len| bytes of |data|, using the given key +// and hash function, and writes the result to |out|. On entry, |out| must +// contain at least |EVP_MD_size| bytes of space. The actual length of the +// result is written to |*out_len|. An output size of |EVP_MAX_MD_SIZE| will +// always be large enough. It returns |out| or NULL on error. OPENSSL_EXPORT uint8_t *HMAC(const EVP_MD *evp_md, const void *key, size_t key_len, const uint8_t *data, size_t data_len, uint8_t *out, unsigned int *out_len); -/* Incremental operation. */ +// Incremental operation. -/* HMAC_CTX_init initialises |ctx| for use in an HMAC operation. It's assumed - * that HMAC_CTX objects will be allocated on the stack thus no allocation - * function is provided. If needed, allocate |sizeof(HMAC_CTX)| and call - * |HMAC_CTX_init| on it. */ +// HMAC_CTX_init initialises |ctx| for use in an HMAC operation. It's assumed +// that HMAC_CTX objects will be allocated on the stack thus no allocation +// function is provided. If needed, allocate |sizeof(HMAC_CTX)| and call +// |HMAC_CTX_init| on it. OPENSSL_EXPORT void HMAC_CTX_init(HMAC_CTX *ctx); -/* HMAC_CTX_cleanup frees data owned by |ctx|. */ +// HMAC_CTX_cleanup frees data owned by |ctx|. OPENSSL_EXPORT void HMAC_CTX_cleanup(HMAC_CTX *ctx); -/* HMAC_Init_ex sets up an initialised |HMAC_CTX| to use |md| as the hash - * function and |key| as the key. For a non-initial call, |md| may be NULL, in - * which case the previous hash function will be used. If the hash function has - * not changed and |key| is NULL, |ctx| reuses the previous key. It returns one - * on success or zero otherwise. - * - * WARNING: NULL and empty keys are ambiguous on non-initial calls. Passing NULL - * |key| but repeating the previous |md| reuses the previous key rather than the - * empty key. */ +// HMAC_Init_ex sets up an initialised |HMAC_CTX| to use |md| as the hash +// function and |key| as the key. For a non-initial call, |md| may be NULL, in +// which case the previous hash function will be used. If the hash function has +// not changed and |key| is NULL, |ctx| reuses the previous key. It returns one +// on success or zero otherwise. +// +// WARNING: NULL and empty keys are ambiguous on non-initial calls. Passing NULL +// |key| but repeating the previous |md| reuses the previous key rather than the +// empty key. OPENSSL_EXPORT int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, size_t key_len, const EVP_MD *md, ENGINE *impl); -/* HMAC_Update hashes |data_len| bytes from |data| into the current HMAC - * operation in |ctx|. It returns one. */ +// HMAC_Update hashes |data_len| bytes from |data| into the current HMAC +// operation in |ctx|. It returns one. OPENSSL_EXPORT int HMAC_Update(HMAC_CTX *ctx, const uint8_t *data, size_t data_len); -/* HMAC_Final completes the HMAC operation in |ctx| and writes the result to - * |out| and the sets |*out_len| to the length of the result. On entry, |out| - * must contain at least |HMAC_size| bytes of space. An output size of - * |EVP_MAX_MD_SIZE| will always be large enough. It returns one on success or - * zero on error. */ +// HMAC_Final completes the HMAC operation in |ctx| and writes the result to +// |out| and the sets |*out_len| to the length of the result. On entry, |out| +// must contain at least |HMAC_size| bytes of space. An output size of +// |EVP_MAX_MD_SIZE| will always be large enough. It returns one on success or +// zero on error. OPENSSL_EXPORT int HMAC_Final(HMAC_CTX *ctx, uint8_t *out, unsigned int *out_len); -/* Utility functions. */ +// Utility functions. -/* HMAC_size returns the size, in bytes, of the HMAC that will be produced by - * |ctx|. On entry, |ctx| must have been setup with |HMAC_Init_ex|. */ +// HMAC_size returns the size, in bytes, of the HMAC that will be produced by +// |ctx|. On entry, |ctx| must have been setup with |HMAC_Init_ex|. OPENSSL_EXPORT size_t HMAC_size(const HMAC_CTX *ctx); -/* HMAC_CTX_copy_ex sets |dest| equal to |src|. On entry, |dest| must have been - * initialised by calling |HMAC_CTX_init|. It returns one on success and zero - * on error. */ +// HMAC_CTX_copy_ex sets |dest| equal to |src|. On entry, |dest| must have been +// initialised by calling |HMAC_CTX_init|. It returns one on success and zero +// on error. OPENSSL_EXPORT int HMAC_CTX_copy_ex(HMAC_CTX *dest, const HMAC_CTX *src); -/* Deprecated functions. */ +// Deprecated functions. OPENSSL_EXPORT int HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len, const EVP_MD *md); -/* HMAC_CTX_copy calls |HMAC_CTX_init| on |dest| and then sets it equal to - * |src|. On entry, |dest| must /not/ be initialised for an operation with - * |HMAC_Init_ex|. It returns one on success and zero on error. */ +// HMAC_CTX_copy calls |HMAC_CTX_init| on |dest| and then sets it equal to +// |src|. On entry, |dest| must /not/ be initialised for an operation with +// |HMAC_Init_ex|. It returns one on success and zero on error. OPENSSL_EXPORT int HMAC_CTX_copy(HMAC_CTX *dest, const HMAC_CTX *src); -/* Private functions */ +// Private functions struct hmac_ctx_st { const EVP_MD *md; @@ -154,7 +154,7 @@ struct hmac_ctx_st { #if defined(__cplusplus) -} /* extern C */ +} // extern C #if !defined(BORINGSSL_NO_CXX) extern "C++" { @@ -171,4 +171,4 @@ using ScopedHMAC_CTX = #endif -#endif /* OPENSSL_HEADER_HMAC_H */ +#endif // OPENSSL_HEADER_HMAC_H |