How apdoescoding18/phishshield works
PhishShield is a backend portal for submitting email messages for phishing and attachment analysis, then retrieving job status, parsed artifacts, findings, and a risk verdict. The documented workflow is upload → asynchronous analysis → results; the excerpts show parsing, four analyzer types, and risk scoring. The orchestrator owns those analysis calls and persistence. Source-index references identify additional models and modules, but unsampled behavior is not inferred beyond those references.
Main entry points: orchestrator.py Analysis orchestrator · analyses.py Analysis API · database.py Database sessions · analyzer.py Analyzer contracts
Components 17
Submission and API
- Analysis API
backend/app/api/v1/endpoints/analyses.py - Secure upload
backend/app/services/upload.py
Email Analysis
- Email parser
backend/app/services/parser.py - Auth analyzer
backend/app/services/analyzers/auth_analyzer.py - Content analyzer
backend/app/services/analyzers/content_analyzer.py - URL analyzer
backend/app/services/analyzers/url_analyzer.py - Attachment analyzer
backend/app/services/analyzers/attachment_analyzer.py - Analyzer contracts
backend/app/schemas/analyzer.py
Findings and Results
- Risk engine
backend/app/services/risk_engine.py - Analysis findings
backend/app/models/finding.py - Risk result
backend/app/models/risk.py
Runtime and Storage
- Analysis orchestrator
backend/app/workers/orchestrator.py - Jobs and artifacts
backend/app/models/analysis.py - Audit events
backend/app/models/audit.py - Database sessions
backend/app/core/database.py
Other components
- Email submitter
- Task broker
Connections 26
- Email submitter → Analysis API: submits email
backend/app/api/v1/endpoints/analyses.py - Analysis API → Secure upload: stores upload
backend/app/api/v1/endpoints/analyses.py - Analysis API → Analysis orchestrator: enqueues job
backend/app/api/v1/endpoints/analyses.py - Analysis API → Jobs and artifacts: reads job data
backend/app/api/v1/endpoints/analyses.py - Analysis API → Analysis findings: reads findings
backend/app/api/v1/endpoints/analyses.py - Analysis API → Risk result: reads verdict
backend/app/api/v1/endpoints/analyses.py - Analysis API → Task broker: dispatches task
backend/app/api/v1/endpoints/analyses.py - Analysis orchestrator → Jobs and artifacts: loads and updates
backend/app/workers/orchestrator.py - Analysis orchestrator → Email parser: parses email
backend/app/workers/orchestrator.py - Analysis orchestrator → Auth analyzer: runs analyzer
backend/app/workers/orchestrator.py - Analysis orchestrator → Content analyzer: runs analyzer
backend/app/workers/orchestrator.py - Analysis orchestrator → URL analyzer: runs analyzer
backend/app/workers/orchestrator.py - Analysis orchestrator → Attachment analyzer: runs analyzer
backend/app/workers/orchestrator.py - Analysis orchestrator → Analysis findings: persists findings
backend/app/workers/orchestrator.py - Analysis orchestrator → Risk engine: scores findings
backend/app/workers/orchestrator.py - Risk engine → Risk result: persists score
backend/app/services/risk_engine.py - Email parser → Jobs and artifacts: stores parsed artifacts
backend/app/services/parser.py - Auth analyzer → Analyzer contracts: uses result schemas
backend/app/services/analyzers/auth_analyzer.py - Content analyzer → Analyzer contracts: uses result schemas
backend/app/services/analyzers/content_analyzer.py - URL analyzer → Analyzer contracts: uses result schemas
backend/app/services/analyzers/url_analyzer.py - Attachment analyzer → Analyzer contracts: uses result schemas
backend/app/services/analyzers/attachment_analyzer.py - Database sessions → Jobs and artifacts: provides ORM base
backend/app/models/analysis.py - Database sessions → Analysis findings: provides ORM base
backend/app/models/finding.py - Database sessions → Risk result: provides ORM base
backend/app/models/risk.py - Database sessions → Audit events: provides ORM base
backend/app/models/audit.py - Secure upload → Audit events: records upload event
backend/app/services/upload.py