├── .devcontainer ├── devcontainer.json └── post-create.sh ├── .ghidra_projects └── .placeholder ├── .github └── workflows │ └── build-and-push-devcontainer.yml ├── .gitignore ├── .vscode ├── launch.json ├── settings.json └── tasks.json ├── LICENSE ├── README.md ├── import_bins.py ├── requirements.txt ├── run_headless.py ├── sample.properties ├── sample.py ├── sample_bridge.py └── sample_pyhidra.py /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 1 | // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: 2 | // https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/python-3 3 | { 4 | "name": "ghidra-python-vscode-devcontainer-skeleton", 5 | // image from https://github.com/clearbluejar/ghidra-python 6 | "image": "ghcr.io/clearbluejar/ghidra-python:11.3.1ghidra3.12python-bookworm", 7 | // Configure tool-specific properties. 8 | "customizations": { 9 | // Configure properties specific to VS Code. 10 | "vscode": { 11 | // Set *default* container specific settings.json values on container create. 12 | "settings": { 13 | // "python.defaultInterpreterPath": "/usr/local/bin/python", 14 | // "python.linting.enabled": true, 15 | // "python.linting.pylintEnabled": true, 16 | // "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8", 17 | // "python.formatting.blackPath": "/usr/local/py-utils/bin/black", 18 | // "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf", 19 | // "python.linting.banditPath": "/usr/local/py-utils/bin/bandit", 20 | // "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8", 21 | // "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy", 22 | // "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle", 23 | // "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle", 24 | // "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint", 25 | // // VS code settings for ghidra-stubs autocomplete 26 | // "python.analysis.stubPath": "${workspaceFolder}/.env/lib/python3.12/site-packages/ghidra-stubs/", 27 | // "python.autoComplete.extraPaths": [ 28 | // "${workspaceFolder}/.env/lib/python3.12/site-packages/ghidra-stubs/" 29 | // ], 30 | // "python.analysis.extraPaths": [ 31 | // "${workspaceFolder}/.env/lib/python3.12/site-packages/ghidra-stubs/" 32 | // ], 33 | "[python]": { 34 | "editor.formatOnSave": true, 35 | }, 36 | }, 37 | // Add the IDs of extensions you want installed when the container is created. 38 | "extensions": [ 39 | "ms-python.python", 40 | "ms-python.vscode-pylance", 41 | "yzhang.markdown-all-in-one" 42 | ] 43 | } 44 | }, 45 | // Use 'forwardPorts' to make a list of ports inside the container available locally. 46 | // "forwardPorts": [], 47 | // Use 'postCreateCommand' to run commands after the container is created. 48 | "postCreateCommand": [ 49 | "bash", 50 | ".devcontainer/post-create.sh" 51 | ], 52 | // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. 53 | "remoteUser": "vscode", 54 | } -------------------------------------------------------------------------------- /.devcontainer/post-create.sh: -------------------------------------------------------------------------------- 1 | # Create local venv 2 | python3 -m venv .env 3 | source .env/bin/activate 4 | 5 | # upgrade pip 6 | pip install --upgrade pip 7 | 8 | # Download latest pyi typings 9 | pip install ghidra-stubs 10 | 11 | # Install pyhdira 12 | pip install pyghidra 13 | 14 | # If arm64 os, need to build native binaries for Ghidra 15 | if uname -a | grep -q 'aarch64'; then 16 | if [ -e $GHIDRA_INSTALL_DIR/support/buildNatives ] 17 | then 18 | $GHIDRA_INSTALL_DIR/support/buildNatives 19 | else 20 | # needed for Ghidra 11.2+ 21 | pushd $GHIDRA_INSTALL_DIR/support/gradle/ 22 | gradle buildNatives 23 | popd 24 | fi 25 | else 26 | ## temporary - fix intel 64 docker image with missing packages 27 | sudo apt update 28 | sudo apt install -y libxtst6 libxi-dev 29 | fi 30 | 31 | # Setup Ghidra Dev for Reference 32 | # git clone https://github.com/NationalSecurityAgency/ghidra.git ~/ghidra-master 33 | # pushd ~/ghidra-master 34 | 35 | # # Follow setup from https://github.com/NationalSecurityAgency/ghidra/blob/master/DevGuide.md 36 | # gradle -I gradle/support/fetchDependencies.gradle init 37 | # gradle prepdev 38 | 39 | # popd 40 | 41 | # echo 'To open up a Ghidra latest dev: code ~/ghidra-master' -------------------------------------------------------------------------------- /.ghidra_projects/.placeholder: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/clearbluejar/ghidra-python-vscode-devcontainer-skeleton/b948f6b3f960d01485a391022edd51f909f2aa86/.ghidra_projects/.placeholder -------------------------------------------------------------------------------- /.github/workflows/build-and-push-devcontainer.yml: -------------------------------------------------------------------------------- 1 | name: 'build-and-push-devcontainer' 2 | on: # rebuild any PRs and main branch changes 3 | # pull_request: 4 | # push: 5 | # branches: 6 | # - main 7 | # paths: 8 | # - '.devcontainer/**' 9 | 10 | workflow_dispatch: 11 | 12 | jobs: 13 | build: 14 | runs-on: ubuntu-latest 15 | steps: 16 | 17 | - name: Checkout (GitHub) 18 | uses: actions/checkout@v3 19 | 20 | - name: Login to GitHub Container Registry 21 | uses: docker/login-action@v2 22 | with: 23 | registry: ghcr.io 24 | username: ${{ github.repository_owner }} 25 | password: ${{ secrets.GITHUB_TOKEN }} 26 | 27 | - id: image_id 28 | uses: pozetroninc/github-action-get-latest-release@master 29 | with: 30 | owner: clearbluejar 31 | repo: ghidra-python-vscode-devcontainer-skeleton 32 | excludes: prerelease, draft 33 | 34 | - name: Install updated Skopeo 35 | # This can be omitted once runner images have a version of Skopeo > 1.4.1 36 | # See https://github.com/containers/skopeo/issues/1874 37 | run: | 38 | sudo apt purge buildah golang-github-containers-common podman skopeo 39 | sudo apt autoremove --purge 40 | REPO_URL="https://download.opensuse.org/repositories/devel:/kubic:/libcontainers:/unstable" 41 | source /etc/os-release 42 | sudo sh -c "echo 'deb ${REPO_URL}/x${NAME}_${VERSION_ID}/ /' > /etc/apt/sources.list.d/devel:kubic:libcontainers:unstable.list" 43 | sudo wget -qnv https://download.opensuse.org/repositories/devel:kubic:libcontainers:stable/x${NAME}_${VERSION_ID}/Release.key -O Release.key 44 | sudo apt-key add Release.key 45 | sudo apt-get update 46 | sudo apt-get install skopeo 47 | 48 | # enables building of multi-platform images 49 | - name: Create Docker Build Instance 50 | run: | 51 | docker buildx create --use 52 | docker buildx ls 53 | 54 | - name: Build dev container image 55 | uses: devcontainers/ci@v0.3 56 | with: 57 | imageName: ghcr.io/clearbluejar/ghidra-python-vscode-devcontainer 58 | cacheFrom: ghcr.io/clearbluejar/ghidra-python-vscode-devcontainer 59 | push: always 60 | imageTag: latest,${{ steps.image_id.outputs.release }} 61 | platform: linux/arm64,linux/amd64 62 | runCmd: | 63 | find . 64 | find /ghidra 65 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | # project specific ignores 132 | .ghidra_projects*/ 133 | .ghidra_bridge*/ -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | // Use IntelliSense to learn about possible attributes. 3 | // Hover to view descriptions of existing attributes. 4 | // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 5 | "version": "0.2.0", 6 | "configurations": [ 7 | { 8 | "name": "Python: Current File", 9 | "type": "python", 10 | "request": "launch", 11 | "program": "${file}", 12 | "console": "integratedTerminal", 13 | "justMyCode": true, 14 | // Don't edit env directly, they read from settings.json 15 | // Add/delete new vars as needed 16 | // "env": { 17 | // "GHIDRA_INSTALL_DIR": "${config:GHIDRA_INSTALL_DIR}", 18 | // "GHIDRA_PROJECTS_PATH": "${config:GHIDRA_PROJECTS_PATH}", 19 | // "GHIDRA_HEADLESS": "${config:GHIDRA_HEADLESS}", 20 | // "PROJECT_NAME": "${config:PROJECT_NAME}", 21 | // "GHIDRA_BRIDGE_INSTALL_DIR": "${config:GHIDRA_BRIDGE_INSTALL_DIR}", 22 | // }, 23 | } 24 | ] 25 | } -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | // needed to make ghidra stubs work in this project (auto complete for vscode) 3 | // "python.defaultInterpreterPath": "${workspaceFolder}/.env/bin/python", 4 | // "python.analysis.stubPath": "${workspaceFolder}/.env/lib/python3.12/site-packages/ghidra-stubs/", 5 | // "python.autoComplete.extraPaths": [ 6 | // "${workspaceFolder}/.env/lib/python3.12/site-packages/ghidra-stubs/" 7 | // ], 8 | // "python.analysis.extraPaths": [ 9 | // "${workspaceFolder}/.env/lib/python3.12/site-packages/ghidra-stubs/" 10 | // ], 11 | } -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | // See https://go.microsoft.com/fwlink/?LinkId=733558 3 | // for the documentation about the tasks.json format 4 | "version": "2.0.0", 5 | "tasks": [ 6 | { 7 | "label": "Run Current Python Script in Ghidra Jython", 8 | "type": "shell", 9 | "command": "${config:GHIDRA_HEADLESS}", 10 | "args": [ 11 | "${config:GHIDRA_PROJECTS_PATH}${pathSeparator}${config:PROJECT_NAME}", 12 | "${config:PROJECT_NAME}", 13 | "-postscript", 14 | "${file}" 15 | ], 16 | "problemMatcher": [], 17 | }, 18 | { 19 | "label": "Start ghidra-bridge RPC server", 20 | "type": "shell", 21 | "command": "${config:GHIDRA_HEADLESS}", 22 | "args": [ 23 | "${config:GHIDRA_PROJECTS_PATH}${pathSeparator}${config:PROJECT_NAME}", 24 | "${config:PROJECT_NAME}", 25 | "-scriptPath", 26 | "${config:GHIDRA_BRIDGE_INSTALL_DIR}", 27 | "-propertiesPath", 28 | "${config:GHIDRA_BRIDGE_INSTALL_DIR}", 29 | "-postscript", 30 | "ghidra_bridge_server.py", 31 | "ls" 32 | ], 33 | "problemMatcher": [], 34 | }, 35 | ], 36 | 37 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ghidra-python-vscode-devcontainer-skeleton 2 | 3 |

