chore: update security docs to mention release frequency and srus - #7013
chore: update security docs to mention release frequency and srus#7013blackboxsw wants to merge 8 commits into
Conversation
|
|
||
| ## Supported versions | ||
|
|
||
| Cloud-init upstream creates [4 time-based releases per year](https://github.com/canonical/cloud-init/milestones). |
There was a problem hiding this comment.
Is this important to document? It wasn't true last year, maybe we just don't need it.
There was a problem hiding this comment.
consolidated this statement and link into the following sentence
Also correct release schedule link
f5b9ba1 to
8fd50b7
Compare
| [latest Ubuntu interim release and the two most recent Ubuntu LTS releases](https://ubuntu.com/about/release-cycle) to | ||
| ensure security bug fixes are published to stable Ubuntu LTS releases. |
There was a problem hiding this comment.
time-based
The word "scheduled" seems more natural here.
is published to the ... Ubuntu ... release
It seems imprecise to say that a cloud-init release is published to an Ubuntu release.
to
ensure security bug fixes are published to stable Ubuntu LTS releases.
I disagree.
There was a problem hiding this comment.
Replaced scheduled, s/published/included
Each cloud-init scheduled upstream release is provided as updates to the latest Ubuntu interim release and the two most recent Ubuntu LTS releases to ensure common behavior of cloud-init on all Ubuntu standard security maintenance releases.
| [latest Ubuntu interim release and the two most recent Ubuntu LTS releases](https://ubuntu.com/about/release-cycle) to | ||
| ensure security bug fixes are published to stable Ubuntu LTS releases. | ||
|
|
||
| If a CVE is of critical CVSS severity and affects older Ubuntu LTS releases, it will be backported to the specific release. |
There was a problem hiding this comment.
critical
Why only critical? Is this some Ubuntu-wide policy?
and affects older Ubuntu LTS releases, it will be backported to the specific release.
Are you sure? This statement is unbounded.
There was a problem hiding this comment.
I should have listed High in there too. Ubuntu ESM CVE policy. Updated critical and high
Updated the statement:
CVEs of critical or high CVSS severity will be backported to all LTS releases and the two most recent ESM releases supported under Ubuntu Pro.
There was a problem hiding this comment.
What happens if the Ubuntu ESM CVE policy changes? Why not just link to it rather than copying it?
There was a problem hiding this comment.
Changed to lnk direcly to the ESM CVE policy doc. If it changes, our policy changes. I was thinking cloud-init may have a slightly limited view of this policy for very old ESM series to limit support exposure. But, looking at our internal CVE-related bug fixes on older cloud-init series as a guideline, the maintenance isn't currently something that is cause for concern.
|
|
||
| ## Supported versions | ||
|
|
||
| Each [cloud-init scheduled upstream release](https://github.com/canonical/cloud-init/milestones) is provided as updates to the [latest Ubuntu interim release and the two most recent Ubuntu LTS releases](https://ubuntu.com/about/release-cycle) to ensure common behavior of cloud-init on all Ubuntu standard security maintenance releases. |
There was a problem hiding this comment.
This is really long, and I can easily interpret this multiple ways. Can we trim this and be more precise?
| Each [cloud-init upstream release](https://github.com/canonical/cloud-init/milestones) is published to the | ||
| [Ubuntu interim release and the two most recent Ubuntu LTS releases](https://ubuntu.com/about/release-cycle) to ensure stable cloud-init behavior on recent releases. |
There was a problem hiding this comment.
This still seems confused. Without knowing what an Ubuntu interim release is, this would be confusing to read.
Also, this file is an upstream document - why is Ubuntu-specific showing up here?
There was a problem hiding this comment.
Ubuntu shows up here in a security context because additional work is performed by the upstream project to ensure that CVE's are properly mitigated in a known Ubuntu downstreams. Since upstream also documents the cloud-init Ubuntu SRU policy, I have simplified this text further and pointed to cloud-init stable_release_updates as well as scoping this security section to # Downstream supported versions. If other downstreams want to represent their treatment of security vulnerabilities I think this is reasonable place to document such treatment or cross link from.
| To ensure the available security fixes are applied to you VMs images upon | ||
| launch, it is recommended by `Ubuntu security team guidelines`_ to update | ||
| the packages | ||
| To ensure the available security fixes are applied to images at launch, | ||
| it is recommended by `Ubuntu security team guidelines`_ to update the packages | ||
|
|
||
| .. note:: | ||
|
|
||
| Ubuntu cloud images are configured by default to enable unattended-upgrades, | ||
| thus this is resolved this issue when the update gets triggered. One can | ||
| still apply this recommendation to cloud that gap and update the packages | ||
| on first boot. | ||
| Ubuntu cloud images enable unattended-upgrades by default, so this issue | ||
| resolves automatically as daily scheduled upgrades run. For images without | ||
| automated upgrades, follow this recommendation to update packages on first boot. |
There was a problem hiding this comment.
This appears self-contradictory. This first paragraph says that the Ubuntu security team guidelines recommend updating packages. The second paragraph says that Ubuntu cloud images don't need to be updated since that happens automatically.
Something like this would be more straightfoward.
Some cloud images (such as Ubuntu) are configured to automatically receive the latest security updates. Other images should use cloud-init to update packages on first boot.
There was a problem hiding this comment.
Good suggestion, unattended-upgrades is a distro-specific implementation detail. I have applied your suggestion.
blackboxsw
left a comment
There was a problem hiding this comment.
Thank you for this thoughtful review. I have updated both docs
| Each [cloud-init upstream release](https://github.com/canonical/cloud-init/milestones) is published to the | ||
| [Ubuntu interim release and the two most recent Ubuntu LTS releases](https://ubuntu.com/about/release-cycle) to ensure stable cloud-init behavior on recent releases. |
There was a problem hiding this comment.
Ubuntu shows up here in a security context because additional work is performed by the upstream project to ensure that CVE's are properly mitigated in a known Ubuntu downstreams. Since upstream also documents the cloud-init Ubuntu SRU policy, I have simplified this text further and pointed to cloud-init stable_release_updates as well as scoping this security section to # Downstream supported versions. If other downstreams want to represent their treatment of security vulnerabilities I think this is reasonable place to document such treatment or cross link from.
| To ensure the available security fixes are applied to you VMs images upon | ||
| launch, it is recommended by `Ubuntu security team guidelines`_ to update | ||
| the packages | ||
| To ensure the available security fixes are applied to images at launch, | ||
| it is recommended by `Ubuntu security team guidelines`_ to update the packages | ||
|
|
||
| .. note:: | ||
|
|
||
| Ubuntu cloud images are configured by default to enable unattended-upgrades, | ||
| thus this is resolved this issue when the update gets triggered. One can | ||
| still apply this recommendation to cloud that gap and update the packages | ||
| on first boot. | ||
| Ubuntu cloud images enable unattended-upgrades by default, so this issue | ||
| resolves automatically as daily scheduled upgrades run. For images without | ||
| automated upgrades, follow this recommendation to update packages on first boot. |
There was a problem hiding this comment.
Good suggestion, unattended-upgrades is a distro-specific implementation detail. I have applied your suggestion.
| To ensure the available security fixes are applied to you VMs images upon | ||
| launch, it is recommended by `Ubuntu security team guidelines`_ to update | ||
| the packages | ||
| To ensure the available security fixes are applied to images at launch, | ||
| it is recommended by `Ubuntu security team guidelines`_ to update the packages | ||
|
|
||
| .. note:: | ||
|
|
||
| Ubuntu cloud images are configured by default to enable unattended-upgrades, | ||
| thus this is resolved this issue when the update gets triggered. One can | ||
| still apply this recommendation to cloud that gap and update the packages | ||
| on first boot. | ||
| Ubuntu cloud images enable unattended-upgrades by default, so this issue | ||
| resolves automatically as daily scheduled upgrades run. For images without | ||
| automated upgrades, follow this recommendation to update packages on first boot. |
| mitigations and where to obtain the fix | ||
| * An announcement is made to [GitHub Discussions](https://github.com/canonical/cloud-init/discussions) | ||
|
|
||
| ## Downstream supported versions |
There was a problem hiding this comment.
What does "Downstream supported versions" mean in the context of a SECURITY.md?
There was a problem hiding this comment.
Maybe a more appropriate title would be Downstream security patches, Downstream vulnerability resolution or Supported downstream security updates?
The context is that I want upstream to represent how some downstreams handle CVE vulnerability resolution so we can point to it when community has questions about how Ubuntu or others deal with security vulnerabilities in cloud-init in a given distribution.
There was a problem hiding this comment.
I've retitled this Downstream CVE mitigation and moved the majority of the content into a specific section of ubuntu_stable_release_updates page.
The reason I felt downstreams should be represented here is to capture some of the supplemental, security-scoped work that is represented by downstreams from the single SECURITY.md page. It ensures that security-focused readers are aware of various downstream efforts or policies related to treatment of cloud-init CVEs.
|
|
||
| ## Downstream supported versions | ||
|
|
||
| [Ubuntu ESM CVE policy](https://ubuntu.com/security/cves/about) is followed to determine when to backport CVEs to [Ubuntu SRU supported releases](https://docs.cloud-init.io/en/latest/reference/ubuntu_stable_release_updates.html). |
There was a problem hiding this comment.
to determine when to backport CVEs
I really hope that we aren't backporting CVEs.
There was a problem hiding this comment.
True. We are resolving CVEs when they affect stable supported releases. updated text.
Proposed Commit Message
Additional Context
Test Steps
Merge type