Skip to main content

A library for identifying files form their magic byte signature.

Project description

pyfsig

A python library for identifying files by headers (magic bytes). You may notice that on MS windows systems files will not open properly if you change the file extension, this is becuase MS windows only pays attention to the file header. Magic bytes/file headers serve as a way to discover the type of file without using the file extension. This library was written to assist python programmers in identifying what type of file something is from its magic bytes/file header. It was originally written by the author to reconstruct BLOB's from a legacy database which did not store the original file extensions.

based on info from: 'Wikipedia - List of file signatures'

Usage

The libraries use should fairly self explainatory, here are some examples:

Find matches for a file when you have the file path

file_path = "some/file/path.abc"
matches = find_matches_for_file_path(file_path=file_path)

Find matches for a file header you have read yourself

[!IMPORTANT] The "rb" here is very important, you must read the file as "bytes"!

with open(file_path, "rb") as f:
    file_header = f.read(32)
matches = find_matches_for_file_header(header=file_header)

Find matches against your own list of file signatures

You will need to create a FileSignatureDict with atleast the following keys:

  • file_extension
  • hex
  • offset
custom_signatures = [
    {
        "file_extension": "abc",
        "hex": [1, 2, 3, None, 5],
        "offset": 0,
    }
]

file_path = "some/file/path.abc"
matches = find_matches_for_file_path(file_path=file_path, signatures=custom_signatures)

Alternatively, you can extend the built in file signatures with your custom file signatures.

from pyfsig import SIGNATURES

extended_signatures = [
    *SIGNATURES,
    {
        "file_extension": "abc",
        "hex": [1, 2, 3, None, 5],
        "offset": 0,
    }
]

file_path = "some/file/path.abc"
matches = find_matches_for_file_path(file_path=file_path, signatures=extended_signatures)

Contributors

Author: Patty C (schlerp)

GitHub Contributors Image

Thanks to all contributors!!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyfsig-1.1.1.tar.gz (41.3 kB view details)

Uploaded Source

Built Distribution

pyfsig-1.1.1-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file pyfsig-1.1.1.tar.gz.

File metadata

  • Download URL: pyfsig-1.1.1.tar.gz
  • Upload date:
  • Size: 41.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.6.10

File hashes

Hashes for pyfsig-1.1.1.tar.gz
Algorithm Hash digest
SHA256 1f9eddf1b8142285d2192645dc0e768dd1276ba9a7ae4984e41cd32720381ce4
MD5 e7c3cfaf248d9a5fa4e787598fa154f2
BLAKE2b-256 4e6f51deb68ed9fe45dea956c787f475000b8803abe86e6a6556ca22f48ca88b

See more details on using hashes here.

File details

Details for the file pyfsig-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: pyfsig-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.6.10

File hashes

Hashes for pyfsig-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c2e09c8a92502995338b6574978eebd8a096e56c8ea99fc296e8b78c78b4f458
MD5 12d61510a880dc567859b95f97ed0595
BLAKE2b-256 887c84908a696012d80a69fac0205c08a85797f3c9c94107fe30504eaaa538a0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page