TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / mirror / mbed-crypto / c2db5f0e443752021c73fb4440a339e2cbc10fb7 / . / docs / html / overview / conventions.html
blob: 0d7a82fc6197039be8f6018f4b7146e88e2c027b [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>5. Library conventions &#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="6. Implementation considerations" href="implementation.html" />
28 <link rel="prev" title="4. Sample architectures" href="sample-arch.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="library-conventions">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]44<h1>5. Library conventions</h1>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]45<div class="section" id="error-handling">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]46<h2>5.1. Error handling</h2>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]47<div class="section" id="return-status">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]48<h3>5.1.1. Return status</h3>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]49<p>Almost all functions return a status indication of type <a class="reference internal" href="../api/library/status.html#c.psa_status_t" title="psa_status_t"><code class="xref any c c-type docutils literal"><span class="pre">psa_status_t</span></code></a>. This
50is an enumeration of integer values, with <code class="docutils literal"><span class="pre">0</span></code> (<a class="reference internal" href="../api/library/status.html#c.PSA_SUCCESS" title="PSA_SUCCESS"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_SUCCESS</span></code></a>) indicating
51successful operation and other values indicating errors. The exceptions are
52functions which only access objects that are intended to be implemented as
53simple data structures. Such functions cannot fail and either return
54<code class="docutils literal"><span class="pre">void</span></code> or a data value.</p>
55<p>Unless specified otherwise, if multiple error conditions apply, an
56implementation is free to return any of the applicable error codes. The choice
57of error code is considered an implementation quality issue. Different
58implementations can make different choices, for example to favor code size over
59ease of debugging or vice versa.</p>
60<p>If the behavior is undefined, for example, if a function receives an invalid
61pointer as a parameter, this specification makes no guarantee that the function
62will return an error. Implementations are encouraged to return an error or halt
63the application in a manner that is appropriate for the platform if the
64undefined behavior condition can be detected. However, application developers need to be aware that undefined behavior conditions cannot be detected in general.</p>
65</div>
66<div class="section" id="behavior-on-error">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]67<h3>5.1.2. Behavior on error</h3>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]68<p>All function calls must be implemented atomically:</p>
69<ul class="simple">
70<li>When a function returns a type other than <a class="reference internal" href="../api/library/status.html#c.psa_status_t" title="psa_status_t"><code class="xref any c c-type docutils literal"><span class="pre">psa_status_t</span></code></a>, the requested
71action has been carried out.</li>
72<li>When a function returns the status <a class="reference internal" href="../api/library/status.html#c.PSA_SUCCESS" title="PSA_SUCCESS"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_SUCCESS</span></code></a>, the requested action has
73been carried out.</li>
74<li>When a function returns another status of type <a class="reference internal" href="../api/library/status.html#c.psa_status_t" title="psa_status_t"><code class="xref any c c-type docutils literal"><span class="pre">psa_status_t</span></code></a>, no action
75has been carried out. The content of the output parameters is undefined, but
76otherwise the state of the system has not changed, except as described below.</li>
77</ul>
78<p>In general, functions that modify the system state, for example, creating or
79destroying a key, must leave the system state unchanged if they return an error
80code. There are specific conditions that can result in different behavior:</p>
81<ul class="simple">
82<li>The status <a class="reference internal" href="../api/library/status.html#c.PSA_ERROR_BAD_STATE" title="PSA_ERROR_BAD_STATE"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_ERROR_BAD_STATE</span></code></a> indicates that a parameter was not in a
83valid state for the requested action. This parameter might have been modified
84by the call and is now in an undefined state. The only valid action on an
85object in an undefined state is to abort it with the appropriate
86<code class="docutils literal"><span class="pre">psa_abort_xxx()</span></code> function.</li>
87<li>The status <a class="reference internal" href="../api/library/status.html#c.PSA_ERROR_INSUFFICIENT_DATA" title="PSA_ERROR_INSUFFICIENT_DATA"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_ERROR_INSUFFICIENT_DATA</span></code></a> indicates that a key
88derivation object has reached its maximum capacity. The key derivation
89operation might have been modified by the call. Any further attempt to obtain
90output from the key derivation operation will return
91<a class="reference internal" href="../api/library/status.html#c.PSA_ERROR_INSUFFICIENT_DATA" title="PSA_ERROR_INSUFFICIENT_DATA"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_ERROR_INSUFFICIENT_DATA</span></code></a>.</li>
92<li>The status <a class="reference internal" href="../api/library/status.html#c.PSA_ERROR_COMMUNICATION_FAILURE" title="PSA_ERROR_COMMUNICATION_FAILURE"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_ERROR_COMMUNICATION_FAILURE</span></code></a> indicates that the
93communication between the application and the cryptoprocessor has broken
94down. In this case, the cryptoprocessor must either finish the requested
95action successfully, or interrupt the action and roll back the system to its
96original state. Because it is often impossible to report the outcome to the
97application after a communication failure, this specification does not
98provide a way for the application to determine whether the action was
99successful.</li>
100<li>The statuses <a class="reference internal" href="../api/library/status.html#c.PSA_ERROR_STORAGE_FAILURE" title="PSA_ERROR_STORAGE_FAILURE"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_ERROR_STORAGE_FAILURE</span></code></a>, <a class="reference internal" href="../api/library/status.html#c.PSA_ERROR_DATA_CORRUPT" title="PSA_ERROR_DATA_CORRUPT"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_ERROR_DATA_CORRUPT</span></code></a>, <a class="reference internal" href="../api/library/status.html#c.PSA_ERROR_HARDWARE_FAILURE" title="PSA_ERROR_HARDWARE_FAILURE"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_ERROR_HARDWARE_FAILURE</span></code></a>
101and <a class="reference internal" href="../api/library/status.html#c.PSA_ERROR_CORRUPTION_DETECTED" title="PSA_ERROR_CORRUPTION_DETECTED"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_ERROR_CORRUPTION_DETECTED</span></code></a> might indicate data corruption in the
102system state. When a function returns one of these statuses, the system state
103might have changed from its previous state before the function call, even
104though the function call failed.</li>
105<li>Some system states cannot be rolled back, for example, the internal state of
106the random number generator or the content of access logs.</li>
107</ul>
108<p>Unless otherwise documented, the content of output parameters is not defined
109when a function returns a status other than <a class="reference internal" href="../api/library/status.html#c.PSA_SUCCESS" title="PSA_SUCCESS"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_SUCCESS</span></code></a>. It is recommended
110that implementations set output parameters to safe defaults to avoid leaking
111confidential data and limit risk, in case an application does not properly
112handle all errors.</p>
113</div>
114</div>
115<div class="section" id="parameter-conventions">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]116<h2>5.2. Parameter conventions</h2>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]117<div class="section" id="pointer-conventions">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]118<h3>5.2.1. Pointer conventions</h3>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]119<p>Unless explicitly stated in the documentation of a function, all pointers must
120be valid pointers to an object of the specified type.</p>
121<p>A parameter is considered a <strong>buffer</strong> if it points to an array of bytes. A
122buffer parameter always has the type <code class="docutils literal"><span class="pre">uint8_t</span> <span class="pre">*</span></code> or <code class="docutils literal"><span class="pre">const</span> <span class="pre">uint8_t</span> <span class="pre">*</span></code>, and
123always has an associated parameter indicating the size of the array. Note that a
124parameter of type <code class="docutils literal"><span class="pre">void</span> <span class="pre">*</span></code> is never considered a buffer.</p>
125<p>All parameters of pointer type must be valid non-null pointers, unless the
126pointer is to a buffer of length <code class="docutils literal"><span class="pre">0</span></code> or the function’s documentation
127explicitly describes the behavior when the pointer is null. Passing a null
128pointer as a function parameter in other cases is expected to abort the caller
129on implementations where this is the normal behavior for a null pointer
130dereference.</p>
131<p>Pointers to input parameters can be in read-only memory. Output parameters must
132be in writable memory. Output parameters that are not buffers must also be
133readable, and the implementation must be able to write to a non-buffer output
134parameter and read back the same value, as explained in the
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]135<a class="reference internal" href="#stability-of-parameters"><span class="secref">Stability of parameters</span></a> section.</p>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]136</div>
137<div class="section" id="input-buffer-sizes">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]138<h3>5.2.2. Input buffer sizes</h3>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]139<p>For input buffers, the parameter convention is:</p>
140<dl class="docutils">
141<dt><code class="docutils literal"><span class="pre">const</span> <span class="pre">uint8_t</span> <span class="pre">*foo</span></code></dt>
142<dd>Pointer to the first byte of the data. The pointer
143can be invalid if the buffer size is <code class="docutils literal"><span class="pre">0</span></code>.</dd>
144<dt><code class="docutils literal"><span class="pre">size_t</span> <span class="pre">foo_length</span></code></dt>
145<dd>Size of the buffer in bytes.</dd>
146</dl>
147<p>The interface never uses input-output buffers.</p>
148</div>
149<div class="section" id="output-buffer-sizes">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]150<h3>5.2.3. Output buffer sizes</h3>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]151<p>For output buffers, the parameter convention is:</p>
152<dl class="docutils">
153<dt><code class="docutils literal"><span class="pre">uint8_t</span> <span class="pre">*foo</span></code></dt>
154<dd>Pointer to the first byte of the data. The pointer can be
155invalid if the buffer size is <code class="docutils literal"><span class="pre">0</span></code>.</dd>
156<dt><code class="docutils literal"><span class="pre">size_t</span> <span class="pre">foo_size</span></code></dt>
157<dd>The size of the buffer in bytes.</dd>
158<dt><code class="docutils literal"><span class="pre">size_t</span> <span class="pre">*foo_length</span></code></dt>
159<dd>On successful return, contains the length of the
160output in bytes.</dd>
161</dl>
162<p>The content of the data buffer and of <code class="docutils literal"><span class="pre">*foo_length</span></code> on errors is unspecified,
163unless explicitly mentioned in the function description. They might be unmodified
164or set to a safe default. On successful completion, the content of the buffer
165between the offsets <code class="docutils literal"><span class="pre">*foo_length</span></code> and <code class="docutils literal"><span class="pre">foo_size</span></code> is also unspecified.</p>
166<p>Functions return <a class="reference internal" href="../api/library/status.html#c.PSA_ERROR_BUFFER_TOO_SMALL" title="PSA_ERROR_BUFFER_TOO_SMALL"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_ERROR_BUFFER_TOO_SMALL</span></code></a> if the buffer size is
167insufficient to carry out the requested operation. The interface defines macros
168to calculate a sufficient buffer size for each operation that has an output
169buffer. These macros return compile-time constants if their arguments are
170compile-time constants, so they are suitable for static or stack allocation.
171Refer to an individual function’s documentation for the associated output size
172macro.</p>
173<p>Some functions always return exactly as much data as the size of the output
174buffer. In this case, the parameter convention changes to:</p>
175<dl class="docutils">
176<dt><code class="docutils literal"><span class="pre">uint8_t</span> <span class="pre">*foo</span></code></dt>
177<dd>Pointer to the first byte of the output. The pointer can be
178invalid if the buffer size is <code class="docutils literal"><span class="pre">0</span></code>.</dd>
179<dt><code class="docutils literal"><span class="pre">size_t</span> <span class="pre">foo_length</span></code></dt>
180<dd>The number of bytes to return in <code class="docutils literal"><span class="pre">foo</span></code> if
181successful.</dd>
182</dl>
183</div>
184<div class="section" id="overlap-between-parameters">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]185<h3>5.2.4. Overlap between parameters</h3>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]186<p>Output parameters that are not buffers must not overlap with any input buffer or
187with any other output parameter. Otherwise, the behavior is undefined.</p>
188<p>Output buffers can overlap with input buffers. In this event, the implementation
189must return the same result as if the buffers did not overlap. The
190implementation must behave as if it had copied all the inputs into temporary
191memory, as far as the result is concerned. However, it is possible that overlap
192between parameters will affect the performance of a function call. Overlap might
193also affect memory management security if the buffer is located in memory that
194the caller shares with another security context, as described in the
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]195<a class="reference internal" href="#stability-of-parameters"><span class="secref">Stability of parameters</span></a> section.</p>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]196</div>
197<div class="section" id="stability-of-parameters">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]198<span id="id1"></span><h3>5.2.5. Stability of parameters</h3>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]199<p>In some environments, it is possible for the content of a parameter to change
200while a function is executing. It might also be possible for the content of an
201output parameter to be read before the function terminates. This can happen if
202the application is multithreaded. In some implementations, memory can be shared
203between security contexts, for example, between tasks in a multitasking
204operating system, between a user land task and the kernel, or between the
205Non-secure world and the Secure world of a trusted execution environment.</p>
206<p>This section describes the assumptions that an implementation can make about
207function parameters, and the guarantees that the implementation must provide
208about how it accesses parameters.</p>
209<p>Parameters that are not buffers are assumed to be under the caller’s full
210control. In a shared memory environment, this means that the parameter must be
211in memory that is exclusively accessible by the application. In a multithreaded
212environment, this means that the parameter must not be modified during the
213execution, and the value of an output parameter is undetermined until the
214function returns. The implementation can read an input parameter that is not a
215buffer multiple times and expect to read the same data. The implementation can
216write to an output parameter that is not a buffer and expect to read back the
217value that it last wrote. The implementation has the same permissions on buffers
218that overlap with a buffer in the opposite direction.</p>
219<p>In an environment with multiple threads or with shared memory, the
220implementation carefully accesses non-overlapping buffer parameters in order to
221prevent any security risk resulting from the content of the buffer being
222modified or observed during the execution of the function. In an input buffer
223that does not overlap with an output buffer, the implementation reads each byte
224of the input once, at most. The implementation does not read from an output
225buffer that does not overlap with an input buffer. Additionally, the
226implementation does not write data to a non-overlapping output buffer if this
227data is potentially confidential and the implementation has not yet verified
228that outputting this data is authorized.</p>
229<p>Unless otherwise specified, the implementation must not keep a reference to any
230parameter once a function call has returned.</p>
231</div>
232</div>
233<div class="section" id="key-types-and-algorithms">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]234<h2>5.3. Key types and algorithms</h2>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]235<p>Types of cryptographic keys and cryptographic algorithms are encoded separately.
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]236Each is encoded by using an integral type: <a class="reference internal" href="../api/keys/types.html#c.psa_key_type_t" title="psa_key_type_t"><code class="xref any c c-type docutils literal"><span class="pre">psa_key_type_t</span></code></a> and
237<a class="reference internal" href="../api/ops/algorithms.html#c.psa_algorithm_t" title="psa_algorithm_t"><code class="xref any c c-type docutils literal"><span class="pre">psa_algorithm_t</span></code></a>, respectively.</p>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]238<p>There is some overlap in the information conveyed by key types and algorithms.
239Both types contain enough information, so that the meaning of an algorithm type
240value does not depend on what type of key it is used with, and vice versa.
241However, the particular instance of an algorithm might depend on the key type. For
242example, the algorithm <a class="reference internal" href="../api/ops/aead.html#c.PSA_ALG_GCM" title="PSA_ALG_GCM"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_ALG_GCM</span></code></a> can be instantiated as any AEAD algorithm
243using the GCM mode over a block cipher. The underlying block cipher is
244determined by the key type.</p>
245<p>Key types do not encode the key size. For example, AES-128, AES-192 and AES-256
246share a key type <a class="reference internal" href="../api/keys/types.html#c.PSA_KEY_TYPE_AES" title="PSA_KEY_TYPE_AES"><code class="xref any c c-macro docutils literal"><span class="pre">PSA_KEY_TYPE_AES</span></code></a>.</p>
247<div class="section" id="structure-of-key-and-algorithm-types">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]248<h3>5.3.1. Structure of key and algorithm types</h3>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]249<p>Both types use a partial bitmask structure, which allows the analysis and
250building of values from parts. However, the interface defines constants, so that
251applications do not need to depend on the encoding, and an implementation might
252only care about the encoding for code size optimization.</p>
253<p>The encodings follows a few conventions:</p>
254<ul class="simple">
255<li>The highest bit is a vendor flag. Current and future versions of this
256specification will only define values where this bit is clear.
257Implementations that wish to define additional implementation-specific values
258must use values where this bit is set, to avoid conflicts with future
259versions of this specification.</li>
260<li>The next few highest bits indicate the corresponding algorithm category:
261hash, MAC, symmetric cipher, asymmetric encryption, and so on.</li>
262<li>The following bits identify a family of algorithms in a category-dependent
263manner.</li>
264<li>In some categories and algorithm families, the lowest-order bits indicate a
265variant in a systematic way. For example, algorithm families that are
266parametrized around a hash function encode the hash in the 8 lowest bits.</li>
267</ul>
268</div>
269</div>
270<div class="section" id="concurrent-calls">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]271<span id="concurrency"></span><h2>5.4. Concurrent calls</h2>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]272<p>In some environments, an application can make calls to the PSA crypto API in
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]273separate threads. In such an environment, <em>concurrent calls</em> are two or more
274calls to the API whose execution can overlap in time.</p>
275<p>Concurrent calls are performed correctly, as if the calls were executed in
276sequence, provided that they obey the following constraints:</p>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]277<ul class="simple">
278<li>There is no overlap between an output parameter of one call and an input or
279output parameter of another call. Overlap between input parameters is
280permitted.</li>
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]281<li>A call to destroy a key must not overlap with a concurrent call to any of
282the following functions:<ul>
283<li>Any call where the same key identifier is a parameter to the call.</li>
284<li>Any call in a multi-part operation, where the same key identifier was
285used as a parameter to a previous step in the multi-part operation.</li>
286</ul>
287</li>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]288<li>Concurrent calls must not use the same operation object.</li>
289</ul>
290<p>If any of these constraints are violated, the behavior is undefined.</p>
291<p>If the application modifies an input parameter while a function call is in
292progress, the behavior is undefined.</p>
293<p>Individual implementations can provide additional guarantees.</p>
294</div>
295</div>
296
297
298 </div>
299 </div>
300 </div>
301 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]302 <div class="sphinxsidebarwrapper"><h3><a href="../index.html"><b>PSA Crypto API</b></a></h3>
303IHI 0086<br/>
304Non-confidential<br/>
305Version 1.0.1
306<span style="color: red; font-weight: bold;"></span>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]307<ul>
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]308<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]309</ul>
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]310<ul class="current">
311<li class="toctree-l1"><a class="reference internal" href="intro.html">1. Introduction</a></li>
312<li class="toctree-l1"><a class="reference internal" href="goals.html">2. Design goals</a></li>
313<li class="toctree-l1"><a class="reference internal" href="functionality.html">3. Functionality overview</a></li>
314<li class="toctree-l1"><a class="reference internal" href="sample-arch.html">4. Sample architectures</a></li>
315<li class="toctree-l1 current"><a class="current reference internal" href="#">5. Library conventions</a><ul>
316<li class="toctree-l2"><a class="reference internal" href="#error-handling">5.1. Error handling</a><ul>
317<li class="toctree-l3"><a class="reference internal" href="#return-status">5.1.1. Return status</a></li>
318<li class="toctree-l3"><a class="reference internal" href="#behavior-on-error">5.1.2. Behavior on error</a></li>
319</ul>
320</li>
321<li class="toctree-l2"><a class="reference internal" href="#parameter-conventions">5.2. Parameter conventions</a><ul>
322<li class="toctree-l3"><a class="reference internal" href="#pointer-conventions">5.2.1. Pointer conventions</a></li>
323<li class="toctree-l3"><a class="reference internal" href="#input-buffer-sizes">5.2.2. Input buffer sizes</a></li>
324<li class="toctree-l3"><a class="reference internal" href="#output-buffer-sizes">5.2.3. Output buffer sizes</a></li>
325<li class="toctree-l3"><a class="reference internal" href="#overlap-between-parameters">5.2.4. Overlap between parameters</a></li>
326<li class="toctree-l3"><a class="reference internal" href="#stability-of-parameters">5.2.5. Stability of parameters</a></li>
327</ul>
328</li>
329<li class="toctree-l2"><a class="reference internal" href="#key-types-and-algorithms">5.3. Key types and algorithms</a><ul>
330<li class="toctree-l3"><a class="reference internal" href="#structure-of-key-and-algorithm-types">5.3.1. Structure of key and algorithm types</a></li>
331</ul>
332</li>
333<li class="toctree-l2"><a class="reference internal" href="#concurrent-calls">5.4. Concurrent calls</a></li>
334</ul>
335</li>
336<li class="toctree-l1"><a class="reference internal" href="implementation.html">6. Implementation considerations</a></li>
337<li class="toctree-l1"><a class="reference internal" href="usage.html">7. Usage considerations</a></li>
338<li class="toctree-l1"><a class="reference internal" href="../api/library/index.html">8. Library management reference</a></li>
339<li class="toctree-l1"><a class="reference internal" href="../api/keys/index.html">9. Key management reference</a></li>
340<li class="toctree-l1"><a class="reference internal" href="../api/ops/index.html">10. Cryptographic operation reference</a></li>
341</ul>
342<ul>
343<li class="toctree-l1"><a class="reference internal" href="../appendix/example_header.html">Example header file</a></li>
344<li class="toctree-l1"><a class="reference internal" href="../appendix/specdef_values.html">Example macro implementations</a></li>
345<li class="toctree-l1"><a class="reference internal" href="../appendix/history.html">Changes to the API</a></li>
346</ul>
347<ul>
348<li class="toctree-l1"><a class="reference internal" href="../psa_c-identifiers.html">Index of API elements</a></li>
349</ul>
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]350<div id="searchbox" style="display: none" role="search">
351 <h3>Quick search</h3>
352 <form class="search" action="../search.html" method="get">
353 <div><input type="text" name="q" /></div>
354 <div><input type="submit" value="Go" /></div>
355 <input type="hidden" name="check_keywords" value="yes" />
356 <input type="hidden" name="area" value="default" />
357 </form>
358</div>
359<script type="text/javascript">$('#searchbox').show(0);</script>
360 </div>
361 </div>
362 <div class="clearer"></div>
363 </div>
364 <div class="footer">
Gilles Peskinec2db5f02021-01-18 20:36:53 +0100[diff] [blame^]365 &copy; 2018-2020, Arm Limited or its affiliates. All rights reserved.
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]366
367 |
368 Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.7</a>
369 &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
370
Gilles Peskine6c723a22020-04-17 16:57:52 +0200[diff] [blame]371 </div>
372
373
374
375
376 </body>
377</html>