Skip to content

Commit 4c7b909

Browse files
committed
Improve docs for pico_encrypt_binary
Add newlines for readability, and explain why MbedTLS version is insecure
1 parent dc1f3df commit 4c7b909

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
@@ -411,11 +411,15 @@ endfunction()
411411
# containing 16 bytes of a random IV), to give the IV used by the encryption.
412412
# This sets PICOTOOL_AESFILE to AESFILE, PICOTOOL_IVFILE to IVFILE, and
413413
# PICOTOOL_ENC_SIGFILE to SIGFILE if specified, else PICOTOOL_SIGFILE.
414+
#
414415
# Optionally, use EMBED to embed a decryption stage into the encrypted binary.
415416
# This sets PICOTOOL_EMBED_DECRYPTION to TRUE.
417+
#
416418
# Optionally, use MBEDTLS to to use the MbedTLS based decryption stage - this
417-
# is faster, but less secure.
419+
# is faster, but offers no security against power or timing sniffing attacks,
420+
# and takes up more code size.
418421
# This sets PICOTOOL_USE_MBEDTLS_DECRYPTION to TRUE.
422+
#
419423
# Optionally, use OTP_KEY_PAGE to specify the OTP page storing the AES key.
420424
# This sets PICOTOOL_OTP_KEY_PAGE to OTP_KEY_PAGE.
421425
function(pico_encrypt_binary TARGET AESFILE IVFILE)

0 commit comments

Comments
 (0)