Merge remote-tracking branch 'origin/dev' into homegrown_powerpc

Author: galenbwill

.github/ISSUE_TEMPLATE/bug_report.md

@@ -32,11 +32,12 @@ If applicable, please add screenshots/video recording here to help explain your
 **Binary:**
 If applicable, please provide us with the binary to help us work with the issue faster. Here are a few options:
 
-1. Directly attach it to this issue in a ZIP archive
-2. Share a publicly accessible link to it (For malware samples, we do not have access to VirusTotal; [Malshare](https://malshare.com/) is an option)
-3. Email it to binaryninja at vector35.com, or join our [slack](https://slack.binary.ninja/) and share with us in private
-4. We understand sometimes it is not possible to share the binary -- sure, no worries, we can still work with it!
-5. If your issue is general and not related to a specific binary, then there is no need to attach the binary as well
+1. Upload it privately using the [Binary Ninja Portal file uploader](https://portal.binary.ninja/upload) and add the provided reference phrase here
+2. Directly attach it to this issue in a ZIP archive
+3. Share a publicly accessible link to it (For malware samples, we do not have access to VirusTotal; [Malshare](https://malshare.com/) is an option)
+4. Email it to binaryninja at vector35.com, or join our [Slack](https://slack.binary.ninja/) and share it with us in private
+5. We understand sometimes it is not possible to share the binary -- sure, no worries, we can still work with it!
+6. If your issue is general and not related to a specific binary, then there is no need to attach the binary as well
 
 **Additional Information:**
 Please add any other context about the problem here.

.github/workflows/rust.yml

@@ -1,44 +1,75 @@
-name: Rust PR Checks
+name: Rust CI
 
 on:
+  workflow_dispatch:
+  push:
+    branches:
+      - '**'
+    paths:
+      - '**.rs'
+      - '**.toml'
+      - 'rust/**'
   pull_request:
     paths:
       - 'rust/**'
 
 jobs:
-  build_and_lint:
-    name: cargo check & cargo clippy
+  # Check lints with clippy
+  clippy:
+    name: cargo clippy
     runs-on: ubuntu-latest
-
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-        with:
-          submodules: true
-
-      - name: Install Clang
-        run: |
-          sudo apt update
-          sudo apt install clang -y
-
-      - name: Install Rust
-        uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v4
+      # Ensure clippy is installed
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
           toolchain: 1.83.0
-          profile: minimal
-          override: true
           components: clippy
+      - name: Clippy Check
+        uses: clechasseur/rs-clippy-check@v4
+        with:
+          # We do not run clippy on plugins.
+          args: -p binaryninja --all-features
 
-      - name: cargo check
-        working-directory: ./rust
-        run: cargo check --workspace --all-features
+  # Check formatting with rustfmt
+  formatting:
+    name: cargo fmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # Ensure rustfmt is installed
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: 1.83.0
+          components: rustfmt
+      - name: Rustfmt Check
+        uses: actions-rust-lang/rustfmt@v1
 
-      - name: cargo doc test
-        working-directory: ./rust
-        run: cargo test --doc -- --show-output
+  # Check spelling with typos
+  spelling:
+    name: typos
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Typo Check
+        uses: crate-ci/[email protected]
+        with:
+          files: ./rust
 
-      - name: cargo clippy
-        working-directory: ./rust
-        run: cargo clippy -- -D warnings
-        continue-on-error: true
-        # If this step fails, it will warn (?)
+  # Check licensing and produce a list of licenses
+  licensing:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install cargo-about
+        uses: baptiste0928/cargo-install@v3
+        with:
+          crate: cargo-about
+          version: "0.6.6"
+      - name: Run license check
+        run: cargo about generate about.hbs > license.html
+      - name: Archive license file
+        uses: actions/upload-artifact@v4
+        with:
+          name: license
+          path: license.html

.github/workflows/rust_testing.yml

@@ -0,0 +1,46 @@
+name: Rust Testing
+
+# This workflow will have access to two secrets, `BN_SERIAL` and `BN_LICENSE`, they are exposed only for the test job
+# and only if workflow has been approved to run. If there is no approval they workflow won't run.
+# What security issues arise from this? If a person makes a PR that leaks the `BN_SERIAL` or `BN_LICENSE` and a maintainer
+# approves it than the those secrets would leak.
+
+on:
+  workflow_dispatch:
+  # Pull request target allows us to use the bn license and serial for PR's
+  # to insure we do not leak the license the workflow is required to be approved manually.
+  pull_request_target:
+    paths:
+      - '**.rs'
+      - '**.toml'
+      - 'rust/**'
+
+jobs:
+  # Check that code compiles and tests pass
+  test:
+    # Using the testing environment gives us the needed secrets, it also requires a maintainer to approve it to run.
+    environment: testing
+    name: cargo test
+    runs-on: ubuntu-latest
+    permissions:
+      issues: read
+    steps:
+      - uses: actions/checkout@v4
+        # We need to add wayland as it's used for file picker in the WARP integration
+      - name: Install system dependencies
+        run: sudo apt-get install libwayland-dev
+        # Pull in Binary Ninja
+      - name: Setup Binary Ninja
+        id: setup-binja
+        uses: Vector35/setup-binary-ninja@v1-beta
+        with:
+          license: '${{ secrets.BN_SERIAL }}'
+          python-support: 'false'
+          dev-branch: 'true'
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - name: Test
+        # For now, we run the tests single threaded, there are some data races in core around platform types
+        run: cargo test --all-features -- --test-threads=1
+        env:
+          BINARYNINJADIR: ${{ steps.setup-binja.outputs.install-path }}
+          BN_LICENSE: ${{ secrets.BN_LICENSE }}

.gitignore

@@ -33,6 +33,7 @@ python/generator.log
 python/generator.tlog
 .cache/
 target/
+view/sharedcache/api/python/_sharedcachecore.py
 
 # Unit Tests
 suite/unit.py
@@ -84,6 +85,8 @@ rust/target/
 rust/binaryninjacore-sys/target/
 rust/examples/*/target/
 rust/examples/dwarf/*/target/
+# Allow the test binaries
+!/rust/fixtures/bin/**
 
 # Debugger docs
 docs/img/debugger

.gitmodules

@@ -16,6 +16,3 @@
 [submodule "arch/x86/mbuild"]
 	path = arch/x86/mbuild
 	url = https://github.com/intelxed/mbuild.git
-[submodule "rust/examples/pdb-ng/pdb-0.8.0-patched"]
-	path = rust/examples/pdb-ng/pdb-0.8.0-patched
-	url = https://github.com/Vector35/pdb-rs.git