room.cpp 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143
  1. // SPDX-FileCopyrightText: Copyright 2017 Citra Emulator Project
  2. // SPDX-License-Identifier: GPL-2.0-or-later
  3. #include <algorithm>
  4. #include <atomic>
  5. #include <iomanip>
  6. #include <mutex>
  7. #include <random>
  8. #include <regex>
  9. #include <shared_mutex>
  10. #include <sstream>
  11. #include <thread>
  12. #include "common/logging/log.h"
  13. #include "enet/enet.h"
  14. #include "network/packet.h"
  15. #include "network/room.h"
  16. #include "network/verify_user.h"
  17. namespace Network {
  18. class Room::RoomImpl {
  19. public:
  20. std::mt19937 random_gen; ///< Random number generator. Used for GenerateFakeIPAddress
  21. ENetHost* server = nullptr; ///< Network interface.
  22. std::atomic<State> state{State::Closed}; ///< Current state of the room.
  23. RoomInformation room_information; ///< Information about this room.
  24. std::string verify_uid; ///< A GUID which may be used for verification.
  25. mutable std::mutex verify_uid_mutex; ///< Mutex for verify_uid
  26. std::string password; ///< The password required to connect to this room.
  27. struct Member {
  28. std::string nickname; ///< The nickname of the member.
  29. GameInfo game_info; ///< The current game of the member
  30. IPv4Address fake_ip; ///< The assigned fake ip address of the member.
  31. /// Data of the user, often including authenticated forum username.
  32. VerifyUser::UserData user_data;
  33. ENetPeer* peer; ///< The remote peer.
  34. };
  35. using MemberList = std::vector<Member>;
  36. MemberList members; ///< Information about the members of this room
  37. mutable std::shared_mutex member_mutex; ///< Mutex for locking the members list
  38. UsernameBanList username_ban_list; ///< List of banned usernames
  39. IPBanList ip_ban_list; ///< List of banned IP addresses
  40. mutable std::mutex ban_list_mutex; ///< Mutex for the ban lists
  41. RoomImpl() : random_gen(std::random_device()()) {}
  42. /// Thread that receives and dispatches network packets
  43. std::unique_ptr<std::thread> room_thread;
  44. /// Verification backend of the room
  45. std::unique_ptr<VerifyUser::Backend> verify_backend;
  46. /// Thread function that will receive and dispatch messages until the room is destroyed.
  47. void ServerLoop();
  48. void StartLoop();
  49. /**
  50. * Parses and answers a room join request from a client.
  51. * Validates the uniqueness of the username and assigns the MAC address
  52. * that the client will use for the remainder of the connection.
  53. */
  54. void HandleJoinRequest(const ENetEvent* event);
  55. /**
  56. * Parses and answers a kick request from a client.
  57. * Validates the permissions and that the given user exists and then kicks the member.
  58. */
  59. void HandleModKickPacket(const ENetEvent* event);
  60. /**
  61. * Parses and answers a ban request from a client.
  62. * Validates the permissions and bans the user (by forum username or IP).
  63. */
  64. void HandleModBanPacket(const ENetEvent* event);
  65. /**
  66. * Parses and answers a unban request from a client.
  67. * Validates the permissions and unbans the address.
  68. */
  69. void HandleModUnbanPacket(const ENetEvent* event);
  70. /**
  71. * Parses and answers a get ban list request from a client.
  72. * Validates the permissions and returns the ban list.
  73. */
  74. void HandleModGetBanListPacket(const ENetEvent* event);
  75. /**
  76. * Returns whether the nickname is valid, ie. isn't already taken by someone else in the room.
  77. */
  78. bool IsValidNickname(const std::string& nickname) const;
  79. /**
  80. * Returns whether the fake ip address is valid, ie. isn't already taken by someone else in the
  81. * room.
  82. */
  83. bool IsValidFakeIPAddress(const IPv4Address& address) const;
  84. /**
  85. * Returns whether a user has mod permissions.
  86. */
  87. bool HasModPermission(const ENetPeer* client) const;
  88. /**
  89. * Sends a ID_ROOM_IS_FULL message telling the client that the room is full.
  90. */
  91. void SendRoomIsFull(ENetPeer* client);
  92. /**
  93. * Sends a ID_ROOM_NAME_COLLISION message telling the client that the name is invalid.
  94. */
  95. void SendNameCollision(ENetPeer* client);
  96. /**
  97. * Sends a ID_ROOM_IP_COLLISION message telling the client that the IP is invalid.
  98. */
  99. void SendIPCollision(ENetPeer* client);
  100. /**
  101. * Sends a ID_ROOM_VERSION_MISMATCH message telling the client that the version is invalid.
  102. */
  103. void SendVersionMismatch(ENetPeer* client);
  104. /**
  105. * Sends a ID_ROOM_WRONG_PASSWORD message telling the client that the password is wrong.
  106. */
  107. void SendWrongPassword(ENetPeer* client);
  108. /**
  109. * Notifies the member that its connection attempt was successful,
  110. * and it is now part of the room.
  111. */
  112. void SendJoinSuccess(ENetPeer* client, IPv4Address fake_ip);
  113. /**
  114. * Notifies the member that its connection attempt was successful,
  115. * and it is now part of the room, and it has been granted mod permissions.
  116. */
  117. void SendJoinSuccessAsMod(ENetPeer* client, IPv4Address fake_ip);
  118. /**
  119. * Sends a IdHostKicked message telling the client that they have been kicked.
  120. */
  121. void SendUserKicked(ENetPeer* client);
  122. /**
  123. * Sends a IdHostBanned message telling the client that they have been banned.
  124. */
  125. void SendUserBanned(ENetPeer* client);
  126. /**
  127. * Sends a IdModPermissionDenied message telling the client that they do not have mod
  128. * permission.
  129. */
  130. void SendModPermissionDenied(ENetPeer* client);
  131. /**
  132. * Sends a IdModNoSuchUser message telling the client that the given user could not be found.
  133. */
  134. void SendModNoSuchUser(ENetPeer* client);
  135. /**
  136. * Sends the ban list in response to a client's request for getting ban list.
  137. */
  138. void SendModBanListResponse(ENetPeer* client);
  139. /**
  140. * Notifies the members that the room is closed,
  141. */
  142. void SendCloseMessage();
  143. /**
  144. * Sends a system message to all the connected clients.
  145. */
  146. void SendStatusMessage(StatusMessageTypes type, const std::string& nickname,
  147. const std::string& username, const std::string& ip);
  148. /**
  149. * Sends the information about the room, along with the list of members
  150. * to every connected client in the room.
  151. * The packet has the structure:
  152. * <MessageID>ID_ROOM_INFORMATION
  153. * <String> room_name
  154. * <String> room_description
  155. * <u32> member_slots: The max number of clients allowed in this room
  156. * <String> uid
  157. * <u16> port
  158. * <u32> num_members: the number of currently joined clients
  159. * This is followed by the following three values for each member:
  160. * <String> nickname of that member
  161. * <IPv4Address> fake_ip of that member
  162. * <String> game_name of that member
  163. */
  164. void BroadcastRoomInformation();
  165. /**
  166. * Generates a free MAC address to assign to a new client.
  167. * The first 3 bytes are the NintendoOUI 0x00, 0x1F, 0x32
  168. */
  169. IPv4Address GenerateFakeIPAddress();
  170. /**
  171. * Broadcasts this packet to all members except the sender.
  172. * @param event The ENet event containing the data
  173. */
  174. void HandleProxyPacket(const ENetEvent* event);
  175. /**
  176. * Broadcasts this packet to all members except the sender.
  177. * @param event The ENet event containing the data
  178. */
  179. void HandleLdnPacket(const ENetEvent* event);
  180. /**
  181. * Extracts a chat entry from a received ENet packet and adds it to the chat queue.
  182. * @param event The ENet event that was received.
  183. */
  184. void HandleChatPacket(const ENetEvent* event);
  185. /**
  186. * Extracts the game name from a received ENet packet and broadcasts it.
  187. * @param event The ENet event that was received.
  188. */
  189. void HandleGameInfoPacket(const ENetEvent* event);
  190. /**
  191. * Removes the client from the members list if it was in it and announces the change
  192. * to all other clients.
  193. */
  194. void HandleClientDisconnection(ENetPeer* client);
  195. };
  196. // RoomImpl
  197. void Room::RoomImpl::ServerLoop() {
  198. while (state != State::Closed) {
  199. ENetEvent event;
  200. if (enet_host_service(server, &event, 5) > 0) {
  201. switch (event.type) {
  202. case ENET_EVENT_TYPE_RECEIVE:
  203. switch (event.packet->data[0]) {
  204. case IdJoinRequest:
  205. HandleJoinRequest(&event);
  206. break;
  207. case IdSetGameInfo:
  208. HandleGameInfoPacket(&event);
  209. break;
  210. case IdProxyPacket:
  211. HandleProxyPacket(&event);
  212. break;
  213. case IdLdnPacket:
  214. HandleLdnPacket(&event);
  215. break;
  216. case IdChatMessage:
  217. HandleChatPacket(&event);
  218. break;
  219. // Moderation
  220. case IdModKick:
  221. HandleModKickPacket(&event);
  222. break;
  223. case IdModBan:
  224. HandleModBanPacket(&event);
  225. break;
  226. case IdModUnban:
  227. HandleModUnbanPacket(&event);
  228. break;
  229. case IdModGetBanList:
  230. HandleModGetBanListPacket(&event);
  231. break;
  232. }
  233. enet_packet_destroy(event.packet);
  234. break;
  235. case ENET_EVENT_TYPE_DISCONNECT:
  236. HandleClientDisconnection(event.peer);
  237. break;
  238. case ENET_EVENT_TYPE_NONE:
  239. case ENET_EVENT_TYPE_CONNECT:
  240. break;
  241. }
  242. }
  243. }
  244. // Close the connection to all members:
  245. SendCloseMessage();
  246. }
  247. void Room::RoomImpl::StartLoop() {
  248. room_thread = std::make_unique<std::thread>(&Room::RoomImpl::ServerLoop, this);
  249. }
  250. void Room::RoomImpl::HandleJoinRequest(const ENetEvent* event) {
  251. {
  252. std::lock_guard lock(member_mutex);
  253. if (members.size() >= room_information.member_slots) {
  254. SendRoomIsFull(event->peer);
  255. return;
  256. }
  257. }
  258. Packet packet;
  259. packet.Append(event->packet->data, event->packet->dataLength);
  260. packet.IgnoreBytes(sizeof(u8)); // Ignore the message type
  261. std::string nickname;
  262. packet.Read(nickname);
  263. IPv4Address preferred_fake_ip;
  264. packet.Read(preferred_fake_ip);
  265. u32 client_version;
  266. packet.Read(client_version);
  267. std::string pass;
  268. packet.Read(pass);
  269. std::string token;
  270. packet.Read(token);
  271. if (pass != password) {
  272. SendWrongPassword(event->peer);
  273. return;
  274. }
  275. if (!IsValidNickname(nickname)) {
  276. SendNameCollision(event->peer);
  277. return;
  278. }
  279. if (preferred_fake_ip != NoPreferredIP) {
  280. // Verify if the preferred fake ip is available
  281. if (!IsValidFakeIPAddress(preferred_fake_ip)) {
  282. SendIPCollision(event->peer);
  283. return;
  284. }
  285. } else {
  286. // Assign a fake ip address of this client automatically
  287. preferred_fake_ip = GenerateFakeIPAddress();
  288. }
  289. if (client_version != network_version) {
  290. SendVersionMismatch(event->peer);
  291. return;
  292. }
  293. // At this point the client is ready to be added to the room.
  294. Member member{};
  295. member.fake_ip = preferred_fake_ip;
  296. member.nickname = nickname;
  297. member.peer = event->peer;
  298. std::string uid;
  299. {
  300. std::lock_guard lock(verify_uid_mutex);
  301. uid = verify_uid;
  302. }
  303. member.user_data = verify_backend->LoadUserData(uid, token);
  304. std::string ip;
  305. {
  306. std::lock_guard lock(ban_list_mutex);
  307. // Check username ban
  308. if (!member.user_data.username.empty() &&
  309. std::find(username_ban_list.begin(), username_ban_list.end(),
  310. member.user_data.username) != username_ban_list.end()) {
  311. SendUserBanned(event->peer);
  312. return;
  313. }
  314. // Check IP ban
  315. std::array<char, 256> ip_raw{};
  316. enet_address_get_host_ip(&event->peer->address, ip_raw.data(), sizeof(ip_raw) - 1);
  317. ip = ip_raw.data();
  318. if (std::find(ip_ban_list.begin(), ip_ban_list.end(), ip) != ip_ban_list.end()) {
  319. SendUserBanned(event->peer);
  320. return;
  321. }
  322. }
  323. // Notify everyone that the user has joined.
  324. SendStatusMessage(IdMemberJoin, member.nickname, member.user_data.username, ip);
  325. {
  326. std::lock_guard lock(member_mutex);
  327. members.push_back(std::move(member));
  328. }
  329. // Notify everyone that the room information has changed.
  330. BroadcastRoomInformation();
  331. if (HasModPermission(event->peer)) {
  332. SendJoinSuccessAsMod(event->peer, preferred_fake_ip);
  333. } else {
  334. SendJoinSuccess(event->peer, preferred_fake_ip);
  335. }
  336. }
  337. void Room::RoomImpl::HandleModKickPacket(const ENetEvent* event) {
  338. if (!HasModPermission(event->peer)) {
  339. SendModPermissionDenied(event->peer);
  340. return;
  341. }
  342. Packet packet;
  343. packet.Append(event->packet->data, event->packet->dataLength);
  344. packet.IgnoreBytes(sizeof(u8)); // Ignore the message type
  345. std::string nickname;
  346. packet.Read(nickname);
  347. std::string username, ip;
  348. {
  349. std::lock_guard lock(member_mutex);
  350. const auto target_member =
  351. std::find_if(members.begin(), members.end(),
  352. [&nickname](const auto& member) { return member.nickname == nickname; });
  353. if (target_member == members.end()) {
  354. SendModNoSuchUser(event->peer);
  355. return;
  356. }
  357. // Notify the kicked member
  358. SendUserKicked(target_member->peer);
  359. username = target_member->user_data.username;
  360. std::array<char, 256> ip_raw{};
  361. enet_address_get_host_ip(&target_member->peer->address, ip_raw.data(), sizeof(ip_raw) - 1);
  362. ip = ip_raw.data();
  363. enet_peer_disconnect(target_member->peer, 0);
  364. members.erase(target_member);
  365. }
  366. // Announce the change to all clients.
  367. SendStatusMessage(IdMemberKicked, nickname, username, ip);
  368. BroadcastRoomInformation();
  369. }
  370. void Room::RoomImpl::HandleModBanPacket(const ENetEvent* event) {
  371. if (!HasModPermission(event->peer)) {
  372. SendModPermissionDenied(event->peer);
  373. return;
  374. }
  375. Packet packet;
  376. packet.Append(event->packet->data, event->packet->dataLength);
  377. packet.IgnoreBytes(sizeof(u8)); // Ignore the message type
  378. std::string nickname;
  379. packet.Read(nickname);
  380. std::string username, ip;
  381. {
  382. std::lock_guard lock(member_mutex);
  383. const auto target_member =
  384. std::find_if(members.begin(), members.end(),
  385. [&nickname](const auto& member) { return member.nickname == nickname; });
  386. if (target_member == members.end()) {
  387. SendModNoSuchUser(event->peer);
  388. return;
  389. }
  390. // Notify the banned member
  391. SendUserBanned(target_member->peer);
  392. nickname = target_member->nickname;
  393. username = target_member->user_data.username;
  394. std::array<char, 256> ip_raw{};
  395. enet_address_get_host_ip(&target_member->peer->address, ip_raw.data(), sizeof(ip_raw) - 1);
  396. ip = ip_raw.data();
  397. enet_peer_disconnect(target_member->peer, 0);
  398. members.erase(target_member);
  399. }
  400. {
  401. std::lock_guard lock(ban_list_mutex);
  402. if (!username.empty()) {
  403. // Ban the forum username
  404. if (std::find(username_ban_list.begin(), username_ban_list.end(), username) ==
  405. username_ban_list.end()) {
  406. username_ban_list.emplace_back(username);
  407. }
  408. }
  409. // Ban the member's IP as well
  410. if (std::find(ip_ban_list.begin(), ip_ban_list.end(), ip) == ip_ban_list.end()) {
  411. ip_ban_list.emplace_back(ip);
  412. }
  413. }
  414. // Announce the change to all clients.
  415. SendStatusMessage(IdMemberBanned, nickname, username, ip);
  416. BroadcastRoomInformation();
  417. }
  418. void Room::RoomImpl::HandleModUnbanPacket(const ENetEvent* event) {
  419. if (!HasModPermission(event->peer)) {
  420. SendModPermissionDenied(event->peer);
  421. return;
  422. }
  423. Packet packet;
  424. packet.Append(event->packet->data, event->packet->dataLength);
  425. packet.IgnoreBytes(sizeof(u8)); // Ignore the message type
  426. std::string address;
  427. packet.Read(address);
  428. bool unbanned = false;
  429. {
  430. std::lock_guard lock(ban_list_mutex);
  431. auto it = std::find(username_ban_list.begin(), username_ban_list.end(), address);
  432. if (it != username_ban_list.end()) {
  433. unbanned = true;
  434. username_ban_list.erase(it);
  435. }
  436. it = std::find(ip_ban_list.begin(), ip_ban_list.end(), address);
  437. if (it != ip_ban_list.end()) {
  438. unbanned = true;
  439. ip_ban_list.erase(it);
  440. }
  441. }
  442. if (unbanned) {
  443. SendStatusMessage(IdAddressUnbanned, address, "", "");
  444. } else {
  445. SendModNoSuchUser(event->peer);
  446. }
  447. }
  448. void Room::RoomImpl::HandleModGetBanListPacket(const ENetEvent* event) {
  449. if (!HasModPermission(event->peer)) {
  450. SendModPermissionDenied(event->peer);
  451. return;
  452. }
  453. SendModBanListResponse(event->peer);
  454. }
  455. bool Room::RoomImpl::IsValidNickname(const std::string& nickname) const {
  456. // A nickname is valid if it matches the regex and is not already taken by anybody else in the
  457. // room.
  458. const std::regex nickname_regex("^[ a-zA-Z0-9._-]{4,20}$");
  459. if (!std::regex_match(nickname, nickname_regex))
  460. return false;
  461. std::lock_guard lock(member_mutex);
  462. return std::all_of(members.begin(), members.end(),
  463. [&nickname](const auto& member) { return member.nickname != nickname; });
  464. }
  465. bool Room::RoomImpl::IsValidFakeIPAddress(const IPv4Address& address) const {
  466. // An IP address is valid if it is not already taken by anybody else in the room.
  467. std::lock_guard lock(member_mutex);
  468. return std::all_of(members.begin(), members.end(),
  469. [&address](const auto& member) { return member.fake_ip != address; });
  470. }
  471. bool Room::RoomImpl::HasModPermission(const ENetPeer* client) const {
  472. std::lock_guard lock(member_mutex);
  473. const auto sending_member =
  474. std::find_if(members.begin(), members.end(),
  475. [client](const auto& member) { return member.peer == client; });
  476. if (sending_member == members.end()) {
  477. return false;
  478. }
  479. if (room_information.enable_yuzu_mods &&
  480. sending_member->user_data.moderator) { // Community moderator
  481. return true;
  482. }
  483. if (!room_information.host_username.empty() &&
  484. sending_member->user_data.username == room_information.host_username) { // Room host
  485. return true;
  486. }
  487. return false;
  488. }
  489. void Room::RoomImpl::SendNameCollision(ENetPeer* client) {
  490. Packet packet;
  491. packet.Write(static_cast<u8>(IdNameCollision));
  492. ENetPacket* enet_packet =
  493. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  494. enet_peer_send(client, 0, enet_packet);
  495. enet_host_flush(server);
  496. }
  497. void Room::RoomImpl::SendIPCollision(ENetPeer* client) {
  498. Packet packet;
  499. packet.Write(static_cast<u8>(IdIpCollision));
  500. ENetPacket* enet_packet =
  501. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  502. enet_peer_send(client, 0, enet_packet);
  503. enet_host_flush(server);
  504. }
  505. void Room::RoomImpl::SendWrongPassword(ENetPeer* client) {
  506. Packet packet;
  507. packet.Write(static_cast<u8>(IdWrongPassword));
  508. ENetPacket* enet_packet =
  509. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  510. enet_peer_send(client, 0, enet_packet);
  511. enet_host_flush(server);
  512. }
  513. void Room::RoomImpl::SendRoomIsFull(ENetPeer* client) {
  514. Packet packet;
  515. packet.Write(static_cast<u8>(IdRoomIsFull));
  516. ENetPacket* enet_packet =
  517. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  518. enet_peer_send(client, 0, enet_packet);
  519. enet_host_flush(server);
  520. }
  521. void Room::RoomImpl::SendVersionMismatch(ENetPeer* client) {
  522. Packet packet;
  523. packet.Write(static_cast<u8>(IdVersionMismatch));
  524. packet.Write(network_version);
  525. ENetPacket* enet_packet =
  526. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  527. enet_peer_send(client, 0, enet_packet);
  528. enet_host_flush(server);
  529. }
  530. void Room::RoomImpl::SendJoinSuccess(ENetPeer* client, IPv4Address fake_ip) {
  531. Packet packet;
  532. packet.Write(static_cast<u8>(IdJoinSuccess));
  533. packet.Write(fake_ip);
  534. ENetPacket* enet_packet =
  535. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  536. enet_peer_send(client, 0, enet_packet);
  537. enet_host_flush(server);
  538. }
  539. void Room::RoomImpl::SendJoinSuccessAsMod(ENetPeer* client, IPv4Address fake_ip) {
  540. Packet packet;
  541. packet.Write(static_cast<u8>(IdJoinSuccessAsMod));
  542. packet.Write(fake_ip);
  543. ENetPacket* enet_packet =
  544. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  545. enet_peer_send(client, 0, enet_packet);
  546. enet_host_flush(server);
  547. }
  548. void Room::RoomImpl::SendUserKicked(ENetPeer* client) {
  549. Packet packet;
  550. packet.Write(static_cast<u8>(IdHostKicked));
  551. ENetPacket* enet_packet =
  552. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  553. enet_peer_send(client, 0, enet_packet);
  554. enet_host_flush(server);
  555. }
  556. void Room::RoomImpl::SendUserBanned(ENetPeer* client) {
  557. Packet packet;
  558. packet.Write(static_cast<u8>(IdHostBanned));
  559. ENetPacket* enet_packet =
  560. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  561. enet_peer_send(client, 0, enet_packet);
  562. enet_host_flush(server);
  563. }
  564. void Room::RoomImpl::SendModPermissionDenied(ENetPeer* client) {
  565. Packet packet;
  566. packet.Write(static_cast<u8>(IdModPermissionDenied));
  567. ENetPacket* enet_packet =
  568. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  569. enet_peer_send(client, 0, enet_packet);
  570. enet_host_flush(server);
  571. }
  572. void Room::RoomImpl::SendModNoSuchUser(ENetPeer* client) {
  573. Packet packet;
  574. packet.Write(static_cast<u8>(IdModNoSuchUser));
  575. ENetPacket* enet_packet =
  576. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  577. enet_peer_send(client, 0, enet_packet);
  578. enet_host_flush(server);
  579. }
  580. void Room::RoomImpl::SendModBanListResponse(ENetPeer* client) {
  581. Packet packet;
  582. packet.Write(static_cast<u8>(IdModBanListResponse));
  583. {
  584. std::lock_guard lock(ban_list_mutex);
  585. packet.Write(username_ban_list);
  586. packet.Write(ip_ban_list);
  587. }
  588. ENetPacket* enet_packet =
  589. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  590. enet_peer_send(client, 0, enet_packet);
  591. enet_host_flush(server);
  592. }
  593. void Room::RoomImpl::SendCloseMessage() {
  594. Packet packet;
  595. packet.Write(static_cast<u8>(IdCloseRoom));
  596. std::lock_guard lock(member_mutex);
  597. if (!members.empty()) {
  598. ENetPacket* enet_packet =
  599. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  600. for (auto& member : members) {
  601. enet_peer_send(member.peer, 0, enet_packet);
  602. }
  603. }
  604. enet_host_flush(server);
  605. for (auto& member : members) {
  606. enet_peer_disconnect(member.peer, 0);
  607. }
  608. }
  609. void Room::RoomImpl::SendStatusMessage(StatusMessageTypes type, const std::string& nickname,
  610. const std::string& username, const std::string& ip) {
  611. Packet packet;
  612. packet.Write(static_cast<u8>(IdStatusMessage));
  613. packet.Write(static_cast<u8>(type));
  614. packet.Write(nickname);
  615. packet.Write(username);
  616. std::lock_guard lock(member_mutex);
  617. if (!members.empty()) {
  618. ENetPacket* enet_packet =
  619. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  620. for (auto& member : members) {
  621. enet_peer_send(member.peer, 0, enet_packet);
  622. }
  623. }
  624. enet_host_flush(server);
  625. const std::string display_name =
  626. username.empty() ? nickname : fmt::format("{} ({})", nickname, username);
  627. switch (type) {
  628. case IdMemberJoin:
  629. LOG_INFO(Network, "[{}] {} has joined.", ip, display_name);
  630. break;
  631. case IdMemberLeave:
  632. LOG_INFO(Network, "[{}] {} has left.", ip, display_name);
  633. break;
  634. case IdMemberKicked:
  635. LOG_INFO(Network, "[{}] {} has been kicked.", ip, display_name);
  636. break;
  637. case IdMemberBanned:
  638. LOG_INFO(Network, "[{}] {} has been banned.", ip, display_name);
  639. break;
  640. case IdAddressUnbanned:
  641. LOG_INFO(Network, "{} has been unbanned.", display_name);
  642. break;
  643. }
  644. }
  645. void Room::RoomImpl::BroadcastRoomInformation() {
  646. Packet packet;
  647. packet.Write(static_cast<u8>(IdRoomInformation));
  648. packet.Write(room_information.name);
  649. packet.Write(room_information.description);
  650. packet.Write(room_information.member_slots);
  651. packet.Write(room_information.port);
  652. packet.Write(room_information.preferred_game.name);
  653. packet.Write(room_information.host_username);
  654. packet.Write(static_cast<u32>(members.size()));
  655. {
  656. std::lock_guard lock(member_mutex);
  657. for (const auto& member : members) {
  658. packet.Write(member.nickname);
  659. packet.Write(member.fake_ip);
  660. packet.Write(member.game_info.name);
  661. packet.Write(member.game_info.id);
  662. packet.Write(member.game_info.version);
  663. packet.Write(member.user_data.username);
  664. packet.Write(member.user_data.display_name);
  665. packet.Write(member.user_data.avatar_url);
  666. }
  667. }
  668. ENetPacket* enet_packet =
  669. enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE);
  670. enet_host_broadcast(server, 0, enet_packet);
  671. enet_host_flush(server);
  672. }
  673. IPv4Address Room::RoomImpl::GenerateFakeIPAddress() {
  674. IPv4Address result_ip{192, 168, 0, 0};
  675. std::uniform_int_distribution<> dis(0x01, 0xFE); // Random byte between 1 and 0xFE
  676. do {
  677. for (std::size_t i = 2; i < result_ip.size(); ++i) {
  678. result_ip[i] = dis(random_gen);
  679. }
  680. } while (!IsValidFakeIPAddress(result_ip));
  681. return result_ip;
  682. }
  683. void Room::RoomImpl::HandleProxyPacket(const ENetEvent* event) {
  684. Packet in_packet;
  685. in_packet.Append(event->packet->data, event->packet->dataLength);
  686. in_packet.IgnoreBytes(sizeof(u8)); // Message type
  687. in_packet.IgnoreBytes(sizeof(u8)); // Domain
  688. in_packet.IgnoreBytes(sizeof(IPv4Address)); // IP
  689. in_packet.IgnoreBytes(sizeof(u16)); // Port
  690. in_packet.IgnoreBytes(sizeof(u8)); // Domain
  691. IPv4Address remote_ip;
  692. in_packet.Read(remote_ip); // IP
  693. in_packet.IgnoreBytes(sizeof(u16)); // Port
  694. in_packet.IgnoreBytes(sizeof(u8)); // Protocol
  695. bool broadcast;
  696. in_packet.Read(broadcast); // Broadcast
  697. Packet out_packet;
  698. out_packet.Append(event->packet->data, event->packet->dataLength);
  699. ENetPacket* enet_packet = enet_packet_create(out_packet.GetData(), out_packet.GetDataSize(),
  700. ENET_PACKET_FLAG_RELIABLE);
  701. const auto& destination_address = remote_ip;
  702. if (broadcast) { // Send the data to everyone except the sender
  703. std::lock_guard lock(member_mutex);
  704. bool sent_packet = false;
  705. for (const auto& member : members) {
  706. if (member.peer != event->peer) {
  707. sent_packet = true;
  708. enet_peer_send(member.peer, 0, enet_packet);
  709. }
  710. }
  711. if (!sent_packet) {
  712. enet_packet_destroy(enet_packet);
  713. }
  714. } else { // Send the data only to the destination client
  715. std::lock_guard lock(member_mutex);
  716. auto member = std::find_if(members.begin(), members.end(),
  717. [destination_address](const Member& member_entry) -> bool {
  718. return member_entry.fake_ip == destination_address;
  719. });
  720. if (member != members.end()) {
  721. enet_peer_send(member->peer, 0, enet_packet);
  722. } else {
  723. LOG_ERROR(Network,
  724. "Attempting to send to unknown IP address: "
  725. "{}.{}.{}.{}",
  726. destination_address[0], destination_address[1], destination_address[2],
  727. destination_address[3]);
  728. enet_packet_destroy(enet_packet);
  729. }
  730. }
  731. enet_host_flush(server);
  732. }
  733. void Room::RoomImpl::HandleLdnPacket(const ENetEvent* event) {
  734. Packet in_packet;
  735. in_packet.Append(event->packet->data, event->packet->dataLength);
  736. in_packet.IgnoreBytes(sizeof(u8)); // Message type
  737. in_packet.IgnoreBytes(sizeof(u8)); // LAN packet type
  738. in_packet.IgnoreBytes(sizeof(IPv4Address)); // Local IP
  739. IPv4Address remote_ip;
  740. in_packet.Read(remote_ip); // Remote IP
  741. bool broadcast;
  742. in_packet.Read(broadcast); // Broadcast
  743. Packet out_packet;
  744. out_packet.Append(event->packet->data, event->packet->dataLength);
  745. ENetPacket* enet_packet = enet_packet_create(out_packet.GetData(), out_packet.GetDataSize(),
  746. ENET_PACKET_FLAG_RELIABLE);
  747. const auto& destination_address = remote_ip;
  748. if (broadcast) { // Send the data to everyone except the sender
  749. std::lock_guard lock(member_mutex);
  750. bool sent_packet = false;
  751. for (const auto& member : members) {
  752. if (member.peer != event->peer) {
  753. sent_packet = true;
  754. enet_peer_send(member.peer, 0, enet_packet);
  755. }
  756. }
  757. if (!sent_packet) {
  758. enet_packet_destroy(enet_packet);
  759. }
  760. } else {
  761. std::lock_guard lock(member_mutex);
  762. auto member = std::find_if(members.begin(), members.end(),
  763. [destination_address](const Member& member_entry) -> bool {
  764. return member_entry.fake_ip == destination_address;
  765. });
  766. if (member != members.end()) {
  767. enet_peer_send(member->peer, 0, enet_packet);
  768. } else {
  769. LOG_ERROR(Network,
  770. "Attempting to send to unknown IP address: "
  771. "{}.{}.{}.{}",
  772. destination_address[0], destination_address[1], destination_address[2],
  773. destination_address[3]);
  774. enet_packet_destroy(enet_packet);
  775. }
  776. }
  777. enet_host_flush(server);
  778. }
  779. void Room::RoomImpl::HandleChatPacket(const ENetEvent* event) {
  780. Packet in_packet;
  781. in_packet.Append(event->packet->data, event->packet->dataLength);
  782. in_packet.IgnoreBytes(sizeof(u8)); // Ignore the message type
  783. std::string message;
  784. in_packet.Read(message);
  785. auto CompareNetworkAddress = [event](const Member member) -> bool {
  786. return member.peer == event->peer;
  787. };
  788. std::lock_guard lock(member_mutex);
  789. const auto sending_member = std::find_if(members.begin(), members.end(), CompareNetworkAddress);
  790. if (sending_member == members.end()) {
  791. return; // Received a chat message from a unknown sender
  792. }
  793. // Limit the size of chat messages to MaxMessageSize
  794. message.resize(std::min(static_cast<u32>(message.size()), MaxMessageSize));
  795. Packet out_packet;
  796. out_packet.Write(static_cast<u8>(IdChatMessage));
  797. out_packet.Write(sending_member->nickname);
  798. out_packet.Write(sending_member->user_data.username);
  799. out_packet.Write(message);
  800. ENetPacket* enet_packet = enet_packet_create(out_packet.GetData(), out_packet.GetDataSize(),
  801. ENET_PACKET_FLAG_RELIABLE);
  802. bool sent_packet = false;
  803. for (const auto& member : members) {
  804. if (member.peer != event->peer) {
  805. sent_packet = true;
  806. enet_peer_send(member.peer, 0, enet_packet);
  807. }
  808. }
  809. if (!sent_packet) {
  810. enet_packet_destroy(enet_packet);
  811. }
  812. enet_host_flush(server);
  813. if (sending_member->user_data.username.empty()) {
  814. LOG_INFO(Network, "{}: {}", sending_member->nickname, message);
  815. } else {
  816. LOG_INFO(Network, "{} ({}): {}", sending_member->nickname,
  817. sending_member->user_data.username, message);
  818. }
  819. }
  820. void Room::RoomImpl::HandleGameInfoPacket(const ENetEvent* event) {
  821. Packet in_packet;
  822. in_packet.Append(event->packet->data, event->packet->dataLength);
  823. in_packet.IgnoreBytes(sizeof(u8)); // Ignore the message type
  824. GameInfo game_info;
  825. in_packet.Read(game_info.name);
  826. in_packet.Read(game_info.id);
  827. in_packet.Read(game_info.version);
  828. {
  829. std::lock_guard lock(member_mutex);
  830. auto member = std::find_if(members.begin(), members.end(),
  831. [event](const Member& member_entry) -> bool {
  832. return member_entry.peer == event->peer;
  833. });
  834. if (member != members.end()) {
  835. member->game_info = game_info;
  836. const std::string display_name =
  837. member->user_data.username.empty()
  838. ? member->nickname
  839. : fmt::format("{} ({})", member->nickname, member->user_data.username);
  840. if (game_info.name.empty()) {
  841. LOG_INFO(Network, "{} is not playing", display_name);
  842. } else {
  843. LOG_INFO(Network, "{} is playing {} ({})", display_name, game_info.name,
  844. game_info.version);
  845. }
  846. }
  847. }
  848. BroadcastRoomInformation();
  849. }
  850. void Room::RoomImpl::HandleClientDisconnection(ENetPeer* client) {
  851. // Remove the client from the members list.
  852. std::string nickname, username, ip;
  853. {
  854. std::lock_guard lock(member_mutex);
  855. auto member =
  856. std::find_if(members.begin(), members.end(), [client](const Member& member_entry) {
  857. return member_entry.peer == client;
  858. });
  859. if (member != members.end()) {
  860. nickname = member->nickname;
  861. username = member->user_data.username;
  862. std::array<char, 256> ip_raw{};
  863. enet_address_get_host_ip(&member->peer->address, ip_raw.data(), sizeof(ip_raw) - 1);
  864. ip = ip_raw.data();
  865. members.erase(member);
  866. }
  867. }
  868. // Announce the change to all clients.
  869. enet_peer_disconnect(client, 0);
  870. if (!nickname.empty())
  871. SendStatusMessage(IdMemberLeave, nickname, username, ip);
  872. BroadcastRoomInformation();
  873. }
  874. // Room
  875. Room::Room() : room_impl{std::make_unique<RoomImpl>()} {}
  876. Room::~Room() = default;
  877. bool Room::Create(const std::string& name, const std::string& description,
  878. const std::string& server_address, u16 server_port, const std::string& password,
  879. const u32 max_connections, const std::string& host_username,
  880. const GameInfo preferred_game,
  881. std::unique_ptr<VerifyUser::Backend> verify_backend,
  882. const Room::BanList& ban_list, bool enable_yuzu_mods) {
  883. ENetAddress address;
  884. address.host = ENET_HOST_ANY;
  885. if (!server_address.empty()) {
  886. enet_address_set_host(&address, server_address.c_str());
  887. }
  888. address.port = server_port;
  889. // In order to send the room is full message to the connecting client, we need to leave one
  890. // slot open so enet won't reject the incoming connection without telling us
  891. room_impl->server = enet_host_create(&address, max_connections + 1, NumChannels, 0, 0);
  892. if (!room_impl->server) {
  893. return false;
  894. }
  895. room_impl->state = State::Open;
  896. room_impl->room_information.name = name;
  897. room_impl->room_information.description = description;
  898. room_impl->room_information.member_slots = max_connections;
  899. room_impl->room_information.port = server_port;
  900. room_impl->room_information.preferred_game = preferred_game;
  901. room_impl->room_information.host_username = host_username;
  902. room_impl->room_information.enable_yuzu_mods = enable_yuzu_mods;
  903. room_impl->password = password;
  904. room_impl->verify_backend = std::move(verify_backend);
  905. room_impl->username_ban_list = ban_list.first;
  906. room_impl->ip_ban_list = ban_list.second;
  907. room_impl->StartLoop();
  908. return true;
  909. }
  910. Room::State Room::GetState() const {
  911. return room_impl->state;
  912. }
  913. const RoomInformation& Room::GetRoomInformation() const {
  914. return room_impl->room_information;
  915. }
  916. std::string Room::GetVerifyUID() const {
  917. std::lock_guard lock(room_impl->verify_uid_mutex);
  918. return room_impl->verify_uid;
  919. }
  920. Room::BanList Room::GetBanList() const {
  921. std::lock_guard lock(room_impl->ban_list_mutex);
  922. return {room_impl->username_ban_list, room_impl->ip_ban_list};
  923. }
  924. std::vector<Member> Room::GetRoomMemberList() const {
  925. std::vector<Member> member_list;
  926. std::lock_guard lock(room_impl->member_mutex);
  927. for (const auto& member_impl : room_impl->members) {
  928. Member member;
  929. member.nickname = member_impl.nickname;
  930. member.username = member_impl.user_data.username;
  931. member.display_name = member_impl.user_data.display_name;
  932. member.avatar_url = member_impl.user_data.avatar_url;
  933. member.fake_ip = member_impl.fake_ip;
  934. member.game = member_impl.game_info;
  935. member_list.push_back(member);
  936. }
  937. return member_list;
  938. }
  939. bool Room::HasPassword() const {
  940. return !room_impl->password.empty();
  941. }
  942. void Room::SetVerifyUID(const std::string& uid) {
  943. std::lock_guard lock(room_impl->verify_uid_mutex);
  944. room_impl->verify_uid = uid;
  945. }
  946. void Room::Destroy() {
  947. room_impl->state = State::Closed;
  948. room_impl->room_thread->join();
  949. room_impl->room_thread.reset();
  950. if (room_impl->server) {
  951. enet_host_destroy(room_impl->server);
  952. }
  953. room_impl->room_information = {};
  954. room_impl->server = nullptr;
  955. {
  956. std::lock_guard lock(room_impl->member_mutex);
  957. room_impl->members.clear();
  958. }
  959. room_impl->room_information.member_slots = 0;
  960. room_impl->room_information.name.clear();
  961. }
  962. } // namespace Network