Skip to content

Commit 8f1896b

Browse files
greg-ferrlubos
authored andcommitted
doc: security: components version matrix
Added a table mapping security component versions to the nRF Connect SDK releases. NCSDK-35652. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent 6e6caae commit 8f1896b

File tree

4 files changed

+89
-1
lines changed

4 files changed

+89
-1
lines changed

doc/nrf/links.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@
7070
.. _`MCUboot Kconfig option documentation`: https://github.com/nrfconnect/sdk-nrf/blob/main/modules/mcuboot/boot/zephyr/Kconfig#L27C11-L27C12
7171

7272
.. _`sdk-mbedtls`: https://github.com/nrfconnect/sdk-mbedtls
73-
.. _`Arm Mbed TLS project`: https://github.com/ARMmbed/mbedtls
73+
.. _`official Mbed TLS releases`: https://github.com/Mbed-TLS/mbedtls/releases
74+
.. _`Arm Mbed TLS project`: https://github.com/Mbed-TLS/mbedtls
7475

7576
.. _`nrfconnect GitHub organization`: https://github.com/nrfconnect
7677
.. _`sdk-nrf`: https://github.com/nrfconnect/sdk-nrf
@@ -1894,6 +1895,8 @@
18941895

18951896
.. _`NX3215SA-32.768K-STD-MUA-9 datasheet`: https://www.ndk.com/en/products/upload/lineup/pdf/NDKX01-00001_en.pdf
18961897

1898+
.. _`official TF-M releases`: https://trustedfirmware-m.readthedocs.io/en/latest/releases/index.html
1899+
18971900
.. ### Temp: nRF54H and nRF54L related links, repositories, and documents
18981901

18991902
.. _`nrf-regtool`: https://github.com/nrfconnect/nrf-regtool/

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,8 @@ Security
137137

138138
* Support for AES in counter mode using CRACEN for the :zephyr:board:`nrf54lm20dk`.
139139

140+
* Updated the :ref:`security_index` page with a table that lists the versions of security components implemented in the |NCS|.
141+
140142
Protocols
141143
=========
142144

@@ -846,6 +848,7 @@ Trusted Firmware-M
846848
nRF54L05 does not support TF-M.
847849
nRF54L10 supports TF-M experimentally.
848850

851+
849852
Documentation
850853
=============
851854

doc/nrf/security.rst

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,79 @@ Security
77
This section provides an overview of core security features available in Nordic Semiconductor products.
88
The features are made available either as built-ins in modules, drivers, and subsystems, or are shown in samples or applications in |NCS|.
99

10+
.. security_components_ver_table_start
11+
12+
The |NCS| |release| allows you to develop applications with the following versions of security components:
13+
14+
.. list-table:: |NCS|, TF-M, and Mbed TLS versions
15+
:header-rows: 1
16+
:widths: auto
17+
18+
* - |NCS| release
19+
- TF-M version
20+
- Mbed TLS version
21+
* - |release|
22+
- v2.1.2
23+
- 3.6.4
24+
25+
.. security_components_ver_table_end
26+
27+
Expand the following section to see the table listing versions of different security components implemented since the |NCS| v2.1.0.
28+
29+
.. toggle::
30+
31+
.. note::
32+
33+
Not all `official TF-M releases`_ are implemented by the |NCS|.
34+
This is because the |NCS| implements TF-M through Zephyr.
35+
Zephyr adds specific patches to the TF-M version, which are then upmerged into the |NCS| with changes specific to the |NCS|.
36+
37+
Similarly, not all `official Mbed TLS releases`_ are implemented by the |NCS| through the `sdk-mbedtls`_ repository.
38+
39+
.. list-table:: |NCS|, TF-M, and Mbed TLS versions
40+
:header-rows: 1
41+
:widths: auto
42+
43+
* - |NCS| release
44+
- TF-M version
45+
- Mbed TLS version
46+
* - Upcoming release (currently on the ``main`` branch of `sdk-nrf`_)
47+
- v2.2.0
48+
- 3.6.4
49+
* - v3.1.0, v3.1.1
50+
- v2.1.2
51+
- 3.6.4
52+
* - v3.0.0 (up to v3.0.2)
53+
- v2.1.1
54+
- 3.6.3
55+
* - v2.9.0 (up to v2.9.2)
56+
- v2.1.1
57+
- 3.6.2
58+
* - v2.8.0
59+
- v2.1.1
60+
- 3.6.2
61+
* - v2.7.0
62+
- v2.0.0
63+
- 3.5.2
64+
* - v2.6.0 (up to v2.6.4)
65+
- v2.0.0
66+
- 3.5.2
67+
* - v2.5.0 (up to v2.5.3)
68+
- v1.8.0
69+
- 3.3.0
70+
* - v2.4.0 (up to v2.4.4)
71+
- v1.7.0
72+
- 3.3.0
73+
* - v2.3.0
74+
- v1.6.0
75+
- 3.1.0
76+
* - v2.2.0
77+
- v1.6.0
78+
- 3.1.0
79+
* - v2.1.0 (up to v2.1.4)
80+
- v1.6.0
81+
- 3.1.0
82+
1083
The following table lists the available general security features.
1184
Some of them are documented in detail in other parts of this documentation, while others are documented in the subpages in this section.
1285

doc/nrf/security/tfm/tfm_supported_services.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ TF-M support and limitations in the |NCS|
99

1010
This page lists the supported features and limitations of Trusted Firmware-M (TF-M) in the |NCS|.
1111

12+
TF-M version in the |NCS|
13+
*************************
14+
15+
.. include:: ../../security.rst
16+
:start-after: security_components_ver_table_start
17+
:end-before: security_components_ver_table_end
18+
19+
For versions used in older releases of the |NCS|, check the expandable section on the :ref:`security` page.
20+
1221
.. _ug_tfm_supported_services_profiles:
1322

1423
Supported TF-M profiles

0 commit comments

Comments
 (0)