c6f334272a
This commit adds support to stm32's mboot for signe, encrypted and compressed DFU updates. It is based on inital work done by Andrew Leech. The feature is enabled by setting MBOOT_ENABLE_PACKING to 1 in the board's mpconfigboard.mk file, and by providing a header file in the board folder (usually called mboot_keys.h) with a set of signing and encryption keys (which can be generated by mboot_pack_dfu.py). The signing and encryption is provided by libhydrogen. Compression is provided by uzlib. Enabling packing costs about 3k of flash. The included mboot_pack_dfu.py script converts a .dfu file to a .pack.dfu file which can be subsequently deployed to a board with mboot in packing mode. This .pack.dfu file is created as follows: - the firmware from the original .dfu is split into chunks (so the decryption can fit in RAM) - each chunk is compressed, encrypted, a header added, then signed - a special final chunk is added with a signature of the entire firmware - all chunks are concatenated to make the final .pack.dfu file The .pack.dfu file can be deployed over USB or from the internal filesystem on the device (if MBOOT_FSLOAD is enabled). See #5267 and #5309 for additional discussion. Signed-off-by: Damien George <damien@micropython.org>
111 lines
3.3 KiB
C
111 lines
3.3 KiB
C
/*
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2019-2020 Damien P. George
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
#include <string.h>
|
|
|
|
#include "py/mphal.h"
|
|
#include "extmod/uzlib/uzlib.h"
|
|
#include "gzstream.h"
|
|
#include "mboot.h"
|
|
|
|
#if MBOOT_FSLOAD || MBOOT_ENABLE_PACKING
|
|
|
|
#define DICT_SIZE (1 << 15)
|
|
|
|
typedef struct _gz_stream_t {
|
|
void *stream_data;
|
|
stream_read_t stream_read;
|
|
struct uzlib_uncomp tinf;
|
|
uint8_t buf[512];
|
|
uint8_t dict[DICT_SIZE];
|
|
} gz_stream_t;
|
|
|
|
static gz_stream_t gz_stream SECTION_NOZERO_BSS;
|
|
|
|
static int gz_stream_read_src(TINF_DATA *tinf) {
|
|
int n = gz_stream.stream_read(gz_stream.stream_data, gz_stream.buf, sizeof(gz_stream.buf));
|
|
if (n < 0) {
|
|
// Stream error
|
|
return -1;
|
|
}
|
|
if (n == 0) {
|
|
// No data / EOF
|
|
return -1;
|
|
}
|
|
|
|
tinf->source = gz_stream.buf + 1;
|
|
tinf->source_limit = gz_stream.buf + n;
|
|
return gz_stream.buf[0];
|
|
}
|
|
|
|
int gz_stream_init_from_raw_data(const uint8_t *data, size_t len) {
|
|
memset(&gz_stream.tinf, 0, sizeof(gz_stream.tinf));
|
|
gz_stream.tinf.source = data;
|
|
gz_stream.tinf.source_limit = data + len;
|
|
|
|
uzlib_uncompress_init(&gz_stream.tinf, gz_stream.dict, DICT_SIZE);
|
|
|
|
return 0;
|
|
}
|
|
|
|
int gz_stream_init_from_stream(void *stream_data, stream_read_t stream_read) {
|
|
gz_stream.stream_data = stream_data;
|
|
gz_stream.stream_read = stream_read;
|
|
|
|
memset(&gz_stream.tinf, 0, sizeof(gz_stream.tinf));
|
|
gz_stream.tinf.source_read_cb = gz_stream_read_src;
|
|
|
|
int st = uzlib_gzip_parse_header(&gz_stream.tinf);
|
|
if (st != TINF_OK) {
|
|
return -1;
|
|
}
|
|
|
|
uzlib_uncompress_init(&gz_stream.tinf, gz_stream.dict, DICT_SIZE);
|
|
|
|
return 0;
|
|
}
|
|
|
|
int gz_stream_read(size_t len, uint8_t *buf) {
|
|
if (gz_stream.tinf.source == NULL && gz_stream.tinf.source_read_cb == NULL) {
|
|
// End of stream.
|
|
return 0;
|
|
}
|
|
gz_stream.tinf.dest = buf;
|
|
gz_stream.tinf.dest_limit = buf + len;
|
|
int st = uzlib_uncompress_chksum(&gz_stream.tinf);
|
|
if (st < 0) {
|
|
return st;
|
|
}
|
|
if (st == TINF_DONE) {
|
|
// Indicate end-of-stream for subsequent calls.
|
|
gz_stream.tinf.source = NULL;
|
|
gz_stream.tinf.source_read_cb = NULL;
|
|
}
|
|
return gz_stream.tinf.dest - buf;
|
|
}
|
|
|
|
#endif // MBOOT_FSLOAD || MBOOT_ENABLE_PACKING
|