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.
Diff: WebServerInterface.hpp
- Revision:
- 32:0a09505a656d
- Parent:
- 29:590a7561318b
diff -r 7b10bcb3e0fc -r 0a09505a656d WebServerInterface.hpp
--- a/WebServerInterface.hpp Tue Apr 04 14:10:48 2017 -0500
+++ b/WebServerInterface.hpp Mon Nov 06 17:34:13 2017 -0600
@@ -28,60 +28,59 @@
* 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>
-#include "RomId/RomId.h"
+#include <MaximInterface/Utilities/RomId.hpp>
/// The message type described by the POST.
-enum PostEvent
-{
- SensorDataEvent, ///< Adding sensor data to the log.
+enum PostEvent {
+ SensorDataEvent, ///< Adding sensor data to the log.
InvalidSensorEvent ///< Reporting an invalid sensor node.
};
namespace mbed { class Serial; }
-namespace OneWire { class ISha256MacCoproc; }
+namespace MaximInterface { class DS2465; }
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:
+class WebServerInterface {
+public:
/// @param esp8266 Interface to ESP8266 for Wi-Fi access.
/// @param pc Optional serial interface for received web traffic.
- WebServerInterface(ESP8266 & esp8266) : esp8266(esp8266) { }
-
+ WebServerInterface(ESP8266 & esp8266) : esp8266(esp8266) {}
+
/// 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 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);
-
+ bool authPostHttpEvent(MaximInterface::DS2465 & 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);
-
+
/// @{
/// Session ID used by the web server to distinguish between multiple Controllers.
- const OneWire::RomId & sessionId() const { return m_sessionId; }
+ const MaximInterface::RomId & sessionId() const { return m_sessionId; }
const std::string & sessionIdString() const { return m_sessionIdString; }
- void setSessionId(const OneWire::RomId & sessionId);
+ void setSessionId(const MaximInterface::RomId & sessionId);
/// @}
-
+
private:
/// @{
/// Configuration strings.
@@ -92,10 +91,10 @@
static const char serverPostPath[];
static const char serverChallengePath[];
/// @}
-
- OneWire::RomId m_sessionId;
+
+ MaximInterface::RomId m_sessionId;
std::string m_sessionIdString;
-
+
ESP8266 & esp8266;
};
MAXREFDES143#: DeepCover Embedded Security in IoT Authenticated Sensing & Notification