esp_http_client.c 61 KB

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