Documentation | Augment AI Platform

Installation

Deploy AI SecurityAuditor in your environment quickly and start identifying security risks across your infrastructure.

System Requirements

Python 3.8 or higher
Docker 20.0+ (for container scanning)
Terraform 1.0+ (for infrastructure scanning)
Minimum 8GB RAM (16GB recommended)
Network access to cloud providers and target systems

Install via Package Manager

Installationbash

# Install via pip
pip install augment-security-auditor

# Install via conda
conda install -c augment security-auditor

# Install from source
git clone https://github.com/augment-ai/security-auditor
cd security-auditor
pip install -e .

# Verify installation
security-auditor --version

Authentication

Configure your cloud provider credentials and Augment API key:

Authentication Setupbash

# Set Augment API key
export AUGMENT_API_KEY=your_api_key_here

# Configure AWS credentials
aws configure

# Configure Azure CLI
az login

# Configure GCP credentials
gcloud auth application-default login

# Verify authentication
security-auditor auth verify

Quick Start

Run your first security audit in minutes and identify critical vulnerabilities across your infrastructure.

1. Initialize Security Profile

Profile Setupbash

# Create security profile for your organization
security-auditor init --profile production

# Configure scanning scope
security-auditor config --scope aws,azure,gcp
security-auditor config --compliance soc2,iso27001

# This creates .security-auditor.yaml config file

2. Run Infrastructure Scan

Infrastructure Auditbash

# Scan all cloud resources
security-auditor scan --type infrastructure

# Scan specific cloud provider
security-auditor scan --provider aws --region us-east-1

# Quick security assessment
security-auditor scan --quick --critical-only

3. Generate Security Report

Security Reportsbash

# Generate comprehensive security report
security-auditor report --format html --output security-report.html

# Export findings as JSON
security-auditor report --format json --output findings.json

# Generate compliance report
security-auditor report --compliance soc2 --output compliance-report.pdf

Configuration

Configure AI SecurityAuditor to match your organization's security policies and compliance requirements.

Basic Configuration

.security-auditor.yamlyaml

version: "1.0"
organization: "your-company"
environment: "production"

scanning:
  providers:
    - aws
    - azure
    - gcp
  regions:
    - us-east-1
    - us-west-2
    - eu-west-1
  
compliance:
  standards:
    - soc2
    - iso27001
    - gdpr
  
security_policies:
  encryption:
    enforce: true
    algorithms: ["AES-256", "RSA-2048"]
  access_control:
    mfa_required: true
    privileged_access_review: true
  network:
    public_access_restricted: true
    security_groups_strict: true

Security Policies

Define custom security policies and rules that align with your organization's security requirements.

Custom Security Policiesyaml

policies:
  - name: "Critical Asset Protection"
    description: "Ensure critical assets have proper protection"
    rules:
      - resource_type: "database"
        encryption: "required"
        backup: "daily"
        monitoring: "enabled"
      
  - name: "Network Security"
    description: "Network security best practices"
    rules:
      - resource_type: "load_balancer"
        ssl_termination: "required"
        security_headers: "enabled"
      
  - name: "Identity and Access"
    description: "IAM security requirements"
    rules:
      - resource_type: "user"
        mfa: "required"
        password_policy: "strict"
        inactive_days_max: 90

Environment Variables

Configure AI SecurityAuditor behavior using environment variables for different deployment scenarios.

Variable	Description	Default
AUGMENT_API_KEY	Your Augment API key	Required
SECURITY_AUDITOR_CONFIG	Path to configuration file	.security-auditor.yaml
SECURITY_AUDITOR_LOG_LEVEL	Logging level (debug/info/warn/error)	info

Basic Usage

Learn the fundamental scanning patterns and security assessment workflows.

Scanning Commands

Security Scanningbash

# Full infrastructure scan
security-auditor scan --type infrastructure

# Application security scan
security-auditor scan --type application --path ./src

# Container security scan
security-auditor scan --type container --image nginx:latest

# Network security assessment
security-auditor scan --type network --target 10.0.0.0/8

CLI Commands Reference

