Offload IoT Cloud connection to Nina module #208

facchinm · 2020-11-16T18:59:26Z

Requires nina-fw 1.4.2

The SHA256 on OTA should be retested on the field (could be too slow for real world usage). In that case we should vendor a software only, embedded friendly implementation.

TODO: add control code if fw is < 1.4.2 that HALTS the execution. Strings comparison (<=>) should be checked on megaAVR since it reports false results.

codecov-io · 2020-11-16T19:01:18Z

Codecov Report

Merging #208 (8383de1) into master (d04bf5b) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #208   +/-   ##
=======================================
  Coverage   95.27%   95.27%           
=======================================
  Files          25       25           
  Lines         889      889           
=======================================
  Hits          847      847           
  Misses         42       42

Impacted Files	Coverage Δ
src/property/Property.h	`90.47% <ø> (ø)`
src/property/Property.cpp	`87.20% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 457d932...8383de1. Read the comment docs.

aentinger

Concerning 46aa5f6 : Why? Can't imagine writing all the data via I2C is faster than doing it all in software. An additional drawback regarding security is that the whole application is available on the I2C lines for sniffing on every startup. It doesn't make a difference right now, with no read-out protection fuses blown, but could be in the future with Arduino Cloud being used for industrial grade solutions.

facchinm · 2020-11-17T09:00:53Z

Concerning 46aa5f6 : Why? Can't imagine writing all the data via I2C is faster than doing it all in software. An additional drawback regarding security is that the whole application is available on the I2C lines for sniffing on every startup. It doesn't make a difference right now, with no read-out protection fuses blown, but could be in the future with Arduino Cloud being used for industrial grade solutions.

The goal is to get rid of bearssl entirely in case we offload SSL operation to the Nina; this path is "free" since we already include ECCx08 library, any other strategy will add a dependency.

aentinger · 2020-11-17T09:02:45Z

I understand your motivation but we can get rid of 98% of BearSSL and still keep their software-hash implementation. I consider the drawbacks of exposing the binary (runtime, secrecy) to severe to justify doing it.

facchinm · 2020-11-17T09:12:35Z

@aentinger fixed by 13fbaf5

aentinger · 2020-11-17T09:41:54Z

Hi @per1234 👋 Can you please extend this PR by adding CI build for Arduino Uno WiFi. Rev. 2? One additional needed dependency for Uno WiFi Rev. 2 build is ArduinoSTL (There might be others which I've not identified yet).

per1234 · 2020-11-17T10:34:15Z

Can you please extend this PR by adding CI build for Arduino Uno WiFi. Rev. 2?

OK, here you go;
#209

src/cbor/CBORDecoder.h

src/cbor/CBOREncoder.h

Temporarily remove OTA support since it depends on bearssl's SHA256 APIs

Need to add a patch to Arduino_ConnectionHandler: diff --git a/src/Arduino_ConnectionHandler.h b/src/Arduino_ConnectionHandler.h index 195ab13..8d80f2e 100644 --- a/src/Arduino_ConnectionHandler.h +++ b/src/Arduino_ConnectionHandler.h @@ -29,7 +29,8 @@ #define WIFI_FIRMWARE_VERSION_REQUIRED WIFI_FIRMWARE_REQUIRED #endif -#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT) +#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_SAMD_NANO_33_IOT) || \ + defined(ARDUINO_AVR_UNO_WIFI_REV2) #include <WiFiNINA.h> #include <WiFiUdp.h>

Loses 2KB of flash compared with 46aa5f6 but it's surely faster

…of and maintainable way.

…ROR/WARNING/... to avoid name clashes with ídentically named constants within Arduino_DebugUtils

…compiled in (which is the case when working with Uno WiFi Rev. 2

…ion anyway only servers as a stub to allow compilation for megaavr architecture.

…rchitecture in samd, mbed and megaavr (all currently supported arduino boards.

It's required by the offloaded ecc anyway, so it will be ok

github-actions · 2021-01-27T16:56:32Z

Memory usage change @ b57d900

Board	flash	%	RAM for global variables	%
arduino:mbed:envie_m4	❔ -128 - +64	-0.01 - +0.01	0 - 0	0.0 - 0.0
arduino:mbed:envie_m7	❔ -128 - +64	-0.02 - +0.01	0 - 0	0.0 - 0.0
arduino:samd:mkr1000	❔ -112 - +48	-0.04 - +0.02	0 - 0	0.0 - 0.0
arduino:samd:mkrgsm1400	❔ -112 - +40	-0.04 - +0.02	0 - 0	0.0 - 0.0
arduino:samd:mkrnb1500	❔ -112 - +48	-0.04 - +0.02	0 - 0	0.0 - 0.0
arduino:samd:mkrwan1300	🔺 +40 - +40	+0.02 - +0.02	0 - 0	0.0 - 0.0
arduino:samd:mkrwifi1010	💚 -51208 - 0	-19.53 - 0.0	💚 -15304 - 0	-46.7 - 0.0
arduino:samd:nano_33_iot	💚 -51208 - 0	-19.53 - 0.0	💚 -15296 - 0	-46.68 - 0.0
esp32:esp32:esp32	🔺 +60 - +60	0.0 - 0.0	0 - 0	0.0 - 0.0
esp8266:esp8266:huzzah	💚 -84 - -80	-0.01 - -0.01	🔺 +348 - +352	+0.42 - +0.43

Click for full report table

Board	examples/ArduinoIoTCloud-Advanced flash	%	examples/ArduinoIoTCloud-Advanced RAM for global variables	%	examples/ArduinoIoTCloud-Basic flash	%	examples/ArduinoIoTCloud-Basic RAM for global variables	%	examples/utility/ArduinoIoTCloud_Travis_CI flash	%	examples/utility/ArduinoIoTCloud_Travis_CI RAM for global variables	%	examples/utility/Provisioning flash	%	examples/utility/Provisioning RAM for global variables	%	examples/utility/SelfProvisioning flash	%	examples/utility/SelfProvisioning RAM for global variables	%
arduino:mbed:envie_m4	64	0.01	0	0.0	0	0.0	0	0.0	64	0.01	0	0.0	-128	-0.01	0	0.0
arduino:mbed:envie_m7	64	0.01	0	0.0	64	0.01	0	0.0	64	0.01	0	0.0	-128	-0.02	0	0.0
arduino:samd:mkr1000	40	0.02	0	0.0	48	0.02	0	0.0	48	0.02	0	0.0	-112	-0.04	0	0.0
arduino:samd:mkrgsm1400	40	0.02	0	0.0	40	0.02	0	0.0	40	0.02	0	0.0	-112	-0.04	0	0.0
arduino:samd:mkrnb1500	48	0.02	0	0.0	40	0.02	0	0.0	48	0.02	0	0.0	-112	-0.04	0	0.0
arduino:samd:mkrwan1300	40	0.02	0	0.0	40	0.02	0	0.0	40	0.02	0	0.0
arduino:samd:mkrwifi1010	-51208	-19.53	-15304	-46.7	-51208	-19.53	-15296	-46.68	-51208	-19.53	-15296	-46.68	-48116	-18.35	-15296	-46.68	0	0.0	0	0.0
arduino:samd:nano_33_iot	-50960	-19.44	-15296	-46.68	-51208	-19.53	-15296	-46.68	-50960	-19.44	-15288	-46.66	-47876	-18.26	-15288	-46.66	0	0.0	0	0.0
esp32:esp32:esp32	60	0.0	0	0.0	60	0.0	0	0.0	60	0.0	0	0.0
esp8266:esp8266:huzzah	-80	-0.01	352	0.43	-84	-0.01	348	0.42	-80	-0.01	352	0.43

Click for full report CSV

Board,examples/ArduinoIoTCloud-Advanced<br>flash,%,examples/ArduinoIoTCloud-Advanced<br>RAM for global variables,%,examples/ArduinoIoTCloud-Basic<br>flash,%,examples/ArduinoIoTCloud-Basic<br>RAM for global variables,%,examples/utility/ArduinoIoTCloud_Travis_CI<br>flash,%,examples/utility/ArduinoIoTCloud_Travis_CI<br>RAM for global variables,%,examples/utility/Provisioning<br>flash,%,examples/utility/Provisioning<br>RAM for global variables,%,examples/utility/SelfProvisioning<br>flash,%,examples/utility/SelfProvisioning<br>RAM for global variables,%
arduino:mbed:envie_m4,64,0.01,0,0.0,0,0.0,0,0.0,64,0.01,0,0.0,-128,-0.01,0,0.0
arduino:mbed:envie_m7,64,0.01,0,0.0,64,0.01,0,0.0,64,0.01,0,0.0,-128,-0.02,0,0.0
arduino:samd:mkr1000,40,0.02,0,0.0,48,0.02,0,0.0,48,0.02,0,0.0,-112,-0.04,0,0.0
arduino:samd:mkrgsm1400,40,0.02,0,0.0,40,0.02,0,0.0,40,0.02,0,0.0,-112,-0.04,0,0.0
arduino:samd:mkrnb1500,48,0.02,0,0.0,40,0.02,0,0.0,48,0.02,0,0.0,-112,-0.04,0,0.0
arduino:samd:mkrwan1300,40,0.02,0,0.0,40,0.02,0,0.0,40,0.02,0,0.0,,,,
arduino:samd:mkrwifi1010,-51208,-19.53,-15304,-46.7,-51208,-19.53,-15296,-46.68,-51208,-19.53,-15296,-46.68,-48116,-18.35,-15296,-46.68,0,0.0,0,0.0
arduino:samd:nano_33_iot,-50960,-19.44,-15296,-46.68,-51208,-19.53,-15296,-46.68,-50960,-19.44,-15288,-46.66,-47876,-18.26,-15288,-46.66,0,0.0,0,0.0
esp32:esp32:esp32,60,0.0,0,0.0,60,0.0,0,0.0,60,0.0,0,0.0,,,,,,,,
esp8266:esp8266:huzzah,-80,-0.01,352,0.43,-84,-0.01,348,0.42,-80,-0.01,352,0.43,,,,,,,,

…sent.

…s actually defined, i.e. if any debug output is enabled on the platform.

…le to see errors otherwise)?

…error messages.

eclipse1985 · 2021-01-28T11:09:42Z

As far as I understand this is a breaking change that requires the nina firmware to be updated. This would need a UI/UX works from our side, so please do not release a new version for now 😄

aentinger · 2021-01-28T11:50:52Z

@eclipse1985 - yes 😉

facchinm requested a review from aentinger November 16, 2020 18:59

aentinger reviewed Nov 17, 2020

View reviewed changes

arduino-libraries deleted a comment from github-actions bot Nov 17, 2020

facchinm force-pushed the offload-ssl-nina-take2 branch from 13fbaf5 to df6818a Compare November 17, 2020 09:41

aentinger mentioned this pull request Nov 18, 2020

Offload SSL on NINA based boards #199

Closed

per1234 reviewed Nov 18, 2020

View reviewed changes

src/cbor/CBORDecoder.h Outdated Show resolved Hide resolved

aentinger reviewed Nov 19, 2020

View reviewed changes

src/cbor/CBOREncoder.h Outdated Show resolved Hide resolved

facchinm and others added 11 commits January 26, 2021 15:48

Offload SSL Client w/ crypto on Nina modules

3a665ae

Temporarily remove OTA support since it depends on bearssl's SHA256 APIs

RFC: calculate SHA256 using ECCx08

6bf3889

Reenable OTA for SAMD Nina targets

3a143a7

OTA: prepare for UNO WiFi rev2

f087d04

Restore SHA256 via bearSSL

cbb745b

Loses 2KB of flash compared with 46aa5f6 but it's surely faster

Prevent inclusion of 'Arduino_DebugUtils' on AVR in a more future-pro…

2b14646

…of and maintainable way.

Renaming all 'DBG_ERROR/WARNING/INFO/DEBUG/VERBOSE macros to DEBUG_ER…

41e2392

…ROR/WARNING/... to avoid name clashes with ídentically named constants within Arduino_DebugUtils

Provide DBG_NONE/ERROR/ etc. values in case ArduinoDebugUtils is not …

3640d4d

…compiled in (which is the case when working with Uno WiFi Rev. 2

Add Uno WiFi Rev2 to "Compile Examples" CI workflow

ad74074

Force inclusion of Arduino_AVRSTL.

7ed85b0

aentinger force-pushed the offload-ssl-nina-take2 branch from 484cca9 to 7ed85b0 Compare January 26, 2021 15:03

aentinger added 5 commits January 27, 2021 06:23

Comment parameter out to prevent unused parameter warning. This funct…

1656ab0

…ion anyway only servers as a stub to allow compilation for megaavr architecture.

Clearly disabling DEBUG macros for megaavr architecture.

573ce66

Correcting debug macros to allow code to compile.

956cd77

Eliminating 'F(expr)' macro since it's of no use due to the Neumann a…

958f73e

…rchitecture in samd, mbed and megaavr (all currently supported arduino boards.

List 'megaavr' as supported platform.

d9d5066

arduino-libraries deleted a comment from github-actions bot Jan 27, 2021

aentinger added 3 commits January 27, 2021 06:43

As Arduino_AVRSTL is not yet released directly link to the repository.

11217fd

Fixing as-of-yet-not-fixed wrong braces.

7e3e196

Cleaning up include structure.

f9e8540

arduino-libraries deleted a comment from github-actions bot Jan 27, 2021

megaAVR: don't use NTP time fallback

b57d900

It's required by the offloaded ecc anyway, so it will be ok

aentinger added 6 commits January 28, 2021 07:45

Add braces to ensure correct order of operant execution.

4865f50

Prevent execution of cloud firmware if a nina firmware < 1.4.2 is pre…

86b1170

…sent.

Automatically include Arduino_DebugUtils if any of the debug macros i…

6e0e75f

…s actually defined, i.e. if any debug output is enabled on the platform.

Enable ERROR message output for Uno WiFi Rev. 2 (how should you be ab…

9b49af2

…le to see errors otherwise)?

Bugfix: Don't loop forever, just return 0.

577f305

Shortening error messages to conserve flash and eliminate unneccsary …

8383de1

…error messages.

aentinger merged commit d8a3a98 into master Jan 28, 2021

aentinger deleted the offload-ssl-nina-take2 branch January 28, 2021 11:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Offload IoT Cloud connection to Nina module #208

Offload IoT Cloud connection to Nina module #208

Uh oh!

facchinm commented Nov 16, 2020

Uh oh!

codecov-io commented Nov 16, 2020 •

edited

Loading

Uh oh!

aentinger left a comment

Uh oh!

facchinm commented Nov 17, 2020

Uh oh!

aentinger commented Nov 17, 2020 •

edited

Loading

Uh oh!

facchinm commented Nov 17, 2020

Uh oh!

aentinger commented Nov 17, 2020

Uh oh!

per1234 commented Nov 17, 2020

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 27, 2021

Uh oh!

eclipse1985 commented Jan 28, 2021

Uh oh!

aentinger commented Jan 28, 2021

Uh oh!

Uh oh!

Offload IoT Cloud connection to Nina module #208

Offload IoT Cloud connection to Nina module #208

Uh oh!

Conversation

facchinm commented Nov 16, 2020

Uh oh!

codecov-io commented Nov 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

aentinger left a comment

Choose a reason for hiding this comment

Uh oh!

facchinm commented Nov 17, 2020

Uh oh!

aentinger commented Nov 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

facchinm commented Nov 17, 2020

Uh oh!

aentinger commented Nov 17, 2020

Uh oh!

per1234 commented Nov 17, 2020

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 27, 2021

Uh oh!

eclipse1985 commented Jan 28, 2021

Uh oh!

aentinger commented Jan 28, 2021

Uh oh!

Uh oh!

codecov-io commented Nov 16, 2020 •

edited

Loading

aentinger commented Nov 17, 2020 •

edited

Loading