Skip to content

Security: fhalamzie/mail-archiver

Security

SECURITY.md

πŸ”’ Security Policy

The Mail-Archiver project takes security seriously. This document describes how to report security vulnerabilities and how they are handled.

πŸ“Œ Reporting a Vulnerability

If you believe you have found a security vulnerability in Mail-Archiver, please do not open a public GitHub issue. Instead, report it responsibly to:

πŸ“§ Email: mail@s1t5.dev

Information to include

To help us understand and reproduce the issue quickly, please provide as much of the following as possible:

  • Affected version or commit / branch (a release tag, or a Docker image tag)
  • Step-by-step instructions to reproduce the issue
  • A minimal proof of concept (if applicable)
  • The impact you believe the vulnerability has (e.g. data exposure, privilege escalation, DoS)
  • Any relevant logs, configuration snippets, or environment details (please redact secrets)

PGP-encrypted reports (optional)

You may encrypt your report using the maintainer's OpenPGP public key, available on keys.openpgp.org:

Response and disclosure

  • We will acknowledge your report on a best-effort basis and as quickly as we reasonably can. There is no guaranteed response time or SLA.
  • We treat all incoming vulnerability reports in confidence and coordinate a responsible disclosure of the issue β€” including credit to the reporter β€” once a fix is available.
  • Please do not publicly disclose the vulnerability before a coordinated release is published.

βœ… Supported Versions

Version / Branch Security Fixes
Latest release (tag) βœ… Supported
Older releases ❌ Not supported

🎯 Scope

In scope

  • Source code in this repository (the ASP.NET Core MVC app, EF Core migrations and helpers, background services, CLI import).
  • The provided docker-compose.yml.
  • Default values shipped in appsettings.json.

Out of scope

  • Vulnerabilities in upstream third-party dependencies (MailKit, Microsoft.Graph, Npgsql, EF Core, etc.). Please report those upstream to the respective maintainers.
  • Issues arising from insecure production deployments β€” e.g. a misconfigured reverse proxy, an exposed database port, weak OAuth client secrets, or a missing HTTPS termination. See the configuration guides under doc/ for hardening guidance.
  • Social engineering, physical attacks, or denial-of-service via sheer network volume against infrastructure we do not control.

πŸ” Secure Configuration

Security in Mail-Archiver depends strongly on how it is deployed. Please review the relevant guides before exposing the application publicly:

Important defaults to be aware of:

  • appsettings.json ships with default Docker-oriented credentials. Override the connection string, DataProtection key path, and any other secrets in production via environment variables, user secrets, or a secure secret store.
  • appsettings.Development.json is gitignored and intended only for local development.
  • Enforce HTTPS in production. Do not expose the Kestrel HTTP port directly; terminate TLS at a reverse proxy (see doc/ReverseProxy.md).

🚫 What We Will Not Do

  • We do not offer a bug bounty or monetary rewards β€” Mail-Archiver is a community project.
  • We do not reverse-engineer or audit deployments we do not control.
  • We will not honor reports that are spam, marketing, or clearly unrelated to security.

πŸ“„ License

Mail-Archiver is licensed under the GNU General Public License v3.0 β€” see the LICENSE file. By submitting a security report you agree that any coordinated fix and advisory may be published under the same license.

There aren't any published security advisories