Browse Source

Implement peer review feedback

kaleb-himes 1 year ago
parent
commit
30d836dc90

+ 44 - 0
IDE/MSVS-2019-AZSPHERE/README.md

@@ -0,0 +1,44 @@
+wolfSSL for Microsoft Azure Sphere Devices in MSVS 2019
+==========================================
+
+## Description
+This directory contains the Visual Studio CMake Project that is targeted for
+the visual studio 2019 Azure Sphere plugin.
+
+## Limitations
+The example includes a client and server executable but the main.c app
+only runs the server by default. main.c can be manually modified to run the
+client instead if desired.
+
+By default the main.c app include the hardware definitions for MT3620-mini. It
+can be manually modified to include hardware definitions for MT3620, or
+avnet MT3620 instead.
+
+The app relies on a wolfSSL static library project, app and library  are built
+by the CMakeLists.txt located in
+IDE/MSVS-2019-AZSPHERE/wolfssl_new_azsphere/CMakeLists.txt. The library and app
+use `user_settings.h` to enable and disable features.
+
+### Set Up Steps
+0. Setup your Azure Sphere device.
+   [Install Azure Sphere](https://docs.microsoft.com/en-us/azure-sphere/install/install)
+   [Set up an account](https://docs.microsoft.com/en-us/azure-sphere/install/azure-directory-account)
+   [Claim your device](https://docs.microsoft.com/en-us/azure-sphere/install/claim-device)
+   [Configure networking](https://docs.microsoft.com/en-us/azure-sphere/install/configure-wifi)
+
+1. Open the local folder IDE/MSVS-2019-AZSPHERE/wolfssl_new_azsphere in MSVS 2019
+
+2. From the file menu select "Build" dropdown
+    + Click: `Rebuild All` option
+
+3. Connect your Azure Sphere MT3620-mini Development Board using USB.
+
+4. Test the server.
+    + Run server(Azure Sphere) using: `Debug->'Start new instance'`
+    + Run the following wolfSSL example client command inside wolfssl directory.
+
+```
+./examples/client/client -h "Server IP Address" -p 11111 -A ./certs/ca-cert.pem
+```
+
+For other information please refer to the README in IDE/VS-AZURE-SPHERE

+ 21 - 0
IDE/MSVS-2019-AZSPHERE/shared/util.h

@@ -1,3 +1,24 @@
+/* util.h
+ *
+ * Copyright (C) 2006-2022 wolfSSL Inc.
+ *
+ * This file is part of wolfSSL.
+ *
+ * wolfSSL is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * wolfSSL is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
+ */
+
 #ifndef _UTIL_H_
 #define _UTIL_H_
 

+ 24 - 2
IDE/MSVS-2019-AZSPHERE/user_settings.h

@@ -1,8 +1,30 @@
-#define SERVER_IP "192.168.1.123" 
-#define CUSTOM_SERVER_CONNECTION 
+/* user_settings.h
+ *
+ * Copyright (C) 2006-2022 wolfSSL Inc.
+ *
+ * This file is part of wolfSSL.
+ *
+ * wolfSSL is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * wolfSSL is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
+ */
+
 #ifndef _USER_SETTINGS_H_
 #define _USER_SETTINGS_H_
 
+#define SERVER_IP "192.168.1.123"
+#define CUSTOM_SERVER_CONNECTION
+
 #define WOLFSSL_AZSPHERE
 /* Client connects to the server with these details. */
 #ifdef CUSTOM_SERVER_CONNECTION

+ 2 - 2
IDE/MSVS-2019-AZSPHERE/wolfssl_new_azsphere/HardwareDefinitions/mt3620_rdb/inc/hw/template_appliance.h

@@ -10,7 +10,7 @@
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- *",
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
@@ -22,7 +22,7 @@
  * attached externally (conditionally).
  * See https://aka.ms/AzureSphereHardwareDefinitions for more
  * information on how to use hardware abstractions .
- */"
+ */
 
 #pragma once
 #include "mt3620_rdb.h"