Skip to content

Improve photo asset validation #1089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Toastbrot236 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Improve photo asset validation #1089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
daca58a
Improve photo asset validation
Toastbrot236 Jun 22, 2026
978e893
Test photo asset validation
Toastbrot236 Jun 22, 2026
6b4fc76
A few photo test fixes
Toastbrot236 Jun 22, 2026
216e4fb
Update other photo tests to use actual plan resources
Toastbrot236 Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 66 additions & 16 deletions Refresh.Interfaces.Game/Endpoints/PhotoEndpoints.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@
using Bunkum.Protocols.Http;
using Refresh.Core.Authentication.Permission;
using Refresh.Core.Configuration;
using Refresh.Core.Helpers;
using Refresh.Core.Importing;
using Refresh.Core.RateLimits.Photos;
using Refresh.Core.Services;
using Refresh.Core.Types.Assets.Validation;
using Refresh.Core.Types.Data;
using Refresh.Database;
using Refresh.Database.Models;
Expand All @@ -26,7 +29,7 @@ public class PhotoEndpoints : EndpointGroup
[RequireEmailVerified]
[RateLimitSettings(300, 30, 240, "upload-photo")]
public Response UploadPhoto(RequestContext context, SerializedPhoto body, GameDatabaseContext database,
GameUser user, IDataStore dataStore,
GameUser user, IDataStore dataStore, AssetImporter importer,
DataContext dataContext, AipiService aipi, GameServerConfig config)
{
if (user.IsWriteBlocked(config))
Expand All @@ -48,15 +51,6 @@ public Response UploadPhoto(RequestContext context, SerializedPhoto body, GameDa
return Unauthorized;
}
}

if (!dataStore.ExistsInStore(body.SmallHash) ||
!dataStore.ExistsInStore(body.MediumHash) ||
!dataStore.ExistsInStore(body.LargeHash) ||
!dataStore.ExistsInStore(body.PlanHash))
{
database.AddErrorNotification("Photo upload failed", "The required assets were not available.", user);
return BadRequest;
}

