Maxim Integrated
DeepCover Embedded Security in IoT: Public-key Secured Data Paths
Dependencies: MaximInterface
The MAXREFDES155# is an internet-of-things (IoT) embedded-security reference design, built to authenticate and control a sensing node using elliptic-curve-based public-key cryptography with control and notification from a web server.
The hardware includes an ARM® mbed™ shield and attached sensor endpoint. The shield contains a DS2476 DeepCover® ECDSA/SHA-2 coprocessor, Wifi communication, LCD push-button controls, and status LEDs. The sensor endpoint is attached to the shield using a 300mm cable and contains a DS28C36 DeepCover ECDSA/SHA-2 authenticator, IR-thermal sensor, and aiming laser for the IR sensor. The MAXREFDES155# is equipped with a standard Arduino® form-factor shield connector for immediate testing using an mbed board such as the MAX32600MBED#. The combination of these two devices represent an IoT device. Communication to the web server is accomplished with the shield Wifi circuitry. Communication from the shield to the attached sensor module is accomplished over I2C . The sensor module represents an IoT endpoint that generates small data with a requirement for message authenticity/integrity and secure on/off operational control.
The design is hierarchical with each mbed platform and shield communicating data from the sensor node to a web server that maintains a centralized log and dispatches notifications as necessary. The simplicity of this design enables rapid integration into any star-topology IoT network to provide security with the low overhead and cost provided by the ECDSA-P256 asymmetric-key and SHA-256 symmetric-key algorithms.
More information about the MAXREFDES155# is available on the Maxim Integrated website.
SensorNode.hpp@15:75404fab3615, 2018-01-19 (annotated)
- Committer:
- IanBenzMaxim
- Date:
- Fri Jan 19 10:28:27 2018 -0600
- Revision:
- 15:75404fab3615
- Parent:
- 13:6a6225690c2e
Updated MaximInterface revision.
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| IanBenzMaxim | 0:33d4e66780c0 | 1 | /******************************************************************************* |
| IanBenzMaxim | 0:33d4e66780c0 | 2 | * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved. |
| IanBenzMaxim | 0:33d4e66780c0 | 3 | * |
| IanBenzMaxim | 0:33d4e66780c0 | 4 | * Permission is hereby granted, free of charge, to any person obtaining a |
| IanBenzMaxim | 0:33d4e66780c0 | 5 | * copy of this software and associated documentation files (the "Software"), |
| IanBenzMaxim | 0:33d4e66780c0 | 6 | * to deal in the Software without restriction, including without limitation |
| IanBenzMaxim | 0:33d4e66780c0 | 7 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| IanBenzMaxim | 0:33d4e66780c0 | 8 | * and/or sell copies of the Software, and to permit persons to whom the |
| IanBenzMaxim | 0:33d4e66780c0 | 9 | * Software is furnished to do so, subject to the following conditions: |
| IanBenzMaxim | 0:33d4e66780c0 | 10 | * |
| IanBenzMaxim | 0:33d4e66780c0 | 11 | * The above copyright notice and this permission notice shall be included |
| IanBenzMaxim | 0:33d4e66780c0 | 12 | * in all copies or substantial portions of the Software. |
| IanBenzMaxim | 0:33d4e66780c0 | 13 | * |
| IanBenzMaxim | 0:33d4e66780c0 | 14 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| IanBenzMaxim | 0:33d4e66780c0 | 15 | * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| IanBenzMaxim | 0:33d4e66780c0 | 16 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| IanBenzMaxim | 0:33d4e66780c0 | 17 | * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES |
| IanBenzMaxim | 0:33d4e66780c0 | 18 | * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| IanBenzMaxim | 0:33d4e66780c0 | 19 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| IanBenzMaxim | 0:33d4e66780c0 | 20 | * OTHER DEALINGS IN THE SOFTWARE. |
| IanBenzMaxim | 0:33d4e66780c0 | 21 | * |
| IanBenzMaxim | 0:33d4e66780c0 | 22 | * Except as contained in this notice, the name of Maxim Integrated |
| IanBenzMaxim | 0:33d4e66780c0 | 23 | * Products, Inc. shall not be used except as stated in the Maxim Integrated |
| IanBenzMaxim | 0:33d4e66780c0 | 24 | * Products, Inc. Branding Policy. |
| IanBenzMaxim | 0:33d4e66780c0 | 25 | * |
| IanBenzMaxim | 0:33d4e66780c0 | 26 | * The mere transfer of this software does not imply any licenses |
| IanBenzMaxim | 0:33d4e66780c0 | 27 | * of trade secrets, proprietary technology, copyrights, patents, |
| IanBenzMaxim | 0:33d4e66780c0 | 28 | * trademarks, maskwork rights, or any other form of intellectual |
| IanBenzMaxim | 0:33d4e66780c0 | 29 | * property whatsoever. Maxim Integrated Products, Inc. retains all |
| IanBenzMaxim | 0:33d4e66780c0 | 30 | * ownership rights. |
| IanBenzMaxim | 0:33d4e66780c0 | 31 | *******************************************************************************/ |
| IanBenzMaxim | 0:33d4e66780c0 | 32 | |
| IanBenzMaxim | 0:33d4e66780c0 | 33 | #ifndef SENSORNODE_HPP |
| IanBenzMaxim | 0:33d4e66780c0 | 34 | #define SENSORNODE_HPP |
| IanBenzMaxim | 0:33d4e66780c0 | 35 | |
| IanBenzMaxim | 0:33d4e66780c0 | 36 | #include <stdint.h> |
| IanBenzMaxim | 13:6a6225690c2e | 37 | #include <utility> |
| IanBenzMaxim | 13:6a6225690c2e | 38 | #include <MaximInterface/Devices/DS28C36_DS2476.hpp> |
| IanBenzMaxim | 13:6a6225690c2e | 39 | #include <MaximInterface/Utilities/Function.hpp> |
| IanBenzMaxim | 0:33d4e66780c0 | 40 | |
| IanBenzMaxim | 13:6a6225690c2e | 41 | namespace MaximInterface { |
| IanBenzMaxim | 0:33d4e66780c0 | 42 | class DS2476; |
| IanBenzMaxim | 13:6a6225690c2e | 43 | class I2CMaster; |
| IanBenzMaxim | 13:6a6225690c2e | 44 | } // namespace MaximInterface |
| IanBenzMaxim | 0:33d4e66780c0 | 45 | |
| IanBenzMaxim | 0:33d4e66780c0 | 46 | /// Interface to the authenticated sensor node peripheral board. |
| IanBenzMaxim | 13:6a6225690c2e | 47 | class SensorNode { |
| IanBenzMaxim | 0:33d4e66780c0 | 48 | public: |
| IanBenzMaxim | 13:6a6225690c2e | 49 | /// Prints a null-terminated char string. |
| IanBenzMaxim | 13:6a6225690c2e | 50 | typedef MaximInterface::Function<void(const char *)> PrintHandler; |
| IanBenzMaxim | 13:6a6225690c2e | 51 | |
| IanBenzMaxim | 13:6a6225690c2e | 52 | /// Style of temperature to measure. |
| IanBenzMaxim | 13:6a6225690c2e | 53 | enum TempStyle { AmbientTemp, ObjectTemp }; |
| IanBenzMaxim | 13:6a6225690c2e | 54 | |
| IanBenzMaxim | 13:6a6225690c2e | 55 | enum State { |
| IanBenzMaxim | 13:6a6225690c2e | 56 | Disconnected, // No sensor node is connected. |
| IanBenzMaxim | 13:6a6225690c2e | 57 | Invalid, // Sensor node is not valid. |
| IanBenzMaxim | 13:6a6225690c2e | 58 | ValidLaserDisabled, // Sensor node is valid, and laser is disabled. |
| IanBenzMaxim | 13:6a6225690c2e | 59 | ValidLaserEnabled, // Sensor node is valid, and laser is enabled. |
| IanBenzMaxim | 13:6a6225690c2e | 60 | NotProvisioned // Sensor node is not provisioned. |
| IanBenzMaxim | 13:6a6225690c2e | 61 | }; |
| IanBenzMaxim | 13:6a6225690c2e | 62 | |
| IanBenzMaxim | 13:6a6225690c2e | 63 | /// @param i2c |
| IanBenzMaxim | 13:6a6225690c2e | 64 | /// I2C bus connected to the sensor node. Communicates with DS28C36 and MLX90614. |
| IanBenzMaxim | 13:6a6225690c2e | 65 | /// @param ds2476 Coprocessor used for authentication computations. |
| IanBenzMaxim | 13:6a6225690c2e | 66 | SensorNode(MaximInterface::I2CMaster & i2c, MaximInterface::DS2476 & ds2476); |
| IanBenzMaxim | 13:6a6225690c2e | 67 | |
| IanBenzMaxim | 13:6a6225690c2e | 68 | /// Detects if a potential sensor node is connected. |
| IanBenzMaxim | 13:6a6225690c2e | 69 | /// @returns True if something was detected. |
| IanBenzMaxim | 13:6a6225690c2e | 70 | std::pair<State, MaximInterface::error_code> detect(); |
| IanBenzMaxim | 13:6a6225690c2e | 71 | |
| IanBenzMaxim | 13:6a6225690c2e | 72 | /// Enable or disable the laser. |
| IanBenzMaxim | 13:6a6225690c2e | 73 | /// @param enabled True to enable the laser or false to disable. |
| IanBenzMaxim | 13:6a6225690c2e | 74 | /// @param print |
| IanBenzMaxim | 13:6a6225690c2e | 75 | /// Optional callback for displaying informational messages to the user. |
| IanBenzMaxim | 13:6a6225690c2e | 76 | /// @returns True if the operation was successful. |
| IanBenzMaxim | 13:6a6225690c2e | 77 | MaximInterface::error_code |
| IanBenzMaxim | 13:6a6225690c2e | 78 | setLaserEnabled(bool enabled, const PrintHandler & print = PrintHandler()); |
| IanBenzMaxim | 0:33d4e66780c0 | 79 | |
| IanBenzMaxim | 13:6a6225690c2e | 80 | /// Get a temperature measurement from the MLX90614. |
| IanBenzMaxim | 13:6a6225690c2e | 81 | /// @param style Temperature style to read. |
| IanBenzMaxim | 13:6a6225690c2e | 82 | /// @param[out] temp Temperature in Celsius. Only valid if operation successful. |
| IanBenzMaxim | 13:6a6225690c2e | 83 | /// @returns True if the operation was successful. |
| IanBenzMaxim | 13:6a6225690c2e | 84 | bool readTemp(TempStyle style, double & temp); |
| IanBenzMaxim | 13:6a6225690c2e | 85 | |
| IanBenzMaxim | 13:6a6225690c2e | 86 | /// Provision the sensor node. |
| IanBenzMaxim | 13:6a6225690c2e | 87 | /// @returns True if the operation was successful. |
| IanBenzMaxim | 13:6a6225690c2e | 88 | MaximInterface::error_code provision(); |
| IanBenzMaxim | 13:6a6225690c2e | 89 | |
| IanBenzMaxim | 0:33d4e66780c0 | 90 | private: |
| IanBenzMaxim | 13:6a6225690c2e | 91 | /// Checks if the sensor node is authentic. |
| IanBenzMaxim | 13:6a6225690c2e | 92 | /// @returns True if the sensor node passed the authentication check. |
| IanBenzMaxim | 13:6a6225690c2e | 93 | MaximInterface::error_code authenticate(); |
| IanBenzMaxim | 13:6a6225690c2e | 94 | |
| IanBenzMaxim | 13:6a6225690c2e | 95 | /// Checks if the laser is enabled. |
| IanBenzMaxim | 13:6a6225690c2e | 96 | /// @param[out] enabled |
| IanBenzMaxim | 13:6a6225690c2e | 97 | /// Set to true if the laser is enabled. Only valid if check successful. |
| IanBenzMaxim | 13:6a6225690c2e | 98 | /// @returns True if check was successful. |
| IanBenzMaxim | 13:6a6225690c2e | 99 | MaximInterface::error_code getLaserEnabled(bool & enabled); |
| IanBenzMaxim | 13:6a6225690c2e | 100 | |
| IanBenzMaxim | 13:6a6225690c2e | 101 | /// Checks if the sensor node is provisioned. |
| IanBenzMaxim | 13:6a6225690c2e | 102 | /// @param[out] provisioned |
| IanBenzMaxim | 13:6a6225690c2e | 103 | /// True if provisioned. Only valid if check successful. |
| IanBenzMaxim | 13:6a6225690c2e | 104 | /// @returns True if the check was successful. |
| IanBenzMaxim | 13:6a6225690c2e | 105 | MaximInterface::error_code getProvisioned(bool & provisioned); |
| IanBenzMaxim | 13:6a6225690c2e | 106 | |
| IanBenzMaxim | 13:6a6225690c2e | 107 | MaximInterface::I2CMaster & i2c; |
| IanBenzMaxim | 13:6a6225690c2e | 108 | MaximInterface::DS28C36 ds28c36; |
| IanBenzMaxim | 13:6a6225690c2e | 109 | MaximInterface::DS2476 & ds2476; |
| IanBenzMaxim | 13:6a6225690c2e | 110 | MaximInterface::RomId romId; |
| IanBenzMaxim | 13:6a6225690c2e | 111 | MaximInterface::ManId manId; |
| IanBenzMaxim | 0:33d4e66780c0 | 112 | }; |
| IanBenzMaxim | 0:33d4e66780c0 | 113 | |
| IanBenzMaxim | 0:33d4e66780c0 | 114 | #endif |