Українська
Безпечні завантаження
Крок 1. Що надсилає клієнт
Навіщо. Завантаження надходить до API як запит multipart із потоком байтів, назвою файлу, типом носія й довжиною. Усі чотири значення походять від клієнта, тож жодному не можна довіряти: назва може містити ../, тип носія може заявляти image/png для сторінки HTML, а довжина може бути брехнею. Бізнес-рівень отримує їх в одному записі без жодного типу ASP.NET Core, тому сервіси лишаються незалежними від HTTP і їх легко тестувати з MemoryStream.
Що зробити.
cs
namespace Chatex.Core.Common;
/// <summary>A file sent by a client. <see cref="Length"/> is what the client claims; the content is still capped while reading.</summary>
public sealed record FileUpload(Stream Content, string FileName, string ContentType, long Length);Крок 2. Потік, що забезпечує обмеження
Навіщо. Перевірка Length > limit – добрий перший фільтр, але клієнт може надіслати Length = 1000, а потім передати гігабайт. Єдине надійне обмеження – рахувати байти під час читання і зупинитися, щойно межу перевищено. Це робить декоратор: потік, що обгортає інший потік, пропускає крізь себе кожне читання й веде лік.
Що зробити.
cs
namespace Chatex.Core.Common;
/// <summary>Thrown by <see cref="LimitedReadStream"/> once more than the allowed number of bytes was read.</summary>
internal sealed class FileTooLargeException() : IOException("The file is larger than allowed.");
/// <summary>
/// Read-only wrapper that fails once the inner stream yields more than <paramref name="maxBytes"/>,
/// so a client cannot get past a size limit by lying about the length.
/// </summary>
internal sealed class LimitedReadStream(Stream inner, long maxBytes) : Stream
{
private long _read;
public override bool CanRead => true;
public override bool CanSeek => false;
public override bool CanWrite => false;
public override long Length => throw new NotSupportedException();
public override long Position
{
get => _read;
set => throw new NotSupportedException();
}
public override int Read(byte[] buffer, int offset, int count) => Read(buffer.AsSpan(offset, count));
public override int Read(Span<byte> buffer) => Count(inner.Read(buffer));
public override async ValueTask<int> ReadAsync(Memory<byte> buffer, CancellationToken cancellationToken = default) =>
Count(await inner.ReadAsync(buffer, cancellationToken));
public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) =>
ReadAsync(buffer.AsMemory(offset, count), cancellationToken).AsTask();
public override void Flush()
{
}
public override long Seek(long offset, SeekOrigin origin) => throw new NotSupportedException();
public override void SetLength(long value) => throw new NotSupportedException();
public override void Write(byte[] buffer, int offset, int count) => throw new NotSupportedException();
private int Count(int read)
{
_read += read;
return _read > maxBytes ? throw new FileTooLargeException() : read;
}
}LimitedReadStreamуспадковує абстрактнийStreamі обгортаєinner. Підтримується лише читання:CanSeekіCanWriteдорівнюютьfalse, а члени, що не мають сенсу, кидаютьNotSupportedException, як того вимагає контрактStream.- Усі методи читання завершуються викликом
Count: синхроннийRead, перевантаженняSpanіMemoryта старийReadAsyncна основі масиву. Якби перевизначити лише один із них, лишився б обхідний шлях повз обмеження, аджеCopyToAsyncможе викликати будь-який. Countдодає щойно прочитані байти й кидаєFileTooLargeException, щойно сума перевищить межу. Виняток успадковуєIOException– звичайний тип для збоїв потоків; вінinternal, тож його перехоплює лише Chatex.Core.Positionповертає кількість байтів, прочитаних на цей момент: після копіювання це справжній розмір файлу, а не заявлений. Саме це використовує сервіс вкладень із теми 11.- Клас винятку використовує первинний конструктор, що передає повідомлення базовому класу:
class FileTooLargeException() : IOException("…").
Крок 3. Сховище аватарів
Навіщо. І в користувачів, і в чатів (тема 10) є аватари з однаковими правилами: JPEG, PNG або WebP, не більше 5 МБ. Невеликий клас тримає ці правила в одному місці, зберігає зображення через IFileStorage (тема 5) і видаляє замінені зображення.
Що зробити.
cs
using Chatex.Data.Abstractions;
namespace Chatex.Core.Common;
/// <summary>Limits for avatar images, public so the Api can cap request bodies to match.</summary>
public static class AvatarLimits
{
public const long MaxBytes = 5 * 1024 * 1024;
}
/// <summary>Validates and stores avatar images for users and chats.</summary>
internal sealed class AvatarStore(IFileStorage storage)
{
public const long MaxBytes = AvatarLimits.MaxBytes;
private static readonly HashSet<string> AllowedContentTypes = new(StringComparer.OrdinalIgnoreCase)
{
"image/jpeg",
"image/png",
"image/webp",
};
public static Error InvalidType { get; } =
Error.Validation("contentType", "avatar_invalid_type", "Avatars must be JPEG, PNG or WebP images.");
public static Error TooLarge { get; } =
Error.Validation("file", "avatar_too_large", $"Avatars must be at most {MaxBytes / (1024 * 1024)} MB.");
/// <summary>Stores the image and returns its storage path.</summary>
public async Task<Result<string>> SaveAsync(FileUpload upload, CancellationToken cancellationToken)
{
if (!AllowedContentTypes.Contains(upload.ContentType))
{
return InvalidType;
}
if (upload.Length > MaxBytes)
{
return TooLarge;
}
try
{
return await storage.SaveAsync(new LimitedReadStream(upload.Content, MaxBytes), cancellationToken);
}
catch (FileTooLargeException)
{
return TooLarge;
}
}
/// <summary>Deletes a replaced avatar. Called after the database no longer points at it.</summary>
public Task DeleteAsync(string? storagePath, CancellationToken cancellationToken) =>
storagePath is null ? Task.CompletedTask : storage.DeleteAsync(storagePath, cancellationToken);
}AvatarLimitsє публічним, щоб API могло обмежити тіло запиту тими самими 5 МБ ще до того, як у сервіс потрапить хоч один байт (тема 13). СамAvatarStoreмає модифікаторinternal.- Дозволені типи – це
HashSet<string>з порівнювачем без урахування регістру:image/PNGприймається,image/svg+xml– ні. Зображення SVG можуть містити скрипти, тому їх навмисно немає. SaveAsyncперевіряє в порядку вартості: заявлений тип, заявлена довжина, а потім справжня довжина під час збереження черезLimitedReadStream. Файл, що виявився завеликим, стає тією самою помилкоюavatar_too_large, що й файл, який сам про це заявив.DeleteAsyncсервіси викликають після того, як база даних уже не вказує на старий файл. У зворотному порядку невдале збереження залишило б профіль із видаленим аватаром.
Перевірка
dotnet build проходить успішно.