-
Notifications
You must be signed in to change notification settings - Fork 0
/
EverCryptNonAgile.html
184 lines (167 loc) · 10.9 KB
/
EverCryptNonAgile.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
<!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>Non-agile APIs — 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="Deprecated APIs" href="EverCryptDeprecated.html" />
<link rel="prev" title="HMAC-DRBG (EverCrypt_DRBG.h)" href="EverCryptDRBG.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"><a class="reference internal" href="EverCryptHKDF.html">HKDF (<code class="docutils literal notranslate"><span class="pre">EverCrypt_HKDF.h</span></code>)</a></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 current"><a class="current reference internal" href="#">Non-agile APIs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#chacha20-poly1305">Chacha20-Poly1305</a></li>
<li class="toctree-l3"><a class="reference internal" href="#curve25519">Curve25519</a></li>
<li class="toctree-l3"><a class="reference internal" href="#poly1305">Poly1305</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ed25519">Ed25519</a></li>
</ul>
</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>Non-agile APIs</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="non-agile-apis">
<h1>Non-agile APIs<a class="headerlink" href="#non-agile-apis" title="Permalink to this headline">¶</a></h1>
<p>Not all algorithms have a corresponding agile API. For instance, there is no
<code class="docutils literal notranslate"><span class="pre">EverCrypt_ECDH.h</span></code> yet. However, clients may still want to call, say
<code class="docutils literal notranslate"><span class="pre">Curve25519</span></code> and enjoy the benefits of multiplexing.</p>
<p>To that end, EverCrypt features a variety of <strong>non-agile</strong>, <strong>multiplexing</strong>
APIs.</p>
<div class="section" id="chacha20-poly1305">
<h2>Chacha20-Poly1305<a class="headerlink" href="#chacha20-poly1305" title="Permalink to this headline">¶</a></h2>
<p>Multiplexes between: portable C, AVX, AVX2</p>
<p>Found in <code class="docutils literal notranslate"><span class="pre">EverCrypt_Chacha20Poly1305.h</span></code>.</p>
<p>See <a class="reference internal" href="HaclAEAD.html#hacl-aead"><span class="std std-ref">AEAD: Chacha20-Poly1305</span></a> for the API documentation, which is identical.</p>
</div>
<div class="section" id="curve25519">
<h2>Curve25519<a class="headerlink" href="#curve25519" title="Permalink to this headline">¶</a></h2>
<p>Multiplexes between: portable C, ADX + BMI2</p>
<p>Found in <code class="docutils literal notranslate"><span class="pre">EverCrypt_Curve25519.h</span></code>.</p>
<p>See <a class="reference internal" href="HaclECDH.html#hacl-curve25519"><span class="std std-ref">ECDH: X25519</span></a> for the API documentation, which is identical.</p>
</div>
<div class="section" id="poly1305">
<h2>Poly1305<a class="headerlink" href="#poly1305" title="Permalink to this headline">¶</a></h2>
<p>Multiplexes between: portable C, AVX, AVX2, X64 assembly</p>
<p>Found in <code class="docutils literal notranslate"><span class="pre">EverCrypt_Poly1305.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">EverCrypt_Poly1305_poly1305</span><span class="p">(</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><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">src</span><span class="p">,</span><span class="w"> </span><span class="kt">uint32_t</span><span class="w"> </span><span class="n">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">key</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">dst</span></code> must be at least 16 bytes</li>
<li>if <code class="docutils literal notranslate"><span class="pre">len</span></code>, the length of <code class="docutils literal notranslate"><span class="pre">src</span></code>, gets close to 4GB, you need to read the
precondition in <code class="docutils literal notranslate"><span class="pre">EverCrypt.Poly1305.fsti</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">key</span></code> must be at least 32 bytes</li>
</ul>
</div>
<div class="section" id="ed25519">
<h2>Ed25519<a class="headerlink" href="#ed25519" title="Permalink to this headline">¶</a></h2>
<p>Found in <code class="docutils literal notranslate"><span class="pre">EverCrypt_Ed25519.h</span></code>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This is just a placeholder and there is no multiplexing for this API yet.</p>
</div>
</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="EverCryptDRBG.html" class="btn btn-neutral float-left" title="HMAC-DRBG (EverCrypt_DRBG.h)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="EverCryptDeprecated.html" class="btn btn-neutral float-right" title="Deprecated APIs" 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>