Merge branch 'master' into apsw-with-sqlalchemy

Signed-off-by: Achintya Jai <[email protected]>

Author: pUrGe12

.coderabbit.yaml

@@ -0,0 +1,22 @@
+chat:
+  auto_reply: true
+code_generation:
+  docstrings:
+    language: en-US
+early_access: true
+language: en-US
+reviews:
+  assess_linked_issues: true
+  auto_apply_labels: false
+  auto_review:
+    enabled: true
+    drafts: true
+  collapse_walkthrough: false
+  high_level_summary: true
+  high_level_summary_in_walkthrough: true
+  labeling_instructions: []
+  poem: false
+  profile: chill
+  request_changes_workflow: false
+  review_status: true
+  sequence_diagrams: false

.data/readme.md

@@ -23,9 +23,10 @@ Your PR description goes here.
 - [ ] Bugfix (non-breaking change which fixes an issue)
 - [ ] Code refactoring without any functionality changes
 - [ ] New or existing module/payload change
-- [ ] Localization improvement
+- [ ] Documentation/localization improvement
+- [ ] Test coverage improvement
 - [ ] Dependency upgrade
-- [ ] Documentation improvement
+- [ ] Other improvement (best practice, cleanup, optimization, etc)
 
 ## Checklist
 

.data/results/readme.md

@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -47,7 +47,7 @@ jobs:
           - python
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v3
@@ -67,7 +67,7 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -90,7 +90,7 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -123,15 +123,15 @@ jobs:
           - ubuntu-24.04
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: '3.11'
 
       - name: Get package artifacts
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: dist
           path: dist
@@ -154,53 +154,49 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Build Docker image
         run: docker build . -t nettacker
 
       - name: Test help menu
         run: |
-          docker run -e github_ci=true --rm nettacker \
-            poetry run python nettacker.py --help
+          docker run -e github_ci=true --rm nettacker --help
 
       - name: Test help menu in Persian
         run: |
-          docker run -e github_ci=true --rm nettacker \
-            poetry run python nettacker.py --help -L fa
+          docker run -e github_ci=true --rm nettacker --help -L fa
 
       - name: Show all modules
         run: |
-          docker run -e github_ci=true --rm nettacker \
-            poetry run python nettacker.py --show-all-modules
+          docker run -e github_ci=true --rm nettacker --show-all-modules
 
       - name: Show all profiles
         run: |
-          docker run -e github_ci=true --rm nettacker \
-            poetry run python nettacker.py --show-all-profiles
+          docker run -e github_ci=true --rm nettacker --show-all-profiles
 
       - name: Test all modules command + check if it's finish successfully + csv
         run: |
-          docker run -e github_ci=true --rm -i nettacker \
-            poetry run python nettacker.py -i 127.0.0.1 -u user1,user2 -p pass1,pass2 -m all -g 21,25,80,443 \
+          docker run -e github_ci=true --rm -i --add-host=host.docker.internal:host-gateway nettacker \
+            -i host.docker.internal -u user1,user2 -p pass1,pass2 -m all -g 21,25,80,443 \
               -t 1000 -T 3 -o out.csv
 
       - name: Test all modules command + check if it's finish successfully + csv
         run: |
-          docker run -e github_ci=true --rm -i nettacker \
-            poetry run python nettacker.py -i 127.0.0.1 -u user1,user2 -p pass1,pass2 -m all -g 21,25,80,443 \
+          docker run -e github_ci=true --rm -i --add-host=host.docker.internal:host-gateway nettacker \
+            -i host.docker.internal -u user1,user2 -p pass1,pass2 -m all -g 21,25,80,443 \
               -t 1000 -T 3 -o out.csv --skip-service-discovery
 
       - name: Test all modules command + check if it's finish successfully + with graph + Persian
         run: |
-          docker run -e github_ci=true --rm -i nettacker \
-            poetry run python nettacker.py -i 127.0.0.1 -L fa -u user1,user2 -p pass1,pass2 --profile all \
+          docker run -e github_ci=true --rm -i --add-host=host.docker.internal:host-gateway nettacker \
+             -i host.docker.internal -L fa -u user1,user2 -p pass1,pass2 --profile all \
               -g 21,25,80,443 -t 1000 -T 3 --graph d3_tree_v2_graph -v
 
       - name: Test all modules command + check if it's finish successfully + with graph + Persian
         run: |
