diff options
author | Martin Willi <martin@strongswan.org> | 2005-11-24 11:39:05 +0000 |
---|---|---|
committer | Martin Willi <martin@strongswan.org> | 2005-11-24 11:39:05 +0000 |
commit | 7a09fceae03666d04e5048194746069fb91dc0a9 (patch) | |
tree | 05cea18ebf1427b309d8b9760b726fa9b08c9e78 /Source/charon/transforms/hmac.h | |
parent | 5796aa164d79b2ffaf2839b281d490be6a72d1d8 (diff) | |
download | strongswan-7a09fceae03666d04e5048194746069fb91dc0a9.tar.bz2 strongswan-7a09fceae03666d04e5048194746069fb91dc0a9.tar.xz |
- updated documentation, should be the reference
Diffstat (limited to 'Source/charon/transforms/hmac.h')
-rw-r--r-- | Source/charon/transforms/hmac.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/Source/charon/transforms/hmac.h b/Source/charon/transforms/hmac.h index 384f47dc9..329c64340 100644 --- a/Source/charon/transforms/hmac.h +++ b/Source/charon/transforms/hmac.h @@ -28,14 +28,14 @@ typedef struct hmac_t hmac_t; - /** - * @brief Message authentication based using hash functions. + * @brief Message authentication using hash functions. * * This class implements the message authenticaion algorithm * described in RFC2104. It uses a hash function, wich must * be implemented as a hasher_t class. * + * @see http://www.faqs.org/rfcs/rfc2104.html * @see hasher_t, prf_hmac_t * * @ingroup transforms @@ -76,7 +76,7 @@ struct hmac_t { status_t (*allocate_mac) (hmac_t *this, chunk_t data, chunk_t *chunk); /** - * @brief get the block size of this hmac + * @brief Get the block size of this hmac. * * @param this calling hmac * @return block size in bytes @@ -84,7 +84,7 @@ struct hmac_t { size_t (*get_block_size) (hmac_t *this); /** - * @brief set the key for this hmac + * @brief Set the key for this hmac. * * Any key length is accepted. * @@ -97,9 +97,9 @@ struct hmac_t { /** * @brief Destroys a hmac object. * - * @param this hmac_t object to destroy - * @return - * SUCCESS in any case + * @param this hmac_t object to destroy + * @return + * - SUCCESS in any case */ status_t (*destroy) (hmac_t *this); }; @@ -107,7 +107,7 @@ struct hmac_t { /** * @brief Creates a new hmac_t object. * - * Creates a new hmac_t object using sing hash_algorithm to + * Creates a new hmac_t object using hash_algorithm to * create a hasher_t internally. * * @param hash_algorithm hash algorithm to use |