Skip to content

Commit f262e69

Browse files
committed
crypto: Add Crypto API documentation
Add a Crypto API page which gives an overview of Mbed Crypto, links to the PSA Crypto API specification, links to the Crypto repo and its documents, and explains a bit about how Mbed Crypto is integrated with Mbed OS for boards with secure environments.
1 parent 7413ebd commit f262e69

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

docs/api/security/crypto.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
## Mbed Crypto
2+
3+
Arm Mbed Crypto is the reference implementation of the cryptography interface
4+
of the Arm Platform Security Architecture (PSA).
5+
6+
<span class="notes">**Note:** The version of Mbed Crypto shipping with Mbed OS
7+
is a preview release of Mbed Crypto, provided for evaluation purposes only. Its
8+
contents may change in the next release.</span>
9+
10+
We have adapted and [integrated Mbed Crypto with Mbed
11+
OS](https://github.com/ARMmbed/mbed-os/blob/master/features/mbedtls/mbedcrypto).
12+
On PSA platforms that support it, Mbed Crypto comes integrated with Mbed OS to
13+
leverage the platform's segmented architecture and isolate cryptographic keys
14+
and operations from applications.
15+
16+
You can import Mbed Crypto from its standalone
17+
[release](https://github.com/ARMmbed/mbed-crypto). Mbed Crypto as integrated
18+
with Mbed OS does not include all test code or scripts used in the development
19+
of the library. You can find all of these in the standalone release.
20+
21+
<span class="notes">**Note:** Mbed Crypto, like Mbed TLS, needs a secure source
22+
of random numbers; make sure that your target board has one and that it is
23+
fully ported to Arm Mbed OS. You can read more about this in our [porting
24+
guide](../contributing/index.html).</span>
25+
26+
### Configuring Mbed Crypto features
27+
28+
The Mbed TLS configuration system configures Mbed Crypto. Please refer to [Mbed
29+
TLS documentation for how to configure Mbed TLS and Mbed
30+
Crypto](../apis/tls.html#configuring-mbed-tls-features).
31+
32+
### Mbed Crypto examples
33+
34+
[![View code](https://github.com/ARMmbed/mbed-os-example-mbed-crypto/)](https://github.com/ARMmbed/mbed-os-example-mbed-crypto/blob/master/main.cpp)
35+
36+
[The Mbed Crypto
37+
example](https://github.com/ARMmbed/mbed-os-example-mbed-crypto) covers some
38+
basic use of the PSA Crypto API as well as factory entropy injection.
39+
40+
For further information, refer to the readme file in [the example
41+
repository](https://github.com/ARMmbed/mbed-os-example-mbed-crypto).
42+
43+
### Other resources
44+
45+
The [Mbed Crypto project homepage on
46+
GitHub](https://github.com/ARMmbed/mbed-crypto) contains the following
47+
resources:
48+
49+
- [An overview of the PSA Crypto
50+
API](https://github.com/ARMmbed/mbed-crypto/blob/psa-api-1.0-beta/docs/PSA_Crypto_API_Overview.pdf).
51+
- [The PSA Crypto API
52+
reference](https://github.com/ARMmbed/mbed-crypto/blob/psa-api-1.0-beta/docs/PSA_Crypto_API_Reference.pdf).
53+
- [Other general developer
54+
documentation](https://github.com/ARMmbed/mbed-crypto/tree/development/docs).

0 commit comments

Comments
 (0)