Complete reference for all security auditing commands and options.

scan

Run security analysis on infrastructure, applications, or containers

security-auditor scan [options]

Options:
  --type <type>           Scan type (infrastructure|application|container|network)
  --provider <provider>   Cloud provider (aws|azure|gcp)
  --region <region>       Target region for scanning
  --output <file>         Output file path
  --format <format>       Output format (json|html|csv|pdf)
  --compliance <std>      Compliance standard to check against
  --severity <levels>     Severity levels to report
  --critical-only         Show only critical findings
  --remediation           Include remediation suggestions

Best Practices

Security scanning best practices to maximize threat detection and minimize false positives.

Security Scanning Strategy

Schedule daily automated scans for critical infrastructure
Run immediate scans after infrastructure changes
Focus on high and critical severity findings first
Implement security policies as code
Track remediation progress with compliance reports

CI/CD Integration

Integrate security scanning into your DevOps pipeline for continuous security assessment.

GitHub Actions

.github/workflows/security-audit.ymlyaml

name: Security Audit

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main]
  schedule:
    - cron: '0 2 * * *'  # Daily at 2 AM

jobs:
  security-audit:
    runs-on: ubuntu-latest
    
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      
      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.9'
      
      - name: Install Security Auditor
        run: pip install augment-security-auditor
      
      - name: Run Security Scan
        env:
          AUGMENT_API_KEY: ${{ secrets.AUGMENT_API_KEY }}
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        run: |
          security-auditor scan --type infrastructure --critical-only
          security-auditor scan --type application --path .
      
      - name: Upload Security Report
        uses: actions/upload-artifact@v3
        with:
          name: security-report
          path: security-report.html

Compliance Reports

Generate comprehensive compliance reports for various security standards and regulations.

Supported Standards

SOC 2

Type I & II

ISO 27001

Full Controls

GDPR

Privacy Controls

HIPAA

Healthcare Security

PCI DSS

Payment Security

NIST

Cybersecurity Framework

API Integration

Integrate AI SecurityAuditor into your security operations center (SOC) and monitoring systems.

REST API

API Usagebash

# Trigger security scan via API
curl -X POST https://api.augment.cfd/v1/security/scan \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scan_type": "infrastructure",
    "target": {
      "provider": "aws",
      "region": "us-east-1"
    },
    "options": {
      "compliance": ["soc2", "iso27001"],
      "severity": "high"
    }
  }'

Python SDK

Python Integrationpython

from augment_security import SecurityAuditor

# Initialize security auditor
auditor = SecurityAuditor(api_key=os.environ['AUGMENT_API_KEY'])

# Run infrastructure scan
scan_result = await auditor.scan_infrastructure(
    provider='aws',
    region='us-east-1',
    compliance=['soc2', 'iso27001']
)

# Get critical findings
critical_findings = scan_result.get_findings(severity='critical')
print(f"Found {len(critical_findings)} critical security issues")

# Generate compliance report
compliance_report = await auditor.generate_compliance_report(
    standard='soc2',
    format='pdf'
)

API Reference

Complete API documentation for integrating security scanning into your applications and workflows.

Security Scan Endpoint

POST /v1/security/scan

Initiate a comprehensive security scan of your infrastructure.

Request Body:

{
  "scan_type": "infrastructure|application|container|network",
  "target": {
    "provider": "aws|azure|gcp",
    "region": "us-east-1",
    "resource_ids": ["resource-123", "resource-456"]
  },
  "options": {
    "compliance": ["soc2", "iso27001", "gdpr"],
    "severity": "low|medium|high|critical",
    "policies": ["custom-policy-1", "custom-policy-2"]
  }
}

Response:

{
  "scan_id": "scan-789",
  "status": "completed",
  "summary": {
    "total_resources": 156,
    "total_findings": 23,
    "critical_findings": 3,
    "high_findings": 8,
    "medium_findings": 12
  },
  "compliance_score": {
    "soc2": 94.5,
    "iso27001": 91.2
  },
  "findings": [
    {
      "id": "finding-001",
      "severity": "critical",
      "category": "access_control",
      "resource_id": "sg-123456",
      "title": "Security group allows unrestricted access",
      "description": "Security group allows inbound traffic from 0.0.0.0/0",
      "remediation": "Restrict security group rules to specific IP ranges",
      "compliance_impact": ["soc2:CC6.1", "iso27001:A.13.1.3"]
    }
  ]
}

