chore: Minor readme tweaks. Bump version for 0.3.4 release
This commit is contained in:
72
README.md
72
README.md
@@ -36,7 +36,7 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🦉 What are Strix?
|
## 🦉 Strix Overview
|
||||||
|
|
||||||
Strix are autonomous AI agents that act just like real hackers - they run your code dynamically, find vulnerabilities, and validate them through actual proof-of-concepts. Built for developers and security teams who need fast, accurate security testing without the overhead of manual pentesting or the false positives of static analysis tools.
|
Strix are autonomous AI agents that act just like real hackers - they run your code dynamically, find vulnerabilities, and validate them through actual proof-of-concepts. Built for developers and security teams who need fast, accurate security testing without the overhead of manual pentesting or the false positives of static analysis tools.
|
||||||
|
|
||||||
@@ -48,14 +48,13 @@ Strix are autonomous AI agents that act just like real hackers - they run your c
|
|||||||
- 💻 **Developer‑first** CLI with actionable reports
|
- 💻 **Developer‑first** CLI with actionable reports
|
||||||
- 🔄 **Auto‑fix & reporting** to accelerate remediation
|
- 🔄 **Auto‑fix & reporting** to accelerate remediation
|
||||||
|
|
||||||
<br>
|
|
||||||
|
|
||||||
## 🎯 Use Cases
|
## 🎯 Use Cases
|
||||||
|
|
||||||
- **Application Security Testing** - Detect and validate critical vulnerabilities in your applications
|
- **Application Security Testing** - Detect and validate critical vulnerabilities in your applications
|
||||||
- **Rapid Penetration Testing** - Get penetration tests done in hours, not weeks, with compliance reports
|
- **Rapid Penetration Testing** - Get penetration tests done in hours, not weeks, with compliance reports
|
||||||
- **Bug Bounty Automation** - Automate bug bounty research and generate PoCs for faster reporting
|
- **Bug Bounty Automation** - Automate bug bounty research and generate PoCs for faster reporting
|
||||||
- **CI/CD Security Gates** - Run tests in CI/CD to block vulnerabilities before reaching production
|
- **CI/CD Integration** - Run tests in CI/CD to block vulnerabilities before reaching production
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -64,7 +63,7 @@ Strix are autonomous AI agents that act just like real hackers - they run your c
|
|||||||
**Prerequisites:**
|
**Prerequisites:**
|
||||||
- Docker (running)
|
- Docker (running)
|
||||||
- Python 3.12+
|
- Python 3.12+
|
||||||
- An LLM provider key ([get OpenAI API key](https://platform.openai.com/api-keys) or use a local LLM)
|
- An LLM provider key (e.g. [get OpenAI API key](https://platform.openai.com/api-keys) or use a local LLM)
|
||||||
|
|
||||||
### Installation & First Scan
|
### Installation & First Scan
|
||||||
|
|
||||||
@@ -82,7 +81,6 @@ strix --target ./app-directory
|
|||||||
|
|
||||||
> **Note:** First run automatically pulls the sandbox Docker image. Results are saved to `agent_runs/<run-name>/`
|
> **Note:** First run automatically pulls the sandbox Docker image. Results are saved to `agent_runs/<run-name>/`
|
||||||
|
|
||||||
<br>
|
|
||||||
|
|
||||||
## 🏆 Enterprise Platform
|
## 🏆 Enterprise Platform
|
||||||
|
|
||||||
@@ -90,14 +88,12 @@ Want to skip the setup? Try our cloud-hosted version at **[usestrix.com](https:/
|
|||||||
|
|
||||||
Our managed platform provides:
|
Our managed platform provides:
|
||||||
|
|
||||||
| Feature | Description |
|
- **📈 Executive Dashboards**
|
||||||
|---------|-------------|
|
- **🧠 Custom Fine-Tuned Models**
|
||||||
| 📈 **Executive Dashboards** | Track security metrics and trends across your organization |
|
- **⚙️ CI/CD Integration**
|
||||||
| 🧠 **Custom Fine-Tuned Models** | AI agents trained on your specific codebase and vulnerabilities |
|
- **🔍 Large-Scale Scanning**
|
||||||
| ⚙️ **CI/CD Integration** | Seamless integration with your existing workflows |
|
- **🔌 Third-Party Integrations**
|
||||||
| 🔍 **Large-Scale Scanning** | Test multiple applications and repositories in parallel |
|
- **🎯 Enterprise Support**
|
||||||
| 🔌 **Third-Party Integrations** | Connect with Jira, Slack, PagerDuty, and more |
|
|
||||||
| 🎯 **Enterprise Support** | Dedicated support team and SLA guarantees |
|
|
||||||
|
|
||||||
[**Get Enterprise Demo →**](https://usestrix.com)
|
[**Get Enterprise Demo →**](https://usestrix.com)
|
||||||
|
|
||||||
@@ -109,37 +105,33 @@ Our managed platform provides:
|
|||||||
|
|
||||||
Strix agents come equipped with a comprehensive security testing toolkit:
|
Strix agents come equipped with a comprehensive security testing toolkit:
|
||||||
|
|
||||||
| Tool | Capability |
|
- **Full HTTP Proxy** - Full request/response manipulation and analysis
|
||||||
|------|------------|
|
- **Browser Automation** - Multi-tab browser for testing of XSS, CSRF, auth flows
|
||||||
| 🌐 **HTTP Proxy** | Full request/response manipulation and analysis |
|
- **Terminal Environments** - Interactive shells for command execution and testing
|
||||||
| 🖥️ **Browser Automation** | Multi-tab browser for XSS, CSRF, and auth flow testing |
|
- **Python Runtime** - Custom exploit development and validation
|
||||||
| ⌨️ **Terminal Environment** | Interactive shells for command execution and testing |
|
- **Reconnaissance** - Automated OSINT and attack surface mapping
|
||||||
| 🐍 **Python Runtime** | Custom exploit development and validation |
|
- **Code Analysis** - Static and dynamic analysis capabilities
|
||||||
| 🔍 **Reconnaissance** | Automated OSINT and attack surface mapping |
|
- **Knowledge Management** - Structured findings and attack documentation
|
||||||
| 📊 **Code Analysis** | Static and dynamic analysis capabilities |
|
|
||||||
| 📝 **Knowledge Management** | Structured findings and attack documentation |
|
|
||||||
|
|
||||||
### 🎯 Comprehensive Vulnerability Detection
|
### 🎯 Comprehensive Vulnerability Detection
|
||||||
|
|
||||||
Strix can identify and validate a wide range of security vulnerabilities:
|
Strix can identify and validate a wide range of security vulnerabilities:
|
||||||
|
|
||||||
| Category | Coverage |
|
- **Access Control** - IDOR, privilege escalation, auth bypass
|
||||||
|----------|----------|
|
- **Injection Attacks** - SQL, NoSQL, command injection
|
||||||
| 🔐 **Access Control** | IDOR, privilege escalation, authorization bypass |
|
- **Server-Side** - SSRF, XXE, deserialization flaws
|
||||||
| 💉 **Injection Attacks** | SQL, NoSQL, command injection, template injection |
|
- **Client-Side** - XSS, prototype pollution, DOM vulnerabilities
|
||||||
| 🖥️ **Server-Side** | SSRF, XXE, deserialization flaws |
|
- **Business Logic** - Race conditions, workflow manipulation
|
||||||
| 🌐 **Client-Side** | XSS, prototype pollution, DOM vulnerabilities |
|
- **Authentication** - JWT vulnerabilities, session management
|
||||||
| ⚙️ **Business Logic** | Race conditions, workflow manipulation |
|
- **Infrastructure** - Misconfigurations, exposed services
|
||||||
| 🔑 **Authentication** | JWT vulnerabilities, session management flaws |
|
|
||||||
| 🏗️ **Infrastructure** | Misconfigurations, exposed services, secrets |
|
|
||||||
|
|
||||||
### 🕸️ Graph of Agents
|
### 🕸️ Graph of Agents
|
||||||
|
|
||||||
Advanced multi-agent orchestration for comprehensive security testing:
|
Advanced multi-agent orchestration for comprehensive security testing:
|
||||||
|
|
||||||
- **🔄 Distributed Workflows** - Specialized agents tackle different attacks and assets simultaneously
|
- **Distributed Workflows** - Specialized agents for different attacks and assets
|
||||||
- **⚡ Scalable Testing** - Parallel execution for fast, comprehensive coverage
|
- **Scalable Testing** - Parallel execution for fast comprehensive coverage
|
||||||
- **🤝 Dynamic Coordination** - Agents collaborate and share discoveries in real-time
|
- **Dynamic Coordination** - Agents collaborate and share discoveries
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -162,16 +154,13 @@ strix --target https://your-app.com
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Grey-box authenticated testing
|
# Grey-box authenticated testing
|
||||||
strix --target https://your-app.com \
|
strix --target https://your-app.com --instruction "Perform authenticated testing using credentials: user:pass"
|
||||||
--instruction "Perform authenticated testing using credentials: user:pass"
|
|
||||||
|
|
||||||
# Multi-target testing (source code + deployed app)
|
# Multi-target testing (source code + deployed app)
|
||||||
strix -t https://github.com/org/app \
|
strix -t https://github.com/org/app -t https://your-app.com
|
||||||
-t https://your-app.com
|
|
||||||
|
|
||||||
# Focused testing with custom instructions
|
# Focused testing with custom instructions
|
||||||
strix --target api.your-app.com \
|
strix --target api.your-app.com --instruction "Focus on business logic flaws and IDOR vulnerabilities"
|
||||||
--instruction "Focus on business logic flaws and IDOR vulnerabilities"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 🤖 Headless Mode
|
### 🤖 Headless Mode
|
||||||
@@ -248,4 +237,7 @@ Have questions? Found a bug? Want to contribute? **[Join our Discord!](https://d
|
|||||||
|
|
||||||
**Love Strix?** Give us a ⭐ on GitHub!
|
**Love Strix?** Give us a ⭐ on GitHub!
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> Only test apps you own or have permission to test. You are responsible for using Strix ethically and legally.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
[tool.poetry]
|
[tool.poetry]
|
||||||
name = "strix-agent"
|
name = "strix-agent"
|
||||||
version = "0.3.3"
|
version = "0.3.4"
|
||||||
description = "Open-source AI Hackers for your apps"
|
description = "Open-source AI Hackers for your apps"
|
||||||
authors = ["Strix <hi@usestrix.com>"]
|
authors = ["Strix <hi@usestrix.com>"]
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
|
|||||||
Reference in New Issue
Block a user