Maxim Integrated / Mbed OS MAXREFDES155#

DeepCover Embedded Security in IoT: Public-key Secured Data Paths

Dependencies:   MaximInterface

The MAXREFDES155# is an internet-of-things (IoT) embedded-security reference design, built to authenticate and control a sensing node using elliptic-curve-based public-key cryptography with control and notification from a web server.

The hardware includes an ARM® mbed™ shield and attached sensor endpoint. The shield contains a DS2476 DeepCover® ECDSA/SHA-2 coprocessor, Wifi communication, LCD push-button controls, and status LEDs. The sensor endpoint is attached to the shield using a 300mm cable and contains a DS28C36 DeepCover ECDSA/SHA-2 authenticator, IR-thermal sensor, and aiming laser for the IR sensor. The MAXREFDES155# is equipped with a standard Arduino® form-factor shield connector for immediate testing using an mbed board such as the MAX32600MBED#. The combination of these two devices represent an IoT device. Communication to the web server is accomplished with the shield Wifi circuitry. Communication from the shield to the attached sensor module is accomplished over I2C . The sensor module represents an IoT endpoint that generates small data with a requirement for message authenticity/integrity and secure on/off operational control.

The design is hierarchical with each mbed platform and shield communicating data from the sensor node to a web server that maintains a centralized log and dispatches notifications as necessary. The simplicity of this design enables rapid integration into any star-topology IoT network to provide security with the low overhead and cost provided by the ECDSA-P256 asymmetric-key and SHA-256 symmetric-key algorithms.

More information about the MAXREFDES155# is available on the Maxim Integrated website.

src/HardwareTestWindow.cpp@17:5926077e5345, 2019-10-04 (annotated)

