Skip to main content

Hinzufügen einer Sicherheitsrichtlinie für dein Repository

Indem du eine Sicherheitsrichtlinie zu deinem Repository hinzufügst, kannst du festlegen, wie Sicherheitslücken in deinem Projekt gemeldet werden sollen.

Informationen zu Sicherheitsrichtlinien

Um Personen Anweisungen zu geben, wie sie Sicherheitsrisiken in deinem Projekt melden können, kannst du eine SECURITY.md-Datei dem Stammverzeichnis deines Repositorys, dem Ordner docs oder .github hinzufügen. Wenn jemand ein Issue in deinem Repository erstellt, wird ein Link zur Sicherheitsrichtlinie deines Projekts angezeigt.

Du kannst eine Standardsicherheitsrichtlinie für deine Organisation oder dein persönliches Konto erstellen. Weitere Informationen findest du unter Erstellen einer Standard-Community-Health-File.

Tipp: Um den Benutzern das Auffinden der Sicherheitsrichtlinie zu erleichtern, kannst du an anderen Stellen in deinem Repository, z. B. in der README-Datei, die SECURITY.md-Datei verlinken. Weitere Informationen findest du unter Informationen zu README-Dateien.

Nachdem jemand eine Sicherheitslücke in deinem Projekt gemeldet hat, kannst du GitHub Security Advisories verwenden, um das Sicherheitsrisiko offen zu legen, zu korrigieren und entsprechende Informationen darüber zu veröffentlichen. Weitere Informationen zum Berichterstellungsprozess und zur Offenlegung von Sicherheitsrisiken in GitHub findest du unter Informationen zur koordinierten Offenlegung von Sicherheitsrisiken. Weitere Informationen zu Sicherheitshinweisen für Repositorys findest du unter Informationen zu Sicherheitsempfehlungen für Repositorys.

Du kannst auch GitHub Security Lab beitreten, um sicherheitsbezogene Themen zu durchsuchen und zu Sicherheitstools und Projekten beizutragen.

Ein Beispiel einer echten SECURITY.md-Datei finden Sie unter https://github.com/electron/electron/blob/main/SECURITY.md.

Hinzufügen einer Sicherheitsrichtlinie für dein Repository

  1. Navigiere auf GitHub.com zur Hauptseite des Repositorys.

  2. Wähle unter dem Repositorynamen die Option Sicherheit aus. Wenn die Registerkarte „Sicherheit“ nicht angezeigt wird, wähle im Dropdownmenü die Option Sicherheit aus. Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Sicherheit“ ist dunkelorange umrandet.

  3. Klicke auf der linken Randleiste unter „Berichterstellung“ auf -Richtlinie.

  4. Klicke auf Start setup (Setup starten).

  5. Fügen Sie in der neuen SECURITY.md-Datei Informationen zu unterstützten Versionen Ihres Projekts sowie zur Art und Weise der Meldung von Sicherheitsrisiken hinzu.

  6. Klicke auf Änderungen committen... .

  7. Gib im Feld „Commitnachricht“ eine kurze, aussagekräftige Commitnachricht ein, die die Änderung beschreibt, die Du an der Datei vorgenommen hast. Du kannst den Commit in der Commit-Mitteilung mehr als einem Autor zuordnen. Weitere Informationen findest du unter Einen Commit mit mehreren Autoren erstellen.

  8. Wenn deinem Konto in GitHub.com mehrere E-Mail-Adressen zugeordnet sind, klicke auf das Dropdownmenü für E-Mail-Adressen, und wähle die Adresse aus, die als Git-Autor-Adresse für den verwendet werden soll. Nur verifizierte E-Mail-Adressen werden in diesem Dropdownmenü angezeigt. Wenn Sie den Datenschutz für E-Mail-Adressen aktiviert haben, ist die Commitautor-Standardadresse No-reply. Weitere Informationen zur genauen Form der No-reply-E-Mail-Adresse finden Sie unter „E-Mail-Adresse für Commits festlegen“.

    Screenshot eines GitHub-Pull Requests mit einem Dropdownmenü mit Optionen zum Auswählen der Commit-E-Mail-Adresse des Autors. octocat@github.com ist ausgewählt.

  9. Lege unter den Commit-Mitteilungsfeldern fest, ob Du Dein Commit zum aktuellen Branch oder zu einem neuen Branch hinzufügen möchten. Wenn dein aktueller Branch als Standardbranch festgelegt ist, solltest du einen neuen Branch für deinen Commit und dann einen Pull Request erstellen. Weitere Informationen findest du unter Erstellen eines Pull Requests.

    Screenshot eines GitHub-Pull Requests mit einem Optionsfeld zum direkten Commit an den Mainbranch oder zum Erstellen eines neuen Branchs. Der neue Branch ist ausgewählt.

  10. Klicke auf Änderungen committen oder Änderungen vorschlagen.

Weiterführende Themen