Skip to content

armgit / ARES

Public Imported from GitHub
0

ARES - authorized red-team engagement automation with dashboard, campaign scope, module orchestration, OPSEC controls, encrypted vault, and reporting.

4.3 KB
Raw Blame
# ARES Environment Variables
# Copy this to .env and fill in your values. NEVER commit .env to git.

# API Security
# Generate this yourself per deployment. ARES does not provide a shared default.
# Used to sign JWT/session security data. Keep private and never commit it.
# Bash: openssl rand -hex 32
ARES_SECRET_KEY=CHANGE_ME_USE_openssl_rand_-hex_32
ARES_API_HOST=127.0.0.1
ARES_API_PORT=8080
ARES_DEBUG=true
# Browser authentication is same-origin only.
# For local dev / quickstart (ARES_DEBUG=true), leave blank to default to http://127.0.0.1:5173.
# For production (ARES_DEBUG=false), set this to your exact HTTPS origin (e.g. https://ares.corp.local)
# and ensure that host is included in ARES_TRUSTED_HOSTS below.
ARES_BROWSER_ORIGIN=

# JWT Algorithm
# HS256 (default, symmetric): sign + verify with ARES_SECRET_KEY - suitable for single-service
# RS256 (asymmetric RSA):     sign with private key, verify with public key
#   Recommended for multi-service: distribute only the public key to verifier services
#   Generate keypair:
#     openssl genrsa -out ares_jwt_private.pem 2048
#     openssl rsa -in ares_jwt_private.pem -pubout -out ares_jwt_public.pem
ARES_JWT_ALGORITHM=HS256
ARES_JWT_EXPIRE_MINUTES=60
# ARES_JWT_PRIVATE_KEY_PATH=/run/secrets/ares_jwt_private.pem   # RS256 only
# ARES_JWT_PUBLIC_KEY_PATH=/run/secrets/ares_jwt_public.pem     # RS256 only

# Database
# SQLite (default - no setup required, single-node)
ARES_DATABASE_URL=sqlite+aiosqlite:///./ares.db
#
# PostgreSQL (multi-operator production deployments)
# Requires: pip install ares-redteam[postgres]
# Run migrations first: alembic upgrade head
# ARES_DATABASE_URL=postgresql+asyncpg://ares_user:strong_password@db:5432/ares_db

# Encryption key for stored sensitive data (AES-256-GCM)
# Generate this yourself per deployment (32 bytes / 256 bits, url-safe base64).
# Used for encrypted database/vault/checkpoint material.
# Keep it stable and backed up securely; changing it after data exists can make
# old encrypted records unreadable.
# Generate:
#   python -c "import secrets; print(secrets.token_urlsafe(32))"
ARES_ENCRYPTION_KEY=CHANGE_ME_USE_secrets_token_urlsafe_32

# Legacy encryption salt - for DataEncryptor records written before v6
# Only set if you rotated the default salt in a previous deployment.
# Changing this makes all pre-v6 encrypted records unreadable.
# Default (if unset): built-in v5 fixed salt is used automatically.
# ARES_LEGACY_SALT=your-custom-legacy-salt-here

# Legacy vault salt - for CredentialVault records written before v6
# ARES_VAULT_LEGACY_SALT=your-custom-vault-legacy-salt-here

# Logging
ARES_LOG_LEVEL=INFO
ARES_LOG_FILE=logs/ares.log

# Rate limiting (requests per minute per IP)
ARES_RATE_LIMIT_RPM=60
# Optional Redis URL for multi-pod/distributed rate limiting.
# Leave unset for the in-process local fallback.
# ARES_REDIS_URL=redis://redis:6379/0

# PDF export browser fallback (optional)
# Set only if browser auto-detection cannot find a working Edge/Chrome/Chromium.
# Windows Edge example:
# ARES_PDF_BROWSER=C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe

# Noise defaults
ARES_DEFAULT_NOISE_PROFILE=stealth
ARES_DEFAULT_JITTER_MIN_MS=500
ARES_DEFAULT_JITTER_MAX_MS=3000

# Webhook Notifications (optional)
# Slack/Teams/generic webhook URL. Leave blank to disable webhook notifications.
ARES_WEBHOOK_URL=
ARES_WEBHOOK_ON_SEVERITY=critical,high    # Severities to alert on
ARES_WEBHOOK_TIMEOUT=5.0                  # HTTP timeout seconds
ARES_WEBHOOK_RETRY=2                      # Max retries on failure

# Network Security
# Comma-separated origins for noncredentialed bearer/API-key integrations only.
# Browser cookie authentication never relies on CORS. No wildcard or null.
# Production: set only the exact integration origins you operate.
#   Example: ARES_CORS_ORIGINS=https://ares.corp.local,https://pentest.corp.local
ARES_CORS_ORIGINS=https://ares.corp.local

# Comma-separated trusted hostnames for TrustedHostMiddleware (no wildcard)
# Dev default: localhost only. Production: set to your actual hostname/IP.
#   Example: ARES_TRUSTED_HOSTS=ares.corp.local,10.0.0.5
ARES_TRUSTED_HOSTS=localhost,127.0.0.1

# Bootstrap Admin (change immediately after first startup)
# You choose this password. It is only for creating the first admin account.
# After first login, change it from the Security page.
ARES_DEFAULT_ADMIN_PASSWORD=YOUR_STRONG_ADMIN_PASSWORD_HERE