Merge pull request #559 from owasp-noir/release/0.20.0

Release v0.20.0

Author: hahwul

.github/ISSUE_TEMPLATE/bug_report.md

@@ -23,7 +23,7 @@ If applicable, add screenshots to help explain your problem.
 
 **Versions**
  - OS: [e.g. macos, linux]
- - Version [e.g. v0.19.1]
+ - Version [e.g. v0.20.0]
 
 **Additional context**
 Add any other context about the problem here.

Dockerfile

@@ -13,7 +13,7 @@ RUN apt-get update && \
 ##= RUNNER =##
 FROM debian:12-slim
 LABEL org.opencontainers.image.title="OWASP Noir"
-LABEL org.opencontainers.image.version="0.19.1"
+LABEL org.opencontainers.image.version="0.20.0"
 LABEL org.opencontainers.image.description="OWASP Noir is an open-source project specializing in identifying attack surfaces for enhanced whitebox security testing and security pipeline."
 LABEL org.opencontainers.image.authors="Noir Team (@hahwul, @ksg97031)"
 LABEL org.opencontainers.image.source=https://github.com/owasp-noir/noir

docs/_advanced/ai_integration.md

@@ -25,12 +25,13 @@ New (v0.20.0)
 * `--ai-model MODEL`: Set the model name to use for AI analysis. Required for AI features.
 * `--ai-key KEY`: Provide the API key for authenticating with the AI provider's API. Alternatively, use the `NOIR_AI_KEY` environment variable.
 
-#### Prefixes and Default URLs
+#### Prefixes and Default Hosts
 
-| Prefix  | Default URL                          |
+| Prefix  | Default Host                          |
 |---------|--------------------------------------|
 | openai  | https://api.openai.com               |
-| x.ai    | https://api.x.ai                     |
+| xAI     | https://api.x.ai                     |
+| github  | https://models.github.ai             |
 | azure   | https://models.inference.ai.azure.com|
 | vllm    | http://localhost:8000                |
 | ollama  | http://localhost:11434               |
@@ -53,12 +54,7 @@ Since (v0.19.0) / Deprecated
 ### Step 1: Configure AI Provider
 
 1. Choose an AI provider and obtain the necessary API key.
-2. Set the provider and model using the `--ai-provider` and `--ai-model` flags. For example:
-
-```bash
-# Set AI provider and model
-noir -b . --ai-provider=openai --ai-model=gpt-4 --ai-key=your-api-key
-```
+2. If you wish to use Local LLM, please install each application.
 
 ### Step 2: Run Noir with AI Analysis
 

docs/_advanced/ai_integration/github_marketplace.md

@@ -1,29 +1,39 @@
 ---
-title: Github marketplace (Azure)
+title: Github
 parent: AI Integration
 nav_order: 6
 layout: page
 ---
 
