Files
Aegis/backend/app/services/webhook_email_service.py
T
kitos f13764d9e2
Aegis CI / lint-and-test (push) Has been cancelled
Snyk Security Scan / Python vulnerabilities (backend) (push) Has been cancelled
Snyk Security Scan / npm vulnerabilities (frontend) (push) Has been cancelled
Snyk Security Scan / Docker image vulnerabilities (backend) (push) Has been cancelled
fix(email): detect and surface webhook send failures instead of claiming success
send_webhook_email() only returned False on a network exception — a
webhook that responded with a non-2xx status (bad URL, wrong API key,
misconfigured Power Automate flow) was still reported as delivered. Now
checks response.ok and returns False on rejection too.

send_password_setup_email() also never checked the return value at all,
so the admin's 'Send Email' action (including resending a password-reset
email after the user already set their password) always showed success
even when nothing was actually sent. Now raises a clear error instead.
2026-07-24 16:45:32 +02:00

194 lines
7.5 KiB
Python

"""Generic outbound-email sender — POSTs to an admin-configured webhook.
Replaces the old SMTP-based email system. Every notification email in the
platform (password setup/reset, test validated, campaign completed, new
MITRE techniques synced, etc.) goes through ``send_webhook_email`` here,
which POSTs a ``{to, subject, body}`` JSON payload to a single configured
webhook URL — intended for a Power Automate flow that actually delivers
the email (the ``body`` is full HTML; the flow's "send email" step must
have its "Is HTML" option enabled). An optional API key, if configured,
is sent as an ``x-api-key`` header.
SMTP (``app.services.email_service``) is intentionally left in place but
unused and unreachable from the UI — see that module's docstring.
"""
from __future__ import annotations
import base64
import html as html_lib
import logging
import re
from pathlib import Path
import requests
from sqlalchemy.orm import Session
logger = logging.getLogger(__name__)
_WEBHOOK_URL_CONFIG_KEY = "email_webhook.url"
_WEBHOOK_API_KEY_CONFIG_KEY = "email_webhook.api_key"
_LOGO_PATH = Path(__file__).resolve().parent.parent / "assets" / "email_logo.png"
_URL_RE = re.compile(r"^https?://\S+$")
_logo_b64_cache: str | None = None
def _get_logo_base64() -> str:
"""Read + cache the inline email logo as a base64 string (empty if missing)."""
global _logo_b64_cache
if _logo_b64_cache is None:
try:
_logo_b64_cache = base64.b64encode(_LOGO_PATH.read_bytes()).decode("ascii")
except OSError:
logger.warning("Email logo asset missing at %s", _LOGO_PATH)
_logo_b64_cache = ""
return _logo_b64_cache
def _message_to_html(message: str) -> str:
"""Turn a plain-text message (paragraphs separated by blank lines) into
escaped HTML, rendering any lone-URL paragraph as a call-to-action button.
"""
parts: list[str] = []
for para in message.strip().split("\n\n"):
para = para.strip()
if not para:
continue
if _URL_RE.match(para):
url = html_lib.escape(para, quote=True)
parts.append(
f'<p style="margin:0 0 20px;">'
f'<a href="{url}" style="display:inline-block;background-color:#0891b2;'
f'color:#ffffff;text-decoration:none;padding:12px 24px;border-radius:6px;'
f'font-weight:600;font-size:14px;">Open Link &rarr;</a>'
f'</p>'
)
else:
escaped = html_lib.escape(para).replace("\n", "<br>")
parts.append(f'<p style="margin:0 0 16px;">{escaped}</p>')
return "".join(parts)
def build_email_body(full_name: str | None, message: str) -> str:
"""Wrap *message* in Aegis's branded HTML email template (inline logo)."""
greeting = html_lib.escape(full_name) if full_name else "there"
message_html = _message_to_html(message)
logo_b64 = _get_logo_base64()
logo_tag = (
f'<img src="data:image/png;base64,{logo_b64}" width="56" height="57" alt="Aegis" '
f'style="display:block;margin:0 auto 10px;border:0;" />'
if logo_b64
else ""
)
return f"""<!DOCTYPE html>
<html>
<body style="margin:0;padding:0;background-color:#0b0f19;">
<table role="presentation" width="100%" cellpadding="0" cellspacing="0" style="background-color:#0b0f19;padding:32px 0;">
<tr>
<td align="center">
<table role="presentation" width="560" cellpadding="0" cellspacing="0" style="max-width:560px;width:100%;background-color:#111827;border-radius:12px;overflow:hidden;border:1px solid #1f2937;">
<tr>
<td style="background-color:#0e7490;background-image:linear-gradient(135deg,#0e7490,#0891b2);padding:28px 32px;text-align:center;">
{logo_tag}
<div style="color:#ffffff;font-size:20px;font-weight:600;letter-spacing:0.5px;">AEGIS SECURITY PLATFORM</div>
<div style="color:#cffafe;font-size:11px;letter-spacing:2px;text-transform:uppercase;margin-top:4px;">Purple Team Engineering</div>
</td>
</tr>
<tr>
<td style="padding:32px;">
<p style="color:#e5e7eb;font-size:16px;margin:0 0 16px;">Hi {greeting},</p>
<div style="color:#d1d5db;font-size:14px;line-height:1.6;">{message_html}</div>
</td>
</tr>
<tr>
<td style="padding:20px 32px;background-color:#0b0f19;border-top:1px solid #1f2937;">
<p style="color:#67e8f9;font-size:12px;margin:0 0 8px;font-style:italic;">Assume breach. Validate controls. Improve continuously.</p>
<p style="color:#4b5563;font-size:11px;margin:0;">Owned and operated by Enterprise Corp. This is an automated notification &mdash; please do not reply.</p>
</td>
</tr>
</table>
</td>
</tr>
</table>
</body>
</html>"""
def _read_system_config(db: Session, key: str) -> str | None:
from app.models.system_config import SystemConfig # avoid circular at import time
row = db.query(SystemConfig).filter(SystemConfig.key == key).first()
return row.value if row else None
def _write_system_config(db: Session, key: str, value: str) -> None:
from app.models.system_config import SystemConfig
row = db.query(SystemConfig).filter(SystemConfig.key == key).first()
if row:
row.value = value
else:
db.add(SystemConfig(key=key, value=value))
def get_webhook_url(db: Session) -> str | None:
"""Return the configured Power-Automate-style webhook URL, or None."""
return _read_system_config(db, _WEBHOOK_URL_CONFIG_KEY) or None
def set_webhook_url(db: Session, url: str) -> None:
"""Persist the webhook URL. Does not commit; caller commits."""
_write_system_config(db, _WEBHOOK_URL_CONFIG_KEY, url)
def get_webhook_api_key(db: Session) -> str | None:
"""Return the configured webhook API key, or None."""
return _read_system_config(db, _WEBHOOK_API_KEY_CONFIG_KEY) or None
def set_webhook_api_key(db: Session, api_key: str) -> None:
"""Persist the webhook API key. Does not commit; caller commits."""
_write_system_config(db, _WEBHOOK_API_KEY_CONFIG_KEY, api_key)
def send_webhook_email(
db: Session, *, to: str | None, subject: str, message: str, full_name: str | None = None,
) -> bool:
"""POST a notification email to the configured webhook.
Best-effort: returns False (and logs a warning) if no webhook is
configured, *to* is empty, the request fails, or the webhook responds
with a non-2xx status — never raises, since a webhook outage must not
break whatever triggered the notification.
"""
if not to:
return False
webhook_url = get_webhook_url(db)
if not webhook_url:
logger.warning("Email webhook is not configured — dropping email to %s", to)
return False
api_key = get_webhook_api_key(db)
headers = {"x-api-key": api_key} if api_key else {}
try:
response = requests.post(
webhook_url,
json={"to": to, "subject": subject, "body": build_email_body(full_name, message)},
headers=headers,
timeout=10,
)
if not response.ok:
logger.warning(
"Email webhook rejected the request for %s: HTTP %d%s",
to, response.status_code, response.text[:500],
)
return False
return True
except requests.RequestException:
logger.warning("Email webhook call failed for %s", to, exc_info=True)
return False