TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / mirror / mbed-crypto / 132d88c4436af3a8ad535238788b3c8beb21e29d / . / docs / html / overview / intro.html
blob: e7e6c1429a65edc5369a8473a0a275a923895343 [file] [log] [blame]
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame]8 <title>1. Introduction &#8212; PSA Crypto API 1.0.1 documentation</title>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]9 <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
10 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
11 <script type="text/javascript">
12 var DOCUMENTATION_OPTIONS = {
13 URL_ROOT: '../',
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame]14 VERSION: '1.0.1',
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]15 COLLAPSE_INDEX: false,
16 FILE_SUFFIX: '.html',
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame]17 HAS_SOURCE: false,
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]18 SOURCELINK_SUFFIX: '.txt'
19 };
20 </script>
21 <script type="text/javascript" src="../_static/jquery.js"></script>
22 <script type="text/javascript" src="../_static/underscore.js"></script>
23 <script type="text/javascript" src="../_static/doctools.js"></script>
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame]24 <link rel="author" title="About these documents" href="../about.html" />
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]25 <link rel="index" title="Index" href="../genindex.html" />
26 <link rel="search" title="Search" href="../search.html" />
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame]27 <link rel="next" title="2. Design goals" href="goals.html" />
28 <link rel="prev" title="About this document" href="../about.html" />
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]29
30 <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
31
32 <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
33
34 </head>
35 <body>
36
37
38 <div class="document">
39 <div class="documentwrapper">
40 <div class="bodywrapper">
41 <div class="body" role="main">
42
43 <div class="section" id="introduction">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame]44<h1>1. Introduction</h1>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]45<p>Arm’s Platform Security Architecture (PSA) is a holistic set of threat models,
46security analyses, hardware and firmware architecture specifications, an
47open source firmware reference implementation, and an independent evaluation
48and certification scheme. PSA provides a recipe, based on
49industry best practice, that allows security to be consistently designed in, at
50both a hardware and firmware level.</p>
51<p>The PSA Cryptographic API (Crypto API) described in this document is an
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame]52important PSA component that provides a portable interface to cryptographic operations
53on a wide range of hardware. The interface is user-friendly, while still
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]54providing access to the low-level primitives used in modern cryptography. It
55does not require that the user has access to the key material. Instead, it uses
56opaque key identifiers.</p>
57<p>This document is part of the PSA family of specifications. It defines an
58interface for cryptographic services, including cryptography primitives and a
59key storage functionality.</p>
60<p>This document includes:</p>
61<ul class="simple">
62<li>A <a class="reference internal" href="goals.html#design-goals"><span class="std std-ref">rationale</span></a> for the design.</li>
63<li>A <a class="reference internal" href="functionality.html#functionality-overview"><span class="std std-ref">high-level overview of the functionality</span></a>
64provided by the interface.</li>
65<li>A <a class="reference internal" href="sample-arch.html#architectures"><span class="std std-ref">description of typical architectures</span></a> of
66implementations for this specification.</li>
67<li>General considerations <a class="reference internal" href="implementation.html#implementation-considerations"><span class="std std-ref">for implementers</span></a>
68of this specification and <a class="reference internal" href="usage.html#usage-considerations"><span class="std std-ref">for applications</span></a> that
69use the interface defined in this specification.</li>
70<li>A <a class="reference internal" href="../api/library/index.html#api-reference"><span class="std std-ref">detailed definition</span></a> of the API.</li>
71</ul>
72<p>Companion documents will define <em>profiles</em> for this specification. A profile is
73a minimum mandatory subset of the interface that a compliant implementation must
74provide.</p>
75</div>
76
77
78 </div>
79 </div>
80 </div>
81 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame]82 <div class="sphinxsidebarwrapper"><h3><a href="../index.html"><b>PSA Crypto API</b></a></h3>
83IHI 0086<br/>
84Non-confidential<br/>
85Version 1.0.1
86<span style="color: red; font-weight: bold;"></span>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]87<ul>
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame]88<li class="toctree-l1"><a class="reference internal" href="../about.html">About this document</a></li>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]89</ul>
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame]90<ul class="current">
91<li class="toctree-l1 current"><a class="current reference internal" href="#">1. Introduction</a></li>
92<li class="toctree-l1"><a class="reference internal" href="goals.html">2. Design goals</a></li>
93<li class="toctree-l1"><a class="reference internal" href="functionality.html">3. Functionality overview</a></li>
94<li class="toctree-l1"><a class="reference internal" href="sample-arch.html">4. Sample architectures</a></li>
95<li class="toctree-l1"><a class="reference internal" href="conventions.html">5. Library conventions</a></li>
96<li class="toctree-l1"><a class="reference internal" href="implementation.html">6. Implementation considerations</a></li>
97<li class="toctree-l1"><a class="reference internal" href="usage.html">7. Usage considerations</a></li>
98<li class="toctree-l1"><a class="reference internal" href="../api/library/index.html">8. Library management reference</a></li>
99<li class="toctree-l1"><a class="reference internal" href="../api/keys/index.html">9. Key management reference</a></li>
100<li class="toctree-l1"><a class="reference internal" href="../api/ops/index.html">10. Cryptographic operation reference</a></li>
101</ul>
102<ul>
103<li class="toctree-l1"><a class="reference internal" href="../appendix/example_header.html">Example header file</a></li>
104<li class="toctree-l1"><a class="reference internal" href="../appendix/specdef_values.html">Example macro implementations</a></li>
105<li class="toctree-l1"><a class="reference internal" href="../appendix/history.html">Changes to the API</a></li>
106</ul>
107<ul>
108<li class="toctree-l1"><a class="reference internal" href="../psa_c-identifiers.html">Index of API elements</a></li>
109</ul>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]110<div id="searchbox" style="display: none" role="search">
111 <h3>Quick search</h3>
112 <form class="search" action="../search.html" method="get">
113 <div><input type="text" name="q" /></div>
114 <div><input type="submit" value="Go" /></div>
115 <input type="hidden" name="check_keywords" value="yes" />
116 <input type="hidden" name="area" value="default" />
117 </form>
118</div>
119<script type="text/javascript">$('#searchbox').show(0);</script>
120 </div>
121 </div>
122 <div class="clearer"></div>
123 </div>
124 <div class="footer">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame]125 &copy; 2018-2020, Arm Limited or its affiliates. All rights reserved.
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]126
127 |
128 Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.7</a>
129 &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
130
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]131 </div>
132
133
134
135
136 </body>
137</html>