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.

Factory.hpp@8:594529956266, 2016-05-14 (annotated)

Committer:
IanBenzMaxim
Date:
Sat May 14 14:28:31 2016 -0500
Revision:
8:594529956266
Parent:
6:b6bafd0a7013
Child:
24:434330962308
Updated following downstream restructuring in OneWire library.

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 1:e1c7c1c636af 34 #ifndef _FACTORY_HPP
IanBenzMaxim 1:e1c7c1c636af 35 #define _FACTORY_HPP
IanBenzMaxim 1:e1c7c1c636af 36
IanBenzMaxim 6:b6bafd0a7013 37 #include <stdint.h>
IanBenzMaxim 1:e1c7c1c636af 38
IanBenzMaxim 8:594529956266 39 namespace OneWire { class DS2465; }
IanBenzMaxim 1:e1c7c1c636af 40 class SensorNode;
IanBenzMaxim 1:e1c7c1c636af 41
IanBenzMaxim 1:e1c7c1c636af 42 /// Represents the secure factory that will perform the initial provisioning of
IanBenzMaxim 1:e1c7c1c636af 43 /// Controllers (DS2465) and Sensor Nodes (DS28E15) for later authentication.
IanBenzMaxim 1:e1c7c1c636af 44 class Factory
IanBenzMaxim 1:e1c7c1c636af 45 {
IanBenzMaxim 1:e1c7c1c636af 46 public:
IanBenzMaxim 1:e1c7c1c636af 47 /// Provision the DS2465 on a Controller.
IanBenzMaxim 1:e1c7c1c636af 48 /// @returns True on success.
IanBenzMaxim 8:594529956266 49 bool provision(OneWire::DS2465 & ds2465);
IanBenzMaxim 1:e1c7c1c636af 50
IanBenzMaxim 1:e1c7c1c636af 51 /// Provision the DS28E15 on a Sensor Node.
IanBenzMaxim 1:e1c7c1c636af 52 /// @param validSecret True to provision using the valid system secret or false to imitate an invalid Controller.
IanBenzMaxim 1:e1c7c1c636af 53 /// @returns True on success.
IanBenzMaxim 1:e1c7c1c636af 54 bool provision(SensorNode & sensorNode, bool validSecret);
IanBenzMaxim 1:e1c7c1c636af 55
IanBenzMaxim 1:e1c7c1c636af 56 private:
IanBenzMaxim 6:b6bafd0a7013 57 static const uint8_t masterSecret[]; ///< The valid master secret for the system.
IanBenzMaxim 6:b6bafd0a7013 58 static const uint8_t invalidMasterSecret[]; ///< An invalid master secret for example purposes.
IanBenzMaxim 1:e1c7c1c636af 59 };
IanBenzMaxim 1:e1c7c1c636af 60
IanBenzMaxim 1:e1c7c1c636af 61 #endif