1 files changed, 95 insertions, 0 deletions
diff --git a/FreeRTOS-Labs/Source/FreeRTOS-IoT-Libraries/c_sdk/standard/https/include/iot_https_utils.h b/FreeRTOS-Labs/Source/FreeRTOS-IoT-Libraries/c_sdk/standard/https/include/iot_https_utils.h
new file mode 100644
index 000000000..849d3fa3a
--- /dev/null
+++ b/FreeRTOS-Labs/Source/FreeRTOS-IoT-Libraries/c_sdk/standard/https/include/iot_https_utils.h
@@ -0,0 +1,95 @@
+/*
+ * Amazon FreeRTOS HTTPS Client V1.1.0
+ * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * http://aws.amazon.com/freertos
+ * http://www.FreeRTOS.org
+ */
+
+/**
+ * @file iot_https_utils.h
+ * @brief User facing HTTPS Client library utilities.
+ */
+
+#ifndef IOT_HTTPS_UTILS_H_
+#define IOT_HTTPS_UTILS_H_
+
+#include "types/iot_https_types.h"
+
+/*-----------------------------------------------------------*/
+
+/**
+ * @brief Retrieve the path from the input URL.
+ *
+ * This function retrieves the location and length of the path from within the
+ * input the URL. The query is not included in the length returned.
+ *
+ * The URL MUST start with "http://" or "https://" to find the path.
+ *
+ * For example, if the URL is:
+ * pUrl = "https://www.somewebsite.com/path/to/item.txt?optionalquery=stuff"
+ *
+ * *pPath = "/path/to/item.txt?optionalquery=stuff"
+ * *pPathLen = 17
+ *
+ * @param[in] pUrl - URL string to parse.
+ * @param[in] urlLen - The length of the URL string input.
+ * @param[out] pPath - pointer within input url that the path starts at.
+ * @param[out] pPathLen - Length of the path.
+ *
+ * - #IOT_HTTPS_OK if the path was successfully parsed.
+ * - #IOT_HTTPS_PARSING_ERROR if there was an error parsing the URL.
+ * - #IOT_HTTPS_NOT_FOUND if the path was not found.
+ */
+IotHttpsReturnCode_t IotHttpsClient_GetUrlPath( const char * pUrl,
+                                                size_t urlLen,
+                                                const char ** pPath,
+                                                size_t * pPathLen );
+
+/**
+ * @brief Retrieve the Address from the input URL.
+ *
+ * This function retrieves the location and length of the address from within
+ * the input URL. The path and query are not included in the length returned.
+ *
+ * The URL MUST start with "http://" or "https://" to find the address.
+ *
+ * For example, if the URL is:
+ * pUrl = "https://www.somewebsite.com/path/to/item.txt?optionalquery=stuff"
+ *
+ * *pAddress = "www.somewebsite.com/path/to/item.txt?optionalquery=stuff"
+ * *pAddressLen = 19
+ *
+ * @param[in] pUrl - URL string to parse.
+ * @param[in] urlLen - The length of the URL string input.
+ * @param[out] pAddress - pointer within input url that the address starts at.
+ * @param[out] pAddressLen - Length of the address.
+ *
+ * @return One of the following:
+ * - #IOT_HTTPS_OK if the path was successfully parsed.
+ * - #IOT_HTTPS_PARSING_ERROR if there was an error parsing the URL.
+ * - #IOT_HTTPS_NOT_FOUND if the address was not found.
+ */
+IotHttpsReturnCode_t IotHttpsClient_GetUrlAddress( const char * pUrl,
+                                                   size_t urlLen,
+                                                   const char ** pAddress,
+                                                   size_t * pAddressLen );
+
+#endif /* IOT_HTTPS_UTILS_H_ */