Troubleshooting

Common issues and solutions when running security audits.

Common Issues

Permission Denied

Error: Insufficient permissions to scan cloud resources

Solutions:

Verify cloud provider credentials are configured correctly
Ensure IAM roles have necessary read permissions
Check if MFA is required for your account
Review and update service account permissions

Scan Timeout

Security scan taking too long or timing out

Solutions:

Reduce scan scope by targeting specific regions
Use resource filters to limit scan scope
Increase timeout values in configuration
Run scans in smaller batches

False Positives

Too many false positive security findings

Solutions:

Configure custom security policies
Use exemption rules for known safe configurations
Adjust severity thresholds
Provide context through resource tagging

Security Documentation Complete!

You now have comprehensive knowledge to implement AI SecurityAuditor in your environment. From basic scanning to advanced compliance reporting, you're equipped to strengthen your organization's security posture with AI-powered threat detection.

Ready to enhance your security posture? Start your free security assessment today and discover vulnerabilities before attackers do.

Installation

Deploy AI SecurityAuditor in your environment quickly and start identifying security risks across your infrastructure.

System Requirements

Python 3.8 or higher
Docker 20.0+ (for container scanning)
Terraform 1.0+ (for infrastructure scanning)
Minimum 8GB RAM (16GB recommended)
Network access to cloud providers and target systems

Install via Package Manager

Installationbash

# Install via pip
pip install augment-security-auditor

# Install via conda
conda install -c augment security-auditor

# Install from source
git clone https://github.com/augment-ai/security-auditor
cd security-auditor
pip install -e .

# Verify installation
security-auditor --version

Authentication

Configure your cloud provider credentials and Augment API key:

Authentication Setupbash

# Set Augment API key
export AUGMENT_API_KEY=your_api_key_here

# Configure AWS credentials
aws configure

# Configure Azure CLI
az login

# Configure GCP credentials
gcloud auth application-default login

# Verify authentication
security-auditor auth verify

Quick Start

Run your first security audit in minutes and identify critical vulnerabilities across your infrastructure.

1. Initialize Security Profile

Profile Setupbash

# Create security profile for your organization
security-auditor init --profile production

# Configure scanning scope
security-auditor config --scope aws,azure,gcp
security-auditor config --compliance soc2,iso27001

# This creates .security-auditor.yaml config file

2. Run Infrastructure Scan

Infrastructure Auditbash

# Scan all cloud resources
security-auditor scan --type infrastructure

# Scan specific cloud provider
security-auditor scan --provider aws --region us-east-1

# Quick security assessment
security-auditor scan --quick --critical-only

3. Generate Security Report

Security Reportsbash

# Generate comprehensive security report
security-auditor report --format html --output security-report.html

# Export findings as JSON
security-auditor report --format json --output findings.json

# Generate compliance report
security-auditor report --compliance soc2 --output compliance-report.pdf

Configuration

Configure AI SecurityAuditor to match your organization's security policies and compliance requirements.

Basic Configuration

.security-auditor.yamlyaml

version: "1.0"
organization: "your-company"
environment: "production"

scanning:
  providers:
    - aws
    - azure
    - gcp
  regions:
    - us-east-1
    - us-west-2
    - eu-west-1
  
compliance:
  standards:
    - soc2
    - iso27001
    - gdpr
  
security_policies:
  encryption:
    enforce: true
    algorithms: ["AES-256", "RSA-2048"]
  access_control:
    mfa_required: true
    privileged_access_review: true
  network:
    public_access_restricted: true
    security_groups_strict: true

Security Policies

Define custom security policies and rules that align with your organization's security requirements.

Custom Security Policiesyaml

