Implement checking for the Patchwork user agent

ProjectLighthouse.Servers.GameServer/Controllers/Login/LoginController.cs

@@ -20,7 +20,7 @@
 public class LoginController : ControllerBase
 {
     private readonly DatabaseContext database;
     public LoginController(DatabaseContext database)
     {
         this.database = database;
     }
@@ -74,7 +74,7 @@
             case Platform.PS3:
             case Platform.Vita:
             case Platform.UnitTest:
                 user = await database.Users.FirstOrDefaultAsync(u => u.LinkedPsnId == npTicket.UserId);
                 break;
             case Platform.PSP:
             case Platform.Unknown:
@@ -86,7 +86,7 @@
         if (user == null)
         {
             // Check if there is an account with that username already
             UserEntity? targetUsername = await database.Users.FirstOrDefaultAsync(u => u.Username == npTicket.Username);
             if (targetUsername != null)
             {
                 ulong targetPlatform = npTicket.Platform == Platform.RPCS3
@@ -101,7 +101,7 @@
                 }
 
                 // if there is already a pending link request don't create another
                 bool linkAttemptExists = await database.PlatformLinkAttempts.AnyAsync(p =>
                     p.Platform == npTicket.Platform &&
                     p.PlatformId == npTicket.UserId &&
                     p.UserId == targetUsername.UserId);
@@ -116,8 +116,8 @@
                     Timestamp = TimeHelper.TimestampMillis,
                     PlatformId = npTicket.UserId,
                 };
                 database.PlatformLinkAttempts.Add(linkAttempt);
                 await database.SaveChangesAsync();
                 Logger.Success($"User '{npTicket.Username}' tried to login but platform isn't linked, platform={npTicket.Platform}", LogArea.Login);
                 return this.Forbid();
             }
