esp_http_client.c 61 KB

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