AppSentinels Platform Deployment

The AppSentinels API Security Platform is available as a SaaS solution or an On-Prem Hosted Application Security platform, designed for high availability, low latency, and ultra-high scalability, ensuring robust API protection across diverse environments.

For organizations in highly regulated industries, AppSentinels offers a fully on-premises deployment where all AI/ML security models are hosted internally. This ensures that data remains within organizational boundaries, maintaining strict compliance with data privacy regulations.

Prerequisites

The following requirements must be met for deploying the AppSentinels Security Platform:

System Requirements

• Operating System: Ubuntu 22.04 or later / Red Hat 8.6 or later
• CPU: 16/32 cores (x86_64) - The CPU must support AVX, AVX2, SSE, and FMA instruction sets to run machine learning models efficiently. You can verify this by running the command:

  'lscpu | grep Flags'

• RAM: 64/128 GB
• Disk Space:
  • 100 GB of free space in the /var partition
  • 4 TB of data disk for data and logs

Note: CPU, memory, and disk requirements may vary based on the volume of API traffic being monitored.

Required Packages

• Docker: Version 23.0 or higher
• Docker Compose: Version 1.28.6 or higher (if deploying with docker-compose)

Network Connectivity Requirements

• TCP Port 443 must be open to access AppSentinels API Security Platform
• TCP Port 9004 must be open for the AppSentinels Sensor/Plugin
• Access to Docker repositories is required to download images:
  • docker.io
  • auth.docker.io
  • registry-1.docker.io
  • production.cloudflare.docker.com
• Access to downloads.appsentinels.ai to download the installation package.

Proxy Configuration

If a proxy is installed, follow these guidelines:

• Disable the proxy for localhost, hostname, and host IP communications.
• Disable the proxy in Docker environments to avoid connectivity issues.

DAST Requirements

• Ensure network connectivity from the AppSentinels Platform server to the application under test.
• Provide two test user accounts with valid credentials for API security testing.

Pre-Installation Checks

1. System Requirements

• Verify the OS:

  uname -a

• Check proxy configuration settings.
• Check if Docker and Docker Compose are installed:
  • Docker version:

    docker -v

  • Docker Compose version:

    docker-compose -v

• Confirm Docker Hub access:

  docker pull appsentinels/ng-controller:latest

2. Certificate & Directory Setup

• Copy signed or self-signed certificates to:

  INSTALL_DIR/certs

• Ensure the base directory is created and has correct permissions:
  • Create directory:

    mkdir -p /as_platform

  • Set permissions:

    chmod 777 /as_platform

3. Network & Accessibility

• Ensure the hostname is DNS reachable, or update the /etc/hosts file.
• Confirm TCP Port 443 is open and accessible.
• Test connectivity to the AppSentinels Platform from a desktop.