Vector35 / Vector35/binaryninja-api

Include original file name/path in bndb metadata created under projects

Open
#7,074 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component: Projects Effort: Low Impact: Low
Dominant language
C++
Stars
1.3k
Forks
298
Avg merge
5d 5h
Merged PRs (30d)
19

Description

What is the feature you'd like to have?
Original file path/name to be included in metadata for a bndb under a project, something like bv.file.project_file.original_name or something discerning between the uuid project names and the file path of the binary being analyzed

Is your feature request related to a problem?
Plugins will reference the original path to the binary being worked on via bv.file.original_name, this functionality completely breaks when operating within a project.

bncov for example will fail to run when operating within a project becuase of this:
https://github.com/ForAllSecure/bncov/blob/master/coverage.py#L26

Are any alternative solutions acceptable?
N/A

Additional Information:
For example, in a binja-test-proj project, if you were to import /tmp/test.so then start reversing and save the bndb, you would end up with a test.bndb, you can use bv.file.project_file.name to get test.bndb. There is currently no way from the bndb to obtain the path of the original binary being analyzed at /tmp/test.so

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the project-file metadata exposed through bv.file.project_file.name and compare it with bv.file.original_name; the issue's bncov coverage.py example shows the broken consumer. Trace how a project-created bndb stores and exposes metadata. Done means a project bndb provides the original binary path or name distinctly from its UUID-based project file name.

Written by the indexing model from the issue text.

Assessment

Domain
reverse-engineering
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.