Skip to content

Community Workflow for the Osmedeus Engine that describes basic reconnaissance methodology for you to build your own

Notifications You must be signed in to change notification settings

osmedeus/osmedeus-workflow

Repository files navigation

Osmedeus
Osmedeus - A Workflow Engine for Offensive Security


Osmedeus Workflow

Workflow is part of Osmedeus which is a collection of YAML files that describe your methodology.

Installation for Linux

NOTE that you need some essential tools like curl, wget, git, zip and login as root to start

bash <(curl -fsSL https://raw.githubusercontent.com/osmedeus/osmedeus-base/master/install.sh)

Anatomy of the Public Community methodology

community-workflow

general workflow

Usage

Check out this page to see how this workflow can be use to scan

# Scan Usage:
  osmedeus scan -f [flowName] -t [target]
  osmedeus scan -m [modulePath] -T [targetsFile]
  osmedeus scan -f /path/to/flow.yaml -t [target]
  osmedeus scan --threads-hold=30 -f cidr -t 1.2.3.4/24
  osmedeus scan -m /path/to/module.yaml -t [target] -l /tmp/log.log
  cat targets | osmedeus scan -f sample

# Practical Scan Usage:
  osmedeus scan -T list_of_targets.txt -W custom_workspaces
  osmedeus scan -t target.com -w workspace_name --debug
  osmedeus scan -f general -t sample.com
  osmedeus scan --tactic aggressive -f general -t sample.com
  osmedeus scan -f extensive -t sample.com -t another.com
  cat list_of_urls.txt | osmedeus scan -f urls
  osmedeus scan --threads-hold=30 -f cidr -t 1.2.3.4/24
  osmedeus scan -m ~/.osmedeus/core/workflow/test/dirbscan.yaml -t list_of_urls.txt
  osmedeus scan --wfFolder ~/custom-workflow/ -f your-custom-workflow -t list_of_urls.txt
  osmedeus scan --chunk --chunk-part 40 -c 2 -f cidr -t list-of-cidr.txt

# Queue Usage:
  osmedeus queue -Q /tmp/queue-file.txt -c 2
  osmedeus queue --add -t example.com -Q /tmp/queue-file.txt

# Provider Usage:
  osmedeus provider wizard
  osmedeus provider validate
  osmedeus provider build --token xxx --rebuild --ic
  osmedeus provider create --name 'sample'
  osmedeus provider health --debug
  osmedeus provider list
  osmedeus provider delete --id 34317111 --id 34317112

# Cloud Usage:
  osmedeus cloud -f [flowName] -t [target]
  osmedeus cloud -m [modulePath] -t [target]
  osmedeus cloud -c 5 -f [flowName] -T [targetsFile]
  osmedeus cloud --token xxx -c 5 -f [flowName] -T [targetsFile]
  osmedeus cloud --chunk -c 5 -f [flowName] -t [targetsFile]

# Utilities Usage:
  ## Health check utility
  osmedeus health
  osmedeus health git
  osmedeus health cloud
  osmedeus version --json
  ## Update utility
  osmedeus update
  osmedeus update --vuln
  osmedeus update --force --clean
  ## Other utilities
  osmedeus utils tmux ls
  osmedeus utils tmux logs -A -l 10
  osmedeus utils ps
  osmedeus utils ps --proc 'jaeles'
  osmedeus utils cron --cmd 'osmdeus scan -t example.com' --sch 60
  osmedeus utils cron --for --cmd 'osmedeus scan -t example.com'
  osmedeus utils workflow
  osmedeus config set --threads-hold=10

👨‍💻 Contribute

If you have found some valuable tool or suggest to use the tool in each module better feel free to open an issue for just DM me via @j3ssiejjj.

💬 Community & Discussion

Join Our Discord server here

💎 Donation & Sponsor

Osmedeus

Check out for a couple of donation methods here to get a premium package

License

Osmedeus is made with ♥ by @j3ssiejjj and it is released under the MIT license.