Skip to content

binja: improve Binary Ninja API detection on macOS and Windows#2893

Open
kevinmuoz wants to merge 3 commits intomandiant:masterfrom
kevinmuoz:fix/binja-api-detection
Open

binja: improve Binary Ninja API detection on macOS and Windows#2893
kevinmuoz wants to merge 3 commits intomandiant:masterfrom
kevinmuoz:fix/binja-api-detection

Conversation

@kevinmuoz
Copy link
Copy Markdown

Problem
On macOS and Windows, capa fails to find the Binary Ninja API even when installed at the default location.

Changes

  • Add _is_python_dir / _to_python_dir helpers to accept both root and python-dir layouts
  • Update validate_binaryninja_path to use _to_python_dir
  • Add macOS default path detection: /Applications/Binary Ninja.app/Contents/Resources
  • Add Windows detection via BN_INSTALL_DIR, lastrun, and C:/Program Files/Vector35/BinaryNinja

Tested on

  • macOS M1
  • Windows 10

Closes #2641

Checklist

  • No CHANGELOG update needed
  • No new tests needed
  • No documentation update needed
  • This submission includes AI-generated code and I have provided details in the description.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a critical issue where capa failed to locate the Binary Ninja API on macOS and Windows systems, even when installed in standard locations. The changes introduce robust, platform-specific detection mechanisms and helper functions to correctly identify the Binary Ninja Python module directory, significantly improving capa's compatibility and usability across these operating systems.

Highlights

  • New Helper Functions: Introduced _is_python_dir to check for the Python module directory structure and _to_python_dir to normalize paths to the correct Python directory, handling both root and python-dir layouts.
  • Improved Path Validation: Refactored validate_binaryninja_path to leverage the new _to_python_dir helper, simplifying the validation logic.
  • Enhanced macOS Detection: Added specific logic to detect Binary Ninja API at the default macOS application path /Applications/Binary Ninja.app/Contents/Resources.
  • Comprehensive Windows Detection: Implemented multiple strategies for Windows, including checking the BN_INSTALL_DIR environment variable, reading the lastrun file, and checking the default installation path C:/Program Files/Vector35/BinaryNinja.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Activity
  • No specific activity (comments, reviews, progress) was provided in the context for this pull request.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request significantly improves the detection of the Binary Ninja API on macOS and Windows by adding several new discovery mechanisms. However, the new detection mechanisms (environment variables and the lastrun configuration file) introduce potential security risks by loading Python modules from unvalidated paths. Specifically, an empty lastrun file can lead to code execution from the current working directory, and on Windows, both mechanisms could be abused via UNC paths to trigger network requests or load remote code. I've also identified a few areas for improvement concerning correctness, robustness, and minor optimizations, including suggestions to handle potentially empty configuration files correctly, refine platform-detection logic to be more explicit, fix a type hint, and remove a redundant function call.

kevinmuoz and others added 2 commits March 3, 2026 01:42
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@kevinmuoz
Copy link
Copy Markdown
Author

@xusheng6 this should address the original macOS Binja API detection issue. Could you please confirm on your setup when you have a moment? It works on my M1, thanks!!

@mike-hunhoff mike-hunhoff requested review from mwilliams31 and williballenthin and removed request for mwilliams31 March 10, 2026 18:09
@mike-hunhoff
Copy link
Copy Markdown
Collaborator

@williballenthin I don't have a binja setup and I'm not familiar with the tool's API. Could you review this PR when you have a chance?

@williballenthin
Copy link
Copy Markdown
Collaborator

yeah i can give this a shot as long as my license is still valid. i'll check tomorrow.

@mr-tz
Copy link
Copy Markdown
Collaborator

mr-tz commented Mar 11, 2026

@xusheng6 could you support here?

@xusheng6
Copy link
Copy Markdown
Contributor

@xusheng6 could you support here?

I will have a look. Can you assign me on this to help me keep track of it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Binary Ninja installation path detection does not work on macOS

5 participants