wsl_peer.cpp 27 KB

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