esp_http_client.c 52 KB

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