Merge pull request #729 from dfir-iris/develop

v2.5.0-beta.1

Author: whikernel

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.4.20
+current_version = 2.5.0-beta.1
 commit = True
 tag = True
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(-(?P<release>.*)-(?P<build>\d+))?

.devcontainer/Dockerfile

@@ -0,0 +1,15 @@
+FROM mcr.microsoft.com/devcontainers/python:1-3.9-bullseye
+
+ENV PYTHONUNBUFFERED 1
+
+# [Optional] If your requirements rarely change, uncomment this section to add them to the image.
+# COPY requirements.txt /tmp/pip-tmp/
+# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
+#    && rm -rf /tmp/pip-tmp
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+
+

.devcontainer/devcontainer.json

@@ -0,0 +1,48 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/postgres
+{
+	"name": "iris-web",
+	"dockerComposeFile": "docker-compose.yml",
+	"service": "devcontainer",
+	"workspaceFolder": "/workspaces/iris-web",
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+	// forward web app & postgres to host
+	"forwardPorts": [
+		8000,
+		5432
+	],
+	// Configure tool-specific properties.
+	// "customizations": {},
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+	// https://containers.dev/implementors/json_reference/#lifecycle-scripts
+	// prep our environment before creating & starting container
+	"initializeCommand": "sh '${localWorkspaceFolder}/.devcontainer/pre-create.sh'",
+	// setup the dev env after the container was setup
+	"postCreateCommand": "sh /workspaces/iris-web/.devcontainer/post-create.sh",
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				// python-related
+				"ms-python.python",
+				"ms-python.vscode-pylance",
+				"KevinRose.vsc-python-indent",
+				"njpwerner.autodocstring",
+
+				// github
+				"github.vscode-github-actions",
+				"GitHub.vscode-pull-request-github",
+
+				// yaml-related
+				"redhat.vscode-yaml",
+
+				// docker-related
+				"ms-azuretools.vscode-docker",
+
+				// utils
+				"mtxr.sqltools"
+			]
+		}
+	}
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,62 @@
+version: "3.8"
+
+volumes:
+  iris_data:
+  postgres_data:
+
+networks:
+  devcontainer:
+
+services:
+  # Our dev env & workspace lives in this container
+  devcontainer:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+    volumes:
+      - ..:/workspaces/iris-web:cached
+      - iris_data:/home/vscode/iris_data
+    command: sleep infinity
+    networks:
+      - devcontainer
+    env_file:
+      - ../.env
+    environment:
+      - DOCKERIZED=1
+      - IRIS_ORGANISATION_NAME=DFIR IRIS Web DevContainer
+      - IRIS_LOGIN_BANNER_TEXT=You've successfully setup DFIR IRIS in a DevContainer! Default credentials are username "devcontainer" / password "DevContainersR0ck!".
+      - IRIS_ADM_PASSWORD=DevContainersR0ck!
+      - IRIS_ADM_API_KEY=B8BA5D730210B50F41C06941582D7965D57319D5685440587F98DFDC45A01594
+      - IRIS_ADM_EMAIL=admin@localhost
+      - IRIS_ADM_USERNAME=devcontainer
+      - IRIS_ASSET_STORE_PATH=/home/vscode/iris_data/custom_assets
+      - IRIS_BACKUP_PATH=/home/vscode/iris_data/backup
+      - IRIS_DATASTORE_PATH=/home/vscode/iris_data/datastore
+      - IRIS_TEMPLATES_PATH=/home/vscode/iris_data/user_templates
+      - IRIS_UPDATES_PATH=/home/vscode/iris_data/updates
+      - IRIS_UPLOADED_PATH=/home/vscode/iris_data/downloads
+
+  # ---- iris dependencies --------------------------------
+
+  # Postgres
+  db:
+    build:
+      context: ../docker/db
+    restart: unless-stopped
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    networks:
+      - devcontainer
+    environment:
+      POSTGRES_ADMIN_USER:
+      POSTGRES_ADMIN_PASSWORD:
+      POSTGRES_USER:
+      POSTGRES_DB:
+      POSTGRES_PASSWORD:
+
+  # RabbitMQ
+  rabbitmq:
+    image: rabbitmq:3-management-alpine
+    restart: unless-stopped
+    networks:
+      - devcontainer

.devcontainer/post-create.sh

@@ -0,0 +1,12 @@
+#
+# after our initial creation of the devcontainer, we will...
+#
+
+# mark workspace dir as safe dir for git (b/c container user != host user)
+git config --global --add safe.directory /workspaces/iris-web
+
+# change working dir to source 
+cd source
+
+# install python dependencies
+pip install -r requirements.txt

.devcontainer/pre-create.sh

@@ -0,0 +1,11 @@
+#
+# before we build the image & create the devcontainer, we will...
+#
+
+echo $PWD
+
+# copy `.env.model` to `.env` if it doesn't exist already
+if [ ! -f .env ]; then
+    echo ".env not found, cloning .env.model"
+    cp .env.model .env
+fi

.env.model

@@ -1,3 +1,6 @@
+# -- COMMON
+LOG_LEVEL=info
+
 # -- NGINX
 NGINX_IMAGE_NAME=ghcr.io/dfir-iris/iriswebapp_nginx
 NGINX_IMAGE_TAG=latest
@@ -30,6 +33,12 @@ IRIS_SECURITY_PASSWORD_SALT=ARandomSalt-NotThisOneEither
 IRIS_UPSTREAM_SERVER=app
 IRIS_UPSTREAM_PORT=8000
 
+IRIS_FRONTEND_SERVER=frontend
+IRIS_FRONTEND_PORT=5173
+
+IRIS_SVELTEKIT_FRONTEND_DIR=../iris-frontend
+
+
 # -- WORKER
 CELERY_BROKER=amqp://rabbitmq
 
@@ -67,6 +76,18 @@ IRIS_AUTHENTICATION_TYPE=local
 #LDAP_PRIVATE_KEY=
 #LDAP_PRIVATE_KEY_PASSWORD=
 
+# -- FOR OIDC AUTHENTICATION
+# IRIS_AUTHENTICATION_TYPE=oidc
+# OIDC_ISSUER_URL=
+# OIDC_CLIENT_ID=
+# OIDC_CLIENT_SECRET=
+# endpoints only required if provider doesn't support metadata discovery
+# OIDC_AUTH_ENDPOINT=
+# OIDC_TOKEN_ENDPOINT=
+# optional to include logout from oidc provider
+# OIDC_END_SESSION_ENDPOINT=
+# OIDC redirect URL for your IDP: https://<IRIS_SERVER_NAME>/oidc-authorize
+
 # -- LISTENING PORT
 INTERFACE_HTTPS_PORT=443