Skip to content

Commit 5d75db0

Browse files
committed
README: update
1 parent b085fd4 commit 5d75db0

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
This layer is an OpenEmbedded/Yocto layer dedicated to Post-Quantum Cryptography, providing integration and testing of quantum-safe cryptographic algorithms for embedded Linux systems. It supports OQS (Open Quantum Safe) and Botan.
44

5-
Both OQS and Botan implement the latest NIST-approved Post-Quantum Cryptography (PQC) algorithms:
5+
Both OQS and Botan implement the latest [NIST-approved Post-Quantum Cryptography (PQC) algorithms](https://csrc.nist.gov/projects/post-quantum-cryptography):
66

77
### Public-Key Encryption and Key-Establishment Algorithms
8-
*`CRYSTALS-Kyber`: A lattice-based key encapsulation mechanism (KEM).
8+
* `CRYSTALS-Kyber`: A lattice-based key encapsulation mechanism (KEM).
99

1010
### Digital Signature Algorithms
1111
* `CRYSTALS-Dilithium`: A lattice-based digital signature algorithm.
@@ -20,17 +20,15 @@ For more information, visit the [Open Quantum Safe website](https://openquantums
2020

2121
## Botan
2222

23-
Botan is a cryptographic library written in C++ that provides a wide range of cryptographic algorithms and protocols. It supports both classical and quantum-safe cryptographic algorithms. Botan is designed to be portable and efficient, making it suitable for use in embedded systems. Botan is also recommended by the German Federal Office for Information Security (BSI).
23+
Botan is a cryptographic library written in C++ that provides a wide range of cryptographic algorithms and protocols. It supports both classical and quantum-safe cryptographic algorithms. Botan is designed to be portable and efficient, making it suitable for use in embedded systems. Botan is also [recommended](https://www.bsi.bund.de/EN/Themen/Unternehmen-und-Organisationen/Informationen-und-Empfehlungen/Kryptografie/Kryptobibliothek-Botan/kryptobibliothek-botan_node.html) by the German Federal Office for Information Security (BSI).
2424

2525
For more information, visit the [Botan website](https://botan.randombit.net).
2626

2727
## Build
2828

29-
This layer can be integrated in your layers or built standalone using [kas-tool](https://github.com/siemens/kas):
29+
This layer can be integrated in your layer(s) or built standalone using [kas-tool](https://github.com/siemens/kas):
3030

31-
To Enable PQC you should set:
32-
33-
`DISTRO_FEATURES += "pqc"`
31+
To Enable OpenSSL with PQC support using `oqs-provider` you should set: `DISTRO_FEATURES += "pqc"`
3432

3533
```sh
3634
KAS_MACHINE=<MACHINE> kas build kas-pqc.yml
@@ -45,7 +43,7 @@ KAS_MACHINE=<MACHINE> kas-container build kas-pqc.yml
4543
for example:
4644

4745
```sh
48-
KAS_MACHINE=qemux86-64 kas build kas-pqc.yml'
46+
KAS_MACHINE=qemux86-64 kas build kas-pqc.yml
4947
```
5048

5149
## Run in Qemu

0 commit comments

Comments
 (0)