Skip to content

Commit 5f6ac6d

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 5f6ac6d

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

docs/api/security/crypto.md

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

0 commit comments

Comments
 (0)