aboutsummaryrefslogtreecommitdiffstats
path: root/lib/crypto/doc/src/crypto.xml
diff options
context:
space:
mode:
authorDaniel White <[email protected]>2012-09-27 02:40:11 +1000
committerSverker Eriksson <[email protected]>2012-12-12 15:35:36 +0100
commitffef856e205bcaf42a1a9a8cc5fb4965fd459edc (patch)
tree19778c527d674f63d54b27c9e888864279a2d237 /lib/crypto/doc/src/crypto.xml
parent918546531fafb9a20170fc1ba1a2c876a46b3cc1 (diff)
downloadotp-ffef856e205bcaf42a1a9a8cc5fb4965fd459edc.tar.gz
otp-ffef856e205bcaf42a1a9a8cc5fb4965fd459edc.tar.bz2
otp-ffef856e205bcaf42a1a9a8cc5fb4965fd459edc.zip
crypto: Provide a generic interface for HMAC generation
Diffstat (limited to 'lib/crypto/doc/src/crypto.xml')
-rw-r--r--lib/crypto/doc/src/crypto.xml17
1 files changed, 17 insertions, 0 deletions
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
@@ -343,6 +343,23 @@ Mpint() = <![CDATA[<<ByteLen:32/integer-big, Bytes:ByteLen/binary>>]]>
</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>
<type>