Maxim Integrated / Mbed 2 deprecated DeepCover Embedded Security in IoT

MAXREFDES143#: DeepCover Embedded Security in IoT Authenticated Sensing & Notification

Dependencies:   MaximInterface mbed

The MAXREFDES143# is an Internet of Things (IoT) embedded security reference design, built to protect an industrial sensing node by means of authentication and notification to a web server. The hardware includes a peripheral module representing a protected sensor node monitoring operating temperature and remaining life of a filter (simulated through ambient light sensing) and an mbed shield representing a controller node responsible for monitoring one or more sensor nodes. The design is hierarchical with each controller node communicating data from connected sensor nodes to a web server that maintains a centralized log and dispatches notifications as necessary. The mbed shield contains a Wi-Fi module, a DS2465 coprocessor with 1-Wire® master function, an LCD, LEDs, and pushbuttons. The protected sensor node contains a DS28E15 authenticator, a DS7505 temperature sensor, and a MAX44009 light sensor. The mbed shield communicates to a web server by the onboard Wi-Fi module and to the protected sensor node with I2C and 1-Wire. The MAXREFDES143# is equipped with a standard shield connector for immediate testing using an mbed board such as the MAX32600MBED#. The simplicity of this design enables rapid integration into any star-topology IoT network requiring the heightened security with low overhead provided by the SHA-256 symmetric-key algorithm.

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

SensorNode.hpp@35:3d414ba9ab6c, 2018-01-19 (annotated)

