wolfssl / arduino-wolfssl Goto Github PK

As noted in arduino/library-registry#4056 (comment) the wolfSSL Arduino examples should be added to this repository.

Additionally, the wolfCrypt Benchmark and wolfCrypt Test apps should be adapted to Arduino and added here as well.

The wolfssl-arduino.sh install script will need to be updated.

@ivankravets over at PlatformIO made a comment regarding the name of wolfSSL in the Arduino registry:

Please fix the name of Arduino library https://github.com/wolfSSL/Arduino-wolfSSL/blob/main/library.properties .
It should be name = Arduino-wolfSSL

The issue being that if there's a name consistency, the wolfSSL for Arduino library will apparently propagate automatically to PlatformIO.

The instance of wolfSSL currently in the PlatformIO registry was published manually:

https://registry.platformio.org/libraries/wolfssl/wolfssl

Although that sounds simple enough, there are implications. For one, I would be concerned that when searching for wolfSSL in the Arduino registry, that having a name other than wolfssl might not be entirely desirable.

I like the fact that wolfSSL is call, well, simply wolfssl in the Arduino registry:

However, I also agree that there's some inconsistency in this repo Arduino-wolfSSL being the same as wolfssl, but restructured for Arduino compatibility as noted in #1 (comment) and in particular arduino/arduino-cli#631.

There's probably an argument that the PlatformIO version of wolfSSL should have a unique name. In fact, we are going to need at least two unique names for wolfSSL in the PlatformIO registry: not only should there be an Arduino environment version of wolfSSL, but also at least one other for the Espressif ESP-IDF environment in a different format / layout.

My inclination is to leave the Arduino properties as-is, and continue to manually publish to PlatformIO.

I'm looking for input regarding the desired naming convention.

See also:

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

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