summaryrefslogtreecommitdiffstats
path: root/src/sha256.h
diff options
context:
space:
mode:
authorMatthias Schiffer <mschiffer@universe-factory.net>2014-05-27 22:21:35 +0200
committerMatthias Schiffer <mschiffer@universe-factory.net>2014-05-27 22:21:35 +0200
commit073357bec4e65da17a30411798476e4abc81bf9d (patch)
tree7bb7558fe963cb39e4a96d8b0a1b9b28d942682e /src/sha256.h
parente03ec948967225c8162ffecf37b59bbfc338a83a (diff)
downloadfastd-073357bec4e65da17a30411798476e4abc81bf9d.tar
fastd-073357bec4e65da17a30411798476e4abc81bf9d.zip
A bit more documentation
Diffstat (limited to 'src/sha256.h')
-rw-r--r--src/sha256.h18
1 files changed, 16 insertions, 2 deletions
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 <stdint.h>
+/** 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;