OXO Scan Orchestration Engine
OXO is a security scanning framework built for modularity, scalability, and simplicity. It is open source and maintained by Ostorlab.
OXO Engine combines specialized tools to work cohesively to find vulnerabilities and perform actions like recon, enumeration, and fingerprinting.
Key Features
- Modular & Scalable: Easily combine multiple specialized agents to perform comprehensive scans.
- Broad Asset Support: Scan anything from IP addresses and domains to mobile applications (Android, iOS, HarmonyOS) and API schemas.
- Agent Store: Access a growing library of community and official agents for popular security tools.
- Extensible: Built-in support for creating and publishing your own agents using a simple Python-based framework.
- API First: Features a GraphQL API for easy integration into CI/CD pipelines and other automated workflows.
Requirements
Docker is required to run scans locally. To install Docker, please follow these instructions.
Installing
OXO ships as a Python package on PyPI. To install it, simply run the following command if you have pip already
installed.
pip install -U ostorlab
Getting Started
OXO ships with a store that boasts dozens of agents, from network scanning agents like Nmap, Nuclei, or Tsunami, web scanners like ZAP, web fingerprinting tools like WhatWeb and Wappalyzer, DNS brute-forcing tools like Subfinder and Dnsx, malware file scanning like VirusTotal, and much more.
To run any of these tools combined, simply run the following command:
OXO CLI is accessible using the
oxoorostorlabcommands.
oxo scan run --install --agent agent/ostorlab/nmap --agent agent/ostorlab/tsunami --agent agent/ostorlab/nuclei ip 8.8.8.8
This command will download and install the following scanning agents:
It will scan the target IP address 8.8.8.8.
Agents are shipped as standard Docker images.
Scan Management
To check the scan status, run:
oxo scan list
Once the scan has completed, to access the scan results, run:
oxo vulnz list --scan-id <scan-id>
oxo vulnz describe --vuln-id <vuln-id>
To stop a running scan, run:
oxo scan stop --scan-id <scan-id>
Docker Image
To run oxo in a container, you may use the publicly available image and run the following command:
docker run -v /var/run/docker.sock:/var/run/docker.sock ostorlab/oxo:latest scan run --install --agent agent/ostorlab/nmap ip 8.8.8.8
Notes:
- The command starts directly with:
scan run, this is because theostorlab/oxoimage hasoxoas anentrypoint. - It is important to mount the Docker socket so OXO can create agents on the host machine.
On-Prem Scanner Logs
When running OXO as an on-prem scanner, use --persist-logs to write scanner logs to disk:
oxo scanner --scanner-id <scanner-uuid> --persist-logs
By default, logs are written to ~/.ostorlab/scanner.log. To choose another file:
oxo scanner --scanner-id <scanner-uuid> --persist-logs --log-file /var/log/ostorlab/scanner.log
To change the persisted log verbosity:
oxo scanner --scanner-id <scanner-uuid> --persist-logs --log-level DEBUG
Assets
OXO supports scanning multiple asset types, allowing for comprehensive security coverage across different platforms and protocols.
| Category | Asset | Description |
|---|---|---|
| Network | ip |
IP address or IP range (v4 and v6). |
domain-name |
Domain name. | |
| Web | link |
Web link, accepting a URL, method, headers, and request body. |
api-schema |
API schema (OpenAPI, GraphQL, etc.). | |
| Mobile | android-apk / android-aab |
Android package files (.APK, .AAB). |
android-store |
Android app in the Google Play Store. | |
ios-ipa |
iOS package file (.IPA). | |
ios-store |
iOS app in the Apple App Store. | |
ios-testflight |
iOS app in TestFlight. | |
harmonyos-apk / harmonyos-hap |
HarmonyOS package files. | |
| Other | file |
Generic file. |
phone-number |
Phone number. | |
agent |
Meta-scanning of an agent. |
The Store
OXO lists all agents on a public store where you can search and also publish your own agents.
Publish Your First Agent
To write your first agent, you can check out a full tutorial here.
The steps are basically as follows:
- Clone a template agent with all files already set up.
- Change the
template_agent.pyfile to add your logic. - Change the
Dockerfileby adding any extra building steps. - Change the
ostorlab.yamlby adding selectors, documentation, image, and license. - Publish it on the store.
Once you have written your agent, you can publish it on the store for others to use and discover it. The store will handle agent building and will automatically pick up new releases from your Git repo.
Ideas for Agents to Build
Implementations of popular tools such as:
semgrep for source code scanning.- nbtscan: Scans for open NetBIOS name servers on your target’s network.
- onesixtyone: Fast scanner to find publicly exposed SNMP services.
- Retire.js: Scanner detecting the use of JavaScript libraries with known vulnerabilities.
snallygaster: Finds file leaks and other security problems on HTTP servers.testssl.sh: Identifies various TLS/SSL weaknesses, including Heartbleed, CRIME, and ROBOT.TruffleHog: Searches through Git repositories for high-entropystrings and secrets, digging deep into commit history.- cve-bin-tool: Scans binaries for vulnerable components.
- XSStrike: XSS web vulnerability scanner with generative payload.
Subjack: Subdomain takeover scanning tool.- DnsReaper: Subdomain takeover scanning tool.
- Gitleaks: SAST tool for detecting and preventing hardcoded secrets.
- ffuf: Fast web fuzzer written in Go.
- Gobuster: Tool used to brute-force URIs, DNS subdomains, and more.
Credits
As an open-source project in a rapidly developing field, we are always open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation. See CONTRIBUTING.md to get started.
We would like to thank the following contributors for their help in making OXO a better tool:
Release files for ostorlab 2.18.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ostorlab-2.18.0.tar.gz | 12.6 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ostorlab-2.18.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.1 MB
Release files / ostorlab-2.18.0.tar.gz
| Download URL | ostorlab-2.18.0.tar.gz |
|---|---|
| Size | 12.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
969e401db430019011666753c8d76055d2816d0bf2eda0a5748ce4d7cd6282ad
|
|
BLAKE2b-256 checksum How to use checksums |
4f79520842a4d9a253b01e844f45fd3a0b4a997096eb8100557f315f1473c22e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / ostorlab-2.18.0-py3-none-any.whl
| Download URL | ostorlab-2.18.0-py3-none-any.whl |
|---|---|
| Size | 14.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d837746ca5f7dd76cdb75a869eb8a2b3ba284f3508ef89cb45e75c147d55397e
|
|
BLAKE2b-256 checksum How to use checksums |
97505ce96adaac07a97222904f1c0ad7bfb615037ea5245721d1e38423d5413b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for ostorlab 2.18.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
