From 073357bec4e65da17a30411798476e4abc81bf9d Mon Sep 17 00:00:00 2001 From: Matthias Schiffer Date: Tue, 27 May 2014 22:21:35 +0200 Subject: A bit more documentation --- src/sha256.h | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'src/sha256.h') diff --git a/src/sha256.h b/src/sha256.h index 30a8d35..a0b8805 100644 --- a/src/sha256.h +++ b/src/sha256.h @@ -23,6 +23,13 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + \file sha256.h + + Small SHA256 and HMAC-SHA256 implementation +*/ + + #pragma once @@ -31,20 +38,27 @@ #include +/** 32bit words per SHA256 hash */ #define FASTD_SHA256_HASH_WORDS 8 +/** 32bit words per input block */ #define FASTD_SHA256_BLOCK_WORDS 8 +/** 32bit words per HMAC-SHA256 key */ #define FASTD_HMACSHA256_KEY_WORDS 8 +/** bytes per SHA256 hash */ #define FASTD_SHA256_HASH_BYTES (4*FASTD_SHA256_HASH_WORDS) +/** bytes per input block */ #define FASTD_SHA256_BLOCK_BYTES (4*FASTD_SHA256_BLOCK_WORDS) +/** bytes per HMAC-SHA256 key */ #define FASTD_HMACSHA256_KEY_BYTES (4*FASTD_HMACSHA256_KEY_WORDS) +/** A SHA256 hash output */ typedef union fastd_sha256 { - uint32_t w[FASTD_SHA256_HASH_WORDS]; - uint8_t b[FASTD_SHA256_HASH_BYTES]; + uint32_t w[FASTD_SHA256_HASH_WORDS]; /**< 32bit-word-wise access */ + uint8_t b[FASTD_SHA256_HASH_BYTES]; /**< bytewise access */ } fastd_sha256_t; -- cgit v1.2.3