if (body.PhotoSubjects.Count > 4)
{
Expand All @@ -79,13 +73,69 @@ public Response UploadPhoto(RequestContext context, SerializedPhoto body, GameDa
return BadRequest;
}

List<string> hashes = [body.LargeHash, body.MediumHash, body.SmallHash];
foreach (string hash in hashes.Distinct())
// Plan
// TODO validate content
AssetValidationParameters planParams = new(body.PlanHash, dataContext, importer)
{
GameAsset? gameAsset = dataContext.Cache.GetAssetInfo(hash, database);
if(gameAsset == null) continue;
if (aipi != null && aipi.ScanAndHandleAsset(dataContext, gameAsset))
return Unauthorized;
MayBeBlank = false,
MayBeGuid = false,
AssetContextTypeStr = "metadata asset",
};
ValidatedAssetResult planResult = ResourceValidationHelper.ValidateReference(planParams, context.Logger);
body.PlanHash = planResult.NewAssetRef;

if (planResult.Status != OK)
{
if (planResult.ErrorMessage != null) database.AddErrorNotification("Photo upload failed", planResult.ErrorMessage, user);
return planResult.Status;
}
// should never be null at this point, but let's just be extra safe
else if (planResult.AssetInfo != null && planResult.AssetInfo.AssetType != GameAssetType.Plan)
{
database.AddErrorNotification("Photo upload failed", "The metadata asset was badly formatted.", user);
return BadRequest;
}

// Don't just iterate because we might eventually want to go further and also validate each format's type
// (e.g. for mainline, small and medium are TEX, while large is JPEG), see https://github.com/LittleBigRefresh/Refresh/issues/977
// Also thinking of dropping the callback param because it's useless after all...
// Small image
AssetValidationParameters imageParams = new(body.SmallHash, dataContext, importer, aipi)
{
MayBeBlank = false,
MayBeGuid = false,
MustBeTexture = true,
AssetContextTypeStr = "image",
};
ValidatedAssetResult imageResult = ResourceValidationHelper.ValidateReference(imageParams, context.Logger);
body.SmallHash = imageResult.NewAssetRef;

if (imageResult.Status != OK)
{
if (imageResult.ErrorMessage != null) database.AddErrorNotification("Photo upload failed", imageResult.ErrorMessage, user);
return imageResult.Status;
}

// Medium image
imageParams.AssetRef = body.MediumHash;
imageResult = ResourceValidationHelper.ValidateReference(imageParams, context.Logger);
body.MediumHash = imageResult.NewAssetRef;

if (imageResult.Status != OK)
{
if (imageResult.ErrorMessage != null) database.AddErrorNotification("Photo upload failed", imageResult.ErrorMessage, user);
return imageResult.Status;
}

// Large image
imageParams.AssetRef = body.LargeHash;
imageResult = ResourceValidationHelper.ValidateReference(imageParams, context.Logger);
body.LargeHash = imageResult.NewAssetRef;

if (imageResult.Status != OK)
{
if (imageResult.ErrorMessage != null) database.AddErrorNotification("Photo upload failed", imageResult.ErrorMessage, user);
return imageResult.Status;
}

GameLevel? level = body.Level == null ? null : database.GetLevelByIdAndType(body.Level.Type, body.Level.LevelId);
Expand Down
184 changes: 155 additions & 29 deletions RefreshTests.GameServer/Tests/Photos/PhotoEndpointsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
using Refresh.Database.Models;
using System.Text;
using System.Net;
using Refresh.Database.Models.Assets;

namespace RefreshTests.GameServer.Tests.Photos;

Expand All @@ -33,14 +34,19 @@ public void UploadAndDeletePhoto()
HttpResponseMessage message = client.PostAsync($"/lbp/upload/{TEST_ASSET_HASH}", new ReadOnlyMemoryContent(TestAsset)).Result;
Assert.That(message.StatusCode, Is.EqualTo(OK));

//Upload out """plan"""
ReadOnlySpan<byte> planData = "PLNb"u8;
string planHash = BitConverter.ToString(SHA1.HashData(planData)).Replace("-", "").ToLower();
context.GetDataStore().WriteToStore(planHash, planData);

SerializedPhoto photo = new()
{
Timestamp = DateTimeOffset.UtcNow.ToUnixTimeSeconds(),
AuthorName = user.Username,
SmallHash = TEST_ASSET_HASH,
MediumHash = TEST_ASSET_HASH,
LargeHash = TEST_ASSET_HASH,
PlanHash = TEST_ASSET_HASH,
PlanHash = planHash,
Level = new SerializedPhotoLevel
{
LevelId = level.LevelId,
Expand Down Expand Up @@ -103,6 +109,12 @@ public void UploadPhotoAndValidateAttributes()
HttpResponseMessage message = client.PostAsync($"/lbp/upload/{TEST_ASSET_HASH}", new ReadOnlyMemoryContent(TestAsset)).Result;
Assert.That(message.StatusCode, Is.EqualTo(OK));
DateTimeOffset takenAt = context.Time.Now;

//Upload out """plan"""
ReadOnlySpan<byte> planData = "PLNb"u8;
string planHash = BitConverter.ToString(SHA1.HashData(planData)).Replace("-", "").ToLower();
context.GetDataStore().WriteToStore(planHash, planData);

context.Time.TimestampMilliseconds += 2000; // Increase to differentiate between creation and publish date

SerializedPhoto photo = new()
Expand All @@ -112,7 +124,7 @@ public void UploadPhotoAndValidateAttributes()
SmallHash = TEST_ASSET_HASH,
MediumHash = TEST_ASSET_HASH,
LargeHash = TEST_ASSET_HASH,
PlanHash = TEST_ASSET_HASH,
PlanHash = planHash,
Level = new SerializedPhotoLevel
{
LevelId = level.StoryId,
Expand Down Expand Up @@ -160,7 +172,7 @@ public void UploadPhotoAndValidateAttributes()
Assert.That(gamePhoto!.SmallAssetHash, Is.EqualTo(TEST_ASSET_HASH));
Assert.That(gamePhoto!.MediumAssetHash, Is.EqualTo(TEST_ASSET_HASH));
Assert.That(gamePhoto!.LargeAssetHash, Is.EqualTo(TEST_ASSET_HASH));
Assert.That(gamePhoto!.PlanHash, Is.EqualTo(TEST_ASSET_HASH));
Assert.That(gamePhoto!.PlanHash, Is.EqualTo(planHash));

List<GamePhotoSubject> subjects = context.Database.GetSubjectsInPhoto(gamePhoto).ToList();

Expand All @@ -174,43 +186,147 @@ public void UploadPhotoAndValidateAttributes()
Assert.That(subjects[1].DisplayName, Is.EqualTo("SecretAlt"));
Assert.That(subjects[1].User, Is.Null);
}

[Test]
public void CantUploadPhotoWithMissingAssets()

private void TryUploadPhotosWithInvalidImage(TestContext context, HttpClient client, GameUser user, string invalidHash, HttpStatusCode expectedStatus)
{
using TestContext context = this.GetServer();
GameUser user = context.CreateUser();
GameLevel level = context.CreateLevel(user);
ReadOnlySpan<byte> imageData = "TEX "u8;
string imageHash = BitConverter.ToString(SHA1.HashData(imageData)).Replace("-", "").ToLower();
context.GetDataStore().WriteToStore(imageHash, imageData);

using HttpClient client = context.GetAuthenticatedClient(TokenType.Game, user);

ReadOnlySpan<byte> planData = "PLNb"u8;
string planHash = BitConverter.ToString(SHA1.HashData(planData)).Replace("-", "").ToLower();
context.GetDataStore().WriteToStore(planHash, planData);

// bad small image
SerializedPhoto photo = new()
{
Timestamp = DateTimeOffset.UtcNow.ToUnixTimeSeconds(),
AuthorName = user.Username,
SmallHash = TEST_ASSET_HASH,
MediumHash = TEST_ASSET_HASH,
LargeHash = TEST_ASSET_HASH,
PlanHash = TEST_ASSET_HASH,
SmallHash = invalidHash,
MediumHash = imageHash,
LargeHash = imageHash,
PlanHash = planHash,
Level = new SerializedPhotoLevel
{
LevelId = level.LevelId,
Title = level.Title,
Type = "user",
LevelId = 0,
Title = "",
Type = "pod",
},
PhotoSubjects = new List<SerializedPhotoSubject>
};

HttpResponseMessage message = client.PostAsync($"/lbp/uploadPhoto", new StringContent(photo.AsXML())).Result;
Assert.That(message.StatusCode, Is.EqualTo(expectedStatus));

// bad medium image
photo.SmallHash = imageHash;
photo.MediumHash = invalidHash;

message = client.PostAsync($"/lbp/uploadPhoto", new StringContent(photo.AsXML())).Result;
Assert.That(message.StatusCode, Is.EqualTo(expectedStatus));

// bad large image
photo.MediumHash = imageHash;
photo.LargeHash = invalidHash;

message = client.PostAsync($"/lbp/uploadPhoto", new StringContent(photo.AsXML())).Result;
Assert.That(message.StatusCode, Is.EqualTo(expectedStatus));
}

private void TryUploadPhotoWithInvalidPlan(TestContext context, HttpClient client, GameUser user, string invalidHash, HttpStatusCode expectedStatus)
{
ReadOnlySpan<byte> imageData = "TEX "u8;
string imageHash = BitConverter.ToString(SHA1.HashData(imageData)).Replace("-", "").ToLower();
context.GetDataStore().WriteToStore(imageHash, imageData);

// bad plan
SerializedPhoto photo = new()
{
Timestamp = DateTimeOffset.UtcNow.ToUnixTimeSeconds(),
AuthorName = user.Username,
SmallHash = imageHash,
MediumHash = imageHash,
LargeHash = imageHash,
PlanHash = invalidHash,
Level = new SerializedPhotoLevel
{
new()
{
Username = user.Username,
DisplayName = user.Username,
BoundsList = "1,1,1,1",
},
}
LevelId = 0,
Title = "",
Type = "pod",
},
};

HttpResponseMessage message = client.PostAsync($"/lbp/uploadPhoto", new StringContent(photo.AsXML())).Result;
Assert.That(message.StatusCode, Is.EqualTo(BadRequest));
Assert.That(message.StatusCode, Is.EqualTo(expectedStatus));
}

[Test]
[TestCase("")]
[TestCase("0")]
[TestCase("g1087")]
[TestCase("g18451")]
public void RejectPhotosWithNonHashAssets(string invalidHash)
{
using TestContext context = this.GetServer();
GameUser user = context.CreateUser();
using HttpClient client = context.GetAuthenticatedClient(TokenType.Game, user);

this.TryUploadPhotosWithInvalidImage(context, client, user, invalidHash, BadRequest);
this.TryUploadPhotoWithInvalidPlan(context, client, user, invalidHash, BadRequest);
}

[Test]
public void CantUploadPhotoWithMissingAssets()
{
using TestContext context = this.GetServer();
GameUser user = context.CreateUser();
using HttpClient client = context.GetAuthenticatedClient(TokenType.Game, user);

ReadOnlySpan<byte> badImageData = "TEX m"u8;
string badImageHash = BitConverter.ToString(SHA1.HashData(badImageData)).Replace("-", "").ToLower();
// Don't add to store

ReadOnlySpan<byte> badPlanData = "PLNb m"u8;
string badPlanHash = BitConverter.ToString(SHA1.HashData(badPlanData)).Replace("-", "").ToLower();
// Don't add to store

this.TryUploadPhotosWithInvalidImage(context, client, user, badImageHash, NotFound);
this.TryUploadPhotoWithInvalidPlan(context, client, user, badPlanHash, NotFound);
}

[Test]
public void CantUploadPhotoWithDisallowedAssets()
{
using TestContext context = this.GetServer();
GameUser user = context.CreateUser();
using HttpClient client = context.GetAuthenticatedClient(TokenType.Game, user);

ReadOnlySpan<byte> badImageData = "TEX d"u8;
string badImageHash = BitConverter.ToString(SHA1.HashData(badImageData)).Replace("-", "").ToLower();
context.GetDataStore().WriteToStore(badImageHash, badImageData);
context.Database.DisallowAsset(badImageHash, GameAssetType.Texture, "");

ReadOnlySpan<byte> badPlanData = "PLNb m"u8;
string badPlanHash = BitConverter.ToString(SHA1.HashData(badPlanData)).Replace("-", "").ToLower();
context.GetDataStore().WriteToStore(badPlanHash, badPlanData);
context.Database.DisallowAsset(badPlanHash, GameAssetType.Plan, "");

this.TryUploadPhotosWithInvalidImage(context, client, user, badImageHash, Unauthorized);
this.TryUploadPhotoWithInvalidPlan(context, client, user, badPlanHash, Unauthorized);
}

[Test]
public void CantUploadPhotoWithInvalidAssets()
{
using TestContext context = this.GetServer();
GameUser user = context.CreateUser();
using HttpClient client = context.GetAuthenticatedClient(TokenType.Game, user);

ReadOnlySpan<byte> meshData = "MSHb"u8;
string meshHash = BitConverter.ToString(SHA1.HashData(meshData)).Replace("-", "").ToLower();
context.GetDataStore().WriteToStore(meshHash, meshData);

this.TryUploadPhotosWithInvalidImage(context, client, user, meshHash, BadRequest);
this.TryUploadPhotoWithInvalidPlan(context, client, user, meshHash, BadRequest);
}

[Test]
Expand All @@ -226,14 +342,19 @@ public void CantUploadPhotoWithTooManySubjects()
HttpResponseMessage message = client.PostAsync($"/lbp/upload/{TEST_ASSET_HASH}", new ReadOnlyMemoryContent(TestAsset)).Result;
Assert.That(message.StatusCode, Is.EqualTo(OK));

//Upload out """plan"""
ReadOnlySpan<byte> planData = "PLNb"u8;
string planHash = BitConverter.ToString(SHA1.HashData(planData)).Replace("-", "").ToLower();
context.GetDataStore().WriteToStore(planHash, planData);

SerializedPhoto photo = new()
{
Timestamp = DateTimeOffset.UtcNow.ToUnixTimeSeconds(),
AuthorName = user.Username,
SmallHash = TEST_ASSET_HASH,
MediumHash = TEST_ASSET_HASH,
LargeHash = TEST_ASSET_HASH,
PlanHash = TEST_ASSET_HASH,
PlanHash = planHash,
Level = new SerializedPhotoLevel
{
LevelId = level.LevelId,
Expand Down Expand Up @@ -338,14 +459,19 @@ public void CantDeleteOthersPhoto()
HttpResponseMessage message = client1.PostAsync($"/lbp/upload/{TEST_ASSET_HASH}", new ReadOnlyMemoryContent(TestAsset)).Result;
Assert.That(message.StatusCode, Is.EqualTo(OK));

//Upload out """plan"""
ReadOnlySpan<byte> planData = "PLNb"u8;
string planHash = BitConverter.ToString(SHA1.HashData(planData)).Replace("-", "").ToLower();
context.GetDataStore().WriteToStore(planHash, planData);

SerializedPhoto photo = new()
{
Timestamp = DateTimeOffset.UtcNow.ToUnixTimeSeconds(),
AuthorName = user1.Username,
SmallHash = TEST_ASSET_HASH,
MediumHash = TEST_ASSET_HASH,
LargeHash = TEST_ASSET_HASH,
PlanHash = TEST_ASSET_HASH,
PlanHash = planHash,
Level = new SerializedPhotoLevel
{
LevelId = level.LevelId,
Expand Down
Loading