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