Bump version 1.0.1

Author: Fenrisfulsur

.env

@@ -2,4 +2,4 @@ ELASTIC_PASSWORD=passwordSUPERPAssword
 ELASTIC_USERNAME=bsim
 CERTS_DIR=/cert
 BASE_URL=ghcr.io/quarkslab/sighthouse
-VERSION="1.0.0"
+VERSION="1.0.1"

.github/workflows/ci.yml

@@ -135,3 +135,52 @@ jobs:
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
+
+  pypi:
+    environment: release
+    name: upload release to PyPI (${{ matrix.package }})
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    strategy:
+      matrix:
+        package:
+          - .
+          - sighthouse-cli
+          - sighthouse-client
+          - sighthouse-core
+          - sighthouse-frontend
+          - sighthouse-pipeline
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: deps
+        run: python -m pip install -U build
+
+      - name: build
+        run: python -m build ${{ matrix.package }}
+
+      - name: mint API token
+        id: mint-token
+        run: |
+          resp=$(curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" \
+            "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=pypi")
+          oidc_token=$(jq -r '.value' <<< "${resp}")
+
+          resp=$(curl -X POST https://pypi.org/_/oidc/mint-token -d "{\"token\": \"${oidc_token}\"}")
+          api_token=$(jq -r '.token' <<< "${resp}")
+
+          echo "::add-mask::${api_token}"
+          echo "api-token=${api_token}" >> "${GITHUB_OUTPUT}"
+
+      - name: publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ steps.mint-token.outputs.api-token }}
+          packages-dir: ${{ matrix.package }}/dist/

Makefile

@@ -1,9 +1,22 @@
+VERSION = 1.0.1
 
 default: help
 
 help: # Show help for each of the Makefile recipes.
 	@grep -E '^[a-zA-Z0-9 -]+:.*#'  Makefile | sort | while read -r l; do printf "\033[1;32m$$(echo $$l | cut -f 1 -d':')\033[00m:$$(echo $$l | cut -f 2- -d'#')\n"; done
 
+bump: # Bump the version .
+	@echo "[+] Bump package version $(VERSION)"
+	@# Update docker version
+	@sed -i "s/VERSION=.*/VERSION=\"$(VERSION)\"/" .env
+	@# Update pyprojects
+	@sed -i "s/version = .*/version = \"$(VERSION)\"/" sighthouse-cli/pyproject.toml 
+	@sed -i "s/version = .*/version = \"$(VERSION)\"/" sighthouse-client/pyproject.toml 
+	@sed -i "s/version = .*/version = \"$(VERSION)\"/" sighthouse-core/pyproject.toml 
+	@sed -i "s/version = .*/version = \"$(VERSION)\"/" sighthouse-frontend/pyproject.toml 
+	@sed -i "s/version = .*/version = \"$(VERSION)\"/" sighthouse-pipeline/pyproject.toml 
+	@sed -i "s/__version__ = .*/__version__ = \"$(VERSION)\"/" src/sighthouse/version.py
+
 lint: # Format with black and lint with ruff.
 	@echo "[+] Linting"
 	@if [ ! -d "./venv" ]; then echo "No venv detected. Please use 'make install-dev' first."; exit 1; fi
@@ -63,6 +76,10 @@ install-dev: install-hooks
 	@. ./venv/bin/activate && pip install .[all]
 	@. ./venv/bin/activate && pip install pytest mypy black pytest-cov
 
+release:
+	@. ./venv/bin/activate && pip install build wheel
+
+
 clean: # Clean build artefacts
 	@echo "[+] Clean"
 	@find . -name '__pycache__' -type d -exec rm -rf {} +

doc/docs/assets/images/demo-pwn2own.mp4

