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
- Committer:
- IanBenzMaxim
- Date:
- 2016-10-19
- Revision:
- 24:434330962308
- Parent:
- 8:594529956266
- Child:
- 25:37ea43ff81be
File content as of revision 24:434330962308:
/******************************************************************************* * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. * * Except as contained in this notice, the name of Maxim Integrated * Products, Inc. shall not be used except as stated in the Maxim Integrated * Products, Inc. Branding Policy. * * The mere transfer of this software does not imply any licenses * of trade secrets, proprietary technology, copyrights, patents, * trademarks, maskwork rights, or any other form of intellectual * property whatsoever. Maxim Integrated Products, Inc. retains all * ownership rights. ******************************************************************************* */ #ifndef WEBSERVERINTERFACE_HPP #define WEBSERVERINTERFACE_HPP #include <string> /// The message type described by the POST. enum PostEvent { SensorDataEvent, ///< Adding sensor data to the log. InvalidSensorEvent ///< Reporting an invalid sensor node. }; namespace mbed { class Serial; } namespace OneWire { class ISha256MacCoproc; } class ESP8266; struct SensorData; /// Network interface to the web server supporting authenticated posting of event /// through an HTTP challenge-respones scheme with SHA-256 data signing. class WebServerInterface { public: /// Session ID used by the web server to distinguish between multiple Controllers. std::string sessionId; /// @param esp8266 Interface to ESP8266 for Wi-Fi access. /// @param pc Optional serial interface for received web traffic. WebServerInterface(ESP8266 & esp8266, mbed::Serial * pc = NULL); /// Initialize network interface and connect to access point. /// @returns True on success. bool initialize(); /// Send an authenticated event message to the web server. /// @param macCoProc Coprocessor such as the DS2465 used to calculate the authentication MAC. /// @param event Event message type. /// @postData Message body as determined by the event message type. /// @setSecret True if the Transport Secret needs to be selected in the coprocessor. /// @returns True on success. bool authPostHttpEvent(OneWire::ISha256MacCoproc & macCoproc, PostEvent event, const std::string & postData, bool setSecret); /// Format sensor data as text suitable for use in a POST body. /// @param sensorData Sensor data to format. /// @returns Data formatted for web server. static std::string formatSensorDataPostBody(const SensorData & sensorData); private: /// @{ /// Configuration strings. static const char wifiSsid[]; static const char wifiPassword[]; static const char serverAddress[]; static const unsigned int serverPort; static const char serverPostPath[]; static const char serverChallengePath[]; /// @} ESP8266 & esp8266; mbed::Serial * pc; }; #endif