Welcome to the OpenKAT documentation!

Contents

• Introduction
  • What is OpenKAT
    • Introduction
    • White papers
    • Securityconcept
    • Who is OpenKAT for?
    • Where do I start with OpenKAT?
    • Where is the software located?
    • Responsible disclosure
    • What are the plans for the future?
  • How does OpenKAT work?
    • General notes
    • Basic concepts
      • Objects, the data model and recursivity
      • Indemnification
      • Users and organizations
    • System design
      • Collection: Boefjes and Whiskers
      • Storage: Bytes and Octopoes
      • Analysis: Bits
      • Reports
  • User Guide
    • Web interface
      • Crisis Room
      • KAT catalog
      • Findings
      • Objects
      • Tasks
    • Users and organizations
      • Organizations
      • Users
      • User management
    • OpenKAT Objects
      • Properties
      • Start scan
      • View Findings
    • Scan levels and indemnities
      • Indemification by user
      • Inheritance
      • Extended profiles
    • Reports
    • My first scan
  • Plugins for OpenKAT: boefjes, whiskers and bits
    • What types of plugins are there?
    • How does it work?
    • Where to start?
    • Existing boefjes
      • Object-types, classes and objects.
      • Example: the boefje for shodan
      • Normalizers
    • Adding object-types
    • Bits: businessrules
    • Add Boefjes
• Modules
  • Modules
    • Rocky - frontend
    • Mula - scheduler
    • Octopoes - datamodel
    • Bytes - raw data storage
    • Boefjes and whiskers - scanners and normalizers
    • Keiko - reporting tool
    • Manon - styling
• Installation and deployment
  • How do I install OpenKAT?
    • Production environments
      • Pre-built Docker images
      • Debian packages
    • Development environment
      • make kat
    • Minimum requirements
    • Example infrastructure
  • Production: Container deployment
    • Container images
    • Setup
    • Container commands
    • Env variables
      • Boefjes / Katalogus
    • Bytes
    • Octopoes
    • Mula
    • Rocky
  • Production: Debian packages
    • Prerequisites
    • Downloading and installing
    • Set up the databases
      • Rocky DB
      • KAT-alogus DB
      • Bytes DB
    • Create Rocky superuser and set up default groups and permissions
    • Set up RabbitMQ
      • Installation
      • Add the ‘kat’ vhost
    • Configure Bytes credentials
    • Restart KAT
    • Start KAT on system boot
    • Start using OpenKAT
    • Upgrading OpenKAT
  • Production: Hardening OpenKAT
    • Password Django installation
    • SESSION_COOKIE_AGE
    • Security headers
    • SSL/TLS on nginx
    • Obscuring errors to the clients
    • Web Application Firewall
    • Continue reading
  • Development: make kat
    • make kat
      • Requirements
      • Before installing
      • Getting Started
      • Updates
  • Adding NGINX to OpenKAT
    • Background
    • Installation
    • Logging
    • Activation
    • SSL certificates
    • Restart NGINX and go
    • Security settings
• Release notes
  • OpenKAT 1.5
    • New Features
    • Upgrading
      • Containers
      • Debian packages
    • Full Changelog
  • OpenKAT 1.8
    • Upgrading
      • Development containers
• Project Guidelines
  • Project management
    • Feature Milestones
    • Bugs and Feature Requests
    • Pull Requests
    • In-depth content discussions
  • Development
    • Code
    • Tools
      • Pre-commit
    • Type Hinting
    • Testing
      • Unit Tests
      • Integration Tests
    • Development Environment
    • Merge Strategy
      • Branching
      • Reviews
      • Code commenting and documentation
    • Technical diagrams
  • Contributions
    • Contribute to Codebase
    • Contribute Documentation
    • Contributor Social Contract
    • Code of Conduct
    • Security
  • Project statuses
• GitHub Templates
  • Bug Report Template
  • Feature Request Template
  • Pull Request Template
• UI/UX design documentation
  • Figma
    • Design process
    • Fundamentals
    • Components
    • Design workfile
    • For review
    • Approved for implementation