Skip to content

Commit 6edfdb9

Browse files
night1ridercfriedt
authored andcommitted
doc: develop: manifests: external: add wolfSSL
Add documentation to external module section for adding wolfSSL to Zephyr Signed-off-by: Zackery Backman <[email protected]>
1 parent 3559dd9 commit 6edfdb9

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
.. _external_module_wolfssl:
2+
3+
wolfSSL
4+
#######
5+
6+
Introduction
7+
************
8+
9+
wolfSSL is a lightweight, portable SSL/TLS library optimized for embedded systems, RTOS environments, and resource-constrained devices. It offers a range of cryptographic functions, and secure communication protocols (up to TLS 1.3 and DTLS 1.3) along with post-quantum cryptography support. Its support for multiple build configurations makes it suitable for a wide range of applications and hardware platforms that are utilizing the Zephyr RTOS.
10+
11+
wolfSSL has support for the Zephyr networking stack so applications can use the wolfSSL API to establish secure connections with other devices or services over the network.
12+
13+
wolfSSL is dual licensed under GPLv3 and commercial licenses.
14+
15+
GitHub Repository: `wolfSSL Repository`_
16+
17+
Usage with Zephyr
18+
*****************
19+
20+
Add wolfssl as a project to your west.yml:
21+
22+
.. code-block:: yaml
23+
24+
manifest:
25+
remotes:
26+
# <your other remotes>
27+
- name: wolfssl
28+
url-base: https://github.com/wolfssl
29+
projects:
30+
# <your other projects>
31+
- name: wolfssl
32+
path: modules/crypto/wolfssl
33+
revision: master
34+
remote: wolfssl
35+
36+
Update west's modules:
37+
38+
.. code-block:: bash
39+
40+
west update
41+
42+
Now west recognizes ``wolfssl`` as a module, and will include its Kconfig and
43+
CMakeLists.txt in the build system.
44+
45+
For more regarding the usage of wolfSSL with Zephyr, please refer to the `wolfSSL Zephyr Example Usage`_.
46+
47+
For application code examples in Zephyr, please refer to the `wolfSSL NXP AppCodeHub`_.
48+
49+
For wolfSSL API documentation, please refer to the `wolfSSL Documentation`_.
50+
51+
Reference
52+
*********
53+
54+
.. target-notes::
55+
56+
.. _wolfssl Repository:
57+
https://github.com/wolfSSL/wolfssl
58+
59+
.. _wolfSSL Zephyr Example Usage:
60+
https://github.com/wolfSSL/wolfssl/blob/master/zephyr/README.md#build-and-run-wolfcrypt-benchmark-application
61+
62+
.. _wolfSSL NXP AppCodeHub:
63+
https://github.com/wolfSSL/nxp-appcodehub
64+
65+
.. _wolfSSL Documentation:
66+
https://www.wolfssl.com/docs/

0 commit comments

Comments
 (0)