Skip to content

Commit 276af56

Browse files
frkvrlubos
authored andcommitted
doc: crypto: Document deprecation of legacy Mbed TLS APIs
-This commit adds cautions that legacy Mbed TLS crypto toolbox APIs are deprecated and will be removed. -This also simplifies a statement around enabling both nrf_security and nordic_security_backend. This is not required as nrf_security will be automatically set once nordic_security_backend is set (which is soon to be deprecated and removed) ref: NCSDK-30036 Signed-off-by: Frank Audun Kvamtrø <[email protected]>
1 parent 9a46ff4 commit 276af56

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

doc/nrf/libraries/security/nrf_security/doc/backend_config.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Legacy configurations and supported features
1010

1111
This section covers the configurations available when using :ref:`legacy_crypto_support`.
1212

13+
.. caution::
14+
Legacy crypto toolbox APIs are marked as deprecated in the |NCS| version 2.8.0, and will be removed in a future version.
15+
It is not recommended to use the legacy crypto toolbox APIs and the related configurations in any new designs.
16+
1317
.. _nrf_security_backend_config_multiple:
1418

1519
Configuring backends

doc/nrf/libraries/security/nrf_security/doc/configuration.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,17 @@ PSA core uses PSA drivers to implement the cryptographic features either in soft
2424
Legacy crypto support
2525
*********************
2626

27-
To enable the legacy crypto support mode of nRF Security, set both the :kconfig:option:`CONFIG_NORDIC_SECURITY_BACKEND` and :kconfig:option:`CONFIG_NRF_SECURITY` Kconfig options along with additional configuration options, as described in :ref:`nrf_security_legacy_config`.
27+
To enable the legacy crypto support mode of nRF Security, set the :kconfig:option:`CONFIG_NORDIC_SECURITY_BACKEND` Kconfig option along with additional configuration options, as described in :ref:`nrf_security_legacy_config`.
2828
The legacy crypto support allows backwards compatibility for software that requires usage of Mbed TLS crypto toolbox functions prefixed with ``mbedtls_``.
2929

30+
.. caution::
31+
Mbed TLS legacy crypto toolbox APIs are marked as deprecated in the |NCS| version 2.8.0, and will be removed in a future version.
32+
It is not recommended to use crypto toolbox functions prefixed with ``mbedtls_`` for any new designs.
33+
Use the equivalent functionality from PSA crypto APIs instead.
34+
35+
Setting the Kconfig option :kconfig:option:`CONFIG_NORDIC_SECURITY_BACKEND` will also enable the Kconfig option :kconfig:option:`MBEDTLS_LEGACY_CRYPTO_C`, which will show a deprecation warning in the build output.
36+
Use the Kconfig option :kconfig:option:`CONFIG_NRF_SECURITY` instead.
37+
3038
Custom Mbed TLS configuration files
3139
***********************************
3240

0 commit comments

Comments
 (0)