Committer:
IanBenzMaxim
Date:
Fri Oct 04 12:10:11 2019 -0500
Revision:
17:5926077e5345
Parent:
16:a004191a79ab 
Set pin maps through the mbed configuration system. Added support for MAX32625MBED target. Updated mbed-os to version 5.7.7 for MAX32625 I2C fixes. Consolidated simplelink hook definitions.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 16:a004191a79ab 1 /*******************************************************************************
IanBenzMaxim 16:a004191a79ab 2 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 16:a004191a79ab 3 *
IanBenzMaxim 16:a004191a79ab 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 16:a004191a79ab 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 16:a004191a79ab 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 16:a004191a79ab 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 16:a004191a79ab 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 16:a004191a79ab 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 16:a004191a79ab 10 *
IanBenzMaxim 16:a004191a79ab 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 16:a004191a79ab 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 16:a004191a79ab 13 *
IanBenzMaxim 16:a004191a79ab 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 16:a004191a79ab 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 16:a004191a79ab 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 16:a004191a79ab 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 16:a004191a79ab 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 16:a004191a79ab 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 16:a004191a79ab 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 16:a004191a79ab 21 *
IanBenzMaxim 16:a004191a79ab 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 16:a004191a79ab 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 16:a004191a79ab 24 * Products, Inc. Branding Policy.
IanBenzMaxim 16:a004191a79ab 25 *
IanBenzMaxim 16:a004191a79ab 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 16:a004191a79ab 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 16:a004191a79ab 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 16:a004191a79ab 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 16:a004191a79ab 30 * ownership rights.
IanBenzMaxim 16:a004191a79ab 31 *******************************************************************************/
IanBenzMaxim 16:a004191a79ab 32
IanBenzMaxim 16:a004191a79ab 33 #include <MaximInterfaceDevices/DS28C36_DS2476.hpp>
IanBenzMaxim 16:a004191a79ab 34 #include "ErrorWindow.hpp"
IanBenzMaxim 16:a004191a79ab 35 #include "Factory.hpp"
IanBenzMaxim 16:a004191a79ab 36 #include "HardwareTestWindow.hpp"
IanBenzMaxim 16:a004191a79ab 37 #include "SensorNode.hpp"
IanBenzMaxim 16:a004191a79ab 38 #include "WindowManager.hpp"
IanBenzMaxim 16:a004191a79ab 39
IanBenzMaxim 16:a004191a79ab 40 extern MaximInterfaceDevices::DS2476 coproc;
IanBenzMaxim 16:a004191a79ab 41 extern SensorNode sensorNode;
IanBenzMaxim 16:a004191a79ab 42
IanBenzMaxim 16:a004191a79ab 43 HardwareTestWindow::HardwareTestWindow() {
IanBenzMaxim 16:a004191a79ab 44 setState(LeftClickKeyTest);
IanBenzMaxim 16:a004191a79ab 45 prompt.setParent(this);
IanBenzMaxim 16:a004191a79ab 46 prompt.setWordWrap(true);
IanBenzMaxim 16:a004191a79ab 47 }
IanBenzMaxim 16:a004191a79ab 48
IanBenzMaxim 16:a004191a79ab 49 void HardwareTestWindow::resized() { prompt.resize(width(), height()); }
IanBenzMaxim 16:a004191a79ab 50
IanBenzMaxim 16:a004191a79ab 51 void HardwareTestWindow::updated() {
IanBenzMaxim 16:a004191a79ab 52 switch (state) {
IanBenzMaxim 16:a004191a79ab 53 case CoprocessorTest:
IanBenzMaxim 16:a004191a79ab 54 if (provisionCoprocessor(coproc)) {
IanBenzMaxim 16:a004191a79ab 55 setState(AuthenticatorTest);
IanBenzMaxim 16:a004191a79ab 56 } else {
IanBenzMaxim 16:a004191a79ab 57 if (windowManager()) {
IanBenzMaxim 16:a004191a79ab 58 std::auto_ptr<Window> window(
IanBenzMaxim 16:a004191a79ab 59 new ErrorWindow("Failed to provision DS2476"));
IanBenzMaxim 16:a004191a79ab 60 windowManager()->push(window);
IanBenzMaxim 16:a004191a79ab 61 }
IanBenzMaxim 16:a004191a79ab 62 }
IanBenzMaxim 16:a004191a79ab 63 break;
IanBenzMaxim 16:a004191a79ab 64
IanBenzMaxim 16:a004191a79ab 65 case AuthenticatorTest: {
IanBenzMaxim 16:a004191a79ab 66 if (!provisionAuthenticator(sensorNode.ds28c36)) {
IanBenzMaxim 16:a004191a79ab 67 if (windowManager()) {
IanBenzMaxim 16:a004191a79ab 68 std::auto_ptr<Window> window(
IanBenzMaxim 16:a004191a79ab 69 new ErrorWindow("Failed to provision DS28C36"));
IanBenzMaxim 16:a004191a79ab 70 windowManager()->push(window);
IanBenzMaxim 16:a004191a79ab 71 }
IanBenzMaxim 16:a004191a79ab 72 break;
IanBenzMaxim 16:a004191a79ab 73 }
IanBenzMaxim 16:a004191a79ab 74
IanBenzMaxim 16:a004191a79ab 75 const SensorNode::State state = sensorNode.detect();
IanBenzMaxim 16:a004191a79ab 76 if (!(state == SensorNode::ValidLaserDisabled ||
IanBenzMaxim 16:a004191a79ab 77 state == SensorNode::ValidLaserEnabled)) {
IanBenzMaxim 16:a004191a79ab 78 if (windowManager()) {
IanBenzMaxim 16:a004191a79ab 79 std::auto_ptr<Window> window(
IanBenzMaxim 16:a004191a79ab 80 new ErrorWindow("Failed to authenticate DS28C36"));
IanBenzMaxim 16:a004191a79ab 81 windowManager()->push(window);
IanBenzMaxim 16:a004191a79ab 82 }
IanBenzMaxim 16:a004191a79ab 83 break;
IanBenzMaxim 16:a004191a79ab 84 }
IanBenzMaxim 16:a004191a79ab 85
IanBenzMaxim 16:a004191a79ab 86 setState(LaserDisabledTest);
IanBenzMaxim 16:a004191a79ab 87 break;
IanBenzMaxim 16:a004191a79ab 88 }
IanBenzMaxim 16:a004191a79ab 89
IanBenzMaxim 16:a004191a79ab 90 case LaserEnabledTest:
IanBenzMaxim 16:a004191a79ab 91 if (!sensorNode.setLaserEnabled(true)) {
IanBenzMaxim 16:a004191a79ab 92 if (windowManager()) {
IanBenzMaxim 16:a004191a79ab 93 std::auto_ptr<Window> window(
IanBenzMaxim 16:a004191a79ab 94 new ErrorWindow("Failed to set laser enabled"));
IanBenzMaxim 16:a004191a79ab 95 windowManager()->push(window);
IanBenzMaxim 16:a004191a79ab 96 }
IanBenzMaxim 16:a004191a79ab 97 }
IanBenzMaxim 16:a004191a79ab 98 break;
IanBenzMaxim 16:a004191a79ab 99
IanBenzMaxim 16:a004191a79ab 100 case TempSensorTest: {
IanBenzMaxim 16:a004191a79ab 101 const MaximInterfaceCore::Result<double> ambientTemp =
IanBenzMaxim 16:a004191a79ab 102 sensorNode.readTemp(SensorNode::AmbientTemp);
IanBenzMaxim 16:a004191a79ab 103 if (ambientTemp && ambientTemp.value() >= 0.0 &&
IanBenzMaxim 16:a004191a79ab 104 ambientTemp.value() <= 50.0) {
IanBenzMaxim 16:a004191a79ab 105 setState(ResetKeyTest);
IanBenzMaxim 16:a004191a79ab 106 } else {
IanBenzMaxim 16:a004191a79ab 107 if (windowManager()) {
IanBenzMaxim 16:a004191a79ab 108 std::auto_ptr<Window> window(
IanBenzMaxim 16:a004191a79ab 109 new ErrorWindow("Failed to read valid ambient temperature"));
IanBenzMaxim 16:a004191a79ab 110 windowManager()->push(window);
IanBenzMaxim 16:a004191a79ab 111 }
IanBenzMaxim 16:a004191a79ab 112 }
IanBenzMaxim 16:a004191a79ab 113 break;
IanBenzMaxim 16:a004191a79ab 114 }
IanBenzMaxim 16:a004191a79ab 115
IanBenzMaxim 16:a004191a79ab 116 default:
IanBenzMaxim 16:a004191a79ab 117 break;
IanBenzMaxim 16:a004191a79ab 118 }
IanBenzMaxim 16:a004191a79ab 119 }
IanBenzMaxim 16:a004191a79ab 120
IanBenzMaxim 16:a004191a79ab 121 bool HardwareTestWindow::doProcessKey(Key key) {
IanBenzMaxim 16:a004191a79ab 122 switch (state) {
IanBenzMaxim 16:a004191a79ab 123 case LeftClickKeyTest:
IanBenzMaxim 16:a004191a79ab 124 if (key == LeftClickKey) {
IanBenzMaxim 16:a004191a79ab 125 setState(RightClickKeyTest);
IanBenzMaxim 16:a004191a79ab 126 }
IanBenzMaxim 16:a004191a79ab 127 break;
IanBenzMaxim 16:a004191a79ab 128
IanBenzMaxim 16:a004191a79ab 129 case RightClickKeyTest:
IanBenzMaxim 16:a004191a79ab 130 if (key == RightClickKey) {
IanBenzMaxim 16:a004191a79ab 131 setState(UpKeyTest);
IanBenzMaxim 16:a004191a79ab 132 }
IanBenzMaxim 16:a004191a79ab 133 break;
IanBenzMaxim 16:a004191a79ab 134
IanBenzMaxim 16:a004191a79ab 135 case UpKeyTest:
IanBenzMaxim 16:a004191a79ab 136 if (key == UpKey) {
IanBenzMaxim 16:a004191a79ab 137 setState(DownKeyTest);
IanBenzMaxim 16:a004191a79ab 138 }
IanBenzMaxim 16:a004191a79ab 139 break;
IanBenzMaxim 16:a004191a79ab 140
IanBenzMaxim 16:a004191a79ab 141 case DownKeyTest:
IanBenzMaxim 16:a004191a79ab 142 if (key == DownKey) {
IanBenzMaxim 16:a004191a79ab 143 setState(LeftKeyTest);
IanBenzMaxim 16:a004191a79ab 144 }
IanBenzMaxim 16:a004191a79ab 145 break;
IanBenzMaxim 16:a004191a79ab 146
IanBenzMaxim 16:a004191a79ab 147 case LeftKeyTest:
IanBenzMaxim 16:a004191a79ab 148 if (key == LeftKey) {
IanBenzMaxim 16:a004191a79ab 149 setState(RightKeyTest);
IanBenzMaxim 16:a004191a79ab 150 }
IanBenzMaxim 16:a004191a79ab 151 break;
IanBenzMaxim 16:a004191a79ab 152
IanBenzMaxim 16:a004191a79ab 153 case RightKeyTest:
IanBenzMaxim 16:a004191a79ab 154 if (key == RightKey) {
IanBenzMaxim 16:a004191a79ab 155 setState(CoprocessorTest);
IanBenzMaxim 16:a004191a79ab 156 }
IanBenzMaxim 16:a004191a79ab 157 break;
IanBenzMaxim 16:a004191a79ab 158
IanBenzMaxim 16:a004191a79ab 159 case LaserDisabledTest:
IanBenzMaxim 16:a004191a79ab 160 setState(LaserEnabledTest);
IanBenzMaxim 16:a004191a79ab 161 break;
IanBenzMaxim 16:a004191a79ab 162
IanBenzMaxim 16:a004191a79ab 163 case LaserEnabledTest:
IanBenzMaxim 16:a004191a79ab 164 setState(TempSensorTest);
IanBenzMaxim 16:a004191a79ab 165 break;
IanBenzMaxim 16:a004191a79ab 166
IanBenzMaxim 16:a004191a79ab 167 default:
IanBenzMaxim 16:a004191a79ab 168 break;
IanBenzMaxim 16:a004191a79ab 169 }
IanBenzMaxim 16:a004191a79ab 170 return true;
IanBenzMaxim 16:a004191a79ab 171 }
IanBenzMaxim 16:a004191a79ab 172
IanBenzMaxim 16:a004191a79ab 173 void HardwareTestWindow::setState(State state) {
IanBenzMaxim 16:a004191a79ab 174 this->state = state;
IanBenzMaxim 16:a004191a79ab 175 switch (state) {
IanBenzMaxim 16:a004191a79ab 176 case LeftClickKeyTest:
IanBenzMaxim 16:a004191a79ab 177 prompt.setText("Press \"Left Click\" key.");
IanBenzMaxim 16:a004191a79ab 178 break;
IanBenzMaxim 16:a004191a79ab 179
IanBenzMaxim 16:a004191a79ab 180 case RightClickKeyTest:
IanBenzMaxim 16:a004191a79ab 181 prompt.setText("Press \"Right Click\" key.");
IanBenzMaxim 16:a004191a79ab 182 break;
IanBenzMaxim 16:a004191a79ab 183
IanBenzMaxim 16:a004191a79ab 184 case UpKeyTest:
IanBenzMaxim 16:a004191a79ab 185 prompt.setText("Press \"Up\" key.");
IanBenzMaxim 16:a004191a79ab 186 break;
IanBenzMaxim 16:a004191a79ab 187
IanBenzMaxim 16:a004191a79ab 188 case DownKeyTest:
IanBenzMaxim 16:a004191a79ab 189 prompt.setText("Press \"Down\" key.");
IanBenzMaxim 16:a004191a79ab 190 break;
IanBenzMaxim 16:a004191a79ab 191
IanBenzMaxim 16:a004191a79ab 192 case LeftKeyTest:
IanBenzMaxim 16:a004191a79ab 193 prompt.setText("Press \"Left\" key.");
IanBenzMaxim 16:a004191a79ab 194 break;
IanBenzMaxim 16:a004191a79ab 195
IanBenzMaxim 16:a004191a79ab 196 case RightKeyTest:
IanBenzMaxim 16:a004191a79ab 197 prompt.setText("Press \"Right\" key.");
IanBenzMaxim 16:a004191a79ab 198 break;
IanBenzMaxim 16:a004191a79ab 199
IanBenzMaxim 16:a004191a79ab 200 case CoprocessorTest:
IanBenzMaxim 16:a004191a79ab 201 prompt.setText("Testing DS2476...");
IanBenzMaxim 16:a004191a79ab 202 break;
IanBenzMaxim 16:a004191a79ab 203
IanBenzMaxim 16:a004191a79ab 204 case AuthenticatorTest:
IanBenzMaxim 16:a004191a79ab 205 prompt.setText("Testing DS28C36...");
IanBenzMaxim 16:a004191a79ab 206 break;
IanBenzMaxim 16:a004191a79ab 207
IanBenzMaxim 16:a004191a79ab 208 case LaserDisabledTest:
IanBenzMaxim 16:a004191a79ab 209 prompt.setText("Ensure that green LED under laser is OFF. Press red button "
IanBenzMaxim 16:a004191a79ab 210 "and ensure that laser is OFF. Press any key to continue.");
IanBenzMaxim 16:a004191a79ab 211 break;
IanBenzMaxim 16:a004191a79ab 212
IanBenzMaxim 16:a004191a79ab 213 case LaserEnabledTest:
IanBenzMaxim 16:a004191a79ab 214 prompt.setText("Ensure that green LED under laser is ON. Press red button "
IanBenzMaxim 16:a004191a79ab 215 "and ensure that laser is ON. Press any key to continue.");
IanBenzMaxim 16:a004191a79ab 216 break;
IanBenzMaxim 16:a004191a79ab 217
IanBenzMaxim 16:a004191a79ab 218 case TempSensorTest:
IanBenzMaxim 16:a004191a79ab 219 prompt.setText("Testing temperature sensor...");
IanBenzMaxim 16:a004191a79ab 220 break;
IanBenzMaxim 16:a004191a79ab 221
IanBenzMaxim 16:a004191a79ab 222 case ResetKeyTest:
IanBenzMaxim 16:a004191a79ab 223 prompt.setText("Press \"Reset\" key to complete test.");
IanBenzMaxim 16:a004191a79ab 224 break;
IanBenzMaxim 16:a004191a79ab 225
IanBenzMaxim 16:a004191a79ab 226 default:
IanBenzMaxim 16:a004191a79ab 227 break;
IanBenzMaxim 16:a004191a79ab 228 }
IanBenzMaxim 16:a004191a79ab 229 }