OpenKAT Logo

Contents

  • How does it work?
    • 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
    • Plugins for OpenKAT: boefjes, whiskers and bits
      • What types of plugins are available?
      • 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
      • Configurable bits
        • Question object
        • My first question object
        • What happens in the background?
        • Advantages and outlook
      • Add Boefjes
  • User Guide
    • User Guide
      • Web interface
        • Crisis Room
        • KAT-alog
        • Findings
        • Muted findings
        • Objects
        • Object clearances
        • Object details
        • Tasks
        • Members
        • Settings
      • Users and organizations
        • Organizations
        • Users
        • Rights and functions per user type
        • User management
        • Adding users through a CSV file
        • API token authentication
      • Working with objects
        • Properties
        • Start scan
        • View Findings
      • Scan levels, clearance & indemnities
        • Indemification by user
        • Inheritance
        • Extended profiles
      • Bits
      • Reports
      • My first scan
      • Trusted timestamps in OpenKAT
        • About the protocol
        • Available timestamp servers
        • How to verify a timestamp?
    • Reports
      • Report contents:
      • Report flow
      • Plugins
      • Downloading and/or exporting a report
      • Generating a Multi Report
      • Troubleshooting
    • Normalizers
      • Burp Suite
  • 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
      • Alternative installs
        • Kubernetes
        • Ansible
      • Development environment
        • make kat
      • Minimum requirements
      • Example infrastructure
    • Production: Container deployment
      • Container images
      • Setup
      • IPv6 support
      • Container commands
      • Upgrading
    • Production: Debian packages
      • Supported distributions
      • Prerequisites
      • Downloading and installing
      • Set up the databases
        • Rocky DB
        • KAT-alogus DB
        • Bytes DB
        • Mula DB
      • Create Rocky superuser and set up default groups and permissions
      • Set up RabbitMQ
        • Installation
        • Add the ‘kat’ vhost
      • Configure Bytes credentials
      • Configure hostname in Rocky
      • Restart KAT
      • Start KAT on system boot
      • Configure reverse proxy
      • Start using OpenKAT
      • Upgrading OpenKAT
    • Scripts
      • Installation
      • Update
      • Status and logs
      • Starting, stopping, restarting
      • Empty queue
      • Backup
      • How to backup your volume
      • Restoring your docker volume
      • Example
    • Production: Hardening OpenKAT
      • DJANGO_ALLOWED_HOSTS
      • DJANGO_CSRF_TRUSTED_ORIGINS
      • 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
        • Clean reinstallation
      • OpenTelemetry
    • Development: make kat on Windows
      • Follow these steps
        • Step 1: Install WSL
        • Step 2: Preparation
        • Step 3: Open your Linux subsystem
        • Step 4: Clone nl-kat-coordination
        • Step 5: Open the code in Visual Studio Code
        • Step 6: Complete the .env file
        • Step 7: Start OpenKAT
      • Troubleshooting
    • Test or develop via GitPod
      • Gitpod test environment
    • Adding NGINX to OpenKAT
      • Background
      • Installation
      • Logging
      • Activation
      • SSL certificates
      • Restart NGINX and go
      • Security settings
    • S3 buckets
      • Enabling S3 buckets for Bytes
      • S3 bucket names
    • Debugging and troubleshooting
      • Healthpage
      • Processes
        • Docker containers
        • Packaged versions
        • Debian package service logs
      • Diskspace in debug mode
      • XTDB memory size
      • Permissions
    • How do I customize LaTeX reports ?
      • Styling changes
        • Text colours
      • Readable findings
      • Changing fonts
    • Environment settings
      • Boefjes
        • BOEFJES_LOG_CFG
        • BOEFJES_POOL_SIZE
        • BOEFJES_POLL_INTERVAL
        • BOEFJES_WORKER_HEARTBEAT
        • BOEFJES_REMOTE_NS
        • BOEFJES_SCAN_PROFILE_WHITELIST
        • QUEUE_URI
        • KATALOGUS_DB_URI
        • KATALOGUS_DB_CONNECTION_POOL_SIZE
        • SCHEDULER_API
        • KATALOGUS_API
        • OCTOPOES_API
        • BOEFJES_API
        • BOEFJES_API_HOST
        • BOEFJES_API_PORT
        • BOEFJES_DOCKER_NETWORK
        • BYTES_API
        • BYTES_USERNAME
        • BYTES_PASSWORD
        • BOEFJES_ENCRYPTION_MIDDLEWARE
        • BOEFJES_KATALOGUS_PRIVATE_KEY
        • BOEFJES_KATALOGUS_PUBLIC_KEY
        • SPAN_EXPORT_GRPC_ENDPOINT
        • BOEFJES_LOGGING_FORMAT
        • BOEFJES_OUTGOING_REQUEST_TIMEOUT
      • Bytes
        • BYTES_SECRET
        • BYTES_USERNAME
        • BYTES_PASSWORD
        • QUEUE_URI
        • BYTES_LOG_CFG
        • BYTES_DB_URI
        • BYTES_DATA_DIR
        • BYTES_LOG_FILE
        • BYTES_ACCESS_TOKEN_EXPIRE_MINUTES
        • BYTES_FOLDER_PERMISSION
        • BYTES_FILE_PERMISSION
        • BYTES_HASHING_ALGORITHM
        • BYTES_EXT_HASH_REPOSITORY
        • BYTES_PASTEBIN_API_DEV_KEY
        • BYTES_RFC3161_PROVIDER
        • BYTES_RFC3161_CERT_FILE
        • BYTES_ENCRYPTION_MIDDLEWARE
        • BYTES_PRIVATE_KEY_B64
        • BYTES_PUBLIC_KEY_B64
        • BYTES_METRICS_TTL_SECONDS
        • BYTES_METRICS_CACHE_SIZE
        • SPAN_EXPORT_GRPC_ENDPOINT
        • BYTES_DB_CONNECTION_POOL_SIZE
        • BYTES_LOGGING_FORMAT
        • S3_BUCKET_PREFIX
        • S3_BUCKET
        • BUCKET_PER_ORG
      • Keiko
        • DEBUG
        • KEIKO_LOG_CFG
        • KEIKO_TEMPLATES_FOLDER
        • KEIKO_GLOSSARIES_FOLDER
        • KEIKO_ASSETS_FOLDER
        • KEIKO_REPORTS_FOLDER
        • SPAN_EXPORT_GRPC_ENDPOINT
      • Mula
        • DEBUG
        • SCHEDULER_LOG_CFG
        • SCHEDULER_COLLECT_METRICS
        • SCHEDULER_LOGGING_FORMAT
        • SCHEDULER_API_HOST
        • SCHEDULER_API_PORT
        • SCHEDULER_MONITOR_ORGANISATIONS_INTERVAL
        • SCHEDULER_OCTOPOES_REQUEST_TIMEOUT
        • SCHEDULER_OCTOPOES_POOL_CONNECTIONS
        • SCHEDULER_KATALOGUS_CACHE_TTL
        • SCHEDULER_KATALOGUS_REQUEST_TIMEOUT
        • SCHEDULER_KATALOGUS_POOL_CONNECTIONS
        • SCHEDULER_BYTES_REQUEST_TIMEOUT
        • SCHEDULER_BYTES_POOL_CONNECTIONS
        • SCHEDULER_RABBITMQ_PREFETCH_COUNT
        • KATALOGUS_API
        • BYTES_API
        • BYTES_USERNAME
        • BYTES_PASSWORD
        • OCTOPOES_API
        • QUEUE_URI
        • QUEUE_URI
        • SPAN_EXPORT_GRPC_ENDPOINT
        • SCHEDULER_PQ_MAXSIZE
        • SCHEDULER_PQ_INTERVAL
        • SCHEDULER_PQ_GRACE_PERIOD
        • SCHEDULER_PQ_MAX_RANDOM_OBJECTS
        • SCHEDULER_DB_URI
        • SCHEDULER_DB_CONNECTION_POOL_SIZE
      • Octopoes
        • OCTOPOES_LOG_CFG
        • QUEUE_URI
        • XTDB_URI
        • KATALOGUS_API
        • OCTOPOES_SCAN_LEVEL_RECALCULATION_INTERVAL
        • OCTOPOES_BITS_ENABLED
        • OCTOPOES_BITS_DISABLED
        • SPAN_EXPORT_GRPC_ENDPOINT
        • OCTOPOES_LOGGING_FORMAT
        • OCTOPOES_OUTGOING_REQUEST_TIMEOUT
        • OCTOPOES_WORKERS
      • Rocky
        • Email Settings
    • External authentication
    • CVE API
  • Developer documentation
    • Rocky
      • Installation
        • Containerized
        • Local
      • Development
        • Testing
      • Design
        • Fonts license
      • Technical Design
        • Running a boefje
        • Rocky View Structure
    • Scheduler
      • Purpose
      • Architecture
        • Stack, packages and libraries
        • External services
        • Project structure
      • Running / Developing
        • Prerequisites
        • Running
        • Migrations
      • Testing
    • Boefjes
      • Prerequisites
      • KATalogus
        • Organisations
        • Plugins
        • Settings
      • Environment variables
      • Technical Design
        • Boefje and Normalizer Workers
        • Running as a Docker container
        • Running the worker directly
        • Example job
        • Manually running a boefje or normalizer
        • Boefje and normalizer structure
        • Tests
    • Design considerations for new boefjes runner
      • Images
        • Distribution
        • Metadata
      • I/O
        • Input
        • Output
      • Logging
      • Runtimes
        • Docker
        • Kubernetes
        • Nomad
      • Building images with this spec from the current boefjes
        • Summary of decisions
      • Limitations
    • Design considerations for new normalisers (whiskers) runner
      • Current situation
      • Requirements
      • Design
        • Runtime
        • Distribution
        • Input/Output
        • Supervisor process
      • Discussion
      • Conclusions
    • Bytes
      • Installation
        • With Docker
        • Without Docker
        • Hashing and Encryption
        • Observability
      • Design
        • Design: C2 Container level
        • Design: C3 Component level
      • Development
        • Code style and tests
        • Migrations
        • Export SQL migrations
      • Production
        • Performance tuning
    • Octopoes
      • Instructions
        • Run Octopoes API
        • Run the event processor
      • Healthcheck
      • OOI
      • Origin
      • Origin through declaration
      • Origin through observation
      • Origin through inference
      • Graph mutations
      • Code Architecture
        • Sequence: save_origin
        • Sequence: process update ooi
      • XTDB
        • XTDB-cli tool
        • XTDB analyze bits tool
      • OOI Objects
      • Relationships
      • A few example records
      • OOI Reference
      • Octopoes API
        • OctopoesAPIConnector
      • Abstract classes / subclassing
      • Querying
      • Run bit manually
      • Tests
    • Octopoes Models
      • octopoes.models.ooi.service
        • IPService
        • Service
        • TLSCipher
      • octopoes.models.ooi.findings
        • ADRFindingType
        • CAPECFindingType
        • CVEFindingType
        • CWEFindingType
        • Finding
        • FindingType
        • KATFindingType
        • MutedFinding
        • RetireJSFindingType
        • RiskLevelSeverity
        • SnykFindingType
      • octopoes.models.ooi.email_security
        • DKIMExists
        • DKIMKey
        • DKIMSelector
        • DMARCTXTRecord
        • DNSSPFMechanism
        • DNSSPFMechanismHostname
        • DNSSPFMechanismIP
        • DNSSPFMechanismNetBlock
        • DNSSPFRecord
      • octopoes.models.ooi.web
        • APIDesignRule
        • APIDesignRuleResult
        • HTTPHeader
        • HTTPHeaderHostname
        • HTTPHeaderURL
        • HTTPResource
        • HostnameHTTPURL
        • IPAddressHTTPURL
        • ImageMetadata
        • RESTAPI
        • SecurityTXT
        • URL
        • WebScheme
        • WebURL
        • Website
      • octopoes.models.ooi.config
        • Config
      • octopoes.models.ooi.certificate
        • AlgorithmType
        • SubjectAlternativeName
        • SubjectAlternativeNameHostname
        • SubjectAlternativeNameIP
        • SubjectAlternativeNameQualifier
        • X509Certificate
      • octopoes.models.ooi.monitoring
        • Application
        • Incident
      • octopoes.models.ooi.question
        • Question
      • octopoes.models.ooi.network
        • AutonomousSystem
        • IPAddress
        • IPAddressV4
        • IPAddressV6
        • IPPort
        • IPV4NetBlock
        • IPV6NetBlock
        • NetBlock
        • Network
        • PortState
        • Protocol
      • octopoes.models.ooi.reports
        • Report
        • ReportData
        • ReportRecipe
      • octopoes.models.ooi.dns.records
        • CAATAGS
        • DNSAAAARecord
        • DNSARecord
        • DNSCAARecord
        • DNSCNAMERecord
        • DNSMXRecord
        • DNSNSRecord
        • DNSPTRRecord
        • DNSRecord
        • DNSSOARecord
        • DNSTXTRecord
        • NXDOMAIN
      • octopoes.models.ooi.dns.zone
        • DNSZone
        • Hostname
        • ResolvedHostname
      • octopoes.models.ooi.software
        • Software
        • SoftwareInstance
    • Octopoes Research
      • Introduction
      • Part I - Requirements, context and inherent complexities
        • Context of Octopoes in KAT
        • Objectives
        • Complexities of Octopoes
      • Part II - Working towards a solution
        • Stages of data processing
        • ClaimSpace
        • FactSpace
        • Inference
        • Handling updates / incoming data
    • Keiko
      • Installation requirements
      • File system permissions
      • Running the API
      • Logging
      • Building a new template
      • Generating a report
      • Testing a report with command line
    • Reports
      • Creating reports
        • Location of the report code
        • Steps to create a new report
        • Collecting data
      • Writing report unit tests
        • Purpose of unit testing
        • Steps for writing unit tests
        • Executing unit tests
    • Development tutorial
      • Glossary
        • Creating a Boefje
        • Testing the boefje
        • Creating a new model
        • Creating a normalizer
        • Creating a bit
        • Creating a report
  • UI/UX design documentation
    • Figma
      • Design process
      • Fundamentals
      • Components
      • Design workfile
      • For review
      • Approved for implementation
  • Release notes
    • OpenKAT 1.18
      • New Features
      • Bug fixes
      • Upgrading
        • Debian packages
      • Full Changelog
    • OpenKAT 1.17
      • New Features
      • Bug fixes
      • Upgrading
      • Running the Origin Migration
      • Full Changelog
    • OpenKAT 1.16
      • New Features
      • Bug fixes
      • Upgrading
      • Checking the KATalogus Migration
      • Full Changelog
    • OpenKAT 1.15 (Roeltje)
      • New Features
      • Bug fixes
      • Upgrading
        • Debian packages
      • Full Changelog
    • OpenKAT 1.14
      • New Features
      • Bug fixes
      • Upgrading
        • Debian packages
      • Full Changelog
    • OpenKAT 1.13
      • New Features
      • Bug fixes
      • Upgrading
        • Containers
        • Debian packages
      • Full Changelog
    • OpenKAT 1.12
      • New Features
      • Bug fixes
      • Upgrading
      • Full Changelog
    • OpenKAT 1.11
      • New Features
      • Bug fixes
      • Upgrading
      • Full Changelog
    • OpenKAT 1.10
      • New Features
      • Bug fixes
      • Upgrading
      • Full Changelog
    • OpenKAT 1.9
      • New Features
      • Bug fixes
      • Upgrading
      • Full Changelog
    • OpenKAT 1.8
      • New Features
      • Bug fixes
      • Upgrading
        • Development containers
      • Full Changelog
    • OpenKAT 1.7
      • New Features
      • Upgrading
        • Debian packages
      • Full Changelog
    • OpenKAT 1.6
      • Full Changelog
    • OpenKAT 1.5
      • New Features
      • Upgrading
        • Containers
        • Debian packages
      • Full Changelog
  • Project Guidelines
    • Project management
      • Feature Milestones
      • Bugs and Feature Requests
      • Pull Requests
      • In-depth content discussions
    • Development
      • Code
      • Tools
        • Pre-commit
      • Signed commits
      • Type Hinting
      • Testing
        • Unit Tests
        • Integration Tests
      • Development Environment
      • Merge Strategy
        • Branching
        • Reviews
        • Code commenting and documentation
      • Line ends
      • Technical diagrams
      • Dependency management
    • OpenKAT background and concepts
      • Indemnification statements
      • Safe viewing of boefjes-data (dutch)
      • OpenKAT as educational tool (dutch)
    • Contributions
      • Contribute to Codebase
      • Contribute Documentation
      • Contribute Translations
        • Adding a new language
      • Contributor Social Contract
      • Code of Conduct
      • Security
    • Feature flow
      • Getting features in the main branch
        • 1. Approved Features / Need Refinement → Refined Tasks
        • 2. In Progress → Review
        • 3. Review → QA review
        • 4. QA Review → Ready for Merge
        • 5. Ready for merge → Done
      • Releasing features
        • Environments for the extended QA
        • Checklist for QA
        • Extended checklist for QA
      • Tips and tricks for pull request QA testing
        • Think outside the box
        • Be pragmatic but versatile
  • GitHub Templates
    • Bug Report Template
    • Feature Request Template
    • Pull Request template for authors
    • Code review checklist for PR’s
    • QA checklist for PR’s
OpenKAT
  • GitHub Templates
  • Edit on GitHub

GitHub Templates

Contains files to be used in the .github folder.

Contents

  • Bug Report Template
  • Feature Request Template
  • Pull Request template for authors
  • Code review checklist for PR’s
  • QA checklist for PR’s
Previous Next

© Copyright Ministerie van Volksgezondheid, Welzijn en Sport (European Union Public License 1.2).

Built with Sphinx using a theme provided by Read the Docs.