-
Notifications
You must be signed in to change notification settings - Fork 0
/
HaclHash.html
232 lines (208 loc) · 16.1 KB
/
HaclHash.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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Hashing: SHA-2, SHA-3 — HACL* and EverCrypt Manual documentation</title><link rel="stylesheet" href="static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="static/js/html5shiv.min.js"></script>
<![endif]-->
<script>
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script src="static/jquery.js"></script>
<script src="static/underscore.js"></script>
<script src="static/doctools.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script src="static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="ECDH: X25519" href="HaclECDH.html" />
<link rel="prev" title="AEAD: Chacha20-Poly1305" href="HaclAEAD.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> HACL* and EverCrypt Manual
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="HaclValeEverCrypt.html">HACL*, Vale, and EverCrypt</a></li>
<li class="toctree-l1"><a class="reference internal" href="Supported.html">List of supported algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="Overview.html">Underlying research</a></li>
<li class="toctree-l1"><a class="reference internal" href="Obtaining.html">Using the crypto library</a></li>
<li class="toctree-l1"><a class="reference internal" href="General.html">Digging into the F* source code</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="HaclDoc.html">HACL APIs</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="HaclAEAD.html">AEAD: Chacha20-Poly1305</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Hashing: SHA-2, SHA-3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#sha-2">SHA-2</a></li>
<li class="toctree-l3"><a class="reference internal" href="#sha-3">SHA-3</a></li>
<li class="toctree-l3"><a class="reference internal" href="#shake">SHAKE</a></li>
<li class="toctree-l3"><a class="reference internal" href="#other-hash-functions-blake-2-md5-sha-1">Other Hash Functions: Blake-2, MD5, SHA-1</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="HaclECDH.html">ECDH: X25519</a></li>
<li class="toctree-l2"><a class="reference internal" href="HaclSig.html">Signatures: Ed25519</a></li>
<li class="toctree-l2"><a class="reference internal" href="HaclNaCl.html">NaCl API: Box and SecretBox</a></li>
<li class="toctree-l2"><a class="reference internal" href="Randomness.html">Randomness</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="EverCryptDoc.html">EverCrypt APIs</a></li>
<li class="toctree-l1"><a class="reference internal" href="API.html">Which API to use</a></li>
<li class="toctree-l1"><a class="reference internal" href="Applications.html">Verified Applications</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">HACL* and EverCrypt Manual</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><a href="HaclDoc.html">HACL APIs</a> »</li>
<li>Hashing: SHA-2, SHA-3</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="hashing-sha-2-sha-3">
<h1>Hashing: SHA-2, SHA-3<a class="headerlink" href="#hashing-sha-2-sha-3" title="Permalink to this headline">¶</a></h1>
<div class="section" id="sha-2">
<h2>SHA-2<a class="headerlink" href="#sha-2" title="Permalink to this headline">¶</a></h2>
<p>HACL* implements the SHA-2 suite of hash functions
as described in the NIST publication <a class="reference external" href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">FIPS PUB 180-4: Secure Hash Standard</a>. The API
for these hash functions is in the file <code class="docutils literal notranslate"><span class="pre">Hacl_Hash.h</span></code>.</p>
<p>The types for SHA-256, SHA-384, and SHA-512 are as follows:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="kt">void</span><span class="w"> </span><span class="nf">Hacl_Hash_SHA2_hash_256</span><span class="p">(</span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">input</span><span class="p">,</span><span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">input_len</span><span class="p">,</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">dst</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="kt">void</span><span class="w"> </span><span class="nf">Hacl_Hash_SHA2_hash_384</span><span class="p">(</span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">input</span><span class="p">,</span><span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">input_len</span><span class="p">,</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">dst</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="kt">void</span><span class="w"> </span><span class="nf">Hacl_Hash_SHA2_hash_512</span><span class="p">(</span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">input</span><span class="p">,</span><span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">input_len</span><span class="p">,</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">dst</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<p>Each function takes a pointer as its first argument a pointer <code class="docutils literal notranslate"><span class="pre">input</span></code>
to an array of bytes of length <code class="docutils literal notranslate"><span class="pre">input_len</span></code> (the second argument).
The last argument is a pointer <code class="docutils literal notranslate"><span class="pre">dst</span></code> to an array of bytes where
the result will be written. All pointers (<code class="docutils literal notranslate"><span class="pre">input</span></code>, <code class="docutils literal notranslate"><span class="pre">dst</span></code>) must be
live (non-null, non-freed). For SHA-256, <code class="docutils literal notranslate"><span class="pre">dst</span></code> must point to an array
allocated with (at least) 32 bytes, for SHA-384, it must have 48 bytes, and for
SHA-512 it must have 64 bytes. The <code class="docutils literal notranslate"><span class="pre">input</span></code> array is limited to 2^32 bytes.</p>
</div>
<div class="section" id="sha-3">
<h2>SHA-3<a class="headerlink" href="#sha-3" title="Permalink to this headline">¶</a></h2>
<p>HACL* also implements the SHA-3 suite of hash algorithms
described in the NIST publication <a class="reference external" href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf">FIPS PUB 202: SHA-3 Standard</a>. The API for
these hash functions is in the file <code class="docutils literal notranslate"><span class="pre">Hacl_SHA3.h</span></code>.</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="kt">void</span><span class="w"> </span><span class="nf">Hacl_SHA3_sha3_256</span><span class="p">(</span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">inputByteLen</span><span class="p">,</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">input</span><span class="p">,</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">output</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="kt">void</span><span class="w"> </span><span class="nf">Hacl_SHA3_sha3_384</span><span class="p">(</span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">inputByteLen</span><span class="p">,</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">input</span><span class="p">,</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">output</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="kt">void</span><span class="w"> </span><span class="nf">Hacl_SHA3_sha3_512</span><span class="p">(</span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">inputByteLen</span><span class="p">,</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">input</span><span class="p">,</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">output</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<p>The API is a little different than SHA-2 in that the first argument
is now the length of the input <code class="docutils literal notranslate"><span class="pre">inputByteLen</span></code> and the second
argument is a pointer to the <code class="docutils literal notranslate"><span class="pre">input</span></code> array. The last argument
is the <code class="docutils literal notranslate"><span class="pre">ouput</span></code> of the hash function. The size of <code class="docutils literal notranslate"><span class="pre">output</span></code>
matches that of SHA-2 (32/48/64 bytes.)</p>
</div>
<div class="section" id="shake">
<h2>SHAKE<a class="headerlink" href="#shake" title="Permalink to this headline">¶</a></h2>
<p>In addition to the above functions, <code class="docutils literal notranslate"><span class="pre">Hacl_SHA3.h</span></code> also provides
the general <code class="docutils literal notranslate"><span class="pre">keccak</span></code> function and the two SHAKE constructions
that can produce arbitrary size digests and hence also take
an <code class="docutils literal notranslate"><span class="pre">outputByteLen</span></code> as argument. These functions expect the
<code class="docutils literal notranslate"><span class="pre">output</span></code> array to have at least <code class="docutils literal notranslate"><span class="pre">outputByteLen</span></code> bytes</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="kt">void</span><span class="w"></span>
<span class="nf">Hacl_SHA3_shake128_hacl</span><span class="p">(</span><span class="w"></span>
<span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">inputByteLen</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">input</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">outputByteLen</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">output</span><span class="w"></span>
<span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="kt">void</span><span class="w"></span>
<span class="nf">Hacl_SHA3_shake256_hacl</span><span class="p">(</span><span class="w"></span>
<span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">inputByteLen</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">input</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">outputByteLen</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">output</span><span class="w"></span>
<span class="p">);</span><span class="w"></span>
</pre></div>
</div>
</div>
<div class="section" id="other-hash-functions-blake-2-md5-sha-1">
<h2>Other Hash Functions: Blake-2, MD5, SHA-1<a class="headerlink" href="#other-hash-functions-blake-2-md5-sha-1" title="Permalink to this headline">¶</a></h2>
<p>A development branch of HACL* contains verified implementations of Blake2s and
Blake2b. Contact the HACL* maintainers if you wish to use these implementations.</p>
<p>HACL* also includes implementations of MD5 and SHA1 for backwards compatibility,
but we strongly recommend against using these algorithms.</p>
</div>
</div>
</div>
</div>
<a href="https://github.com/project-everest/hacl-star/">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub">
</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="HaclAEAD.html" class="btn btn-neutral float-left" title="AEAD: Chacha20-Poly1305" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="HaclECDH.html" class="btn btn-neutral float-right" title="ECDH: X25519" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2019, INRIA, Microsoft Research, CMU.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>