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/SensorNode.hpp@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 0:33d4e66780c0 1 /*******************************************************************************
IanBenzMaxim 16:a004191a79ab 2 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 0:33d4e66780c0 3 *
IanBenzMaxim 0:33d4e66780c0 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 0:33d4e66780c0 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 0:33d4e66780c0 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 0:33d4e66780c0 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 0:33d4e66780c0 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 0:33d4e66780c0 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 0:33d4e66780c0 10 *
IanBenzMaxim 0:33d4e66780c0 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 0:33d4e66780c0 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 0:33d4e66780c0 13 *
IanBenzMaxim 0:33d4e66780c0 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 0:33d4e66780c0 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 0:33d4e66780c0 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 0:33d4e66780c0 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 0:33d4e66780c0 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 0:33d4e66780c0 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 0:33d4e66780c0 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 0:33d4e66780c0 21 *
IanBenzMaxim 0:33d4e66780c0 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 0:33d4e66780c0 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 0:33d4e66780c0 24 * Products, Inc. Branding Policy.
IanBenzMaxim 0:33d4e66780c0 25 *
IanBenzMaxim 0:33d4e66780c0 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 0:33d4e66780c0 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 0:33d4e66780c0 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 0:33d4e66780c0 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 0:33d4e66780c0 30 * ownership rights.
IanBenzMaxim 0:33d4e66780c0 31 *******************************************************************************/
IanBenzMaxim 0:33d4e66780c0 32
IanBenzMaxim 0:33d4e66780c0 33 #ifndef SENSORNODE_HPP
IanBenzMaxim 0:33d4e66780c0 34 #define SENSORNODE_HPP
IanBenzMaxim 0:33d4e66780c0 35
IanBenzMaxim 0:33d4e66780c0 36 #include <stdint.h>
IanBenzMaxim 16:a004191a79ab 37 #include <MaximInterfaceCore/Function.hpp>
IanBenzMaxim 16:a004191a79ab 38 #include <MaximInterfaceCore/ManId.hpp>
IanBenzMaxim 16:a004191a79ab 39 #include <MaximInterfaceCore/Result.hpp>
IanBenzMaxim 16:a004191a79ab 40 #include <MaximInterfaceCore/RomId.hpp>
IanBenzMaxim 16:a004191a79ab 41 #include <MaximInterfaceDevices/DS28C36_DS2476.hpp>
IanBenzMaxim 16:a004191a79ab 42
IanBenzMaxim 16:a004191a79ab 43 namespace MaximInterfaceCore {
IanBenzMaxim 0:33d4e66780c0 44
IanBenzMaxim 16:a004191a79ab 45 class I2CMaster;
IanBenzMaxim 16:a004191a79ab 46 class Sleep;
IanBenzMaxim 16:a004191a79ab 47
IanBenzMaxim 16:a004191a79ab 48 } // namespace MaximInterfaceCore
IanBenzMaxim 16:a004191a79ab 49 namespace MaximInterfaceDevices {
IanBenzMaxim 16:a004191a79ab 50
IanBenzMaxim 0:33d4e66780c0 51 class DS2476;
IanBenzMaxim 16:a004191a79ab 52
IanBenzMaxim 16:a004191a79ab 53 } // namespace MaximInterfaceDevices
IanBenzMaxim 0:33d4e66780c0 54
IanBenzMaxim 0:33d4e66780c0 55 /// Interface to the authenticated sensor node peripheral board.
IanBenzMaxim 13:6a6225690c2e 56 class SensorNode {
IanBenzMaxim 0:33d4e66780c0 57 public:
IanBenzMaxim 13:6a6225690c2e 58 /// Prints a null-terminated char string.
IanBenzMaxim 16:a004191a79ab 59 typedef MaximInterfaceCore::Function<void(const char *)> PrintHandler;
IanBenzMaxim 13:6a6225690c2e 60
IanBenzMaxim 13:6a6225690c2e 61 /// Style of temperature to measure.
IanBenzMaxim 13:6a6225690c2e 62 enum TempStyle { AmbientTemp, ObjectTemp };
IanBenzMaxim 13:6a6225690c2e 63
IanBenzMaxim 13:6a6225690c2e 64 enum State {
IanBenzMaxim 16:a004191a79ab 65 Disconnected, ///< No sensor node is connected.
IanBenzMaxim 16:a004191a79ab 66 Invalid, ///< Sensor node is not valid.
IanBenzMaxim 16:a004191a79ab 67 ValidLaserDisabled, ///< Sensor node is valid, and laser is disabled.
IanBenzMaxim 16:a004191a79ab 68 ValidLaserEnabled, ///< Sensor node is valid, and laser is enabled.
IanBenzMaxim 13:6a6225690c2e 69 };
IanBenzMaxim 13:6a6225690c2e 70
IanBenzMaxim 13:6a6225690c2e 71 /// @param i2c
IanBenzMaxim 16:a004191a79ab 72 /// I2C bus connected to the sensor node that communicates with DS28C36 and
IanBenzMaxim 16:a004191a79ab 73 /// MLX90614.
IanBenzMaxim 13:6a6225690c2e 74 /// @param ds2476 Coprocessor used for authentication computations.
IanBenzMaxim 16:a004191a79ab 75 SensorNode(MaximInterfaceCore::Sleep & sleep,
IanBenzMaxim 16:a004191a79ab 76 MaximInterfaceCore::I2CMaster & i2c,
IanBenzMaxim 16:a004191a79ab 77 MaximInterfaceDevices::DS2476 & ds2476);
IanBenzMaxim 13:6a6225690c2e 78
IanBenzMaxim 13:6a6225690c2e 79 /// Detects if a potential sensor node is connected.
IanBenzMaxim 16:a004191a79ab 80 State detect();
IanBenzMaxim 13:6a6225690c2e 81
IanBenzMaxim 16:a004191a79ab 82 /// @brief Enable or disable the laser.
IanBenzMaxim 13:6a6225690c2e 83 /// @param enabled True to enable the laser or false to disable.
IanBenzMaxim 13:6a6225690c2e 84 /// @param print
IanBenzMaxim 13:6a6225690c2e 85 /// Optional callback for displaying informational messages to the user.
IanBenzMaxim 13:6a6225690c2e 86 /// @returns True if the operation was successful.
IanBenzMaxim 16:a004191a79ab 87 MaximInterfaceCore::Result<void>
IanBenzMaxim 13:6a6225690c2e 88 setLaserEnabled(bool enabled, const PrintHandler & print = PrintHandler());
IanBenzMaxim 0:33d4e66780c0 89
IanBenzMaxim 16:a004191a79ab 90 /// @brief Get a temperature measurement from the MLX90614.
IanBenzMaxim 13:6a6225690c2e 91 /// @param style Temperature style to read.
IanBenzMaxim 16:a004191a79ab 92 /// @returns Temperature in Celsius.
IanBenzMaxim 16:a004191a79ab 93 MaximInterfaceCore::Result<double> readTemp(TempStyle style);
IanBenzMaxim 13:6a6225690c2e 94
IanBenzMaxim 0:33d4e66780c0 95 private:
IanBenzMaxim 13:6a6225690c2e 96 /// Checks if the sensor node is authentic.
IanBenzMaxim 16:a004191a79ab 97 MaximInterfaceCore::Result<void> authenticate();
IanBenzMaxim 13:6a6225690c2e 98
IanBenzMaxim 16:a004191a79ab 99 /// @brief Checks if the laser is enabled.
IanBenzMaxim 16:a004191a79ab 100 /// @returns True if the laser is enabled.
IanBenzMaxim 16:a004191a79ab 101 MaximInterfaceCore::Result<bool> getLaserEnabled();
IanBenzMaxim 13:6a6225690c2e 102
IanBenzMaxim 16:a004191a79ab 103 MaximInterfaceCore::I2CMaster * i2c;
IanBenzMaxim 16:a004191a79ab 104 MaximInterfaceDevices::DS28C36 ds28c36;
IanBenzMaxim 16:a004191a79ab 105 MaximInterfaceDevices::DS2476 * ds2476;
IanBenzMaxim 16:a004191a79ab 106 MaximInterfaceCore::RomId::array romId;
IanBenzMaxim 16:a004191a79ab 107 MaximInterfaceCore::ManId::array manId;
IanBenzMaxim 13:6a6225690c2e 108
IanBenzMaxim 16:a004191a79ab 109 friend class HardwareTestWindow;
IanBenzMaxim 0:33d4e66780c0 110 };
IanBenzMaxim 0:33d4e66780c0 111
IanBenzMaxim 0:33d4e66780c0 112 #endif