Phillip Tarrant
986c0d3d17
Implement complete database schema and Flask application structure for SneakyScan web interface. This establishes the foundation for web-based scan management, scheduling, and visualization. Database & ORM: - Add 11 SQLAlchemy models for comprehensive scan data storage (Scan, ScanSite, ScanIP, ScanPort, ScanService, ScanCertificate, ScanTLSVersion, Schedule, Alert, AlertRule, Setting) - Configure Alembic migrations system with initial schema migration - Add init_db.py script for database initialization and password setup - Support both migration-based and direct table creation Settings System: - Implement SettingsManager with automatic encryption for sensitive values - Add Fernet encryption for SMTP passwords and API tokens - Implement PasswordManager with bcrypt password hashing (work factor 12) - Initialize default settings for SMTP, authentication, and retention Flask Application: - Create Flask app factory pattern with scoped session management - Add 4 API blueprints: scans, schedules, alerts, settings - Implement functional Settings API (GET/PUT/DELETE endpoints) - Add CORS support, error handlers, and request/response logging - Configure development and production logging to file and console Docker & Deployment: - Update Dockerfile to install Flask dependencies - Add docker-compose-web.yml for web application deployment - Configure volume mounts for database, output, and logs persistence - Expose port 5000 for Flask web server Testing & Validation: - Add validate_phase1.py script to verify all deliverables - Validate directory structure, Python syntax, models, and endpoints - All validation checks passing Documentation: - Add PHASE1_COMPLETE.md with comprehensive Phase 1 summary - Update ROADMAP.md with Phase 1 completion status - Update .gitignore to exclude database files and documentation Files changed: 21 files - New: web/ directory with complete Flask app structure - New: migrations/ with Alembic configuration - New: requirements-web.txt with Flask dependencies - Modified: Dockerfile, ROADMAP.md, .gitignore
138 lines
3.2 KiB
Python
138 lines
3.2 KiB
Python
"""
|
|
Alerts API blueprint.
|
|
|
|
Handles endpoints for viewing alert history and managing alert rules.
|
|
"""
|
|
|
|
from flask import Blueprint, jsonify, request
|
|
|
|
bp = Blueprint('alerts', __name__)
|
|
|
|
|
|
@bp.route('', methods=['GET'])
|
|
def list_alerts():
|
|
"""
|
|
List recent alerts.
|
|
|
|
Query params:
|
|
page: Page number (default: 1)
|
|
per_page: Items per page (default: 20)
|
|
alert_type: Filter by alert type
|
|
severity: Filter by severity (info, warning, critical)
|
|
start_date: Filter alerts after this date
|
|
end_date: Filter alerts before this date
|
|
|
|
Returns:
|
|
JSON response with alerts list
|
|
"""
|
|
# TODO: Implement in Phase 4
|
|
return jsonify({
|
|
'alerts': [],
|
|
'total': 0,
|
|
'page': 1,
|
|
'per_page': 20,
|
|
'message': 'Alerts list endpoint - to be implemented in Phase 4'
|
|
})
|
|
|
|
|
|
@bp.route('/rules', methods=['GET'])
|
|
def list_alert_rules():
|
|
"""
|
|
List all alert rules.
|
|
|
|
Returns:
|
|
JSON response with alert rules
|
|
"""
|
|
# TODO: Implement in Phase 4
|
|
return jsonify({
|
|
'rules': [],
|
|
'message': 'Alert rules list endpoint - to be implemented in Phase 4'
|
|
})
|
|
|
|
|
|
@bp.route('/rules', methods=['POST'])
|
|
def create_alert_rule():
|
|
"""
|
|
Create a new alert rule.
|
|
|
|
Request body:
|
|
rule_type: Type of alert rule
|
|
threshold: Threshold value (e.g., days for cert expiry)
|
|
enabled: Whether rule is active (default: true)
|
|
email_enabled: Send email for this rule (default: false)
|
|
|
|
Returns:
|
|
JSON response with created rule ID
|
|
"""
|
|
# TODO: Implement in Phase 4
|
|
data = request.get_json() or {}
|
|
|
|
return jsonify({
|
|
'rule_id': None,
|
|
'status': 'not_implemented',
|
|
'message': 'Alert rule creation endpoint - to be implemented in Phase 4',
|
|
'data': data
|
|
}), 501
|
|
|
|
|
|
@bp.route('/rules/<int:rule_id>', methods=['PUT'])
|
|
def update_alert_rule(rule_id):
|
|
"""
|
|
Update an existing alert rule.
|
|
|
|
Args:
|
|
rule_id: Alert rule ID to update
|
|
|
|
Request body:
|
|
threshold: Threshold value (optional)
|
|
enabled: Whether rule is active (optional)
|
|
email_enabled: Send email for this rule (optional)
|
|
|
|
Returns:
|
|
JSON response with update status
|
|
"""
|
|
# TODO: Implement in Phase 4
|
|
data = request.get_json() or {}
|
|
|
|
return jsonify({
|
|
'rule_id': rule_id,
|
|
'status': 'not_implemented',
|
|
'message': 'Alert rule update endpoint - to be implemented in Phase 4',
|
|
'data': data
|
|
}), 501
|
|
|
|
|
|
@bp.route('/rules/<int:rule_id>', methods=['DELETE'])
|
|
def delete_alert_rule(rule_id):
|
|
"""
|
|
Delete an alert rule.
|
|
|
|
Args:
|
|
rule_id: Alert rule ID to delete
|
|
|
|
Returns:
|
|
JSON response with deletion status
|
|
"""
|
|
# TODO: Implement in Phase 4
|
|
return jsonify({
|
|
'rule_id': rule_id,
|
|
'status': 'not_implemented',
|
|
'message': 'Alert rule deletion endpoint - to be implemented in Phase 4'
|
|
}), 501
|
|
|
|
|
|
# Health check endpoint
|
|
@bp.route('/health', methods=['GET'])
|
|
def health_check():
|
|
"""
|
|
Health check endpoint for monitoring.
|
|
|
|
Returns:
|
|
JSON response with API health status
|
|
"""
|
|
return jsonify({
|
|
'status': 'healthy',
|
|
'api': 'alerts',
|
|
'version': '1.0.0-phase1'
|
|
})
|