esp_http_client.c 57 KB

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