Skip to content

Commit e3a6fd1

Browse files
Norbert Fabritiusinorick
Norbert Fabritius
authored andcommittedSep 9, 2024·
Update current status in README.md
1 parent 32f5f0f commit e3a6fd1

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed
 

‎README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,7 @@ client.
3232

3333
## Status
3434

35-
__Warning: Heimlig is still under development and is not production ready__.
36-
37-
Heimlig implements common cryptographic algorithms:
35+
Heimlig implements common cryptographic algorithms as software workers:
3836

3937
- Symmetric encryption and decryption
4038
([AES-CBC](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Cipher_block_chaining_(CBC)),
@@ -54,12 +52,16 @@ An [example implementation](examples/stm32h745i/README.md) is available for the
5452
[STM32H745XI](https://www.st.com/en/evaluation-tools/stm32h745i-disco.html) discovery board as well
5553
as for [Linux](examples/linux/README.md) (for development).
5654

57-
Current limitations include:
55+
The code has not yet been independently audited by security experts.
56+
57+
## Deployment
58+
59+
To deploy Heimlig in a bare-metal environment, additional integration with the hardware is required:
5860

59-
- Most cryptographic algorithms are implemented in software only.
60-
- Storage for key material is not persistent yet.
61-
- While safe cross-core communication works, safe cross-MCU has not been demonstrated yet.
62-
- The code has not been independently audited by security experts.
61+
- Chip bring-up and peripheral access
62+
- Async executor (such as [embassy-executor](https://crates.io/crates/embassy-executor))
63+
- Hardware-specific workers for persistent key storage and hardware-accelerated cryptography.
64+
The provided software workers can be used where hardware acceleration is not required.
6365

6466
## Quickstart
6567

0 commit comments

Comments
 (0)
Please sign in to comment.