Skip to content

Commit e68720d

Browse files
Merge pull request #186 from nightwatchcyber/master
Last changes before publishing new version
2 parents cdd7b7c + 3a30d93 commit e68720d

File tree

3 files changed

+183
-179
lines changed

3 files changed

+183
-179
lines changed

draft-foudil-securitytxt.html

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head profile="http://www.w3.org/2006/03/hcard http://dublincore.org/documents/2008/08/04/dc-html/">
66
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
77

8-
<title>A Method for Web Security Policies</title>
8+
<title>A File Format to Aid in Security Vulnerability Disclosure</title>
99

1010

1111
<style type="text/css">/*<![CDATA[*/
@@ -341,9 +341,9 @@
341341

342342
<meta name="dct.creator" content="Foudil, E. and Y. Shafranovich" />
343343
<meta name="dct.identifier" content="urn:ietf:id:draft-foudil-securitytxt-09" />
344-
<meta name="dct.issued" scheme="ISO8601" content="2020-01-20" />
345-
<meta name="dct.abstract" content="When security vulnerabilities are discovered by independent security researchers, they often lack the channels to report them properly. As a result, security vulnerabilities may be left unreported. This document defines a format (&#8220;security.txt&#8221;) to help organizations describe their vulnerability disclosure practices to make it easier for researchers to report security vulnerabilities." />
346-
<meta name="description" content="When security vulnerabilities are discovered by independent security researchers, they often lack the channels to report them properly. As a result, security vulnerabilities may be left unreported. This document defines a format (&#8220;security.txt&#8221;) to help organizations describe their vulnerability disclosure practices to make it easier for researchers to report security vulnerabilities." />
344+
<meta name="dct.issued" scheme="ISO8601" content="2020-02-25" />
345+
<meta name="dct.abstract" content="When security vulnerabilities are discovered by researchers, proper reporting channels are often lacking. As a result, vulnerabilities may be left unreported. This document defines a format (&#8220;security.txt&#8221;) to help organizations describe their vulnerability disclosure practices to make it easier for researchers to report vulnerabilities." />
346+
<meta name="description" content="When security vulnerabilities are discovered by researchers, proper reporting channels are often lacking. As a result, vulnerabilities may be left unreported. This document defines a format (&#8220;security.txt&#8221;) to help organizations describe their vulnerability disclosure practices to make it easier for researchers to report vulnerabilities." />
347347

348348
</head>
349349

@@ -365,28 +365,28 @@
365365
<td class="right">Y. Shafranovich</td>
366366
</tr>
367367
<tr>
368-
<td class="left">Expires: July 23, 2020</td>
368+
<td class="left">Expires: August 28, 2020</td>
369369
<td class="right">Nightwatch Cybersecurity</td>
370370
</tr>
371371
<tr>
372372
<td class="left"></td>
373-
<td class="right">January 20, 2020</td>
373+
<td class="right">February 25, 2020</td>
374374
</tr>
375375

376376

377377
</tbody>
378378
</table>
379379

380-
<p class="title">A Method for Web Security Policies<br />
380+
<p class="title">A File Format to Aid in Security Vulnerability Disclosure<br />
381381
<span class="filename">draft-foudil-securitytxt-09</span></p>
382382

