fdt: Fix FIT header verification in mkimage and conduct same checks as bootm
A message that is not in the archive (sent off-list or not yet received): [email protected]
PATCH 1/1 fdt: Fix FIT header verification in mkimage and conduct same checks as bootm
Hi Jordan,
Quoted 24 lines · Jordan Hand
Signed-off-by Jordan Hand <[email protected]>---
FIT header verification in mkimage was treating a return code as a boolean, which meant that failures in validating the fit were seen as successes.Additionally, mkimage was checking all formats to find a header which passes validation, rather than using the image type specified to mkimage.
checkpatch.pl checks for lines ending with '(' and alignment matching open parentheses are ignored to keep with existing coding style.
tools/fit_common.c | 5 ++++- tools/imagetool.c | 31 +++++++++++++++++++++++++++++++ tools/imagetool.h | 15 +++++++++++++++ tools/mkimage.c | 2 +- 4 files changed, 51 insertions(+), 2 deletions(-)tools/fit_common.c +0
-0
tools/fit_common.c line 30
Quoted 6 lines
tools/fit_common.c +2
-1@@ -26,7 +26,10 @@int fit_verify_header (unsigned char *ptr,int image_size,struct image_tool_params *params) { -return fdt_check_header (ptr); +if (fdt_check_header (ptr) !=EXIT_SUCCESS || !fit_check_format (ptr)) +return -FDT_ERR_BADSTRUCTURE ;
So not a standard error code from ernno.h?
Can you please add a comment to fit_verify_header() to indicate what it returns? The use of EXIT_SUCCESS suggests that this value is returned as the program's exit code, and we don't want to return a -ve exit code.
Quoted 11 lines
tools/fit_common.c +2
-0+ +return EXIT_SUCCESS ; }int fit_check_image_types (uint8_t type)tools/imagetool.c +0
-0@@ -65,6 +65,37 @@ int imagetool_verify_print_header(return retval;
tools/imagetool.c int imagetool_verify_print_header( · line 75
Quoted 10 lines
tools/imagetool.c +8
-0} +int imagetool_verify_print_header_by_type ( +void *ptr, +struct stat *sbuf, +struct image_type_params *tparams, +struct image_tool_params *params) +{ +int retval = tparams->verify_header ((unsigned char *)ptr, + sbuf->st_size, params);
Can you do:
int retval;
retval = ...
because it is nicer to separate declarations from non-trivial code.
tools/imagetool.c int imagetool_verify_print_header( · line 79
Quoted 4 lines
tools/imagetool.c +4
-0+ +if (retval ==0 ) { +/* +* Print the image information if verify is
Single space between 'information' and 'if'
Quoted 27 lines
tools/imagetool.c +19
-0+* successful +*/ +if (tparams->print_header) { +if (!params->quiet) + tparams->print_header (ptr); + }else { +fprintf (stderr, +"%s: print_header undefined for %s\n" , + params->cmdname, tparams->name); + } + }else { +fprintf (stderr, +"%s: verify_header failed for %s with exit code %d\n" , + params->cmdname, tparams->name, retval); + } + +return retval; +} + int imagetool_save_subimage( const char *file_name, ulong file_data,tools/imagetool.h +0
-0
tools/imagetool.h int imagetool_verify_print_header( · line 187
Quoted 9 lines
tools/imagetool.h +6
-0@@ -179,6 +179,21 @@ int imagetool_verify_print_header(struct image_type_params *tparams, struct image_tool_params *params); +/* +* imagetool_verify_print_header_by_type() - verifies the image header +* +* Verify the image_header for the image type given by tparams. +* If verification is successful, this prints the respective header. +*
Please add docs for the parameters as well.
Quoted 26 lines
tools/imagetool.h +9
-0+* @return 0 on success, negative if input image format does not match with +* the given image type +*/ +int imagetool_verify_print_header_by_type ( +void *ptr, +struct stat *sbuf, +struct image_type_params *tparams, +struct image_tool_params *params); +/** * imagetool_save_subimage - store data into a file * @file_name: name of the destination file tools/mkimage.c +1
-2@@ -409,7 +409,7 @@ int main(int argc, char **argv)* Print the image information for matched image type * Returns the error code if not matched */ - retval =imagetool_verify_print_header (ptr, &sbuf, + retval =imagetool_verify_print_header_by_type (ptr, &sbuf, tparams, ¶ms); (void )munmap ((void *)ptr, sbuf.st_size); --
Quoted 2 lines
2.17.1
It would be great to have a test for imagetool in pytest. Not sure if you want to take that on :-)
Regards,
Simon
PATCH v2 1/1 fdt: Fix FIT header verification in mkimage and conduct same checks as bootm
---
FIT header verification in mkimage was treating a return code as a boolean, which meant that failures in validating the fit were seen as successes.
Additionally, mkimage was checking all formats to find a header which passes validation, rather than using the image type specified to mkimage.
checkpatch.pl checks for lines ending with '(' and alignment matching open parentheses are ignored to keep with existing coding style.
With regards to Simon's comment about imagetool pytests, I don't currently have time to spare on this but I will keep it on my backlog and try to address it in a future patch.
Changes in v2:
- Return EXIT_FAILURE on err from fit_verify_header and comment that fact
- Address typos and style errors from comments
- Add docs for parameters to imagetool_verify_print_header_by_type
tools/fit_common.c | 5 ++++- tools/fit_common.h | 8 ++++++++ tools/imagetool.c | 34 +++++++++++++++++++++++++++++++++- tools/imagetool.h | 19 +++++++++++++++++++ tools/mkimage.c | 2 +- 5 files changed, 65 insertions(+), 3 deletions(-)
tools/fit_common.c +4 -1
@@ -26,7 +26,10 @@int fit_verify_header (unsigned char *ptr,int image_size,struct image_tool_params *params) { -return fdt_check_header (ptr); +if (fdt_check_header (ptr) !=EXIT_SUCCESS || !fit_check_format (ptr)) +return EXIT_FAILURE ; + +return EXIT_SUCCESS ; }int fit_check_image_types (uint8_t type)
tools/fit_common.h +8 -0
@@ -10,6 +10,14 @@#include "mkimage.h" #include <image.h> +/** +* Verify the format of FIT header pointed to by ptr +* +* @ptr: image header to be verified +* @image_size: size of while image +* @params: mkimage parameters +* @return 0 if OK, -1 on error +*/ int fit_verify_header (unsigned char *ptr,int image_size,struct image_tool_params *params);
tools/imagetool.c +33 -1
@@ -46,7 +46,7 @@ int imagetool_verify_print_header(if (retval ==0 ) {/* -* Print the image information if verify is +* Print the image information if verify is * successful */ if ((*curr)->print_header) {
@@ -65,6 +65,38 @@ int imagetool_verify_print_header(return retval; } +int imagetool_verify_print_header_by_type ( +void *ptr, +struct stat *sbuf, +struct image_type_params *tparams, +struct image_tool_params *params) +{ +int retval; + + retval = tparams->verify_header ((unsigned char *)ptr, sbuf->st_size, + params); + +if (retval ==0 ) { +/* +* Print the image information if verify is successful +*/ +if (tparams->print_header) { +if (!params->quiet) + tparams->print_header (ptr); + }else { +fprintf (stderr, +"%s: print_header undefined for %s\n" , + params->cmdname, tparams->name); + } + }else { +fprintf (stderr, +"%s: verify_header failed for %s with exit code %d\n" , + params->cmdname, tparams->name, retval); + } + +return retval; +} + int imagetool_save_subimage( const char *file_name, ulong file_data,
tools/imagetool.h +19 -0
@@ -179,6 +179,25 @@ int imagetool_verify_print_header(struct image_type_params *tparams, struct image_tool_params *params); +/* +* imagetool_verify_print_header_by_type() - verifies the image header +* +* Verify the image_header for the image type given by tparams. +* If verification is successful, this prints the respective header. +* @ptr: pointer the the image header +* @sbuf: stat information about the file pointed to by ptr +* @tparams: image type parameters +* @params: mkimage parameters +* +* @return 0 on success, negative if input image format does not match with +* the given image type +*/ +int imagetool_verify_print_header_by_type ( +void *ptr, +struct stat *sbuf, +struct image_type_params *tparams, +struct image_tool_params *params); +/** * imagetool_save_subimage - store data into a file * @file_name: name of the destination file
tools/mkimage.c +1 -1
@@ -409,7 +409,7 @@ int main(int argc, char **argv)* Print the image information for matched image type * Returns the error code if not matched */ - retval =imagetool_verify_print_header (ptr, &sbuf, + retval =imagetool_verify_print_header_by_type (ptr, &sbuf, tparams, ¶ms); (void )munmap ((void *)ptr, sbuf.st_size);
Signature · 1 line
2.17.1
PATCH RESEND v2 1/1 fdt: Fix FIT header verification in mkimage and conduct same checks as bootm
---
FIT header verification in mkimage was treating a return code as a boolean, which meant that failures in validating the fit were seen as successes.
Additionally, mkimage was checking all formats to find a header which passes validation, rather than using the image type specified to mkimage.
checkpatch.pl checks for lines ending with '(' and alignment matching open parentheses are ignored to keep with existing coding style.
With regards to Simon's comment about imagetool pytests, I don't currently have time to spare on this but I will keep it on my backlog and try to address it in a future patch.
Changes in v2:
- Return EXIT_FAILURE on failure from fit_verify_header and comment that fact
- Address typos and style errors from comments
- Add docs for parameters to imagetool_verify_print_header_by_type
tools/fit_common.c | 5 ++++- tools/fit_common.h | 8 ++++++++ tools/imagetool.c | 34 +++++++++++++++++++++++++++++++++- tools/imagetool.h | 19 +++++++++++++++++++ tools/mkimage.c | 2 +- 5 files changed, 65 insertions(+), 3 deletions(-)
tools/fit_common.c +4 -1
@@ -26,7 +26,10 @@int fit_verify_header (unsigned char *ptr,int image_size,struct image_tool_params *params) { -return fdt_check_header (ptr); +if (fdt_check_header (ptr) !=EXIT_SUCCESS || !fit_check_format (ptr)) +return EXIT_FAILURE ; + +return EXIT_SUCCESS ; }int fit_check_image_types (uint8_t type)
tools/fit_common.h +8 -0
@@ -10,6 +10,14 @@#include "mkimage.h" #include <image.h> +/** +* Verify the format of FIT header pointed to by ptr +* +* @ptr: image header to be verified +* @image_size: size of while image +* @params: mkimage parameters +* @return 0 if OK, -1 on error +*/ int fit_verify_header (unsigned char *ptr,int image_size,struct image_tool_params *params);
tools/imagetool.c +33 -1
@@ -46,7 +46,7 @@ int imagetool_verify_print_header(if (retval ==0 ) {/* -* Print the image information if verify is +* Print the image information if verify is * successful */ if ((*curr)->print_header) {
@@ -65,6 +65,38 @@ int imagetool_verify_print_header(return retval; } +int imagetool_verify_print_header_by_type ( +void *ptr, +struct stat *sbuf, +struct image_type_params *tparams, +struct image_tool_params *params) +{ +int retval; + + retval = tparams->verify_header ((unsigned char *)ptr, sbuf->st_size, + params); + +if (retval ==0 ) { +/* +* Print the image information if verify is successful +*/ +if (tparams->print_header) { +if (!params->quiet) + tparams->print_header (ptr); + }else { +fprintf (stderr, +"%s: print_header undefined for %s\n" , + params->cmdname, tparams->name); + } + }else { +fprintf (stderr, +"%s: verify_header failed for %s with exit code %d\n" , + params->cmdname, tparams->name, retval); + } + +return retval; +} + int imagetool_save_subimage( const char *file_name, ulong file_data,
tools/imagetool.h +19 -0
@@ -179,6 +179,25 @@ int imagetool_verify_print_header(struct image_type_params *tparams, struct image_tool_params *params); +/* +* imagetool_verify_print_header_by_type() - verifies the image header +* +* Verify the image_header for the image type given by tparams. +* If verification is successful, this prints the respective header. +* @ptr: pointer the the image header +* @sbuf: stat information about the file pointed to by ptr +* @tparams: image type parameters +* @params: mkimage parameters +* +* @return 0 on success, negative if input image format does not match with +* the given image type +*/ +int imagetool_verify_print_header_by_type ( +void *ptr, +struct stat *sbuf, +struct image_type_params *tparams, +struct image_tool_params *params); +/** * imagetool_save_subimage - store data into a file * @file_name: name of the destination file
tools/mkimage.c +1 -1
@@ -409,7 +409,7 @@ int main(int argc, char **argv)* Print the image information for matched image type * Returns the error code if not matched */ - retval =imagetool_verify_print_header (ptr, &sbuf, + retval =imagetool_verify_print_header_by_type (ptr, &sbuf, tparams, ¶ms); (void )munmap ((void *)ptr, sbuf.st_size);
Signature · 1 line
2.17.1
PATCH RESEND v2 1/1 fdt: Fix FIT header verification in mkimage and conduct same checks as bootm
Quoted 11 lines · Jordan Hand
FIT header verification in mkimage was treating a return code as a boolean, which meant that failures in validating the fit were seen as successes.
Additionally, mkimage was checking all formats to find a header which passes validation, rather than using the image type specified to mkimage.
checkpatch.pl checks for lines ending with '(' and alignment matching open parentheses are ignored to keep with existing coding style.
Signed-off-by Jordan Hand <[email protected]>
Applied to u-boot/master, thanks!
Signature · 8 lines
Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 819 bytes Desc: not available URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190308/36afdc62/attachment.sig>