{"id":42642360,"url":"https://github.com/schlerp/pyfsig","last_synced_at":"2026-01-29T06:17:46.016Z","repository":{"id":46149893,"uuid":"83001449","full_name":"schlerp/pyfsig","owner":"schlerp","description":"python file signature identifier - Use this to identify files from their headers","archived":false,"fork":false,"pushed_at":"2025-03-29T02:51:44.000Z","size":179,"stargazers_count":43,"open_issues_count":3,"forks_count":12,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-29T03:23:12.708Z","etag":null,"topics":["file-signature","magic-bytes","python","python-lib","python-library"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/schlerp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-24T04:32:57.000Z","updated_at":"2025-03-29T02:51:25.000Z","dependencies_parsed_at":"2024-02-28T08:33:08.763Z","dependency_job_id":"e3d0f81a-423f-4da0-84f7-2fc943949b86","html_url":"https://github.com/schlerp/pyfsig","commit_stats":{"total_commits":24,"total_committers":6,"mean_commits":4.0,"dds":"0.33333333333333337","last_synced_commit":"5087a6faeb308e7a564d95b4597b0d842563b019"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/schlerp/pyfsig","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schlerp%2Fpyfsig","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schlerp%2Fpyfsig/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schlerp%2Fpyfsig/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schlerp%2Fpyfsig/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/schlerp","download_url":"https://codeload.github.com/schlerp/pyfsig/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schlerp%2Fpyfsig/sbom","scorecard":{"id":803989,"data":{"date":"2025-08-11","repo":{"name":"github.com/schlerp/pyfsig","commit":"3e884801ab269909fc6a5e404c3255d208005124"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.1,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":3,"reason":"Found 7/23 approved changesets -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":10,"reason":"GitHub workflow tokens follow principle of least privilege","details":["Info: topLevel 'contents' permission set to 'read': .github/workflows/python-publish.yml:16","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/schlerp/pyfsig/python-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-publish.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/schlerp/pyfsig/python-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/schlerp/pyfsig/python-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/schlerp/pyfsig/python-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-publish.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/schlerp/pyfsig/python-publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/python-publish.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/schlerp/pyfsig/python-publish.yml/master?enable=pin","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 18 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T11:17:06.133Z","repository_id":46149893,"created_at":"2025-08-23T11:17:06.133Z","updated_at":"2025-08-23T11:17:06.133Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28865899,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T05:56:06.453Z","status":"ssl_error","status_checked_at":"2026-01-29T05:55:57.668Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["file-signature","magic-bytes","python","python-lib","python-library"],"created_at":"2026-01-29T06:17:45.556Z","updated_at":"2026-01-29T06:17:46.003Z","avatar_url":"https://github.com/schlerp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pyfsig\n\nA python library for identifying files by headers (magic bytes).\nYou may notice that on MS windows systems files will not open properly if you\nchange the file extension, this is becuase MS windows only pays attention to\nthe file header.\nMagic bytes/file headers serve as a way to discover the type of file without\nusing the file extension.\nThis library was written to assist python programmers in identifying what type\nof file something is from its magic bytes/file header.\nIt was originally written by the author to reconstruct BLOB's from a legacy\ndatabase which did not store the original file extensions.\n\nbased on info from: ['Wikipedia - List of file signatures'](https://en.wikipedia.org/wiki/List_of_file_signatures)\n\n## Usage\n\nThe libraries use should fairly self explainatory, here are some examples:\n\n### Find matches for a file when you have the file path\n\n```python\nfile_path = \"some/file/path.abc\"\nmatches = find_matches_for_file_path(file_path=file_path)\n```\n\n### Find matches for a file header you have read yourself\n\n\u003e [!IMPORTANT]\n\u003e The \"rb\" here is very important, you must read the file as \"bytes\"!\n\n```python\nwith open(file_path, \"rb\") as f:\n    file_header = f.read(32)\nmatches = find_matches_for_file_header(header=file_header)\n```\n\n### Find matches against your own list of file signatures\n\nYou will need to create a `FileSignatureDict` with atleast the following keys:\n\n* `file_extension`\n* `hex`\n* `offset`\n\n```python\ncustom_signatures = [\n    {\n        \"file_extension\": \"abc\",\n        \"hex\": [1, 2, 3, None, 5],\n        \"offset\": 0,\n    }\n]\n\nfile_path = \"some/file/path.abc\"\nmatches = find_matches_for_file_path(file_path=file_path, signatures=custom_signatures)\n```\n\nAlternatively, you can extend the built in file signatures with your custom\nfile signatures.\n\n```python\nfrom pyfsig import SIGNATURES\n\nextended_signatures = [\n    *SIGNATURES,\n    {\n        \"file_extension\": \"abc\",\n        \"hex\": [1, 2, 3, None, 5],\n        \"offset\": 0,\n    }\n]\n\nfile_path = \"some/file/path.abc\"\nmatches = find_matches_for_file_path(file_path=file_path, signatures=extended_signatures)\n```\n\n## Contributors\n\nAuthor: Patty C ([schlerp](https://github.com/schlerp))\n\n![GitHub Contributors Image](https://contrib.rocks/image?repo=schlerp/pyfsig)\n\nThanks to all contributors!!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschlerp%2Fpyfsig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fschlerp%2Fpyfsig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschlerp%2Fpyfsig/lists"}