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@8:594529956266, 2016-05-14 (annotated)

Committer:
IanBenzMaxim
Date:
Sat May 14 14:28:31 2016 -0500
Revision:
8:594529956266
Parent:
7:e24f0b29f1f7
Child:
9:bc3d211d75ce
Updated following downstream restructuring in OneWire 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 1:e1c7c1c636af 36 #include "common.hpp"
IanBenzMaxim 8:594529956266 37 #include "RomCommands.h"
IanBenzMaxim 6:b6bafd0a7013 38 #include "Masters/DS2465/DS2465.h"
IanBenzMaxim 6:b6bafd0a7013 39 #include "Authenticators/DS28E15_22_25/DS28E15_22_25.h"
IanBenzMaxim 6:b6bafd0a7013 40 #include "wait_api.h"
IanBenzMaxim 1:e1c7c1c636af 41
IanBenzMaxim 8:594529956266 42 using namespace OneWire;
IanBenzMaxim 8:594529956266 43 using namespace OneWire::RomCommands;
IanBenzMaxim 6:b6bafd0a7013 44
IanBenzMaxim 6:b6bafd0a7013 45 const uint8_t Factory::masterSecret[] = { 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x21,
IanBenzMaxim 1:e1c7c1c636af 46 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x2F, 0x31, 0x32 };
IanBenzMaxim 6:b6bafd0a7013 47 const uint8_t Factory::invalidMasterSecret[] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
IanBenzMaxim 1:e1c7c1c636af 48 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
IanBenzMaxim 1:e1c7c1c636af 49
IanBenzMaxim 1:e1c7c1c636af 50 bool Factory::provision(DS2465 & ds2465)
IanBenzMaxim 1:e1c7c1c636af 51 {
IanBenzMaxim 6:b6bafd0a7013 52 bool result = (ds2465.setMasterSecret(masterSecret) == ISha256MacCoproc::Success);
IanBenzMaxim 1:e1c7c1c636af 53 if (result)
IanBenzMaxim 1:e1c7c1c636af 54 {
IanBenzMaxim 1:e1c7c1c636af 55 SensorNode::AuthData authData;
IanBenzMaxim 1:e1c7c1c636af 56 DS28E15_22_25::Page pageData;
IanBenzMaxim 1:e1c7c1c636af 57 std::memset(pageData, SensorNode::defaultPaddingByte, pageData.length);
IanBenzMaxim 1:e1c7c1c636af 58 std::memcpy(pageData, authData.segment, authData.segment.length);
IanBenzMaxim 1:e1c7c1c636af 59 result = (ds2465.writeScratchpad(pageData, pageData.length) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 60 }
IanBenzMaxim 1:e1c7c1c636af 61 if (result)
IanBenzMaxim 1:e1c7c1c636af 62 {
IanBenzMaxim 1:e1c7c1c636af 63 result = (ds2465.copyScratchpadToPage(0) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 64 if (result)
IanBenzMaxim 1:e1c7c1c636af 65 wait_ms(DS2465::eepromPageWriteDelayMs);
IanBenzMaxim 1:e1c7c1c636af 66 }
IanBenzMaxim 1:e1c7c1c636af 67
IanBenzMaxim 1:e1c7c1c636af 68 return result;
IanBenzMaxim 1:e1c7c1c636af 69 }
IanBenzMaxim 1:e1c7c1c636af 70
IanBenzMaxim 1:e1c7c1c636af 71 bool Factory::provision(SensorNode & sensorNode, bool validSecret)
IanBenzMaxim 1:e1c7c1c636af 72 {
IanBenzMaxim 1:e1c7c1c636af 73 const int blockNum = sensorNode.authData.pageNum / 2;
IanBenzMaxim 1:e1c7c1c636af 74 const DS28E15_22_25::BlockProtection desiredProtection(false, false, false, true, blockNum); // Authentication Protection only
IanBenzMaxim 1:e1c7c1c636af 75
IanBenzMaxim 1:e1c7c1c636af 76 // Reset to starting defaults
IanBenzMaxim 1:e1c7c1c636af 77 sensorNode.authData.reset();
IanBenzMaxim 1:e1c7c1c636af 78
IanBenzMaxim 1:e1c7c1c636af 79 // Read current protection status
IanBenzMaxim 1:e1c7c1c636af 80 DS28E15_22_25::BlockProtection protectionStatus;
IanBenzMaxim 1:e1c7c1c636af 81 bool result;
IanBenzMaxim 1:e1c7c1c636af 82 // Select device through Skip ROM
IanBenzMaxim 8:594529956266 83 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 84 if (result)
IanBenzMaxim 1:e1c7c1c636af 85 result = (sensorNode.ds28e15_22_25.readBlockProtection(blockNum, protectionStatus) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 86 // Check if invalid protections are set
IanBenzMaxim 1:e1c7c1c636af 87 if (result)
IanBenzMaxim 1:e1c7c1c636af 88 result = ((protectionStatus.statusByte() & ~(desiredProtection.statusByte())) == 0x00);
IanBenzMaxim 1:e1c7c1c636af 89 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 90 if (result)
IanBenzMaxim 8:594529956266 91 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 92 // Load secret into scratchpad
IanBenzMaxim 1:e1c7c1c636af 93 if (result)
IanBenzMaxim 1:e1c7c1c636af 94 result = (sensorNode.ds28e15_22_25.writeScratchpad(validSecret ? masterSecret : invalidMasterSecret) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 95 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 96 if (result)
IanBenzMaxim 8:594529956266 97 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 98 // Load master secret from scratchpad without locking
IanBenzMaxim 1:e1c7c1c636af 99 if (result)
IanBenzMaxim 1:e1c7c1c636af 100 result = (sensorNode.ds28e15_22_25.loadSecret(false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 101
IanBenzMaxim 1:e1c7c1c636af 102 // Setup is complete if not using a valid secret
IanBenzMaxim 1:e1c7c1c636af 103 if (!validSecret)
IanBenzMaxim 1:e1c7c1c636af 104 return result;
IanBenzMaxim 1:e1c7c1c636af 105
IanBenzMaxim 1:e1c7c1c636af 106 // Create constant partial secret
IanBenzMaxim 1:e1c7c1c636af 107 DS28E15_22_25::Scratchpad partialSecret;
IanBenzMaxim 1:e1c7c1c636af 108 DS28E15_22_25::Page pageData;
IanBenzMaxim 1:e1c7c1c636af 109 std::memset(partialSecret, SensorNode::defaultPaddingByte, partialSecret.length);
IanBenzMaxim 1:e1c7c1c636af 110
IanBenzMaxim 1:e1c7c1c636af 111 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 112 if (result)
IanBenzMaxim 8:594529956266 113 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 114 // Read page data
IanBenzMaxim 1:e1c7c1c636af 115 if (result)
IanBenzMaxim 1:e1c7c1c636af 116 result = (sensorNode.ds28e15_22_25.readPage(sensorNode.authData.pageNum, pageData, false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 117 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 118 if (result)
IanBenzMaxim 8:594529956266 119 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 120 // Load partial secret into scratchpad
IanBenzMaxim 1:e1c7c1c636af 121 if (result)
IanBenzMaxim 1:e1c7c1c636af 122 result = (sensorNode.ds28e15_22_25.writeScratchpad(partialSecret) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 123 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 124 if (result)
IanBenzMaxim 8:594529956266 125 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 126 // Compute secret
IanBenzMaxim 1:e1c7c1c636af 127 if (result)
IanBenzMaxim 1:e1c7c1c636af 128 result = (sensorNode.ds28e15_22_25.computeSecret(sensorNode.authData.pageNum, false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 129 // Configure slave secret on DS2465
IanBenzMaxim 1:e1c7c1c636af 130 if (result)
IanBenzMaxim 6:b6bafd0a7013 131 result = (DS28E15_22_25::computeNextSecret(sensorNode.ds2465, pageData, sensorNode.authData.pageNum, partialSecret, sensorNode.ds28e15_22_25.romId, sensorNode.ds28e15_22_25.manId) == ISha256MacCoproc::Success);
IanBenzMaxim 1:e1c7c1c636af 132 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 133 if (result)
IanBenzMaxim 8:594529956266 134 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 135 // Enable authentication protection if not set
IanBenzMaxim 1:e1c7c1c636af 136 if (result && (protectionStatus != desiredProtection))
IanBenzMaxim 1:e1c7c1c636af 137 result = (sensorNode.ds28e15_22_25.writeAuthBlockProtection(sensorNode.ds2465, desiredProtection, protectionStatus) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 138 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 139 if (result)
IanBenzMaxim 8:594529956266 140 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 141 // Write initial filter life and set all other segments to default value
IanBenzMaxim 1:e1c7c1c636af 142 if (result)
IanBenzMaxim 1:e1c7c1c636af 143 {
IanBenzMaxim 1:e1c7c1c636af 144 DS28E15_22_25::Segment blankSegment;
IanBenzMaxim 1:e1c7c1c636af 145 std::memset(blankSegment, SensorNode::defaultPaddingByte, blankSegment.length);
IanBenzMaxim 6:b6bafd0a7013 146 for (size_t i = 0; i < DS28E15_22_25::segmentsPerPage; i++)
IanBenzMaxim 1:e1c7c1c636af 147 {
IanBenzMaxim 8:594529956266 148 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 149 if (result)
IanBenzMaxim 1:e1c7c1c636af 150 result = (sensorNode.ds28e15_22_25.writeAuthSegment(sensorNode.ds2465, sensorNode.authData.pageNum, i,
IanBenzMaxim 1:e1c7c1c636af 151 ((i == sensorNode.authData.segmentNum) ? sensorNode.authData.segment : blankSegment),
IanBenzMaxim 2:e67d29a371db 152 pageData.toSegment(i), false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 153
IanBenzMaxim 1:e1c7c1c636af 154 if (!result)
IanBenzMaxim 1:e1c7c1c636af 155 break;
IanBenzMaxim 1:e1c7c1c636af 156 }
IanBenzMaxim 1:e1c7c1c636af 157 }
IanBenzMaxim 1:e1c7c1c636af 158
IanBenzMaxim 1:e1c7c1c636af 159 // Reload secret with known page values
IanBenzMaxim 1:e1c7c1c636af 160 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 161 if (result)
IanBenzMaxim 8:594529956266 162 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 163 // Load master secret into scratchpad
IanBenzMaxim 1:e1c7c1c636af 164 if (result)
IanBenzMaxim 1:e1c7c1c636af 165 result = (sensorNode.ds28e15_22_25.writeScratchpad(masterSecret) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 166 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 167 if (result)
IanBenzMaxim 8:594529956266 168 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 169 // Load master secret
IanBenzMaxim 1:e1c7c1c636af 170 if (result)
IanBenzMaxim 1:e1c7c1c636af 171 result = (sensorNode.ds28e15_22_25.loadSecret(false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 172 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 173 if (result)
IanBenzMaxim 8:594529956266 174 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 175 // Read page data
IanBenzMaxim 1:e1c7c1c636af 176 if (result)
IanBenzMaxim 1:e1c7c1c636af 177 result = (sensorNode.ds28e15_22_25.readPage(sensorNode.authData.pageNum, pageData, false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 178 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 179 if (result)
IanBenzMaxim 8:594529956266 180 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 181 // Write partial secret to scratchpad
IanBenzMaxim 1:e1c7c1c636af 182 if (result)
IanBenzMaxim 1:e1c7c1c636af 183 result = (sensorNode.ds28e15_22_25.writeScratchpad(partialSecret) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 184 // Select device through Skip ROM
IanBenzMaxim 1:e1c7c1c636af 185 if (result)
IanBenzMaxim 8:594529956266 186 result = (OWSkipRom(sensorNode.ds2465) == OneWireMaster::Success);
IanBenzMaxim 1:e1c7c1c636af 187 // Compute secret
IanBenzMaxim 1:e1c7c1c636af 188 if (result)
IanBenzMaxim 1:e1c7c1c636af 189 result = (sensorNode.ds28e15_22_25.computeSecret(sensorNode.authData.pageNum, false) == OneWireSlave::Success);
IanBenzMaxim 1:e1c7c1c636af 190 // Configure slave secret on DS2465
IanBenzMaxim 1:e1c7c1c636af 191 if (result)
IanBenzMaxim 6:b6bafd0a7013 192 result = (DS28E15_22_25::computeNextSecret(sensorNode.ds2465, pageData, sensorNode.authData.pageNum, partialSecret, sensorNode.ds28e15_22_25.romId, sensorNode.ds28e15_22_25.manId) == ISha256MacCoproc::Success);
IanBenzMaxim 1:e1c7c1c636af 193
IanBenzMaxim 1:e1c7c1c636af 194 return result;
IanBenzMaxim 1:e1c7c1c636af 195 }