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_transport.h@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?

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_TRANSPORT_H
IanBenzMaxim 0:33d4e66780c0 34 #define CC3100_TRANSPORT_H
IanBenzMaxim 0:33d4e66780c0 35
IanBenzMaxim 0:33d4e66780c0 36 #ifdef __cplusplus
IanBenzMaxim 0:33d4e66780c0 37 extern "C" {
IanBenzMaxim 0:33d4e66780c0 38 #endif
IanBenzMaxim 0:33d4e66780c0 39
IanBenzMaxim 0:33d4e66780c0 40 /*!
IanBenzMaxim 0:33d4e66780c0 41 \brief type definition for the spi channel file descriptor
IanBenzMaxim 0:33d4e66780c0 42
IanBenzMaxim 0:33d4e66780c0 43 \note On each porting or platform the type could be whatever is needed
IanBenzMaxim 0:33d4e66780c0 44 - integer, pointer to structure etc.
IanBenzMaxim 0:33d4e66780c0 45 */
IanBenzMaxim 13:6a6225690c2e 46 typedef void * SlFd_t;
IanBenzMaxim 0:33d4e66780c0 47
IanBenzMaxim 0:33d4e66780c0 48 /*!
IanBenzMaxim 0:33d4e66780c0 49 \brief type definition for the host interrupt handler
IanBenzMaxim 0:33d4e66780c0 50 \param pValue - pointer to any memory structure. The value of this pointer is given on
IanBenzMaxim 0:33d4e66780c0 51 registration of a new interrupt handler
IanBenzMaxim 0:33d4e66780c0 52 \note
IanBenzMaxim 0:33d4e66780c0 53 */
IanBenzMaxim 13:6a6225690c2e 54 typedef void (*SL_P_EVENT_HANDLER)(void * pValue);
IanBenzMaxim 0:33d4e66780c0 55
IanBenzMaxim 0:33d4e66780c0 56 /*!
IanBenzMaxim 0:33d4e66780c0 57 \brief open spi communication port to be used for communicating with a
IanBenzMaxim 0:33d4e66780c0 58 SimpleLink device
IanBenzMaxim 0:33d4e66780c0 59
IanBenzMaxim 0:33d4e66780c0 60 Given an interface name and option flags, this function opens the spi
IanBenzMaxim 0:33d4e66780c0 61 communication port and creates a file descriptor. This file descriptor can
IanBenzMaxim 0:33d4e66780c0 62 be used afterwards to read and write data from and to this specific spi
IanBenzMaxim 0:33d4e66780c0 63 channel.
IanBenzMaxim 0:33d4e66780c0 64 The SPI speed, clock polarity, clock phase, chip select and all other
IanBenzMaxim 0:33d4e66780c0 65 attributes are all set to hardcoded values in this function.
IanBenzMaxim 0:33d4e66780c0 66
IanBenzMaxim 0:33d4e66780c0 67 \param[in] ifName - points to the interface name/path. The
IanBenzMaxim 0:33d4e66780c0 68 interface name is an optional attributes that the simple
IanBenzMaxim 0:33d4e66780c0 69 link driver receives on opening the device. in systems that
IanBenzMaxim 0:33d4e66780c0 70 the spi channel is not implemented as part of the os device
IanBenzMaxim 0:33d4e66780c0 71 drivers, this parameter could be NULL.
IanBenzMaxim 0:33d4e66780c0 72 \param[in] flags - option flags
IanBenzMaxim 0:33d4e66780c0 73
IanBenzMaxim 0:33d4e66780c0 74 \return upon successful completion, the function shall open the spi
IanBenzMaxim 0:33d4e66780c0 75 channel and return a non-negative integer representing the
IanBenzMaxim 0:33d4e66780c0 76 file descriptor. Otherwise, -1 shall be returned
IanBenzMaxim 0:33d4e66780c0 77
IanBenzMaxim 0:33d4e66780c0 78 \sa spi_Close , spi_Read , spi_Write
IanBenzMaxim 0:33d4e66780c0 79 \note
IanBenzMaxim 0:33d4e66780c0 80 \warning
IanBenzMaxim 0:33d4e66780c0 81 */
IanBenzMaxim 13:6a6225690c2e 82 SlFd_t sl_IfOpen(const char * ifName, unsigned long flags);
IanBenzMaxim 0:33d4e66780c0 83
IanBenzMaxim 0:33d4e66780c0 84 /*!
IanBenzMaxim 0:33d4e66780c0 85 \brief closes an opened spi communication port
IanBenzMaxim 0:33d4e66780c0 86
IanBenzMaxim 0:33d4e66780c0 87 \param[in] fd - file descriptor of an opened SPI channel
IanBenzMaxim 0:33d4e66780c0 88
IanBenzMaxim 0:33d4e66780c0 89 \return upon successful completion, the function shall return 0.
IanBenzMaxim 0:33d4e66780c0 90 Otherwise, -1 shall be returned
IanBenzMaxim 0:33d4e66780c0 91
IanBenzMaxim 0:33d4e66780c0 92 \sa spi_Open
IanBenzMaxim 0:33d4e66780c0 93 \note
IanBenzMaxim 0:33d4e66780c0 94 \warning
IanBenzMaxim 0:33d4e66780c0 95 */
IanBenzMaxim 0:33d4e66780c0 96 int sl_IfClose(SlFd_t fd);
IanBenzMaxim 0:33d4e66780c0 97
IanBenzMaxim 0:33d4e66780c0 98 /*!
IanBenzMaxim 0:33d4e66780c0 99 \brief attempts to read up to len bytes from SPI channel into a buffer
IanBenzMaxim 0:33d4e66780c0 100 starting at pBuff.
IanBenzMaxim 0:33d4e66780c0 101
IanBenzMaxim 0:33d4e66780c0 102 \param[in] fd - file descriptor of an opened SPI channel
IanBenzMaxim 0:33d4e66780c0 103
IanBenzMaxim 0:33d4e66780c0 104 \param[in] pBuff - points to first location to start writing the
IanBenzMaxim 0:33d4e66780c0 105 data
IanBenzMaxim 0:33d4e66780c0 106
IanBenzMaxim 0:33d4e66780c0 107 \param[in] len - number of bytes to read from the SPI channel
IanBenzMaxim 0:33d4e66780c0 108
IanBenzMaxim 0:33d4e66780c0 109 \return upon successful completion, the function shall return 0.
IanBenzMaxim 0:33d4e66780c0 110 Otherwise, -1 shall be returned
IanBenzMaxim 0:33d4e66780c0 111
IanBenzMaxim 0:33d4e66780c0 112 \sa spi_Open , spi_Write
IanBenzMaxim 0:33d4e66780c0 113 \note
IanBenzMaxim 0:33d4e66780c0 114 \warning
IanBenzMaxim 0:33d4e66780c0 115 */
IanBenzMaxim 13:6a6225690c2e 116 int sl_IfRead(SlFd_t fd, unsigned char * pBuff, int len);
IanBenzMaxim 0:33d4e66780c0 117
IanBenzMaxim 0:33d4e66780c0 118 /*!
IanBenzMaxim 0:33d4e66780c0 119 \brief attempts to write up to len bytes to the SPI channel
IanBenzMaxim 0:33d4e66780c0 120
IanBenzMaxim 0:33d4e66780c0 121 \param[in] fd - file descriptor of an opened SPI channel
IanBenzMaxim 0:33d4e66780c0 122
IanBenzMaxim 0:33d4e66780c0 123 \param[in] pBuff - points to first location to start getting the
IanBenzMaxim 0:33d4e66780c0 124 data from
IanBenzMaxim 0:33d4e66780c0 125
IanBenzMaxim 0:33d4e66780c0 126 \param[in] len - number of bytes to write to the SPI channel
IanBenzMaxim 0:33d4e66780c0 127
IanBenzMaxim 0:33d4e66780c0 128 \return upon successful completion, the function shall return 0.
IanBenzMaxim 0:33d4e66780c0 129 Otherwise, -1 shall be returned
IanBenzMaxim 0:33d4e66780c0 130
IanBenzMaxim 0:33d4e66780c0 131 \sa spi_Open , spi_Read
IanBenzMaxim 0:33d4e66780c0 132 \note This function could be implemented as zero copy and return
IanBenzMaxim 0:33d4e66780c0 133 only upon successful completion of writing the whole buffer,
IanBenzMaxim 0:33d4e66780c0 134 but in cases that memory allocation is not too tight, the
IanBenzMaxim 0:33d4e66780c0 135 function could copy the data to internal buffer, return
IanBenzMaxim 0:33d4e66780c0 136 back and complete the write in parallel to other activities
IanBenzMaxim 0:33d4e66780c0 137 as long as the other SPI activities would be blocked untill
IanBenzMaxim 0:33d4e66780c0 138 the entire buffer write would be completed
IanBenzMaxim 0:33d4e66780c0 139 \warning
IanBenzMaxim 0:33d4e66780c0 140 */
IanBenzMaxim 13:6a6225690c2e 141 int sl_IfWrite(SlFd_t fd, const unsigned char * pBuff, int len);
IanBenzMaxim 0:33d4e66780c0 142
IanBenzMaxim 0:33d4e66780c0 143 /*!
IanBenzMaxim 0:33d4e66780c0 144 \brief register an interrupt handler for the host IRQ
IanBenzMaxim 0:33d4e66780c0 145
IanBenzMaxim 0:33d4e66780c0 146 \param[in] InterruptHdl - pointer to interrupt handler function
IanBenzMaxim 0:33d4e66780c0 147
IanBenzMaxim 0:33d4e66780c0 148 \param[in] pValue - pointer to a memory strcuture that is
IanBenzMaxim 0:33d4e66780c0 149 passed to the interrupt handler.
IanBenzMaxim 0:33d4e66780c0 150
IanBenzMaxim 0:33d4e66780c0 151 \return upon successful registration, the function shall return 0.
IanBenzMaxim 0:33d4e66780c0 152 Otherwise, -1 shall be returned
IanBenzMaxim 0:33d4e66780c0 153
IanBenzMaxim 0:33d4e66780c0 154 \sa
IanBenzMaxim 0:33d4e66780c0 155 \note If there is already registered interrupt handler, the
IanBenzMaxim 0:33d4e66780c0 156 function should overwrite the old handler with the new one
IanBenzMaxim 0:33d4e66780c0 157
IanBenzMaxim 0:33d4e66780c0 158 \warning
IanBenzMaxim 0:33d4e66780c0 159 */
IanBenzMaxim 13:6a6225690c2e 160 int sl_IfRegIntHdlr(SL_P_EVENT_HANDLER InterruptHdl, void * pValue);
IanBenzMaxim 0:33d4e66780c0 161
IanBenzMaxim 0:33d4e66780c0 162 /*!
IanBenzMaxim 0:33d4e66780c0 163 \brief Enable the Network Processor
IanBenzMaxim 0:33d4e66780c0 164
IanBenzMaxim 0:33d4e66780c0 165 \sa sl_DeviceDisable
IanBenzMaxim 0:33d4e66780c0 166
IanBenzMaxim 0:33d4e66780c0 167 \note belongs to \ref porting_sec
IanBenzMaxim 0:33d4e66780c0 168
IanBenzMaxim 0:33d4e66780c0 169 */
IanBenzMaxim 0:33d4e66780c0 170 void sl_DeviceEnable(void);
IanBenzMaxim 0:33d4e66780c0 171
IanBenzMaxim 0:33d4e66780c0 172 /*!
IanBenzMaxim 0:33d4e66780c0 173 \brief Disable the Network Processor
IanBenzMaxim 0:33d4e66780c0 174
IanBenzMaxim 0:33d4e66780c0 175 \sa sl_DeviceEnable
IanBenzMaxim 0:33d4e66780c0 176
IanBenzMaxim 0:33d4e66780c0 177 \note belongs to \ref porting_sec
IanBenzMaxim 0:33d4e66780c0 178 */
IanBenzMaxim 0:33d4e66780c0 179 void sl_DeviceDisable(void);
IanBenzMaxim 0:33d4e66780c0 180
IanBenzMaxim 13:6a6225690c2e 181 #ifdef __cplusplus
IanBenzMaxim 0:33d4e66780c0 182 }
IanBenzMaxim 0:33d4e66780c0 183 #endif // __cplusplus
IanBenzMaxim 0:33d4e66780c0 184
IanBenzMaxim 0:33d4e66780c0 185 #endif