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.

Factory.cpp@25:37ea43ff81be, 2016-12-16 (annotated)

Committer:
IanBenzMaxim
Date:
Fri Dec 16 10:47:34 2016 -0600
Revision:
25:37ea43ff81be
Parent:
18:6fbf7e7b6ab6
Child:
32:0a09505a656d
Now using unique secret for data signing between mbed node and server. Updated to mbed 5 for better platform support. Updated to latest version of 1-Wire library.

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 1:e1c7c1c636af 34 #include "Factory.hpp"
IanBenzMaxim 1:e1c7c1c636af 35 #include "SensorNode.hpp"
IanBenzMaxim 6:b6bafd0a7013 36 #include "Masters/DS2465/DS2465.h"
IanBenzMaxim 16:6bce01c1dd90 37 #include "Slaves/Authenticators/DS28E15_22_25/DS28E15_22_25.h"
IanBenzMaxim 6:b6bafd0a7013 38 #include "wait_api.h"
IanBenzMaxim 1:e1c7c1c636af 39
IanBenzMaxim 8:594529956266 40 using namespace OneWire;
IanBenzMaxim 6:b6bafd0a7013 41
IanBenzMaxim 25:37ea43ff81be 42 /// The valid master secret for the system.
IanBenzMaxim 25:37ea43ff81be 43 static const DS2465::Secret masterSecret = { { 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x21,
IanBenzMaxim 25:37ea43ff81be 44 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x2F, 0x31, 0x32 } };
IanBenzMaxim 25:37ea43ff81be 45 /// An invalid master secret for example purposes.
IanBenzMaxim 25:37ea43ff81be 46 static const DS2465::Secret invalidMasterSecret = { { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
IanBenzMaxim 25:37ea43ff81be 47 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } };
IanBenzMaxim 1:e1c7c1c636af 48
IanBenzMaxim 25:37ea43ff81be 49 bool provisionCoprocessor(DS2465 & ds2465)
IanBenzMaxim 1:e1c7c1c636af 50 {
IanBenzMaxim 6:b6bafd0a7013 51 bool result = (ds2465.setMasterSecret(masterSecret) == ISha256MacCoproc::Success);
IanBenzMaxim 1:e1c7c1c636af 52 if (result)
IanBenzMaxim 1:e1c7c1c636af 53 {
IanBenzMaxim 1:e1c7c1c636af 54 SensorNode::AuthData authData;
IanBenzMaxim 1:e1c7c1c636af 55 DS28E15_22_25::Page pageData;
IanBenzMaxim 25:37ea43ff81be 56 pageData.fill(uint8_t(SensorNode::defaultPaddingByte));
IanBenzMaxim 25:37ea43ff81be 57 std::copy(authData.segment.begin(), authData.segment.end(), pageData.begin());
IanBenzMaxim 25:37ea43ff81be 58 result = (ds2465.writeScratchpad(pageData.data(), pageData.size()) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 59 }
IanBenzMaxim 1:e1c7c1c636af 60 if (result)
IanBenzMaxim 1:e1c7c1c636af 61 {
IanBenzMaxim 1:e1c7c1c636af 62 result = (ds2465.copyScratchpadToPage(0) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 63 if (result)
IanBenzMaxim 1:e1c7c1c636af 64 wait_ms(DS2465::eepromPageWriteDelayMs);
IanBenzMaxim 1:e1c7c1c636af 65 }
IanBenzMaxim 1:e1c7c1c636af 66
IanBenzMaxim 1:e1c7c1c636af 67 return result;
IanBenzMaxim 1:e1c7c1c636af 68 }
IanBenzMaxim 1:e1c7c1c636af 69
IanBenzMaxim 25:37ea43ff81be 70 bool provisionSensorNode(SensorNode & sensorNode, bool validSecret)
IanBenzMaxim 1:e1c7c1c636af 71 {
IanBenzMaxim 1:e1c7c1c636af 72 const int blockNum = sensorNode.authData.pageNum / 2;
IanBenzMaxim 1:e1c7c1c636af 73 const DS28E15_22_25::BlockProtection desiredProtection(false, false, false, true, blockNum); // Authentication Protection only
IanBenzMaxim 1:e1c7c1c636af 74
IanBenzMaxim 1:e1c7c1c636af 75 // Reset to starting defaults
IanBenzMaxim 1:e1c7c1c636af 76 sensorNode.authData.reset();
IanBenzMaxim 1:e1c7c1c636af 77
IanBenzMaxim 1:e1c7c1c636af 78 // Read current protection status
IanBenzMaxim 1:e1c7c1c636af 79 DS28E15_22_25::BlockProtection protectionStatus;
IanBenzMaxim 1:e1c7c1c636af 80 bool result;
IanBenzMaxim 9:bc3d211d75ce 81 // Read block protections
IanBenzMaxim 18:6fbf7e7b6ab6 82 result = (sensorNode.ds28e15.readBlockProtection(blockNum, protectionStatus) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 83 // Check if invalid protections are set
IanBenzMaxim 1:e1c7c1c636af 84 if (result)
IanBenzMaxim 1:e1c7c1c636af 85 result = ((protectionStatus.statusByte() & ~(desiredProtection.statusByte())) == 0x00);
IanBenzMaxim 1:e1c7c1c636af 86 // Load secret into scratchpad
IanBenzMaxim 1:e1c7c1c636af 87 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 88 result = (sensorNode.ds28e15.writeScratchpad(validSecret ? masterSecret : invalidMasterSecret) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 89 // Load master secret from scratchpad without locking
IanBenzMaxim 1:e1c7c1c636af 90 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 91 result = (sensorNode.ds28e15.loadSecret(false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 92
IanBenzMaxim 1:e1c7c1c636af 93 // Setup is complete if not using a valid secret
IanBenzMaxim 1:e1c7c1c636af 94 if (!validSecret)
IanBenzMaxim 1:e1c7c1c636af 95 return result;
IanBenzMaxim 1:e1c7c1c636af 96
IanBenzMaxim 1:e1c7c1c636af 97 // Create constant partial secret
IanBenzMaxim 1:e1c7c1c636af 98 DS28E15_22_25::Scratchpad partialSecret;
IanBenzMaxim 1:e1c7c1c636af 99 DS28E15_22_25::Page pageData;
IanBenzMaxim 25:37ea43ff81be 100 partialSecret.fill(uint8_t(SensorNode::defaultPaddingByte));
IanBenzMaxim 1:e1c7c1c636af 101
IanBenzMaxim 1:e1c7c1c636af 102 // Read page data
IanBenzMaxim 1:e1c7c1c636af 103 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 104 result = (sensorNode.ds28e15.readPage(sensorNode.authData.pageNum, pageData, false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 105 // Load partial secret into scratchpad
IanBenzMaxim 1:e1c7c1c636af 106 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 107 result = (sensorNode.ds28e15.writeScratchpad(partialSecret) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 108 // Compute secret
IanBenzMaxim 1:e1c7c1c636af 109 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 110 result = (sensorNode.ds28e15.computeSecret(sensorNode.authData.pageNum, false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 111 // Configure slave secret on DS2465
IanBenzMaxim 1:e1c7c1c636af 112 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 113 result = (DS28E15_22_25::computeNextSecret(sensorNode.ds2465, pageData, sensorNode.authData.pageNum, partialSecret, sensorNode.ds28e15.romId(), sensorNode.ds28e15.manId()) == ISha256MacCoproc::Success);
IanBenzMaxim 1:e1c7c1c636af 114 // Enable authentication protection if not set
IanBenzMaxim 1:e1c7c1c636af 115 if (result && (protectionStatus != desiredProtection))
IanBenzMaxim 18:6fbf7e7b6ab6 116 result = (sensorNode.ds28e15.writeAuthBlockProtection(sensorNode.ds2465, desiredProtection, protectionStatus) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 117 // Write initial filter life and set all other segments to default value
IanBenzMaxim 1:e1c7c1c636af 118 if (result)
IanBenzMaxim 1:e1c7c1c636af 119 {
IanBenzMaxim 1:e1c7c1c636af 120 DS28E15_22_25::Segment blankSegment;
IanBenzMaxim 25:37ea43ff81be 121 blankSegment.fill(uint8_t(SensorNode::defaultPaddingByte));
IanBenzMaxim 6:b6bafd0a7013 122 for (size_t i = 0; i < DS28E15_22_25::segmentsPerPage; i++)
IanBenzMaxim 1:e1c7c1c636af 123 {
IanBenzMaxim 18:6fbf7e7b6ab6 124 result = (sensorNode.ds28e15.writeAuthSegment(sensorNode.ds2465, sensorNode.authData.pageNum, i,
IanBenzMaxim 9:bc3d211d75ce 125 ((i == sensorNode.authData.segmentNum) ? sensorNode.authData.segment : blankSegment),
IanBenzMaxim 25:37ea43ff81be 126 DS28E15_22_25::segmentFromPage(i, pageData), false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 127
IanBenzMaxim 1:e1c7c1c636af 128 if (!result)
IanBenzMaxim 1:e1c7c1c636af 129 break;
IanBenzMaxim 1:e1c7c1c636af 130 }
IanBenzMaxim 1:e1c7c1c636af 131 }
IanBenzMaxim 1:e1c7c1c636af 132
IanBenzMaxim 1:e1c7c1c636af 133 // Reload secret with known page values
IanBenzMaxim 1:e1c7c1c636af 134 // Load master secret into scratchpad
IanBenzMaxim 1:e1c7c1c636af 135 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 136 result = (sensorNode.ds28e15.writeScratchpad(masterSecret) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 137 // Load master secret
IanBenzMaxim 1:e1c7c1c636af 138 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 139 result = (sensorNode.ds28e15.loadSecret(false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 140 // Read page data
IanBenzMaxim 1:e1c7c1c636af 141 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 142 result = (sensorNode.ds28e15.readPage(sensorNode.authData.pageNum, pageData, false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 143 // Write partial secret to scratchpad
IanBenzMaxim 1:e1c7c1c636af 144 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 145 result = (sensorNode.ds28e15.writeScratchpad(partialSecret) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 146 // Compute secret
IanBenzMaxim 1:e1c7c1c636af 147 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 148 result = (sensorNode.ds28e15.computeSecret(sensorNode.authData.pageNum, false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 149 // Configure slave secret on DS2465
IanBenzMaxim 1:e1c7c1c636af 150 if (result)
IanBenzMaxim 18:6fbf7e7b6ab6 151 result = (DS28E15_22_25::computeNextSecret(sensorNode.ds2465, pageData, sensorNode.authData.pageNum, partialSecret, sensorNode.ds28e15.romId(), sensorNode.ds28e15.manId()) == ISha256MacCoproc::Success);
IanBenzMaxim 1:e1c7c1c636af 152
IanBenzMaxim 1:e1c7c1c636af 153 return result;
IanBenzMaxim 1:e1c7c1c636af 154 }