Skip to content

Added explanation about configuration options #183

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tamasan238
Copy link
Member

This was written by @miyazakh and translated into English by me.

@tamasan238 tamasan238 requested a review from danielinux April 6, 2025 01:13
@tamasan238
Copy link
Member Author

@danielinux Could you review this PR?
If there are any inaccuracies I will correct them.
I would appreciate it if you could check it.

@danielinux danielinux self-assigned this Apr 15, 2025
Copy link
Member

@danielinux danielinux left a comment

Choose a reason for hiding this comment

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

This looks very helpful, and the description fits perfectly for almost all items. Some minor inaccuracies to fix.

- `ENCRYPT_WITH_CHACHA`: Enable firmware encryption using the ChaCha algorithm.
- Default: 0

- `ARMORED`: Enable additional security measures.
Copy link
Member

Choose a reason for hiding this comment

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

Should mention glitch attacks.
Suggested description:
Enable additional mitigations against fault-injection attacks, e.g. voltage and clock glitches, or EMFI.

- `LMS_WINTERNITZ`: Set the Winternitz coefficient (LMS signature parameter).
- Default: 0

- `WOLFBOOT_UNIVERSAL_KEYSTORE`: Use a common key store across all platforms.
Copy link
Member

Choose a reason for hiding this comment

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

Enable storing public keys of different types in the same keystore.

- `NO_ARM_ASM`: Disable ARM assembly code and implement in C language only.
- Default: 0

- `SIGN_SECONDARY`: Enable signing of secondary firmware.
Copy link
Member

Choose a reason for hiding this comment

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

Enable a second signature for the images. Used to implement hybrid mode (e.g. ECC + ML_DSA). Set to the secondary algorithm selected for hybrid (classic + PQC) authentication.

@@ -18,6 +18,8 @@ Once a .config file is in place, it will change the default compile-time options

.config can be modified with a text editor to alter the default options later on.

Detail parameters can be found at [Appendix. N](appendix14.md)
Copy link
Member

Choose a reason for hiding this comment

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

Detailed?

- Default: 0

- `WOLFBOOT_VERSION`: Option to specify the version of wolfBoot.
- Default: 0
Copy link
Member

Choose a reason for hiding this comment

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

Default is set in include/wolfboot/version.h

- `WOLFBOOT_VERSION`: Option to specify the version of wolfBoot.
- Default: 0

- `V`: Version information for build or detailed output option.
Copy link
Member

Choose a reason for hiding this comment

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

Enable Verbose build.

- `NO_MPU`: Disable Memory Protection Unit (MPU).
- Default: 0

- `SPMATH`: Enable SP Math library (software mathematical operations).
Copy link
Member

Choose a reason for hiding this comment

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

(single-precision math library)

@tamasan238
Copy link
Member Author

Thank you for your review!
I've fixed them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants