WolfSSL
/
meta-wolfssl
mirror of https://github.com/wolfSSL/meta-wolfssl.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Fixed README typos and updating documentation.

pull/83/head
msi-debian 2024-04-16 12:38:23 -06:00 committed by night1rider
parent 0a9f2a7d4a
commit 7e6bef3ba0
2 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
recipes-wolfssl/wolfengine/README.md
View File

@ -2,6 +2,8 @@
The `wolfengine` recipe enables the integration of wolfSSL's cryptographic functionalities into OpenSSL through a custom engine mechanism. This integration allows applications using OpenSSL to leverage wolfSSL's advanced cryptographic algorithms, combining wolfSSL's lightweight and performance-optimized cryptography with OpenSSL's extensive API and capabilities. `wolfengine` is designed for easy integration into Yocto-based systems, ensuring a seamless blend of security and performance ideal for embedded and constrained environments.
The `wolfenginetest` yocto package will provide two apps, `wolfengineenv` and `wolfenginetest`. Running `wolfengineenv` will start up a child shell and run `wolfenginetest`. Use `wolfengineenv` to test that the `wolfengine` package is succesfully installed. If you want to run `wolfenginetest` directly you will need to directly source `wolfengineenv` via `source /usr/bin/wolfengineenv` or setup the env on your own, because `wolfenginetest` will fail otherwise. Use `wolfenginetest` to check that your shell env is correctly setup.
## Getting Started
### Prerequisites
@ -36,9 +38,16 @@ The `wolfengine` recipe enables the integration of wolfSSL's cryptographic funct
Modify your image recipe or `local.conf` file to include `wolfengine`, `wolfssl`, `openssl`, `openssl-bin`, and `wolfenginetest`. You will only need `openssl-bin` and `wolfenginetest` if you want to use and test with our included example and conf file.
```bitbake
IMAGE_INSTALL += "wolfengine wolfssl openssl openssl-bin wolfenginetest"
For yocto kirkstone or newer:
```
IMAGE_INSTALL:append = "wolfengine wolfssl openssl openssl-bin wolfenginetest"
```
For yocto dunfell or earlier:
```
IMAGE_INSTALL_append = "wolfengine wolfssl openssl openssl-bin wolfenginetest"
```
4. **Build Your Image**:

13
recipes-wolfssl/wolfprovider/README.md
View File

@ -2,6 +2,8 @@
The `wolfprovider` recipe enables the integration of wolfSSL's cryptographic functionalities into OpenSSL through a custom provider mechanism. This integration allows applications using OpenSSL to leverage wolfSSL's advanced cryptographic algorithms, combining wolfSSL's lightweight and performance-optimized cryptography with OpenSSL's extensive API and capabilities. `wolfprovider` is designed for easy integration into Yocto-based systems, ensuring a seamless blend of security and performance ideal for embedded and constrained environments.
The `wolfprovidertest` yocto package will provide two apps, `wolfproviderenv` and `wolfprovidertest`. Running `wolfproviderenv` will start up a child shell and run `wolfprovidertest`. Use `wolfproviderenv` to test that the `wolfprovider` package is succesfully installed. If you want to run `wolfprovidertest` directly you will need to directly source `wolfproviderenv` via `source /usr/bin/wolfproviderenv` or setup the env on your own, because `wolfprovidertest` will fail otherwise. Use `wolfprovidertest` to check that your shell env is correctly setup.
## Getting Started
### Prerequisites
@ -36,8 +38,15 @@ The `wolfprovider` recipe enables the integration of wolfSSL's cryptographic fun
Modify your image recipe or `local.conf` file to include `wolfprovider`, `wolfssl`, `openssl`, `openssl-bin`, and `wolfprovidertest`. You will only need `openssl-bin` and `wolfprovidertest` if you want to use and test with our included example and conf file.
```bitbake
IMAGE_INSTALL += "wolfprovider wolfssl openssl openssl-bin wolfprovidertest"
For yocto kirkstone or newer:
```
IMAGE_INSTALL:append = "wolfprovider wolfssl openssl openssl-bin wolfprovidertest"
```
For yocto dunfell or earlier:
```
IMAGE_INSTALL_append = "wolfprovider wolfssl openssl openssl-bin wolfprovidertest"
```
4. **Build Your Image**: