Skip to content

Commit e684dcc

Browse files
committed
Improve docs for pico_encrypt_binary
Add newlines for readability, and explain why MbedTLS version is insecure
1 parent 3bb3acb commit e684dcc

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

tools/CMakeLists.txt

+5-1
Original file line numberDiff line numberDiff line change
@@ -389,11 +389,15 @@ endfunction()
389389
# containing 16 bytes of a random IV), to give the IV used by the encryption.
390390
# This sets PICOTOOL_AESFILE to AESFILE, PICOTOOL_IVFILE to IVFILE, and
391391
# PICOTOOL_ENC_SIGFILE to SIGFILE if specified, else PICOTOOL_SIGFILE.
392+
#
392393
# Optionally, use EMBED to embed a decryption stage into the encrypted binary.
393394
# This sets PICOTOOL_EMBED_DECRYPTION to TRUE.
395+
#
394396
# Optionally, use MBEDTLS to to use the MbedTLS based decryption stage - this
395-
# is faster, but less secure.
397+
# is faster, but offers no security against power or timing sniffing attacks,
398+
# and takes up more code size.
396399
# This sets PICOTOOL_USE_MBEDTLS_DECRYPTION to TRUE.
400+
#
397401
# Optionally, use OTP_KEY_PAGE to specify the OTP page storing the AES key.
398402
# This sets PICOTOOL_OTP_KEY_PAGE to OTP_KEY_PAGE.
399403
function(pico_encrypt_binary TARGET AESFILE IVFILE)

0 commit comments

Comments
 (0)