Merge branch 'feature/nvs_part_util_3.3' into 'release/v3.3'

Add support as per encryption and multipage blob changes in NVS Partition Utility (backport v3.3)

See merge request idf/esp-idf!4626

.flake8

@@ -160,6 +160,5 @@ exclude =
         components/wifi_provisioning/python/wifi_constants_pb2.py,
         examples/provisioning/custom_config/components/custom_provisioning/python/custom_config_pb2.py,
     # temporary list (should be empty)
-        components/nvs_flash/nvs_partition_generator/nvs_partition_gen.py,
         tools/esp_app_trace/pylibelf,
         tools/mass_mfg/mfg_gen.py,

components/nvs_flash/nvs_partition_generator/README.rst

@@ -12,7 +12,7 @@ Prerequisites
 To use this utility in encryption mode, the following packages need to be installed:
     - cryptography package
 
-This dependency is already captured by including these packages in `requirement.txt` in top level IDF directory.
+These dependencies is already captured by including these packages in `requirement.txt` in top level IDF directory.
 
 CSV file format
 ---------------
@@ -44,7 +44,7 @@ Below is an example dump of such CSV file::
     key1,data,u8,1
     key2,file,string,/path/to/file
 
-.. note:: Make sure there are no spaces before and after ',' in CSV file.
+.. note:: Make sure there are no spaces before and after ',' or at the end of each line in CSV file.
 
 NVS Entry and Namespace association
 -----------------------------------
@@ -71,7 +71,7 @@ Running the utility
     python nvs_partition_gen.py [-h] [--input INPUT] [--output OUTPUT]
                             [--size SIZE] [--version {v1,v2}]
                             [--keygen {true,false}] [--encrypt {true,false}]
-                            [--keyfile KEYFILE]
+                            [--keyfile KEYFILE] [--outdir OUTDIR]
 
 
 +------------------------+----------------------------------------------------------------------------------------------+
@@ -85,15 +85,14 @@ Running the utility
 +------------------------+----------------------------------------------------------------------------------------------+
 | --version {v1,v2}      | Set version. Default: v2                                                                     |
 +------------------------+----------------------------------------------------------------------------------------------+
-| --keygen {true,false}  | Generate keys for encryption. Creates an `encryption_keys.bin` file (in current directory).  |
+| --keygen {true,false}  | Generate keys for encryption.                                                                |
-|                        | Default: false                                                                               |
 +------------------------+----------------------------------------------------------------------------------------------+
 | --encrypt {true,false} | Set encryption mode. Default: false                                                          |
 +------------------------+----------------------------------------------------------------------------------------------+
 | --keyfile KEYFILE      | File having key for encryption (Applicable only if encryption mode is true)                  |
 +------------------------+----------------------------------------------------------------------------------------------+
-
+| --outdir OUTDIR        | The output directory to store the files created (Default: current directory)                 |
-
++------------------------+----------------------------------------------------------------------------------------------+
 
 You can run this utility in two modes:
     -   Default mode - Binary generated in this mode is an unencrypted binary file.
@@ -108,7 +107,7 @@ You can run this utility in two modes:
     python nvs_partition_gen.py [-h] --input INPUT --output OUTPUT
                             --size SIZE [--version {v1,v2}]
                             [--keygen {true,false}] [--encrypt {true,false}]
-                            [--keyfile KEYFILE]
+                            [--keyfile KEYFILE] [--outdir OUTDIR]
 
 You can run the utility using below command::
 
@@ -123,28 +122,34 @@ You can run the utility using below command::
 
     python nvs_partition_gen.py [-h] --input INPUT --output OUTPUT
                             --size SIZE --encrypt {true,false}
-                            --keygen {true,false} | --keyfile KEYFILE
+                            --keygen {true,false} --keyfile KEYFILE
-                            [--version {v1,v2}]
+                            [--version {v1,v2}] [--outdir OUTDIR]
 
 
 You can run the utility using below commands:
 
-    -   By taking encryption keys as an input file. A sample encryption keys binary file is provided with the utility::
-
-            python nvs_partition_gen.py --input sample.csv --output sample_encrypted.bin --size 0x3000 --encrypt true --keyfile testdata/sample_encryption_keys.bin
-
     -   By enabling generation of encryption keys::
 
             python nvs_partition_gen.py --input sample.csv --output sample_encrypted.bin --size 0x3000 --encrypt true --keygen true
 
+    -   By taking encryption keys as an input file. A sample encryption keys binary file is provided with the utility::
+
+            python nvs_partition_gen.py --input sample.csv --output sample_encrypted.bin --size 0x3000 --encrypt true --keyfile testdata/sample_encryption_keys.bin
+
+    -   By enabling generation of encryption keys and storing the keys in custom filename::
+
+            python nvs_partition_gen.py --input sample.csv --output sample_encrypted.bin --size 0x3000 --encrypt true --keygen true --keyfile encryption_keys_generated.bin
+
+.. note:: If `--keygen` is given with `--keyfile` argument, generated keys will be stored in `--keyfile` file. If `--keygen` argument is absent, `--keyfile` is taken as input file having key for encryption.
 
 
-*To generate* **only** *encryption keys with this utility* ( Creates an `encryption_keys.bin` file in current directory ): ::
+*To generate* **only** *encryption keys with this utility*::
 
     python nvs_partition_gen.py --keygen true
 
