esp_http_client.c 57 KB

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