Skip to content

Commit d932dc8

Browse files
committed
rearrange docs
according to docs sync meeting
1 parent ba9fa33 commit d932dc8

File tree

8 files changed

+103
-5
lines changed

8 files changed

+103
-5
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## PSA Attestation
2+
3+
### Description
4+
5+
TODO: AlexV
6+
7+
8+
### Specification
9+
TODO: AlexV - describe here about APIs and the difference in behavior whether bootlaoder is present or not
10+
11+
PSA specification can be found here [PSA Secure Storage](https://pages.arm.com/PSA-APIs)
12+
13+
### Doxygen
14+
15+
TODO: AlexV - find PSA attestation APIs in doxygen web site once merged - perhaps will be generated over night.
16+
if it is conditionally compiled under some ifdef make sure to add it to doxyfile_options
17+
Once addded Doxygen will be generate - perhaps on next day fix the link below
18+
19+
[![View code](https://www.mbed.com/embed/?type=library)](../mbed-os-api-doxy/psa__prot__internal__storage_8h.html)

docs/api/security/psa_crypto.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## PSA Crypto
2+
3+
### Description
4+
5+
TODO: Jaeden
6+
7+
8+
### Specification
9+
TODO: Jaeden - describe here about APIs being available from NSPE and SPE
10+
about differences in behaviour if any
11+
12+
PSA specification can be found here [PSA Secure Storage](https://pages.arm.com/PSA-APIs)
13+
14+
### Doxygen
15+
16+
TODO: Jaeden - find PSA crypto APIs in doxygen web site. I was not able to find it.
17+
Perhaps MBED_TLS_PSA_CRYPTO_C macro should be added doxyfile_options file so PSA crypto docs will be generated
18+
Once addded Doxygen will be generate - perhaps on next day fix the link below
19+
20+
[![View code](https://www.mbed.com/embed/?type=library)](../mbed-os-api-doxy/psa__prot__internal__storage_8h.html)
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## PSA Internal Storage
2+
3+
### Description
4+
5+
PSA internal storage APIs allows saving and retrieving data from PSA internal flash.
6+
7+
PSA internal storage is implementation varies depending on the target type:
8+
- on single core ARMv7-M target it PSA internal storage APIs are implemented by calling to "default" internal TDBStore instance.
9+
- on PSA targets implementing SPM, PSA internal storage implemented as a secure service. PSA internal storage has access control list,
10+
which makes sure that only the entries created from NSPE will be accessible to it.
11+
12+
### Specification
13+
14+
API specification in mbed-os specific context can be found here: [mbed-os/Storage](../../storage/storage.md)
15+
16+
PSA specification can be found here [PSA Secure Storage](https://pages.arm.com/PSA-APIs)
17+
18+
### Doxygen
19+
20+
[![View code](https://www.mbed.com/embed/?type=library)](../mbed-os-api-doxy/psa__prot__internal__storage_8h.html)
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## PSA Protected Storage
2+
3+
### Description
4+
5+
PSA Protected storage APIs allows saving and retrieving data from PSA protected storage.
6+
7+
Unlike [PSA Internal storage](./psa_internal_storage.md), PSA Protected storage implemented to always run in NSPE side and redirect the calls to KVStore instance.
8+
9+
TODO: Danniel Benor - review and add links to this page from Storage landing page
10+
11+
### Specification
12+
13+
API specification in mbed-os specific context can be found here: [mbed-os/Storage](../../storage/storage.md)
14+
15+
PSA specification can be found here [PSA Secure Storage](https://pages.arm.com/PSA-APIs)
16+
17+
### Doxygen
18+
19+
[![View code](https://www.mbed.com/embed/?type=library)](../mbed-os-api-doxy/protected__storage_8h.html)

docs/api/security/security.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,20 @@
22

33
Security on Arm Mbed OS is divided into the following parts:
44

5-
- Platform Security Architecture (PSA). For information about working with PSA in the context of Mbed OS, please see [Mbed PSA asset protection](../apis/psa-api.html).
5+
- [PSA SPM](./spm.md) - used for accessing secure services within Secure Processing environment (on PSA targets only)
66

7-
For full details, please see the [PSA site](https://developer.arm.com/products/architecture/security-architectures/platform-security-architecture).
7+
- [PSA internal storage](./psa_internal_storage.md) - used to save PSA RoT state
8+
9+
- [PSA protected storage](./psa_protected_storage.md)
10+
11+
- [PSA Crypto](psa_crypto.md)
812

913
- Mbed TLS. For information about working with Mbed TLS in the context of Mbed OS, please see [Connection security through Arm Mbed TLS](../apis/tls.html).
1014

1115
For full details, please see the [Mbed TLS site](https://tls.mbed.org/).
16+
17+
- [[PSA Attestation](psa_attestation.md)
18+
19+
- [PSA Lifecycle](./lifecycle/psa_lifecycle.md)
20+
21+
- [Device Key](./DeviceKey.md)

docs/api/security/spm.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## SPM APIs
2+
3+
### Description
4+
5+
PSA SPM APIs are used for calling Secure Services within Secure Processing environment
6+
7+
### Specification
8+
9+
More details can be found in [Platform Security Architecture - Firmware Framework ](https://pages.arm.com/psa-resources-ff.html)
10+
11+
### Doxygen
12+
13+
[![View code](https://www.mbed.com/embed/?type=library)](../mbed-os-api-doxy/group___s_p_m.html)

docs/api/security/trusted_storage.md

Lines changed: 0 additions & 3 deletions
This file was deleted.
File renamed without changes.

0 commit comments

Comments
 (0)