shipcra

security.txt: Was die Datei leistet, ein Beispiel und wie Sie sie veröffentlichen

Geprüft am 2 Min. Lesezeit

security.txt ist eine Textdatei unter /.well-known/security.txt, die angibt, wie man Ihnen ein Sicherheitsproblem meldet. RFC 9116 definiert sie: Contact und Expires sind Pflicht, Felder wie Policy, Encryption oder Preferred-Languages sind optional. Sie ist in fünf Minuten geschrieben.

Das Wichtigste

Standard
RFC 9116 (April 2022)
Ort
https://ihre-domain/.well-known/security.txt
Pflichtfelder
Contact und Expires
Format
Klartext, per HTTPS als text/plain mit UTF-8 ausgeliefert
Expires
Empfohlen weniger als ein Jahr in der Zukunft

Wofür security.txt gut ist

Wer eine Schwachstelle in Ihrem Produkt findet, weiß oft nicht, an wen er sich wenden soll. security.txt löst das mit einer Datei an einer vorhersehbaren Adresse, die Menschen und Scanner kennen. RFC 9116, veröffentlicht im April 2022, legt das Format fest.

Die Felder

Feld Pflicht Inhalt
Contact Ja, mindestens eines Eine mailto:-, https://- oder tel:-Adresse für Meldungen
Expires Ja, genau eines Wann die Datei veraltet, im Format ISO 8601
Policy Nein Die URL Ihrer Richtlinie zur Offenlegung von Schwachstellen
Encryption Nein Wo ein Schlüssel für verschlüsselte Meldungen liegt
Preferred-Languages Nein Sprachen, in denen Sie Meldungen bearbeiten, etwa de, en
Canonical Nein Die offizielle URL der Datei
Acknowledgments Nein Eine Seite, die früheren Meldenden dankt
Hiring Nein Stellenangebote im Sicherheitsbereich

Sie können Contact mehrfach angeben, in der Reihenfolge Ihrer Präferenz.

Eine Beispieldatei

Contact: mailto:security@example.com
Contact: https://example.com/sicherheit/
Expires: 2027-10-31T23:00:00.000Z
Preferred-Languages: de, en
Canonical: https://example.com/.well-known/security.txt
Policy: https://example.com/sicherheit/

Das ist eine vollständige, gültige Datei. Zeilen, die mit # beginnen, sind Kommentare.

Wo Sie sie veröffentlichen

  • Unter https://ihre-domain/.well-known/security.txt. Eine Kopie im Stammverzeichnis, /security.txt, ist für ältere Werkzeuge erlaubt, maßgeblich ist aber der Pfad .well-known.
  • Über HTTPS, ausgeliefert als text/plain mit dem Zeichensatz UTF-8.
  • Auf jeder Domain, auf der Menschen Ihr Produkt nutzen, auch auf der Website, auf die Ihr Store-Eintrag verweist.

Bei einer statischen Website legen Sie die Datei in den Ordner, der /.well-known/ entspricht. In Astro-, Next.js- oder Vite-Projekten ist das meist public/.well-known/security.txt.

Optional: signieren

RFC 9116 erlaubt eine OpenPGP-Klartextsignatur, damit Lesende prüfen können, dass die Datei nicht verändert wurde. Wenn Sie signieren, signieren Sie nach jeder Änderung neu. Die meisten kleinen Teams verzichten darauf und verlassen sich auf HTTPS.

Nach dem Veröffentlichen prüfen

  • Die URL liefert die Datei über HTTPS mit dem Inhaltstyp text/plain.
  • Expires liegt in der Zukunft und weniger als ein Jahr entfernt.
  • Jeder Contact funktioniert: Schicken Sie sich eine Testnachricht.
  • Canonical entspricht der URL, unter der die Datei ausgeliefert wird.
  • Der Link unter Policy öffnet Ihre aktuelle Offenlegungsrichtlinie.

Tragen Sie sich einen Monat vor Expires eine Erinnerung ein.

security.txt und der Cyber Resilience Act

Der CRA nennt security.txt nicht. Er verlangt aber, die Meldung von Schwachstellen zu erleichtern, unter anderem durch eine Kontaktadresse (Anhang I, Teil II, Nummer 6), und den Nutzern eine zentrale Kontaktstelle für Schwachstellenmeldungen zu nennen (Anhang II). Eine security.txt mit Verweis auf Ihre Vulnerability Disclosure Policy ist der einfachste Weg, diesen Kontakt dort zu veröffentlichen, wo Forscher ohnehin suchen.

Fragen

Ist eine security.txt Pflicht?

Weder RFC 9116 noch der Cyber Resilience Act schreiben sie vor. Sie ist aber der bekannteste Weg, einen Sicherheitskontakt zu veröffentlichen, und einen solchen Kontakt verlangt der CRA.

Was bedeutet das Feld Expires?

Es ist das Datum, ab dem die Datei als veraltet gilt. RFC 9116 empfiehlt ein Datum weniger als ein Jahr in der Zukunft, damit Sie die Datei mindestens einmal im Jahr prüfen.

Brauche ich eine security.txt für eine App oder ein Spiel?

Veröffentlichen Sie sie auf der Website, die Sie in den App-Stores als Entwickler- oder Support-Website angeben. Dort suchen Sicherheitsforscher danach.

Kann ich eine security.txt erzeugen lassen?

Ja, sie hat nur wenige Zeilen, Sie können sie also nach dem Beispiel auf dieser Seite selbst schreiben. shipcra erzeugt eine als Teil des Dokumentenpakets, mit Verweis auf eine Offenlegungsseite, die wir für Sie hosten.

Quellen

  1. RFC 9116: A File Format to Aid in Security Vulnerability Disclosure
  2. Verordnung (EU) 2024/2847, Anhang I Teil II und Anhang II, EUR-Lex

Dieser Leitfaden erklärt die Verordnung allgemein. Er ist keine Rechtsberatung für Ihr Produkt.

Entwerfen Sie die Unterlagen aus Ihren Antworten.

Das Paket macht aus Ihren Antworten zu Anhang I einen Lückenbericht, technische Dokumentation und einen Erklärungsentwurf, den Sie prüfen und unterschreiben.

Frühen Zugang sichern