Skip to content

Commit

Permalink
Ghidra 11 integration and new ghidrecomp docker image (#14)
Browse files Browse the repository at this point in the history
* add ghidra 11 images and python 3.12
* add new docker image
* bump ver for ghidra 11
* fix  10.1.5 test again
* add ghidrecomp docker file
  • Loading branch information
clearbluejar authored Jan 10, 2024
1 parent 0b5946c commit 289c1d4
Show file tree
Hide file tree
Showing 8 changed files with 150 additions and 66 deletions.
16 changes: 4 additions & 12 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,24 @@
{
"name": "ghidrecomp",
// image from https://github.com/clearbluejar/ghidra-python
"image": "ghcr.io/clearbluejar/ghidra-python:10.4ghidra3.11python-bookworm",
"image": "ghcr.io/clearbluejar/ghidra-python:11.0ghidra3.12python-bookworm",
// Configure tool-specific properties.
"customizations": {
// Configure properties specific to VS Code.
"vscode": {
// Set *default* container specific settings.json values on container create.
"settings": {
"python.defaultInterpreterPath": "/usr/local/bin/python",
"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
// VS code settings for ghidra-stubs autocomplete
"python.analysis.stubPath": "${workspaceFolder}/.env/lib/python3.11/site-packages/ghidra-stubs/",
"python.analysis.stubPath": "${workspaceFolder}/.env/lib/python3.12/site-packages/ghidra-stubs/",
"python.autoComplete.extraPaths": [
"${workspaceFolder}/.env/lib/python3.11/site-packages/ghidra-stubs/"
"${workspaceFolder}/.env/lib/python3.12/site-packages/ghidra-stubs/"
],
"python.analysis.extraPaths": [
"${workspaceFolder}/.env/lib/python3.11/site-packages/ghidra-stubs/"
"${workspaceFolder}/.env/lib/python3.12/site-packages/ghidra-stubs/"
],
"[python]": {
"editor.formatOnSave": true,
Expand Down
4 changes: 2 additions & 2 deletions .devcontainer/post-create.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ if uname -a | grep -q 'aarch64'; then
$GHIDRA_INSTALL_DIR/support/buildNatives
fi

# install local workspace
pip install -e .
# install local workspace and test requirements
pip install -e ".[testing]"
50 changes: 2 additions & 48 deletions .github/workflows/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,55 +1,9 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/python-3
{
"name": "ghidriff",
"name": "ghidriff-workflow-devcontainer",
// image from https://github.com/clearbluejar/ghidra-python
//"image": "ghcr.io/clearbluejar/ghidra-python:latest",
"image": "ghcr.io/clearbluejar/ghidra-python:${localEnv:DC_IMAGE_TAG}",
// Configure tool-specific properties.
// "customizations": {
// // Configure properties specific to VS Code.
// "vscode": {
// // Set *default* container specific settings.json values on container create.
// "settings": {
// "python.defaultInterpreterPath": "/usr/local/bin/python",
// "python.linting.enabled": true,
// "python.linting.pylintEnabled": true,
// "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
// "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
// "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
// "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
// "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
// "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
// "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
// "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
// "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
// // VS code settings for ghidra-stubs autocomplete
// "python.analysis.stubPath": "${workspaceFolder}/.env/lib/python3.11/site-packages/ghidra-stubs/",
// "python.autoComplete.extraPaths": [
// "${workspaceFolder}/.env/lib/python3.11/site-packages/ghidra-stubs/"
// ],
// "python.analysis.extraPaths": [
// "${workspaceFolder}/.env/lib/python3.11/site-packages/ghidra-stubs/"
// ],
// "[python]": {
// "editor.formatOnSave": true,
// },
// },
// // Add the IDs of extensions you want installed when the container is created.
// "extensions": [
// "ms-python.python",
// "ms-python.vscode-pylance",
// "yzhang.markdown-all-in-one"
// ]
// }
// },
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": [
// "bash",
// ".devcontainer/post-create.sh"
// ],
// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
"remoteUser": "vscode",
}
}
111 changes: 111 additions & 0 deletions .github/workflows/docker-build-publish.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
name: Docker-PyPi-Build-Publish

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

on:
schedule:
- cron: '31 19 * * 1'
push:
branches: [ "main","docker" ]
workflow_dispatch:

env:
# Use docker.io for Docker Hub if empty
REGISTRY: ghcr.io
# github.repository as <account>/<repo>
IMAGE_NAME: ${{ github.repository }}


jobs:
get-ver:
runs-on: ubuntu-latest
# Map a step output to a job output
outputs:
version: ${{ steps.step1.outputs.version }}
steps:
- id: step1
run: |
# https://stackoverflow.com/questions/70693375/how-to-output-the-latest-version-of-a-pip-package
VERSION=`python -m pip install --upgrade ghidrecomp== 2>&1 | grep "from versions:" | sed "s/^.*from versions: \(.*\))/\1/" | awk -F ", " '{print $NF}'`
echo $VERSION
echo "version=$VERSION" >> "$GITHUB_OUTPUT"
build:
runs-on: ubuntu-latest
needs: get-ver
permissions:
contents: read
packages: write
# This is used to complete the identity challenge
# with sigstore/fulcio when running outside of PRs.
id-token: write

steps:
- name: Checkout repository
uses: actions/checkout@v3

# Install the cosign tool except on PR
# https://github.com/sigstore/cosign-installer
- name: Install cosign
if: github.event_name != 'pull_request'
uses: sigstore/cosign-installer@6e04d228eb30da1757ee4e1dd75a0ec73a653e06 #v3.1.1
with:
cosign-release: 'v2.1.1'

# Set up BuildKit Docker container builder to be able to build
# multi-platform images and export cache
# https://github.com/docker/setup-buildx-action
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0

# Login against a Docker registry except on PR
# https://github.com/docker/login-action
- name: Log into registry ${{ env.REGISTRY }}
if: github.event_name != 'pull_request'
uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

# Extract metadata (tags, labels) for Docker
# https://github.com/docker/metadata-action
- name: Extract Docker metadata
id: meta
uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
latest
${{needs.get-ver.outputs.version}}
# Build and push Docker image with Buildx (don't push on PR)
# https://github.com/docker/build-push-action
- name: Build and push Docker image
id: build-and-push
uses: docker/build-push-action@v5 # v5.0.0
with:
context: .
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max
platforms: linux/amd64,linux/arm64

# Sign the resulting Docker image digest except on PRs.
# This will only write to the public Rekor transparency log when the Docker
# repository is public to avoid leaking data. If you would like to publish
# transparency data even for private images, pass --force to cosign below.
# https://github.com/sigstore/cosign
- name: Sign the published Docker image
if: ${{ github.event_name != 'pull_request' }}
env:
# https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable
TAGS: ${{ steps.meta.outputs.tags }}
DIGEST: ${{ steps.build-and-push.outputs.digest }}
# This step uses the identity token to provision an ephemeral certificate
# against the sigstore community Fulcio instance.
run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST}
12 changes: 10 additions & 2 deletions .github/workflows/pytest-devcontainer-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,16 @@ jobs:
fail-fast: false
matrix:
# cover the latest and all versions of all subreleases
# add "latest" when jpype is update for python 3.12
image: ["10.4ghidra3.11python-bookworm","10.4ghidra3.9python-bookworm", "10.3.3ghidra3.10python-bookworm", "10.2.3ghidra3.11python-bookworm", "10.1.5ghidra3.11python-bookworm" ]
image: [
"latest",
"11.0ghidra3.12python-bookworm",
"11.0ghidra3.11python-bookworm",
"10.4ghidra3.11python-bookworm",
"10.4ghidra3.9python-bookworm",
"10.3.3ghidra3.10python-bookworm",
"10.2.3ghidra3.11python-bookworm",
"10.1.5ghidra3.11python-bookworm"
]

steps:
- uses: actions/checkout@v3
Expand Down
19 changes: 19 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# From https://github.com/clearbluejar/ghidra-python
FROM ghcr.io/clearbluejar/ghidra-python:latest

ENV GHIDRA_INSTALL_DIR=/ghidra

USER vscode
WORKDIR /home/vscode/

# install latest from pip
RUN pip install ghidrecomp

RUN python -m pyhidra.install_plugins

# point absolute ghidriffs dir to user
# this supports absoulte mapping "docker run --rm -it -v ${PWD}/ghidriffs:/ghidriffs ghidriff /bin/cat1 /bin/cat2"
RUN ln -s /ghidrecomps /home/vscode/

ENTRYPOINT ["/home/vscode/.local/bin/ghidrecomp"]

2 changes: 1 addition & 1 deletion ghidrecomp/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = '0.4.3'
__version__ = '0.5.0'
__author__ = 'clearbluejar'

# Expose API
Expand Down
2 changes: 1 addition & 1 deletion tests/test_ghidrecomp.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def test_decomplie_afd(shared_datadir: Path):
all_funcs, decompilations, output_path, compiler, lang_id, callgraphs = decompile(args)

assert (len(all_funcs) == 1275 or len(all_funcs) == 1273 or len(all_funcs) == 1172)
assert (len(decompilations) == 1275 or len(decompilations) == 1273)
assert (len(decompilations) == 1275 or len(decompilations) == 1273 or len(decompilations) == 1172)
assert output_path == expected_output_path
assert compiler == 'visualstudio:unknown'
assert lang_id == 'x86:LE:64:default'
Expand Down

0 comments on commit 289c1d4

Please sign in to comment.