esp_tls.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673
  1. /*
  2. * SPDX-FileCopyrightText: 2019-2021 Espressif Systems (Shanghai) CO LTD
  3. *
  4. * SPDX-License-Identifier: Apache-2.0
  5. */
  6. #include <stdio.h>
  7. #include <string.h>
  8. #include <stdlib.h>
  9. #include <unistd.h>
  10. #include <sys/types.h>
  11. #include <sys/socket.h>
  12. #include <netdb.h>
  13. #include <http_parser.h>
  14. #include "esp_tls.h"
  15. #include "esp_tls_error_capture_internal.h"
  16. #include <errno.h>
  17. static const char *TAG = "esp-tls";
  18. #ifdef CONFIG_ESP_TLS_USING_MBEDTLS
  19. #include "esp_tls_mbedtls.h"
  20. #elif CONFIG_ESP_TLS_USING_WOLFSSL
  21. #include "esp_tls_wolfssl.h"
  22. #endif
  23. #ifdef ESP_PLATFORM
  24. #include <esp_log.h>
  25. #else
  26. #define ESP_LOGD(TAG, ...) //printf(__VA_ARGS__);
  27. #define ESP_LOGE(TAG, ...) printf(__VA_ARGS__);
  28. #endif
  29. #ifdef CONFIG_ESP_TLS_USING_MBEDTLS
  30. #define _esp_create_ssl_handle esp_create_mbedtls_handle
  31. #define _esp_tls_handshake esp_mbedtls_handshake
  32. #define _esp_tls_read esp_mbedtls_read
  33. #define _esp_tls_write esp_mbedtls_write
  34. #define _esp_tls_conn_delete esp_mbedtls_conn_delete
  35. #define _esp_tls_net_init esp_mbedtls_net_init
  36. #define _esp_tls_get_client_session esp_mbedtls_get_client_session
  37. #ifdef CONFIG_ESP_TLS_SERVER
  38. #define _esp_tls_server_session_create esp_mbedtls_server_session_create
  39. #define _esp_tls_server_session_delete esp_mbedtls_server_session_delete
  40. #define _esp_tls_server_session_ticket_ctx_init esp_mbedtls_server_session_ticket_ctx_init
  41. #define _esp_tls_server_session_ticket_ctx_free esp_mbedtls_server_session_ticket_ctx_free
  42. #endif /* CONFIG_ESP_TLS_SERVER */
  43. #define _esp_tls_get_bytes_avail esp_mbedtls_get_bytes_avail
  44. #define _esp_tls_init_global_ca_store esp_mbedtls_init_global_ca_store
  45. #define _esp_tls_set_global_ca_store esp_mbedtls_set_global_ca_store /*!< Callback function for setting global CA store data for TLS/SSL */
  46. #define _esp_tls_get_global_ca_store esp_mbedtls_get_global_ca_store
  47. #define _esp_tls_free_global_ca_store esp_mbedtls_free_global_ca_store /*!< Callback function for freeing global ca store for TLS/SSL */
  48. #elif CONFIG_ESP_TLS_USING_WOLFSSL /* CONFIG_ESP_TLS_USING_MBEDTLS */
  49. #define _esp_create_ssl_handle esp_create_wolfssl_handle
  50. #define _esp_tls_handshake esp_wolfssl_handshake
  51. #define _esp_tls_read esp_wolfssl_read
  52. #define _esp_tls_write esp_wolfssl_write
  53. #define _esp_tls_conn_delete esp_wolfssl_conn_delete
  54. #define _esp_tls_net_init esp_wolfssl_net_init
  55. #ifdef CONFIG_ESP_TLS_SERVER
  56. #define _esp_tls_server_session_create esp_wolfssl_server_session_create
  57. #define _esp_tls_server_session_delete esp_wolfssl_server_session_delete
  58. #endif /* CONFIG_ESP_TLS_SERVER */
  59. #define _esp_tls_get_bytes_avail esp_wolfssl_get_bytes_avail
  60. #define _esp_tls_init_global_ca_store esp_wolfssl_init_global_ca_store
  61. #define _esp_tls_set_global_ca_store esp_wolfssl_set_global_ca_store /*!< Callback function for setting global CA store data for TLS/SSL */
  62. #define _esp_tls_free_global_ca_store esp_wolfssl_free_global_ca_store /*!< Callback function for freeing global ca store for TLS/SSL */
  63. #else /* ESP_TLS_USING_WOLFSSL */
  64. #error "No TLS stack configured"
  65. #endif
  66. static esp_err_t create_ssl_handle(const char *hostname, size_t hostlen, const void *cfg, esp_tls_t *tls)
  67. {
  68. return _esp_create_ssl_handle(hostname, hostlen, cfg, tls);
  69. }
  70. static esp_err_t esp_tls_handshake(esp_tls_t *tls, const esp_tls_cfg_t *cfg)
  71. {
  72. return _esp_tls_handshake(tls, cfg);
  73. }
  74. static ssize_t tcp_read(esp_tls_t *tls, char *data, size_t datalen)
  75. {
  76. return recv(tls->sockfd, data, datalen, 0);
  77. }
  78. static ssize_t tcp_write(esp_tls_t *tls, const char *data, size_t datalen)
  79. {
  80. return send(tls->sockfd, data, datalen, 0);
  81. }
  82. /**
  83. * @brief Close the TLS connection and free any allocated resources.
  84. */
  85. void esp_tls_conn_delete(esp_tls_t *tls)
  86. {
  87. esp_tls_conn_destroy(tls);
  88. }
  89. int esp_tls_conn_destroy(esp_tls_t *tls)
  90. {
  91. if (tls != NULL) {
  92. int ret = 0;
  93. _esp_tls_conn_delete(tls);
  94. if (tls->sockfd >= 0) {
  95. ret = close(tls->sockfd);
  96. }
  97. esp_tls_internal_event_tracker_destroy(tls->error_handle);
  98. free(tls);
  99. return ret;
  100. }
  101. return -1; // invalid argument
  102. }
  103. esp_tls_t *esp_tls_init(void)
  104. {
  105. esp_tls_t *tls = (esp_tls_t *)calloc(1, sizeof(esp_tls_t));
  106. if (!tls) {
  107. return NULL;
  108. }
  109. tls->error_handle = esp_tls_internal_event_tracker_create();
  110. if (!tls->error_handle) {
  111. free(tls);
  112. return NULL;
  113. }
  114. _esp_tls_net_init(tls);
  115. tls->sockfd = -1;
  116. return tls;
  117. }
  118. static esp_err_t esp_tls_hostname_to_fd(const char *host, size_t hostlen, int port, struct sockaddr_storage *address, int* fd)
  119. {
  120. struct addrinfo *address_info;
  121. struct addrinfo hints;
  122. memset(&hints, 0, sizeof(hints));
  123. hints.ai_family = AF_UNSPEC;
  124. hints.ai_socktype = SOCK_STREAM;
  125. char *use_host = strndup(host, hostlen);
  126. if (!use_host) {
  127. return ESP_ERR_NO_MEM;
  128. }
  129. ESP_LOGD(TAG, "host:%s: strlen %lu", use_host, (unsigned long)hostlen);
  130. int res = getaddrinfo(use_host, NULL, &hints, &address_info);
  131. if (res != 0 || address_info == NULL) {
  132. ESP_LOGE(TAG, "couldn't get hostname for :%s: "
  133. "getaddrinfo() returns %d, addrinfo=%p", use_host, res, address_info);
  134. free(use_host);
  135. return ESP_ERR_ESP_TLS_CANNOT_RESOLVE_HOSTNAME;
  136. }
  137. free(use_host);
  138. *fd = socket(address_info->ai_family, address_info->ai_socktype, address_info->ai_protocol);
  139. if (*fd < 0) {
  140. ESP_LOGE(TAG, "Failed to create socket (family %d socktype %d protocol %d)", address_info->ai_family, address_info->ai_socktype, address_info->ai_protocol);
  141. freeaddrinfo(address_info);
  142. return ESP_ERR_ESP_TLS_CANNOT_CREATE_SOCKET;
  143. }
  144. if (address_info->ai_family == AF_INET) {
  145. struct sockaddr_in *p = (struct sockaddr_in *)address_info->ai_addr;
  146. p->sin_port = htons(port);
  147. ESP_LOGD(TAG, "[sock=%d] Resolved IPv4 address: %s", *fd, ipaddr_ntoa((const ip_addr_t*)&p->sin_addr.s_addr));
  148. memcpy(address, p, sizeof(struct sockaddr ));
  149. }
  150. #if CONFIG_LWIP_IPV6
  151. else if (address_info->ai_family == AF_INET6) {
  152. struct sockaddr_in6 *p = (struct sockaddr_in6 *)address_info->ai_addr;
  153. p->sin6_port = htons(port);
  154. p->sin6_family = AF_INET6;
  155. ESP_LOGD(TAG, "[sock=%d] Resolved IPv6 address: %s", *fd, ip6addr_ntoa((const ip6_addr_t*)&p->sin6_addr));
  156. memcpy(address, p, sizeof(struct sockaddr_in6 ));
  157. }
  158. #endif
  159. else {
  160. ESP_LOGE(TAG, "Unsupported protocol family %d", address_info->ai_family);
  161. close(*fd);
  162. freeaddrinfo(address_info);
  163. return ESP_ERR_ESP_TLS_UNSUPPORTED_PROTOCOL_FAMILY;
  164. }
  165. freeaddrinfo(address_info);
  166. return ESP_OK;
  167. }
  168. static void ms_to_timeval(int timeout_ms, struct timeval *tv)
  169. {
  170. tv->tv_sec = timeout_ms / 1000;
  171. tv->tv_usec = (timeout_ms % 1000) * 1000;
  172. }
  173. static esp_err_t esp_tls_set_socket_options(int fd, const esp_tls_cfg_t *cfg)
  174. {
  175. if (cfg) {
  176. if (cfg->timeout_ms >= 0) {
  177. struct timeval tv;
  178. ms_to_timeval(cfg->timeout_ms, &tv);
  179. if (setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv)) != 0) {
  180. ESP_LOGE(TAG, "Fail to setsockopt SO_RCVTIMEO");
  181. return ESP_ERR_ESP_TLS_SOCKET_SETOPT_FAILED;
  182. }
  183. if (setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv)) != 0) {
  184. ESP_LOGE(TAG, "Fail to setsockopt SO_SNDTIMEO");
  185. return ESP_ERR_ESP_TLS_SOCKET_SETOPT_FAILED;
  186. }
  187. }
  188. if (cfg->keep_alive_cfg && cfg->keep_alive_cfg->keep_alive_enable) {
  189. int keep_alive_enable = 1;
  190. int keep_alive_idle = cfg->keep_alive_cfg->keep_alive_idle;
  191. int keep_alive_interval = cfg->keep_alive_cfg->keep_alive_interval;
  192. int keep_alive_count = cfg->keep_alive_cfg->keep_alive_count;
  193. ESP_LOGD(TAG, "Enable TCP keep alive. idle: %d, interval: %d, count: %d", keep_alive_idle, keep_alive_interval, keep_alive_count);
  194. if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, &keep_alive_enable, sizeof(keep_alive_enable)) != 0) {
  195. ESP_LOGE(TAG, "Fail to setsockopt SO_KEEPALIVE");
  196. return ESP_ERR_ESP_TLS_SOCKET_SETOPT_FAILED;
  197. }
  198. if (setsockopt(fd, IPPROTO_TCP, TCP_KEEPIDLE, &keep_alive_idle, sizeof(keep_alive_idle)) != 0) {
  199. ESP_LOGE(TAG, "Fail to setsockopt TCP_KEEPIDLE");
  200. return ESP_ERR_ESP_TLS_SOCKET_SETOPT_FAILED;
  201. }
  202. if (setsockopt(fd, IPPROTO_TCP, TCP_KEEPINTVL, &keep_alive_interval, sizeof(keep_alive_interval)) != 0) {
  203. ESP_LOGE(TAG, "Fail to setsockopt TCP_KEEPINTVL");
  204. return ESP_ERR_ESP_TLS_SOCKET_SETOPT_FAILED;
  205. }
  206. if (setsockopt(fd, IPPROTO_TCP, TCP_KEEPCNT, &keep_alive_count, sizeof(keep_alive_count)) != 0) {
  207. ESP_LOGE(TAG, "Fail to setsockopt TCP_KEEPCNT");
  208. return ESP_ERR_ESP_TLS_SOCKET_SETOPT_FAILED;
  209. }
  210. }
  211. if (cfg->if_name) {
  212. if (cfg->if_name->ifr_name[0] != 0) {
  213. ESP_LOGD(TAG, "Bind [sock=%d] to interface %s", fd, cfg->if_name->ifr_name);
  214. if (setsockopt(fd, SOL_SOCKET, SO_BINDTODEVICE, cfg->if_name, sizeof(struct ifreq)) != 0) {
  215. ESP_LOGE(TAG, "Bind [sock=%d] to interface %s fail", fd, cfg->if_name->ifr_name);
  216. return ESP_ERR_ESP_TLS_SOCKET_SETOPT_FAILED;
  217. }
  218. }
  219. }
  220. }
  221. return ESP_OK;
  222. }
  223. static esp_err_t esp_tls_set_socket_non_blocking(int fd, bool non_blocking)
  224. {
  225. int flags;
  226. if ((flags = fcntl(fd, F_GETFL, NULL)) < 0) {
  227. ESP_LOGE(TAG, "[sock=%d] get file flags error: %s", fd, strerror(errno));
  228. return ESP_ERR_ESP_TLS_SOCKET_SETOPT_FAILED;
  229. }
  230. if (non_blocking) {
  231. flags |= O_NONBLOCK;
  232. } else {
  233. flags &= ~O_NONBLOCK;
  234. }
  235. if (fcntl(fd, F_SETFL, flags) < 0) {
  236. ESP_LOGE(TAG, "[sock=%d] set blocking/nonblocking error: %s", fd, strerror(errno));
  237. return ESP_ERR_ESP_TLS_SOCKET_SETOPT_FAILED;
  238. }
  239. return ESP_OK;
  240. }
  241. static inline esp_err_t tcp_connect(const char *host, int hostlen, int port, const esp_tls_cfg_t *cfg, esp_tls_error_handle_t error_handle, int *sockfd)
  242. {
  243. struct sockaddr_storage address;
  244. int fd;
  245. esp_err_t ret = esp_tls_hostname_to_fd(host, hostlen, port, &address, &fd);
  246. if (ret != ESP_OK) {
  247. ESP_INT_EVENT_TRACKER_CAPTURE(error_handle, ESP_TLS_ERR_TYPE_SYSTEM, errno);
  248. return ret;
  249. }
  250. // Set timeout options, keep-alive options and bind device options if configured
  251. ret = esp_tls_set_socket_options(fd, cfg);
  252. if (ret != ESP_OK) {
  253. goto err;
  254. }
  255. // Set to non block before connecting to better control connection timeout
  256. ret = esp_tls_set_socket_non_blocking(fd, true);
  257. if (ret != ESP_OK) {
  258. goto err;
  259. }
  260. ret = ESP_ERR_ESP_TLS_FAILED_CONNECT_TO_HOST;
  261. ESP_LOGD(TAG, "[sock=%d] Connecting to server. HOST: %s, Port: %d", fd, host, port);
  262. if (connect(fd, (struct sockaddr *)&address, sizeof(struct sockaddr)) < 0) {
  263. if (errno == EINPROGRESS) {
  264. fd_set fdset;
  265. struct timeval tv = { .tv_usec = 0, .tv_sec = 10 }; // Default connection timeout is 10 s
  266. if (cfg && cfg->non_block) {
  267. // Non-blocking mode -> just return successfully at this stage
  268. *sockfd = fd;
  269. return ESP_OK;
  270. }
  271. if ( cfg && cfg->timeout_ms > 0 ) {
  272. ms_to_timeval(cfg->timeout_ms, &tv);
  273. }
  274. FD_ZERO(&fdset);
  275. FD_SET(fd, &fdset);
  276. int res = select(fd+1, NULL, &fdset, NULL, &tv);
  277. if (res < 0) {
  278. ESP_LOGE(TAG, "[sock=%d] select() error: %s", fd, strerror(errno));
  279. ESP_INT_EVENT_TRACKER_CAPTURE(error_handle, ESP_TLS_ERR_TYPE_SYSTEM, errno);
  280. goto err;
  281. }
  282. else if (res == 0) {
  283. ESP_LOGE(TAG, "[sock=%d] select() timeout", fd);
  284. ret = ESP_ERR_ESP_TLS_CONNECTION_TIMEOUT;
  285. goto err;
  286. } else {
  287. int sockerr;
  288. socklen_t len = (socklen_t)sizeof(int);
  289. if (getsockopt(fd, SOL_SOCKET, SO_ERROR, (void*)(&sockerr), &len) < 0) {
  290. ESP_LOGE(TAG, "[sock=%d] getsockopt() error: %s", fd, strerror(errno));
  291. ret = ESP_ERR_ESP_TLS_SOCKET_SETOPT_FAILED;
  292. goto err;
  293. }
  294. else if (sockerr) {
  295. ESP_INT_EVENT_TRACKER_CAPTURE(error_handle, ESP_TLS_ERR_TYPE_SYSTEM, sockerr);
  296. ESP_LOGE(TAG, "[sock=%d] delayed connect error: %s", fd, strerror(sockerr));
  297. goto err;
  298. }
  299. }
  300. } else {
  301. ESP_LOGE(TAG, "[sock=%d] connect() error: %s", fd, strerror(errno));
  302. goto err;
  303. }
  304. }
  305. if (cfg && cfg->non_block == false) {
  306. // reset back to blocking mode (unless non_block configured)
  307. ret = esp_tls_set_socket_non_blocking(fd, false);
  308. if (ret != ESP_OK) {
  309. goto err;
  310. }
  311. }
  312. *sockfd = fd;
  313. return ESP_OK;
  314. err:
  315. close(fd);
  316. return ret;
  317. }
  318. static int esp_tls_low_level_conn(const char *hostname, int hostlen, int port, const esp_tls_cfg_t *cfg, esp_tls_t *tls)
  319. {
  320. if (!tls) {
  321. ESP_LOGE(TAG, "empty esp_tls parameter");
  322. return -1;
  323. }
  324. esp_err_t esp_ret;
  325. /* These states are used to keep a tab on connection progress in case of non-blocking connect,
  326. and in case of blocking connect these cases will get executed one after the other */
  327. switch (tls->conn_state) {
  328. case ESP_TLS_INIT:
  329. tls->sockfd = -1;
  330. if (cfg != NULL && cfg->is_plain_tcp == false) {
  331. _esp_tls_net_init(tls);
  332. tls->is_tls = true;
  333. }
  334. if ((esp_ret = tcp_connect(hostname, hostlen, port, cfg, tls->error_handle, &tls->sockfd)) != ESP_OK) {
  335. ESP_INT_EVENT_TRACKER_CAPTURE(tls->error_handle, ESP_TLS_ERR_TYPE_ESP, esp_ret);
  336. return -1;
  337. }
  338. if (tls->is_tls == false) {
  339. tls->read = tcp_read;
  340. tls->write = tcp_write;
  341. ESP_LOGD(TAG, "non-tls connection established");
  342. return 1;
  343. }
  344. if (cfg && cfg->non_block) {
  345. FD_ZERO(&tls->rset);
  346. FD_SET(tls->sockfd, &tls->rset);
  347. tls->wset = tls->rset;
  348. }
  349. tls->conn_state = ESP_TLS_CONNECTING;
  350. /* falls through */
  351. case ESP_TLS_CONNECTING:
  352. if (cfg && cfg->non_block) {
  353. ESP_LOGD(TAG, "connecting...");
  354. struct timeval tv;
  355. ms_to_timeval(cfg->timeout_ms, &tv);
  356. /* In case of non-blocking I/O, we use the select() API to check whether
  357. connection has been established or not*/
  358. if (select(tls->sockfd + 1, &tls->rset, &tls->wset, NULL,
  359. cfg->timeout_ms>0 ? &tv : NULL) == 0) {
  360. ESP_LOGD(TAG, "select() timed out");
  361. return 0;
  362. }
  363. if (FD_ISSET(tls->sockfd, &tls->rset) || FD_ISSET(tls->sockfd, &tls->wset)) {
  364. int error;
  365. socklen_t len = sizeof(error);
  366. /* pending error check */
  367. if (getsockopt(tls->sockfd, SOL_SOCKET, SO_ERROR, &error, &len) < 0) {
  368. ESP_LOGD(TAG, "Non blocking connect failed");
  369. ESP_INT_EVENT_TRACKER_CAPTURE(tls->error_handle, ESP_TLS_ERR_TYPE_SYSTEM, errno);
  370. ESP_INT_EVENT_TRACKER_CAPTURE(tls->error_handle, ESP_TLS_ERR_TYPE_ESP, ESP_ERR_ESP_TLS_SOCKET_SETOPT_FAILED);
  371. tls->conn_state = ESP_TLS_FAIL;
  372. return -1;
  373. }
  374. }
  375. }
  376. /* By now, the connection has been established */
  377. esp_ret = create_ssl_handle(hostname, hostlen, cfg, tls);
  378. if (esp_ret != ESP_OK) {
  379. ESP_LOGE(TAG, "create_ssl_handle failed");
  380. ESP_INT_EVENT_TRACKER_CAPTURE(tls->error_handle, ESP_TLS_ERR_TYPE_ESP, esp_ret);
  381. tls->conn_state = ESP_TLS_FAIL;
  382. return -1;
  383. }
  384. tls->read = _esp_tls_read;
  385. tls->write = _esp_tls_write;
  386. tls->conn_state = ESP_TLS_HANDSHAKE;
  387. /* falls through */
  388. case ESP_TLS_HANDSHAKE:
  389. ESP_LOGD(TAG, "handshake in progress...");
  390. return esp_tls_handshake(tls, cfg);
  391. break;
  392. case ESP_TLS_FAIL:
  393. ESP_LOGE(TAG, "failed to open a new connection");;
  394. break;
  395. default:
  396. ESP_LOGE(TAG, "invalid esp-tls state");
  397. break;
  398. }
  399. return -1;
  400. }
  401. /**
  402. * @brief Create a new plain TCP connection
  403. */
  404. esp_err_t esp_tls_plain_tcp_connect(const char *host, int hostlen, int port, const esp_tls_cfg_t *cfg, esp_tls_error_handle_t error_handle, int *sockfd)
  405. {
  406. if (sockfd == NULL || error_handle == NULL) {
  407. return ESP_ERR_INVALID_ARG;
  408. }
  409. return tcp_connect(host, hostlen, port, cfg, error_handle, sockfd);
  410. }
  411. /**
  412. * @brief Create a new TLS/SSL connection
  413. */
  414. esp_tls_t *esp_tls_conn_new(const char *hostname, int hostlen, int port, const esp_tls_cfg_t *cfg)
  415. {
  416. esp_tls_t *tls = esp_tls_init();
  417. if (!tls) {
  418. return NULL;
  419. }
  420. /* esp_tls_conn_new() API establishes connection in a blocking manner thus this loop ensures that esp_tls_conn_new()
  421. API returns only after connection is established unless there is an error*/
  422. size_t start = xTaskGetTickCount();
  423. while (1) {
  424. int ret = esp_tls_low_level_conn(hostname, hostlen, port, cfg, tls);
  425. if (ret == 1) {
  426. return tls;
  427. } else if (ret == -1) {
  428. esp_tls_conn_delete(tls);
  429. ESP_LOGE(TAG, "Failed to open new connection");
  430. return NULL;
  431. } else if (ret == 0 && cfg->timeout_ms >= 0) {
  432. size_t timeout_ticks = pdMS_TO_TICKS(cfg->timeout_ms);
  433. uint32_t expired = xTaskGetTickCount() - start;
  434. if (expired >= timeout_ticks) {
  435. esp_tls_conn_delete(tls);
  436. ESP_LOGE(TAG, "Failed to open new connection in specified timeout");
  437. return NULL;
  438. }
  439. }
  440. }
  441. return NULL;
  442. }
  443. int esp_tls_conn_new_sync(const char *hostname, int hostlen, int port, const esp_tls_cfg_t *cfg, esp_tls_t *tls)
  444. {
  445. /* esp_tls_conn_new_sync() is a sync alternative to esp_tls_conn_new_async() with symmetric function prototype
  446. it is an alternative to esp_tls_conn_new() which is left for compatibility reasons */
  447. size_t start = xTaskGetTickCount();
  448. while (1) {
  449. int ret = esp_tls_low_level_conn(hostname, hostlen, port, cfg, tls);
  450. if (ret == 1) {
  451. return ret;
  452. } else if (ret == -1) {
  453. ESP_LOGE(TAG, "Failed to open new connection");
  454. return -1;
  455. } else if (ret == 0 && cfg->timeout_ms >= 0) {
  456. size_t timeout_ticks = pdMS_TO_TICKS(cfg->timeout_ms);
  457. uint32_t expired = xTaskGetTickCount() - start;
  458. if (expired >= timeout_ticks) {
  459. ESP_LOGW(TAG, "Failed to open new connection in specified timeout");
  460. ESP_INT_EVENT_TRACKER_CAPTURE(tls->error_handle, ESP_TLS_ERR_TYPE_ESP, ESP_ERR_ESP_TLS_CONNECTION_TIMEOUT);
  461. return 0;
  462. }
  463. }
  464. }
  465. return 0;
  466. }
  467. /*
  468. * @brief Create a new TLS/SSL non-blocking connection
  469. */
  470. int esp_tls_conn_new_async(const char *hostname, int hostlen, int port, const esp_tls_cfg_t *cfg, esp_tls_t *tls)
  471. {
  472. return esp_tls_low_level_conn(hostname, hostlen, port, cfg, tls);
  473. }
  474. static int get_port(const char *url, struct http_parser_url *u)
  475. {
  476. if (u->field_data[UF_PORT].len) {
  477. return strtol(&url[u->field_data[UF_PORT].off], NULL, 10);
  478. } else {
  479. if (strncasecmp(&url[u->field_data[UF_SCHEMA].off], "http", u->field_data[UF_SCHEMA].len) == 0) {
  480. return 80;
  481. } else if (strncasecmp(&url[u->field_data[UF_SCHEMA].off], "https", u->field_data[UF_SCHEMA].len) == 0) {
  482. return 443;
  483. }
  484. }
  485. return 0;
  486. }
  487. /**
  488. * @brief Create a new TLS/SSL connection with a given "HTTP" url
  489. */
  490. esp_tls_t *esp_tls_conn_http_new(const char *url, const esp_tls_cfg_t *cfg)
  491. {
  492. /* Parse URI */
  493. struct http_parser_url u;
  494. http_parser_url_init(&u);
  495. http_parser_parse_url(url, strlen(url), 0, &u);
  496. esp_tls_t *tls = esp_tls_init();
  497. if (!tls) {
  498. return NULL;
  499. }
  500. /* Connect to host */
  501. if (esp_tls_conn_new_sync(&url[u.field_data[UF_HOST].off], u.field_data[UF_HOST].len,
  502. get_port(url, &u), cfg, tls) == 1) {
  503. return tls;
  504. }
  505. esp_tls_conn_delete(tls);
  506. return NULL;
  507. }
  508. /**
  509. * @brief Create a new non-blocking TLS/SSL connection with a given "HTTP" url
  510. */
  511. int esp_tls_conn_http_new_async(const char *url, const esp_tls_cfg_t *cfg, esp_tls_t *tls)
  512. {
  513. /* Parse URI */
  514. struct http_parser_url u;
  515. http_parser_url_init(&u);
  516. http_parser_parse_url(url, strlen(url), 0, &u);
  517. /* Connect to host */
  518. return esp_tls_conn_new_async(&url[u.field_data[UF_HOST].off], u.field_data[UF_HOST].len,
  519. get_port(url, &u), cfg, tls);
  520. }
  521. #ifdef CONFIG_ESP_TLS_USING_MBEDTLS
  522. mbedtls_x509_crt *esp_tls_get_global_ca_store(void)
  523. {
  524. return _esp_tls_get_global_ca_store();
  525. }
  526. #endif /* CONFIG_ESP_TLS_USING_MBEDTLS */
  527. #ifdef CONFIG_ESP_TLS_CLIENT_SESSION_TICKETS
  528. esp_tls_client_session_t *esp_tls_get_client_session(esp_tls_t *tls)
  529. {
  530. return _esp_tls_get_client_session(tls);
  531. }
  532. #endif /* CONFIG_ESP_TLS_CLIENT_SESSION_TICKETS */
  533. #ifdef CONFIG_ESP_TLS_SERVER
  534. esp_err_t esp_tls_cfg_server_session_tickets_init(esp_tls_cfg_server_t *cfg)
  535. {
  536. #if defined(CONFIG_ESP_TLS_SERVER_SESSION_TICKETS)
  537. if (!cfg || cfg->ticket_ctx) {
  538. return ESP_ERR_INVALID_ARG;
  539. }
  540. cfg->ticket_ctx = calloc(1, sizeof(esp_tls_server_session_ticket_ctx_t));
  541. if (!cfg->ticket_ctx) {
  542. return ESP_ERR_NO_MEM;
  543. }
  544. esp_err_t ret = _esp_tls_server_session_ticket_ctx_init(cfg->ticket_ctx);
  545. if (ret != ESP_OK) {
  546. free(cfg->ticket_ctx);
  547. }
  548. return ret;
  549. #else
  550. return ESP_ERR_NOT_SUPPORTED;
  551. #endif
  552. }
  553. void esp_tls_cfg_server_session_tickets_free(esp_tls_cfg_server_t *cfg)
  554. {
  555. #if defined(CONFIG_ESP_TLS_SERVER_SESSION_TICKETS)
  556. if (cfg && cfg->ticket_ctx) {
  557. _esp_tls_server_session_ticket_ctx_free(cfg->ticket_ctx);
  558. }
  559. #endif
  560. }
  561. /**
  562. * @brief Create a server side TLS/SSL connection
  563. */
  564. int esp_tls_server_session_create(esp_tls_cfg_server_t *cfg, int sockfd, esp_tls_t *tls)
  565. {
  566. return _esp_tls_server_session_create(cfg, sockfd, tls);
  567. }
  568. /**
  569. * @brief Close the server side TLS/SSL connection and free any allocated resources.
  570. */
  571. void esp_tls_server_session_delete(esp_tls_t *tls)
  572. {
  573. return _esp_tls_server_session_delete(tls);
  574. }
  575. #endif /* CONFIG_ESP_TLS_SERVER */
  576. ssize_t esp_tls_get_bytes_avail(esp_tls_t *tls)
  577. {
  578. return _esp_tls_get_bytes_avail(tls);
  579. }
  580. esp_err_t esp_tls_get_conn_sockfd(esp_tls_t *tls, int *sockfd)
  581. {
  582. if (!tls || !sockfd) {
  583. ESP_LOGE(TAG, "Invalid arguments passed");
  584. return ESP_ERR_INVALID_ARG;
  585. }
  586. *sockfd = tls->sockfd;
  587. return ESP_OK;
  588. }
  589. esp_err_t esp_tls_get_and_clear_last_error(esp_tls_error_handle_t h, int *esp_tls_code, int *esp_tls_flags)
  590. {
  591. if (!h) {
  592. return ESP_ERR_INVALID_STATE;
  593. }
  594. esp_err_t last_err = h->last_error;
  595. if (esp_tls_code) {
  596. *esp_tls_code = h->esp_tls_error_code;
  597. }
  598. if (esp_tls_flags) {
  599. *esp_tls_flags = h->esp_tls_flags;
  600. }
  601. memset(h, 0, sizeof(esp_tls_last_error_t));
  602. return last_err;
  603. }
  604. esp_err_t esp_tls_init_global_ca_store(void)
  605. {
  606. return _esp_tls_init_global_ca_store();
  607. }
  608. esp_err_t esp_tls_set_global_ca_store(const unsigned char *cacert_pem_buf, const unsigned int cacert_pem_bytes)
  609. {
  610. return _esp_tls_set_global_ca_store(cacert_pem_buf, cacert_pem_bytes);
  611. }
  612. void esp_tls_free_global_ca_store(void)
  613. {
  614. return _esp_tls_free_global_ca_store();
  615. }