Introduce IDE/PlatformIO; add wolfSSL Benchmark and Test Examples

[gojimmypi]

Description

Adds IDE/PlatformIO examples.

See also #7413 and platformio/platformio-registry#85

Fixes zd# n/a

Testing

How did you test?

Tested manually using PlatformIO in VS Code.

Checklist

• added tests
• updated/added doxygen
• updated appropriate READMEs
• Updated manual and documentation

[bandi13]

Tested both Benchmark as well as Test examples. Benchmark works, Test needs to be fixed.

[gojimmypi]

@bandi13 thanks for testing this for a test drive!

It's actually a good thing that the example test app is failing here. The published wolfSSL 5.7.0-rev.3b (Post Release Update for PlatformIO) referenced by the example on PlatformIO is stale.

I introduced a SHA interleave test in #7262. This test is included in the stale, post 5.7.0 version published at PlatformIO and is failing as desired, properly detecting the interleave problem.

The failing SHA interleave was the root cause of the SRP errors noted in #7210.

The SHA/SRP problem was fixed in #7505, merged within the last day but not yet published to PlatformIO.

Unfortunately (or fortunately, depending on your perspective), I found a new problem with the latest version of wolfSSL for PlatformIO as noted in #7533.

My plan is to create a new PR to fix #7533 and then publish a new, post-release wolfSSL to PlatformIO.

I don't think there's any problem with this particular PR 7528, as the root cause is the currently published wolfSSL version at PlatformIO. I've confirmed the latest master branch of wolfSSL works properly for both the SHA and SRP tests.

Reminder the SRP for the Apple HomeKit also requires the FP_MAX_BITS setting:

#define WOLFCRYPT_HAVE_SRP
#define FP_MAX_BITS (8192 * 2)

See the 4 different versions of wolfSSL available at PlatformIO:

• Regular (release): https://registry.platformio.org/libraries/wolfssl/wolfssl

• Arduino (release): https://registry.platformio.org/libraries/wolfssl/Arduino-wolfSSL

• Regular (staging): https://registry.platformio.org/libraries/wolfssl-staging/wolfSSL

• Arduino (staging): https://registry.platformio.org/libraries/wolfssl-staging/Arduino-wolfSSL

Note the Arduino version of the PlatformIO library should not be confused with the Official wolfSSL for Arduino: https://github.com/wolfSSL/Arduino-wolfSSL which is published to https://www.arduino.cc/reference/en/libraries/wolfssl/

This initial rollout has been a little more bumpy than anticipated. I do believe that once the appropriate platform-specific fixes are implemented, that the regular release cycle should be considerably more stable and graceful.

[dgarske]

@gojimmypi do you want to rebase the PR or accept as-is?

[gojimmypi]

@dgarske please stand by. I'd like to rebase and apply some minor updates. Testing is taking longer than anticipated.

[gojimmypi]

Hi @dgarske I've refreshed from upstream and made some minor changes in 503bbbe.

Key to getting this to work was having the proper fresh update of wolfSSL published to PlatformIO.

Tested and confirmed working are these versions in platformio.ini:

• RELEASE: lib_deps = wolfssl/wolfssl@^5.7.0-rev.3d

• STAGING: lib_deps = wolfssl-staging/wolfSSL@^5.7.0-test.rev03

@bandi13 if you could please, take this for a test drive again & let me know how it goes.

[gojimmypi]

Jenkins retest this please.

[dgarske]

Is this new file user_settings_platformio.h missing from include.am?

[gojimmypi]

Yes. Updated this, the respective README, and changed sort order.

[dgarske]

If possible please add our standard GPL header

[gojimmypi]

done

[gojimmypi]

Jenkins retest this please

[bandi13]

All tests pass. Benchmarks also run on an ESP32.

Nice work!