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

hw_unique_key: Create read Kconfig option #11976

Closed
wants to merge 1 commit into from

Conversation

mswarowsky
Copy link
Contributor

On nRF52840 to use the HUK the immustable bootloader is needed. By adding a new Kconfig option that should be used the key is just read but not written we ensure during build time that the images includes the immutable bootloader.

@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. labels Aug 7, 2023
@mswarowsky mswarowsky removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Aug 7, 2023
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Aug 7, 2023

Test specification

CI/Jenkins/NRF

  • Integration Platforms

CI/Jenkins/integration

Test Module File based changes Manually selected West overwrite
test-fw-nrfconnect-nrf_crypto X
test-fw-nrfconnect-tfm 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.

lib/hw_unique_key/Kconfig Outdated Show resolved Hide resolved
doc/nrf/libraries/others/hw_unique_key.rst Outdated Show resolved Hide resolved
lib/hw_unique_key/Kconfig Outdated Show resolved Hide resolved
lib/hw_unique_key/Kconfig Outdated Show resolved Hide resolved
lib/hw_unique_key/Kconfig Outdated Show resolved Hide resolved
@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Aug 8, 2023
doc/nrf/libraries/others/hw_unique_key.rst Outdated Show resolved Hide resolved
Use the Hardware Unique Key (HUK) in read access to derive new keys.
It will require an immutable bootloader with the CONFIG_HW_UNIQUE_KEY_LOAD
option set on devices without a KMU.
Note that the key has to be written before.
Copy link
Contributor

Choose a reason for hiding this comment

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

Btw, the key has to be written before what?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

before it can be read.
Is that enough or do you think that requires more details

Copy link
Contributor

Choose a reason for hiding this comment

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

I would maybe add more details. Is that something that user has to make sure that it's done? And how. Maybe reference to or mention of a function/option/procedure that is used, if any.

Copy link
Contributor Author

@mswarowsky mswarowsky Aug 10, 2023

Choose a reason for hiding this comment

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

Oh was not aware that we include procedure descriptions in Kconfigs,

I added a reference to the Kconfigs used for that, I feel describing the whole process here is a bit too much.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, no need to describe the entire process.
It just needed some more info, because writing just simply that the key has to be written before it is read is kind of obvious and does not give that much of a useful info.
But writing that the key has to be written by XX before it can be read, or XX has to have completed and written the key before it can be read gives a clear instruction on what users should be looking out for.
Giving these references is useful I think, so if you are happy now, then I am 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.

Yeah makes sense, but I think the reference to the Kconfig that is needed for writing should be fine now

lib/hw_unique_key/Kconfig Outdated Show resolved Hide resolved
@mswarowsky mswarowsky force-pushed the hw_key_kconfig branch 2 times, most recently from dceb8fd to aa1ddb8 Compare August 10, 2023 12:14
@mswarowsky mswarowsky force-pushed the hw_key_kconfig branch 4 times, most recently from 67c77da to 59c6b72 Compare August 11, 2023 14:56
On nRF52840 to use the HUK the immustable bootloader is needed.
By adding a new Kconfig option that should be used the key is just read
but not written we ensure during build time that the images includes
the immutable bootloader.

Signed-off-by: Markus Swarowsky <markus.swarowsky@nordicsemi.no>
@mswarowsky
Copy link
Contributor Author

Turned out we will run in cyclic Kconfig dependencies, So I give on on what was supposed to be a small fix...

@mswarowsky mswarowsky closed this Aug 15, 2023
@mswarowsky mswarowsky deleted the hw_key_kconfig branch August 18, 2023 14:21
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants