feat(email): generic webhook for all notification emails, hide SMTP UI
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
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
- Renamed the password-setup webhook (email_webhook.*, /system/email-webhook-config) and made it the single transport for all notification emails. - New webhook_email_service.py shared by password_setup_service and notification_service. - Wired test validated/rejected, campaign completed, and new-MITRE-technique notifications through the webhook (previously dead SMTP code, never triggered). - Added POST /system/email-webhook-test to send a real test email. - Hid the Email/SMTP settings tab from the UI (SMTP code kept intact, unused). - Redact email_webhook.api_key on config export.
This commit is contained in:
@@ -755,6 +755,15 @@ def complete_campaign(db: Session, campaign_id: str) -> Campaign:
|
||||
campaign.completed_at = datetime.utcnow()
|
||||
# Flush changes to DB without committing the transaction
|
||||
db.flush()
|
||||
|
||||
from app.services.notification_service import notify_user_by_email
|
||||
notify_user_by_email(
|
||||
db, campaign.created_by,
|
||||
preference_key="email_on_campaign_completed",
|
||||
subject=f"Campaign Completed: {campaign.name}",
|
||||
message=f'Your campaign "{campaign.name}" has been completed.',
|
||||
)
|
||||
|
||||
# Return campaign
|
||||
return campaign
|
||||
|
||||
|
||||
@@ -391,5 +391,18 @@ def sync_mitre(db: Session) -> dict:
|
||||
# Commit all pending changes to the database
|
||||
db.commit()
|
||||
|
||||
if created > 0:
|
||||
from app.services.notification_service import notify_all_users_by_email
|
||||
|
||||
notify_all_users_by_email(
|
||||
db,
|
||||
preference_key="email_on_new_mitre_techniques",
|
||||
subject=f"MITRE ATT&CK Updated: {created} new techniques",
|
||||
message=(
|
||||
f"{created} new techniques were added and {updated} were "
|
||||
"updated in the MITRE ATT&CK catalog."
|
||||
),
|
||||
)
|
||||
|
||||
# Return summary
|
||||
return summary
|
||||
|
||||
@@ -245,6 +245,52 @@ def cleanup_old_notifications(db: Session, days: int = 90) -> int:
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def _preference_allows(user: User | None, preference_key: str) -> bool:
|
||||
"""True unless the user has explicitly turned *preference_key* off.
|
||||
|
||||
``notification_preferences`` may be ``None`` (older rows predating the
|
||||
column) or missing individual keys (newer preference toggles added
|
||||
after the DB default was set) — both cases default to "on".
|
||||
"""
|
||||
if user is None or not user.email:
|
||||
return False
|
||||
prefs = user.notification_preferences or {}
|
||||
return prefs.get(preference_key, True) is not False
|
||||
|
||||
|
||||
def notify_user_by_email(db: Session, user_id, *, preference_key: str, subject: str, message: str) -> None:
|
||||
"""Email a single user (by id) if their preferences allow it.
|
||||
|
||||
Best-effort — swallows lookup/send failures so a notification email
|
||||
never breaks whatever workflow step triggered it.
|
||||
"""
|
||||
if not user_id:
|
||||
return
|
||||
try:
|
||||
user = db.query(User).filter(User.id == user_id).first()
|
||||
if not _preference_allows(user, preference_key):
|
||||
return
|
||||
from app.services.webhook_email_service import send_webhook_email
|
||||
send_webhook_email(db, to=user.email, subject=subject, message=message, full_name=user.full_name)
|
||||
except Exception:
|
||||
pass # nosec B110 — email failures never crash the caller
|
||||
|
||||
|
||||
def notify_all_users_by_email(db: Session, *, preference_key: str, subject: str, message: str) -> None:
|
||||
"""Email every active, opted-in user — for platform-wide events
|
||||
(e.g. a MITRE ATT&CK sync) rather than a single actor's own action.
|
||||
"""
|
||||
users = db.query(User).filter(User.is_active == True, User.email.isnot(None)).all() # noqa: E712
|
||||
for user in users:
|
||||
if not _preference_allows(user, preference_key):
|
||||
continue
|
||||
try:
|
||||
from app.services.webhook_email_service import send_webhook_email
|
||||
send_webhook_email(db, to=user.email, subject=subject, message=message, full_name=user.full_name)
|
||||
except Exception:
|
||||
pass # nosec B110 — one user's failure must not skip the rest
|
||||
|
||||
|
||||
def notify_role_with_email(
|
||||
db: Session,
|
||||
*,
|
||||
@@ -387,6 +433,12 @@ def notify_test_state_change(db: Session, test, new_state: str) -> None:
|
||||
# Keyword argument: entity_id
|
||||
entity_id=test_id,
|
||||
)
|
||||
notify_user_by_email(
|
||||
db, creator_id,
|
||||
preference_key="email_on_test_rejected",
|
||||
subject=f"Test Rejected: {test_name}",
|
||||
message=f'Your test "{test_name}" has been rejected. Please review and resubmit.',
|
||||
)
|
||||
|
||||
# Alternative: new_state == "validated" and creator_id
|
||||
elif new_state == "validated" and creator_id:
|
||||
@@ -406,3 +458,9 @@ def notify_test_state_change(db: Session, test, new_state: str) -> None:
|
||||
# Keyword argument: entity_id
|
||||
entity_id=test_id,
|
||||
)
|
||||
notify_user_by_email(
|
||||
db, creator_id,
|
||||
preference_key="email_on_test_validated",
|
||||
subject=f"Test Validated: {test_name}",
|
||||
message=f'Your test "{test_name}" has been validated successfully.',
|
||||
)
|
||||
|
||||
@@ -2,88 +2,27 @@
|
||||
|
||||
An admin creates a user with just a name/email/role (see
|
||||
``user_service.create_user_without_password``). To let that user in, the
|
||||
admin clicks "Send Email": this service issues a one-time token and POSTs
|
||||
a payload carrying it to an admin-configured webhook URL (intended for a
|
||||
Power Automate flow that actually sends the email — the exact webhook
|
||||
contract is still being finalized, hence the configurable URL rather than
|
||||
a hardcoded integration). The same mechanism, and the same button, is
|
||||
admin clicks "Send Email": this service issues a one-time token and sends
|
||||
it via the shared ``webhook_email_service`` (POSTs to an admin-configured
|
||||
Power Automate webhook). The same mechanism, and the same button, is
|
||||
reused for password resets on existing users.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
import secrets
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
import requests
|
||||
from sqlalchemy.orm import Session
|
||||
|
||||
from app.config import settings
|
||||
from app.domain.errors import BusinessRuleViolation, EntityNotFoundError
|
||||
from app.models.password_setup_token import PasswordSetupToken
|
||||
from app.models.user import User
|
||||
from app.services.webhook_email_service import get_webhook_url, send_webhook_email
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
_WEBHOOK_URL_CONFIG_KEY = "password_setup.webhook_url"
|
||||
_WEBHOOK_API_KEY_CONFIG_KEY = "password_setup.webhook_api_key"
|
||||
_TOKEN_TTL = timedelta(hours=24)
|
||||
|
||||
# Standard footer appended to every Power-Automate-delivered notification
|
||||
# email, matching the platform's established template.
|
||||
_EMAIL_SIGNATURE = (
|
||||
"\n\nRegards,\n"
|
||||
"AEGIS Security Platform\n"
|
||||
"Purple Team Engineering\n"
|
||||
"Owned and operated by Enterprise Corp.\n\n"
|
||||
"Assume breach. Validate controls. Improve continuously.\n\n"
|
||||
"This is an automated notification. Please do not reply."
|
||||
)
|
||||
|
||||
|
||||
def _build_email_body(full_name: str | None, message: str) -> str:
|
||||
"""Wrap *message* in the standard greeting + signature template."""
|
||||
greeting = full_name or "there"
|
||||
return f"HI {greeting}\n\n{message}{_EMAIL_SIGNATURE}"
|
||||
|
||||
|
||||
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_password_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_password_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_password_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_password_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 create_setup_token(db: Session, user: User) -> PasswordSetupToken:
|
||||
"""Issue a fresh one-time token for *user*, invalidating any unused ones.
|
||||
@@ -106,16 +45,15 @@ def create_setup_token(db: Session, user: User) -> PasswordSetupToken:
|
||||
|
||||
|
||||
def send_password_setup_email(db: Session, user: User) -> None:
|
||||
"""Issue a token and POST it to the configured webhook.
|
||||
"""Issue a token and email it via the configured webhook.
|
||||
|
||||
Raises BusinessRuleViolation if no webhook URL is configured yet.
|
||||
Raises BusinessRuleViolation if no webhook is configured yet.
|
||||
Does not commit; caller commits (the token must be persisted even if
|
||||
the webhook call itself fails, so a fresh "Send Email" retry works).
|
||||
"""
|
||||
webhook_url = get_password_webhook_url(db)
|
||||
if not webhook_url:
|
||||
if not get_webhook_url(db):
|
||||
raise BusinessRuleViolation(
|
||||
"No password-setup webhook is configured yet — set one in Settings first."
|
||||
"No email webhook is configured yet — set one in Settings first."
|
||||
)
|
||||
|
||||
token = create_setup_token(db, user)
|
||||
@@ -127,25 +65,7 @@ def send_password_setup_email(db: Session, user: User) -> None:
|
||||
f"{set_password_url}\n\n"
|
||||
"This link expires in 24 hours and can only be used once."
|
||||
)
|
||||
|
||||
api_key = get_password_webhook_api_key(db)
|
||||
headers = {"x-api-key": api_key} if api_key else {}
|
||||
|
||||
try:
|
||||
requests.post(
|
||||
webhook_url,
|
||||
json={
|
||||
"to": user.email,
|
||||
"subject": subject,
|
||||
"body": _build_email_body(user.full_name, message),
|
||||
},
|
||||
headers=headers,
|
||||
timeout=10,
|
||||
)
|
||||
except requests.RequestException:
|
||||
# Best-effort: the token still exists, so the admin can retry
|
||||
# "Send Email" once the webhook endpoint is reachable again.
|
||||
logger.warning("Password-setup webhook call failed for user %s", user.id, exc_info=True)
|
||||
send_webhook_email(db, to=user.email, subject=subject, message=message, full_name=user.full_name)
|
||||
|
||||
|
||||
def _get_valid_token_or_raise(db: Session, token: str) -> PasswordSetupToken:
|
||||
|
||||
@@ -0,0 +1,112 @@
|
||||
"""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. 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 logging
|
||||
|
||||
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"
|
||||
|
||||
# Standard greeting + footer wrapped around every notification email's
|
||||
# actual message, matching the platform's established template.
|
||||
_EMAIL_SIGNATURE = (
|
||||
"\n\nRegards,\n"
|
||||
"AEGIS Security Platform\n"
|
||||
"Purple Team Engineering\n"
|
||||
"Owned and operated by Enterprise Corp.\n\n"
|
||||
"Assume breach. Validate controls. Improve continuously.\n\n"
|
||||
"This is an automated notification. Please do not reply."
|
||||
)
|
||||
|
||||
|
||||
def build_email_body(full_name: str | None, message: str) -> str:
|
||||
"""Wrap *message* in the standard greeting + signature template."""
|
||||
greeting = full_name or "there"
|
||||
return f"HI {greeting}\n\n{message}{_EMAIL_SIGNATURE}"
|
||||
|
||||
|
||||
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, or the request fails — 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:
|
||||
requests.post(
|
||||
webhook_url,
|
||||
json={"to": to, "subject": subject, "body": build_email_body(full_name, message)},
|
||||
headers=headers,
|
||||
timeout=10,
|
||||
)
|
||||
return True
|
||||
except requests.RequestException:
|
||||
logger.warning("Email webhook call failed for %s", to, exc_info=True)
|
||||
return False
|
||||
Reference in New Issue
Block a user