Update PSA API specification to 1.0.1
Generated according to the instructions in update_psa_crypto_api.sh
using the tag psa-crypto-api-1.0.1.
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
diff --git a/docs/html/overview/goals.html b/docs/html/overview/goals.html
index 028cf5e..0185da7 100644
--- a/docs/html/overview/goals.html
+++ b/docs/html/overview/goals.html
@@ -5,26 +5,27 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>Design goals — PSA Crypto API 1.0.0 documentation</title>
+ <title>2. Design goals — PSA Crypto API 1.0.1 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
- VERSION: '1.0.0',
+ VERSION: '1.0.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
- HAS_SOURCE: true,
+ HAS_SOURCE: false,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
+ <link rel="author" title="About these documents" href="../about.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="Functionality overview" href="functionality.html" />
- <link rel="prev" title="Introduction" href="intro.html" />
+ <link rel="next" title="3. Functionality overview" href="functionality.html" />
+ <link rel="prev" title="1. Introduction" href="intro.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@@ -40,9 +41,9 @@
<div class="body" role="main">
<div class="section" id="design-goals">
-<span id="id1"></span><h1>Design goals</h1>
+<span id="id1"></span><h1>2. Design goals</h1>
<div class="section" id="suitable-for-constrained-devices">
-<h2>Suitable for constrained devices</h2>
+<h2>2.1. Suitable for constrained devices</h2>
<p>The interface is suitable for a vast range of devices: from special-purpose
cryptographic processors that process data with a built-in key, to constrained
devices running custom application code, such as microcontrollers, and
@@ -70,7 +71,7 @@
free to choose which memory area to use for internal data.</p>
</div>
<div class="section" id="a-keystore-interface">
-<h2>A keystore interface</h2>
+<h2>2.2. A keystore interface</h2>
<p>The specification allows cryptographic operations to be performed on a key to
which the application does not have direct access. Except where required for
interchange, applications access all keys indirectly, by an identifier. The key
@@ -79,7 +80,7 @@
defined when the key is created.</p>
</div>
<div class="section" id="optional-isolation">
-<span id="isolation"></span><h2>Optional isolation</h2>
+<span id="isolation"></span><h2>2.3. Optional isolation</h2>
<p>Implementations can isolate the cryptoprocessor from the calling application,
and can further isolate multiple calling applications. The interface allows the
implementation to be separated between a frontend and a backend. In an isolated
@@ -122,7 +123,7 @@
</ul>
</div>
<div class="section" id="choice-of-algorithms">
-<h2>Choice of algorithms</h2>
+<h2>2.4. Choice of algorithms</h2>
<p>The specification defines a low-level cryptographic interface, where the caller
explicitly chooses which algorithm and which security parameters they use. This
is necessary to implement protocols that are inescapable in various use cases.
@@ -149,7 +150,7 @@
hash algorithm.</p>
</div>
<div class="section" id="ease-of-use">
-<h2>Ease of use</h2>
+<h2>2.5. Ease of use</h2>
<p>The interface is designed to be as user-friendly as possible, given the
aforementioned constraints on suitability for various types of devices and on
the freedom to choose algorithms.</p>
@@ -162,39 +163,39 @@
constraints.</p>
</div>
<div class="section" id="example-use-cases">
-<h2>Example use cases</h2>
+<h2>2.6. Example use cases</h2>
<p>This section lists some of the use cases that were considered during the design
of this API. This list is not exhaustive, nor are all implementations required to
support all use cases.</p>
<div class="section" id="network-security-tls">
-<h3>Network Security (TLS)</h3>
+<h3>2.6.1. Network Security (TLS)</h3>
<p>The API provides all of the cryptographic primitives needed to establish TLS
connections.</p>
</div>
<div class="section" id="secure-storage">
-<h3>Secure Storage</h3>
+<h3>2.6.2. Secure Storage</h3>
<p>The API provides all primitives related to storage encryption, block or
file-based, with master encryption keys stored inside a key store.</p>
</div>
<div class="section" id="network-credentials">
-<h3>Network Credentials</h3>
+<h3>2.6.3. Network Credentials</h3>
<p>The API provides network credential management inside a key store, for example,
for X.509-based authentication or pre-shared keys on enterprise networks.</p>
</div>
<div class="section" id="device-pairing">
-<h3>Device Pairing</h3>
+<h3>2.6.4. Device Pairing</h3>
<p>The API provides support for key agreement protocols that are often used for
secure pairing of devices over wireless channels. For example, the pairing of an
NFC token or a Bluetooth device might use key agreement protocols upon
first use.</p>
</div>
<div class="section" id="secure-boot">
-<h3>Secure Boot</h3>
+<h3>2.6.5. Secure Boot</h3>
<p>The API provides primitives for use during firmware integrity and authenticity
validation, during a secure or trusted boot process.</p>
</div>
<div class="section" id="attestation">
-<h3>Attestation</h3>
+<h3>2.6.6. Attestation</h3>
<p>The API provides primitives used in attestation activities. Attestation is the
ability for a device to sign an array of bytes with a device private key and
return the result to the caller. There are several use cases; ranging from attestation
@@ -203,7 +204,7 @@
algorithms commonly used for attestation.</p>
</div>
<div class="section" id="factory-provisioning">
-<h3>Factory Provisioning</h3>
+<h3>2.6.7. Factory Provisioning</h3>
<p>Most IoT devices receive a unique identity during the factory provisioning
process, or once they have been deployed to the field. This API provides the APIs necessary for
populating a device with keys that represent that identity.</p>
@@ -216,44 +217,51 @@
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
- <div class="sphinxsidebarwrapper">
- <h3><a href="../index.html">Table Of Contents</a></h3>
- <ul>
-<li><a class="reference internal" href="#">Design goals</a><ul>
-<li><a class="reference internal" href="#suitable-for-constrained-devices">Suitable for constrained devices</a></li>
-<li><a class="reference internal" href="#a-keystore-interface">A keystore interface</a></li>
-<li><a class="reference internal" href="#optional-isolation">Optional isolation</a></li>
-<li><a class="reference internal" href="#choice-of-algorithms">Choice of algorithms</a></li>
-<li><a class="reference internal" href="#ease-of-use">Ease of use</a></li>
-<li><a class="reference internal" href="#example-use-cases">Example use cases</a><ul>
-<li><a class="reference internal" href="#network-security-tls">Network Security (TLS)</a></li>
-<li><a class="reference internal" href="#secure-storage">Secure Storage</a></li>
-<li><a class="reference internal" href="#network-credentials">Network Credentials</a></li>
-<li><a class="reference internal" href="#device-pairing">Device Pairing</a></li>
-<li><a class="reference internal" href="#secure-boot">Secure Boot</a></li>
-<li><a class="reference internal" href="#attestation">Attestation</a></li>
-<li><a class="reference internal" href="#factory-provisioning">Factory Provisioning</a></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-<div class="relations">
-<h3>Related Topics</h3>
+ <div class="sphinxsidebarwrapper"><h3><a href="../index.html"><b>PSA Crypto API</b></a></h3>
+IHI 0086<br/>
+Non-confidential<br/>
+Version 1.0.1
+<span style="color: red; font-weight: bold;"></span>
<ul>
- <li><a href="../index.html">Documentation overview</a><ul>
- <li>Previous: <a href="intro.html" title="previous chapter">Introduction</a></li>
- <li>Next: <a href="functionality.html" title="next chapter">Functionality overview</a></li>
- </ul></li>
+<li class="toctree-l1"><a class="reference internal" href="../about.html">About this document</a></li>
</ul>
-</div>
- <div role="note" aria-label="source link">
- <h3>This Page</h3>
- <ul class="this-page-menu">
- <li><a href="../_sources/overview/goals.rst.txt"
- rel="nofollow">Show Source</a></li>
- </ul>
- </div>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="intro.html">1. Introduction</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">2. Design goals</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#suitable-for-constrained-devices">2.1. Suitable for constrained devices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#a-keystore-interface">2.2. A keystore interface</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#optional-isolation">2.3. Optional isolation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#choice-of-algorithms">2.4. Choice of algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#ease-of-use">2.5. Ease of use</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#example-use-cases">2.6. Example use cases</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#network-security-tls">2.6.1. Network Security (TLS)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#secure-storage">2.6.2. Secure Storage</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#network-credentials">2.6.3. Network Credentials</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#device-pairing">2.6.4. Device Pairing</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#secure-boot">2.6.5. Secure Boot</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#attestation">2.6.6. Attestation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#factory-provisioning">2.6.7. Factory Provisioning</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="functionality.html">3. Functionality overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="sample-arch.html">4. Sample architectures</a></li>
+<li class="toctree-l1"><a class="reference internal" href="conventions.html">5. Library conventions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="implementation.html">6. Implementation considerations</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage.html">7. Usage considerations</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api/library/index.html">8. Library management reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api/keys/index.html">9. Key management reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api/ops/index.html">10. Cryptographic operation reference</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../appendix/example_header.html">Example header file</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../appendix/specdef_values.html">Example macro implementations</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../appendix/history.html">Changes to the API</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../psa_c-identifiers.html">Index of API elements</a></li>
+</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
@@ -269,15 +277,12 @@
<div class="clearer"></div>
</div>
<div class="footer">
- © 2019-2020, Arm Limited or its affiliates. All rights reserved.
+ © 2018-2020, Arm Limited or its affiliates. All rights reserved.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.7</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
- |
- <a href="../_sources/overview/goals.rst.txt"
- rel="nofollow">Page source</a>
</div>