-
Notifications
You must be signed in to change notification settings - Fork 1
/
hmac.html
125 lines (118 loc) · 4.56 KB
/
hmac.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<title> hmac - HMAC hashing </title>
<script src="jquery.js"></script>
<script src="jquery-cookie.js"></script>
<script src="jquery-tablesorter.js"></script>
<script src="strftime.js"></script>
<script src="mustache.js"></script>
<script src="config.js"></script>
<script src="main.js"></script>
<link rel="stylesheet" type="text/css" href="templates/reset.css" />
<link rel="stylesheet" type="text/css" href="templates/hack.css" />
<link rel="stylesheet" type="text/css" id="lights_css" />
<script>
var DOCNAME = 'hmac'
var PROJECT = 'hmac'
//set the lights before rendering starts
set_lights()
</script>
</head>
<body>
<header>
<div class="container">
<div class="btn-container btn-lights-container">
<a href="#" class="btn btn-lights" id="lights">lights</a>
</div>
<div class="btn-container btn-home-container">
<a href="/" class="btn btn-home">luapower</a>
</div>
<table id="header_table">
<tr>
<td style="vertical-align: middle;" width="100%">
<h1> hmac </h1>
<h2> HMAC hashing </h2>
</td>
<td style="vertical-align: middle;" align="right" style="height: 150px">
<table><tr><td>
<div class="doc" id="package_info_container">
<div id="package_info"> </div>
<div id="commit_log"> </div>
</div>
<a href="https://github.com/luapower/hmac" class="btn btn-rightside btn-github"><span class="icon"></span>View on GitHub</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/hmac/tarball/master" class="btn btn-rightside">Download as .tar.gz</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/hmac/zipball/master" class="btn btn-rightside">Download as .zip</a>
</td></tr></table>
</td>
</tr>
</table>
<div class="btn-container btn-discuss-container">
<a href="https://github.com/luapower/hmac/issues/new" target="_blank"
class="btn btn-rightside btn-discuss"><span class="icon"></span>Discuss</a>
</div>
</div>
</header>
<div class="bg-container">
<div class="bg-center-container">
<div class="bg bg-hmac" style="background-image: url('bg/hmac.png');"></div>
</div>
</div>
<div class="under-header">
<div class="container">
<div id="toc_container" class="toc_container doc"></div>
<button id=tab1_button class="tab_button hidden">Documentation</button>
<button id=tab2_button class="tab_button hidden">Package Info</button>
<div id="tabs_cointainer">
<div id="tab1_container">
<section class="doc">
<span id="module_info"></span>
<h2 id="local-hmac-requirehmac"><code>local hmac = require'hmac'</code></h2>
<p><a href="http://en.wikipedia.org/wiki/HMAC">HMAC</a> algorithm per <a href="http://tools.ietf.org/html/rfc2104">RFC 2104</a>.</p>
<table>
<col width="50%" />
<col width="50%" />
<tbody>
<tr class="odd">
<td align="left"><code>hmac.compute(key, message, hash_function, blocksize[, opad][, ipad]) -> hash, opad, ipad</code></td>
<td align="left">Compute a hmac hash based on a hash function. Any function that takes a string as single argument works, like <code>md5.sum</code>. <code>blocksize</code> is that of the underlying hash function, i.e. 64 for MD5 and SHA-256, 128 for SHA-384 and SHA-512.</td>
</tr>
<tr class="even">
<td align="left"><code>hmac.new(hash_function, block_size) -> hmac_function</code> <code>hmac_function(message, key) -> hash</code></td>
<td align="left">Returns a HMAC function that can be used with a specific hash function.</td>
</tr>
<tr class="odd">
<td align="left"><code>hmac.md5(message, key) -> HMAC-MD5 hash</code></td>
<td align="left">Compute HMAC-MD5 (requires <a href="md5.html">md5</a>).</td>
</tr>
<tr class="even">
<td align="left"><code>hmac.sha256(message, key) -> HMAC-SHA256 hash</code> <code>hmac.sha384(message, key) -> HMAC-SHA384 hash</code> <code>hmac.sha512(message, key) -> HMAC-SHA512 hash</code></td>
<td align="left">Compute HMAC-SHA2 (requires <a href="sha2.html">sha2</a>).</td>
</tr>
</tbody>
</table>
</section>
</div>
<div id="tab2_container" class="doc"></div>
</div>
</div>
<div class="container">
<footer>
<div id="disqus_thread"></div>
<div class="faint">[email protected] | <a href="http://unlicense.org/">public domain</a></div>
</footer>
</div>
</div>
<script type="text/x-mustache" id=info_tab_template>
<h3>Modules</h3>
<ul>
{{#module_array}}
<li>{{name}}</li>
{{/module_array}}
</ul>
</script>
</body>
</html>