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.

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

doc: nrf_security: Improve PSA configuration documentation #11702

Merged
merged 7 commits into from
Jul 6, 2023

Conversation

joerchan
Copy link
Contributor

@joerchan joerchan commented Jul 5, 2023

Improve the PSA configuration.
See commits for details.

Pull zephyr for PSA dependency fixes, as well as updating PSA configuration to be aligned with NCS documentation.

@github-actions github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. manifest labels Jul 5, 2023
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jul 5, 2023

The following west manifest projects have been modified in this Pull Request:

Name Old Revision New Revision Diff
nrfxlib nrfconnect/sdk-nrfxlib@dc8c95a nrfconnect/sdk-nrfxlib@4eca399 (main) nrfconnect/sdk-nrfxlib@dc8c95a8..4eca399c
zephyr nrfconnect/sdk-zephyr@52222dc nrfconnect/sdk-zephyr@01e2e4c (main) nrfconnect/sdk-zephyr@52222dc7..01e2e4c9

Note: This message is automatically posted and updated by the Manifest GitHub Action.

@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jul 5, 2023

Test specification

CI/Jenkins/NRF

  • Integration Platforms

CI/Jenkins/integration

Test Module File based changes Manually selected West overwrite
desktop52_verification X
test-fw-nrfconnect-ble X
test-fw-nrfconnect-ble_samples X
test-fw-nrfconnect-chip X
test-fw-nrfconnect-fem X
test-fw-nrfconnect-nfc X
test-fw-nrfconnect-nrf-iot_cloud X
test-fw-nrfconnect-nrf-iot_lwm2m X
test-fw-nrfconnect-nrf-iot_thingy91 X
test-fw-nrfconnect-nrf-iot_zephyr_lwm2m X
test-fw-nrfconnect-nrf_crypto X
test-fw-nrfconnect-rpc X
test-fw-nrfconnect-rs X
test-fw-nrfconnect-tfm X
test-fw-nrfconnect-thread X
test-sdk-find-my X
test-sdk-homekit X
test-sdk-wifi X

Detailed information of selected test modules

Note: This message is automatically posted and updated by the CI

@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

| GCM | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_GCM_CC3XX` | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_GCM_OBERON` |
+-----------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------+
| ChaCha20-Poly1305 | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_CHACHA20_POLY1305_CC3XX` | :kconfig:option:`CONFIG_PSA_CRYPTO_DRIVER_ALG_CHACHA20_POLY1305_OBERON` |
+-----------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------+

.. note::
* The :ref:`nrf_security_drivers_cc3xx` is limited to AES key sizes of 128 bits on devices with Arm CryptoCell cc310.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should AES be removed before GCM in the line below as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, the limitation is still valid. we only support AES, and we only support AES key size of 128 bits

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to be sure we're not misunderstanding each other :D I meant in line below (i.e. line 189), with the following text:

  • The :ref:nrf_security_drivers_cc3xx does not provide hardware support for AES GCM on devices with Arm CryptoCell cc310.
    I guess I am not sure why we removed AES from AES GCM in the table above, but we're still keeping it in the limitation in the note below the table.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yeah, my bad, I didn't read your comment properly.

Yeah, we can say don't support GCM at all.

doc/nrf/libraries/nrf_security/doc/driver_config.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/nrf_security/doc/driver_config.rst Outdated Show resolved Hide resolved
@joerchan joerchan force-pushed the psa-oberon-cleanup branch 2 times, most recently from 77eae59 to 87d6573 Compare July 6, 2023 10:12
@NordicBuilder NordicBuilder removed the DNM label Jul 6, 2023
Improve documentation text, change all references to PKCS1V15 to
PKCS#1 v1.5.

NCSDK-21520

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
Use the PSA naming of the chachapoly algorithm.
This makes it consistent with the PSA documentation as well as the PSA
configuration name.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
Remove mentions of AES in the cipher documentation.
The block ciphers can use different types of block cipher encryption.
Stream cipher does not support AES keys at all.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
Use better naming for cipher names. Document these use natural language
instead of code casing.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
Use better naming for PRNG names. Document these use natural language
instead of code casing.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
Add documentation for enabling PSA RNG configuration.
This configuration is new with Oberon PSA core and was not possible to
disable earlier.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
Update zephyr to include the PSA configuration dependency fixes.
This also aligns the PSA configuration names with the NCS documentation.

Update nrfxlib to match NCS documentation naming.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
@rlubos rlubos merged commit 51bb5ad into nrfconnect:main Jul 6, 2023
@joerchan joerchan deleted the psa-oberon-cleanup branch July 6, 2023 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. manifest manifest-nrfxlib manifest-zephyr
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants