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.
src/NormalOperationWindow.hpp@16:a004191a79ab, 2019-10-03 (annotated)
- Committer:
- IanBenzMaxim
- Date:
- Thu Oct 03 11:40:13 2019 -0500
- Revision:
- 16:a004191a79ab
- Parent:
- NormalOperationWindow.hpp@13:6a6225690c2e
Updated MaximInterface to version 2.0. Updated mbed-os to version 5.5.7. Cleaned up code styling.
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| IanBenzMaxim | 0:33d4e66780c0 | 1 | /******************************************************************************* |
| IanBenzMaxim | 16:a004191a79ab | 2 | * Copyright (C) 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 | 16:a004191a79ab | 33 | #ifndef NORMALOPERATIONWINDOW_HPP |
| IanBenzMaxim | 16:a004191a79ab | 34 | #define NORMALOPERATIONWINDOW_HPP |
| IanBenzMaxim | 0:33d4e66780c0 | 35 | |
| IanBenzMaxim | 0:33d4e66780c0 | 36 | #include <memory> |
| IanBenzMaxim | 0:33d4e66780c0 | 37 | #include <vector> |
| IanBenzMaxim | 16:a004191a79ab | 38 | #include <MaximInterfaceCore/array.hpp> |
| IanBenzMaxim | 16:a004191a79ab | 39 | #include <mbed-os/features/netsocket/TCPSocket.h> |
| IanBenzMaxim | 16:a004191a79ab | 40 | #include <rapidjson/document.h> |
| IanBenzMaxim | 0:33d4e66780c0 | 41 | #include "Button.hpp" |
| IanBenzMaxim | 13:6a6225690c2e | 42 | #include "SensorNode.hpp" |
| IanBenzMaxim | 0:33d4e66780c0 | 43 | #include "Window.hpp" |
| IanBenzMaxim | 0:33d4e66780c0 | 44 | |
| IanBenzMaxim | 16:a004191a79ab | 45 | /// @brief |
| IanBenzMaxim | 13:6a6225690c2e | 46 | /// Handles normal operation of the demo including displaying status information |
| IanBenzMaxim | 13:6a6225690c2e | 47 | /// and processing commands from the server. |
| IanBenzMaxim | 13:6a6225690c2e | 48 | class NormalOperationWindow : public Window { |
| IanBenzMaxim | 0:33d4e66780c0 | 49 | public: |
| IanBenzMaxim | 16:a004191a79ab | 50 | /// @param socket |
| IanBenzMaxim | 16:a004191a79ab | 51 | /// Socket that has been initialized by connecting to the web server. This |
| IanBenzMaxim | 16:a004191a79ab | 52 | /// must be a heap allocated object that NormalOperationWindow will take |
| IanBenzMaxim | 16:a004191a79ab | 53 | /// ownership of. |
| IanBenzMaxim | 13:6a6225690c2e | 54 | explicit NormalOperationWindow(std::auto_ptr<TCPSocket> & socket); |
| IanBenzMaxim | 0:33d4e66780c0 | 55 | |
| IanBenzMaxim | 0:33d4e66780c0 | 56 | protected: |
| IanBenzMaxim | 13:6a6225690c2e | 57 | virtual void resized(); |
| IanBenzMaxim | 13:6a6225690c2e | 58 | virtual void updated(); |
| IanBenzMaxim | 13:6a6225690c2e | 59 | virtual void doRender(Bitmap & bitmap, int xOffset, int yOffset) const; |
| IanBenzMaxim | 13:6a6225690c2e | 60 | virtual bool doProcessKey(Key key); |
| IanBenzMaxim | 13:6a6225690c2e | 61 | |
| IanBenzMaxim | 0:33d4e66780c0 | 62 | private: |
| IanBenzMaxim | 13:6a6225690c2e | 63 | enum Result { |
| IanBenzMaxim | 13:6a6225690c2e | 64 | NoChange, // Windows not changed; No redraw required. |
| IanBenzMaxim | 13:6a6225690c2e | 65 | WindowsChanged // Windows have changed; Redraw is required. |
| IanBenzMaxim | 13:6a6225690c2e | 66 | }; |
| IanBenzMaxim | 13:6a6225690c2e | 67 | |
| IanBenzMaxim | 13:6a6225690c2e | 68 | std::auto_ptr<TCPSocket> socket; |
| IanBenzMaxim | 16:a004191a79ab | 69 | |
| IanBenzMaxim | 13:6a6225690c2e | 70 | // Socket receive buffer. Must be large enough to hold the largest command. |
| IanBenzMaxim | 13:6a6225690c2e | 71 | char recvBuf[1280]; |
| IanBenzMaxim | 16:a004191a79ab | 72 | |
| IanBenzMaxim | 16:a004191a79ab | 73 | // Challenge sent to the server with a command response to sign the next |
| IanBenzMaxim | 16:a004191a79ab | 74 | // command against. |
| IanBenzMaxim | 16:a004191a79ab | 75 | MaximInterfaceCore::array<uint8_t, 32> commandChallenge; |
| IanBenzMaxim | 13:6a6225690c2e | 76 | bool sendChallenge; |
| IanBenzMaxim | 0:33d4e66780c0 | 77 | |
| IanBenzMaxim | 13:6a6225690c2e | 78 | // Device status information. |
| IanBenzMaxim | 13:6a6225690c2e | 79 | bool validSignature; |
| IanBenzMaxim | 13:6a6225690c2e | 80 | SensorNode::State lastSensorNodeState; |
| IanBenzMaxim | 13:6a6225690c2e | 81 | double lastObjectTemp; |
| IanBenzMaxim | 13:6a6225690c2e | 82 | double lastAmbientTemp; |
| IanBenzMaxim | 13:6a6225690c2e | 83 | |
| IanBenzMaxim | 13:6a6225690c2e | 84 | Button validSignatureButton; |
| IanBenzMaxim | 13:6a6225690c2e | 85 | Button showWebIdButton; |
| IanBenzMaxim | 13:6a6225690c2e | 86 | |
| IanBenzMaxim | 13:6a6225690c2e | 87 | // Button event handlers. |
| IanBenzMaxim | 13:6a6225690c2e | 88 | void showWebId(Button *); |
| IanBenzMaxim | 13:6a6225690c2e | 89 | void toggleValidSignature(Button *); |
| IanBenzMaxim | 13:6a6225690c2e | 90 | |
| IanBenzMaxim | 16:a004191a79ab | 91 | // Creates a new command challenge, and adds it to an existing JSON document. |
| IanBenzMaxim | 16:a004191a79ab | 92 | MaximInterfaceCore::Result<void> |
| IanBenzMaxim | 16:a004191a79ab | 93 | addCommandChallenge(rapidjson::Document & document); |
| IanBenzMaxim | 16:a004191a79ab | 94 | |
| IanBenzMaxim | 16:a004191a79ab | 95 | // Adds signature information to an existing JSON document. |
| IanBenzMaxim | 16:a004191a79ab | 96 | static MaximInterfaceCore::Result<void> |
| IanBenzMaxim | 16:a004191a79ab | 97 | signData(rapidjson::Document & document, bool validSignature, |
| IanBenzMaxim | 16:a004191a79ab | 98 | const std::vector<uint8_t> & challenge); |
| IanBenzMaxim | 16:a004191a79ab | 99 | |
| IanBenzMaxim | 16:a004191a79ab | 100 | // Finalizes a command response to the server by adding the next command |
| IanBenzMaxim | 16:a004191a79ab | 101 | // challenge and signing the data. |
| IanBenzMaxim | 16:a004191a79ab | 102 | MaximInterfaceCore::Result<void> |
| IanBenzMaxim | 16:a004191a79ab | 103 | finalizeResponse(rapidjson::Document & document, bool validSignature, |
| IanBenzMaxim | 16:a004191a79ab | 104 | const std::vector<uint8_t> & responseChallenge); |
| IanBenzMaxim | 16:a004191a79ab | 105 | |
| IanBenzMaxim | 16:a004191a79ab | 106 | // Parse and verify a signed JSON string. |
| IanBenzMaxim | 16:a004191a79ab | 107 | MaximInterfaceCore::Result<void> |
| IanBenzMaxim | 16:a004191a79ab | 108 | verifySignedData(rapidjson::Document & signedData, |
| IanBenzMaxim | 16:a004191a79ab | 109 | MaximInterfaceCore::span<const char> verifyDataIn); |
| IanBenzMaxim | 16:a004191a79ab | 110 | |
| IanBenzMaxim | 16:a004191a79ab | 111 | // Send a JSON document to the server. |
| IanBenzMaxim | 16:a004191a79ab | 112 | void sendJson(const rapidjson::Value & document); |
| IanBenzMaxim | 16:a004191a79ab | 113 | |
| IanBenzMaxim | 13:6a6225690c2e | 114 | // Send a message to the server message log. |
| IanBenzMaxim | 13:6a6225690c2e | 115 | void sendMessage(const char * message); |
| IanBenzMaxim | 13:6a6225690c2e | 116 | |
| IanBenzMaxim | 13:6a6225690c2e | 117 | Result processReceivedData(size_t recvBufSize); |
| IanBenzMaxim | 16:a004191a79ab | 118 | Result sendStatus(const std::vector<uint8_t> & responseChallenge); |
| IanBenzMaxim | 16:a004191a79ab | 119 | Result sendObjectTemp(const std::vector<uint8_t> & responseChallenge); |
| IanBenzMaxim | 16:a004191a79ab | 120 | Result sendAmbientTemp(const std::vector<uint8_t> & responseChallenge); |
| IanBenzMaxim | 13:6a6225690c2e | 121 | void displayImage(const std::vector<uint8_t> & imageData); |
| IanBenzMaxim | 0:33d4e66780c0 | 122 | }; |
| IanBenzMaxim | 0:33d4e66780c0 | 123 | |
| IanBenzMaxim | 0:33d4e66780c0 | 124 | #endif |