FileSignatures 7.0.0

.NET 8.0 .NET Standard 2.0

dotnet add package FileSignatures --version 7.0.0

NuGet\Install-Package FileSignatures -Version 7.0.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="FileSignatures" Version="7.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="FileSignatures" Version="7.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="FileSignatures" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add FileSignatures --version 7.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: FileSignatures, 7.0.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package FileSignatures@7.0.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=FileSignatures&version=7.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=FileSignatures&version=7.0.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

FileSignatures

A small library for detecting the type of a file based on header signature (also known as magic number) rather than file extension. It is designed with extensibility in mind, so that recognised formats can be added easily.

How do I install it?

FileSignatures is available on NuGet, so can be installed via the Package Manager:

Install-Package FileSignatures

How do I use it?

Create an instance of the FileFormatInspector class, then pass it a stream to your file:

var inspector = new FileFormatInspector();
var format = inspector.DetermineFileFormat(stream);

This will return a FileFormat instance which contains the signature and media type of the recognised format, or null if a matching format could not be determined.

How do I register it with a dependency injection container?

You can either register an instance calling the empty constructor which will register all formats in the FileSignatures assembly:

services.AddSingleton<IFileFormatInspector>(new FileFormatInspector());

Or use FileFormatLocator to scan for the formats you are interested in then pass that to the constructor of FileFormatInspector and register that instance:

var recognised = FileFormatLocator.GetFormats().OfType<Image>();
var inspector = new FileFormatInspector(recognised);
services.AddSingleton<IFileFormatInspector>(inspector);

In this example, only formats which derive from Image (jpg, tiff, bmp, etc.) will be detected. Anything else will be ignored.

How do I check for a type of file?

Because the formats are defined as a type hierarchy, you can either check for a specific type if you want to work with a particular format, or the base type if you are interested in multiple formats.

var format = inspector.DetermineFileFormat(stream);

if(format is Pdf) {
  // Just matches Pdf
}

if(format is OfficeOpenXml) {
  // Matches Word, Excel, Powerpoint
}

if(format is Image) {
  // Matches any image format
}

See the examples for a sample web application and a console application which demonstrate how to filter uploads by a particular format and retrieve the signature details for a file.

What formats are recognised?

Currently, the following formats are built-in:

Name	Media-Type	Extension
3GPP	video/3gpp	.3gp
Bitmap	image/bmp	.bmp
Excel	application/vnd.openxmlformats-officedocument.spreadsheetml.sheet	.xlsx
Excel 97-2003	application/vnd.ms-excel	.xls
Exe (Windows)	application/octet-stream	.exe
GIF	image/gif	.gif
JPEG	image/jpeg	.jpg
MP4	video/mp4	.mp4
Open Document Presentation	application/vnd.oasis.opendocument.presentationn	.odp
Open Document Spreadhseet	application/vnd.oasis.opendocument.spreadsheet	.ods
Open Document Text	application/vnd.oasis.opendocument.text	.odt
Outlook Message	application/vnd.ms-outlook	.msg
PDF	application/pdf	.pdf
PNG	image/png	.png
PowerPoint	application/vnd.openxmlformats-officedocument.presentationml.presentation	.pptx
Powerpoint 97-2003	application/vnd.ms-powerpoint	.ppt
QuickTime	video/quicktime	.mov
Rich Text Format	application/rtf	.rtf
TIFF	image/tiff	.tif
Visio	application/vnd.visio	.vsdx
Visio 97-2003	application/vnd.visio	.vsd
Webp	image/webp	.webp
Word	application/vnd.openxmlformats-officedocument.wordprocessingml.document	.docx
Word template	application/vnd.openxmlformats-officedocument.wordprocessingml.template	.dotx
Word 97-2003	application/msword	.doc
Xps	application/vnd.ms-xpsdocument	.xps
Zip	application/zip	.zip

How do I add additional formats?

Create a new class (or many classes) which inherit from FileFormat to implement a custom format. Next, pass a collection of recognised formats to the constructor of FileFormatInspector, being sure to include your custom format.

The FileFormatLocator class can be used to load all custom formats located within an assembly:

var assembly = typeof(CustomFileFormat).GetTypeInfo().Assembly;

// Just the formats defined in the assembly containing CustomFileFormat
var customFormats = FileFormatLocator.GetFormats(assembly);

// Formats defined in the assembly and all the defaults
var allFormats = FileFormatLocator.GetFormats(assembly, true);

Using this method, you can continue to create custom formats and they will automatically be included into the recognised formats without any additional configuration.

What is the licence?

This project is licensed under the MIT license.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 is compatible.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- OpenMcdf (>= 3.1.0)
- System.Reflection.TypeExtensions (>= 4.3.0)
.NETStandard 2.1
- OpenMcdf (>= 3.1.0)
- System.Reflection.TypeExtensions (>= 4.3.0)
net10.0
- OpenMcdf (>= 3.1.0)
net8.0
- OpenMcdf (>= 3.1.0)
net9.0
- OpenMcdf (>= 3.1.0)

NuGet packages (14)

Showing the top 5 NuGet packages that depend on FileSignatures:

Package	Downloads
HanaTech.Framework.MvcFunction Package Description	358.6K
Util.FileStorage Util.FileStorage是Util应用框架文件存储操作基础类库	115.7K
CL.Common.Business Package Description	50.0K
ThePensionsRegulator.GovUk.Frontend Based on the GOV.UK Design System and GovUk.Frontend.AspNetCore. Adds extra features and components.	46.4K
Senro.AspNetCore.Tools Commonly used codes in Asp.net Core projects in the form of tools	14.7K

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on FileSignatures:

Repository	Stars
dotnetcore/Util Util是一个.Net平台下的应用框架，旨在提升中小团队的开发能力，由工具类、分层架构基类、Ui组件，配套代码生成模板，权限等组成。	4.6K

Version	Downloads	Last Updated
7.0.0	841	2/25/2026
6.1.1	206,532	9/30/2025
6.1.0	24,906	9/7/2025
6.0.0	38,248	8/1/2025
5.3.0	12,559	7/29/2025
5.2.0	151,758	5/21/2025
5.2.0-rc1	251	5/20/2025
5.1.1	320,863	11/29/2024
5.1.1-rc3	220	11/27/2024
5.1.1-rc2	238	11/26/2024
5.1.0	236,997	9/13/2024
5.0.2	289,714	6/22/2024
5.0.1	67,306	5/29/2024
4.4.1	674,463	10/4/2023
4.4.0	931,189	9/15/2022
4.3.1	186,478	5/15/2022
4.3.0	222,550	2/20/2022

https://github.com/neilharvey/FileSignatures/releases

FileSignatures 7.0.0

FileSignatures

How do I install it?

How do I use it?

How do I register it with a dependency injection container?

How do I check for a type of file?

What formats are recognised?

How do I add additional formats?

What is the licence?

.NETStandard 2.0

.NETStandard 2.1

net10.0

net8.0

net9.0

NuGet packages (14)

GitHub repositories (1)