docs: Improve formatting and content of KCSA document

Various improvements to the KCSA document including:

- Add "Date" (of announcement) and "Affected Versions" columns to table.
- Sort table rows by date.
- Add section showing how to determine which version of Kata you are using.
- Add section with references to upgrading doc if you are affected by a KCSA.
- Add table of contents.

Fixes: #189.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt
2020-11-20 09:45:08 +00:00
parent febac8c37e
commit 9aa5ebdb0f

View File

@@ -1,14 +1,35 @@
# Kata Containers Security Advisories
This page lists all previously published Kata Containers Security Advisories (KCSA)
* [Kata Containers Security Advisories](#kata-containers-security-advisories)
* [KCSA summary](#kcsa-summary)
* [Determine Kata Containers version](#determine-kata-containers-version)
* [Upgrade](#upgrade)
This table is in reverse date order.
## KCSA summary
| KCSA | Description |
| -------------------------------------------------- | ---------------------------- |
| [KCSA-CVE-2020-28914](KCSA/KCSA-CVE-2020-28914.md) | Improper file permissions for read-only volumes |
| [KCSA-CVE-2020-2023](KCSA/KCSA-CVE-2020-2023.md) | Execution with Unnecessary Privileges |
| [KCSA-CVE-2020-2026](KCSA/KCSA-CVE-2020-2026.md) | Improper Link Resolution Before File Access |
| [KCSA-CVE-2020-2024](KCSA/KCSA-CVE-2020-2024.md) | improper link resolution vulnerability |
| [KCSA-CVE-2020-2025](KCSA/KCSA-CVE-2020-2025.md) | Cloud Hypervisor guest image persists vulnerability |
| [KCSA-CVE-2019-5736](KCSA/KCSA-CVE-2019-5736.md) | runc container breakout |
This table lists all previously published Kata Containers Security Advisories ([KCSA]'s), newest first:
| Date | [KCSA] | Affected Versions | Description |
| ---------- | -------------------------------------------------- | ------------------ | --------------------------------------------------- |
| 2020-11-17 | [KCSA-CVE-2020-28914](KCSA/KCSA-CVE-2020-28914.md) | < 1.11.5 | Improper file permissions for read-only volumes |
| 2020-06-12 | [KCSA-CVE-2020-2026](KCSA/KCSA-CVE-2020-2026.md) | < 1.10.5, < 1.11.1 | Improper link resolution before file access |
| 2020-06-12 | [KCSA-CVE-2020-2023](KCSA/KCSA-CVE-2020-2023.md) | < 1.11.1 | Execution with unnecessary privileges |
| 2020-05-28 | [KCSA-CVE-2020-2025](KCSA/KCSA-CVE-2020-2025.md) | < 1.11.0 | Cloud Hypervisor guest image persists vulnerability |
| 2020-05-28 | [KCSA-CVE-2020-2024](KCSA/KCSA-CVE-2020-2024.md) | < 1.11.0 | Improper link resolution vulnerability |
| 2019-02-22 | [KCSA-CVE-2019-5736](KCSA/KCSA-CVE-2019-5736.md) | *not applicable* | `runc` container breakout |
## Determine Kata Containers version
To determine which version of Kata Containers you are running, see the
[upgrading document](https://github.com/kata-containers/kata-containers/blob/2.0-dev/docs/Upgrading.md#determine-current-version).
## Upgrade
If you are running a version of Kata Containers affected by one or more [KCSA]'s,
you are strongly encouraged to upgrade as soon as possible:
- [Kata 1.x upgrading document](https://github.com/kata-containers/documentation/blob/master/Upgrading.md)
- [Kata 2.x upgrading document](https://github.com/kata-containers/kata-containers/blob/2.0-dev/docs/Upgrading.md)
[KCSA]: https://github.com/kata-containers/community/blob/master/VMT/VMT.md#acronyms