Committer:
IanBenzMaxim
Date:
Fri Jan 19 10:33:16 2018 -0600
Revision:
35:3d414ba9ab6c
Parent:
32:0a09505a656d 
Updated MaximInterface revision.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 1:e1c7c1c636af 1 /*******************************************************************************
IanBenzMaxim 1:e1c7c1c636af 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 1:e1c7c1c636af 3 *
IanBenzMaxim 1:e1c7c1c636af 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 1:e1c7c1c636af 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 1:e1c7c1c636af 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 1:e1c7c1c636af 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 1:e1c7c1c636af 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 1:e1c7c1c636af 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 1:e1c7c1c636af 10 *
IanBenzMaxim 1:e1c7c1c636af 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 1:e1c7c1c636af 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 1:e1c7c1c636af 13 *
IanBenzMaxim 1:e1c7c1c636af 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 1:e1c7c1c636af 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 1:e1c7c1c636af 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 1:e1c7c1c636af 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 1:e1c7c1c636af 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 1:e1c7c1c636af 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 1:e1c7c1c636af 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 1:e1c7c1c636af 21 *
IanBenzMaxim 1:e1c7c1c636af 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 1:e1c7c1c636af 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 1:e1c7c1c636af 24 * Products, Inc. Branding Policy.
IanBenzMaxim 1:e1c7c1c636af 25 *
IanBenzMaxim 1:e1c7c1c636af 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 1:e1c7c1c636af 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 1:e1c7c1c636af 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 1:e1c7c1c636af 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 1:e1c7c1c636af 30 * ownership rights.
IanBenzMaxim 32:0a09505a656d 31 *******************************************************************************/
IanBenzMaxim 1:e1c7c1c636af 32
IanBenzMaxim 24:434330962308 33 #ifndef SENSORNODE_HPP
IanBenzMaxim 24:434330962308 34 #define SENSORNODE_HPP
IanBenzMaxim 1:e1c7c1c636af 35
IanBenzMaxim 6:b6bafd0a7013 36 #include <stdint.h>
IanBenzMaxim 32:0a09505a656d 37 #include <MaximInterface/Devices/DS28E15_22_25.hpp>
IanBenzMaxim 32:0a09505a656d 38 #include <MaximInterface/Utilities/RomId.hpp>
IanBenzMaxim 32:0a09505a656d 39 #include <MaximInterface/Utilities/ManId.hpp>
IanBenzMaxim 1:e1c7c1c636af 40 #include "DS7505.hpp"
IanBenzMaxim 1:e1c7c1c636af 41 #include "MAX44009.hpp"
IanBenzMaxim 1:e1c7c1c636af 42
IanBenzMaxim 1:e1c7c1c636af 43 class SensorData;
IanBenzMaxim 32:0a09505a656d 44 namespace MaximInterface { class DS2465; }
IanBenzMaxim 1:e1c7c1c636af 45 namespace mbed { class I2C; }
IanBenzMaxim 1:e1c7c1c636af 46
IanBenzMaxim 1:e1c7c1c636af 47 /// Interface to the Authenticated Sensor Node peripheral board.
IanBenzMaxim 32:0a09505a656d 48 class SensorNode {
IanBenzMaxim 1:e1c7c1c636af 49 public:
IanBenzMaxim 32:0a09505a656d 50 enum State {
IanBenzMaxim 1:e1c7c1c636af 51 UnableToCommunicate, ///< I2C or 1-Wire communication failure.
IanBenzMaxim 32:0a09505a656d 52 NotProvisioned, ///< DS28E15 has not been provisioned.
IanBenzMaxim 32:0a09505a656d 53 NotAuthentic, ///< DS28E15 is not authentic.
IanBenzMaxim 32:0a09505a656d 54 Authentic ///< DS218E15 is authentic.
IanBenzMaxim 1:e1c7c1c636af 55 };
IanBenzMaxim 32:0a09505a656d 56
IanBenzMaxim 1:e1c7c1c636af 57 /// @param i2c Configured I2C communication interface.
IanBenzMaxim 1:e1c7c1c636af 58 /// @param ds7505_i2c_addr I2C bus address of the DS7505 in mbed format.
IanBenzMaxim 1:e1c7c1c636af 59 /// @param max44009_i2c_addr I2C bus address of the MAX44009 in mbed format.
IanBenzMaxim 1:e1c7c1c636af 60 /// @param ds2465 Interface to DS2465 on the Controller.
IanBenzMaxim 32:0a09505a656d 61 SensorNode(mbed::I2C & i2c, uint8_t ds7505_i2c_addr,
IanBenzMaxim 32:0a09505a656d 62 uint8_t max44009_i2c_addr, MaximInterface::DS2465 & ds2465);
IanBenzMaxim 32:0a09505a656d 63
IanBenzMaxim 1:e1c7c1c636af 64 /// Detect if an authentic Sensor Node is connected.
IanBenzMaxim 1:e1c7c1c636af 65 /// @param userEntropy Additional entropy to supply to the RNG.
IanBenzMaxim 1:e1c7c1c636af 66 /// @returns Authentic on success.
IanBenzMaxim 1:e1c7c1c636af 67 State detect(unsigned int userEntropy);
IanBenzMaxim 32:0a09505a656d 68
IanBenzMaxim 1:e1c7c1c636af 69 /// Read the current temperature and filter life measurements with authentication.
IanBenzMaxim 1:e1c7c1c636af 70 /// @param userEntropy Additional entropy to supply to the RNG.
IanBenzMaxim 1:e1c7c1c636af 71 /// @param sensorData Measurements output location.
IanBenzMaxim 1:e1c7c1c636af 72 /// @returns Authentic on success.
IanBenzMaxim 32:0a09505a656d 73 State authenticatedReadSensorData(unsigned int userEntropy,
IanBenzMaxim 32:0a09505a656d 74 SensorData & sensorData);
IanBenzMaxim 32:0a09505a656d 75
IanBenzMaxim 1:e1c7c1c636af 76 /// Reads the current temperature and filter life measurements.
IanBenzMaxim 1:e1c7c1c636af 77 /// @param sensorData Measurements output location.
IanBenzMaxim 1:e1c7c1c636af 78 /// @returns True on success or false if unable to communicate with a sensor.
IanBenzMaxim 1:e1c7c1c636af 79 bool readSensorData(SensorData & sensorData);
IanBenzMaxim 32:0a09505a656d 80
IanBenzMaxim 1:e1c7c1c636af 81 /// Get the ROM ID for this sensor node.
IanBenzMaxim 32:0a09505a656d 82 const MaximInterface::RomId romId() const { return romId_; }
IanBenzMaxim 32:0a09505a656d 83
IanBenzMaxim 1:e1c7c1c636af 84 /// Get the initial lux measurement for this sensor node.
IanBenzMaxim 32:0a09505a656d 85 double initialLux() const { return initialLux_; }
IanBenzMaxim 32:0a09505a656d 86
IanBenzMaxim 1:e1c7c1c636af 87 // Grant access to hardware interfaces for provisioning.
IanBenzMaxim 32:0a09505a656d 88 friend bool provisionCoprocessor(MaximInterface::DS2465 & ds2465);
IanBenzMaxim 25:37ea43ff81be 89 friend bool provisionSensorNode(SensorNode & sensorNode, bool validSecret);
IanBenzMaxim 32:0a09505a656d 90
IanBenzMaxim 1:e1c7c1c636af 91 private:
IanBenzMaxim 1:e1c7c1c636af 92 /// Authenticated data stored in DS28E15.
IanBenzMaxim 32:0a09505a656d 93 struct AuthData {
IanBenzMaxim 6:b6bafd0a7013 94 static const uint8_t initialFilterLife = 100;
IanBenzMaxim 32:0a09505a656d 95 MaximInterface::DS28E15::Segment segment;
IanBenzMaxim 32:0a09505a656d 96 int pageNum, segmentNum;
IanBenzMaxim 32:0a09505a656d 97
IanBenzMaxim 32:0a09505a656d 98 uint8_t & filterLife() { return segment[0]; }
IanBenzMaxim 32:0a09505a656d 99 const uint8_t & filterLife() const { return segment[0]; }
IanBenzMaxim 32:0a09505a656d 100
IanBenzMaxim 32:0a09505a656d 101 AuthData() : pageNum(0), segmentNum(0) { reset(); }
IanBenzMaxim 32:0a09505a656d 102
IanBenzMaxim 32:0a09505a656d 103 void reset() {
IanBenzMaxim 25:37ea43ff81be 104 segment.fill(0);
IanBenzMaxim 32:0a09505a656d 105 filterLife() = initialFilterLife;
IanBenzMaxim 1:e1c7c1c636af 106 }
IanBenzMaxim 1:e1c7c1c636af 107 };
IanBenzMaxim 32:0a09505a656d 108
IanBenzMaxim 1:e1c7c1c636af 109 /// Padding value used in creation of the Slave Secret.
IanBenzMaxim 6:b6bafd0a7013 110 static const uint8_t defaultPaddingByte = 0x00;
IanBenzMaxim 32:0a09505a656d 111
IanBenzMaxim 32:0a09505a656d 112 static const MaximInterface::ManId manId;
IanBenzMaxim 32:0a09505a656d 113
IanBenzMaxim 1:e1c7c1c636af 114 /// Indicates hardware RNG is initialized.
IanBenzMaxim 1:e1c7c1c636af 115 static bool rngInitialized;
IanBenzMaxim 1:e1c7c1c636af 116 // Initialize the hardware RNG.
IanBenzMaxim 1:e1c7c1c636af 117 static void initializeRng();
IanBenzMaxim 32:0a09505a656d 118
IanBenzMaxim 1:e1c7c1c636af 119 /// Initial lux measurement taken on initialization.
IanBenzMaxim 1:e1c7c1c636af 120 /// Assumed to be the maximum intensity that will be observed.
IanBenzMaxim 32:0a09505a656d 121 double initialLux_;
IanBenzMaxim 32:0a09505a656d 122
IanBenzMaxim 1:e1c7c1c636af 123 /// Authenticated data stored on the DS28E15.
IanBenzMaxim 1:e1c7c1c636af 124 AuthData authData;
IanBenzMaxim 32:0a09505a656d 125
IanBenzMaxim 1:e1c7c1c636af 126 // Hardware interfaces
IanBenzMaxim 32:0a09505a656d 127 MaximInterface::DS2465 & ds2465; ///< Interface to DS2465 on Controller.
IanBenzMaxim 32:0a09505a656d 128 MaximInterface::DS28E15 ds28e15; ///< DS28E15 for authentication.
IanBenzMaxim 32:0a09505a656d 129 MaximInterface::RomId romId_;
IanBenzMaxim 32:0a09505a656d 130 DS7505 ds7505; ///< DS7505 temperature sensor.
IanBenzMaxim 1:e1c7c1c636af 131 MAX44009 max44009; ///< MAX44009 optical light sensor.
IanBenzMaxim 32:0a09505a656d 132
IanBenzMaxim 1:e1c7c1c636af 133 /// Initialize sensors for measurement.
IanBenzMaxim 1:e1c7c1c636af 134 /// @returns True on success.
IanBenzMaxim 1:e1c7c1c636af 135 bool initializeSensors();
IanBenzMaxim 32:0a09505a656d 136
IanBenzMaxim 1:e1c7c1c636af 137 /// Select the Slave Secret for this Sensor Node in the Controller.
IanBenzMaxim 1:e1c7c1c636af 138 /// @returns True on success.
IanBenzMaxim 1:e1c7c1c636af 139 bool setSecret();
IanBenzMaxim 32:0a09505a656d 140
IanBenzMaxim 1:e1c7c1c636af 141 /// Check if the Sensor Board is provisioned.
IanBenzMaxim 1:e1c7c1c636af 142 /// @param provisioned True if the sensor board is provisioned.
IanBenzMaxim 1:e1c7c1c636af 143 /// @returns True if provisioning check was successful.
IanBenzMaxim 1:e1c7c1c636af 144 bool checkProvisioned(bool & provisioned);
IanBenzMaxim 32:0a09505a656d 145
IanBenzMaxim 1:e1c7c1c636af 146 /// Check if the Sensor Board is authentic.
IanBenzMaxim 1:e1c7c1c636af 147 /// @param userEntropy Additional entropy to supply to the RNG.
IanBenzMaxim 1:e1c7c1c636af 148 /// @returns True if the Sensor Board passed the authentication check.
IanBenzMaxim 1:e1c7c1c636af 149 bool checkAuthentic(unsigned int userEntropy);
IanBenzMaxim 32:0a09505a656d 150
IanBenzMaxim 1:e1c7c1c636af 151 /// Checks if the authenticated data stored in the DS28E15 needs to be updated.
IanBenzMaxim 1:e1c7c1c636af 152 /// Updates the authenticated data if necessary.
IanBenzMaxim 1:e1c7c1c636af 153 /// @param sensorData Current sensor data to check.
IanBenzMaxim 1:e1c7c1c636af 154 /// @returns True on success.
IanBenzMaxim 1:e1c7c1c636af 155 bool checkAndWriteAuthData(SensorData & sensorData);
IanBenzMaxim 1:e1c7c1c636af 156 };
IanBenzMaxim 1:e1c7c1c636af 157
IanBenzMaxim 1:e1c7c1c636af 158 #endif