policies:
  - name: "Critical Asset Protection"
    description: "Ensure critical assets have proper protection"
    rules:
      - resource_type: "database"
        encryption: "required"
        backup: "daily"
        monitoring: "enabled"
      
  - name: "Network Security"
    description: "Network security best practices"
    rules:
      - resource_type: "load_balancer"
        ssl_termination: "required"
        security_headers: "enabled"
      
  - name: "Identity and Access"
    description: "IAM security requirements"
    rules:
      - resource_type: "user"
        mfa: "required"
        password_policy: "strict"
        inactive_days_max: 90

Environment Variables

Configure AI SecurityAuditor behavior using environment variables for different deployment scenarios.

Variable	Description	Default
AUGMENT_API_KEY	Your Augment API key	Required
SECURITY_AUDITOR_CONFIG	Path to configuration file	.security-auditor.yaml
SECURITY_AUDITOR_LOG_LEVEL	Logging level (debug/info/warn/error)	info

Basic Usage

Learn the fundamental scanning patterns and security assessment workflows.

Scanning Commands

Security Scanningbash

# Full infrastructure scan
security-auditor scan --type infrastructure

# Application security scan
security-auditor scan --type application --path ./src

# Container security scan
security-auditor scan --type container --image nginx:latest

# Network security assessment
security-auditor scan --type network --target 10.0.0.0/8

CLI Commands Reference

Complete reference for all security auditing commands and options.

scan

Run security analysis on infrastructure, applications, or containers

security-auditor scan [options]

Options:
  --type <type>           Scan type (infrastructure|application|container|network)
  --provider <provider>   Cloud provider (aws|azure|gcp)
  --region <region>       Target region for scanning
  --output <file>         Output file path
  --format <format>       Output format (json|html|csv|pdf)
  --compliance <std>      Compliance standard to check against
  --severity <levels>     Severity levels to report
  --critical-only         Show only critical findings
  --remediation           Include remediation suggestions

Best Practices

Security scanning best practices to maximize threat detection and minimize false positives.

Security Scanning Strategy

Schedule daily automated scans for critical infrastructure
Run immediate scans after infrastructure changes
Focus on high and critical severity findings first
Implement security policies as code
Track remediation progress with compliance reports

CI/CD Integration

Integrate security scanning into your DevOps pipeline for continuous security assessment.

GitHub Actions

.github/workflows/security-audit.ymlyaml

name: Security Audit

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main]
  schedule:
    - cron: '0 2 * * *'  # Daily at 2 AM

jobs:
  security-audit:
    runs-on: ubuntu-latest
    
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      
      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.9'
      
      - name: Install Security Auditor
        run: pip install augment-security-auditor
      
      - name: Run Security Scan
        env:
          AUGMENT_API_KEY: ${{ secrets.AUGMENT_API_KEY }}
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        run: |
          security-auditor scan --type infrastructure --critical-only
          security-auditor scan --type application --path .
      
      - name: Upload Security Report
        uses: actions/upload-artifact@v3
        with:
          name: security-report
          path: security-report.html

Compliance Reports

Generate comprehensive compliance reports for various security standards and regulations.

Supported Standards

SOC 2

Type I & II

ISO 27001

Full Controls

GDPR

Privacy Controls

HIPAA

Healthcare Security

PCI DSS

Payment Security

NIST

Cybersecurity Framework

API Integration

Integrate AI SecurityAuditor into your security operations center (SOC) and monitoring systems.

REST API

API Usagebash

# Trigger security scan via API
curl -X POST https://api.augment.cfd/v1/security/scan \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scan_type": "infrastructure",
    "target": {
      "provider": "aws",
      "region": "us-east-1"
    },
    "options": {
      "compliance": ["soc2", "iso27001"],
      "severity": "high"
    }
  }'

Python SDK

Python Integrationpython

from augment_security import SecurityAuditor

# Initialize security auditor
auditor = SecurityAuditor(api_key=os.environ['AUGMENT_API_KEY'])

# Run infrastructure scan
scan_result = await auditor.scan_infrastructure(
    provider='aws',
    region='us-east-1',
    compliance=['soc2', 'iso27001']
)

