Release 1.0.0

Author: stephen-f0

.github/CODE OF CONDUCT.md

@@ -0,0 +1,77 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at info@foundryzero.co.uk . All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Foundry Zero Open Source Project Contributing Guide
+
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+
+The following is a set of guidelines for contributing to ghidra-deep-links which is hosted in the Foundry Zero organisation on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+## Code of Conduct
+This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to info@foundryzero.co.uk.
+
+## What should I know before I get started?
+
+Take a look at the [README.md](https://github.com/foundryzero/ghidra-deep-links/blob/main/README.md) for more information about ghidra-deep-links.
+ 
+## How Can I Contribute?
+
+### Your First Code Contribution
+
+Unsure where to begin contributing to ghidra-deep-links? You can start by looking through these `beginner` and `help-wanted` issues:
+
+* [Beginner issues](https://github.com/foundryzero/ghidra-deep-links/labels/good%20first%20issue) - issues which should only require a few lines of code, and a test or two.
+* [Help wanted issues](https://github.com/foundryzero/ghidra-deep-links/labels/help-wanted) - issues which should be a bit more involved than `beginner` issues.
+
+#### Pull Requests
+
+The process described here has several goals:
+
+- Maintain ghidra-deep-links's quality
+- Fix problems that are important to users
+- Engage the community in working toward the best possible ghidra-deep-links
+
+While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
+
+
+### Reporting Bugs
+
+#### Before Submitting A Bug Report
+
+Before submitting a bug report, please check to see if the bug has already been raised as an issue by searching [our github issues](https://github.com/foundryzero/ghidra-deep-links/labels/bug)
+
+#### How Do I Submit A (Good) Bug Report?
+
+Bugs are tracked as GitHub issues. Please raise your bug as a GitHub issue using our [enhancement template](https://github.com/foundryzero/ghidra-deep-links/blob/main/.github/ISSUE_TEMPLATE/BUG%20REPORT.md).
+
+Explain the problem and include additional details to help maintainers reproduce the problem:
+
+* Use a clear and descriptive title for the issue to identify the problem.
+* Describe the exact steps which reproduce the problem in as many details as possible.
+* Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
+* Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
+* Explain which behavior you expected to see instead and why.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for ghidra-deep-links, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
+
+#### Before Submitting A Feature Request
+
+Before submitting a feature request, please check to see if the bug has already been raised as an issue by searching [our github issues](https://github.com/foundryzero/ghidra-deep-links/labels/enhancement)
+
+#### How Do I Submit A (Good) Enhancement Suggestion?
+
+Features are tracked as GitHub issues. Please raise your bug as a GitHub issue using our [bug issue template](https://github.com/foundryzero/ghidra-deep-links/blob/main/.github/ISSUE_TEMPLATE/FEATURE%20REQUEST.md).
+
+* **Use a clear and descriptive title** for the issue to identify the suggestion.
+* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
+* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the current behavior** and **explain which behavior you would like to see instead** and why.
+* **Explain why this enhancement would be useful**
+* **Specify the name and version of the OS you're using.**
+
+
+## Attribution
+
+This contributor guide is based on the [guide](https://github.com/atom/atom/blob/master/.CONTRIBUTING/CONTRIBUTING.md) developed by the Atom project

.github/ISSUE_TEMPLATE/BUG REPORT.md

@@ -0,0 +1,25 @@
+### Environment
+
+Please list the OS, version of ghidra and version of ghidra-deep-links under which this bug was experienced.
+
+### Description
+
+<!-- Description of the issue -->
+
+### Steps to Reproduce
+
+1. <!-- First Step -->
+2. <!-- Second Step -->
+3. <!-- and so on… -->
+
+**Expected behavior:**
+
+What you expect to happen
+
+**Actual behavior:**
+
+What actually happens
+
+### Additional Information
+
+Any additional information, configuration or data that might be necessary to reproduce the issue.

.github/ISSUE_TEMPLATE/FEATURE REQUEST.md

@@ -0,0 +1,15 @@
+## Summary
+
+<!-- One paragraph explanation of the feature. -->
+
+## Motivation
+
+<!-- Why are we doing this? What use cases does it support? What is the expected outcome? -->
+
+## Describe alternatives you've considered
+
+<!-- A clear and concise description of the alternative solutions you've considered. Be sure to explain why ghidra-deep-links's existing functionality doesn't cover this feature. -->
+
+## Additional context
+
+<!-- Add any other context or screenshots about the feature request here. -->

.github/workflows/mac_app.yml

@@ -0,0 +1,44 @@
+name: build mac middleware
+on: workflow_dispatch
+jobs:
+  build:
+    runs-on: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      
+      - name: Create output directories
+        run: mkdir -p bundle/GhidraDeepLinksHandler.app/Contents/MacOS && mkdir -p bundle/GhidraDeepLinksHandler.app/Contents/Resources
+        working-directory: os/mac
+
+      - name: Copy Info.plist
+        run: cp Info.plist bundle/GhidraDeepLinksHandler.app/Contents/Info.plist
+        working-directory: os/mac
+
+      - name: Copy icon
+        run: cp ghidra-deep-links-logo.icns bundle/GhidraDeepLinksHandler.app/Contents/Resources/ghidra-deep-links-logo.icns
+        working-directory: os/mac
+
+      - name: Build x86_64
+        run: clang -target x86_64-apple-macos10.12 -framework Cocoa -lobjc *.m -o main-x86_64
+        working-directory: os/mac
+      
+      - name: Build ARM64
+        run: clang -target arm64-apple-macos11 -framework Cocoa -lobjc *.m -o main-arm64
+        working-directory: os/mac
+
+      - name: Package universal binary
+        run: lipo -create -output bundle/GhidraDeepLinksHandler.app/Contents/MacOS/main main-x86_64 main-arm64
+        working-directory: os/mac
+
+      - name: Create dmg
+        run: hdiutil create /tmp/tmp.dmg -ov -volname "DeeplinksHandlerInstall" -fs HFS+ -srcfolder os/mac/bundle
+      
+      - name: Finalise dmg
+        run: hdiutil convert /tmp/tmp.dmg -format UDZO -o GhidraDeepLinksHandler.dmg
+
+      - name: Export artifacts 2
+        uses: actions/upload-artifact@v3
+        with:
+          name: GhidraDeepLinksHandler
+          path: GhidraDeepLinksHandler.dmg

.github/workflows/main.yml

@@ -0,0 +1,22 @@
+on: workflow_dispatch
+name: build
+jobs:
+  build-matrix:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ghidra_version: ['10.4', '10.3.3', '10.3.2', '10.3.1', '10.3']
+    steps:
+      - name: checkout repo
+        uses: actions/checkout@v3
+
+      - name: build
+        env: 
+          GHIDRA_VERSION: ${{ matrix.ghidra_version }}
+        run: docker compose up --exit-code-from build.service
+
+      - name: export artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: dist-${{ matrix.ghidra_version }}
+          path: extension/dist/*.zip

.gitignore

@@ -0,0 +1,11 @@
+*.class
+bin/
+.gradle/
+build/
+.settings/
+.project
+dist/
+.pydevproject
+.classpath
+
+.DS_Store

BUILDING.md

@@ -0,0 +1,38 @@
+### Requirements
+
+- Docker, Docker Compose (only if building with docker, see below)
+- Java JDK 17+
+- Gradle
+
+# Docker
+
+### Requirements
+
+- Docker
+- Docker Compose v2
+- A network connection on the build machine
+
+```
+git clone https://github.com/foundryzero/ghidra-deep-links.git
+cd ghidra-deep-links
+GHIDRA_VERSION=10.3.3 docker compose up --exit-code-from build.service
+```
+
+Prior to ghidra 10.3.2, ghidra plugins needed to be built against each new release of ghidra in order to be compatible. As of 10.3.2 it is possible to bypass the compatibility check, but it is still advisable to build the plugin for each specific version. To build for a different ghidra version, edit the `GHIDRA_VERSION` environment variable.
+
+# Manual
+
+### Requirements
+
+- Java JDK 17+
+- Gradle
+- Ghidra (of the version you're building against)
+
+```
+git clone https://github.com/foundryzero/ghidra-deep-links.git
+cd ghidra-deep-links/extension
+gradle -PGHIDRA_INSTALL_DIR=/path/to/ghidra/install
+```
+
+However you build, the built extension will be placed in `dist/` in the source directory.
+

Dockerfile

@@ -0,0 +1,8 @@
+FROM gradle:jdk19
+
+RUN apt-get update && apt-get install python3-pip -y && rm -rf /var/lib/apt/lists/*
+RUN bash -c "AIOHTTP_NO_EXTENSIONS=1 pip3 install pygithub"
+
+COPY docker_build.py /docker_build.py
+
+CMD [ "python3", "-u", "/docker_build.py" ]