4 | 5 |

6 | 7 |

8 | 9 | 10 |

11 | 12 | Blog post: [Ghidra Python Paleontology](https://clearbluejar.github.io/posts/building-vscode-ghidra-python-skeletons/) 13 | 14 | A skeleton repo to provide a Ghidra Headless (non-GUI) Python scripting environment in VS Code. 15 | 16 | ## Features 17 | 18 | - Prescribes [workflow](#workflow) to get you started (modify as needed) 19 | - Container dependencies captured in [.devcontainer](.devcontainer/) 20 | - Leverages [vscode python3 devcontainer image](https://github.com/microsoft/vscode-dev-containers/tree/main/containers/python-3) with Java [feature](.devcontainer/devcontainer.json#L64-L66) added for running Ghidra 21 | - Provisions specified versions Ghidra based on `GHIDRA_VERSION` in [devcontainer.json](.devcontainer/devcontainer.json#L15-L16) 22 | - Auto complete for Ghidra Python script setup and configured 23 | - via pyi typings from [VDOO-Connected-Trust/ghidra-pyi-generator](https://github.com/VDOO-Connected-Trust/ghidra-pyi-generator) 24 | - IDE debugging (available from either) 25 | - [justfoxing/ghidra_bridge](https://github.com/justfoxing/ghidra_bridge) over RPC 26 | - [pyghidra](https://github.com/dod-cyber-crime-center/pyghidra) leveraging native CPython interpreter using [jpype](https://jpype.readthedocs.io/en/latest/) 27 | - Demonstrates running python scripts in [various ways](#different-ways-to-run-a-ghidra-headless-script). 28 | 29 | ## About 30 | 31 | This repo is a starting point for your Ghidra Python scripting project in vscode. It demonstrates some useful vscode integrations and prescribes a workflow for running your python scripts. It leverages the power of devcontainers to provide a seamless development environment. 32 | 33 | ### Devcontainers 34 | 35 | If you haven't tried [developing inside a container](https://code.visualstudio.com/docs/remote/containers#_getting-started) with vscode, you should. 36 | 37 | > "One of the useful things about developing in a container is that you can use specific versions of dependencies that your application needs without impacting your local development environment. " [Get started with development Containers in Visual Studio Code](https://code.visualstudio.com/docs/remote/containers-tutorial) 38 | 39 | > "This lets VS Code provide a local-quality development experience including full IntelliSense (completions), code navigation, and debugging regardless of where your tools (or code) are located." [Developing inside a Container using Visual Studio Code Remote Development](https://code.visualstudio.com/docs/remote/containers) 40 | 41 | This version is an upgrade from the old [ghidra-python-vscode-skeleton](https://github.com/clearbluejar/ghidra-python-vscode-skeleton). Upgraded via the power of `vscode` devcontainers. **Everything just works.** Don't believe me? Try it. 42 | 43 | ![ghidra-python-vscode-devcontainer-skeleton-demo-gif](https://user-images.githubusercontent.com/3752074/189027265-87dacacd-7935-4874-b89e-d4a2ba098359.gif) 44 | 45 | --- 46 | 47 | ## TOC 48 | - [ghidra-python-vscode-devcontainer-skeleton](#ghidra-python-vscode-devcontainer-skeleton) 49 | - [Features](#features) 50 | - [About](#about) 51 | - [Devcontainers](#devcontainers) 52 | - [TOC](#toc) 53 | - [Quick Start Setup - Dev Container (Best Option)](#quick-start-setup---dev-container--best-option) 54 | - [Option 1: Open a Git repository or GitHub PR in an isolated container volume](#option-1-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) 55 | - [Option 2: Open an existing folder in a container](#option-2-open-an-existing-folder-in-a-container) 56 | - [Configure](#configure) 57 | - [Set Python and Ghidra Version](#set-python-and-ghidra-version) 58 | - [Set Java and Gradle Version](#set-java-and-gradle-version) 59 | - [Rebuild after changes](#rebuild-after-changes) 60 | - [Manual Setup (Less Good Option)](#manual-setup-less-good-option) 61 | - [Workflow](#workflow) 62 | - [Ghidra Headless Analyzer (running command line scripts with Ghidra)](#ghidra-headless-analyzer-running-command-line-scripts-with-ghidra) 63 | - [Steps](#steps) 64 | - [Project Creation and Importing Binaries](#project-creation-and-importing-binaries) 65 | - [Different Ways to run a Ghidra Headless script](#different-ways-to-run-a-ghidra-headless-script) 66 | - [Sample Outputs](#sample-outputs) 67 | - [Ghidra Python Headless Scripting Hangups](#ghidra-python-headless-scripting-hangups) 68 | 69 | --- 70 | 71 | ## Quick Start Setup - Dev Container (Best Option) 72 | 73 | On first run, it will build a fast [debian image](https://github.com/microsoft/vscode-dev-containers/tree/main/containers/python-3) with the python3 installed along with java dependencies needed for Ghidra scripting. Then it will download Ghidra based on your settings in [devcontainer.json](.devcontainer/devcontainer.json#L15-L16) and finally create the virtual environment for python and required pip packages in [post-create.sh](.devcontainer/post-create.sh). 74 | 75 | Make sure you have the [prequisites](https://code.visualstudio.com/docs/remote/containers-tutorial#_prerequisites) setup for working with devcontainers in VS Code. Detailed instructions are available [here](https://code.visualstudio.com/docs/remote/containers#_getting-started). If you aren't using the devcontainer, you will need to use the [manual setup](#manual-setup-less-good-option). 76 | 77 | ### Option 1: Open a Git repository or GitHub PR in an isolated container volume 78 | 79 | 1. Start VS Code and run `Remote-Containers: Clone Repository in Container Volume...` from the Command Palette (F1). 80 | 2. Ctrl-V `https://github.com/clearbluejar/ghidra-python-vscode-devcontainer-skeleton` 81 | 3. VS Code will reload, clone the source code, and start building the container. 82 | 4. After the build completes, VS Code will open with the container. You can now work with the repository source code in this independent environment as you would if you had cloned the code locally. 83 | 84 | ### Option 2: Open an existing folder in a container 85 | 86 | 1. `git clone git@github.com:clearbluejar/ghidra-python-vscode-devcontainer-skeleton.git` 87 | 2. code `ghidra-python-vscode-devcontainer-skeleton` 88 | 3. When VS Code loads, it will recognize the .devcontainer folder and ask if you would like to open 89 | 90 | These two options should work out of the box (or container) with an experience like the one shown in the gif above. 91 | 92 | ### Configure 93 | 94 | The following options are available in the [devcontainer.json](.devcontainer/devcontainer.json). 95 | 96 | #### Set Python and Ghidra Version 97 | 98 | https://github.com/clearbluejar/ghidra-python-vscode-devcontainer-skeleton/blob/82077efed8ce673641d2b55f44af69a6ea677a69/.devcontainer/devcontainer.json#L8-L16 99 | 100 | #### Set Java and Gradle Version 101 | 102 | https://github.com/clearbluejar/ghidra-python-vscode-devcontainer-skeleton/blob/82077efed8ce673641d2b55f44af69a6ea677a69/.devcontainer/devcontainer.json#L64-L67 103 | 104 | Ghidra requires at least 11. Install gradle if you want to build native extensions (required see [post-create.sh](https://github.com/clearbluejar/ghidra-python-vscode-devcontainer-skeleton/blob/82077efed8ce673641d2b55f44af69a6ea677a69/.devcontainer/post-create.sh#L29-L32) if you are running on Apple M1 silicon) 105 | 106 | #### Rebuild after changes 107 | 108 | If you make changes to [devcontainer.json](.devcontainer/devcontainer.json), you will need to rebuild the container to enact them. You can do this by running the `Remote-Containers: Rebuild Container` command in the Command Palette (F1) when you are connected to the container. 109 | 110 | ## Manual Setup (Less Good Option) 111 | 112 | The manual setup essentially has to mimic the following scripts: 113 | - Install latest Ghidra - [ghidra-install.sh](.devcontainer/library-scripts/ghidra-install.sh) 114 | - Provide python and Java install - [devcontainer.json](.devcontainer/devcontainer.json) 115 | - Install pip packages and venv - [post-create.sh](.devcontainer/post-create.sh) 116 | 117 |
Expand for Manual Setup Steps 118 | 119 | 1. [Install Ghidra](https://github.com/NationalSecurityAgency/ghidra/releases) yourself. 120 | 2. Update `GHIDRA_INSTALL_DIR` and other variables in [settings.json](.vscode/settings.json) with your install paths. 121 | 3. Set environment variable with `GHIDRA_VERSION` 122 | - `export GHIDRA_VERSION=10.1.4` 123 | 4. Setup `venv` 124 | - `python3 -m venv .env` 125 | 5. Install pip packages 126 | - autocomplete 127 | - `ghidra-stubs` that match your `GHIDRA_VERSION` 128 | - `pip install https://github.com/clearbluejar/ghidra-pyi-generator/releases/download/v1.0.3-10.1.4/ghidra_stubs-10.1.4.refs_heads_master-py2.py3-none-any.whl` or `pip install ghidra-stubs` from pypi (this is an outdated version) 129 | - ghidra bridge 130 | - `pip install ghidra-bridge` 131 | - `python -m ghidra_bridge.install_server .ghidra_bridge` 132 | - pyghidra 133 | - `pip install pyghidra` 134 | 135 |
136 | 137 | ## Workflow 138 | 139 | [Ghidra](https://github.com/NationalSecurityAgency/ghidra) is a binary analysis tool (and much more). In order to perform analysis via script, you first need to create a project and add binaries for analysis. Once a project exists with at least one binary added, [headless analysis](#ghidra-headless-analyzer-running-command-line-scripts-with-ghidra) (scripting Ghidra) can begin. 140 | 141 | ### Ghidra Headless Analyzer (running command line scripts with Ghidra) 142 | 143 | >The Headless Analyzer is a command-line-based (non-GUI) version of Ghidra. 144 | 145 | >The Headless Analyzer can be useful when performing repetitive tasks on a project (i.e., importing and analyzing a directory of files or running a script over all the binaries in a project). 146 | 147 | The basic usage for the headless analyzer in Ghidra is: 148 | ``` 149 | analyzeHeadless [[-import [|]+] | [-process []]] [-postScript ] 150 | ``` 151 | 152 |
153 | Show analyzeHeadless full usage 154 | 155 | ```bash 156 | analyzeHeadless [/] 157 | | ghidra://[:]/[/] 158 | [[-import [|]+] | [-process []]] 159 | [-preScript ] 160 | [-postScript ] 161 | [-scriptPath "[;...]"] 162 | [-propertiesPath "[;...]"] 163 | [-scriptlog ] 164 | [-log ] 165 | [-overwrite] 166 | [-recursive] 167 | [-readOnly] 168 | [-deleteProject] 169 | [-noanalysis] 170 | [-processor ] 171 | [-cspec ] 172 | [-analysisTimeoutPerFile ] 173 | [-keystore ] 174 | [-connect ] 175 | [-p] 176 | [-commit [""]] 177 | [-okToDelete] 178 | [-max-cpu ] 179 | [-loader ] 180 | ``` 181 |
182 | 183 | ### Steps 184 | 185 | This skeleton project prescribes a workflow and demonstrates various ways to run headless Ghidra Python scripts. The steps can be modified to suit your needs. 186 | 187 | 1. **Create Ghidra Project** - Directory and collection of Ghidra project files and data 188 | 2. **Import Binary to project** - Import one or more binaries to the project for analysis 189 | 3. **Analyze Binary** - Ghidra will perform default binary analysis on each binary 190 | 4. **Run Ghidra Python [script](sample.py)** 191 | 192 | 193 | Technically, all of these steps within the skeletion can be performed with a single call to `analyzeHeadless`. 194 | 195 | `/ghidra/support/analyzeHeadless .ghidra_projects/sample_project sample_project -import /bin/ls -postscript sample.py` 196 | 197 | For clarity they are broken down into two distinct steps: 198 | 1. [Project Creation and Importing Binaries](#project-creation-and-importing-binaries) 199 | 2. [Running Headless Scripts](#different-ways-to-run-a-ghidra-headless-script) 200 | 201 | ### Project Creation and Importing Binaries 202 | 203 | Steps 1, 2, and 3 can be combined in a single call to `analyzeHeadless` within [import_bins.py](import_bins.py). Essentially, the script runs the following command line: 204 | 205 | `analyzeHeadless .ghidra_projects/sample_project sample_project -import /bin/ls` 206 | 207 | This single call will create a project (`sample_project`), import a binary (`ls`) and analyze the binary. 208 | 209 | ### Different Ways to run a Ghidra Headless script 210 | 211 | At this point, the `sample_project` exists in [.ghidra_projects](.ghidra_projects/) and is ready to run Python Ghidra Scripts. 212 | 213 | Step 4 runs the script on the imported binary after analysis (*-postscript*) on a subsequent call to `analyzeHeadless` with your [sample.py](sample.py). Essentially, making this call. 214 | 215 | `analyzeHeadless .ghidra_projects/sample_project sample_project -postscript sample.py` 216 | 217 | There are several ways to run a Ghidra Python script. 218 | 219 | 1. Run via launch on [run_headless.py](run_headless.py). 220 | - The most straightforward means to run the script. It simply uses subprocess module to call `analyzeHeadless` with the correct arguments to run the [sample.py](sample.py). 221 | - It also creates a properties file needed to pass arguments to some Ghidra API calls. 222 | 2. Run the task `Run Current Python Script in Ghidra Jython` within [tasks.json](.vscode/tasks.json). 223 | - To use this task make sure you have open and focused the [sample.py](sample.py). 224 | 3. Run via launch on [sample_bridge.py](sample_bridge.py) leveraging `ghidra-bridge`. 225 | - Requires the ghidra-bridge to [start prior to connecting](sample_bridge.py#L43-L49) via bridge. 226 | - Instead of properties file, [passes](sample_bridge.py#L37) `ls` argument to ghidra-bridge server. 227 | 4. Run [sample_pyghidra.py](sample_pyghidra.py) leveraging `pyghidra` (best one! It really just works with the help of `jpype`) 228 | 5. Run [sample.py](sample.py) directly in Ghidra via the GUI after copying it to the `ghidra_scripts` directory. If you are doing that, you likely don't need this repo. 229 | 230 | ### Sample Outputs 231 | 232 |
1. Run via launch on run_headless.py 233 | 234 | ```bash 235 | (.env) vscode ➜ /workspaces/ghidra-python-vscode-devcontainer-skeleton (main ✗) $ ghidra-python-vscode-devcontainer-skeleton/run_headless.py 236 | 237 | ['/ghidra/support/analyzeHeadless', '/workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_projects/sample_project', 'sample_project', '-postscript', 'sample.py'] 238 | 239 | program=ls 240 | 241 | openjdk version "11.0.15" 2022-04-19 LTS 242 | OpenJDK Runtime Environment Microsoft-32930 (build 11.0.15+10-LTS) 243 | OpenJDK 64-Bit Server VM Microsoft-32930 (build 11.0.15+10-LTS, mixed mode) 244 | INFO Using log config file: jar:file:/ghidra/Ghidra/Framework/Generic/lib/Generic.jar!/generic.log4j.xml (LoggingInitialization) 245 | INFO Using log file: /home/vscode/.ghidra/.ghidra_10.1.4_PUBLIC/application.log (LoggingInitialization) 246 | INFO Loading user preferences: /home/vscode/.ghidra/.ghidra_10.1.4_PUBLIC/preferences (Preferences) 247 | INFO Class search complete (1006 ms) (ClassSearcher) 248 | INFO Initializing SSL Context (SSLContextInitializer) 249 | INFO Initializing Random Number Generator... (SecureRandomFactory) 250 | INFO Random Number Generator initialization complete: NativePRNGNonBlocking (SecureRandomFactory) 251 | INFO Trust manager disabled, cacerts have not been set (ApplicationTrustManagerFactory) 252 | WARN Neither the -import parameter nor the -process parameter was specified; therefore, the specified prescripts and/or postscripts will be executed without any type of program context. (HeadlessAnalyzer) 253 | INFO HEADLESS Script Paths: 254 | /ghidra/Ghidra/Features/Decompiler/ghidra_scripts 255 | /ghidra/Ghidra/Features/Base/ghidra_scripts 256 | /ghidra/Ghidra/Features/BytePatterns/ghidra_scripts 257 | /ghidra/Ghidra/Processors/8051/ghidra_scripts 258 | /ghidra/Ghidra/Features/Python/ghidra_scripts 259 | /ghidra/Ghidra/Debug/Debugger/ghidra_scripts 260 | /ghidra/Ghidra/Features/FileFormats/ghidra_scripts 261 | /ghidra/Ghidra/Processors/PIC/ghidra_scripts 262 | /ghidra/Ghidra/Processors/DATA/ghidra_scripts 263 | /ghidra/Ghidra/Debug/Debugger-agent-dbgmodel-traceloader/ghidra_scripts 264 | /ghidra/Ghidra/Features/VersionTracking/ghidra_scripts 265 | /ghidra/Ghidra/Features/FunctionID/ghidra_scripts 266 | /ghidra/Ghidra/Features/GnuDemangler/ghidra_scripts 267 | /ghidra/Ghidra/Features/MicrosoftCodeAnalyzer/ghidra_scripts (HeadlessAnalyzer) 268 | INFO HEADLESS: execution starts (HeadlessAnalyzer) 269 | INFO Opening existing project: /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_projects/sample_project/sample_project (HeadlessAnalyzer) 270 | INFO Opening project: /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_projects/sample_project/sample_project (HeadlessProject) 271 | INFO SCRIPT: /workspaces/ghidra-python-vscode-devcontainer-skeleton/sample.py (HeadlessAnalyzer) 272 | INFO Reading script properties file: /workspaces/ghidra-python-vscode-devcontainer-skeleton/sample.properties (GhidraScriptProperties) 273 | sample_project 274 | ghidra.framework.data.ProjectFileManager@60a907d9 275 | sample_project:/ 276 | Program Info: 277 | Program: ls: AARCH64:LE:64:v8A_default (Wed Jul 13 12:59:48 UTC 2022) 278 | 279 | Memory layout: 280 | Imagebase: 0x100000L 281 | segment_2.1 [start: 0x1048576, end: 0x1049143] 282 | .interp [start: 0x1049144, end: 0x1049170] 283 | .note.gnu.build-id [start: 0x1049172, end: 0x1049207] 284 | .note.ABI-tag [start: 0x1049208, end: 0x1049239] 285 | .gnu.hash [start: 0x1049240, end: 0x1049303] 286 | .dynsym [start: 0x1049304, end: 0x1052423] 287 | .dynstr [start: 0x1052424, end: 0x1053877] 288 | .gnu.version [start: 0x1053878, end: 0x1054137] 289 | .gnu.version_r [start: 0x1054144, end: 0x1054255] 290 | .rela.dyn [start: 0x1054256, end: 0x1060087] 291 | .rela.plt [start: 0x1060088, end: 0x1062703] 292 | .init [start: 0x1062704, end: 0x1062723] 293 | .plt [start: 0x1062736, end: 0x1064511] 294 | .text [start: 0x1064512, end: 0x1149231] 295 | .fini [start: 0x1149232, end: 0x1149247] 296 | .rodata [start: 0x1149248, end: 0x1168549] 297 | .eh_frame_hdr [start: 0x1168552, end: 0x1170795] 298 | .eh_frame [start: 0x1170800, end: 0x1182903] 299 | .init_array [start: 0x1250024, end: 0x1250031] 300 | .fini_array [start: 0x1250032, end: 0x1250039] 301 | .data.rel.ro [start: 0x1250040, end: 0x1252607] 302 | .dynamic [start: 0x1252608, end: 0x1253119] 303 | .got [start: 0x1253120, end: 0x1253351] 304 | .got.plt [start: 0x1253352, end: 0x1254247] 305 | .data [start: 0x1254248, end: 0x1254935] 306 | .bss [start: 0x1254936, end: 0x1259735] 307 | EXTERNAL [start: 0x1261568, end: 0x1262527] 308 | .gnu_debugaltlink [start: 0x0, end: 0x73] 309 | .gnu_debuglink [start: 0x0, end: 0x51] 310 | .shstrtab [start: 0x0, end: 0x279] 311 | _elfSectionHeaders [start: 0x0, end: 0x1855] 312 | ``` 313 |
314 | 315 |
2. Run Current Python Script in Ghidra Jython Task Output 316 | 317 | ```bash 318 | * Executing task: /ghidra/support/analyzeHeadless /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_projects/sample_project sample_project -postscript /workspaces/ghidra-python-vscode-devcontainer-skeleton/sample.py 319 | 320 | source /workspaces/ghidra-python-vscode-devcontainer-skeleton/.env/bin/activate 321 | openjdk version "11.0.15" 2022-04-19 LTS 322 | OpenJDK Runtime Environment Microsoft-32930 (build 11.0.15+10-LTS) 323 | OpenJDK 64-Bit Server VM Microsoft-32930 (build 11.0.15+10-LTS, mixed mode) 324 | INFO Using log config file: jar:file:/ghidra/Ghidra/Framework/Generic/lib/Generic.jar!/generic.log4j.xml (LoggingInitialization) 325 | INFO Using log file: /home/vscode/.ghidra/.ghidra_10.1.4_PUBLIC/application.log (LoggingInitialization) 326 | INFO Loading user preferences: /home/vscode/.ghidra/.ghidra_10.1.4_PUBLIC/preferences (Preferences) 327 | INFO Class search complete (776 ms) (ClassSearcher) 328 | INFO Initializing SSL Context (SSLContextInitializer) 329 | INFO Initializing Random Number Generator... (SecureRandomFactory) 330 | INFO Random Number Generator initialization complete: NativePRNGNonBlocking (SecureRandomFactory) 331 | INFO Trust manager disabled, cacerts have not been set (ApplicationTrustManagerFactory) 332 | WARN Neither the -import parameter nor the -process parameter was specified; therefore, the specified prescripts and/or postscripts will be executed without any type of program context. (HeadlessAnalyzer) 333 | INFO HEADLESS Script Paths: 334 | /ghidra/Ghidra/Features/Decompiler/ghidra_scripts 335 | /ghidra/Ghidra/Features/Base/ghidra_scripts 336 | /ghidra/Ghidra/Features/BytePatterns/ghidra_scripts 337 | /ghidra/Ghidra/Processors/8051/ghidra_scripts 338 | /ghidra/Ghidra/Features/Python/ghidra_scripts 339 | /ghidra/Ghidra/Debug/Debugger/ghidra_scripts 340 | /ghidra/Ghidra/Features/FileFormats/ghidra_scripts 341 | /ghidra/Ghidra/Processors/PIC/ghidra_scripts 342 | /ghidra/Ghidra/Processors/DATA/ghidra_scripts 343 | /ghidra/Ghidra/Debug/Debugger-agent-dbgmodel-traceloader/ghidra_scripts 344 | /ghidra/Ghidra/Features/VersionTracking/ghidra_scripts 345 | /ghidra/Ghidra/Features/FunctionID/ghidra_scripts 346 | /ghidra/Ghidra/Features/GnuDemangler/ghidra_scripts 347 | /ghidra/Ghidra/Features/MicrosoftCodeAnalyzer/ghidra_scripts (HeadlessAnalyzer) 348 | INFO HEADLESS: execution starts (HeadlessAnalyzer) 349 | INFO Opening existing project: /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_projects/sample_project/sample_project (HeadlessAnalyzer) 350 | INFO Opening project: /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_projects/sample_project/sample_project (HeadlessProject) 351 | INFO SCRIPT: /workspaces/ghidra-python-vscode-devcontainer-skeleton/sample.py (HeadlessAnalyzer) 352 | INFO Reading script properties file: /workspaces/ghidra-python-vscode-devcontainer-skeleton/sample.properties (GhidraScriptProperties) 353 | sample_project 354 | ghidra.framework.data.ProjectFileManager@7a9f836e 355 | sample_project:/ 356 | Program Info: 357 | Program: ls: AARCH64:LE:64:v8A_default (Wed Jul 13 13:49:27 UTC 2022) 358 | 359 | Memory layout: 360 | Imagebase: 0x100000L 361 | segment_2.1 [start: 0x1048576, end: 0x1049143] 362 | .interp [start: 0x1049144, end: 0x1049170] 363 | .note.gnu.build-id [start: 0x1049172, end: 0x1049207] 364 | .note.ABI-tag [start: 0x1049208, end: 0x1049239] 365 | .gnu.hash [start: 0x1049240, end: 0x1049303] 366 | .dynsym [start: 0x1049304, end: 0x1052423] 367 | .dynstr [start: 0x1052424, end: 0x1053877] 368 | .gnu.version [start: 0x1053878, end: 0x1054137] 369 | .gnu.version_r [start: 0x1054144, end: 0x1054255] 370 | .rela.dyn [start: 0x1054256, end: 0x1060087] 371 | .rela.plt [start: 0x1060088, end: 0x1062703] 372 | .init [start: 0x1062704, end: 0x1062723] 373 | .plt [start: 0x1062736, end: 0x1064511] 374 | .text [start: 0x1064512, end: 0x1149231] 375 | .fini [start: 0x1149232, end: 0x1149247] 376 | .rodata [start: 0x1149248, end: 0x1168549] 377 | .eh_frame_hdr [start: 0x1168552, end: 0x1170795] 378 | .eh_frame [start: 0x1170800, end: 0x1182903] 379 | .init_array [start: 0x1250024, end: 0x1250031] 380 | .fini_array [start: 0x1250032, end: 0x1250039] 381 | .data.rel.ro [start: 0x1250040, end: 0x1252607] 382 | .dynamic [start: 0x1252608, end: 0x1253119] 383 | .got [start: 0x1253120, end: 0x1253351] 384 | .got.plt [start: 0x1253352, end: 0x1254247] 385 | .data [start: 0x1254248, end: 0x1254935] 386 | .bss [start: 0x1254936, end: 0x1259735] 387 | EXTERNAL [start: 0x1261568, end: 0x1262527] 388 | .gnu_debugaltlink [start: 0x0, end: 0x73] 389 | .gnu_debuglink [start: 0x0, end: 0x51] 390 | .shstrtab [start: 0x0, end: 0x279] 391 | _elfSectionHeaders [start: 0x0, end: 0x1855] 392 | * Terminal will be reused by tasks, press any key to close it. 393 | ``` 394 |
395 | 396 |
3. Run via launch on sample_bridge.py 397 | 398 | ```bash 399 | (.env) vscode ➜ /workspaces/ghidra-python-vscode-devcontainer-skeleton (main ✗) $ cd /workspaces/ghidra-python-vscode-devcontainer-skeleton ; /usr/bin/env /workspaces/ghidra-python-vscode-devcontainer-skeleton/.env/bin/python /home/vscode/.vscode-server/extensions/ms-python.python-2022.10.1/pythonFiles/lib/python/debugpy/adapter/../../debugpy/launcher 38055 -- /workspaces/ghidra-python-vscode-devcontainer-skeleton/sample_bridge.py 400 | /ghidra/support/analyzeHeadless /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_projects/sample_project sample_project -scriptPath /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_bridge -postscript ghidra_bridge_server.py ls 401 | openjdk version "11.0.15" 2022-04-19 LTS 402 | OpenJDK Runtime Environment Microsoft-32930 (build 11.0.15+10-LTS) 403 | OpenJDK 64-Bit Server VM Microsoft-32930 (build 11.0.15+10-LTS, mixed mode) 404 | INFO Using log config file: jar:file:/ghidra/Ghidra/Framework/Generic/lib/Generic.jar!/generic.log4j.xml (LoggingInitialization) 405 | INFO Using log file: /home/vscode/.ghidra/.ghidra_10.1.4_PUBLIC/application.log (LoggingInitialization) 406 | INFO Loading user preferences: /home/vscode/.ghidra/.ghidra_10.1.4_PUBLIC/preferences (Preferences) 407 | waiting for ghidra_bridge_server... 408 | INFO Class search complete (758 ms) (ClassSearcher) 409 | INFO Initializing SSL Context (SSLContextInitializer) 410 | INFO Initializing Random Number Generator... (SecureRandomFactory) 411 | INFO Random Number Generator initialization complete: NativePRNGNonBlocking (SecureRandomFactory) 412 | INFO Trust manager disabled, cacerts have not been set (ApplicationTrustManagerFactory) 413 | WARN Neither the -import parameter nor the -process parameter was specified; therefore, the specified prescripts and/or postscripts will be executed without any type of program context. (HeadlessAnalyzer) 414 | INFO HEADLESS Script Paths: 415 | /ghidra/Ghidra/Features/Decompiler/ghidra_scripts 416 | /ghidra/Ghidra/Features/Base/ghidra_scripts 417 | /ghidra/Ghidra/Features/BytePatterns/ghidra_scripts 418 | /ghidra/Ghidra/Processors/8051/ghidra_scripts 419 | /ghidra/Ghidra/Features/Python/ghidra_scripts 420 | /ghidra/Ghidra/Debug/Debugger/ghidra_scripts 421 | /ghidra/Ghidra/Features/FileFormats/ghidra_scripts 422 | /ghidra/Ghidra/Processors/PIC/ghidra_scripts 423 | /ghidra/Ghidra/Processors/DATA/ghidra_scripts 424 | /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_bridge 425 | /ghidra/Ghidra/Debug/Debugger-agent-dbgmodel-traceloader/ghidra_scripts 426 | /ghidra/Ghidra/Features/VersionTracking/ghidra_scripts 427 | /ghidra/Ghidra/Features/FunctionID/ghidra_scripts 428 | /ghidra/Ghidra/Features/GnuDemangler/ghidra_scripts 429 | /ghidra/Ghidra/Features/MicrosoftCodeAnalyzer/ghidra_scripts (HeadlessAnalyzer) 430 | INFO HEADLESS: execution starts (HeadlessAnalyzer) 431 | INFO Opening existing project: /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_projects/sample_project/sample_project (HeadlessAnalyzer) 432 | INFO Opening project: /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_projects/sample_project/sample_project (HeadlessProject) 433 | INFO SCRIPT: /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_bridge/ghidra_bridge_server.py (HeadlessAnalyzer) 434 | waiting for ghidra_bridge_server... 435 | waiting for ghidra_bridge_server... 436 | waiting for ghidra_bridge_server... 437 | waiting for ghidra_bridge_server... 438 | INFO:jfx_bridge.bridge:serving! (jfx_bridge v0.9.1, Python 2.7.2) 439 | waiting for ghidra_bridge_server... 440 | WARNING:jfx_bridge.bridge:Handling connection from ('127.0.0.1', 48084) 441 | WARNING:jfx_bridge.bridge:Handling connection from ('127.0.0.1', 48086) 442 | WARNING:jfx_bridge.bridge:Closing connection from ('127.0.0.1', 48084) 443 | sample_project 444 | ghidra.framework.data.ProjectFileManager@69d3307d 445 | sample_project:/ 446 | Program Info: 447 | Program: ls: AARCH64:LE:64:v8A_default (Thu Aug 04 01:07:04 UTC 2022) 448 | 449 | Memory layout: 450 | Imagebase: 0x100000 451 | segment_2.1 [start: 0x1048576, end: 0x1049143] 452 | .interp [start: 0x1049144, end: 0x1049170] 453 | .note.gnu.build-id [start: 0x1049172, end: 0x1049207] 454 | .note.ABI-tag [start: 0x1049208, end: 0x1049239] 455 | .gnu.hash [start: 0x1049240, end: 0x1049303] 456 | .dynsym [start: 0x1049304, end: 0x1052423] 457 | .dynstr [start: 0x1052424, end: 0x1053877] 458 | .gnu.version [start: 0x1053878, end: 0x1054137] 459 | .gnu.version_r [start: 0x1054144, end: 0x1054255] 460 | .rela.dyn [start: 0x1054256, end: 0x1060087] 461 | .rela.plt [start: 0x1060088, end: 0x1062703] 462 | .init [start: 0x1062704, end: 0x1062723] 463 | .plt [start: 0x1062736, end: 0x1064511] 464 | .text [start: 0x1064512, end: 0x1149231] 465 | .fini [start: 0x1149232, end: 0x1149247] 466 | .rodata [start: 0x1149248, end: 0x1168549] 467 | .eh_frame_hdr [start: 0x1168552, end: 0x1170795] 468 | .eh_frame [start: 0x1170800, end: 0x1182903] 469 | .init_array [start: 0x1250024, end: 0x1250031] 470 | .fini_array [start: 0x1250032, end: 0x1250039] 471 | .data.rel.ro [start: 0x1250040, end: 0x1252607] 472 | .dynamic [start: 0x1252608, end: 0x1253119] 473 | .got [start: 0x1253120, end: 0x1253351] 474 | .got.plt [start: 0x1253352, end: 0x1254247] 475 | .data [start: 0x1254248, end: 0x1254935] 476 | .bss [start: 0x1254936, end: 0x1259735] 477 | EXTERNAL [start: 0x1261568, end: 0x1262527] 478 | .gnu_debugaltlink [start: 0x0, end: 0x73] 479 | .gnu_debuglink [start: 0x0, end: 0x51] 480 | .shstrtab [start: 0x0, end: 0x279] 481 | _elfSectionHeaders [start: 0x0, end: 0x1855] 482 | Shutting down ghidra_bridge_server : 43841 483 | ``` 484 |
485 | 486 |
4. Run via launch on sample_pyghidra.py 487 | 488 | ```terminal 489 | (.env) vscode ➜ /workspaces/ghidra-python-vscode-devcontainer-skeleton (main ✗) $ cd /workspaces/ghidra-python-vscode-devcontainer-skeleton ; /usr/bin/env /workspaces/ghidra-python-vscode-devcontainer-skeleton/.env/bin/python /home/vscode/.vscode-server/extensions/ms-python.python-2022.12.0/pythonFiles/lib/python/debugpy/adapter/../../debugpy/launcher 40875 -- /workspaces/ghidra-python-vscode-devcontainer-skeleton/sample_pyghidra.py 490 | /ghidra/Ghidra/Framework/Utility/lib/Utility.jar 491 | INFO Using log config file: jar:file:/ghidra/Ghidra/Framework/Generic/lib/Generic.jar!/generic.log4j.xml (LoggingInitialization) 492 | INFO Using log file: /home/vscode/.ghidra/.ghidra_10.1.4_PUBLIC/application.log (LoggingInitialization) 493 | INFO Loading user preferences: /home/vscode/.ghidra/.ghidra_10.1.4_PUBLIC/preferences (Preferences) 494 | INFO Class search complete (813 ms) (ClassSearcher) 495 | INFO Initializing SSL Context (SSLContextInitializer) 496 | INFO Initializing Random Number Generator... (SecureRandomFactory) 497 | INFO Random Number Generator initialization complete: NativePRNGNonBlocking (SecureRandomFactory) 498 | INFO Trust manager disabled, cacerts have not been set (ApplicationTrustManagerFactory) 499 | INFO Opening project: /workspaces/ghidra-python-vscode-devcontainer-skeleton/.ghidra_projects/sample_project/sample_project/sample_project (DefaultProject) 500 | INFO DWARF external debug information found: ExternalDebugInfo [filename=1a4999161b8b2da681b80d8bf351e40afc40ad.debug, crc=1816f651, hash=9c1a4999161b8b2da681b80d8bf351e40afc40ad] (ExternalDebugFilesService) 501 | INFO Unable to find DWARF information, skipping DWARF analysis (DWARFAnalyzer) 502 | ERROR os/linux_arm_64/decompile does not exist (DecompileProcessFactory) 503 | INFO Packed database cache: /tmp/vscode-Ghidra/packed-db-cache (PackedDatabaseCache) 504 | INFO ----------------------------------------------------- 505 | AARCH64 ELF PLT Thunks 0.017 secs 506 | ASCII Strings 0.249 secs 507 | Apply Data Archives 0.230 secs 508 | Basic Constant Reference Analyzer 1.394 secs 509 | Call Convention ID 0.008 secs 510 | Call-Fixup Installer 0.004 secs 511 | Create Address Tables 0.024 secs 512 | Create Function 0.000 secs 513 | DWARF 0.017 secs 514 | Data Reference 0.037 secs 515 | Decompiler Switch Analysis 0.164 secs 516 | Demangler GNU 0.214 secs 517 | Disassemble Entry Points 0.013 secs 518 | Embedded Media 0.013 secs 519 | External Entry References 0.000 secs 520 | Function Start Search 0.106 secs 521 | Function Start Search After Code 0.012 secs 522 | Function Start Search After Data 0.031 secs 523 | GCC Exception Handlers 0.471 secs 524 | Non-Returning Functions - Discovered 0.026 secs 525 | Non-Returning Functions - Known 0.019 secs 526 | Reference 0.093 secs 527 | Shared Return Calls 0.026 secs 528 | Stack 0.069 secs 529 | Subroutine References 0.036 secs 530 | ----------------------------------------------------- 531 | Total Time 3 secs 532 | ----------------------------------------------------- 533 | (AutoAnalysisManager) 534 | Program Info: 535 | Program: ls: AARCH64:LE:64:v8A_default (Sat Aug 06 02:18:37 UTC 2022) 536 | 537 | Memory layout: 538 | Imagebase: 0x100000 539 | segment_2.1 [start: 0x1048576, end: 0x1049143] 540 | .interp [start: 0x1049144, end: 0x1049170] 541 | .note.gnu.build-id [start: 0x1049172, end: 0x1049207] 542 | .note.ABI-tag [start: 0x1049208, end: 0x1049239] 543 | .gnu.hash [start: 0x1049240, end: 0x1049303] 544 | .dynsym [start: 0x1049304, end: 0x1052423] 545 | .dynstr [start: 0x1052424, end: 0x1053877] 546 | .gnu.version [start: 0x1053878, end: 0x1054137] 547 | .gnu.version_r [start: 0x1054144, end: 0x1054255] 548 | .rela.dyn [start: 0x1054256, end: 0x1060087] 549 | .rela.plt [start: 0x1060088, end: 0x1062703] 550 | .init [start: 0x1062704, end: 0x1062723] 551 | .plt [start: 0x1062736, end: 0x1064511] 552 | .text [start: 0x1064512, end: 0x1149231] 553 | .fini [start: 0x1149232, end: 0x1149247] 554 | .rodata [start: 0x1149248, end: 0x1168549] 555 | .eh_frame_hdr [start: 0x1168552, end: 0x1170795] 556 | .eh_frame [start: 0x1170800, end: 0x1182903] 557 | .init_array [start: 0x1250024, end: 0x1250031] 558 | .fini_array [start: 0x1250032, end: 0x1250039] 559 | .data.rel.ro [start: 0x1250040, end: 0x1252607] 560 | .dynamic [start: 0x1252608, end: 0x1253119] 561 | .got [start: 0x1253120, end: 0x1253351] 562 | .got.plt [start: 0x1253352, end: 0x1254247] 563 | .data [start: 0x1254248, end: 0x1254935] 564 | .bss [start: 0x1254936, end: 0x1259735] 565 | EXTERNAL [start: 0x1261568, end: 0x1262527] 566 | .gnu_debugaltlink [start: 0x0, end: 0x73] 567 | .gnu_debuglink [start: 0x0, end: 0x51] 568 | .shstrtab [start: 0x0, end: 0x279] 569 | _elfSectionHeaders [start: 0x0, end: 0x1855] 570 | ``` 571 |
572 | 573 | ## Ghidra Python Headless Scripting Hangups 574 | 575 | 1. Ghidra runs Jython, not actually Python. It is limited to python 2.7 features. 576 | 2. In order to pass arguments to api calls like [askProgram](https://ghidra.re/ghidra_docs/api/ghidra/app/script/GhidraScript.html#askProgram(java.lang.String)) (which sets the current program being analyzed) either: 577 | - a `.properties` file needs to exist with the same name and location as the script being run. In this case a [sample.properties](sample.properties) sets the arguments for [sample.py](sample.py). 578 | - the args have to be passed on the command line when running `analyzeHeadless`. For [sample_bridge.py](sample_bridge.py), the args are awkwardly passed when ghidra_bridge_server [starts](sample_bridge.py#L37), as that server running within the Ghidra context is the only time analyzeHeadless is called. More details [here](https://github.com/justfoxing/ghidra_bridge#headless-analysis-context). 579 | 3. `ghidra-bridge` has to be started and running before you [connect](sample_bridge.py#L53) to it. The bridge can be started outside of sample_bridge.py, but you won't be able to pass arguments to it if neeed. Also, `ghidra-bridge` is slow for large analysis. Its best feature is the ability to step through and inspect the sample_bridge.py script within the IDE. 580 | 4. `pyghidra` - ~~Need to be wary of conflicting module names. As python stdlib and Ghidra have some conflicting module names (such as `pdb`), there are sometimes issues getting access to the full Ghidra Script API with `pyghidra`. Python prefers local modules and stdlib over the Java imports. This is due to [this issue](https://jpype.readthedocs.io/en/latest/userguide.html#importing-java-classes) in `jpype`.~~ No longer the case :) [Fixed](https://github.com/dod-cyber-crime-center/pyghidra/pull/18). 581 | -------------------------------------------------------------------------------- /import_bins.py: -------------------------------------------------------------------------------- 1 | import os 2 | import subprocess 3 | 4 | # Env vars from launch.json 5 | GHIDRA_HEADLESS = '/ghidra/support/analyzeHeadless' 6 | PROJECT_NAME = 'sample_pyghidra' 7 | PROJECT_LOCATION = '.ghidra_projects' 8 | PROJECT_PATH = os.path.join(PROJECT_LOCATION, PROJECT_NAME) 9 | 10 | # Project Path Needs to exist 11 | if not os.path.exists(PROJECT_PATH): 12 | os.mkdir(PROJECT_PATH) 13 | 14 | BINARY_PATH = "/bin/ls" 15 | 16 | # Arguments for Ghidra's Headless Analyzer 17 | args = [GHIDRA_HEADLESS, PROJECT_PATH, PROJECT_NAME, "-import", BINARY_PATH, "-overwrite"] 18 | 19 | print(args) 20 | 21 | subprocess.run(args) 22 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | ghidra-stubs -------------------------------------------------------------------------------- /run_headless.py: -------------------------------------------------------------------------------- 1 | import os 2 | import subprocess 3 | 4 | GHIDRA_HEADLESS = '/ghidra/support/analyzeHeadless' 5 | PROJECT_NAME = 'sample_pyghidra' 6 | PROJECT_LOCATION = '.ghidra_projects' 7 | PROJECT_PATH = os.path.join(PROJECT_LOCATION, PROJECT_NAME) 8 | 9 | SCRIPT = 'sample.py' 10 | BINARY = "ls" 11 | 12 | # Create Properties File to pass arguments to script 13 | PROPERTIES_PATH = os.path.basename(SCRIPT).strip('.py') + '.properties' 14 | PROPERTIES_TEMPLATE = '''program={BINARY}''' 15 | 16 | with open(PROPERTIES_PATH, 'w') as f: 17 | f.write(PROPERTIES_TEMPLATE.format(BINARY=BINARY)) 18 | 19 | # Arguments for Ghidra's Headless Analyzer 20 | args = [GHIDRA_HEADLESS, PROJECT_PATH, PROJECT_NAME, "-postscript", SCRIPT] 21 | 22 | print(args) 23 | print(PROPERTIES_TEMPLATE.format(BINARY=BINARY)) 24 | 25 | subprocess.run(args) 26 | -------------------------------------------------------------------------------- /sample.properties: -------------------------------------------------------------------------------- 1 | program=ls -------------------------------------------------------------------------------- /sample.py: -------------------------------------------------------------------------------- 1 | #TODO write a description for this script 2 | #@author 3 | #@category Functions 4 | #@keybinding 5 | #@menupath 6 | #@toolbar 7 | 8 | 9 | #TODO Add User Code Here 10 | 11 | 12 | #### Section to make autocomplete work 13 | try: 14 | import ghidra 15 | from ghidra_builtins import * 16 | 17 | except: 18 | pass 19 | #### 20 | 21 | project = state.getProject() 22 | projectData = project.getProjectData() 23 | rootFolder = projectData.getRootFolder() 24 | 25 | print(project) 26 | print(projectData) 27 | print(rootFolder) 28 | 29 | prog = askProgram("program") 30 | 31 | print("Program Info:") 32 | program_name = prog.getName() 33 | creation_date = prog.getCreationDate() 34 | language_id = prog.getLanguageID() 35 | compiler_spec_id = prog.getCompilerSpec().getCompilerSpecID() 36 | print("Program: {}: {}_{} ({})\n".format(program_name, language_id, compiler_spec_id, creation_date)) 37 | 38 | # Get info about the current program's memory layout 39 | print("Memory layout:") 40 | print("Imagebase: " + hex(prog.getImageBase().getOffset())) 41 | for block in prog.getMemory().getBlocks(): 42 | start = block.getStart().getOffset() 43 | end = block.getEnd().getOffset() 44 | print("{} [start: 0x{}, end: 0x{}]".format(block.getName(), start, end)) 45 | -------------------------------------------------------------------------------- /sample_bridge.py: -------------------------------------------------------------------------------- 1 | # TODO write a description for this script 2 | # @author 3 | # @category Functions 4 | # @keybinding 5 | # @menupath 6 | # @toolbar 7 | 8 | 9 | # TODO Add User Code Here 10 | 11 | # Section to make autocomplete work 12 | try: 13 | import ghidra 14 | from ghidra_builtins import * 15 | except: 16 | pass 17 | #### 18 | 19 | import ghidra_bridge 20 | 21 | # Start ghidra-bridge-server before we are able to connect so we can pass args 22 | import os 23 | import subprocess 24 | 25 | 26 | def is_port_in_use(port: int) -> bool: 27 | import socket 28 | with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: 29 | return s.connect_ex(('localhost', port)) == 0 30 | 31 | 32 | GHIDRA_HEADLESS = '/ghidra/support/analyzeHeadless' 33 | PROJECT_NAME = 'sample_pyghidra' 34 | PROJECT_LOCATION = '.ghidra_projects' 35 | PROJECT_PATH = os.path.join(PROJECT_LOCATION, PROJECT_NAME) 36 | GHIDRA_BRIDGE_INSTALL_DIR = '.ghidra_bridge' 37 | 38 | BINARY = "ls" 39 | 40 | args = [GHIDRA_HEADLESS, PROJECT_PATH, PROJECT_NAME, '-scriptPath', 41 | GHIDRA_BRIDGE_INSTALL_DIR, "-postscript", 'ghidra_bridge_server.py', BINARY] 42 | print(' '.join(args)) 43 | 44 | proc = None 45 | BRIDGE_PORT = 4768 46 | try: 47 | proc = subprocess.Popen(args, shell=False, preexec_fn=os.setsid) 48 | 49 | # Wait for ghidra_bridge_server to be ready 50 | import time 51 | while not is_port_in_use(BRIDGE_PORT): 52 | time.sleep(1) 53 | print("waiting for ghidra_bridge_server...") 54 | 55 | with ghidra_bridge.GhidraBridge(namespace=globals(), response_timeout=4, ): 56 | project = state.getProject() 57 | projectData = project.getProjectData() 58 | rootFolder = projectData.getRootFolder() 59 | 60 | print(project) 61 | print(projectData) 62 | print(rootFolder) 63 | 64 | prog = askProgram("program") 65 | 66 | print("Program Info:") 67 | program_name = prog.getName() 68 | creation_date = prog.getCreationDate() 69 | language_id = prog.getLanguageID() 70 | compiler_spec_id = prog.getCompilerSpec().getCompilerSpecID() 71 | print("Program: {}: {}_{} ({})\n".format(program_name, language_id, compiler_spec_id, creation_date)) 72 | 73 | # Get info about the current program's memory layout 74 | print("Memory layout:") 75 | print("Imagebase: " + hex(prog.getImageBase().getOffset())) 76 | for block in prog.getMemory().getBlocks(): 77 | start = block.getStart().getOffset() 78 | end = block.getEnd().getOffset() 79 | print("{} [start: 0x{}, end: 0x{}]".format(block.getName(), start, end)) 80 | 81 | # Give time for bridge connection to close 82 | time.sleep(2) 83 | finally: 84 | # Terminate ghidra_bridge_server to prevent another one starting next time 85 | import signal 86 | print(f"Shutting down ghidra_bridge_server : {proc.pid}") 87 | os.killpg(os.getpgid(proc.pid), signal.SIGINT) 88 | -------------------------------------------------------------------------------- /sample_pyhidra.py: -------------------------------------------------------------------------------- 1 | import os 2 | import pyghidra 3 | 4 | # Section to make autocomplete work 5 | try: 6 | import ghidra 7 | from ghidra_builtins import * 8 | except: 9 | pass 10 | #### 11 | 12 | PROJECT_NAME = 'sample_pyghidra' 13 | PROJECT_LOCATION = '.ghidra_projects' 14 | 15 | pyghidra.start(True) # setting Verbose output 16 | 17 | from ghidra.program.model.listing import Program 18 | 19 | with pyghidra.open_program("/bin/ls", project_name=PROJECT_NAME, project_location=PROJECT_LOCATION) as flat_api: 20 | 21 | 22 | # set correct typing to leverage autocomplete my_var: "ghidra-type" 23 | prog: "Program" = flat_api.getCurrentProgram() 24 | 25 | print("Program Info:") 26 | program_name = prog.getName() 27 | creation_date = prog.getCreationDate() 28 | language_id = prog.getLanguageID() 29 | compiler_spec_id = prog.getCompilerSpec().getCompilerSpecID() 30 | print("Program: {}: {}_{} ({})\n".format(program_name, 31 | language_id, compiler_spec_id, creation_date)) 32 | 33 | # Get info about the current program's memory layout 34 | print("Memory layout:") 35 | print("Imagebase: " + hex(prog.getImageBase().getOffset())) 36 | for block in prog.getMemory().getBlocks(): 37 | start = block.getStart().getOffset() 38 | end = block.getEnd().getOffset() 39 | print("{} [start: 0x{}, end: 0x{}]".format( 40 | block.getName(), start, end)) 41 | --------------------------------------------------------------------------------