Maxim Integrated / Mbed OS MAXREFDES155#

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/Bitmap.hpp@18:c2631e985780, 2019-12-03 (annotated)

Committer:
IanBenzMaxim
Date:
Tue Dec 03 12:56:25 2019 -0600
Revision:
18:c2631e985780
Parent:
16:a004191a79ab 
Updated MaximInterface to version 2.1.

Who changed what in which revision?

UserRevisionLine numberNew 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 0:33d4e66780c0 33 #ifndef BITMAP_HPP
IanBenzMaxim 0:33d4e66780c0 34 #define BITMAP_HPP
IanBenzMaxim 0:33d4e66780c0 35
IanBenzMaxim 0:33d4e66780c0 36 #include <stddef.h>
IanBenzMaxim 0:33d4e66780c0 37 #include <stdint.h>
IanBenzMaxim 0:33d4e66780c0 38 #include <vector>
IanBenzMaxim 0:33d4e66780c0 39
IanBenzMaxim 11:989eabe2a376 40 /// Stores a black and white bitmap image.
IanBenzMaxim 13:6a6225690c2e 41 class Bitmap {
IanBenzMaxim 13:6a6225690c2e 42 public:
IanBenzMaxim 16:a004191a79ab 43 /// @brief Construct a zero-initialized bitmap with specified dimensions.
IanBenzMaxim 13:6a6225690c2e 44 /// @param width Width in pixels that is >= 1.
IanBenzMaxim 13:6a6225690c2e 45 /// @param height Height in pixels that is >= 1.
IanBenzMaxim 13:6a6225690c2e 46 Bitmap(int width, int height);
IanBenzMaxim 13:6a6225690c2e 47
IanBenzMaxim 16:a004191a79ab 48 /// @brief Load bitmap from a byte array.
IanBenzMaxim 13:6a6225690c2e 49 /// @param data Array of scanline bitmap data.
IanBenzMaxim 13:6a6225690c2e 50 /// @param size Size of data array.
IanBenzMaxim 13:6a6225690c2e 51 /// @param width Width of loaded image in pixels that is >= 1.
IanBenzMaxim 13:6a6225690c2e 52 Bitmap(const uint8_t * data, size_t size, int width);
IanBenzMaxim 13:6a6225690c2e 53
IanBenzMaxim 16:a004191a79ab 54 /// Width in pixels.
IanBenzMaxim 16:a004191a79ab 55 int width() const { return width_; }
IanBenzMaxim 13:6a6225690c2e 56
IanBenzMaxim 16:a004191a79ab 57 /// Height in pixels.
IanBenzMaxim 16:a004191a79ab 58 int height() const { return height_; }
IanBenzMaxim 16:a004191a79ab 59
IanBenzMaxim 16:a004191a79ab 60 /// @brief Check if a pixel is enabled (black).
IanBenzMaxim 13:6a6225690c2e 61 /// @returns
IanBenzMaxim 13:6a6225690c2e 62 /// True if the pixel is enabled or false if the coordinate is out of range.
IanBenzMaxim 13:6a6225690c2e 63 bool pixelEnabled(int x, int y) const;
IanBenzMaxim 16:a004191a79ab 64
IanBenzMaxim 16:a004191a79ab 65 /// @brief Enable or disable a pixel.
IanBenzMaxim 13:6a6225690c2e 66 /// @param True to set to black. False to set to white.
IanBenzMaxim 13:6a6225690c2e 67 void setPixelEnabled(int x, int y, bool enabled);
IanBenzMaxim 0:33d4e66780c0 68
IanBenzMaxim 16:a004191a79ab 69 /// @brief Overlay another bitmap on top of this bitmap.
IanBenzMaxim 13:6a6225690c2e 70 /// @param x x-coordinate location to overlay.
IanBenzMaxim 13:6a6225690c2e 71 /// @param y y-coordinate location to overlay.
IanBenzMaxim 13:6a6225690c2e 72 /// @param src Bitmap to overlay.
IanBenzMaxim 13:6a6225690c2e 73 void overlay(int x, int y, const Bitmap & src);
IanBenzMaxim 13:6a6225690c2e 74
IanBenzMaxim 16:a004191a79ab 75 /// @brief Overlay bitmap data from a byte array on top of this bitmap.
IanBenzMaxim 13:6a6225690c2e 76 /// @param x x-coordinate location to overlay.
IanBenzMaxim 13:6a6225690c2e 77 /// @param y y-coordinate location to overlay.
IanBenzMaxim 13:6a6225690c2e 78 /// @param data Array of scanline bitmap data.
IanBenzMaxim 13:6a6225690c2e 79 /// @param size Size of data array.
IanBenzMaxim 13:6a6225690c2e 80 /// @param width Width of overlayed image in pixels that is >= 1.
IanBenzMaxim 13:6a6225690c2e 81 void overlay(int x, int y, const uint8_t * data, size_t size, int width);
IanBenzMaxim 13:6a6225690c2e 82
IanBenzMaxim 13:6a6225690c2e 83 /// Reset to initial state.
IanBenzMaxim 13:6a6225690c2e 84 void clear();
IanBenzMaxim 13:6a6225690c2e 85
IanBenzMaxim 16:a004191a79ab 86 /// @brief Reset region to initial state.
IanBenzMaxim 13:6a6225690c2e 87 /// @param x,y Coordinates to begin clearing at.
IanBenzMaxim 13:6a6225690c2e 88 /// @param width,height Dimensions of the cleared region.
IanBenzMaxim 13:6a6225690c2e 89 void clear(int x, int y, int width, int height);
IanBenzMaxim 13:6a6225690c2e 90
IanBenzMaxim 0:33d4e66780c0 91 private:
IanBenzMaxim 16:a004191a79ab 92 int width_;
IanBenzMaxim 16:a004191a79ab 93 int height_;
IanBenzMaxim 16:a004191a79ab 94 std::vector<uint8_t> data_;
IanBenzMaxim 0:33d4e66780c0 95 };
IanBenzMaxim 0:33d4e66780c0 96
IanBenzMaxim 0:33d4e66780c0 97 #endif