ai threat modeling

️ Este repositório está preguiçoso e será arquivado. Todos os avisos foram movidos para: https://github.com/xvnpw/fabric-agent-action

Modelagem de ameaças de IA

? Você pode usar esses scripts para gerar conteúdo apresentado pela IA para modelagem de ameaças e revisão de segurança.

️ Este é um projeto experimental

Instalação

git clone [email protected]:xvnpw/ai-threat-modeling.git
cd ai-threat-modeling
pip install -r requirements.txt

Configuração

Use variáveis ​​de ambiente para definir as teclas da API. Sem as chaves da API, você não pode usar o provedor selecionado:

 # OpenAI API key
# Optional. Only if want to use openai provider
# Get a key from https://platform.openai.com/account/api-keys
OPENAI_API_KEY

# Open Router API key
# Optional. Only if want to use openrouter provider
# Get a key from https://openrouter.ai/keys
OPENROUTER_API_KEY

Uso

$ python ai-tm.py --help
usage: ai-tm.py [-h] [--provider {openai,openrouter}] [--inputs [INPUTS]] [--output [OUTPUT]] [-ai [ARCHITECTURE_INPUTS]] [-atmi [ARCHITECTURE_THREAT_MODEL_INPUT]] [--model MODEL]
                [--temperature TEMPERATURE] [-v VERBOSE] [-d DEBUG] [-usos USER_STORY_OUTPUT_SUFFIX] [-t TEMPLATE_DIR] [--review REVIEW] [--create-draft CREATE_DRAFT]
                {project,architecture,user-story}

AI featured threat modeling and security review

positional arguments:
  {project,architecture,user-story}
                        type of feature

options:
  -h , --help            show this help message and exit
  --provider {openai,openrouter}
                        provider of LLM API, default: openai
  --inputs [INPUTS]     file path or json array of paths to input files (depends on feature)
  --output [OUTPUT]     path to output file
  -a i [ARCHITECTURE_INPUTS], --architecture-inputs [ARCHITECTURE_INPUTS]
                        for user-story only: json array of paths to architecture files
  -a tmi [ARCHITECTURE_THREAT_MODEL_INPUT], --architecture-threat-model-input [ARCHITECTURE_THREAT_MODEL_INPUT]
                        for user-story only: path to architecture threat model file
  --model MODEL         type of ChatGPT model, default: gpt-4
  --temperature TEMPERATURE
                        sampling temperature for a model, default 0.2
  -v, --verbose         turn on verbose messages, default: false
  -d , --debug           turn on debug messages, default: false
  -u sos USER_STORY_OUTPUT_SUFFIX, --user-story-output-suffix USER_STORY_OUTPUT_SUFFIX
                        for user-story only: suffix that will be added to input file name to create output file, default: _SECURITY
  -t TEMPLATE_DIR, --template-dir TEMPLATE_DIR
                        path to template dir, default: ./templates
  --review              review input files using LLM, default: false
  --create-draft        create draft of input (e.g. architecture) based on files (e.g. README.md,controllers.go,swagger.yaml), default: false

Experimental. Use on your own risk

Características

Revise a descrição da arquitetura para o projeto

$ python ai-tm.py architecture --review --inputs < path_to_project > /ARCHITECTURE.md --output ARCHITECTURE_REVIEW.md --verbose
INFO:root:review of architecture started...
INFO:root:finished waiting on llm response
INFO:root:response written to file

Pilha de tecnologia

• Python
• LLM Tooling: Langchain
• LLM: Openai Gpt, OpenRouter

Privacidade

Openai

Este projeto usa API OpenAI. Por padrão, seus dados não serão usados ​​para aprender, de acordo com as políticas de uso de dados da API:

O OpenAI não usará dados enviados pelos clientes por meio de nossa API para treinar ou melhorar nossos modelos, a menos que você decida explicitamente compartilhar seus dados conosco para esse fim. Você pode optar por compartilhar dados.

OpenRouter

O OpenRouter descreve a privacidade e a filtragem nas configurações para cada modelo.