-.. note:: This `encryption_keys.bin` file is compatible with NVS key-partition structure. Refer to :ref:`nvs_key_partition` for more details.
+This creates an `encryption_keys_<timestamp>.bin` file.
 
+.. note:: This newly created file having encryption keys in `keys/` directory is compatible with NVS key-partition structure. Refer to :ref:`nvs_key_partition` for more details.
 
 
 You can also provide the format version number (in any of the two modes):
@@ -158,7 +163,7 @@ You can also provide the format version number (in any of the two modes):
 You can run the utility in this format by setting the version parameter to v2, as shown below.
 A sample CSV file is provided with the utility::
 
-    python nvs_partition_gen.py --input sample_multipage_blob.csv --output partition_multipage_blob.bin --size 0x3000 --version v2
+    python nvs_partition_gen.py --input sample_multipage_blob.csv --output partition_multipage_blob.bin --size 0x4000 --version v2
 
 
 **Multipage Blob Support Disabled (v1):**
@@ -179,3 +184,4 @@ Caveats
 -  Utility doesn't check for duplicate keys and will write data pertaining to both keys. User needs to make sure keys are distinct.
 -  Once a new page is created, no data will be written in the space left in previous page. Fields in the CSV file need to be ordered in such a way so as to optimize memory.
 -  64-bit datatype is not yet supported.
+

components/nvs_flash/nvs_partition_generator/nvs_partition_gen.py

@@ -31,14 +31,24 @@ import array
 import csv
 import zlib
 import codecs
+import datetime
+import distutils.dir_util
+try:
     from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
     from cryptography.hazmat.backends import default_backend
+except ImportError:
+    print('The cryptography package is not installed.'
+          'Please refer to the Get Started section of the ESP-IDF Programming Guide for '
+          'setting up the required packages.')
+    raise
 
 VERSION1_PRINT = "v1 - Multipage Blob Support Disabled"
 VERSION2_PRINT = "v2 - Multipage Blob Support Enabled"
 
 
 """ Class for standard NVS page structure """
