🛠️ This document is under active maintenance in preparation for the major Osmedeus v5.0.0 upgrade
Frequently Asked Questions
Show properties
# Build from source make build # Install to $GOBIN make install # Install security tools osmedeus install binary --all
~/osmedeus-base/workflows/
flows/
modules/
name: my-workflow kind: module description: My custom workflow params: - name: target required: true steps: - name: scan-target type: bash command: nmap {{target}}
bash
function
parallel-steps
foreach
remote-bash
http
llm
# Run a flow workflow osmedeus run -f subdomain-enum -t example.com # Run a module workflow osmedeus run -m port-scan -t example.com
# From command line osmedeus run -m port-scan -t target1.com -t target2.com # From file osmedeus run -m port-scan -T targets.txt -c 5
osmedeus run -m port-scan -t example.com --timeout 2h
~/osmedeus-base/workspaces/<target>/
osmedeus server
# Get a JWT token curl -X POST http://localhost:8002/osm/api/login \ -H "Content-Type: application/json" \ -d '{"username": "osmedeus", "password": "admin"}' # Use the token curl http://localhost:8002/osm/api/workflows \ -H "Authorization: Bearer <token>"
osmedeus server --no-auth
X-API-Key
Authorization: Bearer
# Via CLI (creates a cron schedule) osmedeus run -f subdomain-enum -t example.com --schedule "0 2 * * *" # Via API curl -X POST http://localhost:8002/osm/api/schedules \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "daily-scan", "workflow_name": "subdomain-enum", "target": "example.com", "schedule": "0 2 * * *" }'
minute hour day-of-month month day-of-week
0 2 * * *
0 0 * * 0
*/30 * * * *
host
docker
ssh
osmedeus run -m port-scan -t example.com --runner docker --docker-image osmedeus/osmedeus:latest
osmedeus run -m port-scan -t example.com --runner ssh --ssh-host worker.example.com
osmedeus server --master
osmedeus worker join --master http://master:8002
curl -X POST http://localhost:8002/osm/api/tasks \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "workflow_name": "subdomain-enum", "target": "example.com" }'
osmedeus install binary --all --check
# Install specific tools osmedeus install binary --name nuclei --name httpx # Install all tools osmedeus install binary --all
cat ~/osmedeus-base/workspaces/<target>/log/execution.log
osmedeus snapshot export <workspace>
osmedeus snapshot import snapshot.zip
~/osmedeus-base/osm-settings.yaml
osm-settings.yaml
server: port: 9000
--port
osmedeus server --port 9000
database: db_engine: sqlite3 # or postgres host: localhost port: 5432 name: osmedeus username: user password: pass