From ffef856e205bcaf42a1a9a8cc5fb4965fd459edc Mon Sep 17 00:00:00 2001
From: Daniel White <daniel@whitehouse.id.au>
Date: Thu, 27 Sep 2012 02:40:11 +1000
Subject: crypto: Provide a generic interface for HMAC generation

---
 lib/crypto/doc/src/crypto.xml | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'lib/crypto/doc')

diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index 0f21441748..5e2a7acb97 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -342,6 +342,23 @@ Mpint() = <![CDATA[<<ByteLen:32/integer-big, Bytes:ByteLen/binary>>]]>
           is 96 bits (12 bytes).</p>
       </desc>
     </func>
+    <func>
+      <name>hmac(Type, Key, Data) -> Mac</name>
+      <name>hmac(Type, Key, Data, MacLength) -> Mac</name>
+      <fsummary></fsummary>
+      <type>
+	<v>Type = md5 | sha | sha224 | sha256 | sha384 | sha512</v>
+        <v>Key = iodata()</v>
+	<v>Data = iodata()</v>
+        <v>MacLength = integer()</v>
+	<v>Mac = binary()</v>
+      </type>
+      <desc>
+        <p>Computes a HMAC of type <c>Type</c> from <c>Data</c> using
+        <c>Key</c> as the authentication key.</p> <c>MacLength</c>
+        will limit the size of the resultant <c>Mac</c>.
+      </desc>
+    </func>
     <func>
       <name>hmac_init(Type, Key) -> Context</name>
       <fsummary></fsummary>
-- 
cgit v1.2.3