Skip to content
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

wolfssl 5.7.2 Release for Arduino #8

Merged
merged 3 commits into from
Aug 1, 2024
Merged

Conversation

gojimmypi
Copy link
Contributor

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

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

Log:

gojimmypi:/mnt/c/workspace/wolfssl-master/IDE/ARDUINO
$ ./wolfssl-arduino.sh INSTALL "$ARDUINO_ROOT"
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 repository.
Found wolfSSL version 5.7.2
# 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.2 for the Arduino platform.

total 340
drwxr-xr-x 1 gojimmypi gojimmypi    512 Jul 20 13:25 .
drwxrwxrwx 1 gojimmypi gojimmypi    512 Jul 20 13:25 ..
-rwxr-xr-x 1 gojimmypi gojimmypi    173 Jul 20 13:25 .editorconfig
-rwxr-xr-x 1 gojimmypi gojimmypi  10593 Jul 20 13:25 .gitignore
-rwxr-xr-x 1 gojimmypi gojimmypi  18092 Jul 20 13:25 COPYING
-rw-r--r-- 1 gojimmypi gojimmypi 270993 Jul 20 13:25 ChangeLog.md
-rwxr-xr-x 1 gojimmypi gojimmypi    469 Jul 20 13:25 LICENSING
-rw-r--r-- 1 gojimmypi gojimmypi  13648 Jul 20 13:25 README
-rw-r--r-- 1 gojimmypi gojimmypi  17120 Jul 20 13:25 README.md
drwxr-xr-x 1 gojimmypi gojimmypi    512 Jul 20 13:25 examples
-rwxr-xr-x 1 gojimmypi gojimmypi    623 Jul 20 13:25 keywords.txt
-rw-r--r-- 1 gojimmypi gojimmypi    373 Jul 20 13:25 library.properties
drwxr-xr-x 1 gojimmypi gojimmypi    512 Jul 20 13:25 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.2"

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

Also included in a commit that adds some PlatformIO-specific files, as well as a minor .gitignore update to ignore placeholder files during publish:

/src/wolfcrypt/src/fips.c
/src/wolfcrypt/src/fips_test.c
/src/wolfcrypt/src/selftest.c
/src/wolfcrypt/src/wolfcrypt_first.c
/src/wolfcrypt/src/wolfcrypt_last.c
/src/wolfssl/wolfcrypt/fips.h

Reminder that he 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/

@gojimmypi gojimmypi requested a review from dgarske July 20, 2024 20:57
@dgarske dgarske assigned wolfSSL-Bot and unassigned dgarske Jul 22, 2024
@gojimmypi gojimmypi changed the title Arduino 5.7.2 wolfssl 5.7.2 Release for Arduino Jul 25, 2024
@gojimmypi
Copy link
Contributor Author

With the merge of this PR, I've created Arduino-wolfSSL Release tag 5.7.2.

After a short period of time, the Arduino Indexer should indicate the most recent version being available:

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

See also: https://www.arduino.cc/reference/en/libraries/wolfssl/

Note there's arduino/library-registry#4300 that describes past update problems that appears to still be occurring today. I think it eventually works out.

@gojimmypi
Copy link
Contributor Author

After a few days of delay, it appears the indexer over at Arduino successfully ran and wolfSSL 5.7.2 is now available in the Arduino Library. No changes here: the tag creation mentioned above worked as expected to refresh Arduino version when the indexer ran.

I have a little microblog over on X/Twitter with additional details.

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