This is an automated email from the ASF dual-hosted git repository.
janhoy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr-site.git
The following commit(s) were added to refs/heads/main by this push:
new 84d44f4a7 First draft presenting dependency vulnerability info
new 07f83bb84 Merge pull request #86 from raboof/vex
84d44f4a7 is described below
commit 84d44f4a74919dd051d990d3e08631ad5a8ee2df
Author: Arnout Engelen <[email protected]>
AuthorDate: Wed Dec 14 17:34:07 2022 +0100
First draft presenting dependency vulnerability info
To replace
https://cwiki.apache.org/confluence/display/SOLR/SolrSecurity#SolrSecurity-SolrandVulnerabilityScanningTools
and ask for feedback and experiences on approaches to VEX as discussed in
https://lists.apache.org/thread/j35clzm48s7xxc9671qogzr54bsdj1lz
---
content/pages/security.md | 35 +-
pelicanconf.py | 3 +-
plugins/vex/__init__.py | 1 +
plugins/vex/schema/bom-1.4.schema.json | 1697 ++++++++++++++++++++++++++++++
plugins/vex/schema/vex-input.schema.json | 35 +
plugins/vex/vex.py | 70 ++
requirements.txt | 3 +
themes/solr/templates/security.html | 36 +
vex-input.json | 469 +++++++++
9 files changed, 2342 insertions(+), 7 deletions(-)
diff --git a/content/pages/security.md b/content/pages/security.md
index 7ed52caea..449c54692 100644
--- a/content/pages/security.md
+++ b/content/pages/security.md
@@ -10,20 +10,21 @@ Every CVE that is detected by a software scanner is by
definition already public
To find a path forward in addressing a detected CVE we suggest the following
process for fastest results:
-1. Check further down this page to see if the CVE is listed as exploitable in
Solr.
-2. Check the [officially published non-exploitable
vulnerabilities](https://cwiki.apache.org/confluence/display/SOLR/SolrSecurity#SolrSecurity-SolrandVulnerabilityScanningTools)
list to see if the CVE is listed as not exploitable in Solr.
+1. Check [further down this page](#recent-cve-reports-for-apache-solr) to see
if the CVE is listed as exploitable in Solr.
+2. Check the [officially published non-exploitable
vulnerabilities](#cve-reports-for-apache-solr-dependencies) list to see if the
CVE is listed as not exploitable in Solr.
3. Search through the [Solr users mailing list
archive](https://lists.apache.org/[email protected]) to see if
anyone else has brought up this dependency CVE.
4. If no one has, then please do [subscribe to the users mailing
list](https://solr.apache.org/community.html#mailing-lists-chat) and then send
an email asking about the CVE.
#### Dos and Don'ts
-* Please DO discuss the possible need for library upgrades on the user list.
+* Please DO discuss the possible need for library upgrades on the user list.
* Please DO search Jira for the CVE number to see if we are addressing it
already.
* Please DO create Jira issues and associated pull requests to propose and
discuss upgrades of *a single specific* dependency.
* Please DO NOT attach a scan report, or paste output of a scan into Jira
(just link the CVE instead)
* Please DO NOT email the security email below with a scan report it will be
ignored.
+* Please DO look into automating some of this with [VEX](#vex) and share your
experience.
#### Use of Jira
-Jira is for discussing specific development modifications. Any Jira that
contains only scan report output, or references multiple dependencies at the
same time is likely to be ignored/closed. The large number of folks sending us
reports of things that are already known is a serious drag on our (volunteer)
time so **please search Jira** before opening a new issue.
+Jira is for discussing specific development modifications. Any Jira that
contains only scan report output, or references multiple dependencies at the
same time is likely to be ignored/closed. The large number of folks sending us
reports of things that are already known is a serious drag on our (volunteer)
time so **please search Jira** before opening a new issue.
### New Exploits <span style="color:blue">You</span> Discover in Solr
@@ -37,8 +38,30 @@ Before reporting a new exploit ensure that you have tested
it against an instanc
1. **Authentication** - Exploits demonstrated without login waste our time
because Solr is not meant to run such that the entire world has access to all
of its APIs. Running without forcing users to log in is no more valid than
running linux with a widely known default root password, or a database with a
root account that has no password.
2. **Authorization** - It is not an exploit unless the authenticated user was
configured with a role that should have prohibited the action, or the action
should never be allowed for any user regardless of role. Your report should say
why you think this action is not acceptable for the role(s) you tested it with.
+#### VEX
+Since the process of checking whether CVEs in dependencies of Solr affect your
+Solr deployment is tedious and error-prone, we are experimenting with sharing
+information about advisories that are known (not) to affect Solr in a
+machine-readable way.
+
+File formats to share this information are called 'VEX' formats. A number of
+such formats are under active development, such as based on
+[CycloneDX](https://cyclonedx.org/capabilities/vex/) and
+[CSAF](https://github.com/oasis-tcs/csaf/blob/master/csaf_2.0/prose/csaf-v2-editor-draft.md#45-profile-5-vex).
+
+We are currently providing vulnerability information in a CycloneDX JSON-based
+format [here](/solr.vex.json). We are very curious to hear about your
experience,
+and to find out what is still missing to reduce the signal/noise ratio and make
+these tools more effective. We invite you to join the discussion at the
+[security-discuss](mailto:[email protected])
+[mailinglist](https://www.apache.org/foundation/mailinglists.html) or,
+if you prefer to collaborate in private, contact
+[[email protected]](mailto:[email protected]). It will likely be
interesting
+to know what security scanning/reporting tool you are using, exactly on which
+artifacts, and if/how its vendor appears to support VEX. We'd be happy to work
+with you to see if we can provide this information in other variations or
formats.
+
+
### More information
You will find more security related information on our Wiki:
[https://cwiki.apache.org/confluence/display/SOLR/SolrSecurity](https://cwiki.apache.org/confluence/display/SOLR/SolrSecurity)
-# Recent CVE reports for Apache Solr
-Below is a list of already announced CVE vulnerabilities. These are also
available as an [ATOM feed](/feeds/solr/security.atom.xml):
diff --git a/pelicanconf.py b/pelicanconf.py
index 204127011..d628e3c2e 100755
--- a/pelicanconf.py
+++ b/pelicanconf.py
@@ -96,7 +96,8 @@ PLUGINS = [
'extract_toc',
'jinja2content',
'regex_replace',
- 'age_days_lt'
+ 'age_days_lt',
+ 'vex'
# 'md_inline_extension',
]
diff --git a/plugins/vex/__init__.py b/plugins/vex/__init__.py
new file mode 100644
index 000000000..226902b84
--- /dev/null
+++ b/plugins/vex/__init__.py
@@ -0,0 +1 @@
+from .vex import *
diff --git a/plugins/vex/schema/bom-1.4.schema.json
b/plugins/vex/schema/bom-1.4.schema.json
new file mode 100644
index 000000000..65c3c3c0c
--- /dev/null
+++ b/plugins/vex/schema/bom-1.4.schema.json
@@ -0,0 +1,1697 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#";,
+ "$id": "http://cyclonedx.org/schema/bom-1.4.schema.json";,
+ "type": "object",
+ "title": "CycloneDX Software Bill of Materials Standard",
+ "$comment" : "CycloneDX JSON schema is published under the terms of the
Apache License 2.0.",
+ "required": [
+ "bomFormat",
+ "specVersion",
+ "version"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "$schema": {
+ "type": "string",
+ "enum": [
+ "http://cyclonedx.org/schema/bom-1.4.schema.json";
+ ]
+ },
+ "bomFormat": {
+ "type": "string",
+ "title": "BOM Format",
+ "description": "Specifies the format of the BOM. This helps to identify
the file as CycloneDX since BOMs do not have a filename convention nor does
JSON schema support namespaces. This value MUST be \"CycloneDX\".",
+ "enum": [
+ "CycloneDX"
+ ]
+ },
+ "specVersion": {
+ "type": "string",
+ "title": "CycloneDX Specification Version",
+ "description": "The version of the CycloneDX specification a BOM
conforms to (starting at version 1.2).",
+ "examples": ["1.4"]
+ },
+ "serialNumber": {
+ "type": "string",
+ "title": "BOM Serial Number",
+ "description": "Every BOM generated SHOULD have a unique serial number,
even if the contents of the BOM have not changed over time. If specified, the
serial number MUST conform to RFC-4122. Use of serial numbers are RECOMMENDED.",
+ "examples": ["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"],
+ "pattern":
"^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+ },
+ "version": {
+ "type": "integer",
+ "title": "BOM Version",
+ "description": "Whenever an existing BOM is modified, either manually or
through automated processes, the version of the BOM SHOULD be incremented by 1.
When a system is presented with multiple BOMs with identical serial numbers,
the system SHOULD use the most recent version of the BOM. The default version
is '1'.",
+ "default": 1,
+ "examples": [1]
+ },
+ "metadata": {
+ "$ref": "#/definitions/metadata",
+ "title": "BOM Metadata",
+ "description": "Provides additional information about a BOM."
+ },
+ "components": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components."
+ },
+ "services": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services. This may include microservices,
function-as-a-service, and other types of network or intra-process services."
+ },
+ "externalReferences": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document systems,
sites, and information that may be relevant but which are not included with the
BOM."
+ },
+ "dependencies": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/dependency"},
+ "uniqueItems": true,
+ "title": "Dependencies",
+ "description": "Provides the ability to document dependency
relationships."
+ },
+ "compositions": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/compositions"},
+ "uniqueItems": true,
+ "title": "Compositions",
+ "description": "Compositions describe constituent parts (including
components, services, and dependency relationships) and their completeness."
+ },
+ "vulnerabilities": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/vulnerability"},
+ "uniqueItems": true,
+ "title": "Vulnerabilities",
+ "description": "Vulnerabilities identified in components or services."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format
(JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ },
+ "definitions": {
+ "refType": {
+ "$comment": "Identifier-DataType for interlinked elements.",
+ "type": "string"
+ },
+ "metadata": {
+ "type": "object",
+ "title": "BOM Metadata Object",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the BOM was
created."
+ },
+ "tools": {
+ "type": "array",
+ "title": "Creation Tools",
+ "description": "The tool(s) used in the creation of the BOM.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/tool"}
+ },
+ "authors" :{
+ "type": "array",
+ "title": "Authors",
+ "description": "The person(s) who created the BOM. Authors are
common in BOMs created through manual processes. BOMs created through automated
means may not have authors.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ },
+ "component": {
+ "title": "Component",
+ "description": "The component that the BOM describes.",
+ "$ref": "#/definitions/component"
+ },
+ "manufacture": {
+ "title": "Manufacture",
+ "description": "The organization that manufactured the component
that the BOM describes.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "supplier": {
+ "title": "Supplier",
+ "description": " The organization that supplied the component that
the BOM describes. The supplier may often be the manufacturer, but may also be
a distributor or repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "licenses": {
+ "type": "array",
+ "title": "BOM License(s)",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/licenseChoice"}
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a
name-value store. This provides flexibility to include data not officially
supported in the standard without having to use additional namespaces or create
extensions. Unlike key-value stores, properties support duplicate names, each
potentially having different values. Property names of interest to the general
public are encouraged to be registered in the [CycloneDX Property
Taxonomy](https://github.com/CycloneDX/ [...]
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "tool": {
+ "type": "object",
+ "title": "Tool",
+ "description": "Information about the automated or manual tool used",
+ "additionalProperties": false,
+ "properties": {
+ "vendor": {
+ "type": "string",
+ "title": "Tool Vendor",
+ "description": "The name of the vendor who created the tool"
+ },
+ "name": {
+ "type": "string",
+ "title": "Tool Name",
+ "description": "The name of the tool"
+ },
+ "version": {
+ "type": "string",
+ "title": "Tool Version",
+ "description": "The version of the tool"
+ },
+ "hashes": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the tool (if applicable)."
+ },
+ "externalReferences": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document
systems, sites, and information that may be relevant but which are not included
with the BOM."
+ }
+ }
+ },
+ "organizationalEntity": {
+ "type": "object",
+ "title": "Organizational Entity Object",
+ "description": "",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the organization",
+ "examples": [
+ "Example Inc."
+ ]
+ },
+ "url": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "URL",
+ "description": "The URL of the organization. Multiple URLs are
allowed.",
+ "examples": ["https://example.com";]
+ },
+ "contact": {
+ "type": "array",
+ "title": "Contact",
+ "description": "A contact at the organization. Multiple contacts are
allowed.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/organizationalContact"}
+ }
+ }
+ },
+ "organizationalContact": {
+ "type": "object",
+ "title": "Organizational Contact Object",
+ "description": "",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of a contact",
+ "examples": ["Contact name"]
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "Email Address",
+ "description": "The email address of the contact.",
+ "examples": ["[email protected]"]
+ },
+ "phone": {
+ "type": "string",
+ "title": "Phone",
+ "description": "The phone number of the contact.",
+ "examples": ["800-555-1212"]
+ }
+ }
+ },
+ "component": {
+ "type": "object",
+ "title": "Component Object",
+ "required": [
+ "type",
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "application",
+ "framework",
+ "library",
+ "container",
+ "operating-system",
+ "device",
+ "firmware",
+ "file"
+ ],
+ "title": "Component Type",
+ "description": "Specifies the type of component. For software
components, classify as application if no more specific appropriate
classification is available or cannot be determined for the component. Types
include:\n\n* __application__ = A software application. Refer to
[https://en.wikipedia.org/wiki/Application_software](https://en.wikipedia.org/wiki/Application_software)
for information about applications.\n* __framework__ = A software framework.
Refer to [https://en.wikiped [...]
+ "examples": ["library"]
+ },
+ "mime-type": {
+ "type": "string",
+ "title": "Mime-Type",
+ "description": "The optional mime-type of the component. When used
on file components, the mime-type can provide additional context about the kind
of file being represented such as an image, font, or executable. Some library
or framework components may also have an associated mime-type.",
+ "examples": ["image/jpeg"],
+ "pattern": "^[-+a-z0-9.]+/[-+a-z0-9.]+$"
+ },
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to
reference the component elsewhere in the BOM. Every bom-ref MUST be unique
within the BOM."
+ },
+ "supplier": {
+ "title": "Component Supplier",
+ "description": " The organization that supplied the component. The
supplier may often be the manufacturer, but may also be a distributor or
repackager.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "author": {
+ "type": "string",
+ "title": "Component Author",
+ "description": "The person(s) or organization(s) that authored the
component",
+ "examples": ["Acme Inc"]
+ },
+ "publisher": {
+ "type": "string",
+ "title": "Component Publisher",
+ "description": "The person(s) or organization(s) that published the
component",
+ "examples": ["Acme Inc"]
+ },
+ "group": {
+ "type": "string",
+ "title": "Component Group",
+ "description": "The grouping name or identifier. This will often be
a shortened, single name of the company or project that produced the component,
or the source package or domain name. Whitespace and special characters should
be avoided. Examples include: apache, org.apache.commons, and apache.org.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Component Name",
+ "description": "The name of the component. This will often be a
shortened, single name of the component. Examples: commons-lang3 and jquery",
+ "examples": ["tomcat-catalina"]
+ },
+ "version": {
+ "type": "string",
+ "title": "Component Version",
+ "description": "The component version. The version should ideally
comply with semantic versioning but is not enforced.",
+ "examples": ["9.0.14"]
+ },
+ "description": {
+ "type": "string",
+ "title": "Component Description",
+ "description": "Specifies a description for the component"
+ },
+ "scope": {
+ "type": "string",
+ "enum": [
+ "required",
+ "optional",
+ "excluded"
+ ],
+ "title": "Component Scope",
+ "description": "Specifies the scope of the component. If scope is
not specified, 'required' scope SHOULD be assumed by the consumer of the BOM.",
+ "default": "required"
+ },
+ "hashes": {
+ "type": "array",
+ "title": "Component Hashes",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/hash"}
+ },
+ "licenses": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "copyright": {
+ "type": "string",
+ "title": "Component Copyright",
+ "description": "A copyright notice informing users of the underlying
claims to copyright ownership in a published work.",
+ "examples": ["Acme Inc"]
+ },
+ "cpe": {
+ "type": "string",
+ "title": "Component Common Platform Enumeration (CPE)",
+ "description": "Specifies a well-formed CPE name that conforms to
the CPE 2.2 or 2.3 specification. See
[https://nvd.nist.gov/products/cpe](https://nvd.nist.gov/products/cpe)",
+ "examples": ["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"]
+ },
+ "purl": {
+ "type": "string",
+ "title": "Component Package URL (purl)",
+ "description": "Specifies the package-url (purl). The purl, if
specified, MUST be valid and conform to the specification defined at:
[https://github.com/package-url/purl-spec](https://github.com/package-url/purl-spec)",
+ "examples":
["pkg:maven/com.acme/[email protected]?packaging=jar"]
+ },
+ "swid": {
+ "$ref": "#/definitions/swid",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for [ISO-IEC 19770-2
Software Identification (SWID) Tags](https://www.iso.org/standard/65666.html)."
+ },
+ "modified": {
+ "type": "boolean",
+ "title": "Component Modified From Original",
+ "description": "[Deprecated] - DO NOT USE. This will be removed in a
future version. Use the pedigree element instead to supply information on
exactly how the component was modified. A boolean value indicating if the
component has been modified from the original. A value of true indicates the
component is a derivative of the original. A value of false indicates the
component has not been modified from the original."
+ },
+ "pedigree": {
+ "type": "object",
+ "title": "Component Pedigree",
+ "description": "Component pedigree is a way to document complex
supply chain scenarios where components are created, distributed, modified,
redistributed, combined with other components, etc. Pedigree supports viewing
this complex chain from the beginning, the end, or anywhere in the middle. It
also provides a way to document variants where the exact relation may not be
known.",
+ "additionalProperties": false,
+ "properties": {
+ "ancestors": {
+ "type": "array",
+ "title": "Ancestors",
+ "description": "Describes zero or more components in which a
component is derived from. This is commonly used to describe forks from
existing projects where the forked version contains a ancestor node containing
the original component it was forked from. For example, Component A is the
original component. Component B is the component being used and documented in
the BOM. However, Component B contains a pedigree node with a single ancestor
documenting Component A - the origi [...]
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "descendants": {
+ "type": "array",
+ "title": "Descendants",
+ "description": "Descendants are the exact opposite of ancestors.
This provides a way to document all forks (and their forks) of an original or
root component.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "variants": {
+ "type": "array",
+ "title": "Variants",
+ "description": "Variants describe relations where the
relationship between the components are not known. For example, if Component A
contains nearly identical code to Component B. They are both related, but it is
unclear if one is derived from the other, or if they share a common ancestor.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/component"}
+ },
+ "commits": {
+ "type": "array",
+ "title": "Commits",
+ "description": "A list of zero or more commits which provide a
trail describing how the component deviates from an ancestor, descendant, or
variant.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/commit"}
+ },
+ "patches": {
+ "type": "array",
+ "title": "Patches",
+ "description": ">A list of zero or more patches describing how
the component deviates from an ancestor, descendant, or variant. Patches may be
complimentary to commits or may be used in place of commits.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/patch"}
+ },
+ "notes": {
+ "type": "string",
+ "title": "Notes",
+ "description": "Notes, observations, and other non-structured
commentary describing the components pedigree."
+ }
+ }
+ },
+ "externalReferences": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document
systems, sites, and information that may be relevant but which are not included
with the BOM."
+ },
+ "components": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/component"},
+ "uniqueItems": true,
+ "title": "Components",
+ "description": "A list of software and hardware components included
in the parent component. This is not a dependency tree. It provides a way to
specify a hierarchical representation of component assemblies, similar to
system → subsystem → parts assembly in physical supply chains."
+ },
+ "evidence": {
+ "$ref": "#/definitions/componentEvidence",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected
through various forms of extraction or analysis."
+ },
+ "releaseNotes": {
+ "$ref": "#/definitions/releaseNotes",
+ "title": "Release notes",
+ "description": "Specifies optional release notes."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a
name-value store. This provides flexibility to include data not officially
supported in the standard without having to use additional namespaces or create
extensions. Unlike key-value stores, properties support duplicate names, each
potentially having different values. Property names of interest to the general
public are encouraged to be registered in the [CycloneDX Property
Taxonomy](https://github.com/CycloneDX/ [...]
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/property"}
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format
(JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "swid": {
+ "type": "object",
+ "title": "SWID Tag",
+ "description": "Specifies metadata and content for ISO-IEC 19770-2
Software Identification (SWID) Tags.",
+ "required": [
+ "tagId",
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "tagId": {
+ "type": "string",
+ "title": "Tag ID",
+ "description": "Maps to the tagId of a SoftwareIdentity."
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "Maps to the name of a SoftwareIdentity."
+ },
+ "version": {
+ "type": "string",
+ "title": "Version",
+ "default": "0.0",
+ "description": "Maps to the version of a SoftwareIdentity."
+ },
+ "tagVersion": {
+ "type": "integer",
+ "title": "Tag Version",
+ "default": 0,
+ "description": "Maps to the tagVersion of a SoftwareIdentity."
+ },
+ "patch": {
+ "type": "boolean",
+ "title": "Patch",
+ "default": false,
+ "description": "Maps to the patch of a SoftwareIdentity."
+ },
+ "text": {
+ "title": "Attachment text",
+ "description": "Specifies the metadata and content of the SWID tag.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the SWID file.",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "attachment": {
+ "type": "object",
+ "title": "Attachment",
+ "description": "Specifies the metadata and content for an attachment.",
+ "required": [
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "contentType": {
+ "type": "string",
+ "title": "Content-Type",
+ "description": "Specifies the content type of the text. Defaults to
text/plain if not specified.",
+ "default": "text/plain"
+ },
+ "encoding": {
+ "type": "string",
+ "title": "Encoding",
+ "description": "Specifies the optional encoding the text is
represented in.",
+ "enum": [
+ "base64"
+ ]
+ },
+ "content": {
+ "type": "string",
+ "title": "Attachment Text",
+ "description": "The attachment data. Proactive controls such as
input validation and sanitization should be employed to prevent misuse of
attachment text."
+ }
+ }
+ },
+ "hash": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "alg",
+ "content"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "alg": {
+ "$ref": "#/definitions/hash-alg"
+ },
+ "content": {
+ "$ref": "#/definitions/hash-content"
+ }
+ }
+ },
+ "hash-alg": {
+ "type": "string",
+ "enum": [
+ "MD5",
+ "SHA-1",
+ "SHA-256",
+ "SHA-384",
+ "SHA-512",
+ "SHA3-256",
+ "SHA3-384",
+ "SHA3-512",
+ "BLAKE2b-256",
+ "BLAKE2b-384",
+ "BLAKE2b-512",
+ "BLAKE3"
+ ],
+ "title": "Hash Algorithm"
+ },
+ "hash-content": {
+ "type": "string",
+ "title": "Hash Content (value)",
+ "examples": ["3942447fac867ae5cdb3229b658f4d48"],
+ "pattern":
"^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"
+ },
+ "license": {
+ "type": "object",
+ "title": "License Object",
+ "oneOf": [
+ {
+ "required": ["id"]
+ },
+ {
+ "required": ["name"]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "$ref": "spdx.schema.json",
+ "title": "License ID (SPDX)",
+ "description": "A valid SPDX license ID",
+ "examples": ["Apache-2.0"]
+ },
+ "name": {
+ "type": "string",
+ "title": "License Name",
+ "description": "If SPDX does not define the license used, this field
may be used to provide the license name",
+ "examples": ["Acme Software License"]
+ },
+ "text": {
+ "title": "License text",
+ "description": "An optional way to include the textual content of a
license.",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "License URL",
+ "description": "The URL to the license file. If specified, a
'license' externalReference should also be specified for completeness",
+ "examples": ["https://www.apache.org/licenses/LICENSE-2.0.txt";],
+ "format": "iri-reference"
+ }
+ }
+ },
+ "licenseChoice": {
+ "type": "object",
+ "title": "License(s)",
+ "additionalProperties": false,
+ "properties": {
+ "license": {
+ "$ref": "#/definitions/license"
+ },
+ "expression": {
+ "type": "string",
+ "title": "SPDX License Expression",
+ "examples": [
+ "Apache-2.0 AND (MIT OR GPL-2.0-only)",
+ "GPL-3.0-only WITH Classpath-exception-2.0"
+ ]
+ }
+ },
+ "oneOf":[
+ {
+ "required": ["license"]
+ },
+ {
+ "required": ["expression"]
+ }
+ ]
+ },
+ "commit": {
+ "type": "object",
+ "title": "Commit",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "uid": {
+ "type": "string",
+ "title": "UID",
+ "description": "A unique identifier of the commit. This may be
version control specific. For example, Subversion uses revision numbers whereas
git uses commit hashes."
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the commit. This URL will typically point
to a commit in a version control system.",
+ "format": "iri-reference"
+ },
+ "author": {
+ "title": "Author",
+ "description": "The author who created the changes in the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "committer": {
+ "title": "Committer",
+ "description": "The person who committed or pushed the commit",
+ "$ref": "#/definitions/identifiableAction"
+ },
+ "message": {
+ "type": "string",
+ "title": "Message",
+ "description": "The text description of the contents of the commit"
+ }
+ }
+ },
+ "patch": {
+ "type": "object",
+ "title": "Patch",
+ "description": "Specifies an individual patch",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "unofficial",
+ "monkey",
+ "backport",
+ "cherry-pick"
+ ],
+ "title": "Type",
+ "description": "Specifies the purpose for the patch including the
resolution of defects, security issues, or new behavior or functionality.\n\n*
__unofficial__ = A patch which is not developed by the creators or maintainers
of the software being patched. Refer to
[https://en.wikipedia.org/wiki/Unofficial_patch](https://en.wikipedia.org/wiki/Unofficial_patch)\n*
__monkey__ = A patch which dynamically modifies runtime behavior. Refer to
[https://en.wikipedia.org/wiki/Monkey_patch [...]
+ },
+ "diff": {
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to
[https://en.wikipedia.org/wiki/Diff](https://en.wikipedia.org/wiki/Diff)",
+ "$ref": "#/definitions/diff"
+ },
+ "resolves": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues the patch resolves"
+ }
+ }
+ },
+ "diff": {
+ "type": "object",
+ "title": "Diff",
+ "description": "The patch file (or diff) that show changes. Refer to
https://en.wikipedia.org/wiki/Diff";,
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "title": "Diff text",
+ "description": "Specifies the optional text of the diff",
+ "$ref": "#/definitions/attachment"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "Specifies the URL to the diff",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "issue": {
+ "type": "object",
+ "title": "Diff",
+ "description": "An individual issue that has been resolved.",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "defect",
+ "enhancement",
+ "security"
+ ],
+ "title": "Type",
+ "description": "Specifies the type of issue"
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The identifier of the issue assigned by the source
of the issue"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the issue"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the issue"
+ },
+ "source": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of the issue where it is documented",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source. For example 'National
Vulnerability Database', 'NVD', and 'Apache'"
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the issue documentation as provided
by the source",
+ "format": "iri-reference"
+ }
+ }
+ },
+ "references": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "References",
+ "description": "A collection of URL's for reference. Multiple URLs
are allowed.",
+ "examples": ["https://example.com";]
+ }
+ }
+ },
+ "identifiableAction": {
+ "type": "object",
+ "title": "Identifiable Action",
+ "description": "Specifies an individual commit",
+ "additionalProperties": false,
+ "properties": {
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The timestamp in which the action occurred"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the individual who performed the action"
+ },
+ "email": {
+ "type": "string",
+ "format": "idn-email",
+ "title": "E-mail",
+ "description": "The email address of the individual who performed
the action"
+ }
+ }
+ },
+ "externalReference": {
+ "type": "object",
+ "title": "External Reference",
+ "description": "Specifies an individual external reference",
+ "required": [
+ "url",
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The URL to the external reference",
+ "format": "iri-reference"
+ },
+ "comment": {
+ "type": "string",
+ "title": "Comment",
+ "description": "An optional comment describing the external
reference"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "Specifies the type of external reference. There are
built-in types to describe common references. If a type does not exist for the
reference being referred to, use the \"other\" type.",
+ "enum": [
+ "vcs",
+ "issue-tracker",
+ "website",
+ "advisories",
+ "bom",
+ "mailing-list",
+ "social",
+ "chat",
+ "documentation",
+ "support",
+ "distribution",
+ "license",
+ "build-meta",
+ "build-system",
+ "release-notes",
+ "other"
+ ]
+ },
+ "hashes": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/hash"},
+ "title": "Hashes",
+ "description": "The hashes of the external reference (if
applicable)."
+ }
+ }
+ },
+ "dependency": {
+ "type": "object",
+ "title": "Dependency",
+ "description": "Defines the direct dependencies of a component.
Components that do not have their own dependencies MUST be declared as empty
elements within the graph. Components that are not represented in the
dependency graph MAY have unknown dependencies. It is RECOMMENDED that
implementations assume this to be opaque and not an indicator of a component
being dependency-free.",
+ "required": [
+ "ref"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "$ref": "#/definitions/refType",
+ "title": "Reference",
+ "description": "References a component by the components bom-ref
attribute"
+ },
+ "dependsOn": {
+ "type": "array",
+ "uniqueItems": true,
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/refType"
+ },
+ "title": "Depends On",
+ "description": "The bom-ref identifiers of the components that are
dependencies of this dependency object."
+ }
+ }
+ },
+ "service": {
+ "type": "object",
+ "title": "Service Object",
+ "required": [
+ "name"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to
reference the service elsewhere in the BOM. Every bom-ref MUST be unique within
the BOM."
+ },
+ "provider": {
+ "title": "Provider",
+ "description": "The organization that provides the service.",
+ "$ref": "#/definitions/organizationalEntity"
+ },
+ "group": {
+ "type": "string",
+ "title": "Service Group",
+ "description": "The grouping name, namespace, or identifier. This
will often be a shortened, single name of the company or project that produced
the service or domain name. Whitespace and special characters should be
avoided.",
+ "examples": ["com.acme"]
+ },
+ "name": {
+ "type": "string",
+ "title": "Service Name",
+ "description": "The name of the service. This will often be a
shortened, single name of the service.",
+ "examples": ["ticker-service"]
+ },
+ "version": {
+ "type": "string",
+ "title": "Service Version",
+ "description": "The service version.",
+ "examples": ["1.0.0"]
+ },
+ "description": {
+ "type": "string",
+ "title": "Service Description",
+ "description": "Specifies a description for the service"
+ },
+ "endpoints": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "iri-reference"
+ },
+ "title": "Endpoints",
+ "description": "The endpoint URIs of the service. Multiple endpoints
are allowed.",
+ "examples": ["https://example.com/api/v1/ticker";]
+ },
+ "authenticated": {
+ "type": "boolean",
+ "title": "Authentication Required",
+ "description": "A boolean value indicating if the service requires
authentication. A value of true indicates the service requires authentication
prior to use. A value of false indicates the service does not require
authentication."
+ },
+ "x-trust-boundary": {
+ "type": "boolean",
+ "title": "Crosses Trust Boundary",
+ "description": "A boolean value indicating if use of the service
crosses a trust zone or boundary. A value of true indicates that by using the
service, a trust boundary is crossed. A value of false indicates that by using
the service, a trust boundary is not crossed."
+ },
+ "data": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/dataClassification"},
+ "title": "Data Classification",
+ "description": "Specifies the data classification."
+ },
+ "licenses": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "externalReferences": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/externalReference"},
+ "title": "External References",
+ "description": "External references provide a way to document
systems, sites, and information that may be relevant but which are not included
with the BOM."
+ },
+ "services": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/service"},
+ "uniqueItems": true,
+ "title": "Services",
+ "description": "A list of services included or deployed behind the
parent service. This is not a dependency tree. It provides a way to specify a
hierarchical representation of service assemblies."
+ },
+ "releaseNotes": {
+ "$ref": "#/definitions/releaseNotes",
+ "title": "Release notes",
+ "description": "Specifies optional release notes."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a
name-value store. This provides flexibility to include data not officially
supported in the standard without having to use additional namespaces or create
extensions. Unlike key-value stores, properties support duplicate names, each
potentially having different values. Property names of interest to the general
public are encouraged to be registered in the [CycloneDX Property
Taxonomy](https://github.com/CycloneDX/ [...]
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/property"}
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format
(JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "dataClassification": {
+ "type": "object",
+ "title": "Hash Objects",
+ "required": [
+ "flow",
+ "classification"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "flow": {
+ "$ref": "#/definitions/dataFlow",
+ "title": "Directional Flow",
+ "description": "Specifies the flow direction of the data. Direction
is relative to the service. Inbound flow states that data enters the service.
Outbound flow states that data leaves the service. Bi-directional states that
data flows both ways, and unknown states that the direction is not known."
+ },
+ "classification": {
+ "type": "string",
+ "title": "Classification",
+ "description": "Data classification tags data according to its type,
sensitivity, and value if altered, stolen, or destroyed."
+ }
+ }
+ },
+ "dataFlow": {
+ "type": "string",
+ "enum": [
+ "inbound",
+ "outbound",
+ "bi-directional",
+ "unknown"
+ ],
+ "title": "Data flow direction",
+ "description": "Specifies the flow direction of the data. Direction is
relative to the service. Inbound flow states that data enters the service.
Outbound flow states that data leaves the service. Bi-directional states that
data flows both ways, and unknown states that the direction is not known."
+ },
+
+ "copyright": {
+ "type": "object",
+ "title": "Copyright",
+ "required": [
+ "text"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "text": {
+ "type": "string",
+ "title": "Copyright Text"
+ }
+ }
+ },
+
+ "componentEvidence": {
+ "type": "object",
+ "title": "Evidence",
+ "description": "Provides the ability to document evidence collected
through various forms of extraction or analysis.",
+ "additionalProperties": false,
+ "properties": {
+ "licenses": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/licenseChoice"},
+ "title": "Component License(s)"
+ },
+ "copyright": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/copyright"},
+ "title": "Copyright"
+ }
+ }
+ },
+ "compositions": {
+ "type": "object",
+ "title": "Compositions",
+ "required": [
+ "aggregate"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "aggregate": {
+ "$ref": "#/definitions/aggregateType",
+ "title": "Aggregate",
+ "description": "Specifies an aggregate type that describe how
complete a relationship is."
+ },
+ "assemblies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or
services being described. Assemblies refer to nested relationships whereby a
constituent part may include other constituent parts. References do not cascade
to child parts. References are explicit for the specified constituent part
only."
+ },
+ "dependencies": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ },
+ "title": "BOM references",
+ "description": "The bom-ref identifiers of the components or
services being described. Dependencies refer to a relationship whereby an
independent constituent part requires another independent constituent part.
References do not cascade to transitive dependencies. References are explicit
for the specified dependency only."
+ },
+ "signature": {
+ "$ref": "#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format
(JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+ },
+ "aggregateType": {
+ "type": "string",
+ "default": "not_specified",
+ "enum": [
+ "complete",
+ "incomplete",
+ "incomplete_first_party_only",
+ "incomplete_third_party_only",
+ "unknown",
+ "not_specified"
+ ]
+ },
+ "property": {
+ "type": "object",
+ "title": "Lightweight name-value pair",
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the property. Duplicate names are
allowed, each potentially having a different value."
+ },
+ "value": {
+ "type": "string",
+ "title": "Value",
+ "description": "The value of the property."
+ }
+ }
+ },
+ "localeType": {
+ "type": "string",
+ "pattern": "^([a-z]{2})(-[A-Z]{2})?$",
+ "title": "Locale",
+ "description": "Defines a syntax for representing two character language
code (ISO-639) followed by an optional two character country code. The language
code MUST be lower case. If the country code is specified, the country code
MUST be upper case. The language code and country code MUST be separated by a
minus sign. Examples: en, en-US, fr, fr-CA"
+ },
+ "releaseType": {
+ "type": "string",
+ "examples": [
+ "major",
+ "minor",
+ "patch",
+ "pre-release",
+ "internal"
+ ],
+ "description": "The software versioning type. It is RECOMMENDED that the
release type use one of 'major', 'minor', 'patch', 'pre-release', or
'internal'. Representing all possible software release types is not practical,
so standardizing on the recommended values, whenever possible, is strongly
encouraged.\n\n* __major__ = A major release may contain significant changes or
may introduce breaking changes.\n* __minor__ = A minor release, also known as
an update, may contain a smaller [...]
+ },
+ "note": {
+ "type": "object",
+ "title": "Note",
+ "description": "A note containing the locale and content.",
+ "required": [
+ "text"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "locale": {
+ "$ref": "#/definitions/localeType",
+ "title": "Locale",
+ "description": "The ISO-639 (or higher) language code and optional
ISO-3166 (or higher) country code. Examples include: \"en\", \"en-US\", \"fr\"
and \"fr-CA\""
+ },
+ "text": {
+ "title": "Release note content",
+ "description": "Specifies the full content of the release note.",
+ "$ref": "#/definitions/attachment"
+ }
+ }
+ },
+ "releaseNotes": {
+ "type": "object",
+ "title": "Release notes",
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "type": {
+ "$ref": "#/definitions/releaseType",
+ "title": "Type",
+ "description": "The software versioning type the release note
describes."
+ },
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "description": "The title of the release."
+ },
+ "featuredImage": {
+ "type": "string",
+ "format": "iri-reference",
+ "title": "Featured image",
+ "description": "The URL to an image that may be prominently
displayed with the release note."
+ },
+ "socialImage": {
+ "type": "string",
+ "format": "iri-reference",
+ "title": "Social image",
+ "description": "The URL to an image that may be used in messaging on
social media platforms."
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A short description of the release."
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Timestamp",
+ "description": "The date and time (timestamp) when the release note
was created."
+ },
+ "aliases": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "Aliases",
+ "description": "One or more alternate names the release may be
referred to. This may include unofficial terms used by development and
marketing teams (e.g. code names)."
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "title": "Tags",
+ "description": "One or more tags that may aid in search or retrieval
of the release note."
+ },
+ "resolves": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/issue"},
+ "title": "Resolves",
+ "description": "A collection of issues that have been resolved."
+ },
+ "notes": {
+ "type": "array",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/note"},
+ "title": "Notes",
+ "description": "Zero or more release notes containing the locale and
content. Multiple note objects may be specified to support release notes in a
wide variety of languages."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a
name-value store. This provides flexibility to include data not officially
supported in the standard without having to use additional namespaces or create
extensions. Unlike key-value stores, properties support duplicate names, each
potentially having different values. Property names of interest to the general
public are encouraged to be registered in the [CycloneDX Property
Taxonomy](https://github.com/CycloneDX/ [...]
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/property"}
+ }
+ }
+ },
+ "advisory": {
+ "type": "object",
+ "title": "Advisory",
+ "description": "Title and location where advisory information can be
obtained. An advisory is a notification of a threat to a component, service, or
system.",
+ "required": ["url"],
+ "additionalProperties": false,
+ "properties": {
+ "title": {
+ "type": "string",
+ "title": "Title",
+ "description": "An optional name of the advisory."
+ },
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "format": "iri-reference",
+ "description": "Location where the advisory can be obtained."
+ }
+ }
+ },
+ "cwe": {
+ "type": "integer",
+ "minimum": 1,
+ "title": "CWE",
+ "description": "Integer representation of a Common Weaknesses
Enumerations (CWE). For example 399 (of
https://cwe.mitre.org/data/definitions/399.html)"
+ },
+ "severity": {
+ "type": "string",
+ "title": "Severity",
+ "description": "Textual representation of the severity of the
vulnerability adopted by the analysis method. If the analysis method uses
values other than what is provided, the user is expected to translate
appropriately.",
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low",
+ "info",
+ "none",
+ "unknown"
+ ]
+ },
+ "scoreMethod": {
+ "type": "string",
+ "title": "Method",
+ "description": "Specifies the severity or risk scoring methodology or
standard used.\n\n* CVSSv2 - [Common Vulnerability Scoring System
v2](https://www.first.org/cvss/v2/)\n* CVSSv3 - [Common Vulnerability Scoring
System v3](https://www.first.org/cvss/v3-0/)\n* CVSSv31 - [Common Vulnerability
Scoring System v3.1](https://www.first.org/cvss/v3-1/)\n* OWASP - [OWASP Risk
Rating
Methodology](https://owasp.org/www-community/OWASP_Risk_Rating_Methodology)",
+ "enum": [
+ "CVSSv2",
+ "CVSSv3",
+ "CVSSv31",
+ "OWASP",
+ "other"
+ ]
+ },
+ "impactAnalysisState": {
+ "type": "string",
+ "title": "Impact Analysis State",
+ "description": "Declares the current state of an occurrence of a
vulnerability, after automated or manual analysis. \n\n* __resolved__ = the
vulnerability has been remediated. \n* __resolved\\_with\\_pedigree__ = the
vulnerability has been remediated and evidence of the changes are provided in
the affected components pedigree containing verifiable commit history and/or
diff(s). \n* __exploitable__ = the vulnerability may be directly or indirectly
exploitable. \n* __in\\_triage__ = [...]
+ "enum": [
+ "resolved",
+ "resolved_with_pedigree",
+ "exploitable",
+ "in_triage",
+ "false_positive",
+ "not_affected"
+ ]
+ },
+ "impactAnalysisJustification": {
+ "type": "string",
+ "title": "Impact Analysis Justification",
+ "description": "The rationale of why the impact analysis state was
asserted. \n\n* __code\\_not\\_present__ = the code has been removed or
tree-shaked. \n* __code\\_not\\_reachable__ = the vulnerable code is not
invoked at runtime. \n* __requires\\_configuration__ = exploitability requires
a configurable option to be set/unset. \n* __requires\\_dependency__ =
exploitability requires a dependency that is not present. \n*
__requires\\_environment__ = exploitability requires a certain [...]
+ "enum": [
+ "code_not_present",
+ "code_not_reachable",
+ "requires_configuration",
+ "requires_dependency",
+ "requires_environment",
+ "protected_by_compiler",
+ "protected_at_runtime",
+ "protected_at_perimeter",
+ "protected_by_mitigating_control"
+ ]
+ },
+ "rating": {
+ "type": "object",
+ "title": "Rating",
+ "description": "Defines the severity or risk ratings of a
vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that calculated the severity or risk
rating of the vulnerability."
+ },
+ "score": {
+ "type": "number",
+ "title": "Score",
+ "description": "The numerical score of the rating."
+ },
+ "severity": {
+ "$ref": "#/definitions/severity",
+ "description": "Textual representation of the severity that
corresponds to the numerical score of the rating."
+ },
+ "method": {
+ "$ref": "#/definitions/scoreMethod"
+ },
+ "vector": {
+ "type": "string",
+ "title": "Vector",
+ "description": "Textual representation of the metric values used to
score the vulnerability"
+ },
+ "justification": {
+ "type": "string",
+ "title": "Justification",
+ "description": "An optional reason for rating the vulnerability as
it was"
+ }
+ }
+ },
+ "vulnerabilitySource": {
+ "type": "object",
+ "title": "Source",
+ "description": "The source of vulnerability information. This is often
the organization that published the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "url": {
+ "type": "string",
+ "title": "URL",
+ "description": "The url of the vulnerability documentation as
provided by the source.",
+ "examples": [
+ "https://nvd.nist.gov/vuln/detail/CVE-2021-39182";
+ ]
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the source.",
+ "examples": [
+ "NVD",
+ "National Vulnerability Database",
+ "OSS Index",
+ "VulnDB",
+ "GitHub Advisories"
+ ]
+ }
+ }
+ },
+ "vulnerability": {
+ "type": "object",
+ "title": "Vulnerability",
+ "description": "Defines a weakness in an component or service that could
be exploited or triggered by a threat source.",
+ "additionalProperties": false,
+ "properties": {
+ "bom-ref": {
+ "$ref": "#/definitions/refType",
+ "title": "BOM Reference",
+ "description": "An optional identifier which can be used to
reference the vulnerability elsewhere in the BOM. Every bom-ref MUST be unique
within the BOM."
+ },
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "The identifier that uniquely identifies the
vulnerability.",
+ "examples": [
+ "CVE-2021-39182",
+ "GHSA-35m5-8cvj-8783",
+ "SNYK-PYTHON-ENROCRYPT-1912876"
+ ]
+ },
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that published the vulnerability."
+ },
+ "references": {
+ "type": "array",
+ "title": "References",
+ "description": "Zero or more pointers to vulnerabilities that are
the equivalent of the vulnerability specified. Often times, the same
vulnerability may exist in multiple sources of vulnerability intelligence, but
have different identifiers. References provide a way to correlate
vulnerabilities across multiple sources of vulnerability intelligence.",
+ "additionalItems": false,
+ "items": {
+ "required": [
+ "id",
+ "source"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string",
+ "title": "ID",
+ "description": "An identifier that uniquely identifies the
vulnerability.",
+ "examples": [
+ "CVE-2021-39182",
+ "GHSA-35m5-8cvj-8783",
+ "SNYK-PYTHON-ENROCRYPT-1912876"
+ ]
+ },
+ "source": {
+ "$ref": "#/definitions/vulnerabilitySource",
+ "description": "The source that published the vulnerability."
+ }
+ }
+ }
+ },
+ "ratings": {
+ "type": "array",
+ "title": "Ratings",
+ "description": "List of vulnerability ratings",
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/rating"
+ }
+ },
+ "cwes": {
+ "type": "array",
+ "title": "CWEs",
+ "description": "List of Common Weaknesses Enumerations (CWEs) codes
that describes this vulnerability. For example 399 (of
https://cwe.mitre.org/data/definitions/399.html)",
+ "examples": [399],
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/cwe"
+ }
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A description of the vulnerability as provided by
the source."
+ },
+ "detail": {
+ "type": "string",
+ "title": "Details",
+ "description": "If available, an in-depth description of the
vulnerability as provided by the source organization. Details often include
examples, proof-of-concepts, and other information useful in understanding root
cause."
+ },
+ "recommendation": {
+ "type": "string",
+ "title": "Details",
+ "description": "Recommendations of how the vulnerability can be
remediated or mitigated."
+ },
+ "advisories": {
+ "type": "array",
+ "title": "Advisories",
+ "description": "Published advisories of the vulnerability if
provided.",
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/advisory"
+ }
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created",
+ "description": "The date and time (timestamp) when the vulnerability
record was created in the vulnerability database."
+ },
+ "published": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Published",
+ "description": "The date and time (timestamp) when the vulnerability
record was first published."
+ },
+ "updated": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Updated",
+ "description": "The date and time (timestamp) when the vulnerability
record was last updated."
+ },
+ "credits": {
+ "type": "object",
+ "title": "Credits",
+ "description": "Individuals or organizations credited with the
discovery of the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "organizations": {
+ "type": "array",
+ "title": "Organizations",
+ "description": "The organizations credited with vulnerability
discovery.",
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/organizationalEntity"
+ }
+ },
+ "individuals": {
+ "type": "array",
+ "title": "Individuals",
+ "description": "The individuals, not associated with
organizations, that are credited with vulnerability discovery.",
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/organizationalContact"
+ }
+ }
+ }
+ },
+ "tools": {
+ "type": "array",
+ "title": "Creation Tools",
+ "description": "The tool(s) used to identify, confirm, or score the
vulnerability.",
+ "additionalItems": false,
+ "items": {"$ref": "#/definitions/tool"}
+ },
+ "analysis": {
+ "type": "object",
+ "title": "Impact Analysis",
+ "description": "An assessment of the impact and exploitability of
the vulnerability.",
+ "additionalProperties": false,
+ "properties": {
+ "state": {
+ "$ref": "#/definitions/impactAnalysisState"
+ },
+ "justification": {
+ "$ref": "#/definitions/impactAnalysisJustification"
+ },
+ "response": {
+ "type": "array",
+ "title": "Response",
+ "description": "A response to the vulnerability by the
manufacturer, supplier, or project responsible for the affected component or
service. More than one response is allowed. Responses are strongly encouraged
for vulnerabilities where the analysis state is exploitable.",
+ "additionalItems": false,
+ "items": {
+ "type": "string",
+ "enum": [
+ "can_not_fix",
+ "will_not_fix",
+ "update",
+ "rollback",
+ "workaround_available"
+ ]
+ }
+ },
+ "detail": {
+ "type": "string",
+ "title": "Detail",
+ "description": "Detailed description of the impact including
methods used during assessment. If a vulnerability is not exploitable, this
field should include specific details on why the component or service is not
impacted by this vulnerability."
+ }
+ }
+ },
+ "affects": {
+ "type": "array",
+ "uniqueItems": true,
+ "additionalItems": false,
+ "items": {
+ "required": [
+ "ref"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "ref": {
+ "$ref": "#/definitions/refType",
+ "title": "Reference",
+ "description": "References a component or service by the
objects bom-ref"
+ },
+ "versions": {
+ "type": "array",
+ "title": "Versions",
+ "description": "Zero or more individual versions or range of
versions.",
+ "additionalItems": false,
+ "items": {
+ "oneOf": [
+ {
+ "required": ["version"]
+ },
+ {
+ "required": ["range"]
+ }
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "version": {
+ "description": "A single version of a component or
service.",
+ "$ref": "#/definitions/version"
+ },
+ "range": {
+ "description": "A version range specified in Package URL
Version Range syntax (vers) which is defined at
https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst";,
+ "$ref": "#/definitions/version"
+ },
+ "status": {
+ "description": "The vulnerability status for the version
or range of versions.",
+ "$ref": "#/definitions/affectedStatus",
+ "default": "affected"
+ }
+ }
+ }
+ }
+ }
+ },
+ "title": "Affects",
+ "description": "The components or services that are affected by the
vulnerability."
+ },
+ "properties": {
+ "type": "array",
+ "title": "Properties",
+ "description": "Provides the ability to document properties in a
name-value store. This provides flexibility to include data not officially
supported in the standard without having to use additional namespaces or create
extensions. Unlike key-value stores, properties support duplicate names, each
potentially having different values. Property names of interest to the general
public are encouraged to be registered in the [CycloneDX Property
Taxonomy](https://github.com/CycloneDX/ [...]
+ "additionalItems": false,
+ "items": {
+ "$ref": "#/definitions/property"
+ }
+ }
+ }
+ },
+ "affectedStatus": {
+ "description": "The vulnerability status of a given version or range of
versions of a product. The statuses 'affected' and 'unaffected' indicate that
the version is affected or unaffected by the vulnerability. The status
'unknown' indicates that it is unknown or unspecified whether the given version
is affected. There can be many reasons for an 'unknown' status, including that
an investigation has not been undertaken or that a vendor has not disclosed the
status.",
+ "type": "string",
+ "enum": [
+ "affected",
+ "unaffected",
+ "unknown"
+ ]
+ },
+ "version": {
+ "description": "A single version of a component or service.",
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "range": {
+ "description": "A version range specified in Package URL Version Range
syntax (vers) which is defined at
https://github.com/package-url/purl-spec/VERSION-RANGE-SPEC.rst";,
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1024
+ },
+ "signature": {
+ "$ref": "jsf-0.82.schema.json#/definitions/signature",
+ "title": "Signature",
+ "description": "Enveloped signature in [JSON Signature Format
(JSF)](https://cyberphone.github.io/doc/security/jsf.html)."
+ }
+ }
+}
diff --git a/plugins/vex/schema/vex-input.schema.json
b/plugins/vex/schema/vex-input.schema.json
new file mode 100644
index 000000000..7790632dc
--- /dev/null
+++ b/plugins/vex/schema/vex-input.schema.json
@@ -0,0 +1,35 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#";,
+ "type": "array",
+ "title": "CycloneDX Software Bill of Materials Standard",
+ "items": {
+ "type": "object",
+ "required": [
+ "ids",
+ "versions",
+ "jars",
+ "analysis"
+ ],
+ "additionalProperties": false,
+ "properties": {
+ "ids": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "jars": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "versions": {
+ "type": "string"
+ },
+ "analysis": {
+ "$ref":
"file:bom-1.4.schema.json#/definitions/vulnerability/properties/analysis"
+ }
+ }
+ }
+}
diff --git a/plugins/vex/vex.py b/plugins/vex/vex.py
new file mode 100644
index 000000000..62a8097c3
--- /dev/null
+++ b/plugins/vex/vex.py
@@ -0,0 +1,70 @@
+import os
+import sys
+import json
+from re import sub
+from uuid import UUID, uuid5
+from hashlib import md5
+from pelican import signals
+from jsonschema import validate
+import jsonref
+
+def pelican_init(pelicanobj):
+ with open('vex-input.json', 'r') as input:
+ vex_input = json.loads(input.read())
+
+ # Our own input format - feel free to change as needed,
+ # but remember to also update this plugin and the templates in
+ # /themes/solr/templates/security.html
+ with open('plugins/vex/schema/vex-input.schema.json', 'r') as file:
+ from pathlib import Path
+ loaded = jsonref.load(file,
base_uri=Path('./plugins/vex/schema/base').absolute().as_uri())
+ validate(vex_input, loaded)
+
+ ns = UUID('4f298c2c-eb7c-4968-a827-1482b1e5c095')
+ ref = str(uuid5(ns, md5(json.dumps(vex_input).encode()).hexdigest()))
+
+ vulns = []
+ for v in vex_input:
+ for id in v['ids']:
+ vulns.append({
+ "id": id,
+ "analysis": v['analysis'],
+ "affects": [
+ {
+ "ref": ref
+ }
+ ]
+ })
+ vex = {
+ # we're not committing to doing exactly what CycloneDX comes
+ # up with, but it seems like one of the promising formats, so
+ # let's align with it as much as possible:
+ "bomFormat": "CycloneDX",
+ "specVersion": "1.4",
+ "version": 1,
+ "metadata": {
+ "component": {
+ "name": "solr",
+ "version": "SNAPSHOT",
+ "type": "application",
+ "bom-ref": ref
+ }
+ },
+ "vulnerabilities": vulns
+ }
+ # From https://github.com/CycloneDX/specification/tree/master/schema
+ with open('plugins/vex/schema/bom-1.4.schema.json', 'r') as schema:
+ validate(vex, json.load(schema))
+
+ os.makedirs('output', exist_ok=True)
+ with open('output/solr.vex.json', 'w') as out:
+ json.dump(vex, out, indent=2)
+
+def generator_initialized(generator):
+ generator.context["vex"] = json.load(open('vex-input.json'))
+ generator.context["sub"] = sub
+
+def register():
+ """Plugin registration"""
+ signals.initialized.connect(pelican_init)
+ signals.generator_init.connect(generator_initialized)
diff --git a/requirements.txt b/requirements.txt
index 75ec2e7a4..814be3809 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,6 +5,9 @@ checksumdir~=1.2.0
# Pelican plugins
mdx-include~=1.4.1
beautifulsoup4~=4.9.3
+# Dependencies of the vex plugin
+jsonschema~=4.17.3
+jsonref~=1.0.1
# Dev tools
invoke~=1.5.0
diff --git a/themes/solr/templates/security.html
b/themes/solr/templates/security.html
index bbb55e9d7..1c465737a 100644
--- a/themes/solr/templates/security.html
+++ b/themes/solr/templates/security.html
@@ -16,6 +16,9 @@
<h1 id="solr-news">Solr<sup>™</sup> Security News<a class="headerlink"
href="#solr-news" title="Permanent link">¶</a></h1>
{{page.content}}
+ <h1 id="recent-cve-reports-for-apache-solr">Recent CVE reports for Apache
Solr</h1>
+ <p>Below is a list of already announced CVE vulnerabilities. These are also
available as an <a href="/feeds/solr/security.atom.xml">ATOM feed</a>:</p>
+
<table>
<tr>
<th width="130">CVE#</th>
@@ -38,5 +41,38 @@
{{article.content}}
<hr/>
{% endfor %}
+ <h1 id="cve-reports-for-apache-solr-dependencies">CVE reports for Apache
Solr dependencies</h1>
+ <p>Below is a list of CVE vulnerabilities in Apache Solr dependencies, and
the state of their applicability to Solr.</p>
+ <p>We are currently experimenting with providing this information in a <a
href="#vex">machine-readable VEX format</a> and encourage you to
participate.</p>
+ <table>
+ <tr>
+ <th>id</th>
+ <th>versions</th>
+ <th>jars</th>
+ <th>state</th>
+ <th>detail</th>
+ </tr>
+ {# CVE's that do affect Solr have their own advisory page above #}
+ {% for v in (vex | selectattr("analysis.state", "ne", "exploitable")) %}
+ <tr>
+ <td>
+ {% for id in v.ids %}
+ {% if id.startswith('CVE') %}<a
href="https://nvd.nist.gov/vuln/detail/{{ id }}">{{ id }}</a>{% else %}{{ id
}}{% endif %}
+ {%- if not loop.last %}, {% endif %}
+ {% endfor %}
+ </td>
+ <td>
+ {{ v.versions }}
+ </td>
+ <td>
+ {% for jar in v.jars %}
+ {{ jar }}{% if not loop.last %}, {% endif %}
+ {% endfor %}
+ </td>
+ <td>{{ v.analysis.state.replace('_', ' ') }}</td>
+ <td>{{ sub("(https://.*?)([.;]\s)", "<a href=\"\\1\">\\1</a>\\2",
v.analysis.detail) }}</td>
+ </tr>
+ {% endfor %}
+ </table>
</div>
{% endblock content_inner %}
diff --git a/vex-input.json b/vex-input.json
new file mode 100644
index 000000000..9e829d82c
--- /dev/null
+++ b/vex-input.json
@@ -0,0 +1,469 @@
+[
+ {
+ "ids": [
+ "CVE-2022-33980"
+ ],
+ "versions": "< 9.1",
+ "jars": [
+ "commons-configuration2-2.7.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Solr uses commons-configuration2 for \"hadoop-auth\" only
(for Kerberos). It is only used for loading Hadoop configuration files that
would only ever be provided by trusted administrators, not externally
(untrusted)."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2022-42889"
+ ],
+ "versions": "< 9.1",
+ "jars": [
+ "commons-text-1.9.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Solr uses commons-text directly
(StringEscapeUtils.escapeEcmaScript) in LoadAdminUiServlet that is not
vulnerable. Solr also has a \"hadoop-auth\" module that uses Apache Hadoop
which uses commons-text through commons-configuration2. For Solr, the concern
is limited to loading Hadoop configuration files that would only ever be
provided by trusted administrators, not externally (untrusted)."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2022-25168"
+ ],
+ "versions": "< 9.1",
+ "jars": [
+ "hadoop-common-3.2.2.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "The vulnerable code won't be used by Solr because Solr only
is only using HDFS as a client."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2021-44832"
+ ],
+ "versions": "7.4-8.11.1",
+ "jars": [
+ "log4j-core-2.14.1.jar",
+ "log4j-core-2.16.0.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Solr's default log configuration doesn't use JDBCAppender and
we don't imagine a user would want to use it or other obscure appenders."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2021-45105",
+ "CVE-2021-45046"
+ ],
+ "versions": "7.4-8.11.1",
+ "jars": [
+ "log4j-core-2.14.1.jar",
+ "log4j-core-2.16.0.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "The MDC data used by Solr are for the collection, shard,
replica, core and node names, and a potential trace id, which are all
sanitized. Furthermore, Solr's default log configuration doesn't use
double-dollar-sign and we don't imagine a user would want to do that."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2020-13955"
+ ],
+ "versions": "8.1.0- today",
+ "jars": [
+ "avatica-core-1.13.0.jar",
+ "calcite-core-1.18.0.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Solr's SQL adapter does not use the vulnerable class
\"HttpUtils\". Calcite only used it to talk to Druid or Splunk."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2018-10237"
+ ],
+ "versions": "5.4.0-today",
+ "jars": [
+ "carrot2-guava-18.0.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Only used with the Carrot2 clustering engine."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2014-0114"
+ ],
+ "versions": "4.9.0-7.5.0",
+ "jars": [
+ "commons-beanutils-1.8.3.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "This is only used at compile time and it cannot be used to
attack Solr. Since it is generally unnecessary, the dependency has been removed
as of 7.5.0. See SOLR-12617."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2019-10086"
+ ],
+ "versions": "8.0.0-8.3.0",
+ "jars": [
+ "commons-beanutils-1.9.3.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "While commons-beanutils was removed in 7.5, it was added back
in 8.0 in error and removed again in 8.3. The vulnerable class was not used in
any Solr code path. This jar remains a dependency of both Velocity and
hadoop-common, but Solr does not use it in our implementations."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2012-2098",
+ "CVE-2018-1324",
+ "CVE-2018-11771"
+ ],
+ "versions": "4.6.0-today",
+ "jars": [
+ "commons-compress (only as part of Ant 1.8.2)"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Only used in test framework and at build time."
+ }
+ },
+ {
+ "ids": [
+ "CVE-"
+ ],
+ "versions": "4.6.0-today",
+ "jars": [
+ "derby-10.9.1.0.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Used only in DataImportHandler tests and example
implementation, which should not be used in production."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2018-1000632"
+ ],
+ "versions": "4.6.0-today",
+ "jars": [
+ "dom4j-1.6.1.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Only used in Solr tests."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2018-10237"
+ ],
+ "versions": "4.6.0-today",
+ "jars": [
+ "guava-*.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Only used in tests."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2017-15718"
+ ],
+ "versions": "6.6.1-7.6.0",
+ "jars": [
+ "hadoop-auth-2.7.4.jar",
+ "hadoop-hdfs-2.7.4.jar (all Hadoop)"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Does not impact Solr because Solr uses Hadoop as a client
library."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2017-14952"
+ ],
+ "versions": "6.0.0-7.5.0",
+ "jars": [
+ "icu4j-56.1.jar",
+ "icu4j-59.1.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Issue applies only to the C++ release of ICU and not ICU4J,
which is what Lucene uses. ICU4J is at v63.2 as of Lucene/Solr 7.6.0"
+ }
+ },
+ {
+ "ids": [
+ "CVE-2017-15095",
+ "CVE-2017-17485",
+ "CVE-2017-7525",
+ "CVE-2018-5968",
+ "CVE-2018-7489",
+ "CVE-2019-12086",
+ "CVE-2019-12384",
+ "CVE-2018-12814",
+ "CVE-2019-14379",
+ "CVE-2019-14439",
+ "CVE-2020-35490",
+ "CVE-2020-35491",
+ "CVE-2021-20190",
+ "CVE-2019-14540",
+ "CVE-2019-16335"
+ ],
+ "versions": "4.7.0-today",
+ "jars": [
+ "jackson-databind-*.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "These CVEs, and most of the known jackson-databind CVEs since
2017, are all related to problematic 'gadgets' that could be exploited during
deserialization of untrusted data. The Jackson developers described 4
conditions that must be met in order for a problematic gadget to be exploited.
See
https://medium.com/@cowtowncoder/on-jackson-cves-dont-panic-here-is-what-you-need-to-know-54cd0d6e8062.
Solr's use of jackson-databind does not meet 1 of the 4 conditions described w
[...]
+ }
+ },
+ {
+ "ids": [
+ "CVE-2019-10241",
+ "CVE-2019-10247"
+ ],
+ "versions": "7.7.0-8.2",
+ "jars": [
+ "jetty-9.4.14"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Solr upgraded to Jetty 9.4.19 for the 8.2 release.
Additionally, the path to exploit these vulnerabilities was fixed in 8.1 and
7.7.2. Earlier versions can manually patch their configurations as described in
SOLR-13409."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2020-27218"
+ ],
+ "versions": "7.3.0-8.8.0",
+ "jars": [
+ "jetty-9.4.0 to 9.4.34"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Only exploitable through use of Jetty's GzipHandler, which is
only implemented in Embedded Solr Server."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2020-27223"
+ ],
+ "versions": "7.3.0-present",
+ "jars": [
+ "jetty-9.4.6 to 9.4.36"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Only exploitable if Solr's webapp directory is deployed as a
symlink, which is not Solr's default."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2021-33813"
+ ],
+ "versions": "to present",
+ "jars": [
+ "jdom-*.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "JDOM is only used in Solr Cell, which should not be used in
production which makes the vulnerability unexploitable. It is a dependency of
Apache Tika, which has analyzed the issue and determined the vulnerability is
limited to two libraries not commonly used in search applications, see
TIKA-3488 for details. Since Tika should be used outside of Solr, use a version
of Tika which updates the affected libraries if concerned about exposure to
this issue."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2018-1000056"
+ ],
+ "versions": "4.6.0-7.6.0",
+ "jars": [
+ "junit-4.10.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "JUnit only used in tests; CVE only refers to a Jenkins plugin
not used by Solr."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2014-7940",
+ "CVE-2016-6293",
+ "CVE-2016-7415",
+ "CVE-2017-14952",
+ "CVE-2017-17484",
+ "CVE-2017-7867",
+ "CVE-2017-7868"
+ ],
+ "versions": "7.3.1",
+ "jars": [
+ "lucene-analyzers-icu-7.3.1.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "All of these issues apply to the C++ release of ICU and not
ICU4J, which is what Lucene uses."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2019-16869"
+ ],
+ "versions": "8.2-8.3",
+ "jars": [
+ "netty-all-4.1.29.Final.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "This is not included in Solr but is a dependency of ZooKeeper
3.5.5. The version was upgraded in ZooKeeper 3.5.6, included with Solr 8.3. The
specific classes mentioned in the CVE are not used in Solr (nor in ZooKeeper as
far as the Solr community can determine)."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2017-14868",
+ "CVE-2017-14949"
+ ],
+ "versions": "5.2.0-today",
+ "jars": [
+ "org.restlet-2.3.0.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Solr should not be exposed outside a firewall where bad
actors can send HTTP requests. These two CVEs specifically involve classes
(SimpleXMLProvider and XmlRepresentation, respectively) that Solr does not use
in any code path."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2015-5237"
+ ],
+ "versions": "6.5.0-today",
+ "jars": [
+ "protobuf-java-3.1.0.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Dependency for Hadoop and Calcite. ??"
+ }
+ },
+ {
+ "ids": [
+ "CVE-2018-1471"
+ ],
+ "versions": "5.4.0-7.7.2, 8.0-8.3",
+ "jars": [
+ "simple-xml-2.7.1.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Dependency of Carrot2 and used during compilation, not at
runtime (see SOLR-769. This .jar was replaced in Solr 8.3 and backported to
7.7.3 (see SOLR-13779)."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2018-8088"
+ ],
+ "versions": "4.x-today",
+ "jars": [
+ "slf4j-api-1.7.24.jar",
+ "jcl-over-slf4j-1.7.24.jar",
+ "jul-to-slf4j-1.7.24.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "The reported CVE impacts org.slf4j.ext.EventData, which is
not used in Solr."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2018-1335"
+ ],
+ "versions": "7.3.1-7.5.0",
+ "jars": [
+ "tika-core.1.17.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Solr does not run tika-server, so this is not a problem."
+ }
+ },
+ {
+ "ids": [
+ "CVE-"
+ ],
+ "versions": "7.3.1-today",
+ "jars": [
+ "tika-core.*.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "All Tika issues that could be Solr vulnerabilities would only
be exploitable if untrusted files are indexed with SolrCell. This is not
recommended in production systems, so Solr does not consider these valid CVEs
for Solr."
+ }
+ },
+ {
+ "ids": [
+ "CVE-"
+ ],
+ "versions": "6.6.2-today",
+ "jars": [
+ "velocity-tools-2.0.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Solr does not ship a Struts jar. This is a transitive POM
listing and not included with Solr (see comment in SOLR-2849)."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2016-6809",
+ "CVE-2018-1335",
+ "CVE-2018-1338",
+ "CVE-2018-1339"
+ ],
+ "versions": "5.5.5, 6.2.0-today",
+ "jars": [
+ "vorbis-java-tika-0.8.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "See https://github.com/Gagravarr/VorbisJava/issues/30;
reported CVEs are not related to OggVorbis at all."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2012-0881"
+ ],
+ "versions": "~2.9-today",
+ "jars": [
+ "xercesImpl-2.9.1.jar"
+ ],
+ "analysis": {
+ "state": "not_affected",
+ "detail": "Only used in Lucene Benchmarks and Solr tests."
+ }
+ },
+ {
+ "ids": [
+ "CVE-2022-39135"
+ ],
+ "versions": "6.5-8.11.2, 9.0",
+ "jars": [
+ "calcite-1.31.0.jar"
+ ],
+ "analysis": {
+ "state": "exploitable",
+ "response": [
+ "update"
+ ],
+ "detail": "Apache Calcite has a vulnerability, CVE-2022-39135, that is
exploitable in Apache Solr in SolrCloud mode. If an untrusted user can supply
SQL queries to Solr's '/sql' handler (even indirectly via proxies / other
apps), then the user could perform an XML External Entity (XXE) attack. This
might have been exposed by some deployers of Solr in order for internal
analysts to use JDBC based tooling, but would have unlikely been granted to
wider audiences."
+ }
+ }
+]