-          docker run -e github_ci=true --rm -i nettacker \
-            poetry run python nettacker.py -i 127.0.0.1 -L fa -u user1,user2 -p pass1,pass2 --profile all \
+          docker run -e github_ci=true --rm -i --add-host=host.docker.internal:host-gateway nettacker \
+            -i host.docker.internal -L fa -u user1,user2 -p pass1,pass2 --profile all \
               -g 21,25,80,443 -t 1000 -T 3 --graph d3_tree_v2_graph -v --skip-service-discovery
 
   test-docker-image-build:
@@ -235,17 +231,14 @@ jobs:
           sudo apt-get install docker-ce=5:${{ matrix.docker-version }} docker-ce-cli=5:${{ matrix.docker-version }}
 
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Print Docker version
         run: docker -v
 
       - name: Build Nettacker image
         run: docker build . -t nettacker
 
-      - name: Run pip install
-        run: docker run nettacker pip install .
-
   publish-nettacker-dev-to-docker-registry:
     name: Publish nettacker:dev Docker image
     if: |
@@ -258,7 +251,7 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Login to Docker Hub
         uses: docker/login-action@v3
@@ -289,7 +282,7 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - name: Check out repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -326,7 +319,7 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - name: Get package artifacts
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: dist
           path: dist
@@ -352,7 +345,7 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - name: Get package artifacts
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: dist
           path: dist

.data/tmp/readme.md

@@ -19,7 +19,7 @@ logs.txt
 *.log
 results.*
 .owasp-nettacker*
-.data*
+.nettacker/data*
 *.DS_Store
 *.swp
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,10 @@
-FROM python:3.11.11-slim
-
+### Multi-stage Dockerfile
+# Define the base image only once as a build argument
+ARG PYTHON_IMAGE=python:3.11.13-slim
+      
+### Build stage
+FROM ${PYTHON_IMAGE} AS builder
+### Install OS dependencies and poetry package manager
 RUN apt-get update && \
     apt-get install -y gcc libssl-dev && \
     apt-get clean && \
@@ -8,11 +13,41 @@ RUN apt-get update && \
 
 WORKDIR /usr/src/owaspnettacker
 
+# Copy dependency files first to maximize Docker cache usage for installing dependencies
+COPY poetry.lock pyproject.toml ./
+
+# Install dependencies
+RUN poetry config virtualenvs.in-project true && \
+    poetry install --no-cache --no-root --without dev --without test
+
+# Now copy the rest of the required source code
 COPY nettacker nettacker
-COPY nettacker.py poetry.lock pyproject.toml README.md ./
+COPY nettacker.py README.md ./
 
-RUN poetry install --no-cache --no-root --without dev --without test
+# Build the project only after all code is present
+RUN poetry build
 
-ENV docker_env=true
+### Runtime stage - start from a clean Python image
+FROM ${PYTHON_IMAGE} AS runtime
+WORKDIR /usr/src/owaspnettacker
+
+# OCI Labels (attach to final image)
+LABEL org.opencontainers.image.title="OWASP Nettacker" \
+      org.opencontainers.image.description="Automated Penetration Testing Framework" \
+      org.opencontainers.image.url="https://owasp.org/nettacker" \
+      org.opencontainers.image.source="https://github.com/OWASP/Nettacker" \
+      org.opencontainers.image.licenses="Apache-2.0"
+      
+### Bring from 'builder' just the virtualenv and the packaged Nettacker as a wheel 
+COPY --from=builder /usr/src/owaspnettacker/.venv ./.venv
+COPY --from=builder /usr/src/owaspnettacker/dist/*.whl .
 
-CMD [ "poetry", "run", "python", "./nettacker.py" ]
+ENV PATH=/usr/src/owaspnettacker/.venv/bin:$PATH
+### Use pip inside the venv to install just the nettacker wheel saving 50%+ space
+RUN pip install --no-deps --no-cache-dir nettacker-*.whl && \
+    rm -f nettacker-*.whl
+
+### We now have Nettacker installed in the virtualenv with 'nettacker' command which is the new entrypoint
+ENV docker_env=true
+ENTRYPOINT [ "nettacker" ]
+CMD ["--help"]