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.

WebServerInterface.hpp@29:590a7561318b, 2017-01-26 (annotated)

Committer:
IanBenzMaxim
Date:
Thu Jan 26 16:55:23 2017 -0600
Revision:
29:590a7561318b
Parent:
28:e5cdaf13d299
Child:
32:0a09505a656d
Rollback to mbed 2 for stability until online compiler issues with mbed 5 can be resolved.

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 WEBSERVERINTERFACE_HPP
IanBenzMaxim 24:434330962308 35 #define WEBSERVERINTERFACE_HPP
IanBenzMaxim 1:e1c7c1c636af 36
IanBenzMaxim 1:e1c7c1c636af 37 #include <string>
IanBenzMaxim 25:37ea43ff81be 38 #include "RomId/RomId.h"
IanBenzMaxim 1:e1c7c1c636af 39
IanBenzMaxim 24:434330962308 40 /// The message type described by the POST.
IanBenzMaxim 1:e1c7c1c636af 41 enum PostEvent
IanBenzMaxim 1:e1c7c1c636af 42 {
IanBenzMaxim 1:e1c7c1c636af 43 SensorDataEvent, ///< Adding sensor data to the log.
IanBenzMaxim 1:e1c7c1c636af 44 InvalidSensorEvent ///< Reporting an invalid sensor node.
IanBenzMaxim 1:e1c7c1c636af 45 };
IanBenzMaxim 1:e1c7c1c636af 46
IanBenzMaxim 1:e1c7c1c636af 47 namespace mbed { class Serial; }
IanBenzMaxim 8:594529956266 48 namespace OneWire { class ISha256MacCoproc; }
IanBenzMaxim 29:590a7561318b 49 class ESP8266;
IanBenzMaxim 1:e1c7c1c636af 50 struct SensorData;
IanBenzMaxim 1:e1c7c1c636af 51
IanBenzMaxim 1:e1c7c1c636af 52 /// Network interface to the web server supporting authenticated posting of event
IanBenzMaxim 1:e1c7c1c636af 53 /// through an HTTP challenge-respones scheme with SHA-256 data signing.
IanBenzMaxim 1:e1c7c1c636af 54 class WebServerInterface
IanBenzMaxim 1:e1c7c1c636af 55 {
IanBenzMaxim 25:37ea43ff81be 56 public:
IanBenzMaxim 1:e1c7c1c636af 57 /// @param esp8266 Interface to ESP8266 for Wi-Fi access.
IanBenzMaxim 1:e1c7c1c636af 58 /// @param pc Optional serial interface for received web traffic.
IanBenzMaxim 29:590a7561318b 59 WebServerInterface(ESP8266 & esp8266) : esp8266(esp8266) { }
IanBenzMaxim 29:590a7561318b 60
IanBenzMaxim 29:590a7561318b 61 /// Initialize network interface and connect to access point.
IanBenzMaxim 29:590a7561318b 62 /// @returns True on success.
IanBenzMaxim 29:590a7561318b 63 bool initialize();
IanBenzMaxim 1:e1c7c1c636af 64
IanBenzMaxim 1:e1c7c1c636af 65 /// Send an authenticated event message to the web server.
IanBenzMaxim 1:e1c7c1c636af 66 /// @param macCoProc Coprocessor such as the DS2465 used to calculate the authentication MAC.
IanBenzMaxim 1:e1c7c1c636af 67 /// @param event Event message type.
IanBenzMaxim 1:e1c7c1c636af 68 /// @postData Message body as determined by the event message type.
IanBenzMaxim 1:e1c7c1c636af 69 /// @setSecret True if the Transport Secret needs to be selected in the coprocessor.
IanBenzMaxim 1:e1c7c1c636af 70 /// @returns True on success.
IanBenzMaxim 8:594529956266 71 bool authPostHttpEvent(OneWire::ISha256MacCoproc & macCoproc, PostEvent event, const std::string & postData, bool setSecret);
IanBenzMaxim 1:e1c7c1c636af 72
IanBenzMaxim 1:e1c7c1c636af 73 /// Format sensor data as text suitable for use in a POST body.
IanBenzMaxim 1:e1c7c1c636af 74 /// @param sensorData Sensor data to format.
IanBenzMaxim 1:e1c7c1c636af 75 /// @returns Data formatted for web server.
IanBenzMaxim 25:37ea43ff81be 76 static std::string formatSensorDataPostBody(const SensorData & sensorData);
IanBenzMaxim 25:37ea43ff81be 77
IanBenzMaxim 25:37ea43ff81be 78 /// @{
IanBenzMaxim 25:37ea43ff81be 79 /// Session ID used by the web server to distinguish between multiple Controllers.
IanBenzMaxim 25:37ea43ff81be 80 const OneWire::RomId & sessionId() const { return m_sessionId; }
IanBenzMaxim 25:37ea43ff81be 81 const std::string & sessionIdString() const { return m_sessionIdString; }
IanBenzMaxim 25:37ea43ff81be 82 void setSessionId(const OneWire::RomId & sessionId);
IanBenzMaxim 25:37ea43ff81be 83 /// @}
IanBenzMaxim 1:e1c7c1c636af 84
IanBenzMaxim 1:e1c7c1c636af 85 private:
IanBenzMaxim 1:e1c7c1c636af 86 /// @{
IanBenzMaxim 1:e1c7c1c636af 87 /// Configuration strings.
IanBenzMaxim 29:590a7561318b 88 static const char wifiSsid[];
IanBenzMaxim 29:590a7561318b 89 static const char wifiPassword[];
IanBenzMaxim 1:e1c7c1c636af 90 static const char serverAddress[];
IanBenzMaxim 3:ac723be395d9 91 static const unsigned int serverPort;
IanBenzMaxim 1:e1c7c1c636af 92 static const char serverPostPath[];
IanBenzMaxim 1:e1c7c1c636af 93 static const char serverChallengePath[];
IanBenzMaxim 1:e1c7c1c636af 94 /// @}
IanBenzMaxim 1:e1c7c1c636af 95
IanBenzMaxim 25:37ea43ff81be 96 OneWire::RomId m_sessionId;
IanBenzMaxim 25:37ea43ff81be 97 std::string m_sessionIdString;
IanBenzMaxim 25:37ea43ff81be 98
IanBenzMaxim 29:590a7561318b 99 ESP8266 & esp8266;
IanBenzMaxim 1:e1c7c1c636af 100 };
IanBenzMaxim 1:e1c7c1c636af 101
IanBenzMaxim 1:e1c7c1c636af 102 #endif