Skip to content

Commit 4285e95

Browse files
ms-jcorleytraskopentelemetrybottheletterf
authored
Update Security Response to match new SecSIG documentation (#7235)
Co-authored-by: Trask Stalnaker <[email protected]> Co-authored-by: opentelemetrybot <[email protected]> Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
1 parent 0287859 commit 4285e95

File tree

2 files changed

+52
-107
lines changed

2 files changed

+52
-107
lines changed

content/en/docs/security/security-response.md

Lines changed: 48 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,9 @@ Security vulnerabilities should be handled quickly and sometimes privately. The
77
primary goal of this process is to reduce the total time users are vulnerable to
88
publicly known exploits.
99

10-
The
11-
[OpenTelemetry Technical Committee (OTel TC)](https://github.com/open-telemetry/community/blob/main/tech-committee-charter.md)
12-
and relevant repository maintainers, supported by tooling provided by the
13-
[SIG Security](https://github.com/open-telemetry/sig-security), are responsible
14-
for responding to the incident organizing the entire response including internal
15-
communication and external disclosure.
10+
The relevant OpenTelemetry repository maintainers, supported by the Security SIG
11+
and OpenTelemetry Technical Committee (TC), are responsible for responding to
12+
the incident including internal communication and external disclosure.
1613

1714
## Supported Versions
1815

@@ -25,113 +22,57 @@ branch at the moment of the release. For instance, if the latest version is
2522

2623
Security fixes are given priority and might be enough to cause a new version to
2724
be released. Each repository is entitled to establish their own complementary
28-
processes. SIG Security in conjunction with the TC can advise in case
25+
processes. The Security SIG in conjunction with the TC can advise in case
2926
clarifications are required.
3027

31-
## Disclosures
28+
## Reporting Process - For Vulnerability Reporters
3229

33-
### Private Disclosure Processes
30+
### Reporting Methods
3431

3532
In order for the vulnerability reports to reach maintainers as soon as possible,
3633
the preferred way is to use the `Report a vulnerability` button on the
3734
`Security` tab in the respective GitHub repository. It creates a private
3835
communication channel between the reporter and the maintainers.
3936

40-
If you are absolutely unable to or have strong reasons not to use GitHub
41-
reporting workflow, please reach out to the Technical Committee using
42-
43-
and we will provide instruction on how to report the vulnerability using an
44-
encrypted message, if desired.
45-
46-
### Public Disclosure Processes
47-
48-
If you know of a publicly disclosed security vulnerability please IMMEDIATELY
49-
email
50-
51-
to inform the Security Response Committee (SRC) about the vulnerability so they
52-
may start the patch, release, and communication process. Please include any
53-
relevant information about current public exploitations of this vulnerability if
54-
known to help with scoring and prioritization.
55-
56-
The TC should receive the message and re-direct it to the relevant repository
57-
maintainers for ownership. If possible the repository maintainers will engage
58-
and ask the person making the public report if the issue can be handled via a
59-
private disclosure process. If the reporter denies the request, the repository
60-
maintainers will move swiftly with the fix and release process. In extreme cases
61-
you can ask GitHub to delete the issue but this generally isn't necessary and is
62-
unlikely to make a public disclosure less damaging.
63-
64-
## Patch, Release, and Public Communication
65-
66-
### Fix Team Organization
67-
68-
The Fix Team is made up of people with the following roles:
69-
70-
- Incident commander, the person who manages the communication around the
71-
incident.
72-
- Incident investigator(s), typically one or more maintainers of the affected
73-
repositories.
74-
- Subject matter experts, typically includes the reporter and other
75-
contributors, such as the code owners for the affected components or
76-
repository approvers who provide prompt code reviews for the proposed fixes.
77-
- Other stakeholders, such as other SIGs that might need to consume the fix.
78-
79-
### TC Role
80-
81-
- A member of the TC will need to review the proposed CVSS score and severity
82-
from the Fix Team
83-
- Acknowledge when a proposed fix is completed
84-
85-
### Fix Development Process
86-
87-
All of the timelines below are suggestions that assume a Private Disclosure and
88-
that the report is accepted as valid.
89-
90-
#### Initial Incident Response
91-
92-
- The TC is notified of an incident and the relevant repository maintainers are
93-
added automatically using a Zapier workflow as the Fix Team to the issue.
94-
- The Fix Team acknowledges the incident to the reporter, asks for further
95-
details if necessary, and begins mitigation planning.
96-
- The Fix Team confirms with the reporter if the incident is valid and requires
97-
a fix.
98-
- The Fix Team creates a temporary private branch to start work on the fix.
99-
- The Fix Team will create a
100-
[CVSS](https://www.first.org/cvss/specification-document) Base score using the
101-
[CVSS Calculator](https://www.first.org/cvss/calculator/3.1) and ping the TC
102-
GitHub team, `@open-telemetry/technical-committee` for confirmation.
103-
- The Fix Team will request a CVE from GitHub and follow up with the reporter.
104-
- The Fix Team publishes the CVE to the GitHub Security Advisory Database for
105-
user notification.
106-
107-
#### Incident Mitigation
108-
109-
The incident mitigation timeline depends on the severity of the incident and
110-
repository release cadence.
111-
112-
- The Fix Team will ping
113-
[@open-telemetry/technical-committee](https://github.com/orgs/open-telemetry/teams/technical-committee)
114-
to alert them that work on the fix branch is complete once there are LGTMs on
115-
all commits in the temporary private fork created for the GitHub Security
116-
Advisory.
117-
- The updated version is released with the fix.
118-
- The incident is published to the GitHub Security Advisory Database and
119-
affected users are automatically notified using GitHub security alerts.
120-
121-
### Fix Disclosure Process
122-
123-
OTel relies on GitHub tooling to notify the affected repositories and publish a
124-
security advisory. GitHub will publish the CVE to the CVE List, broadcast the
125-
Security Advisory via the GitHub Advisory Database, and send security alerts to
126-
all repositories that use the package and have alerts on. The CVE will also be
127-
added to the [OTel website's CVE feed](../cve/).
128-
129-
#### Fix Release Day
130-
131-
The Fix Team as repository owners will release an updated version and optionally
132-
notify their communities via Slack.
133-
134-
## Severity
135-
136-
The Fix Team evaluates vulnerability severity on a case-by-case basis, guided by
137-
CVSS 3.1 and is subject to TC review.
37+
If you are unable to or have strong reasons not to use the GitHub reporting
38+
workflow, please reach out to
39+
40+
provide instruction on how to report the vulnerability.
41+
42+
Reports should be acknowledged within 3 working days.
43+
44+
**Please avoid reporting any vulnerabilities as a generic public "Issue" in
45+
GitHub.**
46+
47+
Given the public visibility of GitHub issues, reporting a vulnerability as a
48+
GitHub issue would be public disclosure. If this is done accidentally or if you
49+
notice a vulnerability reported this way, please immediately re-report the
50+
vulnerability using "Report a vulnerability" and note the public disclosure as
51+
part of that report. You can ask GitHub to delete the issue but this shouldn't
52+
be considered a sufficient mitigation and the vulnerability should be considered
53+
publicly disclosed.
54+
55+
### Non-Public Vulnerabilities
56+
57+
If a vulnerability appears to be not publicly known or disclosed, the repository
58+
maintainers will engage and the reporter is requested to honor an embargo period
59+
in which the vulnerability is keep private until a fix can be released and
60+
disclosed in an orderly manner. If the reporter has a need to disclose the
61+
vulnerability further, perhaps for a security conference or other obligation,
62+
they are asked to negotiate the disclosure date with the maintainers fixing the
63+
vulnerability. The repository maintainers will in any case do their best to move
64+
swiftly with the fix and release process.
65+
66+
### Publicly Known Vulnerabilities
67+
68+
If you discover an unreported publicly disclosed/known vulnerability please
69+
IMMEDIATELY use the reporting methods above to inform the team about the
70+
vulnerability so they may start the patch, release and communication process.
71+
Please include any relevant information about current public exploitations of
72+
this vulnerability, if known, to help with scoring and prioritization.
73+
74+
## More Information
75+
76+
For more information, please see the
77+
[Security SIG documentation](https://github.com/open-telemetry/sig-security/blob/main/security-response.md)
78+
on GitHub.

static/refcache.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13747,6 +13747,10 @@
1374713747
"StatusCode": 206,
1374813748
"LastSeen": "2025-01-30T16:54:01.460623-05:00"
1374913749
},
13750+
"https://github.com/open-telemetry/sig-security/blob/main/security-response.md": {
13751+
"StatusCode": 206,
13752+
"LastSeen": "2025-07-01T06:08:12.561678305Z"
13753+
},
1375013754
"https://github.com/open-telemetry/weaver": {
1375113755
"StatusCode": 206,
1375213756
"LastSeen": "2025-01-17T20:08:32.827234548Z"

0 commit comments

Comments
 (0)