mirror of
https://github.com/espressif/ESP8266_RTOS_SDK.git
synced 2025-05-31 15:41:02 +08:00
feature/esp_http_client: Added the esp_http_client component from idf.
Added the component and the example from IDF.
This commit is contained in:
60
components/esp_http_client/lib/include/http_auth.h
Normal file
60
components/esp_http_client/lib/include/http_auth.h
Normal file
@ -0,0 +1,60 @@
|
||||
// Copyright 2015-2018 Espressif Systems (Shanghai) PTE LTD
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
|
||||
#ifndef _HTTP_BASIC_AUTH_H_
|
||||
#define _HTTP_BASIC_AUTH_H_
|
||||
|
||||
/**
|
||||
* HTTP Digest authentication data
|
||||
*/
|
||||
typedef struct {
|
||||
char *method; /*!< Request method, example: GET */
|
||||
char *algorithm; /*!< Authentication algorithm */
|
||||
char *uri; /*!< URI of request example: /path/to/file.html */
|
||||
char *realm; /*!< Authentication realm */
|
||||
char *nonce; /*!< Authentication nonce */
|
||||
char *qop; /*!< Authentication qop */
|
||||
char *opaque; /*!< Authentication opaque */
|
||||
uint64_t cnonce; /*!< Authentication cnonce */
|
||||
int nc; /*!< Authentication nc */
|
||||
} esp_http_auth_data_t;
|
||||
|
||||
/**
|
||||
* @brief This use for Http digest authentication method, create http header for digest authentication.
|
||||
* The returned string need to free after use
|
||||
*
|
||||
* @param[in] username The username
|
||||
* @param[in] password The password
|
||||
* @param auth_data The auth data
|
||||
*
|
||||
* @return
|
||||
* - HTTP Header value of Authorization, valid for digest authentication, must be freed after usage
|
||||
* - NULL
|
||||
*/
|
||||
char *http_auth_digest(const char *username, const char *password, esp_http_auth_data_t *auth_data);
|
||||
|
||||
/**
|
||||
* @brief This use for Http basic authentication method, create header value for basic http authentication
|
||||
* The returned string need to free after use
|
||||
*
|
||||
* @param[in] username The username
|
||||
* @param[in] password The password
|
||||
*
|
||||
* @return
|
||||
* - HTTP Header value of Authorization, valid for basic authentication, must be free after use
|
||||
* - NULL
|
||||
*/
|
||||
char *http_auth_basic(const char *username, const char *password);
|
||||
#endif
|
128
components/esp_http_client/lib/include/http_header.h
Normal file
128
components/esp_http_client/lib/include/http_header.h
Normal file
@ -0,0 +1,128 @@
|
||||
// Copyright 2015-2018 Espressif Systems (Shanghai) PTE LTD
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
#ifndef _HTTP_HEADER_H_
|
||||
#define _HTTP_HEADER_H_
|
||||
|
||||
#include "rom/queue.h"
|
||||
#include "esp_err.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
typedef struct http_header *http_header_handle_t;
|
||||
typedef struct http_header_item *http_header_item_handle_t;
|
||||
|
||||
/**
|
||||
* @brief initialize and allocate the memory for the header object
|
||||
*
|
||||
* @return
|
||||
* - http_header_handle_t
|
||||
* - NULL if any errors
|
||||
*/
|
||||
http_header_handle_t http_header_init();
|
||||
|
||||
/**
|
||||
* @brief Cleanup and free all http header pairs
|
||||
*
|
||||
* @param[in] header The header
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK
|
||||
* - ESP_FAIL
|
||||
*/
|
||||
esp_err_t http_header_clean(http_header_handle_t header);
|
||||
|
||||
/**
|
||||
* @brief Cleanup with http_header_clean and destroy http header handle object
|
||||
*
|
||||
* @param[in] header The header
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK
|
||||
* - ESP_FAIL
|
||||
*/
|
||||
esp_err_t http_header_destroy(http_header_handle_t header);
|
||||
|
||||
/**
|
||||
* @brief Add a key-value pair of http header to the list,
|
||||
* note that with value = NULL, this function will remove the header with `key` already exists in the list.
|
||||
*
|
||||
* @param[in] header The header
|
||||
* @param[in] key The key
|
||||
* @param[in] value The value
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK
|
||||
* - ESP_FAIL
|
||||
*/
|
||||
esp_err_t http_header_set(http_header_handle_t header, const char *key, const char *value);
|
||||
|
||||
/**
|
||||
* @brief Sample as `http_header_set` but the value can be formated
|
||||
*
|
||||
* @param[in] header The header
|
||||
* @param[in] key The key
|
||||
* @param[in] format The format
|
||||
* @param[in] ... format parameters
|
||||
*
|
||||
* @return Total length of value
|
||||
*/
|
||||
int http_header_set_format(http_header_handle_t header, const char *key, const char *format, ...);
|
||||
|
||||
/**
|
||||
* @brief Get a value of header in header list
|
||||
* The address of the value will be assign set to `value` parameter or NULL if no header with the key exists in the list
|
||||
*
|
||||
* @param[in] header The header
|
||||
* @param[in] key The key
|
||||
* @param[out] value The value
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK
|
||||
* - ESP_FAIL
|
||||
*/
|
||||
esp_err_t http_header_get(http_header_handle_t header, const char *key, char **value);
|
||||
|
||||
/**
|
||||
* @brief Create HTTP header string from the header with index, output string to buffer with buffer_len
|
||||
* Also return the last index of header was generated
|
||||
*
|
||||
* @param[in] header The header
|
||||
* @param[in] index The index
|
||||
* @param buffer The buffer
|
||||
* @param buffer_len The buffer length
|
||||
*
|
||||
* @return The last index of header was generated
|
||||
*/
|
||||
int http_header_generate_string(http_header_handle_t header, int index, char *buffer, int *buffer_len);
|
||||
|
||||
/**
|
||||
* @brief Remove the header with key from the headers list
|
||||
*
|
||||
* @param[in] header The header
|
||||
* @param[in] key The key
|
||||
*
|
||||
* @return
|
||||
* - ESP_OK
|
||||
* - ESP_FAIL
|
||||
*/
|
||||
esp_err_t http_header_delete(http_header_handle_t header, const char *key);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
86
components/esp_http_client/lib/include/http_utils.h
Normal file
86
components/esp_http_client/lib/include/http_utils.h
Normal file
@ -0,0 +1,86 @@
|
||||
// Copyright 2015-2018 Espressif Systems (Shanghai) PTE LTD
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
|
||||
#ifndef _HTTP_UTILS_H_
|
||||
#define _HTTP_UTILS_H_
|
||||
#include <sys/time.h>
|
||||
#include "esp_transport_utils.h"
|
||||
/**
|
||||
* @brief Assign new_str to *str pointer, and realloc *str if it not NULL
|
||||
*
|
||||
* @param str pointer to string pointer
|
||||
* @param new_str assign this tring to str
|
||||
* @param len length of string, 0 if new_str is zero terminated
|
||||
*
|
||||
* @return
|
||||
* - new_str pointer
|
||||
* - NULL
|
||||
*/
|
||||
char *http_utils_assign_string(char **str, const char *new_str, int len);
|
||||
|
||||
/**
|
||||
* @brief Remove white space at begin and end of string
|
||||
*
|
||||
* @param[in] str The string
|
||||
*
|
||||
* @return New strings have been trimmed
|
||||
*/
|
||||
void http_utils_trim_whitespace(char **str);
|
||||
|
||||
/**
|
||||
* @brief Gets the string between 2 string.
|
||||
* It will allocate a new memory space for this string, so you need to free it when no longer use
|
||||
*
|
||||
* @param[in] str The source string
|
||||
* @param[in] begin The begin string
|
||||
* @param[in] end The end string
|
||||
*
|
||||
* @return The string between begin and end
|
||||
*/
|
||||
char *http_utils_get_string_between(const char *str, const char *begin, const char *end);
|
||||
|
||||
/**
|
||||
* @brief Join 2 strings to one
|
||||
* It will allocate a new memory space for this string, so you need to free it when no longer use
|
||||
*
|
||||
* @param[in] first_str The first string
|
||||
* @param[in] len_first The length first
|
||||
* @param[in] second_str The second string
|
||||
* @param[in] len_second The length second
|
||||
*
|
||||
* @return
|
||||
* - New string pointer
|
||||
* - NULL: Invalid input
|
||||
*/
|
||||
char *http_utils_join_string(const char *first_str, int len_first, const char *second_str, int len_second);
|
||||
|
||||
/**
|
||||
* @brief Check if ``str`` is start with ``start``
|
||||
*
|
||||
* @param[in] str The string
|
||||
* @param[in] start The start
|
||||
*
|
||||
* @return
|
||||
* - (-1) if length of ``start`` larger than length of ``str``
|
||||
* - (1) if ``start`` NOT starts with ``start``
|
||||
* - (0) if ``str`` starts with ``start``
|
||||
*/
|
||||
int http_utils_str_starts_with(const char *str, const char *start);
|
||||
|
||||
|
||||
#define HTTP_MEM_CHECK(TAG, a, action) ESP_TRANSPORT_MEM_CHECK(TAG, a, action)
|
||||
|
||||
|
||||
#endif
|
Reference in New Issue
Block a user