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/Factory.cpp@18:c2631e985780, 2019-12-03 (annotated)

Committer:
IanBenzMaxim
Date:
Tue Dec 03 12:56:25 2019 -0600
Revision:
18:c2631e985780
Parent:
16:a004191a79ab 
Updated MaximInterface to version 2.1.

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 16:a004191a79ab 33 #include <MaximInterfaceDevices/DS28C36_DS2476.hpp>
IanBenzMaxim 0:33d4e66780c0 34 #include "Factory.hpp"
IanBenzMaxim 0:33d4e66780c0 35
IanBenzMaxim 16:a004191a79ab 36 #define TRY MaximInterfaceCore_TRY
IanBenzMaxim 16:a004191a79ab 37 #define TRY_VALUE MaximInterfaceCore_TRY_VALUE
IanBenzMaxim 16:a004191a79ab 38
IanBenzMaxim 16:a004191a79ab 39 using MaximInterfaceCore::none;
IanBenzMaxim 16:a004191a79ab 40 using MaximInterfaceCore::Result;
IanBenzMaxim 16:a004191a79ab 41 using MaximInterfaceDevices::DS28C36;
IanBenzMaxim 16:a004191a79ab 42 using MaximInterfaceDevices::DS2476;
IanBenzMaxim 13:6a6225690c2e 43
IanBenzMaxim 0:33d4e66780c0 44 // Authority (web server) public key x-component.
IanBenzMaxim 16:a004191a79ab 45 static const DS28C36::Page::array authPublicKeyX = {
IanBenzMaxim 13:6a6225690c2e 46 0x7A, 0xB9, 0xCD, 0x00, 0x3F, 0x42, 0xF3, 0x30, 0x76, 0x25, 0x9B,
IanBenzMaxim 13:6a6225690c2e 47 0x6B, 0xFD, 0xC2, 0x6D, 0xE2, 0xDB, 0x59, 0xA8, 0xD9, 0xE0, 0x68,
IanBenzMaxim 13:6a6225690c2e 48 0x3E, 0x1B, 0xFF, 0x50, 0xCB, 0x6C, 0x18, 0xB6, 0xF2, 0xEB};
IanBenzMaxim 0:33d4e66780c0 49
IanBenzMaxim 0:33d4e66780c0 50 // Authority (web server) public key y-component.
IanBenzMaxim 16:a004191a79ab 51 static const DS28C36::Page::array authPublicKeyY = {
IanBenzMaxim 13:6a6225690c2e 52 0x7F, 0xFC, 0xEE, 0xDD, 0x77, 0xE9, 0x63, 0x07, 0x62, 0x37, 0x33,
IanBenzMaxim 13:6a6225690c2e 53 0x81, 0x17, 0x16, 0x58, 0x75, 0x12, 0x88, 0x85, 0x58, 0x57, 0xC0,
IanBenzMaxim 13:6a6225690c2e 54 0x15, 0xB8, 0x08, 0xDE, 0xB2, 0x3B, 0xD7, 0x8A, 0x9D, 0x2C};
IanBenzMaxim 0:33d4e66780c0 55
IanBenzMaxim 0:33d4e66780c0 56 // Authority (web server) private key.
IanBenzMaxim 16:a004191a79ab 57 static const DS28C36::Page::array authPrivateKey = {
IanBenzMaxim 13:6a6225690c2e 58 0xC5, 0x45, 0x5F, 0xFB, 0x45, 0xEA, 0x77, 0x0B, 0xF1, 0x1B, 0xE5,
IanBenzMaxim 13:6a6225690c2e 59 0xD2, 0x21, 0xAD, 0x35, 0xF5, 0x0B, 0x61, 0x7F, 0x66, 0xDB, 0xA0,
IanBenzMaxim 13:6a6225690c2e 60 0xBD, 0xB6, 0x64, 0x75, 0x21, 0x4E, 0xB0, 0x98, 0x2D, 0x8E};
IanBenzMaxim 0:33d4e66780c0 61
IanBenzMaxim 0:33d4e66780c0 62 // Master secret for SHA-256 HMAC authentication.
IanBenzMaxim 16:a004191a79ab 63 static const DS28C36::Page::array masterSecret = {
IanBenzMaxim 13:6a6225690c2e 64 0x6D, 0x52, 0xB6, 0x15, 0xDC, 0x80, 0xCF, 0xB1, 0x25, 0xB0, 0x76,
IanBenzMaxim 13:6a6225690c2e 65 0xB7, 0x7C, 0xAC, 0x00, 0xF2, 0xBC, 0x19, 0xBE, 0xD3, 0x2F, 0x9D,
IanBenzMaxim 13:6a6225690c2e 66 0xC1, 0x42, 0x2A, 0xA5, 0xF6, 0xAE, 0x71, 0xF2, 0x25, 0xB6};
IanBenzMaxim 0:33d4e66780c0 67
IanBenzMaxim 16:a004191a79ab 68 Result<void> provisionAuthenticator(DS28C36 & ds28c36) {
IanBenzMaxim 16:a004191a79ab 69 // Check if already provisioned;
IanBenzMaxim 16:a004191a79ab 70 if (const Result<DS28C36::PageProtection> protection =
IanBenzMaxim 16:a004191a79ab 71 ds28c36.readPageProtection(DS28C36::gpioControlPage)) {
IanBenzMaxim 16:a004191a79ab 72 if (protection.value().test(DS28C36::APH)) {
IanBenzMaxim 16:a004191a79ab 73 return none;
IanBenzMaxim 16:a004191a79ab 74 }
IanBenzMaxim 16:a004191a79ab 75 } else {
IanBenzMaxim 16:a004191a79ab 76 return protection.error();
IanBenzMaxim 16:a004191a79ab 77 }
IanBenzMaxim 16:a004191a79ab 78
IanBenzMaxim 16:a004191a79ab 79 const DS28C36::Page::array zeroPage = {};
IanBenzMaxim 13:6a6225690c2e 80 // Page 0 - 15
IanBenzMaxim 16:a004191a79ab 81 for (int pageNum = 0; pageNum <= 15; ++pageNum) {
IanBenzMaxim 16:a004191a79ab 82 TRY(ds28c36.writeMemory(pageNum, zeroPage));
IanBenzMaxim 13:6a6225690c2e 83 }
IanBenzMaxim 13:6a6225690c2e 84 // Page 16, 17, 22
IanBenzMaxim 16:a004191a79ab 85 DS28C36::Page::array page;
IanBenzMaxim 16:a004191a79ab 86 TRY(ds28c36.readRng(page));
IanBenzMaxim 16:a004191a79ab 87 TRY(ds28c36.writeMemory(DS28C36::publicKeyAxPage, page));
IanBenzMaxim 16:a004191a79ab 88 TRY(ds28c36.readRng(page));
IanBenzMaxim 16:a004191a79ab 89 TRY(ds28c36.writeMemory(DS28C36::publicKeyAyPage, page));
IanBenzMaxim 16:a004191a79ab 90 TRY(ds28c36.readRng(page));
IanBenzMaxim 16:a004191a79ab 91 TRY(ds28c36.writeMemory(DS28C36::privateKeyAPage, page));
IanBenzMaxim 13:6a6225690c2e 92 // Page 18, 19, 23
IanBenzMaxim 16:a004191a79ab 93 TRY(ds28c36.readRng(page));
IanBenzMaxim 16:a004191a79ab 94 TRY(ds28c36.writeMemory(DS28C36::publicKeyBxPage, page));
IanBenzMaxim 16:a004191a79ab 95 TRY(ds28c36.readRng(page));
IanBenzMaxim 16:a004191a79ab 96 TRY(ds28c36.writeMemory(DS28C36::publicKeyByPage, page));
IanBenzMaxim 16:a004191a79ab 97 TRY(ds28c36.readRng(page));
IanBenzMaxim 16:a004191a79ab 98 TRY(ds28c36.writeMemory(DS28C36::privateKeyBPage, page));
IanBenzMaxim 13:6a6225690c2e 99 // Page 20, 21, 24
IanBenzMaxim 16:a004191a79ab 100 TRY(ds28c36.readRng(page));
IanBenzMaxim 16:a004191a79ab 101 TRY(ds28c36.writeMemory(DS28C36::publicKeyCxPage, page));
IanBenzMaxim 16:a004191a79ab 102 TRY(ds28c36.readRng(page));
IanBenzMaxim 16:a004191a79ab 103 TRY(ds28c36.writeMemory(DS28C36::publicKeyCyPage, page));
IanBenzMaxim 16:a004191a79ab 104 TRY(ds28c36.readRng(page));
IanBenzMaxim 16:a004191a79ab 105 TRY(ds28c36.writeMemory(DS28C36::privateKeyCPage, page));
IanBenzMaxim 13:6a6225690c2e 106 // Page 25
IanBenzMaxim 16:a004191a79ab 107 TRY(ds28c36.writeMemory(DS28C36::secretAPage, masterSecret));
IanBenzMaxim 16:a004191a79ab 108 TRY(ds28c36.writeBuffer(zeroPage));
IanBenzMaxim 16:a004191a79ab 109 TRY(ds28c36.computeAndLockSha2Secret(0, DS28C36::SecretNumA,
IanBenzMaxim 16:a004191a79ab 110 DS28C36::SecretNumA, false));
IanBenzMaxim 13:6a6225690c2e 111 // Page 26
IanBenzMaxim 16:a004191a79ab 112 TRY(ds28c36.readRng(page));
IanBenzMaxim 16:a004191a79ab 113 TRY(ds28c36.writeMemory(DS28C36::secretBPage, page));
IanBenzMaxim 13:6a6225690c2e 114 // Page 28
IanBenzMaxim 16:a004191a79ab 115 TRY(ds28c36.setPageProtection(DS28C36::romOptionsPage, DS28C36::APH));
IanBenzMaxim 13:6a6225690c2e 116 // Page 29
IanBenzMaxim 16:a004191a79ab 117 TRY(ds28c36.setPageProtection(DS28C36::gpioControlPage, DS28C36::APH));
IanBenzMaxim 16:a004191a79ab 118 return none;
IanBenzMaxim 0:33d4e66780c0 119 }
IanBenzMaxim 0:33d4e66780c0 120
IanBenzMaxim 16:a004191a79ab 121 Result<void> provisionCoprocessor(DS2476 & ds2476) {
IanBenzMaxim 16:a004191a79ab 122 // Check if already provisioned;
IanBenzMaxim 16:a004191a79ab 123 if (const Result<DS2476::Page::array> page =
IanBenzMaxim 16:a004191a79ab 124 ds2476.readMemory(DS2476::publicKeyCxPage)) {
IanBenzMaxim 16:a004191a79ab 125 if (page.value() == authPublicKeyX) {
IanBenzMaxim 16:a004191a79ab 126 return none;
IanBenzMaxim 16:a004191a79ab 127 }
IanBenzMaxim 16:a004191a79ab 128 } else {
IanBenzMaxim 16:a004191a79ab 129 return page.error();
IanBenzMaxim 16:a004191a79ab 130 }
IanBenzMaxim 16:a004191a79ab 131
IanBenzMaxim 13:6a6225690c2e 132 // Page 0, 1
IanBenzMaxim 16:a004191a79ab 133 const DS2476::Page::array zeroPage = {};
IanBenzMaxim 16:a004191a79ab 134 TRY(ds2476.writeMemory(0, zeroPage));
IanBenzMaxim 16:a004191a79ab 135 TRY(ds2476.writeMemory(1, zeroPage));
IanBenzMaxim 13:6a6225690c2e 136 // Page 2 - 13
IanBenzMaxim 16:a004191a79ab 137 DS2476::Page::array page;
IanBenzMaxim 16:a004191a79ab 138 for (int pageNum = 2; pageNum <= 13; ++pageNum) {
IanBenzMaxim 16:a004191a79ab 139 TRY(ds2476.readRng(page));
IanBenzMaxim 16:a004191a79ab 140 TRY(ds2476.writeMemory(pageNum, page));
IanBenzMaxim 13:6a6225690c2e 141 }
IanBenzMaxim 13:6a6225690c2e 142 // Page 16, 17, 22
IanBenzMaxim 16:a004191a79ab 143 TRY(ds2476.generateEcc256KeyPair(DS2476::KeyNumA, false));
IanBenzMaxim 13:6a6225690c2e 144 // Page 18, 19, 23
IanBenzMaxim 16:a004191a79ab 145 TRY(ds2476.readRng(page));
IanBenzMaxim 16:a004191a79ab 146 TRY(ds2476.writeMemory(DS2476::publicKeyBxPage, page));
IanBenzMaxim 16:a004191a79ab 147 TRY(ds2476.readRng(page));
IanBenzMaxim 16:a004191a79ab 148 TRY(ds2476.writeMemory(DS2476::publicKeyByPage, page));
IanBenzMaxim 16:a004191a79ab 149 TRY(ds2476.readRng(page));
IanBenzMaxim 16:a004191a79ab 150 TRY(ds2476.writeMemory(DS2476::privateKeyBPage, page));
IanBenzMaxim 13:6a6225690c2e 151 // Page 20, 21, 24
IanBenzMaxim 16:a004191a79ab 152 TRY(ds2476.writeMemory(DS2476::publicKeyCxPage, authPublicKeyX));
IanBenzMaxim 16:a004191a79ab 153 TRY(ds2476.writeMemory(DS2476::publicKeyCyPage, authPublicKeyY));
IanBenzMaxim 16:a004191a79ab 154 TRY(ds2476.writeMemory(DS2476::privateKeyCPage, authPrivateKey));
IanBenzMaxim 13:6a6225690c2e 155 // Page 25
IanBenzMaxim 16:a004191a79ab 156 TRY(ds2476.writeMemory(DS2476::secretAPage, masterSecret));
IanBenzMaxim 13:6a6225690c2e 157 // Page 26
IanBenzMaxim 16:a004191a79ab 158 TRY(ds2476.readRng(page));
IanBenzMaxim 16:a004191a79ab 159 TRY(ds2476.writeMemory(DS2476::secretBPage, page));
IanBenzMaxim 13:6a6225690c2e 160 // Page 29
IanBenzMaxim 16:a004191a79ab 161 // TRY(ds2476.setPageProtection(DS2476::gpioControlPage, DS2476::APH));
IanBenzMaxim 13:6a6225690c2e 162 // Page 14, 15
IanBenzMaxim 13:6a6225690c2e 163 std::vector<uint8_t> publicKeyA;
IanBenzMaxim 13:6a6225690c2e 164 publicKeyA.reserve(page.size() * 2 + 1);
IanBenzMaxim 16:a004191a79ab 165 TRY_VALUE(page, ds2476.readMemory(DS2476::publicKeyAxPage));
IanBenzMaxim 13:6a6225690c2e 166 publicKeyA.assign(page.begin(), page.end());
IanBenzMaxim 16:a004191a79ab 167 TRY_VALUE(page, ds2476.readMemory(DS2476::publicKeyAyPage));
IanBenzMaxim 13:6a6225690c2e 168 publicKeyA.insert(publicKeyA.end(), page.begin(), page.end());
IanBenzMaxim 13:6a6225690c2e 169 publicKeyA.insert(publicKeyA.end(), 0x00); // Customization
IanBenzMaxim 16:a004191a79ab 170 TRY(ds2476.writeBuffer(publicKeyA));
IanBenzMaxim 16:a004191a79ab 171 MaximInterfaceCore::Ecc256::Signature::array writeCertificate;
IanBenzMaxim 16:a004191a79ab 172 TRY_VALUE(writeCertificate, ds2476.generateEcdsaSignature(DS2476::KeyNumC));
IanBenzMaxim 16:a004191a79ab 173 TRY(ds2476.writeMemory(14, writeCertificate.r));
IanBenzMaxim 16:a004191a79ab 174 TRY(ds2476.writeMemory(15, writeCertificate.s));
IanBenzMaxim 13:6a6225690c2e 175 // Remove Private Key C and set protection
IanBenzMaxim 16:a004191a79ab 176 TRY(ds2476.readRng(page));
IanBenzMaxim 16:a004191a79ab 177 TRY(ds2476.writeMemory(DS2476::privateKeyCPage, page));
IanBenzMaxim 16:a004191a79ab 178 // TRY(ds2476.setPageProtection(DS2476::publicKeyCxPage,
IanBenzMaxim 16:a004191a79ab 179 // DS2476::PageProtection::AUTH));
IanBenzMaxim 16:a004191a79ab 180
IanBenzMaxim 16:a004191a79ab 181 return none;
IanBenzMaxim 0:33d4e66780c0 182 }