如何在ASP.NET Core中验证文件上传扩展名

摘录

在这篇文章中，我们将了解如何验证文件上传扩展名，并确保我们的应用程序免受恶意上传的威胁。

原文 How to Validate File Upload Extensions in ASP.NET Core

在这篇文章中，我们将看看如何验证文件上传扩展名并确保我们的应用程序免受恶意上传的威胁。

当接收用户上传的文件时，仅依靠文件名来确定文件类型是存在风险的。这是因为通过替换其扩展名可以轻松伪造文件类型。因此，我们需要一个更可靠的验证方法。

要下载本文的源代码，您可以访问我们的 GitHub仓库。

什么是文件签名？

文件签名，也称为魔术数字，是文件开头的唯一字节序列。与易于被用户操纵的文件名不同，文件签名提供了一个独特的指纹，允许我们确定文件的真实性质。

创建一个项目来验证文件上传扩展名

我们的目标是创建一个基本系统，用于上传图像和PDF文件，并通过两步进行验证：

使用上传文件的文件扩展名确定它是否属于可接受的格式，PDF或图像
验证该文件是否确实与其扩展名指示的类型相对应。如果第一步成功，我们将执行此过程

创建初始项目

让我们使用Visual Studio创建一个新的Web API，指定项目名称和目标框架。确保保持‘使用控制器’选项被选中，因为我们将使用标准控制器，而不是 Minimal APIs.

添加我们的主要类

接下来，我们需要定义一个名为 FileFormatDescriptor 的抽象类，它将作为特定文件类型实现的基类：

public abstract class FileFormatDescriptor
{
    protected FileFormatDescriptor()
    {
        Initialize();
        MaxMagicNumberLength = MagicNumbers.Max(m => m.Length);
    }
    protected abstract void Initialize();
    protected HashSet<string> Extensions { get; } = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
    protected List<byte[]> MagicNumbers { get; } = [];
    protected int MaxMagicNumberLength { get; }
    protected string TypeName { get; set; }
    public bool IsIncludedExtention(string extention) => Extensions.Contains(extention);
    public Result Validate(IFormFile file)
    {
        using var stream = file.OpenReadStream();
        Span<byte> initialBytes = stackalloc byte[MaxMagicNumberLength];
        int Readbytes = stream.Read(initialBytes);
        foreach (var magicNumber in MagicNumbers)
        {
            if (initialBytes[..magicNumber.Length].SequenceCompareTo(magicNumber) == 0)
            {
                return new Result(true, Status.GENUINE, $"{Status.GENUINE} {TypeName}");
            }
        }
        return new Result(false, Status.FAKE, $"{Status.FAKE} {TypeName}!");
    }
}

在我们的类中，我们有Extensions和MagicNumbers属性，分别存储支持的文件扩展名及其相应的文件签名。

Validate()方法将负责执行验证。它以IFormFile类对象作为输入。在该方法中，我们打开一个流，提取初始字节，然后将它们与存储的签名进行比较以验证文件签名。

由于大多数文件格式的签名长度相对较短，通常不超过16个字节，我们将它们读入使用 stackalloc 创建的 Span 中。如果字节需求超过合理长度，例如256个字节，我们需要使用 ArrayPool 或其他适当方法来为我们的字节缓冲区。

请注意，由于不同文件类型可能具有不同长度的签名，例如PNG和JPG图像文件的情况，我们需要读取到存储在MagicNumbers数组中的签名的最大长度的字节，以可能匹配存储的任何签名。

现在，我们需要一个简单的record来保存验证方法的结果，表明文件是否可接受，以及合适的消息：

public record Result(bool Acceptable, Status Status, string Message);

接下来，我们定义两个类，Pdf 和 Image，它们继承自抽象类 FileFormatDescriptor。每个类代表我们系统中支持的一个文件格式。我们将使用它们各自的扩展名和签名初始化这些类。

让我们从 Pdf 类开始：

public class Pdf : FileFormatDescriptor
{
    protected override void Initialize()
    {
        TypeName = "PDF FILE";
        Extensions.Add(".pdf");
        MagicNumbers.Add([0x25, 0x50, 0x44, 0x46]);
    }
}

然后，我们将继续添加 Image 类：

public class Image : FileFormatDescriptor
{
    protected override void Initialize()
    {
        TypeName = "IMAGE FILE";
        Extensions.UnionWith([".jpeg", ".jpg", ".png"]);
        MagicNumbers.AddRange(new byte[][]
        {
             [0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A],
             [0xFF, 0xD8, 0xFF, 0xE0],
             [0xFF, 0xD8, 0xFF, 0xE1],
             [0xFF, 0xD8, 0xFF, 0xE2],
             [0xFF, 0xD8, 0xFF, 0xE3]
        });
    }
}

鉴于我们的系统在图像格式上有一定的容忍度，我们将JPG和PNG格式合并为一个类。然而，我们可以将每个图像格式分解成单独的类。

实现我们的验证器静态类

现在，让我们通过创建一个静态类来集中我们的验证过程，该类维护允许的类型类列表并使用它们各自的Validate()方法：

public static class FileValidator
{
    private static readonly List<FileFormatDescriptor> AllowedFormats = [new Image(), new Pdf()];
    public static Result Validate(IFormFile file)
    {
        var fileExtension = Path.GetExtension(file.FileName);
        var targetType = AllowedFormats.FirstOrDefault(x => x.IsIncludedExtention(fileExtension));
        if (targetType is null)
        {
            return new Result(false, Status.NOT_SUPPORTED, $"{Status.NOT_SUPPORTED}");
        }
        return targetType.Validate(file);
    }
}

验证从提取上传文件的扩展名开始，然后通过在AllowedFormats列表中寻找匹配的扩展名来确定假定的文件类型。如果没有找到相应的扩展名，我们简单地返回一个响应，表示不支持该文件类型。否则，我们将file传递给targetType实例的Validate()方法以验证文件的内容是否符合预期的格式。

添加一个上传端点

为了准备验证上传的文件，我们必须有一个调用它的动作。因此，让我们定义UploadController，它将运用我们的FileValidator：

[Route("api/[controller]")]
[ApiController]
public class UploadController : ControllerBase
{
    [HttpPost]
    public IActionResult Upload(IFormFile file)
    {
        var result = FileValidator.Validate(file);
        return result.Acceptable ? Ok(result) : BadRequest(result);
    }
}

使用Postman测试

让我们验证我们的代码是否按预期工作。因为我们创建了一个Web API，我们将使用Postman来测试。

我们创建一个新的POST请求，选择form-data选项。最后，我们将添加一个键值对，其中键对应于控制器中的IFormFile参数的名称，值代表文件本身。

让我们从上传一个伪造的PNG文件开始：

伪造的图像文件

响应表明上传的文件不可接受，我们的消息属性为我们提供了一个更易读的解释。

现在，让我们通过上传一个PDF文件来继续我们的测试：

真实的pdf文件

最后，我们将尝试上传一个不支持的文件类型，即Word文档：

不支持的文件类型

很好，结果符合我们的预期。现在，在这个成功的基础上，我们可以通过实现操作过滤器来增强我们的解决方案，详见我们的文章在ASP.Net Core中验证上传文件的不同方式。

结论

在这篇文章中，我们学习了如何在.NET应用中验证文件上传扩展名。我们在系统中使用了文件签名，作为一种简单而有效的安全增强方法。尽管它很简单，但这种方法为我们的软件增加了一层额外的保护，使其更加安全，抵御潜在威胁。