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