-
Notifications
You must be signed in to change notification settings - Fork 33
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
base: master
Are you sure you want to change the base?
Conversation
@danielinux Could you review this PR? |
There was a problem hiding this 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.
wolfBoot/src/appendix14.md
Outdated
- `ENCRYPT_WITH_CHACHA`: Enable firmware encryption using the ChaCha algorithm. | ||
- Default: 0 | ||
|
||
- `ARMORED`: Enable additional security measures. |
There was a problem hiding this comment.
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.
wolfBoot/src/appendix14.md
Outdated
- `LMS_WINTERNITZ`: Set the Winternitz coefficient (LMS signature parameter). | ||
- Default: 0 | ||
|
||
- `WOLFBOOT_UNIVERSAL_KEYSTORE`: Use a common key store across all platforms. |
There was a problem hiding this comment.
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.
wolfBoot/src/appendix14.md
Outdated
- `NO_ARM_ASM`: Disable ARM assembly code and implement in C language only. | ||
- Default: 0 | ||
|
||
- `SIGN_SECONDARY`: Enable signing of secondary firmware. |
There was a problem hiding this comment.
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.
wolfBoot/src/chapter02.md
Outdated
@@ -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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Detailed?
wolfBoot/src/appendix14.md
Outdated
- Default: 0 | ||
|
||
- `WOLFBOOT_VERSION`: Option to specify the version of wolfBoot. | ||
- Default: 0 |
There was a problem hiding this comment.
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/src/appendix14.md
Outdated
- `WOLFBOOT_VERSION`: Option to specify the version of wolfBoot. | ||
- Default: 0 | ||
|
||
- `V`: Version information for build or detailed output option. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Enable Verbose build.
wolfBoot/src/appendix14.md
Outdated
- `NO_MPU`: Disable Memory Protection Unit (MPU). | ||
- Default: 0 | ||
|
||
- `SPMATH`: Enable SP Math library (software mathematical operations). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(single-precision math library)
ba29af5
to
f3c21aa
Compare
f3c21aa
to
7202d77
Compare
Thank you for your review! |
This was written by @miyazakh and translated into English by me.