383383
<h1 id="rfc.abstract"><a href="#rfc.abstract">Abstract</a></h1>
384-
<p>When security vulnerabilities are discovered by independent security researchers, they often lack the channels to report them properly. As a result, security vulnerabilities may be left unreported. This document defines a format (&#8220;security.txt&#8221;) to help organizations describe their vulnerability disclosure practices to make it easier for researchers to report security vulnerabilities.</p>
384+
<p>When security vulnerabilities are discovered by researchers, proper reporting channels are often lacking. As a result, vulnerabilities may be left unreported. This document defines a format (&#8220;security.txt&#8221;) to help organizations describe their vulnerability disclosure practices to make it easier for researchers to report vulnerabilities.</p>
385385
<h1 id="rfc.status"><a href="#rfc.status">Status of This Memo</a></h1>
386386
<p>This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.</p>
387387
<p>Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.</p>
388388
<p>Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."</p>
389-
<p>This Internet-Draft will expire on July 23, 2020.</p>
389+
<p>This Internet-Draft will expire on August 28, 2020.</p>
390390
<h1 id="rfc.copyrightnotice"><a href="#rfc.copyrightnotice">Copyright Notice</a></h1>
391391
<p>Copyright (c) 2020 IETF Trust and the persons identified as the document authors. All rights reserved.</p>
392392
<p>This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.</p>
@@ -510,9 +510,9 @@ <h1 id="rfc.section.1">
510510
<h1 id="rfc.section.1.1">
511511
<a href="#rfc.section.1.1">1.1.</a> <a href="#motivation-prior-work-and-scope" id="motivation-prior-work-and-scope">Motivation, Prior Work and Scope</a>
512512
</h1>
513-
<p id="rfc.section.1.1.p.1">Many security researchers encounter situations where they are unable to report security vulnerabilities to organizations because there is no way indicated to contact the owner of a particular resource and no information available about the vulnerability disclosure practices of such owner.</p>
513+
<p id="rfc.section.1.1.p.1">Many security researchers encounter situations where they are unable to report security vulnerabilities to organizations because there are no reporting channels to contact the owner of a particular resource and no information available about the vulnerability disclosure practices of such owner.</p>
514514
<p id="rfc.section.1.1.p.2">As per section 4 of <a href="#RFC2142" class="xref">[RFC2142]</a>, there is an existing convention of using the &lt;SECURITY@domain&gt; email address for communications regarding security vulnerabilities. That convention provides only a single, email-based channel of communication for security vulnerabilities per domain, and does not provide a way for domain owners to publish information about their security disclosure practices.</p>
515-
<p id="rfc.section.1.1.p.3">There are also contact conventions prescribed for Internet Service Providers (ISPs) in section 2 of <a href="#RFC3013" class="xref">[RFC3013]</a>, for Computer Security Incident Response Teams (CSIRTs) in section 3.2 of <a href="#RFC2350" class="xref">[RFC2350]</a> and for site operators in section 5.2 of <a href="#RFC2196" class="xref">[RFC2196]</a>. As per <a href="#RFC7485" class="xref">[RFC7485]</a>, there is also contact information provided by Regional Internet Registries (RIRs) and domain registries for owners of IP addresses, autonomous system numbers (ASNs) and domain names. However, none of these address the issue of how security researchers can locate vulnerability disclosure practices and contact information for organizations in order to report security vulnerabilities.</p>
515+
<p id="rfc.section.1.1.p.3">There are also contact conventions prescribed for Internet Service Providers (ISPs) in section 2 of <a href="#RFC3013" class="xref">[RFC3013]</a>, for Computer Security Incident Response Teams (CSIRTs) in section 3.2 of <a href="#RFC2350" class="xref">[RFC2350]</a> and for site operators in section 5.2 of <a href="#RFC2196" class="xref">[RFC2196]</a>. As per <a href="#RFC7485" class="xref">[RFC7485]</a>, there is also contact information provided by Regional Internet Registries (RIRs) and domain registries for owners of IP addresses, autonomous system numbers (ASNs), and domain names. However, none of these address the issue of how security researchers can locate contact information and vulnerability disclosure practices for organizations in order to report vulnerabilities.</p>
516516
<p id="rfc.section.1.1.p.4">In this document, we define a richer and more extensible way for organizations to communicate information about their security disclosure practices and ways to contact them. Other details of vulnerability disclosure are outside the scope of this document. Readers are encouraged to consult other documents such as <a href="#ISO.29147.2018" class="xref">[ISO.29147.2018]</a> or <a href="#CERT.CVD" class="xref">[CERT.CVD]</a>.</p>
517517
<h1 id="rfc.section.1.2">
518518
<a href="#rfc.section.1.2">1.2.</a> <a href="#terminology" id="terminology">Terminology</a>
@@ -636,7 +636,7 @@ <h1 id="rfc.section.3.5.4">
636636
<h1 id="rfc.section.3.5.5">
637637
<a href="#rfc.section.3.5.5">3.5.5.</a> <a href="#expires" id="expires">Expires</a>
638638
</h1>
639-
<p id="rfc.section.3.5.5.p.1">This field indicates the date/time after which the data contained in the &#8220;security.txt&#8221; file is considered stale and should not be used (as per <a href="#stale" class="xref">Section 6.2</a>). The value of this field follows the format defined in section 3.3 of <a href="#RFC5322" class="xref">[RFC5322]</a>.</p>
639+
<p id="rfc.section.3.5.5.p.1">This field indicates the date and time after which the data contained in the &#8220;security.txt&#8221; file is considered stale and should not be used (as per <a href="#stale" class="xref">Section 6.2</a>). The value of this field follows the format defined in section 3.3 of <a href="#RFC5322" class="xref">[RFC5322]</a>.</p>
640640
<p id="rfc.section.3.5.5.p.2">This field MUST NOT appear more than once.</p>
641641
<pre>
642642
Expires: Thu, 31 Dec 2020 18:37:07 -0800
@@ -751,7 +751,7 @@ <h1 id="rfc.section.5">
751751
unsigned = *line (contact-field eol)
752752
*line [expires-field eol]
753753
*line [lang-field eol] *line
754-
; the order of fields within the file is not important
754+
; order of fields within the file is not important
755755

756756
line = (field / comment) eol
757757

@@ -808,14 +808,14 @@ <h1 id="rfc.section.6.1">
808808
<a href="#rfc.section.6.1">6.1.</a> <a href="#redirects" id="redirects">Compromised Files and Redirects</a>
809809
</h1>
810810
<p id="rfc.section.6.1.p.1">An attacker that has compromised a website is able to compromise the &#8220;security.txt&#8221; file as well or setup a redirect to their own site. This can result in security reports not being received by the organization or sent to the attacker.</p>
811-
<p id="rfc.section.6.1.p.2">To protect against this, organizations should digitally sign their &#8220;security.txt&#8221; files (as per <a href="#signature" class="xref">Section 3.4</a>), use the &#8220;Canonical&#8221; field to sign the locations of the file (as per <a href="#canonical" class="xref">Section 3.5.2</a>), and regularly monitor the file and the referenced resources to detect tampering.</p>
811+
<p id="rfc.section.6.1.p.2">To protect against this, organizations should use the &#8220;Canonical&#8221; field to indicate the locations of the file (as per <a href="#canonical" class="xref">Section 3.5.2</a>), digitally sign their &#8220;security.txt&#8221; files (as per <a href="#signature" class="xref">Section 3.4</a>), and regularly monitor the file and the referenced resources to detect tampering.</p>
812812
<p id="rfc.section.6.1.p.3">Security researchers should triage the &#8220;security.txt&#8221; file including verifying the digital signature and checking any available historical records before using the information contained in the file. If the &#8220;security.txt&#8221; file looks suspicious or compromised, it should not be used.</p>
813-
<p id="rfc.section.6.1.p.4">When retrieving the file and any resources referenced in the file, researchers should record any redirects since they can lead to a different domain or IP address controlled by an attacker. Further inspections of such redirects is recommended before using the information.</p>
813+
<p id="rfc.section.6.1.p.4">When retrieving the file and any resources referenced in the file, researchers should record any redirects since they can lead to a different domain or IP address controlled by an attacker. Further inspections of such redirects is recommended before using the information contained within the file.</p>
814814
<h1 id="rfc.section.6.2">
815815
<a href="#rfc.section.6.2">6.2.</a> <a href="#stale" id="stale">Incorrect or Stale Information</a>
816816
</h1>
817817
<p id="rfc.section.6.2.p.1">If information and resources referenced in a &#8220;security.txt&#8221; file are incorrect or not kept up to date, this can result in security reports not being received by the organization or sent to incorrect contacts, thus exposing possible security issues to third parties. Not having a security.txt file may be preferable to having stale information in this file. Organizations are also encouraged to use the &#8220;Expires&#8221; field (see <a href="#expires" class="xref">Section 3.5.5</a>) to indicate to researchers when the data in the file is no longer valid.</p>
818-
<p id="rfc.section.6.2.p.2">Organizations should ensure that information in this file and any referenced resources such as web pages, email addresses and telephone numbers are kept current, are accessible, controlled by the organization, and are kept secure.</p>
818+
<p id="rfc.section.6.2.p.2">Organizations should ensure that information in this file and any referenced resources such as web pages, email addresses, and telephone numbers are kept current, are accessible, controlled by the organization, and are kept secure.</p>
819819
<h1 id="rfc.section.6.3">
820820
<a href="#rfc.section.6.3">6.3.</a> <a href="#intentionally-malformed-files-resources-and-reports" id="intentionally-malformed-files-resources-and-reports">Intentionally Malformed Files, Resources and Reports</a>
821821
</h1>
@@ -910,7 +910,7 @@ <h1 id="rfc.section.7.2">
910910
Change controller: IESG
911911

912912
Field Name: Expires
913-
Description: specifies the date/time after which the data in this file is considered stale
913+
Description: date and time after which this file is considered stale
914914
Multiple Appearances: No
915915
Published in: this document
916916
Status: current
@@ -947,8 +947,9 @@ <h1 id="rfc.section.7.2">
947947
<h1 id="rfc.section.8">
948948
<a href="#rfc.section.8">8.</a> <a href="#contributors" id="contributors">Contributors</a>
949949
</h1>
950-
<p id="rfc.section.8.p.1">The authors would like to acknowledge the help provided during the development of this document by Tom Hudson, Jobert Abma, Gerben Janssen van Doorn, Austin Heap, Stephane Bortzmeyer, Max Smith, Eduardo Vela and Krzysztof Kotowicz.</p>
951-
<p id="rfc.section.8.p.2">The authors would also like to acknowledge the feedback provided by multiple members of IETF&#8217;s SAAG and SECDISPATCH lists.</p>
950+
<p id="rfc.section.8.p.1">The authors would like to acknowledge the help provided during the development of this document by Tom Hudson, Jobert Abma, Gerben Janssen van Doorn, Austin Heap, Stephane Bortzmeyer, Max Smith, Eduardo Vela, and Krzysztof Kotowicz.</p>
951+
<p id="rfc.section.8.p.2">The authors would also like to acknowledge the feedback provided by multiple members of IETF&#8217;s LAST CALL, SAAG, and SECDISPATCH lists.</p>
952+
<p id="rfc.section.8.p.3">Yakov would like to also thank L.T.S. (for everything).</p>
952953
<h1 id="rfc.references">
953954
<a href="#rfc.references">9.</a> References</h1>
954955
<h1 id="rfc.references.1">
@@ -1249,8 +1250,9 @@ <h1 id="rfc.appendix.B.9">
12491250
<li>Added language and example regarding URI encoding (#176)</li>
12501251
<li>Add &#8220;Expires&#8221; field (#181)</li>
12511252
<li>Changed language from &#8220;directive&#8221; to &#8220;field&#8221; (#182)</li>
1252-
<li>Addressing last call feedback (#179 and #180)</li>
1253+
<li>Addressing last call feedback (#179, #180 and #183)</li>
12531254
<li>Clarifying order of fields (#174)</li>
1255+
<li>Revert comment/field association (#158)</li>
12541256
</ul>
12551257
<p id="rfc.section.B.9.p.2">Full list of changes can be viewed via the IETF document tracker: https://tools.ietf.org/html/draft-foudil-securitytxt</p>
12561258
<h1 id="rfc.authors"><a href="#rfc.authors">Authors' Addresses</a></h1>

0 commit comments

Comments
 (0)