esp_http_client.c 59 KB

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