Skip to content

Commit 2178250

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 2178250

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

docs/api/security/crypto.md

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

0 commit comments

Comments
 (0)