@@ -14,9 +14,18 @@ different Software Reverse Engineering (SRE) tools.
 In order to run the SightHouse plugin, you will need at least [Ghidra 11.3](https://github.com/NationalSecurityAgency/ghidra/releases/tag/Ghidra_11.3_build)
 as it now come with Python 3 support thought pyGhidra. 
 
-We advise you to launch for a first time ghidra before installed this plugin.
+We advise you to launch for a first time ghidra before installing this plugin.
+
+The easiest way to install the Ghidra plugin is to install the `sighthouse-client` 
+package and then run the following commands.
+
+```bash
+pip install sighthouse-client
+sighthouse client install ghidra --ghidra-install-dir /path/to/ghidra
+```
+
+It's also possible to install it from the repository:
 
-To install the Ghidra plugin use the following commands:
 ```bash
 git clone https://github.com/quarkslab/sighthouse
 cd sighthouse/sighthouse-client
@@ -38,7 +47,16 @@ client dependencies and then ask you where you want to copy your script.
 
 </div>
 
-To install the IDA plugin use the following commands:
+The easiest way to install the IDA plugin is to install the `sighthouse-client` 
+package and then run the following commands.
+
+```bash
+pip install sighthouse-client
+sighthouse client install ida --ida-dir /path/to/ida_dir
+```
+
+It's also possible to install it from the repository:
+
 ```bash
 git clone https://github.com/quarkslab/sighthouse
 cd sighthouse/sighthouse-client
@@ -54,7 +72,16 @@ IDA_DIR=/path/to/ida_dir make install_ida
 
 </div>
 
-To install the Binary Ninja plugin use the following commands:
+The easiest way to install the Binary Ninja plugin is to install
+the `sighthouse-client` package and then run the following commands.
+
+```bash
+pip install sighthouse-client
+sighthouse client install binja
+```
+
+It's also possible to install it from the repository:
+
 ```bash
 git clone https://github.com/quarkslab/sighthouse
 cd sighthouse/sighthouse-client

doc/docs/clients/installation.md

@@ -6,20 +6,6 @@ run SightHouse without any arguments to get the help:
 ```bash
 $ sighthouse
 
-          _^_
-          |@|
-         =====
-          #::
-          #::     SightHouse v1.0.0
-          #::        by: Fenrisfulsur & Madsquirrels
-          #::
-          #::
-          #::
-        ###::^-..
-                 ^ ~ ~~ ~~ ~ ~ ~
-                  \~~ ~~ ~ ~  ~~~~~
-
-
 usage: sighthouse [-h] [--version] [-d] {package,pipeline,frontend} ...
 
 SightHouse CLI
@@ -81,51 +67,35 @@ simplify this process, we provided a Docker Compose file, allowing you to deploy
 services:
   redis:
     image: redis:7
-    hostname: redis
     volumes:
       - ./data/redis:/data
 
   bsim_postgres:
-    image: ghidra-bsim-postgres:1.0.0
-    hostname: bsim_postgres
+    image: ghcr.io/quarkslab/sighthouse/ghidra-bsim-postgres:latest
     volumes:
       - ./data/postgres:/home/user/ghidra-data
-    ports:
-      - 5432:5432
-    restart: unless-stopped
-    healthcheck:
-      test: ["CMD-SHELL", "/ghidra/Ghidra/Features/BSim/support/pg_is_ready.sh || exit 1 "]
-      retries: 5
-      interval: "30s"
-      timeout: "5s"
 
   create_user:
-    image: sighthouse:1.0.0
-    entrypoint: '/home/user/.local/bin/sighthouse'
-    command: 'frontend add-user -d sqlite:////data/frontend.db user -p password'
-    restart: no
+    image: ghcr.io/quarkslab/sighthouse/sighthouse-frontend:latest
+    entrypoint: sighthouse
+    command: "frontend add-user -d sqlite:////data/frontend.db user -p password"
+    restart: "no"
     volumes:
       - ./data/frontend:/data
 
-
   sighthouse_frontend:
-    image: sighthouse:1.0.0
-    restart: unless-stopped
-    entrypoint: '/home/user/.local/bin/sighthouse'
-    command: 'frontend -g /ghidra -d sqlite:////data/frontend.db -r local://data start -w redis://redis:6379/0 -b postgresql://user@bsim_postgres:5432/bsim'
-    healthcheck:
-      test: ["CMD-SHELL", "curl http://localhost:6671/api/v1/ping || exit 1 "]
-      retries: "5"
-      interval: "60s"
-      timeout: "5s"
-    volumes:
-      - ./data/frontend:/data
-    depends_on:
-      - create_user
-      - bsim_postgres
-      - redis
+    image: ghcr.io/quarkslab/sighthouse/sighthouse-frontend:latest
+    command: >
+      frontend -g /ghidra -d sqlite:////data/frontend.db
+      -r local://data start
+      -w redis://redis:6379/0
+      -b postgresql://user@bsim_postgres:5432/bsim
     ports:
       - "6669:6671"
+    volumes:
+      - ./data/frontend:/data
+    depends_on: [create_user, bsim_postgres, redis]
 ```
 
-The frontend can then simply be started using `docker compose up -d`.
+The frontend can then simply be started using `docker compose up -d`. 
+The API will be available on port 6669.

doc/docs/frontend/quickstart.md

@@ -8,6 +8,10 @@ collection for function extraction, SightHouse automatically scrapes, compiles,
 new projects. This process allows us to continuously enhance and expand the database with new
 signatures.
 
+<video autoplay muted>
+  <source src="assets/images/demo-pwn2own.mp4" type="video/mp4"/>
+</video>
+
 ## What are you looking for ? 
 
 You either ended up on your own or somebody <s>forced</s> incited you to test SightHouse. In any case, you