esp_http_client.c 54 KB

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