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.

CC3100.hpp@3:d2799d8497c0, 2017-03-02 (annotated)

Committer:
IanBenzMaxim
Date:
Thu Mar 02 10:15:53 2017 -0600
Revision:
3:d2799d8497c0
Parent:
0:33d4e66780c0
Child:
13:6a6225690c2e
Fixed error when removing non-printable characters from Text objects. Program is now running on GCC.

Who changed what in which revision?

UserRevisionLine numberNew 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 CC3100_HPP
IanBenzMaxim 0:33d4e66780c0 34 #define CC3100_HPP
IanBenzMaxim 0:33d4e66780c0 35
IanBenzMaxim 0:33d4e66780c0 36 #include <stdint.h>
IanBenzMaxim 0:33d4e66780c0 37 #include <stddef.h>
IanBenzMaxim 3:d2799d8497c0 38 #include <ctime>
IanBenzMaxim 0:33d4e66780c0 39 #include <string>
IanBenzMaxim 0:33d4e66780c0 40 #include <NetworkStack.h>
IanBenzMaxim 0:33d4e66780c0 41 #include <WiFiInterface.h>
IanBenzMaxim 0:33d4e66780c0 42 #include <SPI.h>
IanBenzMaxim 0:33d4e66780c0 43 #include <DigitalOut.h>
IanBenzMaxim 0:33d4e66780c0 44
IanBenzMaxim 0:33d4e66780c0 45 /// CC3100 Wi-Fi station interface for mbed using SPI.
IanBenzMaxim 0:33d4e66780c0 46 class CC3100 : public NetworkStack, public WiFiInterface
IanBenzMaxim 0:33d4e66780c0 47 {
IanBenzMaxim 0:33d4e66780c0 48 public:
IanBenzMaxim 0:33d4e66780c0 49 /// SPI bus interface.
IanBenzMaxim 0:33d4e66780c0 50 class SPI
IanBenzMaxim 0:33d4e66780c0 51 {
IanBenzMaxim 0:33d4e66780c0 52 public:
IanBenzMaxim 0:33d4e66780c0 53 SPI(PinName mosi, PinName miso, PinName sclk, PinName ssel);
IanBenzMaxim 0:33d4e66780c0 54 void transfer(const uint8_t * txData, size_t dataSize, uint8_t * rxData);
IanBenzMaxim 0:33d4e66780c0 55
IanBenzMaxim 0:33d4e66780c0 56 private:
IanBenzMaxim 0:33d4e66780c0 57 mbed::SPI spi;
IanBenzMaxim 0:33d4e66780c0 58 mbed::DigitalOut cs;
IanBenzMaxim 0:33d4e66780c0 59 };
IanBenzMaxim 0:33d4e66780c0 60
IanBenzMaxim 0:33d4e66780c0 61 /// CC3100 device state.
IanBenzMaxim 0:33d4e66780c0 62 enum State
IanBenzMaxim 0:33d4e66780c0 63 {
IanBenzMaxim 0:33d4e66780c0 64 Stopped,
IanBenzMaxim 0:33d4e66780c0 65 Disconnected,
IanBenzMaxim 0:33d4e66780c0 66 ConnectedWithoutIp,
IanBenzMaxim 0:33d4e66780c0 67 Connected,
IanBenzMaxim 0:33d4e66780c0 68 Pinging
IanBenzMaxim 0:33d4e66780c0 69 };
IanBenzMaxim 0:33d4e66780c0 70
IanBenzMaxim 0:33d4e66780c0 71 /// Result code occurring when the CC3100 is in an invalid state to perform and operation.
IanBenzMaxim 0:33d4e66780c0 72 static const int invalidState = -1;
IanBenzMaxim 0:33d4e66780c0 73
IanBenzMaxim 0:33d4e66780c0 74 /// Retrieve the singleton instance.
IanBenzMaxim 0:33d4e66780c0 75 static CC3100 & instance();
IanBenzMaxim 0:33d4e66780c0 76
IanBenzMaxim 0:33d4e66780c0 77 /// Current state of the CC3100.
IanBenzMaxim 0:33d4e66780c0 78 State state() const;
IanBenzMaxim 0:33d4e66780c0 79
IanBenzMaxim 0:33d4e66780c0 80 /// Start the CC3100 so that nework functionality is available.
IanBenzMaxim 0:33d4e66780c0 81 int start();
IanBenzMaxim 0:33d4e66780c0 82 /// Stop the CC3100 and enter a low power state.
IanBenzMaxim 0:33d4e66780c0 83 int stop();
IanBenzMaxim 0:33d4e66780c0 84 /// Update the networking stack. This should be called regularly to dispatch events.
IanBenzMaxim 0:33d4e66780c0 85 void update();
IanBenzMaxim 0:33d4e66780c0 86 /// Set the current date and time.
IanBenzMaxim 3:d2799d8497c0 87 int setDateTime(const std::tm & dateTime);
IanBenzMaxim 0:33d4e66780c0 88
IanBenzMaxim 0:33d4e66780c0 89 // WiFi station functionality
IanBenzMaxim 0:33d4e66780c0 90 virtual int set_credentials(const char * ssid, const char * pass, nsapi_security_t security = NSAPI_SECURITY_NONE);
IanBenzMaxim 0:33d4e66780c0 91 virtual int set_channel(uint8_t channel) { this->channel = channel; return 0; }
IanBenzMaxim 0:33d4e66780c0 92 virtual int8_t get_rssi() { return 0; } // Not implemented
IanBenzMaxim 0:33d4e66780c0 93 virtual int connect(const char * ssid, const char * pass, nsapi_security_t security = NSAPI_SECURITY_NONE, uint8_t channel = 0);
IanBenzMaxim 0:33d4e66780c0 94 virtual int connect() { return connect(ssid.c_str(), pass.c_str(), security, channel); }
IanBenzMaxim 0:33d4e66780c0 95 int connect(const char * ssid, const char * username, const char * password);
IanBenzMaxim 0:33d4e66780c0 96 virtual int disconnect();
IanBenzMaxim 0:33d4e66780c0 97 virtual int scan(WiFiAccessPoint * res, unsigned count) { return invalidState; } // Not implemented
IanBenzMaxim 0:33d4e66780c0 98
IanBenzMaxim 0:33d4e66780c0 99 // Network functionality
IanBenzMaxim 0:33d4e66780c0 100 virtual const char * get_ip_address() { return NULL; } // Not implemented
IanBenzMaxim 0:33d4e66780c0 101 virtual int gethostbyname(const char *host, SocketAddress *address, nsapi_version_t version = NSAPI_UNSPEC);
IanBenzMaxim 0:33d4e66780c0 102 int ping(const SocketAddress & address);
IanBenzMaxim 0:33d4e66780c0 103 virtual NetworkStack *get_stack() { return this; }
IanBenzMaxim 0:33d4e66780c0 104
IanBenzMaxim 0:33d4e66780c0 105 // Socket functionality
IanBenzMaxim 0:33d4e66780c0 106 virtual int socket_open(nsapi_socket_t *handle, nsapi_protocol_t proto);
IanBenzMaxim 0:33d4e66780c0 107 int socket_set_cert_path(nsapi_socket_t handle, const char * certPath);
IanBenzMaxim 0:33d4e66780c0 108 virtual int socket_close(nsapi_socket_t handle);
IanBenzMaxim 0:33d4e66780c0 109 virtual int socket_bind(nsapi_socket_t handle, const SocketAddress &address);
IanBenzMaxim 0:33d4e66780c0 110 virtual int socket_listen(nsapi_socket_t handle, int backlog);
IanBenzMaxim 0:33d4e66780c0 111 virtual int socket_connect(nsapi_socket_t handle, const SocketAddress &address);
IanBenzMaxim 0:33d4e66780c0 112 virtual int socket_accept(nsapi_socket_t server, nsapi_socket_t *handle, SocketAddress *address = 0)
IanBenzMaxim 0:33d4e66780c0 113 {
IanBenzMaxim 0:33d4e66780c0 114 // Not implemented
IanBenzMaxim 0:33d4e66780c0 115 return invalidState;
IanBenzMaxim 0:33d4e66780c0 116 }
IanBenzMaxim 0:33d4e66780c0 117 virtual int socket_send(nsapi_socket_t handle, const void *data, unsigned size);
IanBenzMaxim 0:33d4e66780c0 118 virtual int socket_recv(nsapi_socket_t handle, void *data, unsigned size);
IanBenzMaxim 0:33d4e66780c0 119 virtual int socket_sendto(nsapi_socket_t handle, const SocketAddress &address, const void *data, unsigned size)
IanBenzMaxim 0:33d4e66780c0 120 {
IanBenzMaxim 0:33d4e66780c0 121 // Not implemented
IanBenzMaxim 0:33d4e66780c0 122 return invalidState;
IanBenzMaxim 0:33d4e66780c0 123 }
IanBenzMaxim 0:33d4e66780c0 124 virtual int socket_recvfrom(nsapi_socket_t handle, SocketAddress *address, void *buffer, unsigned size)
IanBenzMaxim 0:33d4e66780c0 125 {
IanBenzMaxim 0:33d4e66780c0 126 // Not implemented
IanBenzMaxim 0:33d4e66780c0 127 return invalidState;
IanBenzMaxim 0:33d4e66780c0 128 }
IanBenzMaxim 0:33d4e66780c0 129 virtual void socket_attach(nsapi_socket_t handle, void (*callback)(void *), void *data)
IanBenzMaxim 0:33d4e66780c0 130 {
IanBenzMaxim 0:33d4e66780c0 131 // Not implemented
IanBenzMaxim 0:33d4e66780c0 132 }
IanBenzMaxim 0:33d4e66780c0 133
IanBenzMaxim 0:33d4e66780c0 134 private:
IanBenzMaxim 0:33d4e66780c0 135 SPI spi;
IanBenzMaxim 0:33d4e66780c0 136
IanBenzMaxim 0:33d4e66780c0 137 std::string ssid;
IanBenzMaxim 0:33d4e66780c0 138 std::string pass;
IanBenzMaxim 0:33d4e66780c0 139 nsapi_security_t security;
IanBenzMaxim 0:33d4e66780c0 140 uint8_t channel;
IanBenzMaxim 0:33d4e66780c0 141
IanBenzMaxim 0:33d4e66780c0 142 CC3100();
IanBenzMaxim 0:33d4e66780c0 143
IanBenzMaxim 0:33d4e66780c0 144 // Uncopyable
IanBenzMaxim 0:33d4e66780c0 145 CC3100(const CC3100 &);
IanBenzMaxim 0:33d4e66780c0 146 const CC3100& operator=(const CC3100 &);
IanBenzMaxim 0:33d4e66780c0 147 };
IanBenzMaxim 0:33d4e66780c0 148
IanBenzMaxim 0:33d4e66780c0 149 #endif