5e8b1f033f
- Created main documentation index and user guide with sections on getting started, dashboard overview, managing domains, and reports. - Added detailed deployment guide for Docker and manual installation. - Included user-friendly explanations of DMARC, its benefits, and how to manage domains and reports. - Implemented visual assets for dashboard, domains, IMAP, and reports. - Established requirements for documentation build using MkDocs and Material theme. - Integrated navigation structure for easy access to all documentation sections.
214 lines
6.4 KiB
Python
214 lines
6.4 KiB
Python
from typing import Dict, List, Any
|
|
from fastapi import APIRouter, File, HTTPException, UploadFile, status
|
|
from pydantic import BaseModel
|
|
|
|
from app.services.dmarc_parser import DMARCParser
|
|
from app.services.report_store import ReportStore
|
|
|
|
router = APIRouter()
|
|
|
|
class UploadResponse(BaseModel):
|
|
"""Response model for report upload"""
|
|
success: bool
|
|
domain: str
|
|
message: str
|
|
processed_records: int = 0 # Added this field to track processed records
|
|
|
|
class DomainSummary(BaseModel):
|
|
"""Domain summary response model"""
|
|
domain: str
|
|
total_count: int
|
|
passed_count: int
|
|
failed_count: int
|
|
reports_processed: int
|
|
compliance_rate: float
|
|
|
|
class ReportSummary(BaseModel):
|
|
"""DMARC report summary model"""
|
|
report_id: str
|
|
org_name: str
|
|
begin_date: str
|
|
end_date: str
|
|
total_count: int
|
|
passed_count: int
|
|
failed_count: int
|
|
|
|
class PaginatedReportResponse(BaseModel):
|
|
"""Paginated reports response model"""
|
|
total: int
|
|
page: int
|
|
page_size: int
|
|
total_pages: int
|
|
reports: List[ReportSummary]
|
|
|
|
@router.post("/upload", response_model=UploadResponse)
|
|
async def upload_report(file: UploadFile = File(...)):
|
|
"""
|
|
Upload and process a DMARC aggregate report file (XML, ZIP, or GZIP)
|
|
"""
|
|
try:
|
|
# Read the file content
|
|
file_content = await file.read()
|
|
filename = file.filename
|
|
|
|
# Parse the report
|
|
parser = DMARCParser()
|
|
report = parser.parse_file(file_content, filename)
|
|
|
|
# Store the report
|
|
store = ReportStore.get_instance()
|
|
store.add_report(report)
|
|
|
|
domain = report.get("domain", "unknown")
|
|
processed_records = report.get("summary", {}).get("total_count", 0)
|
|
|
|
return UploadResponse(
|
|
success=True,
|
|
domain=domain,
|
|
message=f"Report processed successfully for domain {domain}",
|
|
processed_records=processed_records
|
|
)
|
|
|
|
except Exception as e:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_400_BAD_REQUEST,
|
|
detail=f"Error processing report: {str(e)}"
|
|
)
|
|
|
|
@router.get("/domains", response_model=List[str])
|
|
async def get_domains():
|
|
"""
|
|
Get list of all domains with reports
|
|
"""
|
|
store = ReportStore.get_instance()
|
|
return store.get_domains()
|
|
|
|
@router.get("/domain/{domain}/summary", response_model=DomainSummary)
|
|
async def get_domain_summary(domain: str):
|
|
"""
|
|
Get summary statistics for a specific domain
|
|
"""
|
|
store = ReportStore.get_instance()
|
|
summary = store.get_domain_summary(domain)
|
|
|
|
if not summary:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_404_NOT_FOUND,
|
|
detail=f"No reports found for domain {domain}"
|
|
)
|
|
|
|
return DomainSummary(
|
|
domain=domain,
|
|
**summary
|
|
)
|
|
|
|
@router.get("/summary", response_model=List[DomainSummary])
|
|
async def get_all_summaries():
|
|
"""
|
|
Get summary statistics for all domains
|
|
"""
|
|
store = ReportStore.get_instance()
|
|
all_summaries = store.get_all_domain_summaries()
|
|
|
|
return [
|
|
DomainSummary(domain=domain, **summary)
|
|
for domain, summary in all_summaries.items()
|
|
]
|
|
|
|
@router.get("/domain/{domain}/reports", response_model=List[ReportSummary])
|
|
async def get_domain_reports(domain: str):
|
|
"""
|
|
Get all reports for a specific domain
|
|
"""
|
|
store = ReportStore.get_instance()
|
|
reports = store.get_domain_reports(domain)
|
|
|
|
if not reports:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_404_NOT_FOUND,
|
|
detail=f"No reports found for domain {domain}"
|
|
)
|
|
|
|
return [
|
|
ReportSummary(
|
|
report_id=report.get("report_id", ""),
|
|
org_name=report.get("org_name", ""),
|
|
begin_date=report.get("begin_date", ""),
|
|
end_date=report.get("end_date", ""),
|
|
total_count=report.get("summary", {}).get("total_count", 0),
|
|
passed_count=report.get("summary", {}).get("passed_count", 0),
|
|
failed_count=report.get("summary", {}).get("failed_count", 0)
|
|
)
|
|
for report in reports
|
|
]
|
|
|
|
@router.get("/domain/{domain}/reports/paginated", response_model=PaginatedReportResponse)
|
|
async def get_domain_reports_paginated(
|
|
domain: str,
|
|
page: int = 1,
|
|
page_size: int = 10,
|
|
sort_by: str = "end_date",
|
|
sort_order: str = "desc"
|
|
):
|
|
"""
|
|
Get paginated reports for a specific domain with sorting options
|
|
|
|
Args:
|
|
domain: Domain name
|
|
page: Page number (1-based)
|
|
page_size: Number of reports per page
|
|
sort_by: Field to sort by (report_id, org_name, begin_date, end_date, total_count)
|
|
sort_order: Sort order (asc or desc)
|
|
"""
|
|
store = ReportStore.get_instance()
|
|
all_reports = store.get_domain_reports(domain)
|
|
|
|
if not all_reports:
|
|
raise HTTPException(
|
|
status_code=status.HTTP_404_NOT_FOUND,
|
|
detail=f"No reports found for domain {domain}"
|
|
)
|
|
|
|
# Apply sorting
|
|
valid_sort_fields = ["report_id", "org_name", "begin_date", "end_date", "total_count"]
|
|
sort_field = sort_by if sort_by in valid_sort_fields else "end_date"
|
|
|
|
if sort_field == "total_count":
|
|
all_reports.sort(
|
|
key=lambda r: r.get("summary", {}).get("total_count", 0),
|
|
reverse=(sort_order == "desc")
|
|
)
|
|
else:
|
|
all_reports.sort(
|
|
key=lambda r: r.get(sort_field, ""),
|
|
reverse=(sort_order == "desc")
|
|
)
|
|
|
|
# Apply pagination
|
|
total = len(all_reports)
|
|
total_pages = (total + page_size - 1) // page_size
|
|
start_idx = (page - 1) * page_size
|
|
end_idx = start_idx + page_size
|
|
paginated_reports = all_reports[start_idx:end_idx]
|
|
|
|
# Format reports
|
|
report_entries = [
|
|
ReportSummary(
|
|
report_id=report.get("report_id", ""),
|
|
org_name=report.get("org_name", ""),
|
|
begin_date=report.get("begin_date", ""),
|
|
end_date=report.get("end_date", ""),
|
|
total_count=report.get("summary", {}).get("total_count", 0),
|
|
passed_count=report.get("summary", {}).get("passed_count", 0),
|
|
failed_count=report.get("summary", {}).get("failed_count", 0)
|
|
)
|
|
for report in paginated_reports
|
|
]
|
|
|
|
return PaginatedReportResponse(
|
|
total=total,
|
|
page=page,
|
|
page_size=page_size,
|
|
total_pages=total_pages,
|
|
reports=report_entries
|
|
) |