-# Github marketplace Integration (Azure)
+# Github
 
 ## Setup Github marketplace
 
 1. Obtain an API Key: Follow the instructions on Github to obtain a Personal Access Token (PAS)[^1].
 2. Select and Configure the Model: Choose the desired model from the [Github marketplace](https://github.com/marketplace/models)[^2] and ensure it is properly configured.
 
 ## Run Noir with Github marketplace Models
-
 To leverage Github marketplace's models capabilities for additional analysis, use the following command:
 
+```bash
+noir -b ./spec/functional_test/fixtures/hahwul \
+     --ai-provider=github \
+     --ai-model=gpt-4o \
+     --ai-key=github_....
+```
+*Use to models.github.ai*
+
+or 
+
 ```bash
 noir -b ./spec/functional_test/fixtures/hahwul \
      --ai-provider=azure \
      --ai-model=gpt-4o \
      --ai-key=github_....
 ```
+*Use to models.inference.ai.azure.com*
 
-This command performs the standard Noir operations while utilizing the specified Azure model for enhanced analysis.
+This command performs the standard Noir operations while utilizing the specified Github or Azure's inference API for enhanced analysis.
 
 [^1]: [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
 [^2]: Github > Marketplace > Models

docs/_advanced/ai_integration/xai.md

@@ -1,26 +1,26 @@
 ---
-title: X.AI
+title: xAI
 parent: AI Integration
 nav_order: 5
 layout: page
 ---
 
-# X.AI Integration
+# xAI Integration
 
-## Setup X.AI
+## Setup xAI
 
-1. Obtain an API Key: Follow the instructions on the [official X.AI website](https://x.ai/api) to obtain an API key.
+1. Obtain an API Key: Follow the instructions on the [official xAI website](https://x.ai/api) to obtain an API key.
 2. Configure the Model: Ensure the desired model is available and configured.
 
-## Run Noir with X.AI
+## Run Noir with xAI
 
-To leverage X.AI capabilities for additional analysis, use the following command:
+To leverage xAI capabilities for additional analysis, use the following command:
 
 ```bash
 noir -b ./spec/functional_test/fixtures/hahwul \
-     --ai-provider=x.ai \
+     --ai-provider=xai \
      --ai-model=grok-2-1212 \
      --ai-key=xai-t
 ```
 
-This command performs the standard Noir operations while utilizing the specified X.AI model for enhanced analysis.
+This command performs the standard Noir operations while utilizing the specified xAI model for enhanced analysis.

docs/_developers/release_procedure.md

@@ -31,14 +31,14 @@ layout: page
 2. Generate a PR for the Homebrew core:
 ```bash
 brew bump-formula-pr --strict --version <VERSION> noir
-# Example: brew bump-formula-pr --strict --version 0.19.1 noir
+# Example: brew bump-formula-pr --strict --version 0.20.0 noir
 ```
 
 #### Troubleshooting
 If you encounter issues, try the following commands:
 ```bash
 HOMEBREW_NO_INSTALL_FROM_API=1 brew update
-brew bump-formula-pr --strict --version 0.19.1 noir
+brew bump-formula-pr --strict --version 0.20.0 noir
 ```
 
 #### Style Check

docs/_includes/usage.md

@@ -47,7 +47,8 @@ FLAGS:
     --ai-provider PREFIX|URL         Specify the AI (LLM) provider or directly set a custom API URL. Required for AI features.
                                        [Prefixes and Default URLs]
                                        * openai: https://api.openai.com
-                                       * x.ai: https://api.x.ai
+                                       * xai: https://api.x.ai
+                                       * github: https://models.github.ai
                                        * azure: https://models.inference.ai.azure.com
                                        * vllm: http://localhost:8000
                                        * ollama: http://localhost:11434

shard.yml

@@ -1,6 +1,6 @@
 # Project Metadata
 name: noir
-version: 0.19.1
+version: 0.20.0
 authors:
   - hahwul <[email protected]>
   - ksg97031 <[email protected]>

snap/snapcraft.yaml

@@ -1,6 +1,6 @@
 name: noir
 base: core20
-version: 0.19.1
+version: 0.20.0
 summary: Attack surface detector that identifies endpoints by static analysis.
 description: |
   Noir is an open-source project specializing in identifying attack surfaces for enhanced whitebox security testing and security pipeline. 

src/llm/general/client.cr

@@ -14,12 +14,14 @@ module LLM
                  "http://localhost:11434/v1/chat/completions"
                when "lmstudio"
                  "http://localhost:1234/v1/chat/completions"
-               when "x.ai"
+               when "xai"
                  "https://api.x.ai/v1/chat/completions"
                when "vllm"
                  "http://localhost:8000/v1/chat/completions"
                when "azure"
                  "https://models.inference.ai.azure.com/chat/completions"
+               when "github"
+                 "https://models.github.ai/inference/chat/completions"
                else
                  url
                end

src/noir.cr

@@ -6,7 +6,7 @@ require "./options.cr"
 require "./techs/techs.cr"
 
 module Noir
-  VERSION = "0.19.1"
+  VERSION = "0.20.0"
 end
 
 # Run options parser

src/options.cr

@@ -114,7 +114,8 @@ def run_options_parser
     parser.on "--ai-provider PREFIX|URL", "Specify the AI (LLM) provider or directly set a custom API URL. Required for AI features.\n" \
                                           "  [Prefixes and Default URLs]\n" \
                                           "  * openai: https://api.openai.com\n" \
-                                          "  * x.ai: https://api.x.ai\n" \
+                                          "  * xai: https://api.x.ai\n" \
+                                          "  * github: https://models.github.ai\n" \
                                           "  * azure: https://models.inference.ai.azure.com\n" \
                                           "  * vllm: http://localhost:8000\n" \
                                           "  * ollama: http://localhost:11434\n" \
@@ -198,6 +199,7 @@ def run_options_parser
     parser.on "-h", "--help", "Show help" do
       banner()
       puts parser
+      exit
     end
     parser.on "--help-all", "Show all help" do
       banner()