git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/tools/aws_config_quick_start/aws_iot_demo_profile.templ

   1 /*\r
   2  * FreeRTOS Kernel V10.3.0\r
   3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 /*\r
  29  * IMPORTANT, CONFIGURATION REQUIRED: This is a configuration file containing AWS\r
  30  * IoT profile for the demos, will need additional setup:\r
  31  * https://www.freertos.org/mqtt/preconfiguredexamplesMA.html\r
  32  *\r
  33  * Each profile corresponds to a different service. The demos that use the same\r
  34  * profile share the same service. It is important to understand the\r
  35  * correspondence between the preconfigured profiles and demos, since each\r
  36  * service have different connection configuration and credential validation.\r
  37  *\r
  38  *  - mqtt_demo_profile.h is preconfigured to test.mosquitto.org MQTT broker.\r
  39  * The file is used with mqtt_plain_text demo and mqtt_basic_tls_server_auth\r
  40  * demo. Feel free to try out other broker with the demos.\r
  41  *\r
  42  *  - https_demo_profile.h is preconfigured to httpbin.org server. The file is\r
  43  * used with http_plain_text demo and https_basic_tls_server_auth demo.\r
  44  *\r
  45  *  - aws_iot_demo_profile.h (current) contains information to connect to AWS\r
  46  * IoT. The file is used with mqtt_tls_mutual_auth demo, https_tls_mutual_auth\r
  47  * demo, and other AWS IoT related demo.\r
  48  */\r
  49 \r
  50 #ifndef AWS_IOT_DEMO_PROFILE_H\r
  51 #define AWS_IOT_DEMO_PROFILE_H\r
  52 \r
  53 /**\r
  54  * @brief Details of the MQTT broker to connect to.\r
  55  *\r
  56  * This is the Thing's Rest API Endpoint for AWS IoT.\r
  57  *\r
  58  * #define awsiotdemoprofileAWS_ENDPOINT           "...insert here..."\r
  59  */\r
  60 #define awsiotdemoprofileAWS_ENDPOINT      <IOTEndpoint>\r
  61 \r
  62 /**\r
  63  * @brief The port to use for the MQTT demo.\r
  64  *\r
  65  * Use 8883 if connecting to AWS IoT services.\r
  66  */\r
  67 #define awsiotdemoprofileAWS_MQTT_PORT     8883\r
  68 \r
  69 /**\r
  70  * @brief The port to use for the HTTPS demo.\r
  71  *\r
  72  * Use 8443 if connecting to AWS IoT services.\r
  73  */\r
  74 #define awsiotdemoprofileAWS_HTTPS_PORT    8443\r
  75 \r
  76 /**\r
  77  * @brief The AWS IoT server certificate.\r
  78  *\r
  79  * This certificate is used to identify the AWS IoT server and is publicly\r
  80  * available.\r
  81  */\r
  82 #define awsiotdemoprofileAWS_CERTIFICATE_PEM                             \\r
  83     "-----BEGIN CERTIFICATE-----\n"                                      \\r
  84     "MIIDQTCCAimgAwIBAgITBmyfz5m/jAo54vB4ikPmljZbyjANBgkqhkiG9w0BAQsF\n" \\r
  85     "ADA5MQswCQYDVQQGEwJVUzEPMA0GA1UEChMGQW1hem9uMRkwFwYDVQQDExBBbWF6\n" \\r
  86     "b24gUm9vdCBDQSAxMB4XDTE1MDUyNjAwMDAwMFoXDTM4MDExNzAwMDAwMFowOTEL\n" \\r
  87     "MAkGA1UEBhMCVVMxDzANBgNVBAoTBkFtYXpvbjEZMBcGA1UEAxMQQW1hem9uIFJv\n" \\r
  88     "b3QgQ0EgMTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALJ4gHHKeNXj\n" \\r
  89     "ca9HgFB0fW7Y14h29Jlo91ghYPl0hAEvrAIthtOgQ3pOsqTQNroBvo3bSMgHFzZM\n" \\r
  90     "9O6II8c+6zf1tRn4SWiw3te5djgdYZ6k/oI2peVKVuRF4fn9tBb6dNqcmzU5L/qw\n" \\r
  91     "IFAGbHrQgLKm+a/sRxmPUDgH3KKHOVj4utWp+UhnMJbulHheb4mjUcAwhmahRWa6\n" \\r
  92     "VOujw5H5SNz/0egwLX0tdHA114gk957EWW67c4cX8jJGKLhD+rcdqsq08p8kDi1L\n" \\r
  93     "93FcXmn/6pUCyziKrlA4b9v7LWIbxcceVOF34GfID5yHI9Y/QCB/IIDEgEw+OyQm\n" \\r
  94     "jgSubJrIqg0CAwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMC\n" \\r
  95     "AYYwHQYDVR0OBBYEFIQYzIU07LwMlJQuCFmcx7IQTgoIMA0GCSqGSIb3DQEBCwUA\n" \\r
  96     "A4IBAQCY8jdaQZChGsV2USggNiMOruYou6r4lK5IpDB/G/wkjUu0yKGX9rbxenDI\n" \\r
  97     "U5PMCCjjmCXPI6T53iHTfIUJrU6adTrCC2qJeHZERxhlbI1Bjjt/msv0tadQ1wUs\n" \\r
  98     "N+gDS63pYaACbvXy8MWy7Vu33PqUXHeeE6V/Uq2V8viTO96LXFvKWlJbYK8U90vv\n" \\r
  99     "o/ufQJVtMVT8QtPHRh8jrdkPSHCa2XV4cdFyQzR1bldZwgJcJmApzyMZFo6IQ6XU\n" \\r
 100     "5MsI+yMRQ+hDKXJioaldXgjUkK642M4UwtBV8ob2xJNDd2ZhwLnoQdeXeGADbkpy\n" \\r
 101     "rqXRfboQnoZsG4q5WTP468SQvvG5\n"                                     \\r
 102     "-----END CERTIFICATE-----\n"\r
 103 \r
 104 /**\r
 105  * @brief The MQTT client identifier.\r
 106  *\r
 107  * This is the "Thing Name" in AWS IoT.\r
 108  *\r
 109  * #define awsiotdemoprofileCLIENT_IDENTIFIER    "...insert here..."\r
 110  */\r
 111 #define awsiotdemoprofileCLIENT_IDENTIFIER    <IOTThingName>\r
 112 \r
 113 /**\r
 114  * @brief PEM-encoded client certificate\r
 115  *\r
 116  * Must include the PEM header and footer:\r
 117  * "-----BEGIN CERTIFICATE-----\n"\\r
 118  * "...base64 data...\n"\\r
 119  * "-----END CERTIFICATE-----\n"\r
 120  *\r
 121  * #define awsiotdemoprofileCLIENT_CERTIFICATE_PEM    "...insert here..."\r
 122  */\r
 123 #define awsiotdemoprofileCLIENT_CERTIFICATE_PEM                          \\r
 124 <ClientCertificatePEM>\r
 125 \r
 126 /**\r
 127  * @brief PEM-encoded client private key.\r
 128  *\r
 129  * Must include the PEM header and footer:\r
 130  * "-----BEGIN RSA PRIVATE KEY-----\n"\\r
 131  * "...base64 data...\n"\\r
 132  * "-----END RSA PRIVATE KEY-----\n"\r
 133  *\r
 134  * #define awsiotdemoprofileCLIENT_PRIVATE_KEY_PEM    "...insert here..."\r
 135  */\r
 136 #define awsiotdemoprofileCLIENT_PRIVATE_KEY_PEM                          \\r
 137 <ClientPrivateKeyPEM>\r
 138 \r
 139 #endif /* AWS_IOT_DEMO_PROFILE_H */\r