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@24:434330962308, 2016-10-19 (annotated)

Committer:
IanBenzMaxim
Date:
Wed Oct 19 13:23:41 2016 -0500
Revision:
24:434330962308
Parent:
18:6fbf7e7b6ab6
Child:
25:37ea43ff81be
Fixed include guards.

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 1:e1c7c1c636af 31 *******************************************************************************
IanBenzMaxim 1:e1c7c1c636af 32 */
IanBenzMaxim 1:e1c7c1c636af 33
IanBenzMaxim 24:434330962308 34 #ifndef SENSORNODE_HPP
IanBenzMaxim 24:434330962308 35 #define SENSORNODE_HPP
IanBenzMaxim 1:e1c7c1c636af 36
IanBenzMaxim 6:b6bafd0a7013 37 #include <stdint.h>
IanBenzMaxim 1:e1c7c1c636af 38 #include <cstring>
IanBenzMaxim 1:e1c7c1c636af 39
IanBenzMaxim 1:e1c7c1c636af 40 #include "DS7505.hpp"
IanBenzMaxim 1:e1c7c1c636af 41 #include "MAX44009.hpp"
IanBenzMaxim 18:6fbf7e7b6ab6 42 #include "Slaves/Authenticators/DS28E15_22_25/DS28E15.h"
IanBenzMaxim 1:e1c7c1c636af 43
IanBenzMaxim 1:e1c7c1c636af 44 class SensorData;
IanBenzMaxim 6:b6bafd0a7013 45 namespace OneWire
IanBenzMaxim 6:b6bafd0a7013 46 {
IanBenzMaxim 6:b6bafd0a7013 47 class RomId;
IanBenzMaxim 8:594529956266 48 class DS2465;
IanBenzMaxim 6:b6bafd0a7013 49 }
IanBenzMaxim 1:e1c7c1c636af 50 namespace mbed { class I2C; }
IanBenzMaxim 1:e1c7c1c636af 51
IanBenzMaxim 1:e1c7c1c636af 52 /// Interface to the Authenticated Sensor Node peripheral board.
IanBenzMaxim 1:e1c7c1c636af 53 class SensorNode
IanBenzMaxim 1:e1c7c1c636af 54 {
IanBenzMaxim 1:e1c7c1c636af 55 public:
IanBenzMaxim 1:e1c7c1c636af 56 enum State
IanBenzMaxim 1:e1c7c1c636af 57 {
IanBenzMaxim 1:e1c7c1c636af 58 UnableToCommunicate, ///< I2C or 1-Wire communication failure.
IanBenzMaxim 1:e1c7c1c636af 59 NotProvisioned, ///< DS28E15 has not been provisioned.
IanBenzMaxim 1:e1c7c1c636af 60 NotAuthentic, ///< DS28E15 is not authentic.
IanBenzMaxim 1:e1c7c1c636af 61 Authentic ///< DS218E15 is authentic.
IanBenzMaxim 1:e1c7c1c636af 62 };
IanBenzMaxim 1:e1c7c1c636af 63
IanBenzMaxim 1:e1c7c1c636af 64 /// @param i2c Configured I2C communication interface.
IanBenzMaxim 1:e1c7c1c636af 65 /// @param ds7505_i2c_addr I2C bus address of the DS7505 in mbed format.
IanBenzMaxim 1:e1c7c1c636af 66 /// @param max44009_i2c_addr I2C bus address of the MAX44009 in mbed format.
IanBenzMaxim 1:e1c7c1c636af 67 /// @param ds2465 Interface to DS2465 on the Controller.
IanBenzMaxim 8:594529956266 68 SensorNode(mbed::I2C & i2c, uint8_t ds7505_i2c_addr, uint8_t max44009_i2c_addr, OneWire::DS2465 & ds2465);
IanBenzMaxim 1:e1c7c1c636af 69
IanBenzMaxim 1:e1c7c1c636af 70 /// Detect if an authentic Sensor Node is connected.
IanBenzMaxim 1:e1c7c1c636af 71 /// @param userEntropy Additional entropy to supply to the RNG.
IanBenzMaxim 1:e1c7c1c636af 72 /// @returns Authentic on success.
IanBenzMaxim 1:e1c7c1c636af 73 State detect(unsigned int userEntropy);
IanBenzMaxim 1:e1c7c1c636af 74
IanBenzMaxim 1:e1c7c1c636af 75 /// Read the current temperature and filter life measurements with authentication.
IanBenzMaxim 1:e1c7c1c636af 76 /// @param userEntropy Additional entropy to supply to the RNG.
IanBenzMaxim 1:e1c7c1c636af 77 /// @param sensorData Measurements output location.
IanBenzMaxim 1:e1c7c1c636af 78 /// @returns Authentic on success.
IanBenzMaxim 1:e1c7c1c636af 79 State authenticatedReadSensorData(unsigned int userEntropy, SensorData & sensorData);
IanBenzMaxim 1:e1c7c1c636af 80
IanBenzMaxim 1:e1c7c1c636af 81 /// Reads the current temperature and filter life measurements.
IanBenzMaxim 1:e1c7c1c636af 82 /// @param sensorData Measurements output location.
IanBenzMaxim 1:e1c7c1c636af 83 /// @returns True on success or false if unable to communicate with a sensor.
IanBenzMaxim 1:e1c7c1c636af 84 bool readSensorData(SensorData & sensorData);
IanBenzMaxim 1:e1c7c1c636af 85
IanBenzMaxim 1:e1c7c1c636af 86 /// Get the ROM ID for this sensor node.
IanBenzMaxim 18:6fbf7e7b6ab6 87 const OneWire::RomId romId() const { return ds28e15.romId(); }
IanBenzMaxim 1:e1c7c1c636af 88
IanBenzMaxim 1:e1c7c1c636af 89 /// Get the initial lux measurement for this sensor node.
IanBenzMaxim 1:e1c7c1c636af 90 double initialLux() const { return m_initialLux; }
IanBenzMaxim 1:e1c7c1c636af 91
IanBenzMaxim 1:e1c7c1c636af 92 // Grant access to hardware interfaces for provisioning.
IanBenzMaxim 1:e1c7c1c636af 93 friend class Factory;
IanBenzMaxim 1:e1c7c1c636af 94
IanBenzMaxim 1:e1c7c1c636af 95 private:
IanBenzMaxim 1:e1c7c1c636af 96 /// Authenticated data stored in DS28E15.
IanBenzMaxim 1:e1c7c1c636af 97 struct AuthData
IanBenzMaxim 1:e1c7c1c636af 98 {
IanBenzMaxim 6:b6bafd0a7013 99 static const uint8_t initialFilterLife = 100;
IanBenzMaxim 8:594529956266 100 OneWire::DS28E15_22_25::Segment segment;
IanBenzMaxim 6:b6bafd0a7013 101 uint8_t & filterLife;
IanBenzMaxim 1:e1c7c1c636af 102 unsigned int pageNum, segmentNum;
IanBenzMaxim 1:e1c7c1c636af 103
IanBenzMaxim 1:e1c7c1c636af 104 AuthData() : filterLife(segment[0]), pageNum(0), segmentNum(0) { reset(); }
IanBenzMaxim 1:e1c7c1c636af 105
IanBenzMaxim 1:e1c7c1c636af 106 void reset()
IanBenzMaxim 1:e1c7c1c636af 107 {
IanBenzMaxim 1:e1c7c1c636af 108 std::memset(segment, 0, segment.length);
IanBenzMaxim 1:e1c7c1c636af 109 filterLife = initialFilterLife;
IanBenzMaxim 1:e1c7c1c636af 110 }
IanBenzMaxim 1:e1c7c1c636af 111 };
IanBenzMaxim 1:e1c7c1c636af 112
IanBenzMaxim 1:e1c7c1c636af 113 /// Padding value used in creation of the Slave Secret.
IanBenzMaxim 6:b6bafd0a7013 114 static const uint8_t defaultPaddingByte = 0x00;
IanBenzMaxim 1:e1c7c1c636af 115
IanBenzMaxim 1:e1c7c1c636af 116 /// Indicates hardware RNG is initialized.
IanBenzMaxim 1:e1c7c1c636af 117 static bool rngInitialized;
IanBenzMaxim 1:e1c7c1c636af 118 // Initialize the hardware RNG.
IanBenzMaxim 1:e1c7c1c636af 119 static void initializeRng();
IanBenzMaxim 1:e1c7c1c636af 120
IanBenzMaxim 1:e1c7c1c636af 121 /// Initial lux measurement taken on initialization.
IanBenzMaxim 1:e1c7c1c636af 122 /// Assumed to be the maximum intensity that will be observed.
IanBenzMaxim 1:e1c7c1c636af 123 double m_initialLux;
IanBenzMaxim 1:e1c7c1c636af 124
IanBenzMaxim 1:e1c7c1c636af 125 /// Authenticated data stored on the DS28E15.
IanBenzMaxim 1:e1c7c1c636af 126 AuthData authData;
IanBenzMaxim 1:e1c7c1c636af 127
IanBenzMaxim 1:e1c7c1c636af 128 // Hardware interfaces
IanBenzMaxim 9:bc3d211d75ce 129 OneWire::DS2465 & ds2465; ///< Interface to DS2465 on Controller.
IanBenzMaxim 9:bc3d211d75ce 130 OneWire::SingledropRomIterator selector;
IanBenzMaxim 18:6fbf7e7b6ab6 131 OneWire::DS28E15 ds28e15; ///< DS28E15 for authentication.
IanBenzMaxim 1:e1c7c1c636af 132 DS7505 ds7505; ///< DS7505 temperature sensor.
IanBenzMaxim 1:e1c7c1c636af 133 MAX44009 max44009; ///< MAX44009 optical light sensor.
IanBenzMaxim 1:e1c7c1c636af 134
IanBenzMaxim 1:e1c7c1c636af 135 /// Initialize sensors for measurement.
IanBenzMaxim 1:e1c7c1c636af 136 /// @returns True on success.
IanBenzMaxim 1:e1c7c1c636af 137 bool initializeSensors();
IanBenzMaxim 1:e1c7c1c636af 138
IanBenzMaxim 1:e1c7c1c636af 139 /// Select the Slave Secret for this Sensor Node in the Controller.
IanBenzMaxim 1:e1c7c1c636af 140 /// @returns True on success.
IanBenzMaxim 1:e1c7c1c636af 141 bool setSecret();
IanBenzMaxim 1:e1c7c1c636af 142
IanBenzMaxim 1:e1c7c1c636af 143 /// Check if the Sensor Board is provisioned.
IanBenzMaxim 1:e1c7c1c636af 144 /// @param provisioned True if the sensor board is provisioned.
IanBenzMaxim 1:e1c7c1c636af 145 /// @returns True if provisioning check was successful.
IanBenzMaxim 1:e1c7c1c636af 146 bool checkProvisioned(bool & provisioned);
IanBenzMaxim 1:e1c7c1c636af 147
IanBenzMaxim 1:e1c7c1c636af 148 /// Check if the Sensor Board is authentic.
IanBenzMaxim 1:e1c7c1c636af 149 /// @param userEntropy Additional entropy to supply to the RNG.
IanBenzMaxim 1:e1c7c1c636af 150 /// @returns True if the Sensor Board passed the authentication check.
IanBenzMaxim 1:e1c7c1c636af 151 bool checkAuthentic(unsigned int userEntropy);
IanBenzMaxim 1:e1c7c1c636af 152
IanBenzMaxim 1:e1c7c1c636af 153 /// Checks if the authenticated data stored in the DS28E15 needs to be updated.
IanBenzMaxim 1:e1c7c1c636af 154 /// Updates the authenticated data if necessary.
IanBenzMaxim 1:e1c7c1c636af 155 /// @param sensorData Current sensor data to check.
IanBenzMaxim 1:e1c7c1c636af 156 /// @returns True on success.
IanBenzMaxim 1:e1c7c1c636af 157 bool checkAndWriteAuthData(SensorData & sensorData);
IanBenzMaxim 1:e1c7c1c636af 158 };
IanBenzMaxim 1:e1c7c1c636af 159
IanBenzMaxim 1:e1c7c1c636af 160 #endif