idnits 2.17.1 draft-ietf-mile-rolie-vuln-01.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == The document seems to lack the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. (The document does seem to have the reference to RFC 2119 which the ID-Checklist requires). -- The document date (July 20, 2019) is 1740 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- == Unused Reference: 'RFC4287' is defined on line 304, but no explicit reference was found in the text == Unused Reference: 'RFC5023' is defined on line 312, but no explicit reference was found in the text Summary: 0 errors (**), 0 flaws (~~), 4 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 MILE Working Group S. Banghart 3 Internet-Draft NIST 4 Intended status: Informational July 20, 2019 5 Expires: January 21, 2020 7 Definition of the ROLIE Vulnerability Extension 8 draft-ietf-mile-rolie-vuln-01 10 Abstract 12 This document extends the Resource-Oriented Lightweight Information 13 Exchange (ROLIE) core to add the information type categories and 14 related requirements needed to support Vulnerability use cases. 15 Additional categories, properties, and requirements based on content 16 type enables a higher level of interoperability between ROLIE 17 implementations, and richer metadata for ROLIE consumers. In 18 particular, usage of the Common Vulnerability Enumeration (CVE) [cve] 19 format is discussed. 21 Status of This Memo 23 This Internet-Draft is submitted in full conformance with the 24 provisions of BCP 78 and BCP 79. 26 Internet-Drafts are working documents of the Internet Engineering 27 Task Force (IETF). Note that other groups may also distribute 28 working documents as Internet-Drafts. The list of current Internet- 29 Drafts is at https://datatracker.ietf.org/drafts/current/. 31 Internet-Drafts are draft documents valid for a maximum of six months 32 and may be updated, replaced, or obsoleted by other documents at any 33 time. It is inappropriate to use Internet-Drafts as reference 34 material or to cite them other than as "work in progress." 36 This Internet-Draft will expire on January 21, 2020. 38 Copyright Notice 40 Copyright (c) 2019 IETF Trust and the persons identified as the 41 document authors. All rights reserved. 43 This document is subject to BCP 78 and the IETF Trust's Legal 44 Provisions Relating to IETF Documents 45 (https://trustee.ietf.org/license-info) in effect on the date of 46 publication of this document. Please review these documents 47 carefully, as they describe your rights and restrictions with respect 48 to this document. Code Components extracted from this document must 49 include Simplified BSD License text as described in Section 4.e of 50 the Trust Legal Provisions and are provided without warranty as 51 described in the Simplified BSD License. 53 Table of Contents 55 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 56 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3 57 3. The "vulnerability" information type . . . . . . . . . . . . 3 58 4. Common Vulnerability Enumeration (CVE) Format . . . . . . . . 4 59 4.1. Description . . . . . . . . . . . . . . . . . . . . . . . 4 60 4.2. Requirements . . . . . . . . . . . . . . . . . . . . . . 5 61 5. Link relations for the 'vulnerability' 62 information-type . . . . . . . . . . . . . . . . . . . . . . 5 63 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 64 6.1. information-type registrations . . . . . . . . . . . . . 6 65 6.1.1. vulnerability information-type . . . . . . . . . . . 6 66 7. Security Considerations . . . . . . . . . . . . . . . . . . . 6 67 8. Normative References . . . . . . . . . . . . . . . . . . . . 7 68 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 7 70 1. Introduction 72 As our software becomes more complex and interconnected, the number 73 of software vulnerabilities exploitable by actors with mal-intent has 74 skyrocketed. Huge amounts of resources have been poured into the 75 preemptive discovery, description, and remediation of these 76 vulnerabilities, but it is often a challenge to share and communicate 77 the results of these efforts. While bad-actors have vast 78 collaboration networks that enable widespread knowledge of any 79 vulnerability, the defensive community at large has no sharing 80 consortium as prevalent. If we are to keep up with the rising 81 difficulty of defending our systems, we must increase our ability to 82 quickly, efficiently, and automatically share information about 83 vulnerabilities. 85 The Resource-Oriented Lightweight Information Exchange (ROLIE) 86 [RFC8322] provides a means to share computer security information 87 with an eye towards automation and efficiency. By utilizing ROLIE to 88 share vulnerability data, we get one step closer to establishing 89 automated communication between each party involved in fighting 90 vulnerabilities. A security researcher can send a newly discovered 91 vulnerability to a vulnerability repository, where it is 92 automatically retrieved and consumed by enterprise systems. At this 93 final stage, the enterprise can cross-reference against their 94 enterprise wide software load to begin mitigating the issue. 96 This extension to ROLIE introduces new requirements and IANA 97 registrations to allow ROLIE repositories to share vulnerability data 98 in a standardized and compatible way. 100 This extension does not attempt to solve the vulnerability data 101 format issue, this work is being done across standards groups and 102 industry consortiums. Instead, this extension serves to address the 103 problem of sharing these data formats to downstream consumers in a 104 automated and efficient fashion. 106 2. Terminology 108 The key words "MUST," "MUST NOT," "REQUIRED," "SHALL," "SHALL NOT," 109 "SHOULD," "SHOULD NOT," "RECOMMENDED," "MAY," and "OPTIONAL" in this 110 document are to be interpreted as described in [RFC2119]. 112 As an extension of [RFC8322], this document refers to many terms 113 defined in that document. In particular, the use of "Entry" and 114 "Feed" are aligned with the definitions presented there. 116 Several places in this document refer to the "information-type" of a 117 Resource (Entry or Feed). This refers to the "term" attribute of an 118 "atom:category" element whose scheme is 119 "urn:ietf:params:rolie:category:information-type". For an Entry, 120 this value can be inherited from it's containing Feed as per 121 [RFC8322]. 123 3. The "vulnerability" information type 125 When an "atom:category" element has a "scheme" attribute equal to 126 "urn:ietf:params:rolie:category:information-type", the "term" 127 attribute defines the information type of the associated resource. A 128 new valid value for this attribute: "vulnerability", is described in 129 this section, and registered in Section 6.1.1. When this value is 130 used, the resource in question is considered to have an information- 131 type of "vulnerability" as per [RFC8322] Section 7.1.2. 133 The "vulnerability" information-type represents any information 134 describing or pertaining to a computer security vulnerability. This 135 document uses the definition of vulnerability provided by [RFC4949]. 136 Provided below is a non-exhaustive list of information that may be 137 considered to be of a vulnerability information type. 139 o Fundamental identifying information, such as a global ID or 140 number, that identifies a given vulnerability. 142 o Descriptive information, including but not limited to: 144 * Severity scoring - using some standardized scoring algorithm or 145 otherwise, 147 * Execution details - how the vulnerability is exploited 149 * Impact - what the consequences are of this vulnerability 151 * History and provenance data - when was the vulnerability 152 discovered, when was it reported and to whom, 154 * Plain text description of any of the above 156 o Metadata attached to a vulnerability, such as information about 157 the entity that discovered or described the vulnerability. 159 Note again that this list is not exhaustive, any information that in 160 is the abstract realm of a vulnerability should be classified under 161 this information-type. The final decision as to the information type 162 of an Entry is up to the provider and author of the Entry. 164 4. Common Vulnerability Enumeration (CVE) Format 166 4.1. Description 168 The Common Vulnerability Enumeration (CVE) provides a globally unique 169 identifier for vulnerabilities. Each CVE provides a CVE-ID, by which 170 a vulnerability can be referred to in any context, as well as 171 descriptive information about that vulnerability. 173 For more information and in-depth specifications, please see [cve]. 175 CVE provides a valuable set of information fields, but itself does 176 not provide a standardized data format. This extension provides 177 standardization around two common serializations of the CVE standard, 178 both used by the National Institute of Standards and Technology 179 (NIST) National Vulnerability Database (NVD). The NVD provides a 180 repository of "CVE Entries" available in either serialization format. 181 The first format is XML-based: the NIST NVD CVE Entry format 182 [nvdcvexml], and the second is JSON based: NIST NVD JSON CVE Entry 183 Format [nvdcvejson]. These two representations of a CVE are 184 equivalent, and can be losslessly converted. 186 This section defines usage guidance and additional requirements above 187 and beyond those specified in [RFC8322] that apply when CVE data 188 formats are in use. 190 4.2. Requirements 192 For an Entry to be considered a "CVE Entry", it MUST fulfill the 193 following conditions: 195 o The information-type of the Entry is "vulnerability". For a 196 typical Entry, this is derived from the information type of the 197 Feed it is contained in. For a standalone Entry, this is provided 198 by an "atom:category" element. 200 o The document linked to by the "ref" attribute of the 201 "atom:content" element is a CVE Entry as defined by either 202 [nvdcvexml] or [nvdcvejson]. Other well-defined CVE 203 serializations would be valid but would not be subject to the 204 following requirements, reducing their interoperability. 206 The XML and JSON NVD formats follow different requirements. 208 A "XML CVE Entry" MUST conform to the following requirements: 210 o The value of the "type" attribute of the "atom:content" element 211 MUST be "application/xml". 213 o There MUST be one "rolie:property" with the "name" attribute equal 214 to "urn:ietf:params:rolie:property:content-id" and the "value" 215 attribute exactly equal to the "" element in the attached 216 CVE Entry. This allows for ROLIE consumers to more easily search 217 for CVE Entries without needing to download the entry itself. 219 A "JSON CVE Entry" MUST conform to the following requirements: 221 o The value of the "type" attribute of the "atom:content" element 222 MUST be "application/json". 224 o There MUST be one "rolie:property" with the "name" attribute equal 225 to "urn:ietf:params:rolie:property:content-id" and the "value" 226 attribute exactly equal to the "cve:{cve_data_meta":{ID}}" element 227 in the attached CVE Entry. This allows for ROLIE consumers to 228 more easily search for CVE Entries without needing to download the 229 entry itself. 231 5. Link relations for the 'vulnerability' information-type 233 The atom:link element contains a "rel" attribute that describes the 234 semantic meaning of the given link. 236 If the category of an Entry is the vulnerability information type, 237 then the following link relations MUST be respected, that is, not 238 removed, by the server. Implementations can provide extra 239 functionality by understanding the semantic meaning of these 240 relations. 242 +----------+--------------------------------------------------------+ 243 | Name | Description | 244 +----------+--------------------------------------------------------+ 245 | severity | Links to a document describing or scoring the severity | 246 | | of this vulnerability. | 247 +----------+--------------------------------------------------------+ 249 Table 1: Link Relations for Resource-Oriented Lightweight Indicator 250 Exchange 252 6. IANA Considerations 254 6.1. information-type registrations 256 IANA has added the following entries to the "ROLIE Security Resource 257 Information Type Sub-Registry" registry located at 258 . 260 6.1.1. vulnerability information-type 262 The entry is as follows: 264 name: vulnerability 266 index: TBD 268 reference: This document, Section 3 270 7. Security Considerations 272 All security considerations of the core ROLIE document apply to use 273 of this extension. 275 The use of this particular extension implies the use of ROLIE in 276 sharing vulnerability information. In automated use cases, 277 downstream consumers may be dynamically acquiring and acting on 278 vulnerabilities posted to a ROLIE repository. In this case, a 279 compromised server could serve up false vulnerability information to 280 trigger dangerous activity in automated consumers. Automatic 281 remediation solutions that consume shared vulnerability information 282 in high risk use cases should take care to verify data before taking 283 action. If some global ID, such as a CVE-ID, is included, this 284 verification should be trivial. 286 8. Normative References 288 [cve] "Common Vulnerability Enumeration", . 290 [nvdcvejson] 291 "NVD CVE Entry JSON Schema", 292 . 295 [nvdcvexml] 296 "NVD CVE Entry XML Schema", 297 . 299 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 300 Requirement Levels", BCP 14, RFC 2119, 301 DOI 10.17487/RFC2119, March 1997, 302 . 304 [RFC4287] Nottingham, M., Ed. and R. Sayre, Ed., "The Atom 305 Syndication Format", RFC 4287, DOI 10.17487/RFC4287, 306 December 2005, . 308 [RFC4949] Shirey, R., "Internet Security Glossary, Version 2", 309 FYI 36, RFC 4949, DOI 10.17487/RFC4949, August 2007, 310 . 312 [RFC5023] Gregorio, J., Ed. and B. de hOra, Ed., "The Atom 313 Publishing Protocol", RFC 5023, DOI 10.17487/RFC5023, 314 October 2007, . 316 [RFC8322] Field, J., Banghart, S., and D. Waltermire, "Resource- 317 Oriented Lightweight Information Exchange (ROLIE)", 318 RFC 8322, DOI 10.17487/RFC8322, February 2018, 319 . 321 [vdo] "Vulnerability Description Ontology", . 325 Author's Address 326 Stephen A. Banghart 327 National Institute of Standards and Technology 328 100 Bureau Drive 329 Gaithersburg, Maryland 330 USA 332 Phone: (301)975-4288 333 Email: stephen.banghart@nist.gov