wolfssl 5.8.2 Release for Arduino

[gojimmypi]

wolfSSL 5.8.2 Release for Arduino

This is a restructured wolfSSL for the Arduino library. See Initial #1.

Reminder: 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/

This Update:

Used this script to create the branch with changes. Once approved and merged, tags & release still need to be created manually.

#!/bin/bash
#
# See example https://github.com/wolfSSL/Arduino-wolfSSL/pull/15

# Run shell check to ensure this a good script.
# Specify the executable shell checker you want to use:
MY_SHELLCHECK="shellcheck"

# Check if the executable is available in the PATH
if command -v "$MY_SHELLCHECK" >/dev/null 2>&1; then
    # Run your command here
    shellcheck "$0" || exit 1
else
    echo "$MY_SHELLCHECK is not installed. Please install it if changes to this script have been made."
    exit 1
fi

# start from a clean publish directory:
echo "Creating fresh publish directory..."
cd /mnt/c/temp/  || exit 1
mkdir publish    || exit 1
cd publish       || exit 1

# set version to publish. This is the release title:
WOLFSSL_VERSION=5.8.2

# The tag name is automatically generated,
# but currently needs to be manually created on GitHub:
WOLFSSL_VERSION_TAG=v$WOLFSSL_VERSION-stable

echo "TODO automate creation of release, tag, tag title, copy of release notes, etc."

# set repo root current user is using arduino-wolfssl from fork
THIS_USER=$(whoami)
export THIS_USER

# set repo root using wolfssl from supplementary fork, otherwise current user
export REPO_USER=wolfSSL
# export REPO_USER=$(whoami)

# root from which clones created and used for publishing
THIS_ROOT=$(pwd)

# Assume we'll use the latest master of wolfssl-examples-publish
export WOLFSSL_EXAMPLES_ROOT="$THIS_ROOT/wolfssl-examples-publish"
echo "Publishing examples from: $WOLFSSL_EXAMPLES_ROOT"
echo "WOLFSSL_VERSION: $WOLFSSL_VERSION"
echo "WOLFSSL_VERSION_TAG: $WOLFSSL_VERSION_TAG"

# Checkout clean repositories
git clone https://github.com/"$REPO_USER"/wolfssl.git          wolfssl-publish           || exit 1
git clone https://github.com/"$REPO_USER"/wolfssl-examples.git wolfssl-examples-publish  || exit 1
git clone https://github.com/"$THIS_USER"/arduino-wolfssl.git  arduino-wolfssl-publish   || exit 1


# Checkout the wolfSSL release.
cd wolfssl-publish                             || exit 1
git fetch --tags                               || exit 1
git checkout "$WOLFSSL_VERSION_TAG"            || exit 1
cd "$THIS_ROOT/wolfssl-publish/IDE/ARDUINO"    || exit 1

# Optionally install locally for testing.
# If removing an existing install, consider saving any changes that may have been made to
#
# ~/Arduino/libraries/wolfssl/src/user_settings.h
#
# ./wolfssl-arduino.sh INSTALL

# Install to arduino-wolfssl-publish. This is the directory from which to create a new PR:
./wolfssl-arduino.sh INSTALL "$THIS_ROOT/arduino-wolfssl-publish"      || exit 1


# Commit to create version update PR
# We'll create a arduino-wolfssl PR from a THIS_USER fork
cd "$THIS_ROOT/arduino-wolfssl-publish"                                || exit 1
git remote add upstream https://github.com/wolfSSL/arduino-wolfssl.git || exit 1

# Ensure any new files are included
git add .                                                              || exit 1
git checkout -b Arduino-$WOLFSSL_VERSION                               || exit 1
# (gpg sign as needed here), then commit:
git commit -m "wolfssl $WOLFSSL_VERSION Release for Arduino"           || exit 1

echo "git push and cleanup skipped"
echo ""
echo "See branch in $(pwd)"
echo ""
echo "Review contents, push branch, then create PR"

exit 0

# push commit, disabled here:
git push

# cleanup, also currently disabled here:
echo "Cleanup: $THIS_ROOT"
rm -rf "$THIS_ROOT/wolfssl-publish"
rm -rf "$THIS_ROOT/wolfssl-examples-publish"
rm -rf "$THIS_ROOT/arduino-wolfssl-publish"

With this output:

