-
Notifications
You must be signed in to change notification settings - Fork 0
/
EverCryptHKDF.html
243 lines (222 loc) · 16.4 KB
/
EverCryptHKDF.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
233
234
235
236
237
238
239
240
241
242
243
<!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>HKDF (EverCrypt_HKDF.h) — 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="HMAC-DRBG (EverCrypt_DRBG.h)" href="EverCryptDRBG.html" />
<link rel="prev" title="HMAC (EverCrypt_HMAC.h)" href="EverCryptHMAC.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"><a class="reference internal" href="HaclDoc.html">HACL APIs</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="EverCryptDoc.html">EverCrypt APIs</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="EverCryptAutoConfig.html">CPU autodetection (<code class="docutils literal notranslate"><span class="pre">EverCrypt_AutoConfig2.h</span></code>)</a></li>
<li class="toctree-l2"><a class="reference internal" href="EverCryptAEAD.html">AEAD (<code class="docutils literal notranslate"><span class="pre">EverCrypt_AEAD.h</span></code>)</a></li>
<li class="toctree-l2"><a class="reference internal" href="EverCryptCTR.html">CTR-mode encryption (<code class="docutils literal notranslate"><span class="pre">EverCrypt_CTR.h</span></code>)</a></li>
<li class="toctree-l2"><a class="reference internal" href="EverCryptHash.html">Hashing (<code class="docutils literal notranslate"><span class="pre">EverCrypt_Hash.h</span></code>)</a></li>
<li class="toctree-l2"><a class="reference internal" href="EverCryptHMAC.html">HMAC (<code class="docutils literal notranslate"><span class="pre">EverCrypt_HMAC.h</span></code>)</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">HKDF (<code class="docutils literal notranslate"><span class="pre">EverCrypt_HKDF.h</span></code>)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#agile-api">Agile API</a></li>
<li class="toctree-l3"><a class="reference internal" href="#non-agile-api">Non-agile API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="EverCryptDRBG.html">HMAC-DRBG (<code class="docutils literal notranslate"><span class="pre">EverCrypt_DRBG.h</span></code>)</a></li>
<li class="toctree-l2"><a class="reference internal" href="EverCryptNonAgile.html">Non-agile APIs</a></li>
<li class="toctree-l2"><a class="reference internal" href="EverCryptDeprecated.html">Deprecated APIs</a></li>
</ul>
</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="EverCryptDoc.html">EverCrypt APIs</a> »</li>
<li>HKDF (<code class="docutils literal notranslate"><span class="pre">EverCrypt_HKDF.h</span></code>)</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="hkdf-evercrypt-hkdf-h">
<h1>HKDF (<code class="docutils literal notranslate"><span class="pre">EverCrypt_HKDF.h</span></code>)<a class="headerlink" href="#hkdf-evercrypt-hkdf-h" title="Permalink to this headline">¶</a></h1>
<p>This API is:</p>
<ul class="simple">
<li><strong>agile</strong></li>
<li><strong>multiplexing</strong>: portable C (all); SHAEXT (SHA2-256)</li>
<li><strong>NOT</strong> stateful</li>
</ul>
<p>Possible values for the agility argument (<code class="docutils literal notranslate"><span class="pre">Hacl_Spec.h</span></code>) :</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="cp">#define Spec_Hash_Definitions_SHA2_224 0</span>
<span class="cp">#define Spec_Hash_Definitions_SHA2_256 1</span>
<span class="cp">#define Spec_Hash_Definitions_SHA2_384 2</span>
<span class="cp">#define Spec_Hash_Definitions_SHA2_512 3</span>
<span class="cp">#define Spec_Hash_Definitions_SHA1 4</span>
<span class="cp">#define Spec_Hash_Definitions_MD5 5</span>
<span class="cp">#define Spec_Hash_Definitions_Blake2S 6</span>
<span class="cp">#define Spec_Hash_Definitions_Blake2B 7</span>
</pre></div>
</div>
<p>Supported values for the agility argument: SHA1; SHA2_256; SHA2_384; SHA2_512.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">As always, the source is authoritative and you should check <code class="docutils literal notranslate"><span class="pre">is_supported_alg</span></code>
in <code class="docutils literal notranslate"><span class="pre">EverCrypt.HMAC.fsti</span></code>.</p>
</div>
<div class="section" id="agile-api">
<h2>Agile API<a class="headerlink" href="#agile-api" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">expand</span></code> and <code class="docutils literal notranslate"><span class="pre">extract</span></code> functions are agile and multiplexing:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="kt">void</span><span class="w"></span>
<span class="nf">EverCrypt_HKDF_extract</span><span class="p">(</span><span class="w"></span>
<span class="w"> </span><span class="n">Spec_Hash_Definitions_hash_alg</span><span class="w"> </span><span class="n">a</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">prk</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">salt</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">saltlen</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">ikm</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">ikmlen</span><span class="w"></span>
<span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">prk</span></code> is the output parameter</li>
<li><code class="docutils literal notranslate"><span class="pre">ikm</span></code> means “input key material”</li>
<li>if <code class="docutils literal notranslate"><span class="pre">saltlen</span></code> approaches 4GB then you need to make sure it satisfies
<code class="docutils literal notranslate"><span class="pre">keysized</span></code> in <code class="docutils literal notranslate"><span class="pre">Spec.Agile.HMAC.fsti</span></code></li>
<li>if <code class="docutils literal notranslate"><span class="pre">ikmlen</span></code> approaches 4GB then you need to check the preconditions from
<code class="docutils literal notranslate"><span class="pre">extract_st</span></code>, in <code class="docutils literal notranslate"><span class="pre">EverCrypt.HKDF.fsti</span></code>.</li>
</ul>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="kt">void</span><span class="w"></span>
<span class="nf">EverCrypt_HKDF_expand_sha1</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">okm</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">prk</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">prklen</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">info</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">infolen</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">len</span><span class="w"></span>
<span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">okm</span></code> (“output key material”) is the output parameter</li>
<li>if <code class="docutils literal notranslate"><span class="pre">prklen</span></code> approaches 4GB then you need to make sure it satisfies
<code class="docutils literal notranslate"><span class="pre">keysized</span></code> in <code class="docutils literal notranslate"><span class="pre">Spec.Agile.HMAC.fsti</span></code></li>
<li>if <code class="docutils literal notranslate"><span class="pre">infolen</span></code> approaches 4GB then you need to check the precondition on
<code class="docutils literal notranslate"><span class="pre">infolen</span></code> in <code class="docutils literal notranslate"><span class="pre">expand_st</span></code>, in <code class="docutils literal notranslate"><span class="pre">EverCrypt.HKDF.fsti</span></code>.</li>
</ul>
<p>These functions dynamically dispatch onto one of the specialized, non-agile
versions below. As such, the cost of agility is one test.</p>
</div>
<div class="section" id="non-agile-api">
<h2>Non-agile API<a class="headerlink" href="#non-agile-api" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">expand_*</span></code> and <code class="docutils literal notranslate"><span class="pre">extract_*</span></code> functions are <strong>non-agile</strong> and multiplexing:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span>
<span class="kt">void</span><span class="w"></span>
<span class="nf">EverCrypt_HKDF_expand_sha2_512</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">okm</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">prk</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">prklen</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">info</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">infolen</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">len</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">EverCrypt_HKDF_extract_sha2_512</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">prk</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">salt</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">saltlen</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">ikm</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">ikmlen</span><span class="w"></span>
<span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<p>A non-agile, non-multiplexing copy of this API exists in <code class="docutils literal notranslate"><span class="pre">Hacl_HKDF.h</span></code>.</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="EverCryptHMAC.html" class="btn btn-neutral float-left" title="HMAC (EverCrypt_HMAC.h)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="EverCryptDRBG.html" class="btn btn-neutral float-right" title="HMAC-DRBG (EverCrypt_DRBG.h)" 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>