Skip to content

crypto: Add Crypto API documentation #983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 7, 2019
Merged

crypto: Add Crypto API documentation #983

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/api/security/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## Mbed Crypto

Arm Mbed Crypto is the reference implementation of the cryptography interface
of the Arm Platform Security Architecture (PSA).

<span class="notes">**Note:** The version of Mbed Crypto shipping with Mbed OS
implements PSA Crypto API v1.0b1.</span>

We have adapted and [integrated Mbed Crypto with Mbed
OS](https://github.com/ARMmbed/mbed-os/blob/master/features/mbedtls/mbed-crypto).
On PSA platforms that support it, Mbed Crypto comes integrated with Mbed OS to
leverage the platform's segmented architecture and isolate cryptographic keys
and operations from applications.

You can import Mbed Crypto from its standalone
[release](https://github.com/ARMmbed/mbed-crypto). Mbed Crypto as integrated
with Mbed OS does not include all test code or scripts used in the development
of the library. You can find all of these in the standalone release.

<span class="notes">**Note:** Mbed Crypto, like Mbed TLS, needs a secure source
of random numbers; make sure that your target board has one and that it is
fully ported to Arm Mbed OS. You can read more about this in our [porting
guide](../contributing/index.html).</span>

### Configuring Mbed Crypto features

The Mbed TLS configuration system configures Mbed Crypto. Please refer to [Mbed
TLS documentation for how to configure Mbed TLS and Mbed
Crypto](../apis/tls.html#configuring-mbed-tls-features).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the extra line between sections.

### Mbed Crypto examples

[![View code](https://github.com/ARMmbed/mbed-os-example-mbed-crypto/)](https://github.com/ARMmbed/mbed-os-example-mbed-crypto/blob/master/main.cpp)

[The Mbed Crypto
example](https://github.com/ARMmbed/mbed-os-example-mbed-crypto) covers some
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please transclude this example into our docs using this format:

[![View code](https://github.com/ARMmbed/mbed-os-example-mbed-crypto/)](https://github.com/ARMmbed/mbed-os-example-mbed-crypto/blob/master/main.cpp)

basic use of the PSA Crypto API as well as factory entropy injection.

For further information, refer to the readme file in [the example
repository](https://github.com/ARMmbed/mbed-os-example-mbed-crypto).

### Other resources

The [Mbed Crypto project homepage on
GitHub](https://github.com/ARMmbed/mbed-crypto) contains the following
resources:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a line after the colon, so the bullets render properly. Then, please add a period at the end of each bullet. (I'd make these changes myself, but I still can't edit your PR directly.)


- [An overview of the PSA Crypto
API](https://github.com/ARMmbed/mbed-crypto/blob/psa-api-1.0-beta/docs/PSA_Crypto_API_Overview.pdf).
- [The PSA Crypto API
reference](https://github.com/ARMmbed/mbed-crypto/blob/psa-api-1.0-beta/docs/PSA_Crypto_API_Reference.pdf).
- [Other general developer
documentation](https://github.com/ARMmbed/mbed-crypto/tree/development/docs).