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