Move dependencies to the top level.

2026-07-05 16:59:02 +00:00 · 2022-04-16 18:27:14 +08:00
parent b67980d3d2
commit 5d62e839e7
844 changed files with 74 additions and 114431 deletions
@@ -0,0 +1,45 @@
+	/**
+	 * @file HmacSha1Generator.h
+	 * @brief Declarations for API resources for HMAC-SHA1 calculations.
+	 * @author Jack (jakcron)
+	 * @version 0.1
+	 * @date 2020/05/30
+	 **/
+#pragma once
+#include <tc/types.h>
+#include <tc/crypto/Sha1Generator.h>
+#include <tc/crypto/HmacGenerator.h>
+
+namespace tc { namespace crypto {
+
+	/**
+	 * @typedef HmacSha1Generator
+	 * @brief Class for calculating HMAC-SHA1.
+	 * 
+	 * @details This class calcualtes MAC using SHA1.
+	 * For more information refer to @ref HmacGenerator.
+	 */
+using HmacSha1Generator = HmacGenerator<Sha1Generator>;
+
+	/**
+	 * @brief Utility function for calculating HMAC-SHA1.
+	 * 
+	 * @param[out] mac Pointer to the buffer storing the MAC.
+	 * @param[in]  data Pointer to input data.
+	 * @param[in]  data_size Size in bytes of input data.
+	 * @param[in]  key Pointer to key data.
+	 * @param[in]  key_size Size in bytes of key data.
+	 * 
+	 * @pre
+	 * - Size of the MAC buffer must >= <tt>HmacSha1Generator::kMacSize</tt>.
+	 * 
+	 * @post
+	 * - The MAC is written to <tt><var>mac</var></tt>.
+	 * 
+	 * @details
+	 * This function calculates a MAC for the passed in data array.
+	 * To calculate a MAC for data split into multiple arrays, use the @ref HmacSha1Generator class.
+	 */
+void GenerateHmacSha1Mac(byte_t* mac, const byte_t* data, size_t data_size, const byte_t* key, size_t key_size);
+
+}} // namespace tc::crypto