+
+
 class Page(object):
     PAGE_PARAMS = {
         "max_size": 4096,
@@ -102,7 +112,6 @@ class Page(object):
         struct.pack_into('<I', page_header, 28, crc & 0xFFFFFFFF)
         self.page_buf[0:len(page_header)] = page_header
 
-
     def create_bitmap_array(self):
         bitarray = array.array('B')
         charsize = 32  # bitmaparray has 256 bits, hence 32 bytes
@@ -110,7 +119,6 @@ class Page(object):
         bitarray.extend((fill,) * charsize)
         return bitarray
 
-
     def write_bitmaparray(self):
         bitnum = self.entry_num * 2
         byte_idx = bitnum // 8  # Find byte index in the array
@@ -121,7 +129,6 @@ class Page(object):
         end_idx = Page.BITMAPARRAY_OFFSET + Page.BITMAPARRAY_SIZE_IN_BYTES
         self.page_buf[start_idx:end_idx] = self.bitmap_array
 
-
     def encrypt_entry(self, data_arr, tweak_arr, encr_key):
         # Encrypt 32 bytes of data using AES-XTS encryption
         backend = default_backend()
@@ -134,7 +141,6 @@ class Page(object):
 
         return encrypted_data
 
-
     def reverse_hexbytes(self, addr_tmp):
         addr = []
         reversed_bytes = ""
@@ -144,7 +150,6 @@ class Page(object):
 
         return reversed_bytes
 
-
     def encrypt_data(self, data_input, no_of_entries, nvs_obj):
         # Set values needed for encryption and encrypt data byte wise
         encr_data_to_write = bytearray()
@@ -155,7 +160,6 @@ class Page(object):
         tweak_tmp = ''
         encr_key_input = None
 
-
         # Extract encryption key and tweak key from given key input
         if len(self.encr_key) == key_len_needed:
             encr_key_input = self.encr_key
@@ -207,7 +211,6 @@ class Page(object):
 
         return encr_data_to_write
 
-
     def write_entry_to_buf(self, data, entrycount,nvs_obj):
         encr_data = bytearray()
 
@@ -226,7 +229,6 @@ class Page(object):
             self.write_bitmaparray()
             self.entry_num += 1
 
-
     def set_crc_header(self, entry_struct):
         crc_data = bytearray(b'28')
         crc_data[0:4] = entry_struct[0:4]
@@ -236,7 +238,6 @@ class Page(object):
         struct.pack_into('<I', entry_struct, 4, crc & 0xFFFFFFFF)
         return entry_struct
 
-
     def write_varlen_binary_data(self, entry_struct, ns_index, key, data, data_size, total_entry_count, encoding, nvs_obj):
         chunk_start = 0
         chunk_count = 0
@@ -306,7 +307,6 @@ class Page(object):
 
             offset = offset + chunk_size
 
-
             # All chunks are stored, now store the index
             if not remaining_size:
                 # Initialise data field to 0xff
@@ -336,7 +336,6 @@ class Page(object):
 
         return entry_struct
 
-
     def write_single_page_entry(self, entry_struct, data, datalen, data_entry_count, nvs_obj):
         # compute CRC of data
         struct.pack_into('<H', entry_struct, 24, datalen)
@@ -355,7 +354,6 @@ class Page(object):
         # write actual data
         self.write_entry_to_buf(data, data_entry_count, nvs_obj)
 
-
     """
     Low-level function to write variable length data into page buffer. Data should be formatted
     according to encoding specified.
@@ -364,13 +362,11 @@ class Page(object):
         # Set size of data
         datalen = len(data)
 
-        if version == Page.VERSION1:
         if datalen > Page.PAGE_PARAMS["max_old_blob_size"]:
+            if version == Page.VERSION1:
                 raise InputError("Version %s\n%s: Size exceeds max allowed length." % (VERSION1_PRINT,key))
-
+            else:
-        if version == Page.VERSION2:
                 if encoding == "string":
-                if datalen > Page.PAGE_PARAMS["max_new_blob_size"]:
                     raise InputError("Version %s\n%s: Size exceeds max allowed length." % (VERSION2_PRINT,key))
 
         # Calculate no. of entries data will require
@@ -379,8 +375,10 @@ class Page(object):
         total_entry_count = data_entry_count + 1  # +1 for the entry header
 
         # Check if page is already full and new page is needed to be created right away
-        if encoding == "string":
+        if self.entry_num >= Page.PAGE_PARAMS["max_entries"]:
-            if (self.entry_num + total_entry_count) >= Page.PAGE_PARAMS["max_entries"]:
+            raise PageFullError()
+        elif (self.entry_num + total_entry_count) >= Page.PAGE_PARAMS["max_entries"]:
+            if not (version == Page.VERSION2 and encoding in ["hex2bin", "binary", "base64"]):
                 raise PageFullError()
 
         # Entry header
@@ -409,13 +407,11 @@ class Page(object):
             entry_struct[1] = Page.BLOB
 
         if version == Page.VERSION2 and (encoding in ["hex2bin", "binary", "base64"]):
-                entry_struct = self.write_varlen_binary_data(entry_struct,ns_index,key,data,\
+            entry_struct = self.write_varlen_binary_data(entry_struct,ns_index,key,data,
                                                          datalen,total_entry_count, encoding, nvs_obj)
         else:
             self.write_single_page_entry(entry_struct, data, datalen, data_entry_count, nvs_obj)
 
-
-
     """ Low-level function to write data of primitive type into page buffer. """
     def write_primitive_data(self, key, data, encoding, ns_index,nvs_obj):
         # Check if entry exceeds max number of entries allowed per page
@@ -464,9 +460,13 @@ class Page(object):
     def get_data(self):
         return self.page_buf
 
+
 """
-NVS class encapsulates all NVS specific operations to create a binary with given key-value pairs. Binary can later be flashed onto device via a flashing utility.
+NVS class encapsulates all NVS specific operations to create a binary with given key-value pairs.
+Binary can later be flashed onto device via a flashing utility.
 """
+
+
 class NVS(object):
     def __init__(self, fout, input_size):
         self.size = input_size
@@ -480,11 +480,11 @@ class NVS(object):
         return self
 
     def __exit__(self, exc_type, exc_value, traceback):
-        if exc_type == None and exc_value == None:
+        if exc_type is None and exc_value is None:
             # Create pages for remaining available size
             while True:
                 try:
-                    new_page = self.create_new_page()
+                    self.create_new_page()
                 except InsufficientSizeError:
                     self.size = None
                     # Creating the last reserved page
@@ -572,6 +572,7 @@ class NVS(object):
             data += page.get_data()
         return data
 
+
 class PageFullError(RuntimeError):
     """
     Represents error when current page doesn't have sufficient entries left
@@ -580,6 +581,7 @@ class PageFullError(RuntimeError):
     def __init__(self):
         super(PageFullError, self).__init__()
 
+
 class InputError(RuntimeError):
     """
     Represents error on the input
@@ -587,6 +589,7 @@ class InputError(RuntimeError):
     def __init__(self, e):
         super(InputError, self).__init__(e)
 
+
 class InsufficientSizeError(RuntimeError):
     """
     Represents error when NVS Partition size given is insufficient
@@ -595,6 +598,7 @@ class InsufficientSizeError(RuntimeError):
     def __init__(self, e):
         super(InsufficientSizeError, self).__init__(e)
 
+
 def nvs_open(result_obj, input_size):
     """ Wrapper to create and NVS class object. This object can later be used to set key-value pairs
 
@@ -604,6 +608,7 @@ def nvs_open(result_obj, input_size):
     """
     return NVS(result_obj, input_size)
 
+
 def write_entry(nvs_instance, key, datatype, encoding, value):
     """ Wrapper to set key-value pair in NVS format
 
@@ -617,8 +622,8 @@ def write_entry(nvs_instance, key, datatype, encoding, value):
 
     if datatype == "file":
         abs_file_path = value
-        if os.path.isabs(value) == False:
+        if os.path.isabs(value) is False:
-            script_dir = os.path.dirname(__file__)
+            script_dir = os.getcwd()
             abs_file_path = os.path.join(script_dir, value)
 
         with open(abs_file_path, 'rb') as f:
@@ -629,6 +634,7 @@ def write_entry(nvs_instance, key, datatype, encoding, value):
     else:
         nvs_instance.write_entry(key, value, encoding)
 
+
 def nvs_close(nvs_instance):
     """ Wrapper to finish writing to NVS and write data to file/stream object provided to nvs_open method
 
@@ -638,8 +644,9 @@ def nvs_close(nvs_instance):
     nvs_instance.__exit__(None, None, None)
 
 
-def check_input_args(input_filename=None, output_filename=None, input_part_size=None, is_key_gen=None,\
+def check_input_args(input_filename=None, output_filename=None, input_part_size=None, is_key_gen=None,
-encrypt_mode=None, key_file=None, version_no=None, print_arg_str=None, print_encrypt_arg_str=None):
+                     encrypt_mode=None, key_file=None, version_no=None, print_arg_str=None, print_encrypt_arg_str=None,
+                     output_dir=None):
 
     global version, is_encrypt_data, input_size, key_gen
 
@@ -648,12 +655,17 @@ encrypt_mode=None, key_file=None, version_no=None, print_arg_str=None, print_enc
     key_gen = is_key_gen
     input_size = input_part_size
 
+    if not output_dir == os.getcwd() and (key_file and os.path.isabs(key_file)):
+        sys.exit("Error. Cannot provide --outdir argument as --keyfile is absolute path.")
+
+    if not os.path.isdir(output_dir):
+        distutils.dir_util.mkpath(output_dir)
+
     if is_encrypt_data.lower() == 'true':
         is_encrypt_data = True
     elif is_encrypt_data.lower() == 'false':
         is_encrypt_data = False
 
-
     if version == 'v1':
         version = Page.VERSION1
     elif version == 'v2':
@@ -664,7 +676,6 @@ encrypt_mode=None, key_file=None, version_no=None, print_arg_str=None, print_enc
     elif key_gen.lower() == 'false':
         key_gen = False
 
-
     if key_gen:
         if all(arg is not None for arg in [input_filename, output_filename, input_size]):
             if not is_encrypt_data:
@@ -672,20 +683,26 @@ encrypt_mode=None, key_file=None, version_no=None, print_arg_str=None, print_enc
         elif any(arg is not None for arg in [input_filename, output_filename, input_size]):
             sys.exit(print_arg_str)
     else:
-        if not input_size:
+        if not (input_filename and output_filename and input_size):
-            if not all(arg is not None for arg in [input_filename, output_filename]):
             sys.exit(print_arg_str)
 
-
         if is_encrypt_data and not key_gen and not key_file:
             sys.exit(print_encrypt_arg_str)
 
-    if is_encrypt_data and key_gen and key_file:
-        sys.exit(print_encrypt_arg_str)
-
         if not is_encrypt_data and key_file:
             sys.exit("Invalid. Cannot give --keyfile as --encrypt is set to false.")
 
+    if key_file:
+        key_file_name, key_file_ext = os.path.splitext(key_file)
+        if key_file_ext:
+            if not key_file_ext == '.bin':
+                sys.exit("--keyfile argument can be a filename with no extension or .bin extension only")
+
+    # If only one of the arguments - input_filename, output_filename, input_size is given
+    if ((any(arg is None for arg in [input_filename, output_filename, input_size])) is True) and \
+            ((all(arg is None for arg in [input_filename, output_filename, input_size])) is False):
+            sys.exit(print_arg_str)
+
     if input_size:
         # Set size
         input_size = int(input_size, 0)
@@ -700,9 +717,8 @@ encrypt_mode=None, key_file=None, version_no=None, print_arg_str=None, print_enc
             sys.exit("Minimum NVS partition size needed is 0x3000 bytes.")
 
 
-
+def nvs_part_gen(input_filename=None, output_filename=None, input_part_size=None, is_key_gen=None, encrypt_mode=None,
-
+                 key_file=None, encr_key_prefix=None, version_no=None, output_dir=None):
-def nvs_part_gen(input_filename=None, output_filename=None, input_part_size=None, is_key_gen=None, encrypt_mode=None, key_file=None, version_no=None):
     """ Wrapper to generate nvs partition binary
 
     :param input_filename: Name of input file containing data
@@ -716,6 +732,9 @@ def nvs_part_gen(input_filename=None, output_filename=None, input_part_size=None
     """
 
     global key_input, key_len_needed
+    encr_key_bin_file = None
+    encr_keys_dir = None
+    backslash = ['/','\\']
 
     key_len_needed = 64
     key_input = bytearray()
@@ -727,6 +746,8 @@ def nvs_part_gen(input_filename=None, output_filename=None, input_part_size=None
             key_input = key_f.read(64)
 
     if all(arg is not None for arg in [input_filename, output_filename, input_size]):
+        if not os.path.isabs(output_filename) and not any(ch in output_filename for ch in backslash):
+            output_filename = os.path.join(output_dir, '') + output_filename
         input_file = open(input_filename, 'rt', encoding='utf8')
         output_file = open(output_filename, 'wb')
 
@@ -744,6 +765,7 @@ def nvs_part_gen(input_filename=None, output_filename=None, input_part_size=None
         input_file.close()
         output_file.close()
 
+        print("NVS binary created: " + output_filename)
 
     if key_gen:
         keys_page_buf = bytearray(b'\xff') * Page.PAGE_PARAMS["max_size"]
@@ -758,57 +780,87 @@ def nvs_part_gen(input_filename=None, output_filename=None, input_part_size=None
         crc_data = bytes(crc_data)
         crc = zlib.crc32(crc_data, 0xFFFFFFFF)
         struct.pack_into('<I', keys_page_buf, key_len,  crc & 0xFFFFFFFF)
-        with open("encryption_keys.bin",'wb') as output_keys_file:
+
+        if not key_file or (key_file and not os.path.isabs(key_file)):
+            # Create encryption keys bin file with timestamp
+            if not encr_key_prefix:
+                timestamp = datetime.datetime.now().strftime('%m-%d_%H-%M')
+            output_dir = os.path.join(output_dir, '')
+            encr_keys_dir = output_dir + "keys"
+            if not os.path.isdir(encr_keys_dir):
+                distutils.dir_util.mkpath(encr_keys_dir)
+
+            # Add backslash to `keys` dir if it is not present
+            encr_keys_dir = os.path.join(encr_keys_dir, '')
+
+        if key_file:
+            key_file_name, ext  = os.path.splitext(key_file)
+            if ext:
+                if ".bin" not in ext:
+                    sys.exit("Error: --keyfile must have .bin extension")
+                encr_key_bin_file = os.path.basename(key_file)
+            else:
+                encr_key_bin_file = key_file_name + ".bin"
+            if encr_keys_dir:
+                encr_key_bin_file = encr_keys_dir + encr_key_bin_file
+        else:
+            if encr_key_prefix:
+                encr_key_bin_file = encr_keys_dir + encr_key_prefix + "-keys" + ".bin"
+            else:
+                encr_key_bin_file = encr_keys_dir + "encryption_keys_" + timestamp + ".bin"
+
+        with open(encr_key_bin_file,'wb') as output_keys_file:
             output_keys_file.write(keys_page_buf)
 
-    print("Binary created.")
+        print("Encryption keys binary created: " + encr_key_bin_file)
 
 
 def main():
     parser = argparse.ArgumentParser(description="ESP32 NVS partition generation utility")
     nvs_part_gen_group = parser.add_argument_group('To generate NVS partition')
-    nvs_part_gen_group.add_argument(
+    nvs_part_gen_group.add_argument("--input",
-            "--input",
                                     help="Path to CSV file to parse.",
                                     default=None)
 
-    nvs_part_gen_group.add_argument(
+    nvs_part_gen_group.add_argument("--output",
-            "--output",
                                     help='Path to output converted binary file.',
                                     default=None)
 
-    nvs_part_gen_group.add_argument(
+    nvs_part_gen_group.add_argument("--size",
-            "--size",
                                     help='Size of NVS Partition in bytes (must be multiple of 4096)')
 
-    nvs_part_gen_group.add_argument(
+    nvs_part_gen_group.add_argument("--version",
-            "--version",
                                     help='Set version. Default: v2',
                                     choices=['v1','v2'],
                                     default='v2',
                                     type=str.lower)
 
-    keygen_action=nvs_part_gen_group.add_argument(
+    keygen_action_key = nvs_part_gen_group.add_argument("--keygen",
-            "--keygen",
+                                                        help='Generate keys for encryption.',
-            help='Generate keys for encryption. Creates an `encryption_keys.bin` file. Default: false',
                                                         choices=['true','false'],
                                                         default='false',
                                                         type=str.lower)
 
-    nvs_part_gen_group.add_argument(
+    nvs_part_gen_group.add_argument("--encrypt",
-            "--encrypt",
                                     help='Set encryption mode. Default: false',
                                     choices=['true','false'],
                                     default='false',
                                     type=str.lower)
 
-    nvs_part_gen_group.add_argument(
+    keygen_action_file = nvs_part_gen_group.add_argument("--keyfile",
-            "--keyfile",
+                                                         help='File having key for encryption (Applicable only if encryption mode is true).',
-            help='File having key for encryption (Applicable only if encryption mode is true)',
                                                          default=None)
 
+    keygen_action_dir = nvs_part_gen_group.add_argument('--outdir',
+                                                        dest='outdir',
+                                                        default=os.getcwd(),
+                                                        help='the output directory to store the files created\
+                                                        (Default: current directory)')
+
     key_gen_group = parser.add_argument_group('To generate encryption keys')
-    key_gen_group._group_actions.append(keygen_action)
+    key_gen_group._group_actions.append(keygen_action_key)
+    key_gen_group._group_actions.append(keygen_action_file)
+    key_gen_group._group_actions.append(keygen_action_dir)
 
     args = parser.parse_args()
     input_filename = args.input
@@ -818,13 +870,17 @@ def main():
     is_key_gen = args.keygen
     is_encrypt_data = args.encrypt
     key_file = args.keyfile
+    output_dir_path = args.outdir
+    encr_keys_prefix = None
 
-    print_arg_str = "Invalid.\nTo generate nvs partition binary --input, --output and --size arguments are mandatory.\nTo generate encryption keys --keygen argument is mandatory."
+    print_arg_str = "Invalid.\nTo generate nvs partition binary --input, --output and --size arguments are mandatory.\
+                    \nTo generate encryption keys --keygen argument is mandatory."
     print_encrypt_arg_str = "Missing parameter. Enter --keyfile or --keygen."
 
-    check_input_args(input_filename,output_filename, part_size, is_key_gen, is_encrypt_data, key_file, version_no, print_arg_str, print_encrypt_arg_str)
+    check_input_args(input_filename,output_filename, part_size, is_key_gen, is_encrypt_data, key_file, version_no,
-    nvs_part_gen(input_filename, output_filename, part_size, is_key_gen, is_encrypt_data, key_file, version_no)
+                     print_arg_str, print_encrypt_arg_str, output_dir_path)
-
+    nvs_part_gen(input_filename, output_filename, part_size, is_key_gen, is_encrypt_data, key_file,
+                 encr_keys_prefix, version_no, output_dir_path)
 
 
 if __name__ == "__main__":

components/nvs_flash/nvs_partition_generator/sample_multipage_blob.csv

@@ -11,4 +11,6 @@ dummyBase64Key,data,base64,MTIzYWJj
 hexFileKey,file,hex2bin,testdata/sample.hex
 base64FileKey,file,base64,testdata/sample.base64
 stringFileKey,file,string,testdata/sample.txt
+blobFileAKey,file,binary,testdata/sample_blob.bin
+blobFileBKey,file,binary,testdata/sample_blob.bin
 binFileKey,file,binary,testdata/sample_multipage_blob.bin

components/nvs_flash/nvs_partition_generator/sample_singlepage_blob.csv

@@ -11,4 +11,6 @@ dummyBase64Key,data,base64,MTIzYWJj
 hexFileKey,file,hex2bin,testdata/sample.hex
 base64FileKey,file,base64,testdata/sample.base64
 stringFileKey,file,string,testdata/sample.txt
+blobFileAKey,file,binary,testdata/sample_blob.bin
+blobFileBKey,file,binary,testdata/sample_blob.bin
 binFileKey,file,binary,testdata/sample_singlepage_blob.bin

components/nvs_flash/nvs_partition_generator/testdata/sample_blob.bin

@@ -0,0 +1 @@
+start0000000000000000000000start0123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef00000000000000000123456789abcdef0000000000000000end00000000000000000000000000end

components/nvs_flash/test_nvs_host/Makefile

@@ -61,5 +61,10 @@ clean:
 	rm -f $(COVERAGE_FILES) *.gcov
 	rm -rf coverage_report/
 	rm -f coverage.info
+	rm ../nvs_partition_generator/partition_single_page.bin
+	rm ../nvs_partition_generator/partition_multipage_blob.bin
+	rm ../nvs_partition_generator/partition_encrypted.bin
+	rm ../nvs_partition_generator/partition_encrypted_using_keygen.bin
+	rm ../nvs_partition_generator/partition_encrypted_using_keyfile.bin
 
 .PHONY: clean all test long-test

components/nvs_flash/test_nvs_host/test_nvs.cpp

@@ -21,8 +21,10 @@
 #include <sstream>
 #include <iostream>
 #include <fstream>
+#include <dirent.h>
 #include <unistd.h>
 #include <sys/wait.h>
+#include <string.h>
 
 #define TEST_ESP_ERR(rc, res) CHECK((rc) == (res))
 #define TEST_ESP_OK(rc) CHECK((rc) == ESP_OK)
@@ -2057,14 +2059,14 @@ TEST_CASE("Recovery from power-off during modification of blob present in old-fo
     TEST_ESP_ERR(p3.findItem(1, ItemType::BLOB, "singlepage"), ESP_ERR_NVS_NOT_FOUND);
 }
 
-static void check_nvs_part_gen_args(char const *part_name, char const *filename, bool is_encr, nvs_sec_cfg_t* xts_cfg)
+static void check_nvs_part_gen_args(char const *part_name, int size, char const *filename, bool is_encr, nvs_sec_cfg_t* xts_cfg)
 {
     nvs_handle handle;
 
     if (is_encr)
-        TEST_ESP_OK(nvs_flash_secure_init_custom(part_name, 0, 3, xts_cfg));
+        TEST_ESP_OK(nvs_flash_secure_init_custom(part_name, 0, size, xts_cfg));
     else
-        TEST_ESP_OK( nvs_flash_init_custom(part_name, 0, 3) );
+        TEST_ESP_OK( nvs_flash_init_custom(part_name, 0, size) );
 
     TEST_ESP_OK( nvs_open_from_partition(part_name, "dummyNamespace", NVS_READONLY, &handle));
     uint8_t u8v;
@@ -2125,7 +2127,20 @@ static void check_nvs_part_gen_args(char const *part_name, char const *filename,
 
 TEST_CASE("check and read data from partition generated via partition generation utility with multipage blob support disabled", "[nvs_part_gen]")
 {
+    int status;
     int childpid = fork();
+    if (childpid == 0) {
+        exit(execlp("cp", " cp",
+                    "-rf",
+                    "../nvs_partition_generator/testdata",
+                    ".",NULL));
+    } else {
+        CHECK(childpid > 0);
+        waitpid(childpid, &status, 0);
+        CHECK(WEXITSTATUS(status) != -1);
+
+        childpid = fork();
+
         if (childpid == 0) {
             exit(execlp("python", "python",
                     "../nvs_partition_generator/nvs_partition_gen.py",
@@ -2143,18 +2158,42 @@ TEST_CASE("check and read data from partition generated via partition generation
             waitpid(childpid, &status, 0);
             CHECK(WEXITSTATUS(status) != -1);
         }
+    }
 
     SpiFlashEmulator emu("../nvs_partition_generator/partition_single_page.bin");
 
     TEST_ESP_OK(nvs_flash_deinit());
 
-    check_nvs_part_gen_args("test", "../nvs_partition_generator/testdata/sample_singlepage_blob.bin", false, NULL);
+    check_nvs_part_gen_args("test", 3, "../nvs_partition_generator/testdata/sample_singlepage_blob.bin", false, NULL);
-}
 
+    if (childpid == 0) {
+        exit(execlp("rm", " rm",
+                    "-rf",
+                    "testdata",NULL));
+    } else {
+        CHECK(childpid > 0);
+        waitpid(childpid, &status, 0);
+        CHECK(WEXITSTATUS(status) != -1);
+
+    }
+}
 
 TEST_CASE("check and read data from partition generated via partition generation utility with multipage blob support enabled", "[nvs_part_gen]")
 {
+    int status;
     int childpid = fork();
+    if (childpid == 0) {
+        exit(execlp("cp", " cp",
+                    "-rf",
+                    "../nvs_partition_generator/testdata",
+                    ".",NULL));
+    } else {
+        CHECK(childpid > 0);
+        waitpid(childpid, &status, 0);
+        CHECK(WEXITSTATUS(status) != -1);
+
+        childpid = fork();
+
         if (childpid == 0) {
             exit(execlp("python", "python",
                     "../nvs_partition_generator/nvs_partition_gen.py",
@@ -2163,20 +2202,30 @@ TEST_CASE("check and read data from partition generated via partition generation
                     "--output",
                     "../nvs_partition_generator/partition_multipage_blob.bin",
                     "--size",
-                "0x3000",
+                    "0x4000",
                     "--version",
                     "v2",NULL));
         } else {
             CHECK(childpid > 0);
-        int status;
             waitpid(childpid, &status, 0);
             CHECK(WEXITSTATUS(status) != -1);
         }
+    }
 
     SpiFlashEmulator emu("../nvs_partition_generator/partition_multipage_blob.bin");
 
-    check_nvs_part_gen_args("test", "../nvs_partition_generator/testdata/sample_multipage_blob.bin",false,NULL);
+    check_nvs_part_gen_args("test", 4, "../nvs_partition_generator/testdata/sample_multipage_blob.bin",false,NULL);
 
+    if (childpid == 0) {
+        exit(execlp("rm", " rm",
+                    "-rf",
+                    "testdata",NULL));
+    } else {
+        CHECK(childpid > 0);
+        waitpid(childpid, &status, 0);
+        CHECK(WEXITSTATUS(status) != -1);
+
+    }
 }
 
 #if CONFIG_NVS_ENCRYPTION
@@ -2320,7 +2369,20 @@ TEST_CASE("test nvs apis with encryption enabled", "[nvs]")
 
 TEST_CASE("test nvs apis for nvs partition generator utility with encryption enabled", "[nvs_part_gen]")
 {
+    int status;
     int childpid = fork();
+    if (childpid == 0) {
+        exit(execlp("cp", " cp",
+                    "-rf",
+                    "../nvs_partition_generator/testdata",
+                    ".",NULL));
+    } else {
+        CHECK(childpid > 0);
+        waitpid(childpid, &status, 0);
+        CHECK(WEXITSTATUS(status) != -1);
+
+        childpid = fork();
+
         if (childpid == 0) {
             exit(execlp("python", "python",
                     "../nvs_partition_generator/nvs_partition_gen.py",
@@ -2329,17 +2391,17 @@ TEST_CASE("test nvs apis for nvs partition generator utility with encryption ena
                     "--output",
                     "../nvs_partition_generator/partition_encrypted.bin",
                     "--size",
-                "0x3000",
+                    "0x4000",
                     "--encrypt",
                     "True",
                     "--keyfile",
                     "../nvs_partition_generator/testdata/sample_encryption_keys.bin",NULL));
         } else {
             CHECK(childpid > 0);
-        int status;
             waitpid(childpid, &status, 0);
             CHECK(WEXITSTATUS(status) != -1);
         }
+    }
 
     SpiFlashEmulator emu("../nvs_partition_generator/partition_encrypted.bin");
 
@@ -2349,7 +2411,19 @@ TEST_CASE("test nvs apis for nvs partition generator utility with encryption ena
         cfg.tky[count] = 0x22;
     }
 
-    check_nvs_part_gen_args(NVS_DEFAULT_PART_NAME, "../nvs_partition_generator/testdata/sample_multipage_blob.bin", true, &cfg);
+    check_nvs_part_gen_args(NVS_DEFAULT_PART_NAME, 4, "../nvs_partition_generator/testdata/sample_multipage_blob.bin", true, &cfg);
+
+    childpid = fork();
+    if (childpid == 0) {
+        exit(execlp("rm", " rm",
+                    "-rf",
+                    "testdata",NULL));
+    } else {
+        CHECK(childpid > 0);
+        waitpid(childpid, &status, 0);
+        CHECK(WEXITSTATUS(status) != -1);
+
+    }
 
 }
 
@@ -2358,6 +2432,18 @@ TEST_CASE("test nvs apis for nvs partition generator utility with encryption ena
 {
     int childpid = fork();
     int status;
+
+    if (childpid == 0) {
+        exit(execlp("cp", " cp",
+                    "-rf",
+                    "../nvs_partition_generator/testdata",
+                    ".",NULL));
+    } else {
+        CHECK(childpid > 0);
+        waitpid(childpid, &status, 0);
+        CHECK(WEXITSTATUS(status) != -1);
+
+        childpid = fork();
         if (childpid == 0) {
             exit(execlp("python", "python",
                         "../nvs_partition_generator/nvs_partition_gen.py",
@@ -2366,7 +2452,7 @@ TEST_CASE("test nvs apis for nvs partition generator utility with encryption ena
                         "--output",
                         "../nvs_partition_generator/partition_encrypted_using_keygen.bin",
                         "--size",
-                    "0x3000",
+                        "0x4000",
                         "--encrypt",
                         "True",
                         "--keygen",
@@ -2376,14 +2462,39 @@ TEST_CASE("test nvs apis for nvs partition generator utility with encryption ena
             CHECK(childpid > 0);
             waitpid(childpid, &status, 0);
             CHECK(WEXITSTATUS(status) != -1);
+
+        }
     }
 
+
+    DIR *dir;
+    struct dirent *file;
+    char *filename;
+    char *files;
+    char *file_ext;
+
+    dir = opendir("keys");
+    while ((file = readdir(dir)) != NULL)
+    {
+        filename = file->d_name;
+        files = strrchr(filename, '.');
+        if (files != NULL)
+        {
+            file_ext = files+1;
+            if (strncmp(file_ext,"bin",3) == 0)
+            {
+                break;
+            }
+        }
+    }
+
+    std::string encr_file = std::string("keys/") + std::string(filename);
     SpiFlashEmulator emu("../nvs_partition_generator/partition_encrypted_using_keygen.bin");
 
     char buffer[64];
     FILE *fp;
 
-    fp = fopen("encryption_keys.bin","rb");
+    fp = fopen(encr_file.c_str(),"rb");
     fread(buffer,sizeof(buffer),1,fp);
 
     fclose(fp);
@@ -2396,8 +2507,7 @@ TEST_CASE("test nvs apis for nvs partition generator utility with encryption ena
         cfg.tky[count] = buffer[count+32] & 255;
     }
 
-    check_nvs_part_gen_args(NVS_DEFAULT_PART_NAME, "../nvs_partition_generator/testdata/sample_multipage_blob.bin", true, &cfg);
+    check_nvs_part_gen_args(NVS_DEFAULT_PART_NAME, 4, "../nvs_partition_generator/testdata/sample_multipage_blob.bin", true, &cfg);
-
 
 }
 
@@ -2405,6 +2515,30 @@ TEST_CASE("test nvs apis for nvs partition generator utility with encryption ena
 {
     int childpid = fork();
     int status;
+
+    DIR *dir;
+    struct dirent *file;
+    char *filename;
+    char *files;
+    char *file_ext;
+
+    dir = opendir("keys");
+    while ((file = readdir(dir)) != NULL)
+    {
+        filename = file->d_name;
+        files = strrchr(filename, '.');
+        if (files != NULL)
+        {
+            file_ext = files+1;
+            if (strncmp(file_ext,"bin",3) == 0)
+            {
+                break;
+            }
+        }
+    }
+
+    std::string encr_file = std::string("keys/") + std::string(filename);
+
      if (childpid == 0) {
         exit(execlp("python", "python",
                 "../nvs_partition_generator/nvs_partition_gen.py",
@@ -2413,11 +2547,11 @@ TEST_CASE("test nvs apis for nvs partition generator utility with encryption ena
                 "--output",
                 "../nvs_partition_generator/partition_encrypted_using_keyfile.bin",
                 "--size",
-                "0x3000",
+                "0x4000",
                 "--encrypt",
                 "True",
                 "--keyfile",
-                "encryption_keys.bin",NULL));
+                encr_file.c_str(),NULL));
 
     } else {
         CHECK(childpid > 0);
@@ -2430,7 +2564,7 @@ TEST_CASE("test nvs apis for nvs partition generator utility with encryption ena
     char buffer[64];
     FILE *fp;
 
-    fp = fopen("encryption_keys.bin","rb");
+    fp = fopen(encr_file.c_str(),"rb");
     fread(buffer,sizeof(buffer),1,fp);
 
     fclose(fp);
@@ -2443,17 +2577,29 @@ TEST_CASE("test nvs apis for nvs partition generator utility with encryption ena
         cfg.tky[count] = buffer[count+32] & 255;
     }
 
-    check_nvs_part_gen_args(NVS_DEFAULT_PART_NAME, "../nvs_partition_generator/testdata/sample_multipage_blob.bin", true, &cfg);
+    check_nvs_part_gen_args(NVS_DEFAULT_PART_NAME, 4, "../nvs_partition_generator/testdata/sample_multipage_blob.bin", true, &cfg);
 
     childpid = fork();
     if (childpid == 0) {
         exit(execlp("rm", " rm",
-                    "encryption_keys.bin",NULL));
+                    "-rf",
+                    "keys",NULL));
     } else {
         CHECK(childpid > 0);
         waitpid(childpid, &status, 0);
         CHECK(WEXITSTATUS(status) != -1);
 
+        childpid = fork();
+
+        if (childpid == 0) {
+            exit(execlp("rm", " rm",
+                        "-rf",
+                        "testdata",NULL));
+        } else {
+            CHECK(childpid > 0);
+            waitpid(childpid, &status, 0);
+            CHECK(WEXITSTATUS(status) != -1);
+        }
     }
 
 }

tools/ci/setup_python.sh

@@ -5,7 +5,7 @@
 # - UT_009_ - multi-device tests are not compatible
 # - UT_014_ - multi-device tests are not compatible
 # - UT_017_ - multi-device tests are not compatible
-py3_incomp='assign_test|nvs_compatible_test|IT|UT_009_|UT_014_|UT_017_'
+py3_incomp='assign_test|nvs_compatible_test|IT|UT_009_|UT_013_|UT_014_|UT_017_'
 
 if [ -z ${PYTHON_VER+x} ] || [[ $CI_JOB_NAME =~ $py3_incomp ]]; then
     # Use this version of the Python interpreter if it was not defined before or