shipcra

security.txt : à quoi sert ce fichier, un exemple et comment le publier

Relu le 2 min de lecture

security.txt est un fichier texte publié à l’adresse /.well-known/security.txt qui indique comment vous signaler un problème de sécurité. La RFC 9116 le définit : les champs Contact et Expires sont obligatoires, et des champs comme Policy, Encryption ou Preferred-Languages sont facultatifs. Il s’écrit en cinq minutes.

L’essentiel

Norme
RFC 9116 (avril 2022)
Emplacement
https://votre-domaine/.well-known/security.txt
Champs obligatoires
Contact et Expires
Format
Texte brut, servi en HTTPS en text/plain et en UTF-8
Expires
De préférence moins d’un an dans le futur

À quoi sert security.txt

Quand quelqu’un trouve une vulnérabilité dans votre produit, le plus difficile est souvent de savoir à qui le dire. security.txt règle ce problème avec un fichier à une adresse prévisible, que les personnes et les outils d’analyse savent consulter. La RFC 9116, publiée en avril 2022, en normalise le format.

Les champs

Champ Obligatoire Contenu
Contact Oui, au moins un Une adresse mailto:, https:// ou tel: pour les signalements
Expires Oui, un seul La date de péremption du fichier, au format ISO 8601
Policy Non L’URL de votre politique de divulgation des vulnérabilités
Encryption Non Où trouver une clé pour chiffrer les signalements
Preferred-Languages Non Les langues dans lesquelles vous traitez les signalements, comme fr, en
Canonical Non L’URL officielle de publication du fichier
Acknowledgments Non Une page qui remercie les auteurs de signalements
Hiring Non Les offres d’emploi en sécurité

Vous pouvez répéter Contact pour indiquer plusieurs canaux, par ordre de préférence.

Un exemple de fichier

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

C’est un fichier complet et valide. Les lignes commençant par # sont des commentaires.

Où le publier

  • À l’adresse https://votre-domaine/.well-known/security.txt. Une copie à la racine, /security.txt, est tolérée pour les anciens outils, mais c’est le chemin .well-known qui fait référence.
  • En HTTPS, servi en text/plain avec le jeu de caractères UTF-8.
  • Sur chaque domaine où les gens utilisent votre produit, y compris le site vers lequel pointe votre fiche dans les stores.

Sur un site statique, placez le fichier dans le dossier qui correspond à /.well-known/. Dans un projet Astro, Next.js ou Vite, c’est en général public/.well-known/security.txt.

Facultatif : le signer

La RFC 9116 permet de signer le fichier avec une signature OpenPGP en clair, pour que les lecteurs vérifient qu’il n’a pas été modifié. Si vous le signez, re-signez-le à chaque modification. La plupart des petites équipes s’en passent et s’appuient sur le HTTPS.

Le vérifier après publication

  • L’URL renvoie le fichier, en HTTPS, avec le type de contenu text/plain.
  • Expires est dans le futur, à moins d’un an.
  • Chaque Contact fonctionne : envoyez-vous un message de test.
  • Canonical correspond à l’URL où le fichier est servi.
  • Le lien Policy ouvre votre politique de divulgation à jour.

Mettez un rappel dans votre agenda un mois avant la date Expires.

security.txt et le Cyber Resilience Act

Le CRA ne cite pas security.txt. Il impose en revanche de faciliter le signalement des vulnérabilités, notamment en fournissant une adresse de contact (annexe I, partie II, point 6), et de donner aux utilisateurs un point de contact unique pour signaler les vulnérabilités (annexe II). Un fichier security.txt qui renvoie vers votre politique de divulgation des vulnérabilités est le moyen le plus simple de publier ce contact là où les chercheurs regardent déjà.

Questions

Le fichier security.txt est-il obligatoire ?

Ni la RFC 9116 ni le Cyber Resilience Act ne le rendent obligatoire. C’est en revanche la façon la plus reconnue de publier un contact sécurité, et le CRA impose d’en fournir un.

Que signifie le champ Expires ?

C’est la date après laquelle le fichier doit être considéré comme périmé. La RFC 9116 recommande une date à moins d’un an, pour que vous le relisiez au moins une fois par an.

Faut-il un security.txt pour une app mobile ou un jeu ?

Publiez-le sur le site web indiqué comme site du développeur ou d’assistance dans les stores. C’est là que les chercheurs le chercheront.

Peut-on générer un fichier security.txt ?

Oui, il ne fait que quelques lignes : vous pouvez l’écrire à la main à partir de l’exemple de cette page. shipcra en génère un dans son dossier de documents, qui renvoie vers une page de divulgation qu’il héberge pour vous.

Sources

  1. RFC 9116 : format de fichier pour faciliter la divulgation des vulnérabilités
  2. Règlement (UE) 2024/2847, annexe I partie II et annexe II, EUR-Lex

Ce guide explique le règlement de façon générale. Il ne constitue pas un conseil juridique pour votre produit.

Rédigez le dossier à partir de vos réponses.

Le dossier transforme vos réponses à l’annexe I en rapport d’écarts, en documentation technique et en projet de déclaration, que vous relisez et signez.

Rejoindre l’accès anticipé