room.cpp 37 KB

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