wsl_peer.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854
  1. /**************************************************************************/
  2. /* wsl_peer.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #ifndef WEB_ENABLED
  31. #include "wsl_peer.h"
  32. #include "wsl_peer.h"
  33. #include "core/io/stream_peer_tls.h"
  34. CryptoCore::RandomGenerator *WSLPeer::_static_rng = nullptr;
  35. void WSLPeer::initialize() {
  36. WebSocketPeer::_create = WSLPeer::_create;
  37. _static_rng = memnew(CryptoCore::RandomGenerator);
  38. _static_rng->init();
  39. }
  40. void WSLPeer::deinitialize() {
  41. if (_static_rng) {
  42. memdelete(_static_rng);
  43. _static_rng = nullptr;
  44. }
  45. }
  46. ///
  47. /// Resolver
  48. ///
  49. void WSLPeer::Resolver::start(const String &p_host, int p_port) {
  50. stop();
  51. port = p_port;
  52. if (p_host.is_valid_ip_address()) {
  53. ip_candidates.push_back(IPAddress(p_host));
  54. } else {
  55. // Queue hostname for resolution.
  56. resolver_id = IP::get_singleton()->resolve_hostname_queue_item(p_host);
  57. ERR_FAIL_COND(resolver_id == IP::RESOLVER_INVALID_ID);
  58. // Check if it was found in cache.
  59. IP::ResolverStatus ip_status = IP::get_singleton()->get_resolve_item_status(resolver_id);
  60. if (ip_status == IP::RESOLVER_STATUS_DONE) {
  61. ip_candidates = IP::get_singleton()->get_resolve_item_addresses(resolver_id);
  62. IP::get_singleton()->erase_resolve_item(resolver_id);
  63. resolver_id = IP::RESOLVER_INVALID_ID;
  64. }
  65. }
  66. }
  67. void WSLPeer::Resolver::stop() {
  68. if (resolver_id != IP::RESOLVER_INVALID_ID) {
  69. IP::get_singleton()->erase_resolve_item(resolver_id);
  70. resolver_id = IP::RESOLVER_INVALID_ID;
  71. }
  72. port = 0;
  73. }
  74. void WSLPeer::Resolver::try_next_candidate(Ref<StreamPeerTCP> &p_tcp) {
  75. // Check if we still need resolving.
  76. if (resolver_id != IP::RESOLVER_INVALID_ID) {
  77. IP::ResolverStatus ip_status = IP::get_singleton()->get_resolve_item_status(resolver_id);
  78. if (ip_status == IP::RESOLVER_STATUS_WAITING) {
  79. return;
  80. }
  81. if (ip_status == IP::RESOLVER_STATUS_DONE) {
  82. ip_candidates = IP::get_singleton()->get_resolve_item_addresses(resolver_id);
  83. }
  84. IP::get_singleton()->erase_resolve_item(resolver_id);
  85. resolver_id = IP::RESOLVER_INVALID_ID;
  86. }
  87. // Try the current candidate if we have one.
  88. if (p_tcp->get_status() != StreamPeerTCP::STATUS_NONE) {
  89. p_tcp->poll();
  90. StreamPeerTCP::Status status = p_tcp->get_status();
  91. if (status == StreamPeerTCP::STATUS_CONNECTED) {
  92. p_tcp->set_no_delay(true);
  93. ip_candidates.clear();
  94. return;
  95. } else if (status == StreamPeerTCP::STATUS_CONNECTING) {
  96. return; // Keep connecting.
  97. } else {
  98. p_tcp->disconnect_from_host();
  99. }
  100. }
  101. // Keep trying next candidate.
  102. while (ip_candidates.size()) {
  103. Error err = p_tcp->connect_to_host(ip_candidates.pop_front(), port);
  104. if (err == OK) {
  105. return;
  106. } else {
  107. p_tcp->disconnect_from_host();
  108. }
  109. }
  110. }
  111. ///
  112. /// Server functions
  113. ///
  114. Error WSLPeer::accept_stream(Ref<StreamPeer> p_stream) {
  115. ERR_FAIL_COND_V(wsl_ctx || tcp.is_valid(), ERR_ALREADY_IN_USE);
  116. ERR_FAIL_COND_V(p_stream.is_null(), ERR_INVALID_PARAMETER);
  117. _clear();
  118. if (p_stream->is_class_ptr(StreamPeerTCP::get_class_ptr_static())) {
  119. tcp = p_stream;
  120. connection = p_stream;
  121. use_tls = false;
  122. } else if (p_stream->is_class_ptr(StreamPeerTLS::get_class_ptr_static())) {
  123. Ref<StreamPeer> base_stream = static_cast<Ref<StreamPeerTLS>>(p_stream)->get_stream();
  124. ERR_FAIL_COND_V(base_stream.is_null() || !base_stream->is_class_ptr(StreamPeerTCP::get_class_ptr_static()), ERR_INVALID_PARAMETER);
  125. tcp = static_cast<Ref<StreamPeerTCP>>(base_stream);
  126. connection = p_stream;
  127. use_tls = true;
  128. }
  129. ERR_FAIL_COND_V(connection.is_null() || tcp.is_null(), ERR_INVALID_PARAMETER);
  130. is_server = true;
  131. ready_state = STATE_CONNECTING;
  132. handshake_buffer->resize(WSL_MAX_HEADER_SIZE);
  133. handshake_buffer->seek(0);
  134. return OK;
  135. }
  136. bool WSLPeer::_parse_client_request() {
  137. Vector<String> psa = String((const char *)handshake_buffer->get_data_array().ptr(), handshake_buffer->get_position() - 4).split("\r\n");
  138. int len = psa.size();
  139. ERR_FAIL_COND_V_MSG(len < 4, false, "Not enough response headers, got: " + itos(len) + ", expected >= 4.");
  140. Vector<String> req = psa[0].split(" ", false);
  141. ERR_FAIL_COND_V_MSG(req.size() < 2, false, "Invalid protocol or status code.");
  142. // Wrong protocol
  143. ERR_FAIL_COND_V_MSG(req[0] != "GET" || req[2] != "HTTP/1.1", false, "Invalid method or HTTP version.");
  144. HashMap<String, String> headers;
  145. for (int i = 1; i < len; i++) {
  146. Vector<String> header = psa[i].split(":", false, 1);
  147. ERR_FAIL_COND_V_MSG(header.size() != 2, false, "Invalid header -> " + psa[i]);
  148. String name = header[0].to_lower();
  149. String value = header[1].strip_edges();
  150. if (headers.has(name)) {
  151. headers[name] += "," + value;
  152. } else {
  153. headers[name] = value;
  154. }
  155. }
  156. requested_host = headers.has("host") ? headers.get("host") : "";
  157. requested_url = (use_tls ? "wss://" : "ws://") + requested_host + req[1];
  158. #define WSL_CHECK(NAME, VALUE) \
  159. ERR_FAIL_COND_V_MSG(!headers.has(NAME) || headers[NAME].to_lower() != VALUE, false, \
  160. "Missing or invalid header '" + String(NAME) + "'. Expected value '" + VALUE + "'.");
  161. #define WSL_CHECK_EX(NAME) \
  162. ERR_FAIL_COND_V_MSG(!headers.has(NAME), false, "Missing header '" + String(NAME) + "'.");
  163. WSL_CHECK("upgrade", "websocket");
  164. WSL_CHECK("sec-websocket-version", "13");
  165. WSL_CHECK_EX("sec-websocket-key");
  166. WSL_CHECK_EX("connection");
  167. #undef WSL_CHECK_EX
  168. #undef WSL_CHECK
  169. session_key = headers["sec-websocket-key"];
  170. if (headers.has("sec-websocket-protocol")) {
  171. Vector<String> protos = headers["sec-websocket-protocol"].split(",");
  172. for (int i = 0; i < protos.size(); i++) {
  173. String proto = protos[i].strip_edges();
  174. // Check if we have the given protocol
  175. for (int j = 0; j < supported_protocols.size(); j++) {
  176. if (proto != supported_protocols[j]) {
  177. continue;
  178. }
  179. selected_protocol = proto;
  180. break;
  181. }
  182. // Found a protocol
  183. if (!selected_protocol.is_empty()) {
  184. break;
  185. }
  186. }
  187. if (selected_protocol.is_empty()) { // Invalid protocol(s) requested
  188. return false;
  189. }
  190. } else if (supported_protocols.size() > 0) { // No protocol requested, but we need one
  191. return false;
  192. }
  193. return true;
  194. }
  195. Error WSLPeer::_do_server_handshake() {
  196. if (use_tls) {
  197. Ref<StreamPeerTLS> tls = static_cast<Ref<StreamPeerTLS>>(connection);
  198. if (tls.is_null()) {
  199. ERR_FAIL_V_MSG(ERR_BUG, "Couldn't get StreamPeerTLS for WebSocket handshake.");
  200. close(-1);
  201. return FAILED;
  202. }
  203. tls->poll();
  204. if (tls->get_status() == StreamPeerTLS::STATUS_HANDSHAKING) {
  205. return OK; // Pending handshake
  206. } else if (tls->get_status() != StreamPeerTLS::STATUS_CONNECTED) {
  207. print_verbose(vformat("WebSocket SSL connection error during handshake (StreamPeerTLS status code %d).", tls->get_status()));
  208. close(-1);
  209. return FAILED;
  210. }
  211. }
  212. if (pending_request) {
  213. int read = 0;
  214. while (true) {
  215. ERR_FAIL_COND_V_MSG(handshake_buffer->get_available_bytes() < 1, ERR_OUT_OF_MEMORY, "WebSocket response headers are too big.");
  216. int pos = handshake_buffer->get_position();
  217. uint8_t byte;
  218. Error err = connection->get_partial_data(&byte, 1, read);
  219. if (err != OK) { // Got an error
  220. print_verbose(vformat("WebSocket error while getting partial data (StreamPeer error code %d).", err));
  221. close(-1);
  222. return FAILED;
  223. } else if (read != 1) { // Busy, wait next poll
  224. return OK;
  225. }
  226. handshake_buffer->put_u8(byte);
  227. const char *r = (const char *)handshake_buffer->get_data_array().ptr();
  228. int l = pos;
  229. if (l > 3 && r[l] == '\n' && r[l - 1] == '\r' && r[l - 2] == '\n' && r[l - 3] == '\r') {
  230. if (!_parse_client_request()) {
  231. close(-1);
  232. return FAILED;
  233. }
  234. String s = "HTTP/1.1 101 Switching Protocols\r\n";
  235. s += "Upgrade: websocket\r\n";
  236. s += "Connection: Upgrade\r\n";
  237. s += "Sec-WebSocket-Accept: " + _compute_key_response(session_key) + "\r\n";
  238. if (!selected_protocol.is_empty()) {
  239. s += "Sec-WebSocket-Protocol: " + selected_protocol + "\r\n";
  240. }
  241. for (int i = 0; i < handshake_headers.size(); i++) {
  242. s += handshake_headers[i] + "\r\n";
  243. }
  244. s += "\r\n";
  245. CharString cs = s.utf8();
  246. handshake_buffer->clear();
  247. handshake_buffer->put_data((const uint8_t *)cs.get_data(), cs.length());
  248. handshake_buffer->seek(0);
  249. pending_request = false;
  250. break;
  251. }
  252. }
  253. }
  254. if (pending_request) { // Still pending.
  255. return OK;
  256. }
  257. int left = handshake_buffer->get_available_bytes();
  258. if (left) {
  259. Vector<uint8_t> data = handshake_buffer->get_data_array();
  260. int pos = handshake_buffer->get_position();
  261. int sent = 0;
  262. Error err = connection->put_partial_data(data.ptr() + pos, left, sent);
  263. if (err != OK) {
  264. print_verbose(vformat("WebSocket error while putting partial data (StreamPeer error code %d).", err));
  265. close(-1);
  266. return err;
  267. }
  268. handshake_buffer->seek(pos + sent);
  269. left -= sent;
  270. if (left == 0) {
  271. resolver.stop();
  272. // Response sent, initialize wslay context.
  273. wslay_event_context_server_init(&wsl_ctx, &_wsl_callbacks, this);
  274. wslay_event_config_set_max_recv_msg_length(wsl_ctx, inbound_buffer_size);
  275. in_buffer.resize(nearest_shift(inbound_buffer_size), max_queued_packets);
  276. packet_buffer.resize(inbound_buffer_size);
  277. ready_state = STATE_OPEN;
  278. }
  279. }
  280. return OK;
  281. }
  282. ///
  283. /// Client functions
  284. ///
  285. void WSLPeer::_do_client_handshake() {
  286. ERR_FAIL_COND(tcp.is_null());
  287. // Try to connect to candidates.
  288. if (resolver.has_more_candidates()) {
  289. resolver.try_next_candidate(tcp);
  290. if (resolver.has_more_candidates()) {
  291. return; // Still pending.
  292. }
  293. }
  294. tcp->poll();
  295. if (tcp->get_status() == StreamPeerTCP::STATUS_CONNECTING) {
  296. return; // Keep connecting.
  297. } else if (tcp->get_status() != StreamPeerTCP::STATUS_CONNECTED) {
  298. close(-1); // Failed to connect.
  299. return;
  300. }
  301. if (use_tls) {
  302. Ref<StreamPeerTLS> tls;
  303. if (connection == tcp) {
  304. // Start SSL handshake
  305. tls = Ref<StreamPeerTLS>(StreamPeerTLS::create());
  306. ERR_FAIL_COND(tls.is_null());
  307. if (tls->connect_to_stream(tcp, requested_host, tls_options) != OK) {
  308. close(-1);
  309. return; // Error.
  310. }
  311. connection = tls;
  312. } else {
  313. tls = static_cast<Ref<StreamPeerTLS>>(connection);
  314. ERR_FAIL_COND(tls.is_null());
  315. tls->poll();
  316. }
  317. if (tls->get_status() == StreamPeerTLS::STATUS_HANDSHAKING) {
  318. return; // Need more polling.
  319. } else if (tls->get_status() != StreamPeerTLS::STATUS_CONNECTED) {
  320. close(-1);
  321. return; // Error.
  322. }
  323. }
  324. // Do websocket handshake.
  325. if (pending_request) {
  326. int left = handshake_buffer->get_available_bytes();
  327. int pos = handshake_buffer->get_position();
  328. const Vector<uint8_t> data = handshake_buffer->get_data_array();
  329. int sent = 0;
  330. Error err = connection->put_partial_data(data.ptr() + pos, left, sent);
  331. // Sending handshake failed
  332. if (err != OK) {
  333. close(-1);
  334. return; // Error.
  335. }
  336. handshake_buffer->seek(pos + sent);
  337. if (handshake_buffer->get_available_bytes() == 0) {
  338. pending_request = false;
  339. handshake_buffer->clear();
  340. handshake_buffer->resize(WSL_MAX_HEADER_SIZE);
  341. handshake_buffer->seek(0);
  342. }
  343. } else {
  344. int read = 0;
  345. while (true) {
  346. int left = handshake_buffer->get_available_bytes();
  347. int pos = handshake_buffer->get_position();
  348. if (left == 0) {
  349. // Header is too big
  350. close(-1);
  351. ERR_FAIL_MSG("Response headers too big.");
  352. return;
  353. }
  354. uint8_t byte;
  355. Error err = connection->get_partial_data(&byte, 1, read);
  356. if (err != OK) {
  357. // Got some error.
  358. close(-1);
  359. return;
  360. } else if (read != 1) {
  361. // Busy, wait next poll.
  362. break;
  363. }
  364. handshake_buffer->put_u8(byte);
  365. // Check "\r\n\r\n" header terminator
  366. const char *r = (const char *)handshake_buffer->get_data_array().ptr();
  367. int l = pos;
  368. if (l > 3 && r[l] == '\n' && r[l - 1] == '\r' && r[l - 2] == '\n' && r[l - 3] == '\r') {
  369. // Response is over, verify headers and initialize wslay context/
  370. if (!_verify_server_response()) {
  371. close(-1);
  372. ERR_FAIL_MSG("Invalid response headers.");
  373. return;
  374. }
  375. wslay_event_context_client_init(&wsl_ctx, &_wsl_callbacks, this);
  376. wslay_event_config_set_max_recv_msg_length(wsl_ctx, inbound_buffer_size);
  377. in_buffer.resize(nearest_shift(inbound_buffer_size), max_queued_packets);
  378. packet_buffer.resize(inbound_buffer_size);
  379. ready_state = STATE_OPEN;
  380. break;
  381. }
  382. }
  383. }
  384. }
  385. bool WSLPeer::_verify_server_response() {
  386. Vector<String> psa = String((const char *)handshake_buffer->get_data_array().ptr(), handshake_buffer->get_position() - 4).split("\r\n");
  387. int len = psa.size();
  388. ERR_FAIL_COND_V_MSG(len < 4, false, "Not enough response headers. Got: " + itos(len) + ", expected >= 4.");
  389. Vector<String> req = psa[0].split(" ", false);
  390. ERR_FAIL_COND_V_MSG(req.size() < 2, false, "Invalid protocol or status code. Got '" + psa[0] + "', expected 'HTTP/1.1 101'.");
  391. // Wrong protocol
  392. ERR_FAIL_COND_V_MSG(req[0] != "HTTP/1.1", false, "Invalid protocol. Got: '" + req[0] + "', expected 'HTTP/1.1'.");
  393. ERR_FAIL_COND_V_MSG(req[1] != "101", false, "Invalid status code. Got: '" + req[1] + "', expected '101'.");
  394. HashMap<String, String> headers;
  395. for (int i = 1; i < len; i++) {
  396. Vector<String> header = psa[i].split(":", false, 1);
  397. ERR_FAIL_COND_V_MSG(header.size() != 2, false, "Invalid header -> " + psa[i] + ".");
  398. String name = header[0].to_lower();
  399. String value = header[1].strip_edges();
  400. if (headers.has(name)) {
  401. headers[name] += "," + value;
  402. } else {
  403. headers[name] = value;
  404. }
  405. }
  406. #define WSL_CHECK(NAME, VALUE) \
  407. ERR_FAIL_COND_V_MSG(!headers.has(NAME) || headers[NAME].to_lower() != VALUE, false, \
  408. "Missing or invalid header '" + String(NAME) + "'. Expected value '" + VALUE + "'.");
  409. #define WSL_CHECK_NC(NAME, VALUE) \
  410. ERR_FAIL_COND_V_MSG(!headers.has(NAME) || headers[NAME] != VALUE, false, \
  411. "Missing or invalid header '" + String(NAME) + "'. Expected value '" + VALUE + "'.");
  412. WSL_CHECK("connection", "upgrade");
  413. WSL_CHECK("upgrade", "websocket");
  414. WSL_CHECK_NC("sec-websocket-accept", _compute_key_response(session_key));
  415. #undef WSL_CHECK_NC
  416. #undef WSL_CHECK
  417. if (supported_protocols.size() == 0) {
  418. // We didn't request a custom protocol
  419. ERR_FAIL_COND_V_MSG(headers.has("sec-websocket-protocol"), false, "Received unrequested sub-protocol -> " + headers["sec-websocket-protocol"]);
  420. } else {
  421. // We requested at least one custom protocol but didn't receive one
  422. ERR_FAIL_COND_V_MSG(!headers.has("sec-websocket-protocol"), false, "Requested sub-protocol(s) but received none.");
  423. // Check received sub-protocol was one of those requested.
  424. selected_protocol = headers["sec-websocket-protocol"];
  425. bool valid = false;
  426. for (int i = 0; i < supported_protocols.size(); i++) {
  427. if (supported_protocols[i] != selected_protocol) {
  428. continue;
  429. }
  430. valid = true;
  431. break;
  432. }
  433. if (!valid) {
  434. ERR_FAIL_V_MSG(false, "Received unrequested sub-protocol -> " + selected_protocol);
  435. return false;
  436. }
  437. }
  438. return true;
  439. }
  440. Error WSLPeer::connect_to_url(const String &p_url, Ref<TLSOptions> p_options) {
  441. ERR_FAIL_COND_V(wsl_ctx || tcp.is_valid(), ERR_ALREADY_IN_USE);
  442. ERR_FAIL_COND_V(p_url.is_empty(), ERR_INVALID_PARAMETER);
  443. ERR_FAIL_COND_V(p_options.is_valid() && p_options->is_server(), ERR_INVALID_PARAMETER);
  444. _clear();
  445. String host;
  446. String path;
  447. String scheme;
  448. int port = 0;
  449. Error err = p_url.parse_url(scheme, host, port, path);
  450. ERR_FAIL_COND_V_MSG(err != OK, err, "Invalid URL: " + p_url);
  451. if (scheme.is_empty()) {
  452. scheme = "ws://";
  453. }
  454. ERR_FAIL_COND_V_MSG(scheme != "ws://" && scheme != "wss://", ERR_INVALID_PARAMETER, vformat("Invalid protocol: \"%s\" (must be either \"ws://\" or \"wss://\").", scheme));
  455. use_tls = false;
  456. if (scheme == "wss://") {
  457. use_tls = true;
  458. }
  459. if (port == 0) {
  460. port = use_tls ? 443 : 80;
  461. }
  462. if (path.is_empty()) {
  463. path = "/";
  464. }
  465. ERR_FAIL_COND_V_MSG(use_tls && !StreamPeerTLS::is_available(), ERR_UNAVAILABLE, "WSS is not available in this build.");
  466. requested_url = p_url;
  467. requested_host = host;
  468. if (p_options.is_valid()) {
  469. tls_options = p_options;
  470. } else {
  471. tls_options = TLSOptions::client();
  472. }
  473. tcp.instantiate();
  474. resolver.start(host, port);
  475. resolver.try_next_candidate(tcp);
  476. if (tcp->get_status() != StreamPeerTCP::STATUS_CONNECTING && tcp->get_status() != StreamPeerTCP::STATUS_CONNECTED && !resolver.has_more_candidates()) {
  477. _clear();
  478. return FAILED;
  479. }
  480. connection = tcp;
  481. // Prepare handshake request.
  482. session_key = _generate_key();
  483. String request = "GET " + path + " HTTP/1.1\r\n";
  484. String port_string;
  485. if ((port != 80 && !use_tls) || (port != 443 && use_tls)) {
  486. port_string = ":" + itos(port);
  487. }
  488. request += "Host: " + host + port_string + "\r\n";
  489. request += "Upgrade: websocket\r\n";
  490. request += "Connection: Upgrade\r\n";
  491. request += "Sec-WebSocket-Key: " + session_key + "\r\n";
  492. request += "Sec-WebSocket-Version: 13\r\n";
  493. if (supported_protocols.size() > 0) {
  494. request += "Sec-WebSocket-Protocol: ";
  495. for (int i = 0; i < supported_protocols.size(); i++) {
  496. if (i != 0) {
  497. request += ",";
  498. }
  499. request += supported_protocols[i];
  500. }
  501. request += "\r\n";
  502. }
  503. for (int i = 0; i < handshake_headers.size(); i++) {
  504. request += handshake_headers[i] + "\r\n";
  505. }
  506. request += "\r\n";
  507. CharString cs = request.utf8();
  508. handshake_buffer->put_data((const uint8_t *)cs.get_data(), cs.length());
  509. handshake_buffer->seek(0);
  510. ready_state = STATE_CONNECTING;
  511. is_server = false;
  512. return OK;
  513. }
  514. ///
  515. /// Callback functions.
  516. ///
  517. ssize_t WSLPeer::_wsl_recv_callback(wslay_event_context_ptr ctx, uint8_t *data, size_t len, int flags, void *user_data) {
  518. WSLPeer *peer = (WSLPeer *)user_data;
  519. Ref<StreamPeer> conn = peer->connection;
  520. if (conn.is_null()) {
  521. wslay_event_set_error(ctx, WSLAY_ERR_CALLBACK_FAILURE);
  522. return -1;
  523. }
  524. int read = 0;
  525. Error err = conn->get_partial_data(data, len, read);
  526. if (err != OK) {
  527. print_verbose("Websocket get data error: " + itos(err) + ", read (should be 0!): " + itos(read));
  528. wslay_event_set_error(ctx, WSLAY_ERR_CALLBACK_FAILURE);
  529. return -1;
  530. }
  531. if (read == 0) {
  532. wslay_event_set_error(ctx, WSLAY_ERR_WOULDBLOCK);
  533. return -1;
  534. }
  535. return read;
  536. }
  537. ssize_t WSLPeer::_wsl_send_callback(wslay_event_context_ptr ctx, const uint8_t *data, size_t len, int flags, void *user_data) {
  538. WSLPeer *peer = (WSLPeer *)user_data;
  539. Ref<StreamPeer> conn = peer->connection;
  540. if (conn.is_null()) {
  541. wslay_event_set_error(ctx, WSLAY_ERR_CALLBACK_FAILURE);
  542. return -1;
  543. }
  544. int sent = 0;
  545. Error err = conn->put_partial_data(data, len, sent);
  546. if (err != OK) {
  547. wslay_event_set_error(ctx, WSLAY_ERR_CALLBACK_FAILURE);
  548. return -1;
  549. }
  550. if (sent == 0) {
  551. wslay_event_set_error(ctx, WSLAY_ERR_WOULDBLOCK);
  552. return -1;
  553. }
  554. return sent;
  555. }
  556. int WSLPeer::_wsl_genmask_callback(wslay_event_context_ptr ctx, uint8_t *buf, size_t len, void *user_data) {
  557. ERR_FAIL_COND_V(!_static_rng, WSLAY_ERR_CALLBACK_FAILURE);
  558. Error err = _static_rng->get_random_bytes(buf, len);
  559. ERR_FAIL_COND_V(err != OK, WSLAY_ERR_CALLBACK_FAILURE);
  560. return 0;
  561. }
  562. void WSLPeer::_wsl_msg_recv_callback(wslay_event_context_ptr ctx, const struct wslay_event_on_msg_recv_arg *arg, void *user_data) {
  563. WSLPeer *peer = (WSLPeer *)user_data;
  564. uint8_t op = arg->opcode;
  565. if (op == WSLAY_CONNECTION_CLOSE) {
  566. // Close request or confirmation.
  567. peer->close_code = arg->status_code;
  568. size_t len = arg->msg_length;
  569. peer->close_reason = "";
  570. if (len > 2 /* first 2 bytes = close code */) {
  571. peer->close_reason.parse_utf8((char *)arg->msg + 2, len - 2);
  572. }
  573. if (peer->ready_state == STATE_OPEN) {
  574. peer->ready_state = STATE_CLOSING;
  575. }
  576. return;
  577. }
  578. if (peer->ready_state == STATE_CLOSING) {
  579. return;
  580. }
  581. if (op == WSLAY_TEXT_FRAME || op == WSLAY_BINARY_FRAME) {
  582. // Message.
  583. uint8_t is_string = arg->opcode == WSLAY_TEXT_FRAME ? 1 : 0;
  584. peer->in_buffer.write_packet(arg->msg, arg->msg_length, &is_string);
  585. }
  586. // Ping or pong.
  587. }
  588. wslay_event_callbacks WSLPeer::_wsl_callbacks = {
  589. _wsl_recv_callback,
  590. _wsl_send_callback,
  591. _wsl_genmask_callback,
  592. nullptr, /* on_frame_recv_start_callback */
  593. nullptr, /* on_frame_recv_callback */
  594. nullptr, /* on_frame_recv_end_callback */
  595. _wsl_msg_recv_callback
  596. };
  597. String WSLPeer::_generate_key() {
  598. // Random key
  599. Vector<uint8_t> bkey;
  600. int len = 16; // 16 bytes, as per RFC
  601. bkey.resize(len);
  602. _wsl_genmask_callback(nullptr, bkey.ptrw(), len, nullptr);
  603. return CryptoCore::b64_encode_str(bkey.ptrw(), len);
  604. }
  605. String WSLPeer::_compute_key_response(String p_key) {
  606. String key = p_key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; // Magic UUID as per RFC
  607. Vector<uint8_t> sha = key.sha1_buffer();
  608. return CryptoCore::b64_encode_str(sha.ptr(), sha.size());
  609. }
  610. void WSLPeer::poll() {
  611. // Nothing to do.
  612. if (ready_state == STATE_CLOSED) {
  613. return;
  614. }
  615. if (ready_state == STATE_CONNECTING) {
  616. if (is_server) {
  617. _do_server_handshake();
  618. } else {
  619. _do_client_handshake();
  620. }
  621. }
  622. if (ready_state == STATE_OPEN || ready_state == STATE_CLOSING) {
  623. ERR_FAIL_COND(!wsl_ctx);
  624. int err = 0;
  625. if ((err = wslay_event_recv(wsl_ctx)) != 0 || (err = wslay_event_send(wsl_ctx)) != 0) {
  626. // Error close.
  627. print_verbose("Websocket (wslay) poll error: " + itos(err));
  628. wslay_event_context_free(wsl_ctx);
  629. wsl_ctx = nullptr;
  630. close(-1);
  631. return;
  632. }
  633. if (wslay_event_get_close_sent(wsl_ctx) && wslay_event_get_close_received(wsl_ctx)) {
  634. // Clean close.
  635. wslay_event_context_free(wsl_ctx);
  636. wsl_ctx = nullptr;
  637. close(-1);
  638. return;
  639. }
  640. }
  641. }
  642. Error WSLPeer::_send(const uint8_t *p_buffer, int p_buffer_size, wslay_opcode p_opcode) {
  643. ERR_FAIL_COND_V(ready_state != STATE_OPEN, FAILED);
  644. ERR_FAIL_COND_V(wslay_event_get_queued_msg_count(wsl_ctx) >= (uint32_t)max_queued_packets, ERR_OUT_OF_MEMORY);
  645. ERR_FAIL_COND_V(outbound_buffer_size > 0 && (wslay_event_get_queued_msg_length(wsl_ctx) + p_buffer_size > (uint32_t)outbound_buffer_size), ERR_OUT_OF_MEMORY);
  646. struct wslay_event_msg msg;
  647. msg.opcode = p_opcode;
  648. msg.msg = p_buffer;
  649. msg.msg_length = p_buffer_size;
  650. // Queue & send message.
  651. if (wslay_event_queue_msg(wsl_ctx, &msg) != 0 || wslay_event_send(wsl_ctx) != 0) {
  652. close(-1);
  653. return FAILED;
  654. }
  655. return OK;
  656. }
  657. Error WSLPeer::send(const uint8_t *p_buffer, int p_buffer_size, WriteMode p_mode) {
  658. wslay_opcode opcode = p_mode == WRITE_MODE_TEXT ? WSLAY_TEXT_FRAME : WSLAY_BINARY_FRAME;
  659. return _send(p_buffer, p_buffer_size, opcode);
  660. }
  661. Error WSLPeer::put_packet(const uint8_t *p_buffer, int p_buffer_size) {
  662. return _send(p_buffer, p_buffer_size, WSLAY_BINARY_FRAME);
  663. }
  664. Error WSLPeer::get_packet(const uint8_t **r_buffer, int &r_buffer_size) {
  665. r_buffer_size = 0;
  666. ERR_FAIL_COND_V(ready_state != STATE_OPEN, FAILED);
  667. if (in_buffer.packets_left() == 0) {
  668. return ERR_UNAVAILABLE;
  669. }
  670. int read = 0;
  671. uint8_t *rw = packet_buffer.ptrw();
  672. in_buffer.read_packet(rw, packet_buffer.size(), &was_string, read);
  673. *r_buffer = rw;
  674. r_buffer_size = read;
  675. return OK;
  676. }
  677. int WSLPeer::get_available_packet_count() const {
  678. if (ready_state != STATE_OPEN) {
  679. return 0;
  680. }
  681. return in_buffer.packets_left();
  682. }
  683. int WSLPeer::get_current_outbound_buffered_amount() const {
  684. if (ready_state != STATE_OPEN) {
  685. return 0;
  686. }
  687. return wslay_event_get_queued_msg_length(wsl_ctx);
  688. }
  689. void WSLPeer::close(int p_code, String p_reason) {
  690. if (p_code < 0) {
  691. // Force immediate close.
  692. ready_state = STATE_CLOSED;
  693. }
  694. if (ready_state == STATE_OPEN && !wslay_event_get_close_sent(wsl_ctx)) {
  695. CharString cs = p_reason.utf8();
  696. wslay_event_queue_close(wsl_ctx, p_code, (uint8_t *)cs.ptr(), cs.length());
  697. wslay_event_send(wsl_ctx);
  698. ready_state = STATE_CLOSING;
  699. } else if (ready_state == STATE_CONNECTING || ready_state == STATE_CLOSED) {
  700. ready_state = STATE_CLOSED;
  701. connection.unref();
  702. if (tcp.is_valid()) {
  703. tcp->disconnect_from_host();
  704. tcp.unref();
  705. }
  706. }
  707. in_buffer.clear();
  708. packet_buffer.resize(0);
  709. }
  710. IPAddress WSLPeer::get_connected_host() const {
  711. ERR_FAIL_COND_V(tcp.is_null(), IPAddress());
  712. return tcp->get_connected_host();
  713. }
  714. uint16_t WSLPeer::get_connected_port() const {
  715. ERR_FAIL_COND_V(tcp.is_null(), 0);
  716. return tcp->get_connected_port();
  717. }
  718. String WSLPeer::get_selected_protocol() const {
  719. return selected_protocol;
  720. }
  721. String WSLPeer::get_requested_url() const {
  722. return requested_url;
  723. }
  724. void WSLPeer::set_no_delay(bool p_enabled) {
  725. ERR_FAIL_COND(tcp.is_null());
  726. tcp->set_no_delay(p_enabled);
  727. }
  728. void WSLPeer::_clear() {
  729. // Connection info.
  730. ready_state = STATE_CLOSED;
  731. is_server = false;
  732. connection.unref();
  733. if (tcp.is_valid()) {
  734. tcp->disconnect_from_host();
  735. tcp.unref();
  736. }
  737. if (wsl_ctx) {
  738. wslay_event_context_free(wsl_ctx);
  739. wsl_ctx = nullptr;
  740. }
  741. resolver.stop();
  742. requested_url.clear();
  743. requested_host.clear();
  744. pending_request = true;
  745. handshake_buffer->clear();
  746. selected_protocol.clear();
  747. session_key.clear();
  748. // Pending packets info.
  749. was_string = 0;
  750. in_buffer.clear();
  751. packet_buffer.clear();
  752. // Close code info.
  753. close_code = -1;
  754. close_reason.clear();
  755. }
  756. WSLPeer::WSLPeer() {
  757. handshake_buffer.instantiate();
  758. }
  759. WSLPeer::~WSLPeer() {
  760. close(-1);
  761. }
  762. #endif // WEB_ENABLED