Guides
Start typing to search…

Deploying a scanner from scratch

Scanner Deployment Guide

Guide for deploying CyberOptix scanners for automated security testing.

Overview

CyberOptix scanners perform automated discovery, vulnerability scanning, and security testing within defined zones. Scanners are deployed on your infrastructure and connect to the CyberOptix platform to receive scanning tasks.

Prerequisites

  • Ubuntu Server 24.04 or Red Hat Enterprise Linux 9.6
  • Root or sudo access
  • Network connectivity to CyberOptix platform
  • Minimum 8 GB RAM, 4 CPU cores, 120 GB disk space

Ubuntu Server 24.04 Installation

Step 1: Add Purple Team Software Repository

wget -O - https://apt.fury.io/purpleteamsoftware/gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/purpleteamsoftware-archive-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/purpleteamsoftware-archive-keyring.gpg] https://apt.purpleteamsoftware.com/ /" | sudo tee /etc/apt/sources.list.d/purpleteamsoftware.list

Step 2: Install CyberOptix Scanner

sudo apt update && sudo apt install cyberoptix.scanner -y

Step 3: Disable Swap

sudo sed -i '/swap/ s/^/#/' /etc/fstab
sudo sed -i '/127\.0\.1\.1/ s/^/#/' /etc/hosts

Step 4: Reboot System

sudo reboot

Red Hat Enterprise Linux 9.6 Installation

Step 1: Import GPG Key

sudo rpm --import https://apt.fury.io/purpleteamsoftware/gpg.key

Step 2: Create Repository File

sudo tee /etc/yum.repos.d/purpleteamsoftware.repo > /dev/null << 'EOF'
[purpleteamsoftware]
name=PurpleTeam Software Repository
baseurl=https://dnf.purpleteamsoftware.com/
enabled=1
gpgcheck=1
gpgkey=https://apt.fury.io/purpleteamsoftware/gpg.key
EOF

Step 3: Install Dependency Repositories

# EPEL (required for pipx/sysstat/openvpn on EL9)
sudo dnf install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm

# Docker CE repository
sudo dnf -y install dnf-plugins-core
sudo dnf config-manager --add-repo https://download.docker.com/linux/rhel/docker-ce.repo

Step 4: Install CyberOptix Scanner

sudo dnf clean all && sudo dnf makecache && sudo dnf install cyberoptix.scanner -y

Step 5: Disable Swap

sudo sed -i '/swap/ s/^/#/' /etc/fstab

Step 6: Reboot System

sudo reboot

Post-Installation

After installation is complete, proceed to configure the scanner to link it with your CyberOptix organization and scanner group.

System Requirements

Minimum Specifications

  • CPU: 2 cores
  • Memory: 8 GB RAM
  • Disk: 120 GB available space
  • Network: Outbound HTTPS (443) access to CyberOptix platform

Recommended Specifications

  • CPU: 4 cores
  • Memory: 16 GB RAM
  • Disk: 150 GB available space
  • Network: Outbound HTTPS (443) access to CyberOptix platform

Network Requirements

Scanners require outbound access to:

  • CyberOptix platform (https://{instance}.cyberoptix.io)
  • Purple Team Software package repositories
  • Target networks defined in assigned zones

Firewall Rules:

  • Allow outbound HTTPS (443) to CyberOptix platform
  • Allow outbound access to scanning targets (configurable per zone)
  • No inbound connections required

Scanner Capabilities

Once deployed and configured, scanners perform:

Discovery:

  • Network host discovery
  • Service and port enumeration
  • Web application identification
  • SSL/TLS certificate analysis

Vulnerability Scanning:

  • Network vulnerability assessment
  • Web application security testing (DAST)
  • Configuration compliance checks
  • CVE detection and reporting

Continuous Monitoring:

  • Scheduled scanning based on zone configuration
  • Real-time task processing
  • Automated reporting to CyberOptix platform

Next Steps

  1. Complete scanner configuration using the link command from your scanner group
  2. Verify scanner connectivity to CyberOptix platform
  3. Assign scanner group to zones
  4. Configure scan schedules and parameters
  5. Monitor scanner activity and scan results

Additional Resources

Updated about 2 months ago