Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Add missing documentation entries #11600

Merged
merged 1 commit into from
Jul 4, 2023
Merged

doc: Add missing documentation entries #11600

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 41 additions & 29 deletions doc/nrf/libraries/nrf_security/doc/driver_config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ To enable AES cipher modes, set one or more of the following Kconfig options:
+----------------+------------------------------------------------------+
| XTS | :kconfig:option:`CONFIG_PSA_WANT_ALG_XTS` |
+----------------+------------------------------------------------------+
| Stream cipher | :kconfig:option:`CONFIG_PSA_WANT_ALG_STREAM_CIPHER` |
+----------------+------------------------------------------------------+


AES cipher driver configurations
Expand All @@ -77,6 +79,8 @@ You can use the following Kconfig options for fine-grained control over which dr
+----------------+---------------------------------------------------------------------+----------------------------------------------------------------------+
| XTS | Not supported | Not supported |
+----------------+---------------------------------------------------------------------+----------------------------------------------------------------------+
| Stream cipher | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_STREAM_CIPHER_CC3XX` | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_STREAM_CIPHER_OBERON` |
+----------------+---------------------------------------------------------------------+----------------------------------------------------------------------+

.. note::
* The :ref:`nrf_security_drivers_cc3xx` is limited to AES key sizes of 128 bits on devices with Arm CryptoCell cc310.
Expand Down Expand Up @@ -239,7 +243,7 @@ To configure elliptic curve support, set one or more of the following Kconfig op
+-----------------------+-----------------------------------------------------------+
| Curve448 | :kconfig:option:`CONFIG_PSA_WANT_ECC_MONTGOMERY_448` |
+-----------------------+-----------------------------------------------------------+
| Ed25519 | :kconfig:option:`CONFIG_PSA_WANT_ECC_TWISTED_EDWARDS_255` |
| Edwards25519 | :kconfig:option:`CONFIG_PSA_WANT_ECC_TWISTED_EDWARDS_255` |
+-----------------------+-----------------------------------------------------------+
| secp192k1 | :kconfig:option:`CONFIG_PSA_WANT_ECC_SECP_K1_192` |
+-----------------------+-----------------------------------------------------------+
Expand Down Expand Up @@ -275,7 +279,7 @@ You can use the following Kconfig options for fine-grained control over which dr
+-----------------------+--------------------------------------------------------------------------+---------------------------------------------------------------------------+
| Curve448 | Not supported | Not supported |
+-----------------------+--------------------------------------------------------------------------+---------------------------------------------------------------------------+
| Ed25519 | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ECC_TWISTED_EDWARDS_255_CC3XX` | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ECC_TWISTED_EDWARDS_255_OBERON` |
| Edwards25519 | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ECC_TWISTED_EDWARDS_255_CC3XX` | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ECC_TWISTED_EDWARDS_255_OBERON` |
+-----------------------+--------------------------------------------------------------------------+---------------------------------------------------------------------------+
| secp192k1 | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ECC_SECP_K1_192_CC3XX` | Not supported |
+-----------------------+--------------------------------------------------------------------------+---------------------------------------------------------------------------+
Expand Down Expand Up @@ -362,41 +366,49 @@ You can use the following Kconfig options for fine-grained control over which dr
* :ref:`nrf_security_drivers_oberon` does not support RSA key pair generation.


Secure Hash configurations
**************************

To configure the Secure Hash algorithms, set one or more of the following Kconfig options:

+-----------------------+-----------------------------------------------+
| Hash algorithm | Configuration option |
+=======================+===============================================+
| SHA-1 | :kconfig:option:`CONFIG_PSA_WANT_ALG_SHA_1` |
+-----------------------+-----------------------------------------------+
| SHA-224 | :kconfig:option:`CONFIG_PSA_WANT_ALG_SHA_224` |
+-----------------------+-----------------------------------------------+
| SHA-256 | :kconfig:option:`CONFIG_PSA_WANT_ALG_SHA_256` |
+-----------------------+-----------------------------------------------+
| SHA-384 | :kconfig:option:`CONFIG_PSA_WANT_ALG_SHA_384` |
+-----------------------+-----------------------------------------------+
| SHA-512 | :kconfig:option:`CONFIG_PSA_WANT_ALG_SHA_512` |
+-----------------------+-----------------------------------------------+

Hash configurations
*******************

Secure Hash driver configurations
=================================
To configure the Hash algorithms, set one or more of the following Kconfig options:

+-----------------------+---------------------------------------------------+
| Hash algorithm | Configuration option |
+=======================+===================================================+
| SHA-1 | :kconfig:option:`CONFIG_PSA_WANT_ALG_SHA_1` |
+-----------------------+---------------------------------------------------+
| SHA-224 | :kconfig:option:`CONFIG_PSA_WANT_ALG_SHA_224` |
+-----------------------+---------------------------------------------------+
| SHA-256 | :kconfig:option:`CONFIG_PSA_WANT_ALG_SHA_256` |
+-----------------------+---------------------------------------------------+
| SHA-384 | :kconfig:option:`CONFIG_PSA_WANT_ALG_SHA_384` |
+-----------------------+---------------------------------------------------+
| SHA-512 | :kconfig:option:`CONFIG_PSA_WANT_ALG_SHA_512` |
+-----------------------+---------------------------------------------------+
| MD5 | :kconfig:option:`CONFIG_PSA_WANT_ALG_MD5` |
+-----------------------+---------------------------------------------------+
| RIPEMD160 | :kconfig:option:`CONFIG_PSA_WANT_ALG_RIPEMD160` |
+-----------------------+---------------------------------------------------+


Hash driver configurations
==========================

You can use the following PSA driver-specific configurations for fine-grained control over which drivers provide the Secure Hash algorithm.
You can use the following PSA driver-specific configurations for fine-grained control over which drivers provide the Hash algorithm.

+-----------------------+---------------------------------------------------------------+---------------------------------------------------------------+
| Hash algorithm | nrf_cc3xx driver support | nrf_oberon driver support |
+=======================+===============================================================+===============================================================+
| SHA-1 | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_1_CC3XX` | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_1_OBERON` |
| SHA-1 | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_1_CC3XX` | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_1_OBERON` |
+-----------------------+---------------------------------------------------------------+---------------------------------------------------------------+
| SHA-224 | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_224_CC3XX` | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_224_OBERON` |
+-----------------------+---------------------------------------------------------------+---------------------------------------------------------------+
| SHA-256 | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_256_CC3XX` | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_256_OBERON` |
+-----------------------+---------------------------------------------------------------+---------------------------------------------------------------+
| SHA-224 | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_224_CC3XX` | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_224_OBERON` |
| SHA-384 | Not supported | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_384_OBERON` |
+-----------------------+---------------------------------------------------------------+---------------------------------------------------------------+
| SHA-256 | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_256_CC3XX` | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_256_OBERON` |
| SHA-512 | Not supported | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_512_OBERON` |
+-----------------------+---------------------------------------------------------------+---------------------------------------------------------------+
| SHA-384 | Not supported | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_384_OBERON` |
| MD5 | Not supported | Not supported |
+-----------------------+---------------------------------------------------------------+---------------------------------------------------------------+
| SHA-512 | Not supported | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_SHA_512_OBERON` |
| RIPEMD160 | Not supported | Not supported |
+-----------------------+---------------------------------------------------------------+---------------------------------------------------------------+