From 9a09e13f324aa56576d35d6f4b307de1b21ceaf2 Mon Sep 17 00:00:00 2001 From: shiva108 Date: Wed, 7 Jan 2026 13:40:48 +0100 Subject: [PATCH] fix: Update paths after scripts reorganization and fix GitBook config MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - README.md: Update requirements.txt and runner.py paths - .gitbook.yaml: Fix chapter count (24 → 51) and date (Jan 2026) - Configuration.md: Update all script paths to new structure - Remove broken links to non-existent files --- .gitbook.yaml | 4 +-- README.md | 4 +-- docs/Configuration.md | 70 +++++++++++++++++++++++------------------- scripts/docs/README.md | 2 +- 4 files changed, 44 insertions(+), 36 deletions(-) diff --git a/.gitbook.yaml b/.gitbook.yaml index 3217b64..f29f2c5 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -90,9 +90,9 @@ pluginsConfig: # Variables variables: handbook_version: "2.0" - last_updated: "December 2024" + last_updated: "January 2026" author: "CPH:SEC" - chapters_count: "24" + chapters_count: "51" # Links links: diff --git a/README.md b/README.md index 9cd6560..0e89e27 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ cd ai-llm-red-team-handbook # Install dependencies cd scripts -pip install -r requirements.txt +pip install -r config/requirements.txt ``` **Running Tests:** @@ -87,7 +87,7 @@ cp .env.example .env nano .env # Run the test runner -python runner.py --target "gpt-4" --test "prompt_injection" +python examples/runner.py --target "gpt-4" --test "prompt_injection" ``` --- diff --git a/docs/Configuration.md b/docs/Configuration.md index 132ab30..22d2050 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -22,7 +22,7 @@ This guide provides detailed instructions for configuring and running the automa ```bash cd scripts -pip install -r requirements.txt +pip install -r config/requirements.txt ``` ### 2. Configure Environment @@ -38,7 +38,7 @@ MODEL_NAME=gpt-4 ### 3. Run Tests ```bash -python runner.py +python examples/runner.py ``` --- @@ -77,17 +77,17 @@ ENABLE_TESTS = [ ### Configuration Parameters -| Parameter | Type | Default | Description | -|-----------|------|---------|-------------| -| `API_ENDPOINT` | string | required | Target LLM API endpoint URL | -| `API_KEY` | string | required | Authentication key for API | -| `MODEL_NAME` | string | required | Model identifier (e.g., "gpt-4", "claude-3") | -| `MAX_RETRIES` | int | 3 | Number of retry attempts for failed requests | -| `TIMEOUT` | int | 30 | Request timeout in seconds | -| `REQUEST_DELAY` | float | 1.0 | Delay between requests to avoid rate limiting | -| `LOG_LEVEL` | string | "INFO" | Logging verbosity (DEBUG, INFO, WARNING, ERROR) | -| `LOG_FILE` | string | "test_results.log" | Path to log file | -| `ENABLE_TESTS` | list | all tests | List of test categories to run | +| Parameter | Type | Default | Description | +| --------------- | ------ | ------------------ | ----------------------------------------------- | +| `API_ENDPOINT` | string | required | Target LLM API endpoint URL | +| `API_KEY` | string | required | Authentication key for API | +| `MODEL_NAME` | string | required | Model identifier (e.g., "gpt-4", "claude-3") | +| `MAX_RETRIES` | int | 3 | Number of retry attempts for failed requests | +| `TIMEOUT` | int | 30 | Request timeout in seconds | +| `REQUEST_DELAY` | float | 1.0 | Delay between requests to avoid rate limiting | +| `LOG_LEVEL` | string | "INFO" | Logging verbosity (DEBUG, INFO, WARNING, ERROR) | +| `LOG_FILE` | string | "test_results.log" | Path to log file | +| `ENABLE_TESTS` | list | all tests | List of test categories to run | --- @@ -249,51 +249,51 @@ TEST_CONFIG = { ### Run All Tests ```bash -python runner.py +python examples/runner.py ``` ### Run Specific Test Category ```bash -python runner.py --test prompt_injection -python runner.py --test safety_bypass -python runner.py --test data_exposure +python examples/runner.py --test prompt_injection +python examples/runner.py --test safety_bypass +python examples/runner.py --test data_exposure ``` ### Run Multiple Categories ```bash -python runner.py --test prompt_injection,safety_bypass,data_exposure +python examples/runner.py --test prompt_injection,safety_bypass,data_exposure ``` ### Use Custom Configuration File ```bash -python runner.py --config my_custom_config.py +python examples/runner.py --config my_custom_config.py ``` ### Verbose Output ```bash -python runner.py --verbose +python examples/runner.py --verbose ``` ### Debug Mode ```bash -python runner.py --debug +python examples/runner.py --debug ``` ### Save Results to Custom Location ```bash -python runner.py --output /path/to/results/ +python examples/runner.py --output /path/to/results/ ``` ### Dry Run (Preview Tests) ```bash -python runner.py --dry-run +python examples/runner.py --dry-run ``` --- @@ -304,16 +304,17 @@ python runner.py --dry-run Test results are saved to multiple locations: -| File/Directory | Format | Description | -|----------------|--------|-------------| -| `test_results.log` | Text | Detailed execution log with timestamps | -| `reports/json/` | JSON | Machine-readable test results | -| `reports/html/` | HTML | Human-readable HTML reports | -| `reports/summary.txt` | Text | Executive summary of findings | +| File/Directory | Format | Description | +| --------------------- | ------ | -------------------------------------- | +| `test_results.log` | Text | Detailed execution log with timestamps | +| `reports/json/` | JSON | Machine-readable test results | +| `reports/html/` | HTML | Human-readable HTML reports | +| `reports/summary.txt` | Text | Executive summary of findings | ### Report Structure #### JSON Report + ```json { "test_run_id": "20250630-124530", @@ -336,6 +337,7 @@ Test results are saved to multiple locations: ``` #### HTML Report + - Interactive dashboard with charts - Filterable findings by severity - Detailed test case results @@ -364,11 +366,13 @@ Running AI/LLM Red Team Tests... #### API Connection Errors ##### Error + ``` ConnectionError: Failed to connect to API endpoint ``` ##### Solution + - Verify `API_ENDPOINT` is correct - Check network connectivity - Confirm firewall/proxy settings @@ -376,11 +380,13 @@ ConnectionError: Failed to connect to API endpoint #### Authentication Failures ##### Error + ``` AuthenticationError: Invalid API key ``` ##### Solution + - Verify `API_KEY` is correct and active - Check API key permissions - Ensure key hasn't expired @@ -388,11 +394,13 @@ AuthenticationError: Invalid API key #### Rate Limiting ##### Error + ``` RateLimitError: Too many requests ``` ##### Solution + - Increase `REQUEST_DELAY` in config - Reduce concurrent tests - Use rate limiting configuration @@ -400,11 +408,13 @@ RateLimitError: Too many requests #### Timeout Issues ##### Error + ``` TimeoutError: Request timed out after 30s ``` ##### Solution + - Increase `TIMEOUT` value - Check API service status - Verify network latency @@ -461,5 +471,3 @@ python runner.py --debug - [Main README](../README.md) - [Field Manual](AI_LLM%20Red%20Team%20Field%20Manual.md) -- [Handbook](AI%20LLM%20Red%20Team%20Hand%20book.md) -- [Report Template](Full_LLM_RedTeam_Report_Template.docx) diff --git a/scripts/docs/README.md b/scripts/docs/README.md index 739e4c2..f07540d 100644 --- a/scripts/docs/README.md +++ b/scripts/docs/README.md @@ -4,7 +4,7 @@ This directory contains 386 practical, production-ready scripts extracted from t ## 📁 Directory Structure -``` +```text scripts/ ├── automation/ 4 scripts - Attack orchestration and fuzzing ├── compliance/ 16 scripts - Standards, regulations, and best practices