esp_http_client.c 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556
  1. /*
  2. * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
  3. *
  4. * SPDX-License-Identifier: Apache-2.0
  5. */
  6. #include <string.h>
  7. #include "esp_system.h"
  8. #include "esp_log.h"
  9. #include "esp_check.h"
  10. #include "http_header.h"
  11. #include "esp_transport.h"
  12. #include "esp_transport_tcp.h"
  13. #include "http_utils.h"
  14. #include "http_auth.h"
  15. #include "sdkconfig.h"
  16. #include "esp_http_client.h"
  17. #include "errno.h"
  18. #ifdef CONFIG_ESP_HTTP_CLIENT_ENABLE_HTTPS
  19. #include "esp_transport_ssl.h"
  20. #endif
  21. static const char *TAG = "HTTP_CLIENT";
  22. /**
  23. * HTTP Buffer
  24. */
  25. typedef struct {
  26. char *data; /*!< The HTTP data received from the server */
  27. int len; /*!< The HTTP data len received from the server */
  28. char *raw_data; /*!< The HTTP data after decoding */
  29. int raw_len; /*!< The HTTP data len after decoding */
  30. char *output_ptr; /*!< The destination address of the data to be copied to after decoding */
  31. } esp_http_buffer_t;
  32. /**
  33. * private HTTP Data structure
  34. */
  35. typedef struct {
  36. http_header_handle_t headers; /*!< http header */
  37. esp_http_buffer_t *buffer; /*!< data buffer as linked list */
  38. int status_code; /*!< status code (integer) */
  39. int64_t content_length; /*!< data length */
  40. int chunk_length; /*!< chunk length */
  41. int data_offset; /*!< offset to http data (Skip header) */
  42. int64_t data_process; /*!< data processed */
  43. int method; /*!< http method */
  44. bool is_chunked;
  45. } esp_http_data_t;
  46. typedef struct {
  47. char *url;
  48. char *scheme;
  49. char *host;
  50. int port;
  51. char *username;
  52. char *password;
  53. char *path;
  54. char *query;
  55. char *cert_pem;
  56. esp_http_client_method_t method;
  57. esp_http_client_auth_type_t auth_type;
  58. esp_http_client_transport_t transport_type;
  59. int max_store_header_size;
  60. } connection_info_t;
  61. typedef enum {
  62. HTTP_STATE_UNINIT = 0,
  63. HTTP_STATE_INIT,
  64. HTTP_STATE_CONNECTED,
  65. HTTP_STATE_REQ_COMPLETE_HEADER,
  66. HTTP_STATE_REQ_COMPLETE_DATA,
  67. HTTP_STATE_RES_COMPLETE_HEADER,
  68. HTTP_STATE_RES_COMPLETE_DATA,
  69. HTTP_STATE_CLOSE
  70. } esp_http_state_t;
  71. /**
  72. * HTTP client class
  73. */
  74. struct esp_http_client {
  75. int redirect_counter;
  76. int max_redirection_count;
  77. int max_authorization_retries;
  78. int process_again;
  79. struct http_parser *parser;
  80. struct http_parser_settings *parser_settings;
  81. esp_transport_list_handle_t transport_list;
  82. esp_transport_handle_t transport;
  83. esp_http_data_t *request;
  84. esp_http_data_t *response;
  85. void *user_data;
  86. esp_http_auth_data_t *auth_data;
  87. char *post_data;
  88. char *location;
  89. char *auth_header;
  90. char *current_header_key;
  91. char *current_header_value;
  92. int post_len;
  93. connection_info_t connection_info;
  94. bool is_chunk_complete;
  95. esp_http_state_t state;
  96. http_event_handle_cb event_handler;
  97. int timeout_ms;
  98. int buffer_size_rx;
  99. int buffer_size_tx;
  100. bool disable_auto_redirect;
  101. esp_http_client_event_t event;
  102. int data_written_index;
  103. int data_write_left;
  104. bool first_line_prepared;
  105. int header_index;
  106. bool is_async;
  107. esp_transport_keep_alive_t keep_alive_cfg;
  108. struct ifreq *if_name;
  109. };
  110. typedef struct esp_http_client esp_http_client_t;
  111. static esp_err_t _clear_connection_info(esp_http_client_handle_t client);
  112. /**
  113. * Default settings
  114. */
  115. #define DEFAULT_HTTP_PORT (80)
  116. #define DEFAULT_HTTPS_PORT (443)
  117. #define ASYNC_TRANS_CONNECT_FAIL -1
  118. #define ASYNC_TRANS_CONNECTING 0
  119. #define ASYNC_TRANS_CONNECT_PASS 1
  120. static const char *DEFAULT_HTTP_USER_AGENT = "ESP32 HTTP Client/1.0";
  121. static const char *DEFAULT_HTTP_PROTOCOL = "HTTP/1.1";
  122. static const char *DEFAULT_HTTP_PATH = "/";
  123. static const int DEFAULT_MAX_REDIRECT = 10;
  124. static const int DEFAULT_MAX_AUTH_RETRIES = 10;
  125. static const int DEFAULT_TIMEOUT_MS = 5000;
  126. static const int DEFAULT_KEEP_ALIVE_IDLE = 5;
  127. static const int DEFAULT_KEEP_ALIVE_INTERVAL= 5;
  128. static const int DEFAULT_KEEP_ALIVE_COUNT= 3;
  129. static const char *HTTP_METHOD_MAPPING[] = {
  130. "GET",
  131. "POST",
  132. "PUT",
  133. "PATCH",
  134. "DELETE",
  135. "HEAD",
  136. "NOTIFY",
  137. "SUBSCRIBE",
  138. "UNSUBSCRIBE",
  139. "OPTIONS",
  140. "COPY",
  141. "MOVE",
  142. "LOCK",
  143. "UNLOCK",
  144. "PROPFIND",
  145. "PROPPATCH",
  146. "MKCOL"
  147. };
  148. static esp_err_t esp_http_client_request_send(esp_http_client_handle_t client, int write_len);
  149. static esp_err_t esp_http_client_connect(esp_http_client_handle_t client);
  150. static esp_err_t esp_http_client_send_post_data(esp_http_client_handle_t client);
  151. static esp_err_t http_dispatch_event(esp_http_client_t *client, esp_http_client_event_id_t event_id, void *data, int len)
  152. {
  153. esp_http_client_event_t *event = &client->event;
  154. if (client->event_handler) {
  155. event->event_id = event_id;
  156. event->user_data = client->user_data;
  157. event->data = data;
  158. event->data_len = len;
  159. return client->event_handler(event);
  160. }
  161. return ESP_OK;
  162. }
  163. static int http_on_message_begin(http_parser *parser)
  164. {
  165. esp_http_client_t *client = parser->data;
  166. ESP_LOGD(TAG, "on_message_begin");
  167. client->response->is_chunked = false;
  168. client->is_chunk_complete = false;
  169. return 0;
  170. }
  171. static int http_on_url(http_parser *parser, const char *at, size_t length)
  172. {
  173. ESP_LOGD(TAG, "http_on_url");
  174. return 0;
  175. }
  176. static int http_on_status(http_parser *parser, const char *at, size_t length)
  177. {
  178. return 0;
  179. }
  180. static int http_on_header_event(esp_http_client_handle_t client)
  181. {
  182. if (client->current_header_key != NULL && client->current_header_value != NULL) {
  183. ESP_LOGD(TAG, "HEADER=%s:%s", client->current_header_key, client->current_header_value);
  184. client->event.header_key = client->current_header_key;
  185. client->event.header_value = client->current_header_value;
  186. http_dispatch_event(client, HTTP_EVENT_ON_HEADER, NULL, 0);
  187. free(client->current_header_key);
  188. free(client->current_header_value);
  189. client->current_header_key = NULL;
  190. client->current_header_value = NULL;
  191. }
  192. return 0;
  193. }
  194. static int http_on_header_field(http_parser *parser, const char *at, size_t length)
  195. {
  196. esp_http_client_t *client = parser->data;
  197. http_on_header_event(client);
  198. http_utils_append_string(&client->current_header_key, at, length);
  199. return 0;
  200. }
  201. static int http_on_header_value(http_parser *parser, const char *at, size_t length)
  202. {
  203. esp_http_client_handle_t client = parser->data;
  204. if (client->current_header_key == NULL) {
  205. return 0;
  206. }
  207. if (strcasecmp(client->current_header_key, "Location") == 0) {
  208. http_utils_append_string(&client->location, at, length);
  209. } else if (strcasecmp(client->current_header_key, "Transfer-Encoding") == 0
  210. && memcmp(at, "chunked", length) == 0) {
  211. client->response->is_chunked = true;
  212. } else if (strcasecmp(client->current_header_key, "WWW-Authenticate") == 0) {
  213. http_utils_append_string(&client->auth_header, at, length);
  214. }
  215. http_utils_append_string(&client->current_header_value, at, length);
  216. return 0;
  217. }
  218. static int http_on_headers_complete(http_parser *parser)
  219. {
  220. esp_http_client_handle_t client = parser->data;
  221. http_on_header_event(client);
  222. client->response->status_code = parser->status_code;
  223. client->response->data_offset = parser->nread;
  224. client->response->content_length = parser->content_length;
  225. client->response->data_process = 0;
  226. ESP_LOGD(TAG, "http_on_headers_complete, status=%d, offset=%d, nread=%d", parser->status_code, client->response->data_offset, parser->nread);
  227. client->state = HTTP_STATE_RES_COMPLETE_HEADER;
  228. if (client->connection_info.method == HTTP_METHOD_HEAD) {
  229. /* In a HTTP_RESPONSE parser returning '1' from on_headers_complete will tell the
  230. parser that it should not expect a body. This is used when receiving a response
  231. to a HEAD request which may contain 'Content-Length' or 'Transfer-Encoding: chunked'
  232. headers that indicate the presence of a body.*/
  233. return 1;
  234. }
  235. return 0;
  236. }
  237. static int http_on_body(http_parser *parser, const char *at, size_t length)
  238. {
  239. esp_http_client_t *client = parser->data;
  240. ESP_LOGD(TAG, "http_on_body %d", length);
  241. client->response->buffer->raw_data = (char *)at;
  242. if (client->response->buffer->output_ptr) {
  243. memcpy(client->response->buffer->output_ptr, (char *)at, length);
  244. client->response->buffer->output_ptr += length;
  245. }
  246. client->response->data_process += length;
  247. client->response->buffer->raw_len += length;
  248. http_dispatch_event(client, HTTP_EVENT_ON_DATA, (void *)at, length);
  249. return 0;
  250. }
  251. static int http_on_message_complete(http_parser *parser)
  252. {
  253. ESP_LOGD(TAG, "http_on_message_complete, parser=%x", (int)parser);
  254. esp_http_client_handle_t client = parser->data;
  255. client->is_chunk_complete = true;
  256. return 0;
  257. }
  258. static int http_on_chunk_complete(http_parser *parser)
  259. {
  260. ESP_LOGD(TAG, "http_on_chunk_complete");
  261. return 0;
  262. }
  263. static int http_on_chunk_header(http_parser *parser)
  264. {
  265. esp_http_client_handle_t client = parser->data;
  266. client->response->chunk_length = parser->content_length;
  267. ESP_LOGD(TAG, "http_on_chunk_header, chunk_length");
  268. return 0;
  269. }
  270. esp_err_t esp_http_client_set_header(esp_http_client_handle_t client, const char *key, const char *value)
  271. {
  272. return http_header_set(client->request->headers, key, value);
  273. }
  274. esp_err_t esp_http_client_get_header(esp_http_client_handle_t client, const char *key, char **value)
  275. {
  276. return http_header_get(client->request->headers, key, value);
  277. }
  278. esp_err_t esp_http_client_delete_header(esp_http_client_handle_t client, const char *key)
  279. {
  280. return http_header_delete(client->request->headers, key);
  281. }
  282. esp_err_t esp_http_client_get_username(esp_http_client_handle_t client, char **value)
  283. {
  284. if (client == NULL || value == NULL) {
  285. ESP_LOGE(TAG, "client or value must not be NULL");
  286. return ESP_ERR_INVALID_ARG;
  287. }
  288. *value = client->connection_info.username;
  289. return ESP_OK;
  290. }
  291. esp_err_t esp_http_client_set_username(esp_http_client_handle_t client, const char *username)
  292. {
  293. if (client == NULL) {
  294. ESP_LOGE(TAG, "client must not be NULL");
  295. return ESP_ERR_INVALID_ARG;
  296. }
  297. if (client->connection_info.username != NULL) {
  298. free(client->connection_info.username);
  299. }
  300. client->connection_info.username = username ? strdup(username) : NULL;
  301. return ESP_OK;
  302. }
  303. esp_err_t esp_http_client_get_password(esp_http_client_handle_t client, char **value)
  304. {
  305. if (client == NULL || value == NULL) {
  306. ESP_LOGE(TAG, "client or value must not be NULL");
  307. return ESP_ERR_INVALID_ARG;
  308. }
  309. *value = client->connection_info.password;
  310. return ESP_OK;
  311. }
  312. esp_err_t esp_http_client_set_password(esp_http_client_handle_t client, const char *password)
  313. {
  314. if (client == NULL) {
  315. ESP_LOGE(TAG, "client must not be NULL");
  316. return ESP_ERR_INVALID_ARG;
  317. }
  318. if (client->connection_info.password != NULL) {
  319. memset(client->connection_info.password, 0, strlen(client->connection_info.password));
  320. free(client->connection_info.password);
  321. }
  322. client->connection_info.password = password ? strdup(password) : NULL;
  323. return ESP_OK;
  324. }
  325. esp_err_t esp_http_client_set_authtype(esp_http_client_handle_t client, esp_http_client_auth_type_t auth_type)
  326. {
  327. if (client == NULL) {
  328. ESP_LOGE(TAG, "client must not be NULL");
  329. return ESP_ERR_INVALID_ARG;
  330. }
  331. client->connection_info.auth_type = auth_type;
  332. return ESP_OK;
  333. }
  334. static esp_err_t _set_config(esp_http_client_handle_t client, const esp_http_client_config_t *config)
  335. {
  336. esp_err_t ret = ESP_OK;
  337. client->connection_info.method = config->method;
  338. client->connection_info.port = config->port;
  339. client->connection_info.auth_type = config->auth_type;
  340. client->event_handler = config->event_handler;
  341. client->timeout_ms = config->timeout_ms;
  342. client->max_redirection_count = config->max_redirection_count;
  343. client->max_authorization_retries = config->max_authorization_retries;
  344. client->user_data = config->user_data;
  345. client->buffer_size_rx = config->buffer_size;
  346. client->buffer_size_tx = config->buffer_size_tx;
  347. client->disable_auto_redirect = config->disable_auto_redirect;
  348. if (config->buffer_size == 0) {
  349. client->buffer_size_rx = DEFAULT_HTTP_BUF_SIZE;
  350. }
  351. if (config->buffer_size_tx == 0) {
  352. client->buffer_size_tx = DEFAULT_HTTP_BUF_SIZE;
  353. }
  354. if (client->max_redirection_count == 0) {
  355. client->max_redirection_count = DEFAULT_MAX_REDIRECT;
  356. }
  357. if (client->max_authorization_retries == 0) {
  358. client->max_authorization_retries = DEFAULT_MAX_AUTH_RETRIES;
  359. } else if (client->max_authorization_retries == -1) {
  360. client->max_authorization_retries = 0;
  361. }
  362. if (config->path) {
  363. client->connection_info.path = strdup(config->path);
  364. } else {
  365. client->connection_info.path = strdup(DEFAULT_HTTP_PATH);
  366. }
  367. ESP_RETURN_ON_FALSE(client->connection_info.path, ESP_ERR_NO_MEM, TAG, "Memory exhausted");
  368. if (config->host) {
  369. client->connection_info.host = strdup(config->host);
  370. ESP_GOTO_ON_FALSE(client->connection_info.host, ESP_ERR_NO_MEM, error, TAG, "Memory exhausted");
  371. }
  372. if (config->query) {
  373. client->connection_info.query = strdup(config->query);
  374. ESP_GOTO_ON_FALSE(client->connection_info.query, ESP_ERR_NO_MEM, error, TAG, "Memory exhausted");
  375. }
  376. if (config->username) {
  377. client->connection_info.username = strdup(config->username);
  378. ESP_GOTO_ON_FALSE(client->connection_info.username, ESP_ERR_NO_MEM, error, TAG, "Memory exhausted");
  379. }
  380. if (config->password) {
  381. client->connection_info.password = strdup(config->password);
  382. ESP_GOTO_ON_FALSE(client->connection_info.password, ESP_ERR_NO_MEM, error, TAG, "Memory exhausted");
  383. }
  384. if (config->transport_type == HTTP_TRANSPORT_OVER_SSL) {
  385. http_utils_assign_string(&client->connection_info.scheme, "https", -1);
  386. if (client->connection_info.port == 0) {
  387. client->connection_info.port = DEFAULT_HTTPS_PORT;
  388. }
  389. } else {
  390. http_utils_assign_string(&client->connection_info.scheme, "http", -1);
  391. if (client->connection_info.port == 0) {
  392. client->connection_info.port = DEFAULT_HTTP_PORT;
  393. }
  394. }
  395. if (client->timeout_ms == 0) {
  396. client->timeout_ms = DEFAULT_TIMEOUT_MS;
  397. }
  398. if (config->is_async) {
  399. client->is_async = true;
  400. }
  401. return ret;
  402. error:
  403. _clear_connection_info(client);
  404. return ret;
  405. }
  406. static esp_err_t _clear_connection_info(esp_http_client_handle_t client)
  407. {
  408. free(client->connection_info.path);
  409. free(client->connection_info.host);
  410. free(client->connection_info.query);
  411. free(client->connection_info.username);
  412. if (client->connection_info.password) {
  413. memset(client->connection_info.password, 0, strlen(client->connection_info.password));
  414. free(client->connection_info.password);
  415. }
  416. free(client->connection_info.scheme);
  417. free(client->connection_info.url);
  418. memset(&client->connection_info, 0, sizeof(connection_info_t));
  419. return ESP_OK;
  420. }
  421. static esp_err_t _clear_auth_data(esp_http_client_handle_t client)
  422. {
  423. if (client->auth_data == NULL) {
  424. return ESP_FAIL;
  425. }
  426. free(client->auth_data->method);
  427. free(client->auth_data->realm);
  428. free(client->auth_data->algorithm);
  429. free(client->auth_data->qop);
  430. free(client->auth_data->nonce);
  431. free(client->auth_data->opaque);
  432. memset(client->auth_data, 0, sizeof(esp_http_auth_data_t));
  433. return ESP_OK;
  434. }
  435. static esp_err_t esp_http_client_prepare(esp_http_client_handle_t client)
  436. {
  437. client->process_again = 0;
  438. client->response->data_process = 0;
  439. client->first_line_prepared = false;
  440. http_parser_init(client->parser, HTTP_RESPONSE);
  441. if (client->connection_info.username) {
  442. char *auth_response = NULL;
  443. if (client->connection_info.auth_type == HTTP_AUTH_TYPE_BASIC) {
  444. auth_response = http_auth_basic(client->connection_info.username, client->connection_info.password);
  445. #ifdef CONFIG_ESP_HTTP_CLIENT_ENABLE_DIGEST_AUTH
  446. } else if (client->connection_info.auth_type == HTTP_AUTH_TYPE_DIGEST && client->auth_data) {
  447. client->auth_data->uri = client->connection_info.path;
  448. client->auth_data->cnonce = ((uint64_t)esp_random() << 32) + esp_random();
  449. auth_response = http_auth_digest(client->connection_info.username, client->connection_info.password, client->auth_data);
  450. client->auth_data->nc ++;
  451. #endif
  452. }
  453. if (auth_response) {
  454. ESP_LOGD(TAG, "auth_response=%s", auth_response);
  455. esp_http_client_set_header(client, "Authorization", auth_response);
  456. free(auth_response);
  457. }
  458. }
  459. return ESP_OK;
  460. }
  461. static char *_get_host_header(char *host, int port)
  462. {
  463. int err = 0;
  464. char *host_name;
  465. if (port != DEFAULT_HTTP_PORT && port != DEFAULT_HTTPS_PORT) {
  466. err = asprintf(&host_name, "%s:%d", host, port);
  467. } else {
  468. err = asprintf(&host_name, "%s", host);
  469. }
  470. if (err == -1) {
  471. return NULL;
  472. }
  473. return host_name;
  474. }
  475. esp_http_client_handle_t esp_http_client_init(const esp_http_client_config_t *config)
  476. {
  477. esp_http_client_handle_t client;
  478. esp_err_t ret = ESP_OK;
  479. esp_transport_handle_t tcp = NULL;
  480. char *host_name;
  481. bool _success;
  482. _success = (
  483. (client = calloc(1, sizeof(esp_http_client_t))) &&
  484. (client->parser = calloc(1, sizeof(struct http_parser))) &&
  485. (client->parser_settings = calloc(1, sizeof(struct http_parser_settings))) &&
  486. (client->auth_data = calloc(1, sizeof(esp_http_auth_data_t))) &&
  487. (client->request = calloc(1, sizeof(esp_http_data_t))) &&
  488. (client->request->headers = http_header_init()) &&
  489. (client->request->buffer = calloc(1, sizeof(esp_http_buffer_t))) &&
  490. (client->response = calloc(1, sizeof(esp_http_data_t))) &&
  491. (client->response->headers = http_header_init()) &&
  492. (client->response->buffer = calloc(1, sizeof(esp_http_buffer_t)))
  493. );
  494. if (!_success) {
  495. ESP_LOGE(TAG, "Error allocate memory");
  496. goto error;
  497. }
  498. _success = (
  499. (client->transport_list = esp_transport_list_init()) &&
  500. (tcp = esp_transport_tcp_init()) &&
  501. (esp_transport_set_default_port(tcp, DEFAULT_HTTP_PORT) == ESP_OK) &&
  502. (esp_transport_list_add(client->transport_list, tcp, "http") == ESP_OK)
  503. );
  504. if (!_success) {
  505. ESP_LOGE(TAG, "Error initialize transport");
  506. goto error;
  507. }
  508. if (config->keep_alive_enable == true) {
  509. client->keep_alive_cfg.keep_alive_enable = true;
  510. client->keep_alive_cfg.keep_alive_idle = (config->keep_alive_idle == 0) ? DEFAULT_KEEP_ALIVE_IDLE : config->keep_alive_idle;
  511. client->keep_alive_cfg.keep_alive_interval = (config->keep_alive_interval == 0) ? DEFAULT_KEEP_ALIVE_INTERVAL : config->keep_alive_interval;
  512. client->keep_alive_cfg.keep_alive_count = (config->keep_alive_count == 0) ? DEFAULT_KEEP_ALIVE_COUNT : config->keep_alive_count;
  513. esp_transport_tcp_set_keep_alive(tcp, &client->keep_alive_cfg);
  514. }
  515. if (config->if_name) {
  516. client->if_name = calloc(1, sizeof(struct ifreq) + 1);
  517. ESP_GOTO_ON_FALSE(client->if_name, ESP_FAIL, error, TAG, "Memory exhausted");
  518. memcpy(client->if_name, config->if_name, sizeof(struct ifreq));
  519. esp_transport_tcp_set_interface_name(tcp, client->if_name);
  520. }
  521. #ifdef CONFIG_ESP_HTTP_CLIENT_ENABLE_HTTPS
  522. esp_transport_handle_t ssl = NULL;
  523. _success = (
  524. (ssl = esp_transport_ssl_init()) &&
  525. (esp_transport_set_default_port(ssl, DEFAULT_HTTPS_PORT) == ESP_OK) &&
  526. (esp_transport_list_add(client->transport_list, ssl, "https") == ESP_OK)
  527. );
  528. if (!_success) {
  529. ESP_LOGE(TAG, "Error initialize SSL Transport");
  530. goto error;
  531. }
  532. if (config->crt_bundle_attach != NULL) {
  533. #ifdef CONFIG_MBEDTLS_CERTIFICATE_BUNDLE
  534. esp_transport_ssl_crt_bundle_attach(ssl, config->crt_bundle_attach);
  535. #else //CONFIG_MBEDTLS_CERTIFICATE_BUNDLE
  536. ESP_LOGE(TAG, "use_crt_bundle configured but not enabled in menuconfig: Please enable MBEDTLS_CERTIFICATE_BUNDLE option");
  537. #endif
  538. } else if (config->use_global_ca_store == true) {
  539. esp_transport_ssl_enable_global_ca_store(ssl);
  540. } else if (config->cert_pem) {
  541. if (!config->cert_len) {
  542. esp_transport_ssl_set_cert_data(ssl, config->cert_pem, strlen(config->cert_pem));
  543. } else {
  544. esp_transport_ssl_set_cert_data_der(ssl, config->cert_pem, config->cert_len);
  545. }
  546. }
  547. if (config->client_cert_pem) {
  548. if (!config->client_cert_len) {
  549. esp_transport_ssl_set_client_cert_data(ssl, config->client_cert_pem, strlen(config->client_cert_pem));
  550. } else {
  551. esp_transport_ssl_set_client_cert_data_der(ssl, config->client_cert_pem, config->client_cert_len);
  552. }
  553. }
  554. if (config->client_key_pem) {
  555. if (!config->client_key_len) {
  556. esp_transport_ssl_set_client_key_data(ssl, config->client_key_pem, strlen(config->client_key_pem));
  557. } else {
  558. esp_transport_ssl_set_client_key_data_der(ssl, config->client_key_pem, config->client_key_len);
  559. }
  560. }
  561. if (config->client_key_password && config->client_key_password_len > 0) {
  562. esp_transport_ssl_set_client_key_password(ssl, config->client_key_password, config->client_key_password_len);
  563. }
  564. if (config->skip_cert_common_name_check) {
  565. esp_transport_ssl_skip_common_name_check(ssl);
  566. }
  567. #endif
  568. if (_set_config(client, config) != ESP_OK) {
  569. ESP_LOGE(TAG, "Error set configurations");
  570. goto error;
  571. }
  572. _success = (
  573. (client->request->buffer->data = malloc(client->buffer_size_tx)) &&
  574. (client->response->buffer->data = malloc(client->buffer_size_rx))
  575. );
  576. if (!_success) {
  577. ESP_LOGE(TAG, "Allocation failed");
  578. goto error;
  579. }
  580. const char *user_agent = config->user_agent == NULL ? DEFAULT_HTTP_USER_AGENT : config->user_agent;
  581. if (config->host != NULL && config->path != NULL) {
  582. host_name = _get_host_header(client->connection_info.host, client->connection_info.port);
  583. if (host_name == NULL) {
  584. ESP_LOGE(TAG, "Failed to allocate memory for host header");
  585. goto error;
  586. }
  587. _success = (
  588. (esp_http_client_set_header(client, "User-Agent", user_agent) == ESP_OK) &&
  589. (esp_http_client_set_header(client, "Host", host_name) == ESP_OK)
  590. );
  591. free(host_name);
  592. if (!_success) {
  593. ESP_LOGE(TAG, "Error while setting default configurations");
  594. goto error;
  595. }
  596. } else if (config->url != NULL) {
  597. if (esp_http_client_set_url(client, config->url) != ESP_OK) {
  598. ESP_LOGE(TAG, "Failed to set URL");
  599. goto error;
  600. }
  601. host_name = _get_host_header(client->connection_info.host, client->connection_info.port);
  602. if (host_name == NULL) {
  603. ESP_LOGE(TAG, "Failed to allocate memory for host header");
  604. goto error;
  605. }
  606. _success = (
  607. (esp_http_client_set_header(client, "User-Agent", user_agent) == ESP_OK) &&
  608. (esp_http_client_set_header(client, "Host", host_name) == ESP_OK)
  609. );
  610. free(host_name);
  611. if (!_success) {
  612. ESP_LOGE(TAG, "Error while setting default configurations");
  613. goto error;
  614. }
  615. } else {
  616. ESP_LOGE(TAG, "config should have either URL or host & path");
  617. goto error;
  618. }
  619. client->parser_settings->on_message_begin = http_on_message_begin;
  620. client->parser_settings->on_url = http_on_url;
  621. client->parser_settings->on_status = http_on_status;
  622. client->parser_settings->on_header_field = http_on_header_field;
  623. client->parser_settings->on_header_value = http_on_header_value;
  624. client->parser_settings->on_headers_complete = http_on_headers_complete;
  625. client->parser_settings->on_body = http_on_body;
  626. client->parser_settings->on_message_complete = http_on_message_complete;
  627. client->parser_settings->on_chunk_complete = http_on_chunk_complete;
  628. client->parser_settings->on_chunk_header = http_on_chunk_header;
  629. client->parser->data = client;
  630. client->event.client = client;
  631. client->state = HTTP_STATE_INIT;
  632. if (ret == ESP_OK) {
  633. return client;
  634. }
  635. error:
  636. esp_http_client_cleanup(client);
  637. return NULL;
  638. }
  639. esp_err_t esp_http_client_cleanup(esp_http_client_handle_t client)
  640. {
  641. if (client == NULL) {
  642. return ESP_FAIL;
  643. }
  644. esp_http_client_close(client);
  645. if (client->transport_list) {
  646. esp_transport_list_destroy(client->transport_list);
  647. }
  648. if (client->request) {
  649. http_header_destroy(client->request->headers);
  650. if (client->request->buffer) {
  651. free(client->request->buffer->data);
  652. }
  653. free(client->request->buffer);
  654. free(client->request);
  655. }
  656. if (client->response) {
  657. http_header_destroy(client->response->headers);
  658. if (client->response->buffer) {
  659. free(client->response->buffer->data);
  660. }
  661. free(client->response->buffer);
  662. free(client->response);
  663. }
  664. if (client->if_name) {
  665. free(client->if_name);
  666. }
  667. free(client->parser);
  668. free(client->parser_settings);
  669. _clear_connection_info(client);
  670. _clear_auth_data(client);
  671. free(client->auth_data);
  672. free(client->current_header_key);
  673. free(client->location);
  674. free(client->auth_header);
  675. free(client);
  676. return ESP_OK;
  677. }
  678. esp_err_t esp_http_client_set_redirection(esp_http_client_handle_t client)
  679. {
  680. if (client == NULL) {
  681. return ESP_ERR_INVALID_ARG;
  682. }
  683. if (client->location == NULL) {
  684. return ESP_ERR_INVALID_ARG;
  685. }
  686. ESP_LOGD(TAG, "Redirect to %s", client->location);
  687. return esp_http_client_set_url(client, client->location);
  688. }
  689. static esp_err_t esp_http_check_response(esp_http_client_handle_t client)
  690. {
  691. if (client->response->status_code >= HttpStatus_Ok && client->response->status_code < HttpStatus_MultipleChoices) {
  692. return ESP_OK;
  693. }
  694. if (client->redirect_counter >= client->max_redirection_count || client->disable_auto_redirect) {
  695. ESP_LOGE(TAG, "Error, reach max_redirection_count count=%d", client->redirect_counter);
  696. return ESP_ERR_HTTP_MAX_REDIRECT;
  697. }
  698. switch (client->response->status_code) {
  699. case HttpStatus_MovedPermanently:
  700. case HttpStatus_Found:
  701. case HttpStatus_TemporaryRedirect:
  702. esp_http_client_set_redirection(client);
  703. client->redirect_counter ++;
  704. client->process_again = 1;
  705. break;
  706. case HttpStatus_Unauthorized:
  707. esp_http_client_add_auth(client);
  708. }
  709. return ESP_OK;
  710. }
  711. esp_err_t esp_http_client_set_url(esp_http_client_handle_t client, const char *url)
  712. {
  713. esp_err_t ret = ESP_OK;
  714. char *old_host = NULL;
  715. struct http_parser_url purl;
  716. int old_port;
  717. if (client == NULL || url == NULL) {
  718. ESP_LOGE(TAG, "client or url must not NULL");
  719. return ESP_ERR_INVALID_ARG;
  720. }
  721. http_parser_url_init(&purl);
  722. int parser_status = http_parser_parse_url(url, strlen(url), 0, &purl);
  723. if (parser_status != 0) {
  724. ESP_LOGE(TAG, "Error parse url %s", url);
  725. return ESP_ERR_INVALID_ARG;
  726. }
  727. if (client->connection_info.host) {
  728. old_host = strdup(client->connection_info.host);
  729. }
  730. old_port = client->connection_info.port;
  731. if (purl.field_data[UF_HOST].len) {
  732. http_utils_assign_string(&client->connection_info.host, url + purl.field_data[UF_HOST].off, purl.field_data[UF_HOST].len);
  733. ESP_GOTO_ON_FALSE(client->connection_info.host, ESP_ERR_NO_MEM, error, TAG, "Memory exhausted");
  734. }
  735. // Close the connection if host was changed
  736. if (old_host && client->connection_info.host
  737. && strcasecmp(old_host, (const void *)client->connection_info.host) != 0) {
  738. ESP_LOGD(TAG, "New host assign = %s", client->connection_info.host);
  739. if (esp_http_client_set_header(client, "Host", client->connection_info.host) != ESP_OK) {
  740. free(old_host);
  741. return ESP_ERR_NO_MEM;
  742. }
  743. esp_http_client_close(client);
  744. }
  745. if (old_host) {
  746. free(old_host);
  747. old_host = NULL;
  748. }
  749. if (purl.field_data[UF_SCHEMA].len) {
  750. http_utils_assign_string(&client->connection_info.scheme, url + purl.field_data[UF_SCHEMA].off, purl.field_data[UF_SCHEMA].len);
  751. ESP_RETURN_ON_FALSE(client->connection_info.scheme, ESP_ERR_NO_MEM, TAG, "Memory exhausted");
  752. if (strcasecmp(client->connection_info.scheme, "http") == 0) {
  753. client->connection_info.port = DEFAULT_HTTP_PORT;
  754. } else if (strcasecmp(client->connection_info.scheme, "https") == 0) {
  755. client->connection_info.port = DEFAULT_HTTPS_PORT;
  756. }
  757. }
  758. if (purl.field_data[UF_PORT].len) {
  759. client->connection_info.port = strtol((const char*)(url + purl.field_data[UF_PORT].off), NULL, 10);
  760. }
  761. if (old_port != client->connection_info.port) {
  762. esp_http_client_close(client);
  763. }
  764. if (purl.field_data[UF_USERINFO].len) {
  765. char *user_info = NULL;
  766. http_utils_assign_string(&user_info, url + purl.field_data[UF_USERINFO].off, purl.field_data[UF_USERINFO].len);
  767. if (user_info) {
  768. char *username = user_info;
  769. char *password = strchr(user_info, ':');
  770. if (password) {
  771. *password = 0;
  772. password ++;
  773. http_utils_assign_string(&client->connection_info.password, password, -1);
  774. ESP_RETURN_ON_FALSE(client->connection_info.password, ESP_ERR_NO_MEM, TAG, "Memory exhausted");
  775. }
  776. http_utils_assign_string(&client->connection_info.username, username, -1);
  777. ESP_RETURN_ON_FALSE(client->connection_info.username, ESP_ERR_NO_MEM, TAG, "Memory exhausted");
  778. free(user_info);
  779. } else {
  780. return ESP_ERR_NO_MEM;
  781. }
  782. }
  783. //Reset path and query if there are no information
  784. if (purl.field_data[UF_PATH].len) {
  785. http_utils_assign_string(&client->connection_info.path, url + purl.field_data[UF_PATH].off, purl.field_data[UF_PATH].len);
  786. } else {
  787. http_utils_assign_string(&client->connection_info.path, "/", -1);
  788. }
  789. ESP_RETURN_ON_FALSE(client->connection_info.path, ESP_ERR_NO_MEM, TAG, "Memory exhausted");
  790. if (purl.field_data[UF_QUERY].len) {
  791. http_utils_assign_string(&client->connection_info.query, url + purl.field_data[UF_QUERY].off, purl.field_data[UF_QUERY].len);
  792. ESP_RETURN_ON_FALSE(client->connection_info.query, ESP_ERR_NO_MEM, TAG, "Memory exhausted");
  793. } else if (client->connection_info.query) {
  794. free(client->connection_info.query);
  795. client->connection_info.query = NULL;
  796. }
  797. return ret;
  798. error:
  799. free(old_host);
  800. return ret;
  801. }
  802. esp_err_t esp_http_client_set_method(esp_http_client_handle_t client, esp_http_client_method_t method)
  803. {
  804. client->connection_info.method = method;
  805. return ESP_OK;
  806. }
  807. esp_err_t esp_http_client_set_timeout_ms(esp_http_client_handle_t client, int timeout_ms)
  808. {
  809. if (client == NULL) {
  810. return ESP_ERR_INVALID_ARG;
  811. }
  812. client->timeout_ms = timeout_ms;
  813. return ESP_OK;
  814. }
  815. static int esp_http_client_get_data(esp_http_client_handle_t client)
  816. {
  817. if (client->state < HTTP_STATE_RES_COMPLETE_HEADER) {
  818. return ESP_FAIL;
  819. }
  820. if (client->connection_info.method == HTTP_METHOD_HEAD) {
  821. return 0;
  822. }
  823. esp_http_buffer_t *res_buffer = client->response->buffer;
  824. ESP_LOGD(TAG, "data_process=%lld, content_length=%lld", client->response->data_process, client->response->content_length);
  825. int rlen = esp_transport_read(client->transport, res_buffer->data, client->buffer_size_rx, client->timeout_ms);
  826. if (rlen >= 0) {
  827. http_parser_execute(client->parser, client->parser_settings, res_buffer->data, rlen);
  828. }
  829. return rlen;
  830. }
  831. bool esp_http_client_is_complete_data_received(esp_http_client_handle_t client)
  832. {
  833. if (client->response->is_chunked) {
  834. if (!client->is_chunk_complete) {
  835. ESP_LOGD(TAG, "Chunks were not completely read");
  836. return false;
  837. }
  838. } else {
  839. if (client->response->data_process != client->response->content_length) {
  840. ESP_LOGD(TAG, "Data processed %lld != Data specified in content length %lld", client->response->data_process, client->response->content_length);
  841. return false;
  842. }
  843. }
  844. return true;
  845. }
  846. int esp_http_client_read(esp_http_client_handle_t client, char *buffer, int len)
  847. {
  848. esp_http_buffer_t *res_buffer = client->response->buffer;
  849. int rlen = ESP_FAIL, ridx = 0;
  850. if (res_buffer->raw_len) {
  851. int remain_len = client->response->buffer->raw_len;
  852. if (remain_len > len) {
  853. remain_len = len;
  854. }
  855. memcpy(buffer, res_buffer->raw_data, remain_len);
  856. res_buffer->raw_len -= remain_len;
  857. res_buffer->raw_data += remain_len;
  858. ridx = remain_len;
  859. }
  860. int need_read = len - ridx;
  861. bool is_data_remain = true;
  862. while (need_read > 0 && is_data_remain) {
  863. if (client->response->is_chunked) {
  864. is_data_remain = !client->is_chunk_complete;
  865. } else {
  866. is_data_remain = client->response->data_process < client->response->content_length;
  867. }
  868. ESP_LOGD(TAG, "is_data_remain=%d, is_chunked=%d, content_length=%lld", is_data_remain, client->response->is_chunked, client->response->content_length);
  869. if (!is_data_remain) {
  870. break;
  871. }
  872. int byte_to_read = need_read;
  873. if (byte_to_read > client->buffer_size_rx) {
  874. byte_to_read = client->buffer_size_rx;
  875. }
  876. errno = 0;
  877. rlen = esp_transport_read(client->transport, res_buffer->data, byte_to_read, client->timeout_ms);
  878. ESP_LOGD(TAG, "need_read=%d, byte_to_read=%d, rlen=%d, ridx=%d", need_read, byte_to_read, rlen, ridx);
  879. if (rlen <= 0) {
  880. if (errno != 0) {
  881. esp_log_level_t sev = ESP_LOG_WARN;
  882. /* On connection close from server, recv should ideally return 0 but we have error conversion
  883. * in `tcp_transport` SSL layer which translates it `-1` and hence below additional checks */
  884. if (rlen == -1 && errno == ENOTCONN && client->response->is_chunked) {
  885. /* Explicit call to parser for invoking `message_complete` callback */
  886. http_parser_execute(client->parser, client->parser_settings, res_buffer->data, 0);
  887. /* ...and lowering the message severity, as closed connection from server side is expected in chunked transport */
  888. sev = ESP_LOG_DEBUG;
  889. }
  890. ESP_LOG_LEVEL(sev, TAG, "esp_transport_read returned:%d and errno:%d ", rlen, errno);
  891. }
  892. #ifdef CONFIG_ESP_HTTP_CLIENT_ENABLE_HTTPS
  893. if (rlen == ESP_TLS_ERR_SSL_WANT_READ || errno == EAGAIN) {
  894. #else
  895. if (errno == EAGAIN) {
  896. #endif
  897. ESP_LOGD(TAG, "Received EAGAIN! rlen = %d, errno %d", rlen, errno);
  898. return ridx;
  899. }
  900. if (rlen < 0 && ridx == 0 && !esp_http_client_is_complete_data_received(client)) {
  901. http_dispatch_event(client, HTTP_EVENT_ERROR, esp_transport_get_error_handle(client->transport), 0);
  902. return ESP_FAIL;
  903. }
  904. return ridx;
  905. }
  906. res_buffer->output_ptr = buffer + ridx;
  907. http_parser_execute(client->parser, client->parser_settings, res_buffer->data, rlen);
  908. ridx += res_buffer->raw_len;
  909. need_read -= res_buffer->raw_len;
  910. res_buffer->raw_len = 0; //clear
  911. res_buffer->output_ptr = NULL;
  912. }
  913. return ridx;
  914. }
  915. esp_err_t esp_http_client_perform(esp_http_client_handle_t client)
  916. {
  917. esp_err_t err;
  918. do {
  919. if (client->process_again) {
  920. esp_http_client_prepare(client);
  921. }
  922. switch (client->state) {
  923. /* In case of blocking esp_http_client_perform(), the following states will fall through one after the after;
  924. in case of non-blocking esp_http_client_perform(), if there is an error condition, like EINPROGRESS or EAGAIN,
  925. then the esp_http_client_perform() API will return ESP_ERR_HTTP_EAGAIN error. The user may call
  926. esp_http_client_perform API again, and for this reason, we maintain the states */
  927. case HTTP_STATE_INIT:
  928. if ((err = esp_http_client_connect(client)) != ESP_OK) {
  929. if (client->is_async && err == ESP_ERR_HTTP_CONNECTING) {
  930. return ESP_ERR_HTTP_EAGAIN;
  931. }
  932. http_dispatch_event(client, HTTP_EVENT_ERROR, esp_transport_get_error_handle(client->transport), 0);
  933. return err;
  934. }
  935. /* falls through */
  936. case HTTP_STATE_CONNECTED:
  937. if ((err = esp_http_client_request_send(client, client->post_len)) != ESP_OK) {
  938. if (client->is_async && errno == EAGAIN) {
  939. return ESP_ERR_HTTP_EAGAIN;
  940. }
  941. http_dispatch_event(client, HTTP_EVENT_ERROR, esp_transport_get_error_handle(client->transport), 0);
  942. return err;
  943. }
  944. /* falls through */
  945. case HTTP_STATE_REQ_COMPLETE_HEADER:
  946. if ((err = esp_http_client_send_post_data(client)) != ESP_OK) {
  947. if (client->is_async && errno == EAGAIN) {
  948. return ESP_ERR_HTTP_EAGAIN;
  949. }
  950. http_dispatch_event(client, HTTP_EVENT_ERROR, esp_transport_get_error_handle(client->transport), 0);
  951. return err;
  952. }
  953. /* falls through */
  954. case HTTP_STATE_REQ_COMPLETE_DATA:
  955. if (esp_http_client_fetch_headers(client) < 0) {
  956. if (client->is_async && errno == EAGAIN) {
  957. return ESP_ERR_HTTP_EAGAIN;
  958. }
  959. if (esp_transport_get_errno(client->transport) == ENOTCONN) {
  960. ESP_LOGW(TAG, "Close connection due to FIN received");
  961. esp_http_client_close(client);
  962. http_dispatch_event(client, HTTP_EVENT_ERROR, esp_transport_get_error_handle(client->transport), 0);
  963. return ESP_ERR_HTTP_CONNECTION_CLOSED;
  964. }
  965. http_dispatch_event(client, HTTP_EVENT_ERROR, esp_transport_get_error_handle(client->transport), 0);
  966. return ESP_ERR_HTTP_FETCH_HEADER;
  967. }
  968. /* falls through */
  969. case HTTP_STATE_RES_COMPLETE_HEADER:
  970. if ((err = esp_http_check_response(client)) != ESP_OK) {
  971. ESP_LOGE(TAG, "Error response");
  972. http_dispatch_event(client, HTTP_EVENT_ERROR, esp_transport_get_error_handle(client->transport), 0);
  973. return err;
  974. }
  975. while (client->response->is_chunked && !client->is_chunk_complete) {
  976. if (esp_http_client_get_data(client) <= 0) {
  977. if (client->is_async && errno == EAGAIN) {
  978. return ESP_ERR_HTTP_EAGAIN;
  979. }
  980. ESP_LOGD(TAG, "Read finish or server requests close");
  981. break;
  982. }
  983. }
  984. while (client->response->data_process < client->response->content_length) {
  985. if (esp_http_client_get_data(client) <= 0) {
  986. if (client->is_async && errno == EAGAIN) {
  987. return ESP_ERR_HTTP_EAGAIN;
  988. }
  989. ESP_LOGD(TAG, "Read finish or server requests close");
  990. break;
  991. }
  992. }
  993. http_dispatch_event(client, HTTP_EVENT_ON_FINISH, NULL, 0);
  994. client->response->buffer->raw_len = 0;
  995. if (!http_should_keep_alive(client->parser)) {
  996. ESP_LOGD(TAG, "Close connection");
  997. esp_http_client_close(client);
  998. } else {
  999. if (client->state > HTTP_STATE_CONNECTED) {
  1000. client->state = HTTP_STATE_CONNECTED;
  1001. client->first_line_prepared = false;
  1002. }
  1003. }
  1004. break;
  1005. default:
  1006. break;
  1007. }
  1008. } while (client->process_again);
  1009. return ESP_OK;
  1010. }
  1011. int64_t esp_http_client_fetch_headers(esp_http_client_handle_t client)
  1012. {
  1013. if (client->state < HTTP_STATE_REQ_COMPLETE_HEADER) {
  1014. return ESP_FAIL;
  1015. }
  1016. client->state = HTTP_STATE_REQ_COMPLETE_DATA;
  1017. esp_http_buffer_t *buffer = client->response->buffer;
  1018. client->response->status_code = -1;
  1019. while (client->state < HTTP_STATE_RES_COMPLETE_HEADER) {
  1020. buffer->len = esp_transport_read(client->transport, buffer->data, client->buffer_size_rx, client->timeout_ms);
  1021. if (buffer->len <= 0) {
  1022. return ESP_FAIL;
  1023. }
  1024. http_parser_execute(client->parser, client->parser_settings, buffer->data, buffer->len);
  1025. }
  1026. ESP_LOGD(TAG, "content_length = %lld", client->response->content_length);
  1027. if (client->response->content_length <= 0) {
  1028. client->response->is_chunked = true;
  1029. return 0;
  1030. }
  1031. return client->response->content_length;
  1032. }
  1033. static esp_err_t esp_http_client_connect(esp_http_client_handle_t client)
  1034. {
  1035. esp_err_t err;
  1036. if (client->state == HTTP_STATE_UNINIT) {
  1037. ESP_LOGE(TAG, "Client has not been initialized");
  1038. return ESP_ERR_INVALID_STATE;
  1039. }
  1040. if ((err = esp_http_client_prepare(client)) != ESP_OK) {
  1041. ESP_LOGE(TAG, "Failed to initialize request data");
  1042. esp_http_client_close(client);
  1043. return err;
  1044. }
  1045. if (client->state < HTTP_STATE_CONNECTED) {
  1046. ESP_LOGD(TAG, "Begin connect to: %s://%s:%d", client->connection_info.scheme, client->connection_info.host, client->connection_info.port);
  1047. client->transport = esp_transport_list_get_transport(client->transport_list, client->connection_info.scheme);
  1048. if (client->transport == NULL) {
  1049. ESP_LOGE(TAG, "No transport found");
  1050. #ifndef CONFIG_ESP_HTTP_CLIENT_ENABLE_HTTPS
  1051. if (strcasecmp(client->connection_info.scheme, "https") == 0) {
  1052. ESP_LOGE(TAG, "Please enable HTTPS at menuconfig to allow requesting via https");
  1053. }
  1054. #endif
  1055. return ESP_ERR_HTTP_INVALID_TRANSPORT;
  1056. }
  1057. if (!client->is_async) {
  1058. if (esp_transport_connect(client->transport, client->connection_info.host, client->connection_info.port, client->timeout_ms) < 0) {
  1059. ESP_LOGE(TAG, "Connection failed, sock < 0");
  1060. return ESP_ERR_HTTP_CONNECT;
  1061. }
  1062. } else {
  1063. int ret = esp_transport_connect_async(client->transport, client->connection_info.host, client->connection_info.port, client->timeout_ms);
  1064. if (ret == ASYNC_TRANS_CONNECT_FAIL) {
  1065. ESP_LOGE(TAG, "Connection failed");
  1066. if (strcasecmp(client->connection_info.scheme, "http") == 0) {
  1067. ESP_LOGE(TAG, "Asynchronous mode doesn't work for HTTP based connection");
  1068. return ESP_ERR_INVALID_ARG;
  1069. }
  1070. return ESP_ERR_HTTP_CONNECT;
  1071. } else if (ret == ASYNC_TRANS_CONNECTING) {
  1072. ESP_LOGD(TAG, "Connection not yet established");
  1073. return ESP_ERR_HTTP_CONNECTING;
  1074. }
  1075. }
  1076. client->state = HTTP_STATE_CONNECTED;
  1077. http_dispatch_event(client, HTTP_EVENT_ON_CONNECTED, NULL, 0);
  1078. }
  1079. return ESP_OK;
  1080. }
  1081. static int http_client_prepare_first_line(esp_http_client_handle_t client, int write_len)
  1082. {
  1083. if (write_len >= 0) {
  1084. http_header_set_format(client->request->headers, "Content-Length", "%d", write_len);
  1085. } else {
  1086. esp_http_client_set_header(client, "Transfer-Encoding", "chunked");
  1087. }
  1088. const char *method = HTTP_METHOD_MAPPING[client->connection_info.method];
  1089. int first_line_len = snprintf(client->request->buffer->data,
  1090. client->buffer_size_tx, "%s %s",
  1091. method,
  1092. client->connection_info.path);
  1093. if (first_line_len >= client->buffer_size_tx) {
  1094. ESP_LOGE(TAG, "Out of buffer");
  1095. return -1;
  1096. }
  1097. if (client->connection_info.query) {
  1098. first_line_len += snprintf(client->request->buffer->data + first_line_len,
  1099. client->buffer_size_tx - first_line_len, "?%s", client->connection_info.query);
  1100. if (first_line_len >= client->buffer_size_tx) {
  1101. ESP_LOGE(TAG, "Out of buffer");
  1102. return -1;
  1103. }
  1104. }
  1105. first_line_len += snprintf(client->request->buffer->data + first_line_len,
  1106. client->buffer_size_tx - first_line_len, " %s\r\n", DEFAULT_HTTP_PROTOCOL);
  1107. if (first_line_len >= client->buffer_size_tx) {
  1108. ESP_LOGE(TAG, "Out of buffer");
  1109. return -1;
  1110. }
  1111. return first_line_len;
  1112. }
  1113. static esp_err_t esp_http_client_request_send(esp_http_client_handle_t client, int write_len)
  1114. {
  1115. int first_line_len = 0;
  1116. if (!client->first_line_prepared) {
  1117. if ((first_line_len = http_client_prepare_first_line(client, write_len)) < 0) {
  1118. return first_line_len;
  1119. }
  1120. client->first_line_prepared = true;
  1121. client->header_index = 0;
  1122. client->data_written_index = 0;
  1123. client->data_write_left = 0;
  1124. }
  1125. if (client->data_write_left > 0) {
  1126. /* sending leftover data from previous call to esp_http_client_request_send() API */
  1127. int wret = 0;
  1128. if (((wret = esp_http_client_write(client, client->request->buffer->data + client->data_written_index, client->data_write_left)) < 0)) {
  1129. ESP_LOGE(TAG, "Error write request");
  1130. return ESP_ERR_HTTP_WRITE_DATA;
  1131. }
  1132. client->data_write_left -= wret;
  1133. client->data_written_index += wret;
  1134. if (client->is_async && client->data_write_left > 0) {
  1135. return ESP_ERR_HTTP_WRITE_DATA; /* In case of EAGAIN error, we return ESP_ERR_HTTP_WRITE_DATA,
  1136. and the handling of EAGAIN should be done in the higher level APIs. */
  1137. }
  1138. }
  1139. int wlen = client->buffer_size_tx - first_line_len;
  1140. while ((client->header_index = http_header_generate_string(client->request->headers, client->header_index, client->request->buffer->data + first_line_len, &wlen))) {
  1141. if (wlen <= 0) {
  1142. break;
  1143. }
  1144. if (first_line_len) {
  1145. wlen += first_line_len;
  1146. first_line_len = 0;
  1147. }
  1148. client->request->buffer->data[wlen] = 0;
  1149. ESP_LOGD(TAG, "Write header[%d]: %s", client->header_index, client->request->buffer->data);
  1150. client->data_write_left = wlen;
  1151. client->data_written_index = 0;
  1152. while (client->data_write_left > 0) {
  1153. int wret = esp_transport_write(client->transport, client->request->buffer->data + client->data_written_index, client->data_write_left, client->timeout_ms);
  1154. if (wret <= 0) {
  1155. ESP_LOGE(TAG, "Error write request");
  1156. esp_http_client_close(client);
  1157. return ESP_ERR_HTTP_WRITE_DATA;
  1158. }
  1159. client->data_write_left -= wret;
  1160. client->data_written_index += wret;
  1161. }
  1162. wlen = client->buffer_size_tx;
  1163. }
  1164. client->data_written_index = 0;
  1165. client->data_write_left = client->post_len;
  1166. http_dispatch_event(client, HTTP_EVENT_HEADERS_SENT, NULL, 0);
  1167. client->state = HTTP_STATE_REQ_COMPLETE_HEADER;
  1168. return ESP_OK;
  1169. }
  1170. static esp_err_t esp_http_client_send_post_data(esp_http_client_handle_t client)
  1171. {
  1172. if (client->state != HTTP_STATE_REQ_COMPLETE_HEADER) {
  1173. ESP_LOGE(TAG, "Invalid state");
  1174. return ESP_ERR_INVALID_STATE;
  1175. }
  1176. if (!(client->post_data && client->post_len)) {
  1177. goto success;
  1178. }
  1179. int wret = esp_http_client_write(client, client->post_data + client->data_written_index, client->data_write_left);
  1180. if (wret < 0) {
  1181. return wret;
  1182. }
  1183. client->data_write_left -= wret;
  1184. client->data_written_index += wret;
  1185. if (client->data_write_left <= 0) {
  1186. goto success;
  1187. } else {
  1188. return ESP_ERR_HTTP_WRITE_DATA;
  1189. }
  1190. success:
  1191. client->state = HTTP_STATE_REQ_COMPLETE_DATA;
  1192. return ESP_OK;
  1193. }
  1194. esp_err_t esp_http_client_open(esp_http_client_handle_t client, int write_len)
  1195. {
  1196. client->post_len = write_len;
  1197. esp_err_t err;
  1198. if ((err = esp_http_client_connect(client)) != ESP_OK) {
  1199. http_dispatch_event(client, HTTP_EVENT_ERROR, esp_transport_get_error_handle(client->transport), 0);
  1200. return err;
  1201. }
  1202. if ((err = esp_http_client_request_send(client, write_len)) != ESP_OK) {
  1203. http_dispatch_event(client, HTTP_EVENT_ERROR, esp_transport_get_error_handle(client->transport), 0);
  1204. return err;
  1205. }
  1206. return ESP_OK;
  1207. }
  1208. int esp_http_client_write(esp_http_client_handle_t client, const char *buffer, int len)
  1209. {
  1210. if (client->state < HTTP_STATE_REQ_COMPLETE_HEADER) {
  1211. return ESP_FAIL;
  1212. }
  1213. int wlen = 0, widx = 0;
  1214. while (len > 0) {
  1215. wlen = esp_transport_write(client->transport, buffer + widx, len, client->timeout_ms);
  1216. /* client->async_block is initialised in case of non-blocking IO, and in this case we return how
  1217. much ever data was written by the esp_transport_write() API. */
  1218. if (client->is_async || wlen <= 0) {
  1219. return wlen;
  1220. }
  1221. widx += wlen;
  1222. len -= wlen;
  1223. }
  1224. return widx;
  1225. }
  1226. esp_err_t esp_http_client_close(esp_http_client_handle_t client)
  1227. {
  1228. if (client->state >= HTTP_STATE_INIT) {
  1229. http_dispatch_event(client, HTTP_EVENT_DISCONNECTED, esp_transport_get_error_handle(client->transport), 0);
  1230. client->state = HTTP_STATE_INIT;
  1231. return esp_transport_close(client->transport);
  1232. }
  1233. return ESP_OK;
  1234. }
  1235. esp_err_t esp_http_client_set_post_field(esp_http_client_handle_t client, const char *data, int len)
  1236. {
  1237. esp_err_t err = ESP_OK;
  1238. client->post_data = (char *)data;
  1239. client->post_len = len;
  1240. ESP_LOGD(TAG, "set post file length = %d", len);
  1241. if (client->post_data) {
  1242. char *value = NULL;
  1243. if ((err = esp_http_client_get_header(client, "Content-Type", &value)) != ESP_OK) {
  1244. return err;
  1245. }
  1246. if (value == NULL) {
  1247. err = esp_http_client_set_header(client, "Content-Type", "application/x-www-form-urlencoded");
  1248. }
  1249. } else {
  1250. client->post_len = 0;
  1251. err = esp_http_client_set_header(client, "Content-Type", NULL);
  1252. }
  1253. return err;
  1254. }
  1255. int esp_http_client_get_post_field(esp_http_client_handle_t client, char **data)
  1256. {
  1257. if (client->post_data) {
  1258. *data = client->post_data;
  1259. return client->post_len;
  1260. }
  1261. return 0;
  1262. }
  1263. int esp_http_client_get_status_code(esp_http_client_handle_t client)
  1264. {
  1265. return client->response->status_code;
  1266. }
  1267. int64_t esp_http_client_get_content_length(esp_http_client_handle_t client)
  1268. {
  1269. return client->response->content_length;
  1270. }
  1271. bool esp_http_client_is_chunked_response(esp_http_client_handle_t client)
  1272. {
  1273. return client->response->is_chunked;
  1274. }
  1275. esp_http_client_transport_t esp_http_client_get_transport_type(esp_http_client_handle_t client)
  1276. {
  1277. if (!strcasecmp(client->connection_info.scheme, "https") ) {
  1278. return HTTP_TRANSPORT_OVER_SSL;
  1279. } else if (!strcasecmp(client->connection_info.scheme, "http")) {
  1280. return HTTP_TRANSPORT_OVER_TCP;
  1281. } else {
  1282. return HTTP_TRANSPORT_UNKNOWN;
  1283. }
  1284. }
  1285. void esp_http_client_add_auth(esp_http_client_handle_t client)
  1286. {
  1287. if (client == NULL) {
  1288. return;
  1289. }
  1290. if (client->state != HTTP_STATE_RES_COMPLETE_HEADER) {
  1291. return;
  1292. }
  1293. if (client->redirect_counter >= client->max_authorization_retries) {
  1294. ESP_LOGE(TAG, "Error, reached max_authorization_retries count=%d", client->redirect_counter);
  1295. return;
  1296. }
  1297. char *auth_header = client->auth_header;
  1298. if (auth_header) {
  1299. http_utils_trim_whitespace(&auth_header);
  1300. ESP_LOGD(TAG, "UNAUTHORIZED: %s", auth_header);
  1301. client->redirect_counter++;
  1302. #ifdef CONFIG_ESP_HTTP_CLIENT_ENABLE_DIGEST_AUTH
  1303. if (http_utils_str_starts_with(auth_header, "Digest") == 0) {
  1304. ESP_LOGD(TAG, "type = Digest");
  1305. client->connection_info.auth_type = HTTP_AUTH_TYPE_DIGEST;
  1306. } else {
  1307. #endif
  1308. #ifdef CONFIG_ESP_HTTP_CLIENT_ENABLE_BASIC_AUTH
  1309. if (http_utils_str_starts_with(auth_header, "Basic") == 0) {
  1310. ESP_LOGD(TAG, "type = Basic");
  1311. client->connection_info.auth_type = HTTP_AUTH_TYPE_BASIC;
  1312. } else {
  1313. #endif
  1314. client->connection_info.auth_type = HTTP_AUTH_TYPE_NONE;
  1315. ESP_LOGE(TAG, "This authentication method is not supported: %s", auth_header);
  1316. return;
  1317. #ifdef CONFIG_ESP_HTTP_CLIENT_ENABLE_BASIC_AUTH
  1318. }
  1319. #endif
  1320. #ifdef CONFIG_ESP_HTTP_CLIENT_ENABLE_DIGEST_AUTH
  1321. }
  1322. #endif
  1323. _clear_auth_data(client);
  1324. client->auth_data->method = strdup(HTTP_METHOD_MAPPING[client->connection_info.method]);
  1325. client->auth_data->nc = 1;
  1326. client->auth_data->realm = http_utils_get_string_between(auth_header, "realm=\"", "\"");
  1327. client->auth_data->algorithm = http_utils_get_string_between(auth_header, "algorithm=", ",");
  1328. if (client->auth_data->algorithm == NULL) {
  1329. client->auth_data->algorithm = strdup("MD5");
  1330. }
  1331. client->auth_data->qop = http_utils_get_string_between(auth_header, "qop=\"", "\"");
  1332. client->auth_data->nonce = http_utils_get_string_between(auth_header, "nonce=\"", "\"");
  1333. client->auth_data->opaque = http_utils_get_string_between(auth_header, "opaque=\"", "\"");
  1334. client->process_again = 1;
  1335. } else {
  1336. client->connection_info.auth_type = HTTP_AUTH_TYPE_NONE;
  1337. ESP_LOGW(TAG, "This request requires authentication, but does not provide header information for that");
  1338. }
  1339. }
  1340. int esp_http_client_read_response(esp_http_client_handle_t client, char *buffer, int len)
  1341. {
  1342. int read_len = 0;
  1343. while (read_len < len) {
  1344. int data_read = esp_http_client_read(client, buffer + read_len, len - read_len);
  1345. if (data_read <= 0) {
  1346. return read_len;
  1347. }
  1348. read_len += data_read;
  1349. }
  1350. return read_len;
  1351. }
  1352. esp_err_t esp_http_client_flush_response(esp_http_client_handle_t client, int *len)
  1353. {
  1354. if (client == NULL) {
  1355. ESP_LOGE(TAG, "client must not be NULL");
  1356. return ESP_ERR_INVALID_ARG;
  1357. }
  1358. int read_len = 0;
  1359. while (!esp_http_client_is_complete_data_received(client)) {
  1360. int data_read = esp_http_client_get_data(client);
  1361. if (data_read < 0) {
  1362. return ESP_FAIL;
  1363. }
  1364. read_len += data_read;
  1365. }
  1366. if (len) {
  1367. *len = read_len;
  1368. }
  1369. return ESP_OK;
  1370. }
  1371. esp_err_t esp_http_client_get_url(esp_http_client_handle_t client, char *url, const int len)
  1372. {
  1373. if (client == NULL || url == NULL) {
  1374. return ESP_ERR_INVALID_ARG;
  1375. }
  1376. if (client->connection_info.host && client->connection_info.scheme && client->connection_info.path) {
  1377. snprintf(url, len, "%s://%s%s", client->connection_info.scheme, client->connection_info.host, client->connection_info.path);
  1378. return ESP_OK;
  1379. } else {
  1380. ESP_LOGE(TAG, "Failed to get URL");
  1381. }
  1382. return ESP_FAIL;
  1383. }
  1384. esp_err_t esp_http_client_get_chunk_length(esp_http_client_handle_t client, int *len)
  1385. {
  1386. if (client == NULL || len == NULL) {
  1387. return ESP_ERR_INVALID_ARG;
  1388. }
  1389. if (esp_http_client_is_chunked_response(client)) {
  1390. *len = client->response->chunk_length;
  1391. } else {
  1392. ESP_LOGE(TAG, "Response is not chunked");
  1393. return ESP_FAIL;
  1394. }
  1395. return ESP_OK;
  1396. }