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