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