@@ -147,11 +147,11 @@
             }
 
             // create account for user if they don't exist
             user = await database.CreateUser(username, "$");
             user.Password = null;
             user.LinkedRpcnId = npTicket.Platform == Platform.RPCS3 ? npTicket.UserId : 0;
             user.LinkedPsnId = npTicket.Platform != Platform.RPCS3 ? npTicket.UserId : 0;
             await database.SaveChangesAsync();
 
             if (DiscordConfiguration.Instance.DiscordIntegrationEnabled)
             {
@@ -171,7 +171,7 @@
         // automatically change username if it doesn't match
         else if (user.Username != npTicket.Username)
         {
             bool usernameExists = await database.Users.AnyAsync(u => u.Username == npTicket.Username);
             if (usernameExists)
             {
                 Logger.Warn($"{npTicket.Platform} user changed their name to a name that is already taken," +
@@ -180,17 +180,17 @@
             }
             Logger.Info($"User's username has changed, old='{user.Username}', new='{npTicket.Username}', platform={npTicket.Platform}", LogArea.Login);
             user.Username = username;
             await database.PlatformLinkAttempts.RemoveWhere(p => p.UserId == user.UserId);
             // unlink other platforms because the names no longer match
             if (npTicket.Platform == Platform.RPCS3)
                 user.LinkedPsnId = 0;
             else
                 user.LinkedRpcnId = 0;
 
             await database.SaveChangesAsync();
         }
 
         GameTokenEntity? token = await database.GameTokens.Include(t => t.User)
             .FirstOrDefaultAsync(t => t.User.Username == npTicket.Username && t.TicketHash == npTicket.TicketHash);
 
         if (token != null)
@@ -199,7 +199,7 @@
             return this.Forbid();
         }
 
         token = await database.AuthenticateUser(user, npTicket, ipAddress);
         if (token == null)
         {
             Logger.Warn($"Unable to find/generate a token for username {npTicket.Username}", LogArea.Login);
@@ -214,9 +214,13 @@
 
         Logger.Success($"Successfully logged in user {user.Username} as {token.GameVersion} client", LogArea.Login);
 
-        user.LastLogin = TimeHelper.TimestampMillis;
+        string userAgent = this.Request.Headers.UserAgent.ToString();
+        if (!String.IsNullOrWhiteSpace(userAgent))
+        {
+            user.UserAgent = userAgent;
+        }
 
         await database.SaveChangesAsync();
 
         // Create a new room on LBP2/3/Vita
         if (token.GameVersion != GameVersion.LittleBigPlanet1) RoomHelper.CreateRoom(user.UserId, token.GameVersion, token.Platform);

ProjectLighthouse.Servers.GameServer/Controllers/Login/LogoutController.cs

@@ -1,6 +1,6 @@
 using LBPUnion.ProjectLighthouse.Database;
 using LBPUnion.ProjectLighthouse.Extensions;
-using LBPUnion.ProjectLighthouse.Helpers;
+using LBPUnion.ProjectLighthouse.Servers.GameServer.Helpers;
 using LBPUnion.ProjectLighthouse.Types.Entities.Profile;
 using LBPUnion.ProjectLighthouse.Types.Entities.Token;
 using Microsoft.AspNetCore.Authorization;
@@ -17,7 +17,7 @@
 
     private readonly DatabaseContext database;
 
     public LogoutController(DatabaseContext database)
     {
         this.database = database;
     }
@@ -30,10 +30,7 @@
         UserEntity? user = await this.database.UserFromGameToken(token);
         if (user == null) return this.Forbid();
 
-        user.LastLogout = TimeHelper.TimestampMillis;
-
-        await this.database.GameTokens.RemoveWhere(t => t.TokenId == token.TokenId);
-        await this.database.LastContacts.RemoveWhere(c => c.UserId == token.UserId);
+        await LogoutHelper.Logout(token, user, database);
 
         return this.Ok();
     }

ProjectLighthouse.Servers.GameServer/Controllers/MessageController.cs

@@ -1,4 +1,5 @@
-using System.Text;
+using System.Globalization;
+using System.Text; 
 using LBPUnion.ProjectLighthouse.Configuration;
 using LBPUnion.ProjectLighthouse.Database;
 using LBPUnion.ProjectLighthouse.Extensions;
@@ -7,6 +8,7 @@
 using LBPUnion.ProjectLighthouse.Localization.StringLists;
 using LBPUnion.ProjectLighthouse.Logging;
 using LBPUnion.ProjectLighthouse.Serialization;
+using LBPUnion.ProjectLighthouse.Servers.GameServer.Helpers;
 using LBPUnion.ProjectLighthouse.Types.Entities.Notifications;
 using LBPUnion.ProjectLighthouse.Types.Entities.Profile;
 using LBPUnion.ProjectLighthouse.Types.Entities.Token;
@@ -42,7 +44,7 @@
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.";
 
     public MessageController(DatabaseContext database)
     {
         this.database = database;
     }
@@ -54,6 +56,10 @@
     public async Task<IActionResult> Announce()
     {
         GameTokenEntity token = this.GetToken();
+        UserEntity? user = await this.database.UserFromGameToken(token);
+
+        if (user == null)
+            return this.Forbid();
 
         string username = await this.database.UsernameFromGameToken(token);
 
@@ -67,12 +73,24 @@
             announceText.Insert(0, BaseLayoutStrings.ReadOnlyWarn.Translate(LocalizationManager.DefaultLang) + "\n\n");
         }
 
+        if (ServerConfiguration.Instance.RequirePatchworkUserAgent)
+        {
+            announceText.Append("This server instance requires the use of the Patchwork plugin for LBP.\n\n");
+
+            if (PatchworkHelper.userHasValidPatchworkUserAgent(user.UserAgent))
+            {
+                announceText.Append("It appears you do not have the Patchwork plugin installed correctly." +
+                    "Since this server instance requires it, you will not be able to play until you so.");
+            }
+            await LogoutHelper.Logout(token, user, database);
+        }
+
         #if DEBUG
         announceText.Append("\n\n---DEBUG INFO---\n" +
                                   $"user.UserId: {token.UserId}\n" +
                                   $"token.GameVersion: {token.GameVersion}\n" +
                                   $"token.TicketHash: {token.TicketHash}\n" +
                                   $"token.ExpiresAt: {token.ExpiresAt.ToString()}\n" +
                                   "---DEBUG INFO---");
         #endif
 
@@ -128,7 +146,7 @@
 
         if (message.StartsWith("/setemail ") && ServerConfiguration.Instance.Mail.MailEnabled)
         {
             string email = message[(message.IndexOf(" ", StringComparison.Ordinal)+1)..];
             if (!SanitizationHelper.IsValidEmail(email)) return this.Ok();
 
             if (await this.database.Users.AnyAsync(u => u.EmailAddress == email)) return this.Ok();

ProjectLighthouse.Servers.GameServer/Helpers/LogoutHelper.cs

@@ -0,0 +1,18 @@
+using LBPUnion.ProjectLighthouse.Helpers;
+using LBPUnion.ProjectLighthouse.Database;
+using LBPUnion.ProjectLighthouse.Extensions;
+using LBPUnion.ProjectLighthouse.Types.Entities.Token;
+using LBPUnion.ProjectLighthouse.Types.Entities.Profile;
+
+namespace LBPUnion.ProjectLighthouse.Servers.GameServer.Helpers;
+
+public class LogoutHelper
+{
+    public static async Task Logout(GameTokenEntity token, UserEntity user, DatabaseContext database)
+    {
+        user.LastLogout = TimeHelper.TimestampMillis;
+
+        await database.GameTokens.RemoveWhere(t => t.TokenId == token.TokenId);
+        await database.LastContacts.RemoveWhere(c => c.UserId == token.UserId);
+    }
+}

ProjectLighthouse.Servers.GameServer/Helpers/PatchworkHelper.cs

@@ -0,0 +1,20 @@
+using LBPUnion.ProjectLighthouse.Configuration;
+
+namespace LBPUnion.ProjectLighthouse.Servers.GameServer.Helpers;
+
+public static class PatchworkHelper
+{
+    static int patchworkMajorVer = ServerConfiguration.Instance.PatchworkMajorVersionMinimum;
+    static int patchworkMinorVer = ServerConfiguration.Instance.PatchworkMinorVersionMinimum;
+    public static bool userHasValidPatchworkUserAgent(string userAgent)
+    {
+        if (userAgent.StartsWith("PatchworkLBP"))
+            return false;
+
+        string[] patchworkVer = userAgent.Split(' ')[1].Split('.');
+        if (int.Parse(patchworkVer[0]) >= patchworkMajorVer && int.Parse(patchworkVer[1]) >= patchworkMinorVer)
+            return true;
+
+        return false;
+    }
+}

ProjectLighthouse/Configuration/ServerConfiguration.cs

@@ -11,39 +11,44 @@
     // This is so Lighthouse can properly identify outdated configurations and update them with newer settings accordingly.
     // If you are modifying anything here, this value MUST be incremented.
     // Thanks for listening~
-    public override int ConfigVersion { get; set; } = 27;
+    public override int ConfigVersion { get; set; } = 28;
 
     public override string ConfigName { get; set; } = "lighthouse.yml";
     public string WebsiteListenUrl { get; set; } = "http://localhost:10060";
     public string GameApiListenUrl { get; set; } = "http://localhost:10061";
     public string ApiListenUrl { get; set; } = "http://localhost:10062";
 
     public string DbConnectionString { get; set; } = "server=127.0.0.1;uid=root;pwd=lighthouse;database=lighthouse";
     public string RedisConnectionString { get; set; } = "redis://localhost:6379";
     public string ExternalUrl { get; set; } = "http://localhost:10060";
     public string GameApiExternalUrl { get; set; } = "http://localhost:10060/LITTLEBIGPLANETPS3_XML";
     public string EulaText { get; set; } = "";
 #if !DEBUG
     public string AnnounceText { get; set; } = "You are now logged in as %user.";
 #else
     public string AnnounceText { get; set; } = "You are now logged in as %user (id: %id).";
 #endif
     public bool CheckForUnsafeFiles { get; set; } = true;
     public bool LogChatFiltering { get; set; } = false;
     public bool LogChatMessages { get; set; } = false;
 
+    // Require use of Zaprit's "Patchwork" prx plugin's user agent when connecting to the server
+    // Major and minor version minimums can be left alone if patchwork is not required
+    public bool RequirePatchworkUserAgent { get; set; } = false;
+    public int PatchworkMajorVersionMinimum { get; set; } = 0;
+    public int PatchworkMinorVersionMinimum { get; set; } = 0;
     public AuthenticationConfiguration Authentication { get; set; } = new();
     public CaptchaConfiguration Captcha { get; set; } = new();
     public DigestKeyConfiguration DigestKey { get; set; } = new();
     public MatchmakingConfiguration Matchmaking { get; set; } = new();
     public GoogleAnalyticsConfiguration GoogleAnalytics { get; set; } = new();
     public MailConfiguration Mail { get; set; } = new();
     public UserGeneratedContentLimitConfiguration UserGeneratedContentLimits { get; set; } = new();
     public WebsiteConfiguration WebsiteConfiguration { get; set; } = new();
     public CustomizationConfiguration Customization { get; set; } = new();
     public RateLimitConfiguration RateLimitConfiguration { get; set; } = new();
     public TwoFactorConfiguration TwoFactorConfiguration { get; set; } = new();
     public RichPresenceConfiguration RichPresenceConfiguration { get; set; } = new();
     public NotificationConfiguration NotificationConfiguration { get; set; } = new();
 
     public override ConfigurationBase<ServerConfiguration> Deserialize(IDeserializer deserializer, string text) => deserializer.Deserialize<ServerConfiguration>(text);

ProjectLighthouse/Types/Entities/Profile/UserEntity.cs

@@ -14,20 +14,22 @@
 
     #nullable enable
     [Key]
     public int UserId { get; set; }
 
     public string Username { get; set; } = "";
 
     #nullable enable
     public string? EmailAddress { get; set; }
     #nullable disable
 
     public bool EmailAddressVerified { get; set; }
 
     public string Password { get; set; }
 
     public string IconHash { get; set; }
 
+    public string UserAgent { get;  set;}
+
     /// <summary>
     ///     Markup that displays the username next to a polaroid with the user's icon.
     ///     This can be used everywhere markup works ingame, e.g. news or notifications
@@ -38,7 +40,7 @@
     /// <summary>
     ///     A user-customizable biography shown on the profile card
     /// </summary>
     public string Biography { get; set; }
 
     [NotMapped]
     public string WebsiteAvatarHash {
@@ -75,24 +77,24 @@
         set => this.LocationPacked = (ulong)value.X << 32 | (uint)value.Y;
     }
 
     public string Pins { get; set; } = "";
 
     public string PlanetHashLBP2 { get; set; } = "";
 
     // ReSharper disable once InconsistentNaming
     public string PlanetHashLBP2CC { get; set; } = "";
 
     public string PlanetHashLBP3 { get; set; } = "";
 
     public string PlanetHashLBPVita { get; set; } = "";
 
     public bool PasswordResetRequired { get; set; }
 
     public string YayHash { get; set; } = "";
     public string BooHash { get; set; } = "";
     public string MehHash { get; set; } = "";
 
     public long LastLogin { get; set; }
     public long LastLogout { get; set; }
 
     public bool IsBanned => this.PermissionLevel is PermissionLevel.Banned;
@@ -108,12 +110,12 @@
     public PermissionLevel PermissionLevel { get; set; } = PermissionLevel.Default;
 
     #nullable enable
     public string? BannedReason { get; set; }
     #nullable disable
 
     public string Language { get; set; } = "en";
 
     public string TimeZone { get; set; } = TimeZoneInfo.Local.Id;
 
     public PrivacyType LevelVisibility { get; set; } = PrivacyType.All;
 
@@ -124,9 +126,9 @@
 
     public bool IsTwoFactorSetup => this.TwoFactorBackup?.Length > 0 && this.TwoFactorSecret?.Length > 0;
 
     public string TwoFactorSecret { get; set; } = "";
 
     public string TwoFactorBackup { get; set; } = "";
 
     public ulong LinkedRpcnId { get; set; }
 
@@ -139,7 +141,7 @@
     // should not be adjustable by user
     public bool CommentsEnabled { get; set; } = true;
 
     public string ProfileTag { get; set; } = "";
 
     #nullable enable
     public override bool Equals(object? obj)
@@ -161,4 +163,4 @@
 
     [SuppressMessage("ReSharper", "NonReadonlyMemberInGetHashCode")]
     public override int GetHashCode() => this.UserId;
     #nullable disable