Creating fresh publish directory...
TODO automate creation of release, tag, tag title, copy of release notes, etc.
Publishing examples from: /mnt/c/temp/publish/wolfssl-examples-publish
WOLFSSL_VERSION: 5.8.2
WOLFSSL_VERSION_TAG: v5.8.2-stable
Cloning into 'wolfssl-publish'...
Updating files:   8% (251/3093)
[ ... snip ...]
Updating files: 100% (3093/3093)
Updating files: 100% (3093/3093), done.
Cloning into 'wolfssl-examples-publish'...
Updating files:  20% (301/1472)
[ ... snip ...]
Updating files: 100% (1472/1472), done.
Cloning into 'arduino-wolfssl-publish'...
Note: switching to 'v5.8.2-stable'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at decea12e2 Merge pull request #9012 from JacobBarthelmeh/release
The Arduino library root is: /mnt/c/Users/gojimmypi/Documents/Arduino/libraries
Install is active.
Installing to /mnt/c/temp/publish/arduino-wolfssl-publish
Target is a GitHub root repository.
EXTRA_EXAMPLES_DIR=/mnt/c/temp/publish/wolfssl-examples-publish/Arduino
Found wolfSSL version 5.8.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....
Source WOLFSSL_EXAMPLES_ROOT=/mnt/c/temp/publish/wolfssl-examples-publish
Destination EXAMPLES_DIR=./wolfssl/examples
EXAMPLES_DIR_REAL_PATH=/mnt/c/temp/publish/wolfssl-publish/IDE/ARDUINO/wolfssl/examples
Copy template example....
Copy wolfssl_AES_CTR example....
Copy wolfssl_client example....
Copy wolfssl_server example....
Copy wolfssl_version example....
Examples copied to ./wolfssl/examples
ls /mnt/c/temp/publish/wolfssl-publish/IDE/ARDUINO/wolfssl/examples
template
wolfssl_AES_CTR
wolfssl_client
wolfssl_server
wolfssl_version
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.8.2 for the Arduino platform.

total 404
drwxr-xr-x 1 gojimmypi gojimmypi    512 Jul 21 11:47 .
drwxr-xr-x 1 gojimmypi gojimmypi    512 Jul 21 11:47 ..
-rw-r--r-- 1 gojimmypi gojimmypi    173 Jul 21 11:47 .editorconfig
-rw-r--r-- 1 gojimmypi gojimmypi  11282 Jul 21 11:47 .gitignore
-rw-r--r-- 1 gojimmypi gojimmypi  35147 Jul 21 11:47 COPYING
-rw-r--r-- 1 gojimmypi gojimmypi 313197 Jul 21 11:47 ChangeLog.md
-rw-r--r-- 1 gojimmypi gojimmypi    469 Jul 21 11:47 LICENSING
-rw-r--r-- 1 gojimmypi gojimmypi  19212 Jul 21 11:47 README
-rw-r--r-- 1 gojimmypi gojimmypi  24267 Jul 21 11:47 README.md
drwxr-xr-x 1 gojimmypi gojimmypi    512 Jul 21 11:47 examples
-rw-r--r-- 1 gojimmypi gojimmypi    623 Jul 21 11:47 keywords.txt
-rw-r--r-- 1 gojimmypi gojimmypi    373 Jul 21 11:47 library.properties
drwxr-xr-x 1 gojimmypi gojimmypi    512 Jul 21 11:47 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.6"

Installing to GitHub directory: /mnt/c/temp/publish/arduino-wolfssl-publish
Removing workspace library directory: ./wolfssl
Done!
Switched to a new branch 'Arduino-5.8.2'
[Arduino-5.8.2 ae21919] wolfssl 5.8.2 Release for Arduino
 304 files changed, 14222 insertions(+), 8351 deletions(-)
 rewrite COPYING (86%)
 rewrite README (68%)
 create mode 100644 src/wolfssl/wolfcrypt/oid_sum.h
 rewrite src/wolfssl/wolfcrypt/types.h (81%)
git push and cleanup skipped

[gojimmypi]

Two hours later and the wolfSSL status page has not been updated with v5.8.2.

There's also been no recent update to the servo example, so there may be an issue on the Arduino side.

See also: arduino/library-registry#4300

Will check again tomorrow. Library publishing delays often seem to get resolved.