# Get critical findings
critical_findings = scan_result.get_findings(severity='critical')
print(f"Found {len(critical_findings)} critical security issues")

# Generate compliance report
compliance_report = await auditor.generate_compliance_report(
    standard='soc2',
    format='pdf'
)

API Reference

Complete API documentation for integrating security scanning into your applications and workflows.

Security Scan Endpoint

POST /v1/security/scan

Initiate a comprehensive security scan of your infrastructure.

Request Body:

{
  "scan_type": "infrastructure|application|container|network",
  "target": {
    "provider": "aws|azure|gcp",
    "region": "us-east-1",
    "resource_ids": ["resource-123", "resource-456"]
  },
  "options": {
    "compliance": ["soc2", "iso27001", "gdpr"],
    "severity": "low|medium|high|critical",
    "policies": ["custom-policy-1", "custom-policy-2"]
  }
}

Response:

{
  "scan_id": "scan-789",
  "status": "completed",
  "summary": {
    "total_resources": 156,
    "total_findings": 23,
    "critical_findings": 3,
    "high_findings": 8,
    "medium_findings": 12
  },
  "compliance_score": {
    "soc2": 94.5,
    "iso27001": 91.2
  },
  "findings": [
    {
      "id": "finding-001",
      "severity": "critical",
      "category": "access_control",
      "resource_id": "sg-123456",
      "title": "Security group allows unrestricted access",
      "description": "Security group allows inbound traffic from 0.0.0.0/0",
      "remediation": "Restrict security group rules to specific IP ranges",
      "compliance_impact": ["soc2:CC6.1", "iso27001:A.13.1.3"]
    }
  ]
}

Troubleshooting

Common issues and solutions when running security audits.

Common Issues

Permission Denied

Error: Insufficient permissions to scan cloud resources

Solutions:

Verify cloud provider credentials are configured correctly
Ensure IAM roles have necessary read permissions
Check if MFA is required for your account
Review and update service account permissions

Scan Timeout

Security scan taking too long or timing out

Solutions:

Reduce scan scope by targeting specific regions
Use resource filters to limit scan scope
Increase timeout values in configuration
Run scans in smaller batches

False Positives

Too many false positive security findings

Solutions:

Configure custom security policies
Use exemption rules for known safe configurations
Adjust severity thresholds
Provide context through resource tagging

Security Documentation Complete!

Ready to enhance your security posture? Start your free security assessment today and discover vulnerabilities before attackers do.

AI SecurityAuditor

AI Threat Detection

Risk Scoring

Multi-Cloud Security

Compliance Ready

Installation

System Requirements

Install via Package Manager

Authentication

Quick Start

1. Initialize Security Profile

2. Run Infrastructure Scan

3. Generate Security Report

Configuration

Basic Configuration

Security Policies

Environment Variables

Basic Usage

Scanning Commands

CLI Commands Reference

scan

Best Practices

Security Scanning Strategy

CI/CD Integration

GitHub Actions

Compliance Reports

Supported Standards

API Integration

REST API

Python SDK

API Reference

Security Scan Endpoint

POST /v1/security/scan

Request Body:

Response:

Troubleshooting

Common Issues

Permission Denied

Scan Timeout

False Positives

Security Documentation Complete!

AI SecurityAuditor

AI Threat Detection

Risk Scoring

Multi-Cloud Security

Compliance Ready

Installation

System Requirements

Install via Package Manager

Authentication

Quick Start

1. Initialize Security Profile

2. Run Infrastructure Scan

3. Generate Security Report

Configuration

Basic Configuration

Security Policies

Environment Variables

Basic Usage

Scanning Commands

CLI Commands Reference

scan

Best Practices

Security Scanning Strategy

CI/CD Integration

GitHub Actions

Compliance Reports

Supported Standards

API Integration

REST API

Python SDK

API Reference

Security Scan Endpoint

POST /v1/security/scan

Request Body:

Response:

Troubleshooting

Common Issues

Permission Denied

Scan Timeout