Skip to content

wolfssl 5.7.6 Release for Arduino #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 4, 2025
Merged

Conversation

gojimmypi
Copy link
Contributor

@gojimmypi gojimmypi commented Jan 27, 2025

wolfSSL Release 5.7.6 (Dec 31, 2024)

The published version of wolfSSL for Arduino when running wolfssl-arduino.sh for wolfSSL v5.7. 6:

wolfssl-arduino.sh INSTALL /mnt/c/workspace/Arduino-wolfSSL-$USER

NOTE:

This release is based on a branch with minor post-release updates. See: wolfSSL/wolfssl#8381 and wolfSSL/wolfssl#8384 that mainly improved visibility to tips on wolfSSL user settings customization, in particular:

/* wolfSSL user_settings.h must be included from settings.h
 * Make all configurations changes in user_settings.h
 * Do not edit wolfSSL `settings.h` or `config.h` files.
 * Do not explicitly include user_settings.h in any source code.
 * Each Arduino sketch that uses wolfSSL must have: #include "wolfssl.h"
 * C/C++ source files can use: #include <wolfssl/wolfcrypt/settings.h>
 * The wolfSSL "settings.h" must be included in each source file using wolfSSL.
 * The wolfSSL "settings.h" must be listed before any other wolfSSL include.
 */

Log:

$ git status
On branch pr-post-release-239b85c80-arduino
Your branch is up to date with 'origin/pr-post-release-239b85c80-arduino'.

nothing to commit, working tree clean
gojimmypi:/mnt/c/workspace/wolfssl-master/IDE/ARDUINO
$ ./wolfssl-arduino.sh INSTALL /mnt/c/workspace/Arduino-wolfSSL-gojimmypi
The Arduino library root is: /mnt/c/Users/gojimmypi/Documents/Arduino/libraries
Install is active.
Installing to /mnt/c/workspace/Arduino-wolfSSL-gojimmypi
Target is a GitHub root repository.
Found wolfSSL version 5.7.6
# WOLFSSL_VERSION_ARUINO_SUFFIX

Step 01: mkdir ./wolfssl
Step 02: mkdir ./wolfssl/src
Step 03: mkdir ./wolfssl/src/wolfssl
Step 04: cp    ../../wolfssl/*.h              ./wolfssl/src/wolfssl
Step 05: mkdir ./wolfssl/src/wolfssl/wolfcrypt
Step 06: cp    ../../wolfssl/wolfcrypt/*.h    ./wolfssl/src/wolfssl/wolfcrypt
Step 07: mkdir ./wolfssl/src/wolfcrypt
Step 08: mkdir ./wolfssl/src/wolfcrypt/src
Step 09: cp    ../../wolfcrypt/src/*.c        ./wolfssl/src/wolfcrypt/src
Step 10: mkdir ./wolfssl/src/src
Copy examples....
Copy wolfssl_client example....
Copy wolfssl_server example....
Copy wolfssl_server example....
Step 11: Final root file copy
Step 12: Workspace to publish:

# Arduino wolfSSL Library

This library is restructured from [wolfSSL](https://github.com/wolfSSL/wolfssl/) Release 5.7.6 for the Arduino platform.

total 348
drwxr-xr-x 1 gojimmypi gojimmypi    512 Jan 27 11:03 .
drwxrwxrwx 1 gojimmypi gojimmypi    512 Jan 27 11:03 ..
-rw-r--r-- 1 gojimmypi gojimmypi    173 Jan 27 11:03 .editorconfig
-rw-r--r-- 1 gojimmypi gojimmypi  11099 Jan 27 11:03 .gitignore
-rw-r--r-- 1 gojimmypi gojimmypi  18092 Jan 27 11:03 COPYING
-rw-r--r-- 1 gojimmypi gojimmypi 287788 Jan 27 11:03 ChangeLog.md
-rw-r--r-- 1 gojimmypi gojimmypi    469 Jan 27 11:03 LICENSING
-rw-r--r-- 1 gojimmypi gojimmypi  10902 Jan 27 11:03 README
-rw-r--r-- 1 gojimmypi gojimmypi  15953 Jan 27 11:03 README.md
drwxr-xr-x 1 gojimmypi gojimmypi    512 Jan 27 11:03 examples
-rw-r--r-- 1 gojimmypi gojimmypi    623 Jan 27 11:03 keywords.txt
-rw-r--r-- 1 gojimmypi gojimmypi    373 Jan 27 11:03 library.properties
drwxr-xr-x 1 gojimmypi gojimmypi    512 Jan 27 11:03 src

Config:
cp ../../examples/configs/user_settings_arduino.h  ./wolfssl/src/user_settings.h
#define WOLFSSL_USER_SETTINGS_ID "Arduino user_settings.h v5.7.4"

Installing to GitHub directory: /mnt/c/workspace/Arduino-wolfSSL-gojimmypi
Removing workspace library directory: ./wolfssl
Done!
gojimmypi:/mnt/c/workspace/wolfssl-master/IDE/ARDUINO
$

Reminder that the Arduino library requires this repository to be updated, and a tag created before being available in the Arduino library. See the requirements of Arduino libraries as described in the Arduino Library Specification.

See also:

https://downloads.arduino.cc/libraries/logs/github.com/wolfSSL/Arduino-wolfSSL/

https://docs.arduino.cc/learn/starting-guide/software-libraries/

Initial #1 and prior #8

@gojimmypi gojimmypi requested a review from dgarske January 27, 2025 19:18
@dgarske dgarske removed their assignment Jan 27, 2025
@dgarske dgarske removed their request for review January 27, 2025 21:59
@dgarske dgarske merged commit 0703f7b into wolfSSL:main Feb 4, 2025
@gojimmypi
Copy link
Contributor Author

After the merge of this PR, I've created a local Arduino-wolfSSL 5.7.6 release.

See https://downloads.arduino.cc/libraries/logs/github.com/wolfSSL/Arduino-wolfSSL/ for Arduino publishing status. It should be available within an hour or so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants